arr-force 1.0.0

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright (c) 2011, Steve Agalloco
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+ArrForce
+========
+
+Parsing XML is teh suck, but sometimes you don't have a choice, who hasn't experienced this joy?
+
+```xml
+<access_tokens>
+  <access_token>
+    <token>abc</token>
+    <secret>123</secret>
+  </access_token>
+</access_tokens>
+```
+
+Parsing that returns a hash:
+
+```
+{ 'access_tokens' => { 'access_token' => { 'token' = 'abc', 'secret = '123' } }
+```
+
+What you probably wanted was this:
+
+```
+{ 'access_tokens' => [ 'access_token' => { 'token' = 'abc', 'secret = '123' } ] }
+```
+
+ArrForce is a Faraday middleware that will do that for you.  Just tell ArrForce what keys should be transformed into arrays and ArrForce will make sure they are.
+
+Installation
+------------
+    gem install arr-force
+
+Usage
+-----
+
+Simply add it to your middleware stack:
+
+```ruby
+conn = Faraday.new(:url => 'http://sushi.com') do |builder|
+  builder.use Faraday::Response::ArrForce, :access_tokens
+  builder.use Faraday::Response::ParseXml
+end
+```
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2011 Steve Agalloco. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/arr_force.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/arr_force/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'arr-force'
+  gem.version     = ArrForce::VERSION
+  gem.author      = "Steve Agalloco"
+  gem.email       = 'steve.agalloco@gmail.com'
+  gem.homepage    = 'https://github.com/spagalloco/arr-force'
+  gem.summary     = %q{Faraday Middleware to ensure certain keys are converted to arrays}
+  gem.description = %q{Faraday Middleware to ensure certain keys are converted to arrays}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'yard', '~> 0.7'
+
+  gem.add_dependency 'faraday', '0.7'
+end

data/lib/arr_force/version.rb

@@ -0,0 +1,3 @@
+module ArrForce
+  VERSION = "1.0.0"
+end

data/lib/arr_force.rb

@@ -0,0 +1,5 @@
+require 'faraday'
+
+class Faraday::Response
+  autoload :ArrForce,   'faraday/response/arr_force'
+end

data/lib/faraday/response/arr_force.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+
+module Faraday
+  class Response::ArrForce < Response::Middleware
+
+    def parse(body)
+      return body unless @to_array.any?
+
+      case body
+      when Hash
+        normalize(body)
+      when Array
+        body.map { |item| item.is_a?(Hash) ? normalize(item) : item }
+      else
+        body
+      end
+    end
+
+    def initialize(env = nil, *args)
+      @to_array = [args.shift].flatten.map { |k| k.to_s }
+      super(env)
+    end
+
+    private
+
+    def normalize(response_object)
+      if response_object.kind_of?(Hash)
+        response_object.each_pair do |key, value|
+          if @to_array.include?(key.to_s)
+            response_object[key] = [normalize(value)].flatten
+          else
+            response_object[key] = normalize(value)
+          end
+        end
+      else
+        response_object
+      end
+      response_object
+    end
+  end
+end

data/spec/arr_force_spec.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+describe Faraday::Response::ArrForce do
+
+  context 'when used' do
+    let(:arr_force) { Faraday::Response::ArrForce.new(nil, :tokens) }
+
+    it 'should create an Array for arguments' do
+      env = { :body => { "tokens" => { "token" => '123', 'secret' => 'abc' } } }
+      res = arr_force.on_complete(env)
+      res.class.should == Hash
+      res['tokens'].class.should == Array
+    end
+
+    it 'should pass through strings' do
+      env = { :body => 'this is a string' }
+      res = arr_force.on_complete(env)
+      res.class.should == String
+      res.should == 'this is a string'
+    end
+
+    it 'should properly handle arrays' do
+      env = { :body => ['abc', { 'somekey' => 'somevalue'}, 123] }
+      res = arr_force.on_complete(env)
+      res.class.should == Array
+    end
+
+    it 'should properly handle keys nested in arrays' do
+      env = { :body => ['abc', { 'tokens' => 'boo'}, 123] }
+      res = arr_force.on_complete(env)
+      res.class.should == Array
+      res[1]['tokens'].class.should == Array
+    end
+  end
+
+  context 'when not configured' do
+    let(:arr_force) { Faraday::Response::ArrForce.new }
+
+    it 'should have no impact' do
+      env = { :body => { "tokens" => { "token" => '123', 'secret' => 'abc' } } }
+      res = arr_force.on_complete(env)
+      res.class.should == Hash
+      res['tokens'].class.should == Hash
+    end
+  end
+
+  context 'when passed multiple arguments' do
+    let(:arr_force) { Faraday::Response::ArrForce.new(nil, [:tokens, :access_tokens]) }
+
+    it 'should create an Array for arguments' do
+      env = { :body => { "tokens" => { "token" => '123', 'secret' => 'abc' }, 'access_tokens' => 'abcdefg' } }
+      res = arr_force.on_complete(env)
+      res.class.should == Hash
+      res['tokens'].class.should == Array
+      res['access_tokens'].class.should == Array
+    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 Faraday::Response::ArrForce, :tokens, :voodoo
+      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'}, { "tokens" => { "token" => '123', 'secret' => 'abc' }, "otherkey" => 'xyz' }]}
+      res = connection.get('/hash').body
+      res['tokens'].class.should == Array
+      res['tokens'].first['token'].should == '123'
+      res['otherkey'].should == 'xyz'
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,11 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'although not required, its recommended you use bundler when running the tests'
+end
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'arr_force'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: arr-force
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Steve Agalloco
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "4.5"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.7"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id007
+description: Faraday Middleware to ensure certain keys are converted to arrays
+email: steve.agalloco@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gemtest
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- arr_force.gemspec
+- lib/arr_force.rb
+- lib/arr_force/version.rb
+- lib/faraday/response/arr_force.rb
+- spec/arr_force_spec.rb
+- spec/helper.rb
+has_rdoc: true
+homepage: https://github.com/spagalloco/arr-force
+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: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Faraday Middleware to ensure certain keys are converted to arrays
+test_files: 
+- spec/arr_force_spec.rb
+- spec/helper.rb