PHPLIB-313/change/examples_always_create_heidelpay_instance_to_show_s…

…andbox_banner (#187) * [change] (PHPLIB-326) Enable test output for failed tests even when verbose test logging is disabled. * [change] (PHPLIB-326) Replace environment variable for test log output and set default to false (no output). * [change] (PHPLIB-326) Replace environment variable for test log output and set default to false (no output). * [change] (PHPLIB-326) Update CHANGELOG.md. * [change] (PHPLIB-326) Fix style issues. * [change] (PHPLIB-326) Add new line before and after log dump. * [change] (PHPLIB-326) Fix version in deprecation notice. * [change] (PHPLIB-333) Remove default key pair from examples. * [change] (PHPLIB-333) Update version since the changes are quite intence. * [change] (PHPLIB-333) small change,. * [change] (PHPLIB-333) small change,. * [change] (PHPLIB-333) Fix key validation. * [change] (PHPLIB-333) Move general key-check to index. * [change] (PHPLIB-334) Remove default keys from tests and refactor tests. * [change] (PHPLIB-334) Tests: Extend unit test for fetching the keys from env vars. * [change] (PHPLIB-334) Tests: Changed EnvironmentService call to static method. * [change] (PHPLIB-334) Tests: Refactor tests due to removal of default keys. * [change] (PHPLIB-334) Tests: Changed EnvironmentService call to static method. * [change] (PHPLIB-334) Tests: Update recurring test to comply to latest api changes. * [change] (PHPLIB-334) Update README.md * [change] (PHPLIB-334) Update README.md * [change] (PHPLIB-334) Update CHANGELOG.md * [refactor] (PHPLIB-317) Adapt style and features to PHP version 7.1. * Add return type hints. * Fix some minor issues. * Add missing exception annotations. * Remove unnecessary comments from tests. * [refactor] (PHPLIB-317) Update CHANGELOG.md and replace abandoned codacy/coverage package. * [refactor] (PHPLIB-317) Update CHANGELOG.md and replace abandoned codacy/coverage package. * [refactor] (PHPLIB-317) Update CHANGELOG.md and replace abandoned codacy/coverage package. * [refactor] (PHPLIB-317) Refactor code. * Replace deprecated methods. * Add some noinspection rules. * Fixed some minor issues. * [refactor] (PHPLIB-317) Remove debug code. * [refactor] (PHPLIB-334) Fix style issues. * [change] (PHPLIB-313) Examples/PrePayment: Create heidelpay object to make sure the sandbox banner is visible. * [change] (PHPLIB-313) Examples/PrePayment: Create heidelpay object to make sure the sandbox banner is visible. * [change] (PHPLIB-313) Update due to codacy issues. * [change] (PHPLIB-313) Tests: Fix unit tests. * [change] (PHPLIB-313) Add missing throws annotations. * [change] (PHPLIB-313) Add missing throws annotations. Co-authored-by: sixer1182 <[email protected]>
heidelpay · Jul 24, 2020 · 99b43bb · 99b43bb
1 parent 957eca4
commit 99b43bb
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 *   Refactor tests due to disabled default keypair.
 *   Refactor all files to reflect PHP 7.1 standards.
 *   Replace `codacy/coverage` with `codacy/codacy-coverage-reporter`.
+*   Update examples to always show the sandbox banner when sandbox keys are used.
 
 ### Fix
 *   Change TravisCI config to use default linux distribution in VM to fix certificate errors during integration tests.

diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ For any issues or questions please get in touch with our support team.
 [https://docs.heidelpay.com/](https://docs.heidelpay.com/)
 
 ### Email
-[email protected]
+<[email protected]>
 
 ### Phone
 +49 (0)6221/6471-100

diff --git a/examples/EmbeddedPayPage/index.php b/examples/EmbeddedPayPage/index.php
@@ -27,6 +27,7 @@
 require_once __DIR__ . '/Constants.php';
 
 /** @noinspection PhpIncludeInspection */
+
 /** Require the composer autoloader file */
 require_once __DIR__ . '/../../../../autoload.php';
 ?>
@@ -76,6 +77,10 @@
 </form>
 
 <script>
+    // Create a heidelpay instance with your public key
+    // This is not actually needed for this example but we want the sandbox banner to show on the page.
+    let heidelpayInstance = new heidelpay('<?php echo HEIDELPAY_PHP_PAYMENT_API_PUBLIC_KEY; ?>');
+
     let $errorHolder = $('#error-holder');
     let $submitButton = $('#submit-button');
     let $form = $('#payment-form');

diff --git a/examples/HostedPayPage/index.php b/examples/HostedPayPage/index.php
@@ -27,6 +27,7 @@
 require_once __DIR__ . '/Constants.php';
 
 /** @noinspection PhpIncludeInspection */
+
 /** Require the composer autoloader file */
 require_once __DIR__ . '/../../../../autoload.php';
 ?>
@@ -72,5 +73,11 @@
     <button class="heidelpayUI primary button fluid" id="submit-button" type="submit">Pay</button>
 </form>
 
+<script>
+    // Create a heidelpay instance with your public key
+    // This is not actually needed for this example but we want the sandbox banner to show on the page.
+    let heidelpayInstance = new heidelpay('<?php echo HEIDELPAY_PHP_PAYMENT_API_PUBLIC_KEY; ?>');
+</script
+
 </body>
 </html>
diff --git a/examples/Invoice/index.php b/examples/Invoice/index.php
@@ -39,10 +39,9 @@
     <title>
         Heidelpay UI Examples
     </title>
-    <script src="https://code.jquery.com/jquery-3.1.1.min.js"
-            integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin="anonymous"></script>
 
     <link rel="stylesheet" href="https://static.heidelpay.com/v1/heidelpay.css" />
+    <script type="text/javascript" src="https://static.heidelpay.com/v1/heidelpay.js"></script>
 </head>
 
 <body style="margin: 70px 70px 0;">
@@ -51,5 +50,11 @@
     <button class="heidelpayUI primary button fluid" id="submit-button" type="submit">Pay</button>
 </form>
 
+<script>
+    // Create a heidelpay instance with your public key
+    // This is not actually needed for this example but we want the sandbox banner to show on the page.
+    let heidelpayInstance = new heidelpay('<?php echo HEIDELPAY_PHP_PAYMENT_API_PUBLIC_KEY; ?>');
+</script
+
 </body>
 </html>
diff --git a/examples/InvoiceFactoring/index.php b/examples/InvoiceFactoring/index.php
@@ -39,8 +39,6 @@
     <title>
         Heidelpay UI Examples
     </title>
-    <script src="https://code.jquery.com/jquery-3.1.1.min.js"
-            integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin="anonymous"></script>
 
     <link rel="stylesheet" href="https://static.heidelpay.com/v1/heidelpay.css" />
     <script type="text/javascript" src="https://static.heidelpay.com/v1/heidelpay.js"></script>
@@ -52,5 +50,11 @@
     <button class="heidelpayUI primary button fluid" id="submit-button" type="submit">Pay</button>
 </form>
 
+<script>
+    // Create a heidelpay instance with your public key
+    // This is not actually needed for this example but we want the sandbox banner to show on the page.
+    let heidelpayInstance = new heidelpay('<?php echo HEIDELPAY_PHP_PAYMENT_API_PUBLIC_KEY; ?>');
+</script
+
 </body>
 </html>
diff --git a/examples/Prepayment/index.php b/examples/Prepayment/index.php
@@ -39,10 +39,9 @@
     <title>
         Heidelpay UI Examples
     </title>
-    <script src="https://code.jquery.com/jquery-3.1.1.min.js"
-            integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin="anonymous"></script>
 
     <link rel="stylesheet" href="https://static.heidelpay.com/v1/heidelpay.css" />
+    <script type="text/javascript" src="https://static.heidelpay.com/v1/heidelpay.js"></script>
 </head>
 
 <body style="margin: 70px 70px 0;">
@@ -51,5 +50,11 @@
     <button class="heidelpayUI primary button fluid" id="submit-button" type="submit">Pay</button>
 </form>
 
+<script>
+    // Create a heidelpay instance with your public key
+    // This is not actually needed for this example but we want the sandbox banner to show on the page.
+    let heidelpayInstance = new heidelpay('<?php echo HEIDELPAY_PHP_PAYMENT_API_PUBLIC_KEY; ?>');
+</script
+
 </body>
 </html>
diff --git a/src/Adapter/CurlAdapter.php b/src/Adapter/CurlAdapter.php
@@ -54,7 +54,7 @@ public function __construct()
     public function init($url, $payload = null, $httpMethod = HttpAdapterInterface::REQUEST_GET): void
     {
         $timeout = EnvironmentService::getTimeout();
-        $curlVerbose = EnvironmentService::getCurlVerbose();
+        $curlVerbose = EnvironmentService::isCurlVerbose();
 
         $this->request = curl_init($url);
         $this->setOption(CURLOPT_HEADER, 0);

diff --git a/src/Services/EnvironmentService.php b/src/Services/EnvironmentService.php
@@ -60,7 +60,7 @@ protected static function getBoolEnvValue(string $varName): bool
         /** @noinspection ProperNullCoalescingOperatorUsageInspection */
         $envVar = $_SERVER[$varName] ?? false;
         if (!is_bool($envVar)) {
-            $envVar = in_array(strtolower($envVar), [true, 'true', '1'], true);
+            $envVar = in_array(strtolower(stripslashes($envVar)), [true, 'true', '1'], true);
         }
         return $envVar;
     }
@@ -72,7 +72,7 @@ protected static function getBoolEnvValue(string $varName): bool
      */
     public function getMgwEnvironment(): string
     {
-        return $_SERVER[self::ENV_VAR_NAME_ENVIRONMENT] ?? self::ENV_VAR_VALUE_PROD_ENVIRONMENT;
+        return stripslashes($_SERVER[self::ENV_VAR_NAME_ENVIRONMENT] ?? self::ENV_VAR_VALUE_PROD_ENVIRONMENT);
     }
 
     /**
@@ -83,11 +83,9 @@ public function getMgwEnvironment(): string
     public static function isTestLoggingActive(): bool
     {
         if (isset($_SERVER[self::ENV_VAR_NAME_VERBOSE_TEST_LOGGING])) {
-            $verboseLogging = self::getBoolEnvValue(self::ENV_VAR_NAME_VERBOSE_TEST_LOGGING);
-        } else {
-            $verboseLogging = !self::getBoolEnvValue(self::ENV_VAR_NAME_DISABLE_TEST_LOGGING);
+            return self::getBoolEnvValue(self::ENV_VAR_NAME_VERBOSE_TEST_LOGGING);
         }
-        return $verboseLogging;
+        return !self::getBoolEnvValue(self::ENV_VAR_NAME_DISABLE_TEST_LOGGING);
     }
 
     /**
@@ -98,7 +96,7 @@ public static function isTestLoggingActive(): bool
      */
     public static function getTimeout(): int
     {
-        $timeout = $_SERVER[self::ENV_VAR_NAME_TIMEOUT] ?? '';
+        $timeout = stripslashes($_SERVER[self::ENV_VAR_NAME_TIMEOUT] ?? '');
         return is_numeric($timeout) ? (int)$timeout : self::DEFAULT_TIMEOUT;
     }
 
@@ -107,9 +105,9 @@ public static function getTimeout(): int
      *
      * @return bool
      */
-    public static function getCurlVerbose(): bool
+    public static function isCurlVerbose(): bool
     {
-        $curlVerbose = strtolower($_SERVER[self::ENV_VAR_NAME_CURL_VERBOSE] ?? 'false');
+        $curlVerbose = strtolower(stripslashes($_SERVER[self::ENV_VAR_NAME_CURL_VERBOSE] ?? 'false'));
         return in_array($curlVerbose, ['true', '1'], true);
     }
 
@@ -125,7 +123,7 @@ public static function getCurlVerbose(): bool
     public static function getTestPrivateKey($non3ds = false): string
     {
         $variableName = $non3ds ? self::ENV_VAR_TEST_PRIVATE_KEY_NON_3DS : self::ENV_VAR_TEST_PRIVATE_KEY;
-        $key = $_SERVER[$variableName] ?? '';
+        $key = stripslashes($_SERVER[$variableName] ?? '');
         return empty($key) ? '' : $key;
     }
 
@@ -141,7 +139,7 @@ public static function getTestPrivateKey($non3ds = false): string
     public static function getTestPublicKey($non3ds = false): string
     {
         $variableName = $non3ds ? self::ENV_VAR_TEST_PUBLIC_KEY_NON_3DS : self::ENV_VAR_TEST_PUBLIC_KEY;
-        $key = $_SERVER[$variableName] ?? '';
+        $key = stripslashes($_SERVER[$variableName] ?? '');
         return empty($key) ? '' : $key;
     }
 }
diff --git a/src/Services/IdService.php b/src/Services/IdService.php
@@ -91,7 +91,6 @@ public static function getLastResourceIdFromUrlString($url): ?string
      */
     public static function getResourceTypeFromIdString($typeId): ?string
     {
-        $paymentType  = null;
         $typeIdString = null;
 
         $typeIdParts = [];

diff --git a/src/Services/ResourceService.php b/src/Services/ResourceService.php
@@ -299,6 +299,7 @@ public function deleteResource(AbstractHeidelpayResource &$resource): ?AbstractH
      *
      * @throws HeidelpayApiException A HeidelpayApiException is thrown if there is an error returned on API-request.
      * @throws RuntimeException      A RuntimeException is thrown when there is an error while using the SDK.
+     * @throws Exception
      */
     public function fetchResource(AbstractHeidelpayResource $resource): AbstractHeidelpayResource
     {