Version Bump v3.0.0: Made the Request and Response variables non-redundant. e.g. request.requestBody becomes request.body

Author: thinkingserious

.env_sample

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0] - 2016-06-06
+### Changed
+- Made the Request and Response variables non-redundant. e.g. request.requestBody becomes request.body
+
 ## [2.0.2] - 2016-02-29
 ### Fixed
 - Renaming files to conform to PSR-0, git ignored the case in 2.0.1

CHANGELOG.md

@@ -42,8 +42,8 @@ $global_headers = array(Authorization: Basic XXXXXXX);
 $client = SendGrid\Client('base_url', 'global_headers');
 $response = $client->your()->api()->_($param)->call()->get();
 print $response->statusCode();
-print $response->responseHeaders();
-print $response->responseBody();
+print $response->headers();
+print $response->body();
 ```
 
 `POST /your/api/{param}/call` with headers, query parameters and a request body with versioning.
@@ -59,8 +59,8 @@ $response = $client->your()->api()->_($param)->call()->post('data',
                                                             'query_params',
                                                             'request_headers');
 print $response->statusCode();
-print $response->responseHeaders();
-print $response->responseBody();
+print $response->headers();
+print $response->body();
 ```
 
 # Usage

README.md

@@ -2,7 +2,7 @@
     "name": "sendgrid/php-http-client",
     "description": "HTTP REST client, simplified for PHP",
     "type": "library",
