agiley-faraday_middleware 0.8.3

data/spec/parse_json_spec.rb

@@ -0,0 +1,94 @@
+require 'helper'
+require 'faraday_middleware/response/parse_json'
+
+describe FaradayMiddleware::ParseJson, :type => :response do
+  context "no type matching" do
+    it "doesn't change nil body" do
+      process(nil).body.should be_nil
+    end
+
+    it "nullifies empty body" do
+      process('').body.should be_nil
+    end
+
+    it "parses json body" do
+      response = process('{"a":1}')
+      response.body.should eql('a' => 1)
+      response.env[:raw_body].should be_nil
+    end
+  end
+
+  context "with preserving raw" do
+    let(:options) { {:preserve_raw => true} }
+
+    it "parses json body" do
+      response = process('{"a":1}')
+      response.body.should eql('a' => 1)
+      response.env[:raw_body].should eql('{"a":1}')
+    end
+
+    it "can opt out of preserving raw" do
+      response = process('{"a":1}', nil, :preserve_raw => false)
+      response.env[:raw_body].should be_nil
+    end
+  end
+
+  context "with regexp type matching" do
+    let(:options) { {:content_type => /\bjson$/} }
+
+    it "parses json body of correct type" do
+      response = process('{"a":1}', 'application/x-json')
+      response.body.should eql('a' => 1)
+    end
+
+    it "ignores json body of incorrect type" do
+      response = process('{"a":1}', 'text/json-xml')
+      response.body.should eql('{"a":1}')
+    end
+  end
+
+  context "with array type matching" do
+    let(:options) { {:content_type => %w[a/b c/d]} }
+
+    it "parses json body of correct type" do
+      process('{"a":1}', 'a/b').body.should be_a(Hash)
+      process('{"a":1}', 'c/d').body.should be_a(Hash)
+    end
+
+    it "ignores json body of incorrect type" do
+      process('{"a":1}', 'a/d').body.should_not be_a(Hash)
+    end
+  end
+
+  it "chokes on invalid json" do
+    ['{!', ' ', '"a"', 'true', 'null', '1'].each do |data|
+      expect { process(data) }.to raise_error(Faraday::Error::ParsingError)
+    end
+  end
+
+  context "with mime type fix" do
+    let(:middleware) {
+      app = described_class::MimeTypeFix.new(lambda {|env|
+        Faraday::Response.new(env)
+      }, :content_type => /^text\//)
+      described_class.new(app, :content_type => 'application/json')
+    }
+
+    it "ignores completely incompatible type" do
+      response = process('{"a":1}', 'application/xml')
+      response.body.should eql('{"a":1}')
+    end
+
+    it "ignores compatible type with bad data" do
+      response = process('var a = 1', 'text/javascript')
+      response.body.should eql('var a = 1')
+      response['content-type'].should eql('text/javascript')
+    end
+
+    it "corrects compatible type and data" do
+      response = process('{"a":1}', 'text/javascript')
+      response.body.should be_a(Hash)
+      response['content-type'].should eql('application/json')
+    end
+  end
+end

data/spec/parse_marshal_spec.rb

@@ -0,0 +1,16 @@
+require 'helper'
+require 'faraday_middleware/response/parse_marshal'
+
+describe FaradayMiddleware::ParseMarshal, :type => :response do
+  it "restores a marshaled dump" do
+    process(Marshal.dump(:a => 1)).body.should be_eql(:a => 1)
+  end
+
+  it "nulifies blank response" do
+    process('').body.should be_nil
+  end
+
+  it "chokes on invalid content" do
+    expect { process('abc') }.to raise_error(Faraday::Error::ParsingError)
+  end
+end

data/spec/parse_xml_spec.rb

@@ -0,0 +1,71 @@
+require 'helper'
+require 'faraday_middleware/response/parse_xml'
+
+describe FaradayMiddleware::ParseXml, :type => :response do
+  let(:xml)  { '<user><name>Erik Michaels-Ober</name><screen_name>sferik</screen_name></user>' }
+  let(:user) { {'user' => {'name' => 'Erik Michaels-Ober', 'screen_name' => 'sferik'} } }
+
+  context "no type matching" do
+    it "doesn't change nil body" do
+      process(nil).body.should be_nil
+    end
+
+    it "turns empty body into empty hash" do
+      process('').body.should be_eql({})
+    end
+
+    it "parses xml body" do
+      response = process(xml)
+      response.body.should eql(user)
+      response.env[:raw_body].should be_nil
+    end
+  end
+
+  context "with preserving raw" do
+    let(:options) { {:preserve_raw => true} }
+
+    it "parses xml body" do
+      response = process(xml)
+      response.body.should eql(user)
+      response.env[:raw_body].should eql(xml)
+    end
+
+    it "can opt out of preserving raw" do
+      response = process(xml, nil, :preserve_raw => false)
+      response.env[:raw_body].should be_nil
+    end
+  end
+
+  context "with regexp type matching" do
+    let(:options) { {:content_type => /\bxml$/} }
+
+    it "parses xml body of correct type" do
+      response = process(xml, 'application/xml')
+      response.body.should eql(user)
+    end
+
+    it "ignores xml body of incorrect type" do
+      response = process(xml, 'text/html')
+      response.body.should eql(xml)
+    end
+  end
+
+  context "with array type matching" do
+    let(:options) { {:content_type => %w[a/b c/d]} }
+
+    it "parses xml body of correct type" do
+      process(xml, 'a/b').body.should be_a(Hash)
+      process(xml, 'c/d').body.should be_a(Hash)
+    end
+
+    it "ignores xml body of incorrect type" do
+      process(xml, 'a/d').body.should_not be_a(Hash)
+    end
+  end
+
+  it "chokes on invalid xml" do
+    ['{!', '"a"', 'true', 'null', '1'].each do |data|
+      expect { process(data) }.to raise_error(Faraday::Error::ParsingError)
+    end
+  end
+end

data/spec/parse_yaml_spec.rb

@@ -0,0 +1,53 @@
+require 'helper'
+require 'faraday_middleware/response/parse_yaml'
+
+describe FaradayMiddleware::ParseYaml, :type => :response do
+  context "no type matching" do
+    it "doesn't change nil body" do
+      process(nil).body.should be_nil
+    end
+
+    it "returns false for empty body" do
+      process('').body.should be_false
+    end
+
+    it "parses yaml body" do
+      response = process('a: 1')
+      response.body.should eql('a' => 1)
+      response.env[:raw_body].should be_nil
+    end
+  end
+
+  context "with preserving raw" do
+    let(:options) { {:preserve_raw => true} }
+
+    it "parses yaml body" do
+      response = process('a: 1')
+      response.body.should eql('a' => 1)
+      response.env[:raw_body].should eql('a: 1')
+    end
+
+    it "can opt out of preserving raw" do
+      response = process('a: 1', nil, :preserve_raw => false)
+      response.env[:raw_body].should be_nil
+    end
+  end
+
+  context "with regexp type matching" do
+    let(:options) { {:content_type => /\byaml$/} }
+
+    it "parses json body of correct type" do
+      response = process('a: 1', 'application/x-yaml')
+      response.body.should eql('a' => 1)
+    end
+
+    it "ignores json body of incorrect type" do
+      response = process('a: 1', 'text/yaml-xml')
+      response.body.should eql('a: 1')
+    end
+  end
+
+  it "chokes on invalid yaml" do
+    expect { process('{!') }.to raise_error(Faraday::Error::ParsingError)
+  end
+end

data/spec/rashify_spec.rb

@@ -0,0 +1,69 @@
+require 'helper'
+require 'faraday_middleware/response/rashify'
+
+describe FaradayMiddleware::Rashify do
+
+  context 'when used' do
+    let(:rashify) { described_class.new }
+
+    it 'should create a Hashie::Rash from the body' do
+      env = { :body => { "name" => "Erik Michaels-Ober", "username" => "sferik" } }
+      me  = rashify.on_complete(env)
+      me.class.should == Hashie::Rash
+    end
+
+    it 'should handle strings' do
+      env = { :body => "Most amazing string EVER" }
+      me  = rashify.on_complete(env)
+      me.should == "Most amazing string EVER"
+    end
+
+    it 'should handle hashes and decamelcase the keys' do
+      env = { :body => { "name" => "Erik Michaels-Ober", "userName" => "sferik" } }
+      me  = rashify.on_complete(env)
+      me.name.should == 'Erik Michaels-Ober'
+      me.user_name.should == 'sferik'
+    end
+
+    it 'should handle arrays' do
+      env = { :body => [123, 456] }
+      values = rashify.on_complete(env)
+      values.first.should == 123
+      values.last.should == 456
+    end
+
+    it 'should handle arrays of hashes' do
+      env = { :body => [{ "username" => "sferik" }, { "username" => "pengwynn" }] }
+      us  = rashify.on_complete(env)
+      us.first.username.should == 'sferik'
+      us.last.username.should == 'pengwynn'
+    end
+
+    it 'should handle mixed arrays' do
+      env = { :body => [123, { "username" => "sferik" }, 456] }
+      values = rashify.on_complete(env)
+      values.first.should == 123
+      values.last.should == 456
+      values[1].username.should == 'sferik'
+    end
+  end
+
+  context 'integration test' do
+    let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+    let(:connection) do
+      Faraday::Connection.new do |builder|
+        builder.adapter :test, stubs
+        builder.use described_class
+      end
+    end
+
+    # although it is not good practice to pass a hash as the body, if we add ParseJson
+    # to the middleware stack we end up testing two middlewares instead of one
+    it 'should create a Hash from the body' do
+      stubs.get('/hash') {[200, {'content-type' => 'application/json; charset=utf-8'}, { "name" => "Erik Michaels-Ober", "username" => "sferik" }]}
+      me = connection.get('/hash').body
+      me.name.should == 'Erik Michaels-Ober'
+      me.username.should == 'sferik'
+    end
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: agiley-faraday_middleware
+version: !ruby/object:Gem::Version
+  version: 0.8.3
+  prerelease: 
+platform: ruby
+authors:
+- Erik Michaels-Ober
+- Wynn Netherland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70130128226140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70130128226140
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &70130128225380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128225380
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70130128224920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70130128224920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70130128224460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128224460
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70130128224000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128224000
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: &70130128223540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128223540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70130128223080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128223080
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: &70130128222620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128222620
+- !ruby/object:Gem::Dependency
+  name: rack-cache
+  requirement: &70130128222160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: *70130128222160
+description: Various middleware for Faraday
+email:
+- sferik@gmail.com
+- wynn.netherland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- faraday_middleware.gemspec
+- lib/faraday_middleware.rb
+- lib/faraday_middleware/addressable_patch.rb
+- lib/faraday_middleware/backwards_compatibility.rb
+- lib/faraday_middleware/instrumentation.rb
+- lib/faraday_middleware/rack_compatible.rb
+- lib/faraday_middleware/request/encode_json.rb
+- lib/faraday_middleware/request/oauth.rb
+- lib/faraday_middleware/request/oauth2.rb
+- lib/faraday_middleware/response/caching.rb
+- lib/faraday_middleware/response/follow_redirects.rb
+- lib/faraday_middleware/response/mashify.rb
+- lib/faraday_middleware/response/parse_json.rb
+- lib/faraday_middleware/response/parse_marshal.rb
+- lib/faraday_middleware/response/parse_nokogiri_xml.rb
+- lib/faraday_middleware/response/parse_xml.rb
+- lib/faraday_middleware/response/parse_yaml.rb
+- lib/faraday_middleware/response/rashify.rb
+- lib/faraday_middleware/response_middleware.rb
+- lib/faraday_middleware/version.rb
+- spec/caching_test.rb
+- spec/encode_json_spec.rb
+- spec/follow_redirects_spec.rb
+- spec/helper.rb
+- spec/mashify_spec.rb
+- spec/oauth2_spec.rb
+- spec/oauth_spec.rb
+- spec/parse_json_spec.rb
+- spec/parse_marshal_spec.rb
+- spec/parse_xml_spec.rb
+- spec/parse_yaml_spec.rb
+- spec/rashify_spec.rb
+homepage: https://github.com/pengwynn/faraday_middleware
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Various middleware for Faraday
+test_files:
+- spec/caching_test.rb
+- spec/encode_json_spec.rb
+- spec/follow_redirects_spec.rb
+- spec/helper.rb
+- spec/mashify_spec.rb
+- spec/oauth2_spec.rb
+- spec/oauth_spec.rb
+- spec/parse_json_spec.rb
+- spec/parse_marshal_spec.rb
+- spec/parse_xml_spec.rb
+- spec/parse_yaml_spec.rb
+- spec/rashify_spec.rb