Merge pull request #3 from ctwillie/development

Merged v0.1.1

Author: ctwillie

.gitignore

@@ -4,4 +4,5 @@ composer.lock
 index.php
 notes.php
 todo.txt
-/src/Removed
+/src/Removed
+dev-notes.txt

README.md

@@ -62,7 +62,7 @@ $address = new Address([
 
 $response = $address->validate();
 ```
-The USPS api supports up to 5 address validations per request. If you need to validate more than one address at a time, pass a multi dim array to the `Address` constructor.
+The USPS api supports up to 5 address validations per request. If you need to validate more than one address at a time, pass an array of addresses to the `Address` constructor.
 
 ```php
 use ctwillie\Usps\Address;
@@ -81,7 +81,7 @@ $address2 = [
     'Zip5' => 20770
 ];
 
-$addresses = new Address([$address1, $address2])
+$addresses = new Address([$address1, $address2]);
 
 $response = $addresses->validate();
 ```

composer.json

@@ -24,7 +24,7 @@
   },
   "autoload": {
     "psr-4": {
-      "ctwillie\\": "src/"
+      "ctwillie\\Usps\\": "src/"
     }
   },
   "minimum-stability": "dev"

dev-notes.txt

@@ -34,7 +34,7 @@ public function __construct() {
     }
 
     /** Determines the current application env */
-    public function setEnvironment()
+    protected function setEnvironment()
     {
         if (Config::has('services.usps.env')) {
 
@@ -49,7 +49,7 @@ public function setEnvironment()
     }
 
     /** Determines the api url to use based on running env */
-    public function setUrl()
+    protected function setUrl()
     {
         $this->apiUrl = $this->env === 'local' ? self::LOCAL_URL : self::PROD_URL;
     }
@@ -59,62 +59,103 @@ public function setUrl()
      * 
      * @throws Exception If no userid is found in config/services.php
      */
-    public function checkForUserId()
+    protected function checkForUserId()
     {
         if (is_null($this->userId)) {
+
             throw new \Exception('USPS: A user ID is required. None found in config/services.php');
+
         }
     }
 
     /**
-     * Converts entity data into xml format and url encodes
+     * Converts entity data into xml format
      * 
      * @return string
      */
     protected function convertToXML()
     {
-        $xml = ArrayToXml::convert( $this->getRequestData(),
+        return ArrayToXml::convert( $this->getRequestData(),
             [
                 'rootElementName' => $this->rootElements[$this->apiType],
 
                 '_attributes' => ['USERID' => $this->userId]
 
             ], false
         );
-        return urlencode($xml);
     }
 
     /**
-     * Handles making the api request
+     * Handles making the api request and formatting response type
      * 
      * This method handles creating the http client and gathering
      * all necessary data for making the api request.
      * 
-     * @return StreamInterface of the response content body
+     * @param string|null $responseType
+     * @return mixed depending on $responseType param
      */
-    public function makeRequest()
+    protected function makeRequest(string $responseType = null)
     {
         $this->checkForUserId();
 
-        $xml = $this->convertToXML();
+        $xml = urlencode($this->convertToXML());
 
         $client = new Client(['base_uri' => $this->apiUrl, 'verify' => config('services.usps.verifyssl', true)]);
 
         $response =  $client->request('GET', "?API=$this->apiType&XML=$xml");
 
-        return $response->getBody();
+        // converts stream to xml string
+        $body = (string) $response->getBody();
+        
+        return $this->convertResponse($body, $responseType);
+    }
+
+    /**
+     * Responsible for converting api responses to desired format
+     * 
+     * The api response will return an assoc array by default
+     * 
+     * @param string $body xml string from api response
+     * @param string $responseType desired response format ('json', 'object', 'string')
+     * @return mixed
+     */
+    protected function convertResponse($body, $responseType)
+    {
+        switch(strtolower($responseType)) {
+            case 'string':
+                return $body;
+                break;
+            case 'json':
+                $xml = simplexml_load_string( $body );
+                return json_encode($xml);
+                break;
+            case 'object':
+                $xml = simplexml_load_string($body);
+                return json_decode(json_encode($xml));
+                break;
+            default:
+                $xml = simplexml_load_string($body);
+                return json_decode(json_encode($xml), true);
+                break;
+        }
     }
 
     /**
      * Each entity decides the array structure for the request data
      * 
      * @return array
      */
-    abstract public function getRequestData();
+    abstract protected function getRequestData();
 
-    public function validate()
+    /**
+     * Alias for makeRequest
+     * 
+     * @param string $responseType The desired format of the response
+     * @return mixed depending on $responseType param
+     */
+    public function validate(string $responseType = null)
     {
-        return $this->makeRequest();
+        return $this->makeRequest($responseType);
     }
 
 }