capybara-typhoeus 0.1.0

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/typhoeus_driver.rb

@@ -0,0 +1,155 @@
+require "typhoeus"
+
+class Capybara::Driver::Typhoeus < Capybara::Driver::Base
+  class Node < Capybara::Driver::RackTest::Node
+    def click
+      driver.process(:get, self[:href].to_s) if self[:href] && self[:href] != ""
+    end
+  end
+
+  attr_accessor :as, :follow
+  attr_reader :app, :rack_server, :options, :response
+
+  def client
+    @client ||= Typhoeus::Hydra.new
+  end
+  
+  def initialize(app, options={})
+    @app = app
+    @options = 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)
+    content_type = response_headers["Content-Type"]
+    case content_type.to_s[/\A[^;]+/]
+    when "application/xml", "text/xml"
+      xml
+    when "text/html"
+      html
+    else
+      # $stdout.puts "response: #{response.inspect}"
+      raise "Content-Type: #{content_type} is not handling xpath search"
+    end.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 ||= ActiveSupport::JSON.decode body
+  end
+  
+  def body
+    # $stdout.puts "body: #{response.body}"
+    response.body
+  end
+  alias_method :source, :body
+  
+  def response_headers
+    response.headers_hash
+  end
+
+  def status_code
+    response.code
+  end
+  
+  def current_url
+    @current_uri.to_s
+  end
+  
+  def reset!
+    @client = nil
+    @response = nil
+    @current_uri = nil
+    reset_cache
+  end
+  
+  def as
+    @as ||= "application/json"
+  end
+  
+  def with
+    @with ||= {}
+  end
+
+  def process(method, path, params = {}, headers = {})
+    @current_uri = url path
+    opts = {
+      :method => method,
+      :headers => headers.merge("Content-Type" => as, "Accept" => as),
+      :timeout => 100,
+    }
+    opts[method==:get ? :params : :body] = params
+    # $stdout.puts "current_uri: #{@current_uri}"
+    # $stdout.puts "opts: #{opts.inspect}"
+    request = Typhoeus::Request.new @current_uri, opts
+    client.queue request
+    client.run
+    @response = request.response
+  end
+
+  def url(path)
+    rack_server.url(path)
+  end
+
+private
+
+  def reset_cache
+    @xml = nil
+    @html = nil
+    @json = nil
+  end
+
+end

data/lib/capybara/spec/extended_test_app.rb

@@ -0,0 +1,17 @@
+require 'capybara/spec/test_app'
+
+class ExtendedTestApp < TestApp
+  set :environment, :production
+  
+  get %r{/redirect_to/(.*)} do
+    redirect params[:captures]
+  end
+  
+  get '/host' do
+    "current host is #{request.host}"
+  end
+end
+
+if __FILE__ == $0
+  Rack::Handler::Mongrel.run ExtendedTestApp, :Port => 8070
+end

data/lib/capybara/typhoeus.rb

@@ -0,0 +1,9 @@
+module Capybara
+  module Driver
+    autoload :Typhoeus, 'capybara/driver/typhoeus_driver'
+  end
+end
+
+Capybara.register_driver :typhoeus do |app|
+  Capybara::Driver::Typhoeus.new(app)
+end

data/lib/capybara/typhoeus/cucumber.rb

@@ -0,0 +1,5 @@
+require 'capybara/typhoeus'
+
+Before('@typhoeus') do
+  Capybara.current_driver = :typhoeus
+end

data/spec/driver/typhoeus_driver_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Capybara::Driver::Typhoeus do
+  before do
+    @driver = Capybara::Driver::Typhoeus.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
+  
+end

data/spec/session/typhoeus_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module TestSessions
+  Typhoeus = Capybara::Session.new :typhoeus, TestApp
+end
+
+describe Capybara::Session do
+  context 'with typhoeus driver' do
+    before(:all) do
+      @session = TestSessions::Typhoeus
+    end
+
+    describe '#driver' do
+      it "should be a typhoeus driver" do
+        @session.driver.should be_an_instance_of Capybara::Driver::Typhoeus
+      end
+    end
+
+    describe '#mode' do
+      it "should remember the mode" do
+        @session.mode.should == :typhoeus
+      end
+    end
+
+    def extract_results(session)
+      YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.text
+    end
+
+    after do
+      @session.reset!
+    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_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/typhoeus'
+require 'capybara/spec/extended_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,77 @@
+--- !ruby/object:Gem::Specification
+name: capybara-typhoeus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joseph HALTER
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-22 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &2165218620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165218620
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &2165218020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165218020
+description: Typhoeus driver for Capybara, allowing testing of REST APIs
+email: joseph.halter@thetalentbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/capybara/driver/typhoeus_driver.rb
+- lib/capybara/spec/extended_test_app.rb
+- lib/capybara/typhoeus/cucumber.rb
+- lib/capybara/typhoeus.rb
+- spec/driver/typhoeus_driver_spec.rb
+- spec/session/typhoeus_spec.rb
+- spec/spec_helper.rb
+- README.md
+has_rdoc: true
+homepage: https://github.com/TalentBox/capybara-typhoeus
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Typhoeus driver for Capybara
+test_files: []