capybara-faraday 0.1.1

data/README.md

@@ -0,0 +1,89 @@
+Capybara-restfulie
+==================
+
+This gems makes it possible to use [Faraday](http://github.com/technoweenie/faraday) for remote testing.
+
+This gem is a [Capybara](http://github.com/jnicklas/capybara) extension. The structure of the gem is taken from the work done on [Capybara-mechanize](http://github.com/jeroenvandijk/capybara-mechanize).
+
+### Installation
+
+    gem install capybara-faraday
+
+### Usage without Cucumber
+
+    require 'capybara/faraday'
+
+### Usage with Cucumber and tags
+
+A @faraday tag is added to your hooks when you add the following line to your env.rb
+
+    require 'capybara/faraday/cucumber'
+
+The following scenario will then be using the Faraday driver
+
+    @faraday
+    Scenario: do something with the API
+      Given I send and accept JSON
+      When I send a GET request to /users
+      
+If you want to use a specific faraday supported adapter, you need to install the dependency and then specify the tag matching it:
+
+To use Typhoeus
+
+    @faraday_typhoeus
+    Scenario: do something with the API
+      Given I send and accept JSON
+      When I send a GET request to /users
+    
+To use Patron
+
+    @faraday_patron
+    Scenario: do something with the API
+      Given I send and accept JSON
+      When I send a GET request to /users    
+      
+### Remote testing
+
+When you want to use this driver to test a remote application. You have to set the app_host:
+
+    Capybara.app_host = "http://www.yourapp.com"
+    
+Note that I haven't tested this case for my self yet. The Capybara tests pass for this situation though so it should work! Please provide me with feedback if it doesn't.
+
+## Running tests
+
+For the tests to make sense, you need to simulate a remote server, simply add this line to your hosts file:
+
+    127.0.0.1 capybara-testapp.heroku.com
+
+Run bundler
+
+    bundle install
+
+Then you are ready to run the test like so
+
+    rake spec
+
+Caveats
+-------
+
+The focus being to provide a working driver to test APIs, not all Capybara goodness are implemented.
+Everything related to submitting forms, clicking buttons, clicking checkboxes or javascript will not work with this driver.
+
+Todo
+----
+
+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) 2010 Tron Jonathan and HALTER Joseph. See LICENSE for details.

data/lib/capybara/driver/faraday_driver.rb

@@ -0,0 +1,185 @@
+require "faraday"
+
+class Capybara::Driver::Faraday < Capybara::Driver::Base
+  class Node < Capybara::RackTest::Node
+    def click
+      driver.process(:get, self[:href].to_s) if self[:href] && self[:href] != ""
+    end
+  end
+
+  attr_writer :as, :with_headers, :with_params, :with_options
+  attr_reader :app, :adapter, :rack_server, :options, :response, :login, :password
+
+  def client
+    @client ||= Faraday::Connection.new{|c| c.adapter adapter}
+  end
+
+  def initialize(app, options={})
+    @app = app
+    @adapter = options.delete(:adapter) || :net_http
+    @options = {
+      :timeout => 3, # 3 seconds
+    }.merge options
+    @rack_server = Capybara::Server.new(@app)
+    @rack_server.boot if Capybara.run_server
+  end
+
+  def visit(url, params = {})
+    reset_cache
+    process :get, url, params
+  end
+
+  def get(url, params = {}, headers = {})
+    reset_cache
+    process :get, url, params, headers
+  end
+
+  def post(url, params = {}, headers = {})
+    reset_cache
+    process :post, url, params, headers
+  end
+
+  def put(url, params = {}, headers = {})
+    reset_cache
+    process :put, url, params, headers
+  end
+
+  def delete(url, params = {}, headers = {})
+    reset_cache
+    process :delete, url, params, headers
+  end
+
+  def head(url, params = {}, headers = {})
+    reset_cache
+    process :head, url, params, headers
+  end
+
+  def patch(url, params = {}, headers = {})
+    reset_cache
+    process :patch, url, params, headers
+  end
+
+  def request(url, params = {}, headers = {})
+    reset_cache
+    process :request, url, params, headers
+  end
+
+  def submit(method, path, attributes)
+    path = request.path if not path or path.empty?
+    process method.to_sym, path, attributes
+  end
+
+  def find(selector)
+    dom.xpath(selector).map { |node| Node.new(self, node) }
+  end
+
+  def html
+    @html ||= Nokogiri::HTML body
+  end
+
+  def xml
+    @xml ||= Nokogiri::XML body
+  end
+
+  def json
+    @json ||= Yajl::Parser.parse body
+  end
+
+  def body
+    response.body
+  end
+  alias_method :source, :body
+
+  def response_headers
+    response.headers["Content-Type"] = response.headers["content-type"]
+    response.headers
+  end
+
+  def status_code
+    response.status
+  end
+
+  def current_url
+    @current_uri.to_s
+  end
+
+  def reset!
+    @client = nil
+    @response = nil
+    @current_uri = nil
+    @login = nil
+    @password = nil
+    reset_cache
+  end
+
+  def reset_with!
+    @with_headers = {}
+    @with_params = {}
+    @with_options = {}
+  end
+
+  def as
+    @as ||= "application/json"
+  end
+
+  def with_headers
+    @with_headers ||= {}
+  end
+
+  def with_params
+    @with_params ||= {}
+  end
+
+  def with_options
+    @with_options ||= {}
+  end
+
+  def authenticate_with(login, password)
+    @login, @password = login, password
+  end
+
+  def auth?
+    login && password
+  end
+
+  def process(method, path, params = {}, headers = {})
+    client.basic_auth login, password if auth?
+    response = client.send(method) do |req|
+      if method == :get
+        req.url url(path), params
+      else
+        req.url url(path)
+        req.body = params
+      end
+      req.headers.merge!(headers.merge("Content-Type" => as, "Accept" => as))
+      req.options = options
+    end
+    @current_uri = url(path)
+    @response = response
+  end
+
+  def url(path)
+    rack_server.url(path)
+  end
+
+  def dom
+    content_type = response_headers["Content-Type"]
+    case content_type.to_s[/\A[^;]+/]
+    when "application/xml", "text/xml"
+      xml
+    when "text/html"
+      html
+    else
+      raise "Content-Type: #{content_type} is not handling xpath search"
+    end
+  end
+
+private
+
+  def reset_cache
+    @xml = nil
+    @html = nil
+    @json = nil
+  end
+
+end

data/lib/capybara/faraday.rb

@@ -0,0 +1,27 @@
+require "capybara"
+
+module Capybara
+  module Driver
+    autoload :Faraday, 'capybara/driver/faraday_driver'
+  end
+end
+
+Capybara.register_driver :faraday do |app|
+  Capybara::Driver::Faraday.new(app) # Net::HTTP
+end
+
+Capybara.register_driver :faraday_excon do |app|
+  Capybara::Driver::Faraday.new(app, :adapter => :excon)
+end
+
+Capybara.register_driver :faraday_typhoeus do |app|
+  Capybara::Driver::Faraday.new(app, :adapter => :typhoeus)
+end
+
+Capybara.register_driver :faraday_patron do |app|
+  Capybara::Driver::Faraday.new(app, :adapter => :patron)
+end
+
+Capybara.register_driver :faraday_em_http do |app|
+  Capybara::Driver::Faraday.new(app, :adapter => :em_http)
+end

data/lib/capybara/faraday/cucumber.rb

@@ -0,0 +1,26 @@
+require 'capybara/faraday'
+
+Before('@faraday') do
+  Capybara.current_driver = :faraday
+  page.driver.reset_with!
+end
+
+Before('@faraday_excon') do
+  Capybara.current_driver = :faraday_excon
+  page.driver.reset_with!
+end
+
+Before('@faraday_typhoeus') do
+  Capybara.current_driver = :faraday_typhoeus
+  page.driver.reset_with!
+end
+
+Before('@faraday_patron') do
+  Capybara.current_driver = :faraday_patron
+  page.driver.reset_with!
+end
+
+Before('@faraday_em_http') do
+  Capybara.current_driver = :faraday_em_http
+  page.driver.reset_with!
+end

data/spec/driver/faraday_driver_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Capybara::Driver::Faraday do
+  before do
+    @driver = described_class.new TestApp
+  end
+
+  context "in remote mode" do
+    it_should_behave_like "driver"
+    it_should_behave_like "driver with header support"
+    it_should_behave_like "driver with status code support"
+    # neither supports cookies nor follows redirect automatically
+  end
+
+  context "basic authentication" do
+    subject do
+      app = Sinatra.new do
+        use Rack::Auth::Basic do |username, password|
+          username=="admin" && password=="secret"
+        end
+        get("/"){ "Success!" }
+      end
+      described_class.new app
+    end
+
+    it "allow access with right credentials" do
+      subject.authenticate_with "admin", "secret"
+      subject.get "/"
+      subject.status_code.should be 200
+      subject.source.should == "Success!"
+    end
+
+    it "deny access with wrong credentials" do
+      subject.authenticate_with "admin", "admin"
+      subject.get "/"
+      subject.status_code.should be 401
+    end
+  end
+
+  context "timeout" do
+    context "default" do
+      subject do
+        driver = described_class.new TestApp
+      end
+
+      it "is 3 seconds" do
+        subject.options[:timeout].should == 3
+      end
+
+      it "is used during request" do
+        expect do
+          subject.get "/slow_response"
+        end.to_not raise_error
+      end
+    end
+
+    context "accepts custom timeout" do
+      subject do
+        driver = described_class.new TestApp, timeout: 1
+      end
+
+      it "is stored in options" do
+        subject.options[:timeout].should == 1
+      end
+
+      it "is used during request" do
+        expect do
+          subject.get "/slow_response"
+        end.to raise_error Faraday::Error::TimeoutError
+      end
+    end
+  end
+
+end

data/spec/session/faraday_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+module TestSessions
+  Faraday = Capybara::Session.new :faraday, TestApp
+end
+
+describe Capybara::Session do
+  context 'with faraday driver' do
+    before(:all) do
+      @session = TestSessions::Faraday
+    end
+
+    after do
+      @session.reset_session!
+    end
+
+    def extract_results(session)
+      YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.text
+    end
+
+    describe '#driver' do
+      it "should be a typhoeus driver" do
+        @session.driver.should be_an_instance_of Capybara::Driver::Faraday
+      end
+    end
+
+    describe '#mode' do
+      it "should remember the mode" do
+        @session.mode.should == :faraday
+      end
+    end
+
+    describe '#app' do
+      it "should remember the application" do
+        @session.app.should == TestApp
+      end
+    end
+
+    describe '#visit' do
+      it "should fetch a response from the driver" do
+        @session.visit('/')
+        @session.body.should include('Hello world!')
+        @session.visit('/foo')
+        @session.body.should include('Another World')
+      end
+    end
+
+    describe '#body' do
+      it "should return the unmodified page body" do
+        @session.visit('/')
+        @session.body.should include('Hello world!')
+      end
+    end
+
+    describe '#source' do
+      it "should return the unmodified page source" do
+        @session.visit('/')
+        @session.source.should include('Hello world!')
+      end
+    end
+
+    it_should_behave_like "all"
+    it_should_behave_like "first"
+    it_should_behave_like "find_button"
+    it_should_behave_like "find_field"
+    it_should_behave_like "find_link"
+    it_should_behave_like "find_by_id"
+    it_should_behave_like "has_content"
+    it_should_behave_like "has_css"
+    it_should_behave_like "has_selector"
+    it_should_behave_like "has_xpath"
+    it_should_behave_like "has_link"
+    it_should_behave_like "has_button"
+    it_should_behave_like "has_field"
+    it_should_behave_like "has_select"
+    it_should_behave_like "has_table"
+    it_should_behave_like "current_url"
+    it_should_behave_like "session without javascript support"
+    it_should_behave_like "session with headers support"
+    it_should_behave_like "session with status code support"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'capybara'
+require 'capybara/faraday'
+require 'capybara/spec/test_app'
+require 'capybara/spec/driver'
+require 'capybara/spec/session'
+
+alias :running :lambda
+
+Capybara.default_wait_time = 0 # less timeout so tests run faster
+
+RSpec.configure do |config|
+  config.after do
+    Capybara.default_selector = :xpath
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: capybara-faraday
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Tron
+- Joseph HALTER
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Faraday driver for Capybara, allowing testing of REST APIs
+email: team@openhood.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/capybara/driver/faraday_driver.rb
+- lib/capybara/faraday/cucumber.rb
+- lib/capybara/faraday.rb
+- spec/driver/faraday_driver_spec.rb
+- spec/session/faraday_spec.rb
+- spec/spec_helper.rb
+- README.md
+homepage: http://github.com/openhood/capybara-faraday
+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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Faraday driver for Capybara
+test_files: []