ruby_http_client 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 915aca3c1ef2db0465b051e7a30aa8af13918469
-  data.tar.gz: 3a296aa133c66dd033b7be2b4483b0a3e085c242
+  metadata.gz: 3f9d4f32d8569bd5aa2e86656e3d6e68b5334442
+  data.tar.gz: 475cbb494afc68fe05165188196d7ae5f4e56113
 SHA512:
-  metadata.gz: e8e6f3b4c8c1c32d56fd0ed8dc7f845d5bb6ddd232305b532642a6340fe6fce102ddfa11687af5ac1cb8541ecb1ef0d6954e7583143b5dbaf39571dba68d0c74
-  data.tar.gz: 67b7f3b7d8db5bc929e566c0296e8f9297a9d8f921cdc916f0e755b5fe22eaaf9987d48b5618ccb6054d7f58c28e419328604db8fc5a65bd92575f3b163cd0e3
+  metadata.gz: 98ed2fbc4320ce9a9391db9f63d3c7bc02f27eb52cddb548af2a2b98dcb55ab015477911af84850aedcfc0a5b11992aaa50cf2b544df1f333461459e6b08e0ea
+  data.tar.gz: ce31fc3da4472576bfc3f2ca373c1a9719a3d3f34d8d3a3567737dea9152aeafa2ec04ac1eb39b467605f5d9b6e091ecb699e3b07b502fad0bc5963670f3c4d4

data/.gitignore

@@ -1,3 +1,4 @@
+bin
 *.gem
 *.rbc
 /.config
