make host and port configurable (#16)

* [host] make host and port configurable

* fix test case

* added scheme

* make single root endpoint for the SAAS platform endpoint and fixed test cases

* [changelog] update

* [changelog] minor edits

Author: Vinay Bhalerao

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+### Changed
+- Allow custom host and port configurable for 3scale On premise SAAS platform [PR #16](https://github.com/3scale/3scale_ws_api_for_php/.)  Note: For example, the signature is changed from ```$url = "http://" . $this->getHost() . "/transactions/authorize.xml"``` to ```$url = $this->getHost() . "/transactions/oauth_authorize.xml";``` for endpoints
+
 ##[2.7.0] - 2017-02-16
 ### Added
 - Added support for (Service Tokens)[https://support.3scale.net/docs/accounts/tokens]

lib/ThreeScaleClient.php

@@ -17,30 +17,30 @@
  *
  * Objects of this class are stateless and can be shared through multiple
  * transactions and by multiple clients.
+ * DEFAULT_ROOT_ENDPOINT  su1.3scale.net communicates with 3scale SAAS platform. When connecting to an on-premise instance of the  3scale platform, replace it with correct scheme, host and port
  */
 class ThreeScaleClient {
-  const DEFAULT_HOST = 'su1.3scale.net';
+  const DEFAULT_ROOT_ENDPOINT = 'http://su1.3scale.net';
 
   private $providerKey = null;
-  private $host;
   private $httpClient;
+  private $host;
 
   /**
    * Create a ThreeScaleClient instance.
    *
    * @param $providerKey If (!Provider Key) then service token workflow is triggered.
-   * @param $host String Hostname of 3scale backend server. Usually there is no reason to use anything
-   *              else than the default value.
+   * @param $host String scheme + hostname + port of 3scale backend server or On-premise 3scale SAAS platform
    * @param $httpClient Object Object for handling HTTP requests. Default is CURL. Don't change it
    *                    unless you know what you are doing.
    */
-  public function __construct($providerKey = null, $host = self::DEFAULT_HOST, $httpClient = null) {
+  public function __construct($providerKey = null, $host = self::DEFAULT_ROOT_ENDPOINT, $httpClient = null) {
     if ($providerKey) {
       $this->providerKey = $providerKey;
     } 
 
-    $this->host = $host;
     $this->setHttpClient($httpClient);
+    $this->host   = $host;
   }
 
   /**
@@ -52,7 +52,7 @@ public function getProviderKey() {
   }
 
   /**
-   * Get hostname of 3scale backend server.
+   * Get hostname of backend server.
    * @return string
    */
   public function getHost() {
@@ -94,7 +94,7 @@ public function getHost() {
    */
 
      public function authorize($appId, $appKey = null, $credentials_or_service_id, $usage = null) {
-    $url = "http://" . $this->getHost() . "/transactions/authorize.xml";
+    $url =  $this->getHost() . "/transactions/authorize.xml";
     $params = array('app_id' => $appId);
 
     if ($credentials_or_service_id instanceof ThreeScaleClientCredentials ) {
@@ -156,7 +156,7 @@ public function authorize($appId, $appKey = null, $credentials_or_service_id, $u
    * </code>
    */
   public function oauth_authorize($appId, $credentials_or_service_id, $usage = null) {
-    $url = "http://" . $this->getHost() . "/transactions/oauth_authorize.xml";
+    $url = $this->getHost() . "/transactions/oauth_authorize.xml";
     $params = array('app_id' => $appId);
 
    if ($credentials_or_service_id instanceof ThreeScaleClientCredentials ) {
@@ -215,7 +215,7 @@ public function oauth_authorize($appId, $credentials_or_service_id, $usage = nul
    */
 
   public function authorize_with_user_key($userKey, $credentials_or_service_id, $usage = null) {
-    $url = "http://" . $this->getHost() . "/transactions/authorize.xml";
+    $url = $this->getHost() . "/transactions/authorize.xml";
     $params = array('user_key' => $userKey);
 
     if ($credentials_or_service_id instanceof ThreeScaleClientCredentials ) {
@@ -275,7 +275,7 @@ public function authorize_with_user_key($userKey, $credentials_or_service_id, $u
    */
 
    public function authrep($appId, $appKey = null, $credentials_or_service_id, $usage = null, $userId = null, $object = null, $no_body = null) {  
-    $url = "http://" . $this->getHost() . "/transactions/authrep.xml";
+    $url = $this->getHost() . "/transactions/authrep.xml";
 
     $params = array('app_id' => $appId);
 
@@ -337,7 +337,7 @@ public function authrep($appId, $appKey = null, $credentials_or_service_id, $usa
    */
 
   public function authrep_with_user_key($userKey, $credentials_or_service_id, $usage = null, $userId = null, $object = null, $no_body = null) {  
-    $url = "http://" . $this->getHost() . "/transactions/authrep.xml";
+    $url = $this->getHost() . "/transactions/authrep.xml";
 
     $params = array('user_key' => $userKey);
 
@@ -429,7 +429,7 @@ public function report($transactions, $credentials_or_service_id) {
       throw new InvalidArgumentException('no transactions to report');
     }
 
-    $url = "http://" . $this->getHost() . "/transactions.xml";
+    $url = $this->getHost() . "/transactions.xml";
 
     $params = array();
 

test/ThreeScaleClientTest.php

@@ -38,7 +38,7 @@ function testThrowsExceptionIfServiceTokenIsMissing() {
   function testDefaultHost() {
     $client = new ThreeScaleClient('1234abcd');
 
-    $this->assertEqual('su1.3scale.net', $client->getHost());
+    $this->assertEqual('http://su1.3scale.net', $client->getHost());
   }
 
   function testSuccessfulAuthorize() {
@@ -159,7 +159,7 @@ function testSuccessfulReport() {
 
   function testReportEncodesTransactions() {
     $this->httpClient->expectOnce('post',
-      array('http://' . ThreeScaleClient::DEFAULT_HOST . '/transactions.xml',
+      array(ThreeScaleClient::DEFAULT_ROOT_ENDPOINT . '/transactions.xml',
         array(
           'service_token' => '12345',
           'service_id' => '12345',