faraday-encoding 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9e20bcab08b07b48ae880d62f8134eae931e28a
-  data.tar.gz: 8fff202baf5f45df5777cc604ff459c36559511d
+  metadata.gz: 89fdc80352bd6ee60754f19ea6fbf6b213e43198
+  data.tar.gz: 116f0cdfc9c4135a391ca9a2c955a7d5d20ecd07
 SHA512:
-  metadata.gz: 04412b83b8449b3b2f34f54f5375eef6db2ef6de29062480b2148cddf34477b82b50de3e04d854bbd9da3c34428900ac0c001d948addfe6902297592e80d8fee
-  data.tar.gz: 1676dd3ed7d6c54106f036d7d159584c5d6ac256a13003054452df2fd4343894ac54b6a1dd7149c835ee44408d5c2445a9e2e8b842f502d4aa37d3b202c01695
+  metadata.gz: be550d9f77dd7c161b00b1debda2c369c8da41e708af5e4edc06f71341ae2825aa7094a4ada3e1988c6186a7566ced1849ab636972273d57a010f1f15f0bf160
+  data.tar.gz: 6bc1bf936d5a0ac790c1d2da440168e07637b16ac71ea86df030859e5773798426c0d181e3dcf23663fa90319a1ef976aef6f55ff2cad3ddf98e2d6ec6998331

data/README.md

@@ -17,6 +17,8 @@ body.to_json
 
 That's why I wrote Farday::Encoding gem.
 
+SEE ALSO: [response.body is ASCII-8BIT when Content-Type is text/xml; charset=utf-8](https://github.com/lostisland/faraday/issues/139)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/faraday-encoding.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "faraday-encoding"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Takayuki Matsubara"]
   spec.email         = ["takayuki.1229@m3.com"]
   spec.summary       = %q{A Faraday Middleware sets body encoding when specified by server.}

data/lib/faraday/encoding.rb

@@ -2,18 +2,49 @@ require "faraday"
 
 module Faraday
   class Faraday::Encoding < Faraday::Middleware
+    def self.mappings
+      {
+        'utf8' => 'utf-8'
+      }
+    end
 
     def call(environment)
       @app.call(environment).on_complete do |env|
-        @content_charset = nil
-        if /;\s*charset=\s*(.+?)\s*(;|$)/.match(env[:response_headers][:content_type])
-          @content_charset = ::Encoding.find $1 rescue nil
+        @env = env
+        env[:body].force_encoding(content_charset) if content_charset
+      end
+    end
+
+    private
+
+    # @return [Encoding|NilClass] returns Encoding or nil
+    def content_charset
+      @content_charset ||= ::Encoding.find encoding_name rescue nil
+    end
+
+    # @return [String] returns a string representing encoding name if it is find in the CONTENT TYPE header
+    def encoding_name
+      @encoding_name ||= begin
+        if /charset=([^;|$]+)/.match(content_type)
+          mapped_encoding(Regexp.last_match(1))
         end
-        env[:body].force_encoding @content_charset if @content_charset
       end
     end
 
+    # @param [String] encoding_name
+    # @return [String] tries to find a mapping for the encoding name
+    # ex: returns 'utf-8' for encoding_name 'utf8'
+    # if mapping is not found - return the same input parameter `encoding_name`
+    # Look at `self.mappings` to see which mappings are available
+    def mapped_encoding(encoding_name)
+      self.class.mappings.fetch(encoding_name, default = encoding_name)
+    end
+
+    # @return [String]
+    def content_type
+      @env[:response_headers][:content_type]
+    end
   end
 end
 
-Faraday::Response.register_middleware :encoding => Faraday::Encoding
+Faraday::Response.register_middleware encoding: Faraday::Encoding

data/spec/faraday/encoding_spec.rb

@@ -18,17 +18,50 @@ describe Faraday::Encoding do
 
   let(:response_status) { 200 }
   let(:response_headers) do
-    { 'content-type' => 'text/plain; charset=utf-8' }
-  end
-  let(:response_body) do
-    'ねこ'.force_encoding(Encoding::ASCII_8BIT)
+    { 'content-type' => "text/plain; charset=#{response_encoding}" }
   end
 
   context 'http adapter return binary encoded body' do
+    let(:response_encoding) do
+      'utf-8'
+    end
+    let(:response_body) do
+      'ねこ'.force_encoding(Encoding::ASCII_8BIT)
+    end
+
     it 'set encoding specified by http header' do
       response = client.get('/')
       expect(response.body.encoding).to eq(Encoding::UTF_8)
     end
   end
 
+  context 'deal correctly with a non standard encoding names' do
+    context 'utf8' do
+      let(:response_encoding) do
+        'utf8'
+      end
+      let(:response_body) do
+        'abc'.force_encoding(Encoding::ASCII_8BIT)
+      end
+
+      it 'set encoding to utf-8' do
+        response = client.get('/')
+        expect(response.body.encoding).to eq(Encoding::UTF_8)
+      end
+    end
+
+    context 'for unknown encoding' do
+      let(:response_encoding) do
+        'unknown-encoding'
+      end
+      let(:response_body) do
+        'abc'.force_encoding(Encoding::ASCII_8BIT)
+      end
+
+      it 'does not enforce encoding' do
+        response = client.get('/')
+        expect(response.body.encoding).to eq(Encoding::ASCII_8BIT)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-encoding
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Takayuki Matsubara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler