faraday_cage 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rspec
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.pryrc

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'pathname'
+$LOAD_PATH.unshift(Pathname.getwd.join('lib').to_s)
+require 'faraday_cage'
+
+def reload!
+  Dir["#{Dir.pwd}/lib/**/*.rb"].each { |f| load f }
+end

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - 2.0.0
+branches:
+  only:
+    - master
+notifications:
+  email:
+    recipients:
+      - dev@tabeso.com
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
+    - rvm: 2.0.0

data/.yardopts

@@ -0,0 +1,3 @@
+--title 'FaradayCage Documentation'
+--charset utf-8
+--markup markdown

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_cage.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,15 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch('faraday_cage.gemspec')
+end
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard 'yard' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tabeso, LLC.
+
+MIT License
+
+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,88 @@
+# Faraday Cage
+
+* Code: [github.com/tabeso/faraday_cage](https://github.com/tabeso/faraday_cage)
+
+## Description
+
+Faraday Cage allows you to use [Faraday](https://github.com/lostisland/faraday)
+for making requests to your APIs in integration testing, minus the boilerplate
+code and repeated parsing and encoding of requests and responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_cage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_cage
+
+## Usage with RSpec
+
+Load RSpec support by adding the following to your `spec_helper.rb`:
+
+```ruby
+require 'faraday_cage/rspec'
+```
+
+Configure the middleware you would like to use (see
+[Faraday](https://github.com/lostisland/faraday) and
+[faraday_middleware](https://github.com/lostisland/faraday_middleware) for more
+information):
+
+```ruby
+FaradayCage.middleware do |conn|
+  conn.request  :json
+  conn.response :mashify
+  conn.response :json, content_type: /\bjson$/
+
+  conn.options[:preserve_raw] = true
+end
+```
+
+You will now be able to test your app like so:
+
+```ruby
+describe 'creating a gist' do
+
+  before do
+    header :accept, 'application/vnd.github.v3'
+    basic_auth 'username', 'password'
+  end
+
+  let(:gist) do
+    {
+      description: 'This is my gist, there are many like it but this one is mine.',
+      public: true,
+      files: [
+        'file1.txt' => {
+          content: 'cool beans'
+        }
+      ]
+    }
+  end
+
+  subject { post 'gists', gist }
+
+  its(:status) { should be_created }
+
+  it 'references the location of the created gist' do
+    body[:url].should =~ %r{^https://api.github.com/gists/[a-f0-9]+$}
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+desc 'Start Pry with runtime dependencies loaded'
+task :console, :script do |t, args|
+  command  = 'bundle exec pry'
+  command += "-r #{args[:script]}" if args[:script]
+  sh command
+end

data/faraday_cage.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_cage/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'faraday_cage'
+  gem.version       = FaradayCage::VERSION
+  gem.authors       = ['Gabriel Evans']
+  gem.email         = ['gabe@tabeso.com']
+  gem.description   = %q{Faraday Cage allows you to use Faraday for making requests to your REST APIs in integration testing, minus the boilerplate code and crufty parsing and encoding of requests and responses.}
+  gem.summary       = %q{Use Faraday to integration test your REST applications.}
+  gem.homepage      = 'https://github.com/tabeso/faraday_cage'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rack', '>= 1.0'
+  gem.add_dependency 'rack-test', '>= 0.5.4'
+  gem.add_dependency 'faraday_middleware', '>= 0.8', '< 1.0'
+  gem.add_dependency 'activesupport'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-bundler'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-yard'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'growl'
+end

data/lib/faraday_cage.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/concern'
+
+require 'faraday_middleware'
+
+require 'faraday_cage/version'
+require 'faraday_cage/errors'
+require 'faraday_cage/config'
+require 'faraday_cage/helpers'
+require 'faraday_cage/response'
+require 'faraday_cage/server'
+require 'faraday_cage/status'
+
+module FaradayCage
+  extend self
+
+  def configure
+    yield(config)
+  end
+
+  def config
+    @config ||= Config.new
+  end
+
+  def server
+    @server ||= FaradayCage::Server.new
+  end
+
+  def connection
+    server.connection
+  end
+
+  def reset!
+    @server = nil
+  end
+
+  delegate(*Config.public_instance_methods(false), to: :config)
+end # FaradayCage

data/lib/faraday_cage/config.rb

@@ -0,0 +1,38 @@
+module FaradayCage
+  ##
+  # Handles configuration of Faraday connection and server options.
+  class Config
+
+    attr_accessor :default_host
+
+    attr_writer :app
+
+    def initialize
+      self.default_host = 'http://example.com'
+    end
+
+    def app
+      @app ||= begin
+        default_rails_app if defined?(Rails)
+      end
+    end
+
+    def middleware(&block)
+      if block_given?
+        @middleware = block
+      else
+        @middleware
+      end
+    end
+
+    private
+
+    def default_rails_app
+      Rack::Builder.new do
+        map '/' do
+          run Rails.application
+        end
+      end.to_app
+    end
+  end # Config
+end # FaradayCage

data/lib/faraday_cage/errors.rb

@@ -0,0 +1,3 @@
+module FaradayCage
+  class Error < StandardError; end
+end

data/lib/faraday_cage/helpers.rb

@@ -0,0 +1,55 @@
+module FaradayCage
+  module Helpers
+
+    %w(get head post put patch delete).each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(uri = nil, params_or_body = nil, headers = nil, &block)
+          @last_response = FaradayCage.connection.#{method}(uri, params_or_body, headers, &block).tap do |res|
+            res.extend(FaradayCage::Response)
+          end
+        end
+      RUBY
+    end
+
+    def params(hash)
+      FaradayCage.connection.params = hash
+    end
+
+    def headers(hash)
+      FaradayCage.connection.headers = hash
+    end
+
+    def header(name, value)
+      FaradayCage.connection.headers[name] = value
+    end
+
+    def basic_auth(login, pass = nil)
+      FaradayCage.connection.basic_auth(login, pass)
+    end
+
+    def token_auth(login, options = nil)
+      FaradayCage.connection.token_auth(token, options)
+    end
+
+    def last_response
+      @last_response || raise(FaradayCage::Error , 'No response yet. Request a page first.')
+    end
+
+    def response_headers
+      last_response.headers
+    end
+
+    def body
+      last_response.body
+    end
+
+    def source
+      last_response.env[:raw_body] || last_response.body
+    end
+
+    def reset_faraday_cage!
+      FaradayCage.reset!
+      @last_response = nil
+    end
+  end # Helpers
+end # FaradayCage

data/lib/faraday_cage/rack_middleware.rb

@@ -0,0 +1,26 @@
+module FaradayCage
+  ##
+  # Wraps Rack apps to allow identification when running multiple.
+  class RackMiddleware
+
+    attr_reader :app
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      identity_request?(env) ? identity : app.call(env)
+    end
+
+    protected
+
+    def identity_request?(env)
+      env['PATH_INFO'] == '/__identify__'
+    end
+
+    def identity
+      [200, { 'Content-Type' => 'text/plain' }, [@app.object_id.to_s]]
+    end
+  end # Middleware
+end # FaradayCage

data/lib/faraday_cage/response.rb

@@ -0,0 +1,13 @@
+module FaradayCage
+  module Response
+
+    def self.extended(base)
+      base.instance_eval do
+        alias :original_status :status
+        def status
+          finished? ? Status.new(env[:status]) : nil
+        end
+      end
+    end
+  end # Response
+end # FaradayCage

data/lib/faraday_cage/rspec.rb

@@ -0,0 +1,14 @@
+require 'faraday_cage'
+require 'rspec/core'
+
+RSpec.configure do |config|
+  [:feature, :request].each do |group|
+    config.include FaradayCage::Helpers, type: group
+  end
+
+  config.after do
+    if self.class.include?(FaradayCage::Helpers)
+      FaradayCage.reset!
+    end
+  end
+end