faraday_middleware 0.0.4

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+.yardopts
+.yardoc
+
+## PROJECT::SPECIFIC

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+### 0.0.2 September 25, 2010
+
+* Mashify now handles arrays of non-hashes
+
+### 0.0.1 June 27, 2010
+
+* MultiJSON
+* Mashify

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    faraday_middleware (0.0.3)
+      faraday (~> 0.4.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.1)
+    faraday (0.4.6)
+      addressable (>= 2.1.1)
+      rack (>= 1.0.1)
+    hashie (0.4.0)
+    mcmire-matchy (0.5.2)
+    multi_json (0.0.4)
+    rack (1.2.1)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (~> 0.4.5)
+  faraday_middleware!
+  hashie (~> 0.4.0)
+  mcmire-matchy (~> 0.5.2)
+  multi_json (~> 0.0.4)
+  shoulda (~> 2.11.3)

data/README.md

@@ -0,0 +1,43 @@
+# Faraday Middleware
+
+Collection of [Faraday](http://github.com/technoweenie/faraday) middlewares I've been using in some of my API wrappers
+
+
+## Installation
+
+    sudo gem install faraday-middleware
+    
+
+#### Some examples
+
+Let's decode the response body with [MultiJson](http://github.com/intridea/multi_json)
+
+    conn = Faraday::Connection.new(:url => 'http://api.twitter.com/1') do |builder|
+      builder.adapter Faraday.default_adapter
+      builder.use Faraday::Response::MultiJson
+    end
+
+    resp = conn.get do |req|
+      req.url '/users/show.json', :screen_name => 'pengwynn'
+    end
+
+    u = resp.body
+    u['name']
+    # => "Wynn Netherland"
+    
+
+Want to ditch the brackets and use dot notation? [Mashify](http://github.com/intridea/hashie) it!
+
+    conn = Faraday::Connection.new(:url => 'http://api.twitter.com/1') do |builder|
+      builder.adapter Faraday.default_adapter
+      builder.use Faraday::Response::MultiJson
+      builder.use Faraday::Response::Mashify
+    end
+
+    resp = conn.get do |req|
+      req.url '/users/show.json', :screen_name => 'pengwynn'
+    end
+
+    u = resp.body
+    u.name
+    # => "Wynn Netherland"

data/Rakefile

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts = ["-rubygems"] if defined? Gem
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/faraday_middleware.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path("../lib/faraday_middleware/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('hashie', ['~> 0.4.0'])
+  s.add_development_dependency('mcmire-matchy', ['~> 0.5.2'])
+  s.add_development_dependency('multi_json', ['~> 0.0.4'])
+  s.add_development_dependency('shoulda', ['~> 2.11.3'])
+  s.add_runtime_dependency('faraday', ['~> 0.4.5'])
+  s.authors = ["Wynn Netherland"]
+  s.description = %q{Various middleware for Faraday}
+  s.email = ['wynn.netherland@gmail.com']
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = ["README.md"]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://wynnnetherland.com/projects/faraday-middleware/'
+  s.name = 'faraday_middleware'
+  s.platform = Gem::Platform::RUBY
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = ">= 1.3.6"
+  s.summary = %q{Various middleware for Faraday}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = FaradayMiddleware::VERSION
+end

data/lib/faraday/mashify.rb

@@ -0,0 +1,25 @@
+module Faraday
+  class Response::Mashify < Response::Middleware
+    begin
+      require 'hashie'
+
+      def self.register_on_complete(env)
+        env[:response].on_complete do |finished_env|
+          json = finished_env[:body]
+          if json.is_a?(Hash)
+            finished_env[:body] = Hashie::Mash.new(json)
+          elsif json.is_a?(Array) and json.first.is_a?(Hash)
+            finished_env[:body] = json.map{|item| Hashie::Mash.new(item) }
+          end
+        end
+      end
+    rescue LoadError, NameError => e
+      self.load_error = e
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+  end
+end

data/lib/faraday/multi_json.rb

@@ -0,0 +1,31 @@
+module Faraday
+  class Response::MultiJson < Response::Middleware
+    begin
+      require 'multi_json'
+
+      def self.register_on_complete(env)
+        env[:response].on_complete do |finished_env|
+          finished_env[:body] = begin
+            case finished_env[:body]
+            when ""
+              nil
+            when "true"
+              true
+            when "false"
+              false
+            else
+              MultiJson.decode(finished_env[:body])
+            end
+          end
+        end
+      end
+    rescue LoadError, NameError => e
+      self.load_error = e
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+  end
+end

data/lib/faraday/oauth2.rb

@@ -0,0 +1,21 @@
+module Faraday
+  class Request::OAuth2 < Faraday::Middleware
+    begin
+      require 'oauth2'
+    rescue LoadError, NameError => e
+      self.load_error = e
+    end
+    def initialize(app, *args)
+      @app = app
+      @token = args.shift
+    end
+
+    def call(env)
+      params = env[:url].query_values || {}
+      env[:url].query_values = params.merge('access_token' => @token)
+      env[:request_headers].merge!('Authorization' => "Token token=\"#{@token}\"")
+
+      @app.call env
+    end
+  end
+end

data/lib/faraday_middleware.rb

@@ -0,0 +1,6 @@
+require 'faraday'
+
+directory = File.expand_path(File.dirname(__FILE__))
+require File.join(directory, 'faraday', 'oauth2')
+require File.join(directory, 'faraday', 'multi_json')
+require File.join(directory, 'faraday', 'mashify')

data/lib/faraday_middleware/version.rb

@@ -0,0 +1,3 @@
+module FaradayMiddleware
+  VERSION = "0.0.4".freeze
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'pathname'
+require 'rubygems'
+require 'shoulda'
+require 'faraday'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'faraday_middleware'
+
+class Test::Unit::TestCase
+end

data/test/mashify_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class MashifyTest < Test::Unit::TestCase
+  context 'when used' do
+    setup do
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @conn  = Faraday::Connection.new do |builder|
+        builder.adapter :test, @stubs
+        builder.use Faraday::Response::MultiJson
+        builder.use Faraday::Response::Mashify
+      end
+    end
+
+    should 'create a Hashie::Mash from the body' do
+      @stubs.get('/hash') { [200, {}, "{\"name\":\"Wynn Netherland\",\"username\":\"pengwynn\"}"] }
+      me = @conn.get("/hash").body
+      assert_equal 'Wynn Netherland', me.name
+      assert_equal 'pengwynn', me.username
+    end
+
+    should 'handle arrays' do
+      @stubs.get('/array') { [200, {}, "[{\"username\":\"pengwynn\"},{\"username\":\"jnunemaker\"}]" ] }
+      us = @conn.get("/array").body
+      assert_equal 'pengwynn', us.first.username
+      assert_equal 'jnunemaker', us.last.username
+    end
+    
+    should 'handle arrays of non-hashes' do
+      @stubs.get('/array/simple') { [200, {}, "[123, 456]" ] }
+      values = @conn.get("/array/simple").body
+      assert_equal 123, values.first
+      assert_equal 456, values.last
+    end
+  end
+end

data/test/multi_json_test.rb

@@ -0,0 +1,75 @@
+require 'helper'
+
+class Multi_Json_Test < Test::Unit::TestCase
+  context 'when used' do
+    setup do
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @conn  = Faraday::Connection.new do |builder|
+        builder.adapter :test, @stubs
+        builder.use Faraday::Response::MultiJson
+      end
+    end
+
+    context "when there is a JSON body" do
+      setup do
+        @stubs.get('/me') { [200, {}, "{\"name\":\"Wynn Netherland\",\"username\":\"pengwynn\"}"] }
+      end
+
+      should 'parse the body as JSON' do
+        me = @conn.get("/me").body
+        assert me.is_a?(Hash)
+        assert_equal 'Wynn Netherland', me['name']
+        assert_equal 'pengwynn', me['username']
+      end
+    end
+
+    context "when the JSON body is empty" do
+      setup do
+        @stubs.get('/me') { [200, {}, ""] }
+      end
+
+      should 'still have the status code' do
+        response = @conn.get("/me")
+        assert_equal 200, response.status
+      end
+
+      should 'set body to nil' do
+        response = @conn.get("/me")
+        assert_equal response.body, nil
+      end
+    end
+
+    context "when the JSON body is 'true'" do
+      setup do
+        @stubs.get('/me') { [200, {}, "true"] }
+      end
+
+      should 'still have the status code' do
+        response = @conn.get("/me")
+        assert_equal 200, response.status
+      end
+
+      should 'set body to nil' do
+        response = @conn.get("/me")
+        assert_equal response.body, true
+      end
+    end
+
+    context "when the JSON body is 'false'" do
+      setup do
+        @stubs.get('/me') { [200, {}, "false"] }
+      end
+
+      should 'still have the status code' do
+        response = @conn.get("/me")
+        assert_equal 200, response.status
+      end
+
+      should 'set body to nil' do
+        response = @conn.get("/me")
+        assert_equal response.body, false
+      end
+    end
+
+  end
+end

data/test/oauth2_test.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+class OAuth2Test < Test::Unit::TestCase
+  context 'when used' do
+    setup do
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @stubs.get('/me?access_token=OU812') { [200, {}, 'pengwynn'] }
+    end
+
+    should 'add the access token to the request' do
+      do_you  = Faraday::Connection.new do |builder|
+        builder.use Faraday::Request::OAuth2, 'OU812'
+        builder.adapter :test, @stubs
+      end
+      do_you.get("/me")
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: faraday_middleware
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Wynn Netherland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mcmire-matchy
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 0
+        - 4
+        version: 0.0.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 4
+        - 5
+        version: 0.4.5
+  type: :runtime
+  version_requirements: *id005
+description: Various middleware for Faraday
+email: 
+- wynn.netherland@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- faraday_middleware.gemspec
+- lib/faraday/mashify.rb
+- lib/faraday/multi_json.rb
+- lib/faraday/oauth2.rb
+- lib/faraday_middleware.rb
+- lib/faraday_middleware/version.rb
+- test/helper.rb
+- test/mashify_test.rb
+- test/multi_json_test.rb
+- test/oauth2_test.rb
+has_rdoc: true
+homepage: http://wynnnetherland.com/projects/faraday-middleware/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Various middleware for Faraday
+test_files: 
+- test/helper.rb
+- test/mashify_test.rb
+- test/multi_json_test.rb
+- test/oauth2_test.rb