-    "version": "2.0.2",
+    "version": "3.0.0",
     "require-dev": {
         "phpunit/phpunit": "~4.4",
         "squizlabs/php_codesniffer": "2.*"

composer.json

@@ -3,10 +3,8 @@
 // comment out the two includes below
 // require __DIR__ . '/vendor/autoload.php';
 include(dirname(__DIR__).'/lib/SendGrid/client.php');
-include(dirname(__DIR__).'/lib/SendGrid/config.php');
 // This gets the parent directory, for your current directory use getcwd()
 $path_to_config = dirname(__DIR__);
-$config = new SendGrid\Config($path_to_config, '.env');
 $api_key = getenv('SENDGRID_API_KEY');
 $headers = array(
     'Content-Type: application/json',
@@ -19,8 +17,8 @@
 $request_headers = array('X-Mock: 200');
 $response = $client->api_keys()->get(null, $query_params, $request_headers);
 echo $response->statusCode();
-echo $response->responseBody();
-echo $response->responseHeaders();
+echo $response->body();
+echo $response->headers();
 
 // POST
 $request_body = array(
@@ -33,25 +31,25 @@
 );
 $response = $client->api_keys()->post($request_body);
 echo $response->statusCode();
-echo $response->responseBody();
-echo $response->responseHeaders();
-$response_body = json_decode($response->responseBody());
+echo $response->body();
+echo $response->headers();
+$response_body = json_decode($response->body());
 $api_key_id = $response_body->api_key_id;
 
 // GET Single
 $response = $client->version('/v3')->api_keys()->_($api_key_id)->get();
 echo $response->statusCode();
-echo $response->responseBody();
-echo $response->responseHeaders();
+echo $response->body();
+echo $response->headers();
 
 // PATCH
 $request_body = array(
         'name' => 'A New Hope'
 );
 $response = $client->api_keys()->_($api_key_id)->patch($request_body);
 echo $response->statusCode();
-echo $response->responseBody();
-echo $response->responseHeaders();
+echo $response->body();
+echo $response->headers();
 
 // PUT
 $request_body = array(
@@ -63,13 +61,13 @@
 );
 $response = $client->api_keys()->_($api_key_id)->put($request_body);
 echo $response->statusCode();
-echo $response->responseBody();
-echo $response->responseHeaders();
+echo $response->body();
+echo $response->headers();
 
 // DELETE
 $response = $client->api_keys()->_($api_key_id)->delete();
 echo $response->statusCode();
-echo $response->responseBody();
-echo $response->responseHeaders();
+echo $response->body();
+echo $response->headers();
 
 ?>

examples/example.php

@@ -1,5 +1,5 @@
 <?php
-/** 
+/**
   * HTTP Client library
   *
   * PHP version 5.2
@@ -28,10 +28,10 @@ class Response
     function __construct($status_code = null, $response_body = null, $response_headers = null)
     {
         $this->_status_code = $status_code;
-        $this->_response_body = $response_body;
-        $this->_response_headers = $response_headers;
+        $this->_body = $response_body;
+        $this->_headers = $response_headers;
     }
-    
+
     /**
     * The status code
     *
@@ -47,19 +47,19 @@ public function statusCode()
     *
     * @return array
     */
-    public function responseBody() 
+    public function body()
     {
-        return $this->_response_body;
+        return $this->_body;
     }
 
     /**
     * The response headers
     *
     * @return array
     */
-    public function responseHeaders() 
+    public function headers()
     {
-        return $this->_response_headers;
+        return $this->_headers;
     }
 }
 
@@ -68,22 +68,22 @@ public function responseHeaders()
   */
 class Client
 {
-    
-    public 
+
+    public
       $host,
       $request_headers,
       $version,
       $url_path,
-      $methods;    
- 
+      $methods;
+
     /**
       * Initialize the client
       *
       * @param string $host            the base url (e.g. https://api.sendgrid.com)
       * @param array  $request_headers global request headers
       * @param string $version         api version (configurable)
       * @param array  $url_path        holds the segments of the url path
-      */   
+      */
     function __construct($host, $request_headers = null, $version = null, $url_path = null)
     {
         $this->host = $host;
@@ -110,7 +110,7 @@ private function _buildClient($name = null)
         $this->url_path = [];
         return new Client($this->host, $this->request_headers, $this->version, $url_path);
     }
-  
+
     /**
       * Subclass this function for your own needs.
       *  Or just pass the version as part of the URL
@@ -120,7 +120,7 @@ private function _buildClient($name = null)
       *
       * @return string
     */
-    private function _buildVersionedUrl($url) 
+    private function _buildVersionedUrl($url)
     {
         return sprintf("%s%s%s", $this->host, $this->version, $url);
     }
@@ -129,10 +129,10 @@ private function _buildVersionedUrl($url)
       * Build the final URL to be passed
       *
       * @param array $query_params an array of all the query parameters
-      * 
+      *
       * @return string
       */
-    private function _buildUrl($query_params = null) 
+    private function _buildUrl($query_params = null)
     {
         $url = '/'.implode('/', $this->url_path);
         if (isset($query_params)) {
@@ -155,10 +155,10 @@ private function _buildUrl($query_params = null)
       * @param string $url             the final url to call
       * @param array  $request_body    request body
       * @param array  $request_headers any additional request headers
-      * 
+      *
       * @return Response object
       */
-    public function makeRequest($method, $url, $request_body = null, $request_headers = null) 
+    public function makeRequest($method, $url, $request_body = null, $request_headers = null)
     {
         $curl = curl_init($url);
         curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
@@ -179,9 +179,9 @@ public function makeRequest($method, $url, $request_body = null, $request_header
         $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         $response_body = substr($curl_response, $header_size);
         $response_header = substr($curl_response, 0, $header_size);
-        
+
         curl_close($curl);
-        
+
         return new Response($status_code, $response_body, $response_header);
     }
 
@@ -192,10 +192,10 @@ public function makeRequest($method, $url, $request_body = null, $request_header
       * in your url, you must use this method.
       *
       * @param string $name name of the url segment
-      * 
+      *
       * @return Client object
       */
-    public function _($name = null) 
+    public function _($name = null)
     {
         return $this->_buildClient($name);
     }
@@ -206,24 +206,24 @@ public function _($name = null)
       *
       * @param string $name name of the dynamic method call or HTTP verb
       * @param array  $args parameters passed with the method call
-      * 
+      *
       * @return Client or Response object
       */
     public function __call($name, $args)
-    {    
+    {
         if($name == 'version') {
             $this->version = $args[0];
             return $this->_();
         }
-      
+
         if (in_array($name, $this->methods)) {
             $query_params = ((count($args) >= 2) ? $args[1] : null);
             $url = $this->_buildUrl($query_params);
             $request_body = ($args ? $args[0] : null);
             $request_headers = ((count($args) == 3) ? $args[2] : null);
             return $this->makeRequest($name, $url, $request_body, $request_headers);
         }
-      
+
         return $this->_($name);
     }
 }

lib/SendGrid/Client.php

@@ -1,6 +1,5 @@
 <?php
 include(dirname(dirname(__FILE__)) . '/../lib/SendGrid/client.php');
-include(dirname(dirname(__FILE__)) . '/../lib/SendGrid/config.php');
 require __DIR__ . '/../../vendor/autoload.php';
 function autoload_tests($class)
 {