braintreehttp 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f9eecbaee9baceb441762bc358a9fdd70ff6775
-  data.tar.gz: 8cca413a46d85a6f02d4208ced9aff63a0473bef
+  metadata.gz: 5713242e8cfed8abeb24124ba10ca92c3e95ec2b
+  data.tar.gz: 93e09fa466ce4c6ecf25a506da8fd8305d7da6b5
 SHA512:
-  metadata.gz: 1231f2845245b696eea965a638bba671d9b1b342968e7855b705b053e90b00e7edb66b97528ecea0d17671ac3896b4a68f5c5e3f814deb3242160518f6a27656
-  data.tar.gz: 099178fdfadd1fd5ef8d01b01ae6df470bc5ca1be55234ce6816b4de02e6e659b42acb0dfd30523778e2c8edc9ab205bdcbd374520f737f7a4c44585007c6cce
+  metadata.gz: 2ddacb0b0df421383f074526d9cff0fbdce994f6b0c5f853498e16c9cb4d292b57638e26ee5b60576b05f73854abbb8690927792430ef3a14187fa9bc0ac4f8c
+  data.tar.gz: 1cbe84a0729e3077412e21b881c461aa07e6b73ba66ea0ebb1156bf808c7b0c5089a8b39e1c4420fdab5d2a190c9c79b19453c2d41d174764edad8313be9dab7

data/lib/braintreehttp/encoder.rb

@@ -1,5 +1,9 @@
-require 'json'
-require 'uri'
+require 'zlib'
+
+require_relative './serializers/json'
+require_relative './serializers/form_encoded'
+require_relative './serializers/text'
+require_relative './serializers/multipart'
 
 module BraintreeHttp
   class Encoder
@@ -10,24 +14,35 @@ module BraintreeHttp
     def serialize_request(req)
       raise UnsupportedEncodingError.new('HttpRequest did not have Content-Type header set') unless req.headers && (req.headers['content-type'] || req.headers['Content-Type'])
 
-      content_type = req.headers['content-type'] || req.headers['Content-Type']
-      content_type = content_type.first if content_type.kind_of?(Array)
+      content_type = _extract_header(req.headers, 'Content-Type')
 
       enc = _encoder(content_type)
       raise UnsupportedEncodingError.new("Unable to serialize request with Content-Type #{content_type}. Supported encodings are #{supported_encodings}") unless enc
 
-      enc.encode(req)
+      encoded = enc.encode(req)
+      content_encoding = _extract_header(req.headers, 'Content-Encoding')
+
+      if content_encoding == 'gzip'
+        encoded = Zlib::Deflate.deflate(encoded)
+      end
+
+      encoded
     end
 
     def deserialize_response(resp, headers)
       raise UnsupportedEncodingError.new('HttpResponse did not have Content-Type header set') unless headers && (headers['content-type'] || headers['Content-Type'])
 
-      content_type = headers['content-type'] || headers['Content-Type']
-      content_type = content_type.first if content_type.kind_of?(Array)
+      content_type = _extract_header(headers, 'Content-Type')
 
       enc = _encoder(content_type)
       raise UnsupportedEncodingError.new("Unable to deserialize response with Content-Type #{content_type}. Supported decodings are #{supported_encodings}") unless enc
 
+      content_encoding = _extract_header(headers, 'Content-Encoding')
+
+      if content_encoding == 'gzip'
+        resp = Zlib::Inflate.inflate(resp)
+      end
+
       enc.decode(resp)
     end
 
@@ -40,101 +55,12 @@ module BraintreeHttp
 
       @encoders[idx] if idx
     end
-  end
-
-  class Json
-    def encode(request)
-      JSON.generate(request.body)
-    end
-
-    def decode(body)
-      JSON.parse(body)
-    end
-
-    def content_type
-      /^application\/json$/
-    end
-  end
 
