Merge pull request #29 from PaymentRails/analytics-and-rebranding

Aman Aalam · web-flow · commit 5bbaef58dc8c · 2023-03-02T20:35:55.000-05:00
feat:Analytics and rebranding
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md
@@ -1,7 +1,7 @@
 Acknowledgements
 ----------------
 
-The PaymentRails SDK uses code from the following libraries:
+The Trolley SDK uses code from the following libraries:
 
 * [phpunit](https://github.com/sebastianbergmann/phpunit), BSD-3-Clause License
 * [Braintree](https://github.com/braintree/braintree_php), MIT License
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2017 Payment Rails, Inc.
+Copyright (c) 2017 Trolley, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-# Payment Rails[^1] PHP Library
+# Trolley PHP SDK (Previously Payment Rails[^1])
 
 [![Latest Stable Version](https://poser.pugx.org/paymentrails/php-sdk/v/stable.png)](https://packagist.org/packages/paymentrails/php-sdk)
 
-The Payment Rails PHP library provides integration access to the Payment Rails API.
+The Trolley PHP SDK provides integration access to the Trolley API.
 
-[^1]: [Payment Rails is now Trolley](https://www.trolley.com/payment-rails-is-now-trolley-series-a), we'll be updating our SDKs to support the new domain during the first half of 2022.
+[^1]: [Payment Rails is now Trolley](https://www.trolley.com/payment-rails-is-now-trolley-series-a). We're in the process of updating our SDKs to support the new domain. In this transition phase, you might still see "PaymentRails" at some places.
 
 ## Requirements
 
@@ -19,7 +19,7 @@ openssl
 
 ## Installation & Usage
 
-### Library
+### SDK
 
 ```bash
 git clone https://github.com/PaymentRails/php-sdk.git
@@ -73,7 +73,7 @@ try {
 
 ## Documentation for API Endpoints
 
-All URIs are available at http://docs.paymentrails.com/
+All URIs are available at https://docs.trolley.com/
 
 ## Running SDK from Source  
   1. Clone this repo.
@@ -83,5 +83,6 @@ All URIs are available at http://docs.paymentrails.com/
 ### Running the tests from SDK  
 To run the tests in the terminal, use the PHPUnit test suite from within the `tests` directory, like the following:  
 ```
+$ cd tests
 $ ../vendor/bin/phpunit integration/RecipientTest.php
 ```
diff --git a/composer.json b/composer.json
@@ -1,16 +1,17 @@
 {
     "name": "paymentrails/php-sdk",
     "type": "library",
-    "description": "Payment Rails PHP Client Library",
+    "description": "Trolley PHP SDK",
     "homepage": "https://github.com/PaymentRails/php-sdk",
     "keywords": [
-        "PaymentRails"
+        "PaymentRails",
+        "Trolley"
     ],
     "license": "MIT",
     "authors": [
         {
-            "name": "PaymentRails",
-            "homepage": "https://www.paymentrails.com"
+            "name": "Trolley (previously PaymentRails)",
+            "homepage": "https://www.trolley.com"
         }
     ],
     "require": {
diff --git a/lib/PaymentRails.php b/lib/PaymentRails.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * PaymentRails PHP Library
+ * Trolley (PaymentRails) PHP SDK
  * Creates class_aliases for old class names replaced by PSR-4 Namespaces
  */
 
@@ -16,7 +16,7 @@ public static function requireDependencies() {
         $requiredExtensions = ['xmlwriter', 'openssl', 'dom', 'hash', 'curl'];
         foreach ($requiredExtensions AS $ext) {
             if (!extension_loaded($ext)) {
-                throw new PaymentRails_Exception('The PaymentRails library requires the ' . $ext . ' extension.');
+                throw new PaymentRails_Exception('The Trolley SDK requires the ' . $ext . ' extension.');
             }
         }
     }
diff --git a/lib/PaymentRails/Balance.php b/lib/PaymentRails/Balance.php
@@ -2,7 +2,7 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails Balance module
+ * Trolley (PaymentRails) Balance module
  * PHP Version 5
  * Gets merchant balances
  *
diff --git a/lib/PaymentRails/BalanceGateway.php b/lib/PaymentRails/BalanceGateway.php
@@ -4,12 +4,12 @@
 use InvalidArgumentException;
 
 /**
- * PaymentRails Balance processor
+ * Trolley (PaymentRails) Balance processor
  * Gets balances
  *
  * <b>== More information ==</b>
  *
- * For more detailed information on Balance, see {@link http://docs.paymentrails.com/#balances}
+ * For more detailed information on Balance, see {@link https://docs.trolley.com/api/#balances}
  *
  * @package    PaymentRails
  * @category   Resources
@@ -33,7 +33,7 @@ public function __construct($gateway)
      *
      * If <b>query</b> is a string, the search will be a basic search.
      * If <b>query</b> is a hash, the search will be an advanced search.
-     * For more detailed information and examples, see {@link http://docs.paymentrails.com/#balances}
+     * For more detailed information and examples, see {@link https://docs.trolley.com/api/#balances}
      *
      * @param mixed $query search query
      * @param array $options options such as page number
diff --git a/lib/PaymentRails/Base.php b/lib/PaymentRails/Base.php
@@ -2,9 +2,9 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails PHP Library.
+ * Trolley (PaymentRails) PHP SDK.
  *
- * PaymentRails base class and initialization
+ * Trolley base class and initialization
  * Provides methods to child classes. This class cannot be instantiated.
  *
  *  PHP version 5
diff --git a/lib/PaymentRails/Batch.php b/lib/PaymentRails/Batch.php
@@ -2,7 +2,7 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails Batch module
+ * Trolley (PaymentRails) Batch module
  * PHP Version 5
  * Creates and manages batches of payments
  *
diff --git a/lib/PaymentRails/BatchGateway.php b/lib/PaymentRails/BatchGateway.php
@@ -4,12 +4,12 @@
 use InvalidArgumentException;
 
 /**
- * PaymentRails Batch processor
+ * Trolley (PaymentRails) Batch processor
  * Creates and manages batches
  *
  * <b>== More information ==</b>
  *
- * For more detailed information on Batch, see {@link http://docs.paymentrails.com/#create-a-batch}
+ * For more detailed information on Batch, see {@link https://docs.trolley.com/api/#create-a-batch}
  *
  * @package    PaymentRails
  * @category   Resources
@@ -33,7 +33,7 @@ public function __construct($gateway)
      *
      * If <b>query</b> is a string, the search will be a basic search.
      * If <b>query</b> is a hash, the search will be an advanced search.
-     * For more detailed information and examples, see {@link http://docs.paymentrails.com/#create-a-batch}
+     * For more detailed information and examples, see {@link https://docs.trolley.com/api/#create-a-batch}
      *
      * @param mixed $query search query
      * @param array $options options such as page number
diff --git a/lib/PaymentRails/BatchSummary.php b/lib/PaymentRails/BatchSummary.php
@@ -2,7 +2,7 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails BatchSummary Data
+ * Trolley (PaymentRails) BatchSummary Data
  * PHP Version 5
  * Creates and manages batches of payments
  *
diff --git a/lib/PaymentRails/Configuration.php b/lib/PaymentRails/Configuration.php
@@ -29,7 +29,7 @@ class Configuration
     private $_acceptGzipEncoding = true;
 
     /**
-     * PaymentRails API version to use
+     * Trolley API version to use
      * @access public
      */
     const API_VERSION =  1;
@@ -85,7 +85,7 @@ public static function privateKey($value=null)
      * Sets or gets the read timeout to use for making requests.
      *
      * @param integer $value If provided, sets the read timeout
-     * @return integer The read timeout used for connecting to PaymentRails
+     * @return integer The read timeout used for connecting to Trolley
      */
     public static function timeout($value=null)
     {
@@ -101,7 +101,7 @@ public static function timeout($value=null)
      * CURLOPT_SSLVERSION values.
      *
      * @param integer $value If provided, sets the SSL version
-     * @return integer The SSL version used for connecting to PaymentRails
+     * @return integer The SSL version used for connecting to Trolley
      */
     public static function sslVersion($value=null)
     {
@@ -112,10 +112,10 @@ public static function sslVersion($value=null)
     }
 
     /**
-     * Sets or gets the proxy host to use for connecting to PaymentRails
+     * Sets or gets the proxy host to use for connecting to Trolley
      *
      * @param string $value If provided, sets the proxy host
-     * @return string The proxy host used for connecting to PaymentRails
+     * @return string The proxy host used for connecting to Trolley
      */
     public static function proxyHost($value = null)
     {
@@ -126,10 +126,10 @@ public static function proxyHost($value = null)
     }
 
     /**
-     * Sets or gets the port of the proxy to use for connecting to PaymentRails
+     * Sets or gets the port of the proxy to use for connecting to Trolley
      *
      * @param string $value If provided, sets the port of the proxy
-     * @return string The port of the proxy used for connecting to PaymentRails
+     * @return string The port of the proxy used for connecting to Trolley
      */
     public static function proxyPort($value = null)
     {
@@ -140,11 +140,11 @@ public static function proxyPort($value = null)
     }
 
     /**
-     * Sets or gets the proxy type to use for connecting to PaymentRails. This value
+     * Sets or gets the proxy type to use for connecting to Trolley. This value
      * can be any of the CURLOPT_PROXYTYPE options in PHP cURL.
      *
      * @param string $value If provided, sets the proxy type
-     * @return string The proxy type used for connecting to PaymentRails
+     * @return string The proxy type used for connecting to Trolley
      */
     public static function proxyType($value = null)
     {
@@ -391,7 +391,7 @@ public function isClientCredentials()
         return !empty($this->_clientId);
     }
     /**
-     * returns the base paymentrails gateway URL based on config values
+     * returns the base Trolley gateway URL based on config values
      *
      * @access public
      * @param none
@@ -440,20 +440,20 @@ public function serverName()
     {
         switch($this->_environment) {
          case 'production':
-             $serverName = 'https://api.paymentrails.com';
+             $serverName = 'https://api.trolley.com';
              break;
 	     case 'development':
          case 'qa':
              $serverName = 'https://api.railz.io';
              break;
          case 'sandbox':
-             $serverName = 'https://api.sandbox.paymentrails.com';
+             $serverName = 'https://api.sandbox.trolley.com';
              break;         
          case 'integration':
              $serverName = 'http://api.local.dev:3000';
              break;
          default:
-             $serverName = 'https://api.paymentrails.com';
+             $serverName = 'https://api.trolley.com';
              break;
         }
         return $serverName;
@@ -496,7 +496,7 @@ public function sslOn()
      */
     public function logMessage($message)
     {
-        error_log('[PaymentRails] ' . $message);
+        error_log('[Trolley] ' . $message);
     }
 }
 
diff --git a/lib/PaymentRails/Exception.php b/lib/PaymentRails/Exception.php
@@ -3,7 +3,7 @@
 namespace PaymentRails;
 
 /**
- * super class for all PaymentRails exceptions
+ * super class for all Trolley (PaymentRails) exceptions
  *
  * @package    PaymentRails
  * @subpackage Exception
diff --git a/lib/PaymentRails/Gateway.php b/lib/PaymentRails/Gateway.php
@@ -2,7 +2,7 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails gateway module
+ * Trolley (PaymentRails) gateway module
  *
  * @package    PaymentRails
  * @category   Resources
diff --git a/lib/PaymentRails/Http.php b/lib/PaymentRails/Http.php
@@ -4,7 +4,7 @@
 use finfo;
 
 /**
- * PaymentRails HTTP Client
+ * Trolley (PaymentRails) HTTP Client
  * processes Http requests using curl
  */
 class Http
@@ -154,6 +154,7 @@ public function _doUrlRequest($httpVerb, $url, $path, $requestBody = null)
         $headers[] = "Authorization: prsign " . $this->_config->getPublicKey() . ":" . $signature;
         $headers[] = "X-PR-Timestamp: " . $timestamp;
         $headers[] = 'User-Agent: PaymentRails PHP Library version=' . Version::get();
+        $headers[] = "Trolley-Source: php-sdk_" . Version::get();
 
         curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
 
diff --git a/lib/PaymentRails/OfflinePayment.php b/lib/PaymentRails/OfflinePayment.php
@@ -2,7 +2,7 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails Payment Module
+ * Trolley (PaymentRails) Payment Module
  * PHP Version 5
  * Creates and manages Offline Payments
  *
diff --git a/lib/PaymentRails/OfflinePaymentGateway.php b/lib/PaymentRails/OfflinePaymentGateway.php
@@ -4,13 +4,13 @@
 use InvalidArgumentException;
 
 /**
- * PaymentRails Offline Payment processor
+ * Trolley (PaymentRails) Offline Payment processor
  * Creates and manages transactions
  *
  *
  * <b>== More information ==</b>
  *
- * For more detailed information on Offline Payments, see {@link http://docs.paymentrails.com/#create-an-offline-payment}
+ * For more detailed information on Offline Payments, see {@link https://docs.trolley.com/api/#create-an-offline-payment}
  *
  * @package    PaymentRails
  * @category   Resources
@@ -35,7 +35,7 @@ public function __construct($gateway)
      *
      * If <b>query</b> is a string, the search will be a basic search.
      * If <b>query</b> is a hash, the search will be an advanced search.
-     * For more detailed information and examples, see {@link http://docs.paymentrails.com/#offline-payments}
+     * For more detailed information and examples, see {@link https://docs.trolley.com/api/#offline-payments}
      *
      * @param mixed $query search query
      * @param array $options options such as page number
diff --git a/lib/PaymentRails/Payment.php b/lib/PaymentRails/Payment.php
@@ -2,7 +2,7 @@
 namespace PaymentRails;
 
 /**
- * PaymentRails Payment Module
+ * Trolley (PaymentRails) Payment Module
  * PHP Version 5
  * Creates and manages Payments
  *
diff --git a/lib/PaymentRails/PaymentGateway.php b/lib/PaymentRails/PaymentGateway.php
@@ -4,13 +4,13 @@
 use InvalidArgumentException;
 
 /**
- * PaymentRails Payment processor
+ * Trolley (PaymentRails) Payment processor
  * Creates and manages transactions
  *
  *
  * <b>== More information ==</b>
  *
- * For more detailed information on Payment, see {@link http://docs.paymentrails.com/#create-a-payment}
+ * For more detailed information on Payment, see {@link https://docs.trolley.com/api/#create-a-payment}
  *
  * @package    PaymentRails
  * @category   Resources
@@ -35,7 +35,7 @@ public function __construct($gateway)
      *
      * If <b>query</b> is a string, the search will be a basic search.
      * If <b>query</b> is a hash, the search will be an advanced search.
-     * For more detailed information and examples, see {@link http://docs.paymentrails.com/#recipients}
+     * For more detailed information and examples, see {@link https://docs.trolley.com/api/#recipients}
      *
      * @param mixed $query search query
      * @param array $options options such as page number
diff --git a/lib/PaymentRails/Recipient.php b/lib/PaymentRails/Recipient.php
diff --git a/lib/PaymentRails/RecipientAccount.php b/lib/PaymentRails/RecipientAccount.php
diff --git a/lib/PaymentRails/RecipientAccountGateway.php b/lib/PaymentRails/RecipientAccountGateway.php
diff --git a/lib/PaymentRails/RecipientAddress.php b/lib/PaymentRails/RecipientAddress.php
diff --git a/lib/PaymentRails/RecipientGateway.php b/lib/PaymentRails/RecipientGateway.php
diff --git a/lib/PaymentRails/ResourceCollection.php b/lib/PaymentRails/ResourceCollection.php
diff --git a/lib/PaymentRails/Version.php b/lib/PaymentRails/Version.php
diff --git a/tests/integration/RecipientTest.php b/tests/integration/RecipientTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2017 Payment Rails, Inc.`
	`1`	`+Copyright (c) 2017 Trolley, Inc.`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person`
`4`	`4`	`obtaining a copy of this software and associated documentation`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`	`3`	`/**`
`4`		`- * PaymentRails PHP Library`
	`4`	`+ * Trolley (PaymentRails) PHP SDK`
`5`	`5`	`* Creates class_aliases for old class names replaced by PSR-4 Namespaces`
`6`	`6`	`*/`
`7`	`7`
`@@ -16,7 +16,7 @@ public static function requireDependencies() {`
`16`	`16`	`$requiredExtensions = ['xmlwriter', 'openssl', 'dom', 'hash', 'curl'];`
`17`	`17`	`foreach ($requiredExtensions AS $ext) {`
`18`	`18`	`if (!extension_loaded($ext)) {`
`19`		`- throw new PaymentRails_Exception('The PaymentRails library requires the ' . $ext . ' extension.');`
	`19`	`+ throw new PaymentRails_Exception('The Trolley SDK requires the ' . $ext . ' extension.');`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`namespace PaymentRails;`
`3`	`3`
`4`	`4`	`/**`
`5`		`- * PaymentRails Balance module`
	`5`	`+ * Trolley (PaymentRails) Balance module`
`6`	`6`	`* PHP Version 5`
`7`	`7`	`* Gets merchant balances`
`8`	`8`	`*`
Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,12 @@`
`4`	`4`	`use InvalidArgumentException;`
`5`	`5`
`6`	`6`	`/**`
`7`		`- * PaymentRails Balance processor`
	`7`	`+ * Trolley (PaymentRails) Balance processor`
`8`	`8`	`* Gets balances`
`9`	`9`	`*`
`10`	`10`	`* <b>== More information ==</b>`
`11`	`11`	`*`
`12`		`- * For more detailed information on Balance, see {@link http://docs.paymentrails.com/#balances}`
	`12`	`+ * For more detailed information on Balance, see {@link https://docs.trolley.com/api/#balances}`
`13`	`13`	`*`
`14`	`14`	`* @package PaymentRails`
`15`	`15`	`* @category Resources`
`@@ -33,7 +33,7 @@ public function __construct($gateway)`
`33`	`33`	`*`
`34`	`34`	`* If <b>query</b> is a string, the search will be a basic search.`
`35`	`35`	`* If <b>query</b> is a hash, the search will be an advanced search.`
`36`		`- * For more detailed information and examples, see {@link http://docs.paymentrails.com/#balances}`
	`36`	`+ * For more detailed information and examples, see {@link https://docs.trolley.com/api/#balances}`
`37`	`37`	`*`
`38`	`38`	`* @param mixed $query search query`
`39`	`39`	`* @param array $options options such as page number`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`	`namespace PaymentRails;`
`3`	`3`
`4`	`4`	`/**`
`5`		`- * PaymentRails PHP Library.`
	`5`	`+ * Trolley (PaymentRails) PHP SDK.`
`6`	`6`	`*`
`7`		`- * PaymentRails base class and initialization`
	`7`	`+ * Trolley base class and initialization`
`8`	`8`	`* Provides methods to child classes. This class cannot be instantiated.`
`9`	`9`	`*`
`10`	`10`	`* PHP version 5`