Versiom Bump 2.0.0: Made the Response variables non-redundant. e.g. response.response_body becomes response.body

Author: thinkingserious

CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.0.0] - 2016-06-03
+### Changed
+- Made the Response variables non-redundant. e.g. response.response_body becomes response.body
+
+### Removed
+- Config class
+
 ## [1.1.0] - 2016-03-17
 ### Added
 - Config class moved to client

README.md

@@ -26,8 +26,8 @@ global_headers = {'Authorization' => 'Basic XXXXXXX' }
 client = SendGrid::Client(host: 'base_url', request_headers: global_headers)
 client.your.api._(param).call.get
 puts response.status_code
-puts response.response_body
-puts response.response_headers
+puts response.body
+puts response.headers
 ```
 
 `POST /your/api/{param}/call` with headers, query parameters and a request body with versioning.
@@ -43,8 +43,8 @@ response = client.your.api._(param).call.post(request_body: data,
                                               query_params: query_params,
                                               request_headers: request_headers)
 puts response.status_code
-puts response.response_body
-puts response.response_headers
+puts response.body
+puts response.headers
 ```
 
 # Usage

examples/example.rb

@@ -1,21 +1,21 @@
 require_relative '../lib/ruby_http_client'
 
-SendGrid::Config.new
+# This example uses the SendGrid API as an example
 headers = JSON.parse('
   {
     "Authorization": "Bearer ' + ENV['SENDGRID_API_KEY'] + '",
     "Content-Type": "application/json"
   }
 ')
-host = ENV['LOCAL_HOST']
+host =  'https://api.sendgrid.com'
 client = SendGrid::Client.new(host: host, request_headers: headers)
 
 # GET Collection
 query_params = { 'limit' => 100, 'offset' => 0 }
 response = client.version('v3').api_keys.get(query_params: query_params)
 puts response.status_code
-puts response.response_body
-puts response.response_headers
+puts response.body
+puts response.headers
 
 # POST
 request_body = JSON.parse('
@@ -30,15 +30,15 @@
 ')
 response = client.version('v3').api_keys.post(request_body: request_body)
 puts response.status_code
-puts response.response_body
-puts response.response_headers
-api_key_id = JSON.parse(response.response_body)['api_key_id']
+puts response.body
+puts response.headers
+api_key_id = JSON.parse(response.body)['api_key_id']
 
 # GET Single
 response = client.version('v3').api_keys._(api_key_id).get
 puts response.status_code
-puts response.response_body
-puts response.response_headers
+puts response.body
+puts response.headers
 
 # PATCH
 request_body = JSON.parse('
@@ -48,8 +48,8 @@
 ')
 response = client.api_keys._(api_key_id).patch(request_body: request_body)
 puts response.status_code
-puts response.response_body
-puts response.response_headers
+puts response.body
+puts response.headers
 
 # PUT
 request_body = JSON.parse('
@@ -63,10 +63,10 @@
 ')
 response = client.api_keys._(api_key_id).put(request_body: request_body)
 puts response.status_code
-puts response.response_body
-puts response.response_headers
+puts response.body
+puts response.headers
 
 # DELETE
 response = client.api_keys._(api_key_id).delete
 puts response.status_code
-puts response.response_headers
+puts response.headers

lib/ruby_http_client.rb

@@ -4,27 +4,16 @@ module SendGrid
   require 'net/http'
   require 'net/https'
 
-  # Loads environment variables from a .env file.
-  class Config
-    def initialize
-        File.open('./.env').readlines.each do |line|
-        key, value = line.split '='
-        ENV[key] = value.chomp
-        end
-        ENV
-    end
-  end
-  
   # Holds the response from an API call.
   class Response
     # * *Args*    :
     #   - +response+ -> A NET::HTTP response object
     #
-    attr_reader :status_code, :response_body, :response_headers
+    attr_reader :status_code, :body, :headers
     def initialize(response)
       @status_code = response.code
-      @response_body = response.body
-      @response_headers = response.to_hash.inspect
+      @body = response.body
+      @headers = response.to_hash.inspect
     end
   end
 

ruby_http_client.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = 'ruby_http_client'
-  spec.version     = '1.1.0'
+  spec.version     = '2.0.0'
   spec.authors     = ['Elmer Thomas']
   spec.email       = 'dx@sendgrid.com'
   spec.summary     = 'A simple REST client'

test/test_ruby_http_client.rb

@@ -2,12 +2,12 @@
 require 'minitest/autorun'
 
 class MockResponse
-  attr_reader :status_code, :response_body, :response_headers
+  attr_reader :status_code, :body, :headers
 
   def initialize(response)
     @status_code = response['code']
-    @response_body = response['body']
-    @response_headers = response['headers']
+    @body = response['body']
+    @headers = response['headers']
   end
 end
 
@@ -91,8 +91,8 @@ def test_build_request
     args = nil
     response = @client.build_request(name, args)
     assert_equal(response.status_code, 200)
-    assert_equal(response.response_body, 'message' => 'success')
-    assert_equal(response.response_headers, 'headers' => 'test')
+    assert_equal(response.body, 'message' => 'success')
+    assert_equal(response.headers, 'headers' => 'test')
   end
 
   def add_ssl
@@ -111,7 +111,7 @@ def test__
   def test_method_missing
     response = @client.get
     assert_equal(response.status_code, 200)
-    assert_equal(response.response_body, 'message' => 'success')
-    assert_equal(response.response_headers, 'headers' => 'test')
+    assert_equal(response.body, 'message' => 'success')
+    assert_equal(response.headers, 'headers' => 'test')
   end
 end