-  class Text
-    def encode(request)
-      request.body.to_s
-    end
+    def _extract_header(headers, key)
+      value = headers[key] || headers[key.downcase]
+      value = value.first if value.kind_of?(Array)
 
-    def decode(body)
-      body.to_s
-    end
-
-    def content_type
-      /^text\/.*/
-    end
-  end
-
-  class FormEncoded
-    def encode(request)
-      encoded_params = []
-      request.body.each do |k, v|
-        encoded_params.push("#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}")
-      end
-
-      encoded_params.join("&")
-    end
-
-    def decode(body)
-      raise UnsupportedEncodingError.new("FormEncoded does not support deserialization")
-    end
-
-    def content_type
-      /^application\/x-www-form-urlencoded/
-    end
-  end
-
-  class Multipart
-    def encode(request)
-      boundary = DateTime.now.strftime("%Q")
-      request.headers["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
-
-      form_params = []
-      request.body.each do |k, v|
-        if v.is_a? File
-          form_params.push(_add_file_part(k, v))
-        else
-          form_params.push(_add_form_field(k, v))
-        end
-      end
-
-      form_params.collect {|p| "--" + boundary + "#{LINE_FEED}" + p}.join("") + "--" + boundary + "--"
-    end
-
-    def decode(body)
-      raise UnsupportedEncodingError.new("Multipart does not support deserialization")
-    end
-
-    def content_type
-      /^multipart\/.*/
-    end
-
-    def _add_form_field(key, value)
-      return "Content-Disposition: form-data; name=\"#{key}\"#{LINE_FEED}#{LINE_FEED}#{value}#{LINE_FEED}"
-    end
-
-    def _add_file_part(key, file)
-      mime_type = _mime_type_for_file_name(file.path)
-      return "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{File.basename(file.path)}\"#{LINE_FEED}" +
-        "Content-Type: #{mime_type}#{LINE_FEED}#{LINE_FEED}#{file.read}#{LINE_FEED}"
-    end
-
-    def _mime_type_for_file_name(filename)
-      file_extension = File.extname(filename).strip.downcase[1..-1]
-      if file_extension == "jpeg" || file_extension == "jpg"
-        return "image/jpeg"
-      elsif file_extension == "png"
-        return "image/png"
-      elsif file_extension == "pdf"
-        return "application/pdf"
-      else
-        return "application/octet-stream"
-      end
+      value
     end
   end
 end

data/lib/braintreehttp/http_client.rb

@@ -27,7 +27,16 @@ module BraintreeHttp
       request.respond_to?(:body) and request.body
     end
 
-    def execute(request)
+    def execute(req)
+      headers = req.headers || {}
+
+      request = OpenStruct.new({
+        :verb => req.verb,
+        :path => req.path,
+        :headers => headers.clone,
+        :body => req.body,
+      })
+
       if !request.headers
         request.headers = {}
       end

data/lib/braintreehttp/serializers/form_encoded.rb

@@ -0,0 +1,22 @@
+require 'uri'
+
+module BraintreeHttp
+  class FormEncoded
+    def encode(request)
+      encoded_params = []
+      request.body.each do |k, v|
+        encoded_params.push("#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}")
+      end
+
+      encoded_params.join("&")
+    end
+
+    def decode(body)
+      raise UnsupportedEncodingError.new("FormEncoded does not support deserialization")
+    end
+
+    def content_type
+      /^application\/x-www-form-urlencoded/
+    end
+  end
+end

data/lib/braintreehttp/serializers/json.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+module BraintreeHttp
+  class Json
+    def encode(request)
+      JSON.generate(request.body)
+    end
+
+    def decode(body)
+      JSON.parse(body)
+    end
+
+    def content_type
+      /application\/json/
+    end
+  end
+end

data/lib/braintreehttp/serializers/multipart.rb

@@ -0,0 +1,50 @@
+module BraintreeHttp
+  class Multipart
+    def encode(request)
+      boundary = DateTime.now.strftime("%Q")
+      request.headers["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+
+      form_params = []
+      request.body.each do |k, v|
+        if v.is_a? File
+          form_params.push(_add_file_part(k, v))
+        else
+          form_params.push(_add_form_field(k, v))
+        end
+      end
+
+      form_params.collect {|p| "--" + boundary + "#{LINE_FEED}" + p}.join("") + "--" + boundary + "--"
+    end
+
+    def decode(body)
+      raise UnsupportedEncodingError.new("Multipart does not support deserialization")
+    end
+
+    def content_type
+      /multipart\/.*/
+    end
+
+    def _add_form_field(key, value)
+      return "Content-Disposition: form-data; name=\"#{key}\"#{LINE_FEED}#{LINE_FEED}#{value}#{LINE_FEED}"
+    end
+
+    def _add_file_part(key, file)
+      mime_type = _mime_type_for_file_name(file.path)
+      return "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{File.basename(file.path)}\"#{LINE_FEED}" +
+        "Content-Type: #{mime_type}#{LINE_FEED}#{LINE_FEED}#{file.read}#{LINE_FEED}"
+    end
+
+    def _mime_type_for_file_name(filename)
+      file_extension = File.extname(filename).strip.downcase[1..-1]
+      if file_extension == "jpeg" || file_extension == "jpg"
+        return "image/jpeg"
+      elsif file_extension == "png"
+        return "image/png"
+      elsif file_extension == "pdf"
+        return "application/pdf"
+      else
+        return "application/octet-stream"
+      end
+    end
+  end
+end

data/lib/braintreehttp/serializers/text.rb

@@ -0,0 +1,15 @@
+module BraintreeHttp
+  class Text
+    def encode(request)
+      request.body.to_s
+    end
+
+    def decode(body)
+      body.to_s
+    end
+
+    def content_type
+      /text\/.*/
+    end
+  end
+end

data/lib/braintreehttp/version.rb

@@ -1 +1 @@
-VERSION = "0.3.0"
+VERSION = "0.4.0"

data/spec/braintreehttp/encoder_spec.rb

@@ -1,4 +1,6 @@
 require 'ostruct'
+require 'json'
+require 'zlib'
 
 describe Encoder do
 
@@ -6,7 +8,7 @@ describe Encoder do
     it 'serializes the request when content-type == application/json' do
       req = OpenStruct.new({
         :headers  => {
-          "content-type" => "application/json"
+          "content-type" => "application/json; charset=utf8"
         },
         :body => {
           "string" => "value",
@@ -28,7 +30,7 @@ describe Encoder do
     it 'serializes the request when content-type == text/*' do
       req = OpenStruct.new({
         :headers  => {
-          "content-type" => "text/plain"
+          "content-type" => "text/plain; charset=utf8"
         },
         :body => "some text"
       })
@@ -39,10 +41,10 @@ describe Encoder do
     it 'serializes the request when content-type == multipart/form-data' do
       file = File.new("README.md", "r")
       req = OpenStruct.new({
-        :verb => "POST", 
-        :path => "/v1/api", 
+        :verb => "POST",
+        :path => "/v1/api",
         :headers => {
-          "Content-Type" => "multipart/form-data"
+          "Content-Type" => "multipart/form-data; charset=utf8"
         },
         :body => {
           :key => "value",
@@ -63,10 +65,10 @@ describe Encoder do
 
     it 'serializes the request when content-type == application/x-www-form-urlencoded' do
       req = OpenStruct.new({
-        :verb => "POST", 
-        :path => "/v1/api", 
+        :verb => "POST",
+        :path => "/v1/api",
         :headers => {
-          "Content-Type" => "application/x-www-form-urlencoded"
+          "Content-Type" => "application/x-www-form-urlencoded; charset=utf8"
         },
         :body => {
           :key => "value with a space",
@@ -78,10 +80,10 @@ describe Encoder do
       expect(serialized).to eq("key=value%20with%20a%20space&another_key=1013")
     end
 
-    it 'throws when content-type is not application/json' do
+    it 'throws when content-type is unsupported' do
       req = OpenStruct.new({
         :headers  => {
-          "content-type" => "not application/json"
+          "content-type" => "fake/content-type"
         },
         :body => { :string => "value" }
       })
@@ -96,10 +98,38 @@ describe Encoder do
 
       expect{Encoder.new.serialize_request(req)}.to raise_error(UnsupportedEncodingError, 'HttpRequest did not have Content-Type header set')
     end
+
+    it 'throws when conent-type undefined' do
+      req = OpenStruct.new({
+        :headers => {},
+        :body  => { :key => "value" }
+      })
+
+
+      expect{Encoder.new.serialize_request(req)}.to raise_error(UnsupportedEncodingError, 'HttpRequest did not have Content-Type header set')
+    end
+
+    it 'encodes data as gzip when content-encoding == gzip' do
+      req = OpenStruct.new({
+        :path => '/143j2bz1',
+        :verb => "POST",
+        :headers => {
+          'Content-Type' => 'application/json',
+          'Content-Encoding' => 'gzip'
+        },
+        :body => {
+          :one => "two"
+        }
+      })
+
+      encoder = Encoder.new
+
+      expect(encoder.serialize_request(req)).to eq(Zlib::Deflate.deflate(JSON.generate(req.body)))
+    end
   end
 
   describe 'deserialize_response' do
-    it 'throws when content-type not application/json' do
+    it 'throws when content-type unsupported' do
       body = '{"string":"value","number":1.23,"bool":true,"array":["one","two","three"],"nested":{"nested_string":"nested_value","nested_array":[1,2,3]}}'
       headers = {
         "content-type" => ["application/xml"]
@@ -114,6 +144,12 @@ describe Encoder do
       expect{Encoder.new.deserialize_response(body, nil)}.to raise_error(UnsupportedEncodingError, 'HttpResponse did not have Content-Type header set')
     end
 
+    it 'throws when content-type undefined' do
+      body = '{"string":"value","number":1.23,"bool":true,"array":["one","two","three"],"nested":{"nested_string":"nested_value","nested_array":[1,2,3]}}'
+
+      expect{Encoder.new.deserialize_response(body, {})}.to raise_error(UnsupportedEncodingError, 'HttpResponse did not have Content-Type header set')
+    end
+
     it 'deserializes the response when content-type == application/json' do
       expected = {
         "string" => "value",
@@ -126,17 +162,45 @@ describe Encoder do
         }
       }
 
-      headers = {"content-type" => ["application/json"]}
+      headers = {"content-type" => ["application/json; charset=utf8"]}
       body = '{"string":"value","number":1.23,"bool":true,"array":["one","two","three"],"nested":{"nested_string":"nested_value","nested_array":[1,2,3]}}'
 
       expect(Encoder.new.deserialize_response(body, headers)).to eq(expected)
     end
 
     it 'deserializes the response when content-type == text/*' do
-      headers = {"content-type" => ["text/plain"]}
+      headers = {"content-type" => ["text/plain; charset=utf8"]}
       body = 'some text'
 
       expect(Encoder.new.deserialize_response(body, headers)).to eq('some text')
     end
+
+    it 'throws when attempting to deserialize multipart/*' do
+      headers = {"content-type" => ["multipart/form-data"]}
+      body = 'some multipart encoded data here'
+
+      expect{Encoder.new.deserialize_response(body, headers)}.to raise_error(UnsupportedEncodingError, 'Multipart does not support deserialization')
+    end
+
+    it 'throws when attempting to deserialize application/x-www-form-urlencoded' do
+      headers = {"content-type" => ["application/x-www-form-urlencoded"]}
+      body = 'some multipart encoded data here'
+
+      expect{Encoder.new.deserialize_response(body, headers)}.to raise_error(UnsupportedEncodingError, 'FormEncoded does not support deserialization')
+    end
+
+    it 'decodes data from gzip when content-encoding == gzip' do
+      headers = {
+        'content-type' => 'application/json',
+        'content-encoding' => 'gzip'
+      }
+      body = JSON.generate({
+        :one => 'two'
+      })
+
+      encoded_body = Zlib::Deflate.deflate(body)
+
+      expect(Encoder.new.deserialize_response(encoded_body, headers)).to eq({'one' => 'two'})
+    end
   end
 end

data/spec/braintreehttp/http_client_spec.rb

@@ -23,7 +23,10 @@ describe HttpClient do
 
     http_client.execute(req)
 
-    expect(req.headers["Some-Key"]).to eq("Some Value")
+    assert_requested :get, "#{@environment.base_url}/", {
+      :headers => {'Some-Key' => 'Some Value'},
+      :times => 1
+    }
   end
 
   it "uses method injector to modify request" do
@@ -43,7 +46,10 @@ describe HttpClient do
 
     http_client.execute(req)
 
-    expect(req.headers["Some-Key"]).to eq("Some Value")
+    assert_requested :get, "#{@environment.base_url}/", {
+      :headers => {'Some-Key' => 'Some Value'},
+      :times => 1
+    }
   end
 
   it "sets User-Agent header in request if not set" do
@@ -56,7 +62,10 @@ describe HttpClient do
 
     http_client.execute(req)
 
-    expect(req.headers["User-Agent"]).to eq("BraintreeHttp-Ruby HTTP/1.1")
+    assert_requested :get, "#{@environment.base_url}/", {
+      :headers => {"User-Agent" => "BraintreeHttp-Ruby HTTP/1.1"},
+      :times => 1
+    }
   end
 
   it "does not overwrite User-Agent header if set" do
@@ -70,7 +79,24 @@ describe HttpClient do
 
     http_client.execute(req)
 
-    expect(req.headers["User-Agent"]).to eq("Not Ruby Http/1.1")
+    assert_requested :get, "#{@environment.base_url}/", {
+      :headers => {"User-Agent" => "Not Ruby Http/1.1"},
+      :times => 1
+    }
+  end
+
+  it "does not modify the original request" do
+    WebMock.enable!
+
+    http_client = HttpClient.new(@environment)
+
+    req = OpenStruct.new({:verb => "GET", :path => "/"})
+
+    stub_request(:any, @environment.base_url)
+
+    http_client.execute(req)
+
+    expect(req.headers).to be_nil
   end
 
   it "uses body in request" do
@@ -210,15 +236,6 @@ describe HttpClient do
 				@verb = "POST"
 				@path = "/v1/api"
 			end
-
-			def requestBody(body)
-				@body = body
-			end
-
-			def setFile(file)
-				@file = file
-			end
-
 		end
 
 		WebMock.enable!
@@ -231,8 +248,6 @@ describe HttpClient do
 		rescue Exception => e
 			fail e.message
 		end
-
 	end
-
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: braintreehttp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Braintree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-25 00:00:00.000000000 Z
+date: 2017-11-18 00:00:00.000000000 Z
 dependencies: []
 description: Used for generated API clients
 email: code@getbraintree.com
@@ -22,6 +22,10 @@ files:
 - lib/braintreehttp/environment.rb
 - lib/braintreehttp/errors.rb
 - lib/braintreehttp/http_client.rb
+- lib/braintreehttp/serializers/form_encoded.rb
+- lib/braintreehttp/serializers/json.rb
+- lib/braintreehttp/serializers/multipart.rb
+- lib/braintreehttp/serializers/text.rb
 - lib/braintreehttp/version.rb
 - spec/braintreehttp/encoder_spec.rb
 - spec/braintreehttp/http_client_spec.rb
@@ -46,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: braintreehttp
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: BraintreeHttp Client Library