Merged Pull Request '#53 cloud-examples->main : Ensure resource_key e…

…nvironment variable is consistently used'

Ensure resource_key environment variable is consistently used

ci/run-integration-tests.ps1

@@ -13,7 +13,7 @@ if (!$Keys.TestResourceKey) {
     return
 }
 
-$env:RESOURCEKEY = $Keys.TestResourceKey
+$env:resource_key = $Keys.TestResourceKey
 $env:AcceptChPlatformKey = $Keys.TestResourceKey
 $env:AcceptChHardwareKey = $Keys.TestResourceKey
 $env:AcceptChBrowserKey = $Keys.TestResourceKey

examples/cloud/classes/ExampleUtils.php

@@ -1,24 +1,24 @@
 <?php
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 namespace fiftyone\pipeline\devicedetection\examples\cloud\classes;
@@ -50,6 +50,11 @@ public static function getResourceKeyFromCliArgs($argv)
         return null;
     }
 
+    public static function getResourceKeyFromQueryParameter()
+    {
+        return $_GET[self::RESOURCE_KEY_ENV_VAR] ?? null;
+    }
+
     public static function getResourceKeyFromConfig($config)
     {
         $key = null;

examples/cloud/classes/MetadataConsole.php

@@ -1,24 +1,24 @@
 <?php
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 /**
@@ -68,6 +68,8 @@ public function run($resourceKey, $logger, callable $output)
         $pipeline = (new DeviceDetectionPipelineBuilder(['resourceKey' => $resourceKey]))
             ->addLogger($logger)
             ->build();
+
+        $pipeline->createFlowData()->process();
 
         $this->outputProperties($pipeline->getElement('device'), $output);
         // We use the CloudRequestEngine to get evidence key details, rather than the

examples/cloud/failureToMatch.php

@@ -1,24 +1,24 @@
-<?php
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+<?php
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 /**
@@ -53,27 +53,30 @@
 
 require(__DIR__ . "/../../vendor/autoload.php");
 
+use fiftyone\pipeline\core\Logger;
 use fiftyone\pipeline\devicedetection\DeviceDetectionPipelineBuilder;
+use fiftyone\pipeline\devicedetection\examples\cloud\classes\ExampleUtils;
 
 // We then create a pipeline with the builder. Create your own resource key for free at https://configure.51degrees.com.
 
 // Check if there is a resource key in the environment variable and use
 // it if there is one. You will need to switch this for your own resource key.
 
-if (isset($_ENV["RESOURCEKEY"])) {
-    $resourceKey = $_ENV["RESOURCEKEY"];
-} else {
-    $resourceKey = "!!YOUR_RESOURCE_KEY!!";
+$resourceKey = ExampleUtils::getResourceKeyFromEnv();
+
+if (empty($resourceKey)) {
+    $resourceKey = ExampleUtils::getResourceKeyFromQueryParameter();
 }
 
-if ($resourceKey === "!!YOUR_RESOURCE_KEY!!") {
-    echo "You need to create a resource key at " .
-        "https://configure.51degrees.com and paste it into the code, " .
-        "replacing !!YOUR_RESOURCE_KEY!!.";
-    echo "\n<br/>";
-    echo "Make sure to include the ismobile property " .
-        "as it is used by this example.\n<br />";
-    return;
+if (empty($resourceKey)) {
+    $message = 'No resource key specified in the environment variable or query parameter ';
+    $message .= "'" . ExampleUtils::RESOURCE_KEY_ENV_VAR . "'." . PHP_EOL;
+    $message .= 'Create a resource key with the properties required by this example';
+    $message .= 'at https://configure.51degrees.com' . '<br/>';
+    $message .= 'Once complete, populate the environment variable or query parameter ';
+    $message .= 'mentioned at the start of this message with the key.' . '<br/>';
+
+    ExampleUtils::logErrorAndExit(new Logger('info'), $message);
 }
 
 $builder = new DeviceDetectionPipelineBuilder(array(

examples/cloud/gettingStartedWeb.php

@@ -1,24 +1,24 @@
 <?php
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 
@@ -82,17 +82,17 @@
 use fiftyone\pipeline\devicedetection\examples\cloud\classes\ExampleUtils;
 use fiftyone\pipeline\devicedetection\examples\cloud\classes\GettingStartedWeb;
 
-function main($argv)
+function main()
 {
     // Configure a logger to output to the console
     $logger = new Logger("info");
 
-    // Get the resource key from command line args
-    $resourceKey = ExampleUtils::getResourceKeyFromCliArgs($argv);
+    // Get the resource key from the environment variable
+    $resourceKey = ExampleUtils::getResourceKeyFromEnv();
 
-    // Otherwise, get the resource key from the environment variable
+    // Otherwise, get the resource key from the query parameter
     if (empty($resourceKey)) {
-        $resourceKey = ExampleUtils::getResourceKeyFromEnv();
+        $resourceKey = ExampleUtils::getResourceKeyFromQueryParameter();
     }
 
     if (empty($resourceKey)) {
@@ -113,4 +113,4 @@ function main($argv)
     (new GettingStartedWeb())->run($resourceKey, $logger, function($message) { echo $message; });
 }
 
-main(isset($argv) ? array_slice($argv, 1) : null);
+main();

examples/cloud/metadataConsole.php

@@ -1,24 +1,24 @@
 <?php
-/* *********************************************************************
- * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
- * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
- * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
- *
- * This Original Work is licensed under the European Union Public Licence
- * (EUPL) v.1.2 and is subject to its terms as set out below.
- *
- * If a copy of the EUPL was not distributed with this file, You can obtain
- * one at https://opensource.org/licenses/EUPL-1.2.
- *
- * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
- * amended by the European Commission) shall be deemed incompatible for
- * the purposes of the Work and the provisions of the compatibility
- * clause in Article 5 of the EUPL shall not apply.
- *
- * If using the Work as, or as part of, a network application, by
- * including the attribution notice(s) required under Article 5 of the EUPL
- * in the end user terms of the application under an appropriate heading,
- * such notice(s) shall fulfill the requirements of that article.
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
+ * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+ *
+ * This Original Work is licensed under the European Union Public Licence
+ * (EUPL) v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
  * ********************************************************************* */
 
 /**
@@ -63,12 +63,12 @@ function main($argv)
         // Configure a logger to output to the console
         $logger = new Logger("info");
 
-        // Get the resource key from command line args
-        $resourceKey = ExampleUtils::getResourceKeyFromCliArgs($argv);
+        // Get the resource key from the environment variable
+        $resourceKey = ExampleUtils::getResourceKeyFromEnv();
 
-        // Otherwise, get the resource key from the environment variable
+        // Otherwise, get the resource key from command line args
         if (empty($resourceKey)) {
-            $resourceKey = ExampleUtils::getResourceKeyFromEnv();
+            $resourceKey = ExampleUtils::getResourceKeyFromCliArgs($argv);
         }
 
         if (empty($resourceKey)) {