@@ -28,7 +29,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.1.0] - 2016-04-10
+### Added
+- #5 Ability to set the Content-Type header
+- Thanks to [Wataru Sato](https://github.com/awwa) for the pull request!
+
 ## [3.0.2] - 2016-04-10
 ### Update
 - #8 Internal refactor

data/README.md

@@ -12,7 +12,7 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
 
 ## Prerequisites
 
-- Ruby version 2.2
+- Ruby version 2.2+
 
 ## Install Package
 
@@ -27,7 +27,7 @@ gem install ruby_http_client
 ```ruby
 require 'ruby_http_client'
 global_headers = {'Authorization' => 'Basic XXXXXXX' }
-client = SendGrid::Client(host: 'base_url', request_headers: global_headers)
+client = SendGrid::Client.new(host: 'base_url', request_headers: global_headers)
 client.your.api._(param).call.get
 puts response.status_code
 puts response.body
@@ -39,7 +39,7 @@ puts response.headers
 ```ruby
 require 'ruby_http_client'
 global_headers = {'Authorization' => 'Basic XXXXXXX' }
-client = SendGrid::Client(host: 'base_url', request_headers: global_headers)
+client = SendGrid::Client.new(host: 'base_url', request_headers: global_headers)
 query_params = { 'hello' => 0, 'world' => 1 }
 request_headers = { 'X-Test' => 'test' }
 data = { 'some' => 1, 'awesome' => 2, 'data' => 3}

data/lib/ruby_http_client.rb

@@ -19,7 +19,7 @@ module SendGrid
 
   # A simple REST client.
   class Client
-    attr_reader :host, :request_headers, :url_path
+    attr_reader :host, :request_headers, :url_path, :request, :http
     # * *Args*    :
     #   - +host+ -> Base URL for the api. (e.g. https://api.sendgrid.com)
     #   - +request_headers+ -> A hash of the headers you want applied on
@@ -132,18 +132,21 @@ module SendGrid
     def build_request(name, args)
       build_args(args) if args
       uri = build_url(query_params: @query_params)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http = add_ssl(http)
+      @http = add_ssl(Net::HTTP.new(uri.host, uri.port))
       net_http = Kernel.const_get('Net::HTTP::' + name.to_s.capitalize)
-      request = net_http.new(uri.request_uri)
-      request = build_request_headers(request)
-      request.body = @request_body.to_json if @request_body
-      if request.body
-        request['Content-Type'] = 'application/json'
-      elsif !request.body and (name.to_s == "post")
-        request['Content-Type'] = ''
+      @request = build_request_headers(net_http.new(uri.request_uri))
+      if (@request_body &&
+          (!@request_headers.has_key?('Content-Type') ||
+           @request_headers['Content-Type'] == 'application/json')
+      )
+        @request.body = @request_body.to_json
+        @request['Content-Type'] = 'application/json'
+      elsif !@request_body and (name.to_s == "post")
+        @request['Content-Type'] = ''
+      else
+        @request.body = @request_body
       end
-      make_request(http, request)
+      make_request(@http, @request)
     end
 
     # Make the API call and return the response. This is separated into

data/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     = '3.0.2'
+  spec.version     = '3.1.0'
   spec.authors     = ['Elmer Thomas']
   spec.email       = 'dx@sendgrid.com'
   spec.summary     = 'A simple REST client'

data/test/test_ruby_http_client.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/ruby_http_client'
+require 'ruby_http_client'
 require 'minitest/autorun'
 
 class MockResponse
@@ -50,20 +50,20 @@ class TestClient < Minitest::Test
   def test_build_request_headers
     request = {}
     request = @client.build_request_headers(request)
-    assert_equal(@client.request_headers, request)
+    assert_equal(request, @client.request_headers)
   end
 
   def test_add_version
     url = ''
     @client.add_version(url)
-    assert_equal(url, "/#{@version}")
+    assert_equal("/#{@version}", url)
   end
 
   def test_build_query_params
     url = ''
     query_params = { 'limit' => 100, 'offset' => 0 }
     url = @client.build_query_params(url, query_params)
-    assert_equal(url, '?limit=100&offset=0')
+    assert_equal('?limit=100&offset=0', url)
   end
 
   def test_build_url
@@ -71,28 +71,85 @@ class TestClient < Minitest::Test
     params = { 'limit' => 100, 'offset' => 0 }
     url = URI.parse(@host + '/' + @version +
                     '/my/path/to/the/endpoint?limit=100&offset=0')
-    assert_equal(url1.build_url(query_params: params), url)
+    assert_equal(url, url1.build_url(query_params: params))
 
     url1 = url1.one_more
     params = { 'limit' => 100, 'offset' => 0 }
     url = URI.parse(@host + '/' + @version +
                     '/my/path/to/the/endpoint/one_more?limit=100&offset=0')
-    assert_equal(url1.build_url(query_params: params), url)
+    assert_equal(url, url1.build_url(query_params: params))
 
     url2 = @client.my.path._('to').the.endpoint
     params = { 'limit' => 100, 'offset' => 0 }
     url = URI.parse(@host + '/' + @version +
                     '/my/path/to/the/endpoint?limit=100&offset=0')
-    assert_equal(url2.build_url(query_params: params), url)
+    assert_equal(url, url2.build_url(query_params: params))
   end
 
   def test_build_request
     name = 'get'
     args = nil
     response = @client.build_request(name, args)
-    assert_equal(response.status_code, 200)
-    assert_equal(response.body, 'message' => 'success')
-    assert_equal(response.headers, 'headers' => 'test')
+    assert_equal(200, response.status_code)
+    assert_equal({'message' => 'success'}, response.body)
+    assert_equal({'headers' => 'test'}, response.headers)
+  end
+
+  def test_build_request_post_empty_content_type
+    headers = {
+    }
+    client = MockRequest.new(
+      host: 'https://localhost',
+      request_headers: headers,
+      version: 'v3'
+    )
+    args = [{'request_body' => {"hogekey" => "hogevalue"}}]
+    client.build_request('post', args)
+    assert_equal('application/json', client.request['Content-Type'])
+    assert_equal('{"hogekey":"hogevalue"}', client.request.body)
+  end
+
+  def test_build_request_get_application_json
+    headers = {
+      'Content-Type' => 'application/json'
+    }
+    client = MockRequest.new(
+      host: 'https://localhost',
+      request_headers: headers,
+      version: 'v3'
+    )
+    client.build_request('get', nil)
+    assert_equal('application/json', client.request['Content-Type'])
+    assert_equal(nil, client.request.body)
+  end
+
+  def test_build_request_post_empty_body
+    headers = {
+      'Content-Type' => 'application/json'
+    }
+    client = MockRequest.new(
+      host: 'https://localhost',
+      request_headers: headers,
+      version: 'v3'
+    )
+    client.build_request('post', nil)
+    assert_equal('', client.request['Content-Type'])
+    assert_equal(nil, client.request.body)
+  end
+
+  def test_build_request_post_multipart
+    headers = {
+      'Content-Type' => 'multipart/form-data; boundary=xYzZY'
+    }
+    client = MockRequest.new(
+      host: 'https://localhost',
+      request_headers: headers,
+    )
+    name = 'post'
+    args = [{'request_body' => 'hogebody'}]
+    client.build_request(name, args)
+    assert_equal('multipart/form-data; boundary=xYzZY', client.request['Content-Type'])
+    assert_equal('hogebody', client.request.body)
   end
 
   def add_ssl
@@ -105,13 +162,13 @@ class TestClient < Minitest::Test
 
   def test__
     url1 = @client._('test')
-    assert_equal(url1.url_path, ['test'])
+    assert_equal(['test'], url1.url_path)
   end
 
   def test_method_missing
     response = @client.get
-    assert_equal(response.status_code, 200)
-    assert_equal(response.body, 'message' => 'success')
-    assert_equal(response.headers, 'headers' => 'test')
+    assert_equal(200, response.status_code)
+    assert_equal({'message' => 'success'}, response.body)
+    assert_equal({'headers' => 'test'}, response.headers)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_http_client
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Elmer Thomas