api_hammer 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea5469a646316cf076f0fb0016ac81b661c864f4
-  data.tar.gz: 45c3e691c8692b974496e8ffd40fb213bedf8f41
+  metadata.gz: c2f9e2e65c6bd39813bce85257d2ff06f3a9296c
+  data.tar.gz: dd5ba2a6902c635d761edf351399820ace975bfc
 SHA512:
-  metadata.gz: e953cde20b88e2ee2bc2804a5c030b55abad006a90fe9f7794970da303db467116833fe069f4059a155489e31cde8373f57759f82df58a384b8b0ef035a4f2af
-  data.tar.gz: 534622ea02a5d88b6ea43e4d6f4f110c15394c4b1a612f310af3841598c6aef14e30a50501b0eb596d463b2c878ce4ce3c4b209179b5966687e0ebcce6d080ff
+  metadata.gz: 22059c86a14b39b299ca220fe0465ebcd0fd2d220832a3c49152f02c82b40aca902032c9fd1649cb2052046ac8836e234d7052dd454211feb4d6249fbedbcd57
+  data.tar.gz: 907c407c523d113eb6ceb0c21bcb32357dd4bb26c71fd08d3b27e8d0dd721473f4d1a6bf62d87e216e1c504f850a82f3c81e441b23486652cfe07697f365f520

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.4.2
+- bugfix encoding in faraday request logger
+
 # 0.4.1
 - bugfix
 

data/lib/api_hammer/faraday/request_logger.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'rack'
 require 'term/ansicolor'
 require 'json'
+require 'strscan'
 
 if Faraday.respond_to?(:register_middleware)
   Faraday.register_middleware(:request, :api_hammer_request_logger => proc { ApiHammer::Faraday::RequestLogger })
@@ -28,6 +29,69 @@ module ApiHammer
         @options = options
       end
 
+      # deal with the vagaries of getting the response body in a form which JSON 
+      # gem will not cry about dumping 
+      def response_body(response_env)
+        # first try to change the string's encoding per the Content-Type header 
+        content_type = response_env.response_headers['Content-Type']
+        response_body = response_env.body.dup
+        unless response_body.valid_encoding?
+          # I think this always comes in as ASCII-8BIT anyway so may never get here. hopefully.
+          response_body.force_encoding('ASCII-8BIT')
+        end
+
+        if content_type
+          # TODO refactor this parsing somewhere better? 
+          parsed = false
+          attributes = Hash.new { |h,k| h[k] = [] }
+          catch(:unparseable) do
+            uri_parser = URI.const_defined?(:Parser) ? URI::Parser.new : URI
+            scanner = StringScanner.new(content_type)
+            scanner.scan(/.*;\s*/) || throw(:unparseable)
+            while match = scanner.scan(/(\w+)=("?)([^"]*)("?)\s*(,?)\s*/)
+              key = scanner[1]
+              quote1 = scanner[2]
+              value = scanner[3]
+              quote2 = scanner[4]
+              comma_follows = !scanner[5].empty?
+              throw(:unparseable) unless quote1 == quote2
+              throw(:unparseable) if !comma_follows && !scanner.eos?
+              attributes[uri_parser.unescape(key)] << uri_parser.unescape(value)
+            end
+            throw(:unparseable) unless scanner.eos?
+            parsed = true
+          end
+          if parsed
+            charset = attributes['charset'].first
+            if Encoding.list.any? { |enc| enc.to_s.downcase == charset.downcase }
+              if response_body.dup.force_encoding(charset).valid_encoding?
+                response_body.force_encoding(charset)
+              else
+                # I guess just ignore the specified encoding if the result is not valid. fall back to 
+                # something else below.
+              end
+            end
+          end
+        end
+        begin
+          JSON.dump([response_body])
+        rescue Encoding::UndefinedConversionError
+          # if updating by content-type didn't do it, try UTF8 since JSON wants that - but only 
+          # if it seems to be valid utf8. 
+          # don't try utf8 if the response content-type indicated something else. 
+          try_utf8 = !(parsed && attributes['charset'].any?)
+          if try_utf8 && response_body.dup.force_encoding('UTF-8').valid_encoding?
+            response_body.force_encoding('UTF-8')
+          else
+            # I'm not sure if there is a way in this situation to get JSON gem to dump the 
+            # string correctly. fall back to an array of codepoints I guess? this is a weird 
+            # solution but the best I've got for now. 
+            response_body = response_body.codepoints.to_a
+          end
+        end
+        response_body
+      end
+
       def call(request_env)
         began_at = Time.now
 
@@ -60,7 +124,7 @@ module ApiHammer
             'response' => {
               'status' => response_env.status,
               'headers' => response_env.response_headers,
-              'body' => response_env.body,
+              'body' => response_body(response_env),
             }.reject{|k,v| v.nil? },
             'processing' => {
               'began_at' => began_at.utc.to_i,

data/lib/api_hammer/version.rb

@@ -1,3 +1,3 @@
 module ApiHammer
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/test/faraday_request_logger_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 proc { |p| $:.unshift(p) unless $:.any? { |lp| File.expand_path(lp) == p } }.call(File.expand_path('.', File.dirname(__FILE__)))
 require 'helper'
 require 'logger'
@@ -41,4 +43,54 @@ describe ApiHammer::RequestLogger do
     conn.get '/'
     assert_match(/200/, logio.string)
   end
+
+  describe 'response body encoding' do
+    it 'deals with encoding specified properly by the content type' do
+      app = proc do |env|
+        [200, {'Content-Type' => 'text/plain; charset=utf-8'}, ["Jalapeños".force_encoding("ASCII-8BIT")]]
+      end
+      conn = Faraday.new do |f|
+        f.request :api_hammer_request_logger, logger
+        f.use Faraday::Adapter::Rack, app
+      end
+      conn.get '/'
+      assert_match(/Jalapeños/, logio.string)
+    end
+
+    it 'deals with encoding not specified by the content type' do
+      app = proc do |env|
+        [200, {}, ["Jalapeños".force_encoding("ASCII-8BIT")]]
+      end
+      conn = Faraday.new do |f|
+        f.request :api_hammer_request_logger, logger
+        f.use Faraday::Adapter::Rack, app
+      end
+      conn.get '/'
+      assert_match(/Jalapeños/, logio.string)
+    end
+
+    it 'falls back to array of codepoints when encoding is improperly specified by the content type' do
+      app = proc do |env|
+        [200, {'Content-Type' => 'text/plain; charset=utf-8'}, ["xx" + [195].pack("C*")]]
+      end
+      conn = Faraday.new do |f|
+        f.request :api_hammer_request_logger, logger
+        f.use Faraday::Adapter::Rack, app
+      end
+      conn.get '/'
+      assert_match('[120,120,195]', logio.string)
+    end
+
+    it 'falls back to array of codepoints when encoding is not specified and not valid utf8' do
+      app = proc do |env|
+        [200, {}, ["xx" + [195].pack("C*")]]
+      end
+      conn = Faraday.new do |f|
+        f.request :api_hammer_request_logger, logger
+        f.use Faraday::Adapter::Rack, app
+      end
+      conn.get '/'
+      assert_match('[120,120,195]', logio.string)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack