bbc-capybara-mechanize-with-proxy 0.3.0.rc0 → 0.3.1

data/README.mdown

@@ -1,17 +1,12 @@
 Capybara-mechanize
 ==================
 
-This gems makes it possible to use Capybara for (partially) remote testing. It inherits most functionality from the RackTest driver and only uses [Mechanize](http://github.com/tenderlove/mechanize) for remote requests. 
-
-It is currently in use to test the integration between a Rails application and Twitter authorization and sharing.
-
-This gem is a [Capybara](http://github.com/jnicklas/capybara) extension. I have been inspired by the Capybara driver and some earlier efforts for a Mechanize driver.
-
-Thanks to [Pinkelstar](http://www.pinkelstar.com) for giving me the time and the need to develop this gem.
+Forked from mobzilla/capybara-mechanize and modified to suit the needs of using capybara mechanize from behind a proxy
+or firewall. 
 
 ### Installation
 
-    gem install capybara-mechanize
+    gem install capybara-mechanize-with-proxy
 
 ### Usage without Cucumber
 

data/lib/capybara/mechanize.rb

@@ -20,5 +20,5 @@ end
 require 'capybara/mechanize/driver'
 
 Capybara.register_driver :mechanize do |app|
-  Capybara::Mechanize::Driver.new(app, options = {})
+  Capybara::Mechanize::Driver.new(app)
 end

data/lib/capybara/mechanize/browser.rb

@@ -4,232 +4,246 @@ require 'mechanize'
 class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
   extend Forwardable
   
+  attr_reader :driver
+  
   def_delegator :agent, :scheme_handlers
   def_delegator :agent, :scheme_handlers=
   
-  def initialize(app, options)
+  def initialize(driver)
     @agent = ::Mechanize.new
     @agent.redirect_ok = false
-	if !options.empty?
-		if options[:proxy] && !options[:proxy].empty?
-			proxy = nil
-			begin
-				proxy = URI.parse(options[:proxy])
-			rescue URI::InvalidURIError => e
-				raise "You have entered an invalid proxy address #{options[:proxy]}. Check proxy settings."
-			end
-			if proxy && proxy.instance_of?(URI::HTTP) 
-				@agent.set_proxy(proxy.host, proxy.port)
-			else
-				raise "ProxyError: You have entered an invalid proxy address #{options[:proxy]}. e.g. (http|https)://proxy.com(:port)"
-			end
-		end
-	end
+    @agent.user_agent = default_user_agent
+    if !driver.options.empty?
+      if driver.options[:certificate] && driver.options[:certificate][:key] && driver.options[:certificate][:cer]
+        @agent.cert = driver.options[:certificate][:cer]
+        @agent.key = driver.options[:certificate][:key]
+      end
+      if driver.options[:proxy] && !driver.options[:proxy].empty?
+        proxy = nil
+        begin
+          proxy = URI.parse(driver.options[:proxy])
+        rescue URI::InvalidURIError => e
+          raise "You have entered an invalid proxy address #{driver.options[:proxy]}. Check proxy settings."
+        end
+        if proxy && proxy.instance_of?(URI::HTTP) 
+          @agent.set_proxy(proxy.host, proxy.port)
+        else
+          raise "ProxyError: You have entered an invalid proxy address #{driver.options[:proxy]}. e.g. (http|https)://proxy.com(:port)"
+        end
+      end
+    end
     super
-  end
+  end  
   
   def reset_host!
-    @last_remote_host = nil
-    @last_request_remote = nil
-    super
-  end
-  
-  def current_url
-    last_request_remote? ? remote_response.current_url : super
-  end
-  
-  def last_response
-    last_request_remote? ? remote_response : super
-  end
-  
-  def follow_redirects!
-    5.times do
-      follow_redirect! if last_response.redirect?
-    end
-    raise Capybara::InfiniteRedirectError, "redirected more than 5 times, check for infinite redirects." if last_response.redirect?
-  end
-  
-  def follow_redirect!
-    unless last_response.redirect?
-      raise "Last response was not a redirect. Cannot follow_redirect!"
-    end
-  
-    get(last_location_header)
-  end
-  
-  def process(method, path, *options)
-    reset_cache!
-    send(method, path, *options)
-    follow_redirects!
-  end
-  
-  def process_without_redirect(method, path, attributes, headers)
-    path = @last_path if path.nil? || path.empty?
-
-    if remote?(path)
-      process_remote_request(method, path, attributes, headers)
-    else
-      register_local_request
-      
-      path = determine_path(path)
-      
-      reset_cache!
-      send("racktest_#{method}", path, attributes, env.merge(headers))
-    end
-    
-    @last_path = path
-  end
-  
-  # TODO path Capybara to move this into its own method
-  def determine_path(path)
-    new_uri = URI.parse(path)
-    current_uri = URI.parse(current_url)
+        @last_remote_host = nil
+        @last_request_remote = nil
+        super
+      end
 
-    if new_uri.host
-      @current_host = new_uri.scheme + '://' + new_uri.host
-    end
-  
-    if new_uri.relative?
-      path = request_path + path if path.start_with?('?')
-    
-      unless path.start_with?('/')
-        folders = request_path.split('/')
-        path = (folders[0, folders.size - 1] << path).join('/')
-      end
-      path = current_host + path
-    end
-    path
-  end
-
-  alias :racktest_get :get
-  def get(path, attributes = {}, headers = {})
-    process_without_redirect(:get, path, attributes, headers)
-  end
-
-  alias :racktest_post :post
-  def post(path, attributes = {}, headers = {})
-    process_without_redirect(:post, path, post_data(attributes), headers)
-  end
-  
-  alias :racktest_put :put
-  def put(path, attributes = {}, headers = {})
-    process_without_redirect(:put, path, attributes, headers)
-  end
-  
-  alias :racktest_delete :delete
-  def delete(path, attributes = {}, headers = {})
-    process_without_redirect(:delete, path, attributes, headers)
-  end
-  
-  def post_data(params)
-    params.inject({}) do |memo, param|
-      case param
-      when Hash
-        param.each {|attribute, value| memo[attribute] = value }
-        memo
-      when Array
-        case param.last
-        when Hash
-          param.last.each {|attribute, value| memo["#{param.first}[#{attribute}]"] = value }
+      def current_url
+        last_request_remote? ? remote_response.current_url : super
+      end
+
+      def last_response
+        last_request_remote? ? remote_response : super
+      end
+
+      def follow_redirects!
+        5.times do
+          follow_redirect! if last_response.redirect?
+        end
+        raise Capybara::InfiniteRedirectError, "redirected more than 5 times, check for infinite redirects." if last_response.redirect?
+      end
+
+      def follow_redirect!
+        unless last_response.redirect?
+          raise "Last response was not a redirect. Cannot follow_redirect!"
+        end
+
+        get(last_location_header)
+      end
+
+      def process(method, path, *options)
+        reset_cache!
+        send(method, path, *options)
+        follow_redirects!
+      end
+
+      def process_without_redirect(method, path, attributes, headers)
+        path = @last_path if path.nil? || path.empty?
+
+        if remote?(path)
+          process_remote_request(method, path, attributes, headers)
         else
-          memo[param.first] = param.last
+          register_local_request
+
+          path = determine_path(path)
+
+          reset_cache!
+          send("racktest_#{method}", path, attributes, env.merge(headers))
         end
-        memo
+
+        @last_path = path
       end
-    end
-  end
-  
-  def remote?(url)
-    if Capybara.app_host
-      true
-    else
-      host = URI.parse(url).host
-      
-      if host.nil?
-        last_request_remote?
-      else
-        !Capybara::Mechanize.local_hosts.include?(host)
+
+      # TODO path Capybara to move this into its own method
+      def determine_path(path)
+        new_uri = URI.parse(path)
+        current_uri = URI.parse(current_url)
+
+        if new_uri.host
+          @current_host = new_uri.scheme + '://' + new_uri.host
+        end
+
+        if new_uri.relative?
+          path = request_path + path if path.start_with?('?')
+
+          unless path.start_with?('/')
+            folders = request_path.split('/')
+            if folders.empty?
+              path = '/' + path
+            else
+              path = (folders[0, folders.size - 1] << path).join('/')
+            end
+          end
+          path = current_host + path
+        end
+        path
+      end
+
+      alias :racktest_get :get
+      def get(path, attributes = {}, headers = {})
+        process_without_redirect(:get, path, attributes, headers)
+      end
+
+      alias :racktest_post :post
+      def post(path, attributes = {}, headers = {})
+        process_without_redirect(:post, path, post_data(attributes), headers)
+      end
+
+      alias :racktest_put :put
+      def put(path, attributes = {}, headers = {})
+        process_without_redirect(:put, path, attributes, headers)
+      end
+
+      alias :racktest_delete :delete
+      def delete(path, attributes = {}, headers = {})
+        process_without_redirect(:delete, path, attributes, headers)
+      end
+
+      def post_data(params)
+        params.inject({}) do |memo, param|
+          case param
+          when Hash
+            param.each {|attribute, value| memo[attribute] = value }
+            memo
+          when Array
+            case param.last
+            when Hash
+              param.last.each {|attribute, value| memo["#{param.first}[#{attribute}]"] = value }
+            else
+              memo[param.first] = param.last
+            end
+            memo
+          end
+        end
+      end
+
+      def remote?(url)
+        if Capybara.app_host
+          true
+        else
+          host = URI.parse(url).host
+
+          if host.nil?
+            last_request_remote?
+          else
+            !Capybara::Mechanize.local_hosts.include?(host)
+          end
+        end
+      end
+
+      attr_reader :agent
+
+      private
+
+      def last_location_header
+        last_request_remote? ? remote_response.page.response['Location'] : last_response['Location']
+      end
+
+      def last_request_remote?
+        !!@last_request_remote
+      end
+
+      def register_local_request
+        @last_remote_host = nil
+        @last_request_remote = false
+      end
+
+      def process_remote_request(method, url, attributes, headers)
+        if remote?(url)
+          remote_uri = URI.parse(url)
+
+          if remote_uri.host.nil?
+            remote_host = @last_remote_host || Capybara.app_host || Capybara.default_host
+            url = File.join(remote_host, url)
+            url = "http://#{url}" unless url =~ /^http:/ or url =~ /^https:/
+          else
+            @last_remote_host = "#{remote_uri.host}:#{remote_uri.port}"
+          end
+
+          reset_cache!
+          begin
+            args = []
+            args << attributes unless attributes.empty?
+            args << headers unless headers.empty?
+            @agent.send(method, url, *args)
+          rescue => e
+            raise "Received the following error for a #{method.to_s.upcase} request to #{url}: '#{e.message}'"
+          end
+          @last_request_remote = true
+        end
+      end
+
+      def remote_response
+        ResponseProxy.new(@agent.current_page) if @agent.current_page
+      end
+
+      def default_user_agent
+        "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_0) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.853.0 Safari/535.2"
+      end
+
+      class ResponseProxy
+        extend Forwardable
+
+        def_delegator :page, :body
+
+        attr_reader :page
+
+        def initialize(page)
+          @page = page
+        end
+
+        def current_url
+          page.uri.to_s
+        end
+
+        def headers
+          # Hax the content-type contains utf8, so Capybara specs are failing, need to ask mailinglist
+          headers = page.response
+          headers["content-type"].gsub!(';charset=utf-8', '') if headers["content-type"]
+          headers
+        end
+
+        def status
+          page.code.to_i
+        end
+
+        def redirect?
+          [301, 302].include?(status)
+        end
+
       end
-    end
-  end
-  
-  attr_reader :agent
-  
-  private
-  
-  def last_location_header
-    last_request_remote? ? remote_response.page.response['Location'] : last_response['Location']
-  end
-  
-  def last_request_remote?
-    !!@last_request_remote
-  end
-  
-  def register_local_request
-    @last_remote_host = nil
-    @last_request_remote = false
-  end
-  
-  def process_remote_request(method, url, attributes, headers)
-    if remote?(url)
-      remote_uri = URI.parse(url)
-  
-      if remote_uri.host.nil?
-        remote_host = @last_remote_host || Capybara.app_host || Capybara.default_host
-        url = File.join(remote_host, url)
-        url = "http://#{url}" unless url =~ /^http:/
-      else
-        @last_remote_host = "#{remote_uri.host}:#{remote_uri.port}"
-      end
-      
-      reset_cache!
-      begin
-        args = []
-        args << attributes unless attributes.empty?
-        args << headers unless headers.empty?
-        @agent.send(method, url, *args)
-      rescue => e
-        raise "Received the following error for a #{method.to_s.upcase} request to #{url}: '#{e.message}'"
-      end
-      @last_request_remote = true
-    end
-  end
-  
-  def remote_response
-    ResponseProxy.new(@agent.current_page) if @agent.current_page
-  end
-  
-  class ResponseProxy
-    extend Forwardable
-    
-    def_delegator :page, :body
-    
-    attr_reader :page
-    
-    def initialize(page)
-      @page = page
-    end
-    
-    def current_url
-      page.uri.to_s
-    end
-    
-    def headers
-      # Hax the content-type contains utf8, so Capybara specs are failing, need to ask mailinglist  
-      headers = page.response
-      headers["content-type"].gsub!(';charset=utf-8', '') if headers["content-type"]
-      headers
-    end
-  
-    def status
-      page.code.to_i
-    end    
-  
-    def redirect?
-      [301, 302].include?(status)
-    end
-    
-  end 
-   
-end
 
+    end

data/lib/capybara/mechanize/driver.rb

@@ -15,7 +15,7 @@ class Capybara::Mechanize::Driver < Capybara::RackTest::Driver
   end
   
   def browser
-    @browser ||= Capybara::Mechanize::Browser.new(app, options)
+    @browser ||= Capybara::Mechanize::Browser.new(self)
   end
   
-end
+end

data/lib/capybara/mechanize/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Mechanize
-    VERSION = '0.3.0.rc0'
+    VERSION = '0.3.1'
   end
-end
+end

data/lib/capybara/spec/extended_test_app.rb

@@ -2,27 +2,31 @@ require 'capybara/spec/test_app'
 
 class ExtendedTestApp < TestApp#< Sinatra::Base
   set :environment, :production # so we don't get debug info that makes our test pass!
-  
+
   get %r{/redirect_to/(.*)} do
     redirect params[:captures]
   end
-  
+
   get '/form_with_relative_action_to_host' do
     %{<form action="/request_info/host" method="post">
        <input type="submit" value="submit" />
       </form>}
   end
-  
+
   get '/request_info/form_with_no_action' do
     %{<form method="post">
        <input type="submit" value="submit" />
       </form>}
   end
-  
+
   get '/relative_link_to_host' do
     %{<a href="/request_info/host">host</a>}
   end
-  
+
+  get '/request_info/user_agent' do
+    request.user_agent
+  end
+
   get '/request_info/*' do
     current_request_info
   end
@@ -31,11 +35,10 @@ class ExtendedTestApp < TestApp#< Sinatra::Base
     current_request_info
   end
 
-  
+
   private
-  
+
     def current_request_info
       "Current host is #{request.url}, method #{request.request_method.downcase}"
     end
-end
-
+end

data/spec/driver/remote_mechanize_driver_spec.rb

@@ -58,38 +58,38 @@ describe Capybara::Mechanize::Driver do
 end
 
 describe "Capybara::Mechanize::Driver, browser" do
+  
   before(:each) do
     Capybara.app_host = REMOTE_TEST_URL
   end
-  
+
   after(:each) do
     Capybara.app_host = nil
   end
-    context "in remote mode" do
-  		it "should not throw an error when empty option is passed" do
-      		running do
-        		Capybara::Mechanize::Driver.new(ExtendedTestApp, {})
-      		end.should_not raise_error()
-    	end
-    	
-    	it "should throw an error when bad proxy option is passed" do
-      		running do
-        		Capybara::Mechanize::Driver.new(ExtendedTestApp, {:proxy => BAD_PROXY}).browser
-      		end.should raise_error("ProxyError: You have entered an invalid proxy address #{BAD_PROXY}. e.g. (http|https)://proxy.com(:port)")
-    	end
-    	
-    	it "should not throw an error when good proxy option is passed" do
-      		running do
-        		Capybara::Mechanize::Driver.new(ExtendedTestApp, {:proxy => GOOD_PROXY}).browser
-      		end.should_not raise_error()
-    	end
-    	
-    	it "should not throw an error when good proxy with port option is passed" do
-      		running do
-        		Capybara::Mechanize::Driver.new(ExtendedTestApp, {:proxy => PROXY_WITH_PORT}).browser
-      		end.should_not raise_error()
-    	end
-    	
-    	
-  	end
+  
+  context "in remote mode" do
+    it "should not throw an error when empty option is passed" do
+      running do
+        Capybara::Mechanize::Driver.new(ExtendedTestApp, {})
+      end.should_not raise_error()
+    end
+
+    it "should throw an error when bad proxy option is passed" do
+      running do
+        Capybara::Mechanize::Driver.new(ExtendedTestApp, {:proxy => BAD_PROXY}).browser
+      end.should raise_error("ProxyError: You have entered an invalid proxy address #{BAD_PROXY}. e.g. (http|https)://proxy.com(:port)")
+    end
+
+    it "should not throw an error when good proxy option is passed" do
+      running do
+        Capybara::Mechanize::Driver.new(ExtendedTestApp, {:proxy => GOOD_PROXY}).browser
+      end.should_not raise_error()
+    end
+
+    it "should not throw an error when good proxy with port option is passed" do
+      running do
+        Capybara::Mechanize::Driver.new(ExtendedTestApp, {:proxy => PROXY_WITH_PORT}).browser
+      end.should_not raise_error()
+    end
+  end
 end

data/spec/session/mechanize_spec.rb

@@ -4,6 +4,7 @@ describe Capybara::Session do
   context 'with mechanize driver' do
     before do
       @session = Capybara::Session.new(:mechanize, TestApp)
+      @session.driver.options[:respect_data_method] = true
       Capybara.default_host = 'http://www.local.com'
     end
 
@@ -26,28 +27,33 @@ describe Capybara::Session do
         @session.body.should include('The requested object was deleted')
       end
     end
-    
+
     it "should use the last remote url when following relative links" do
       @session.visit("#{REMOTE_TEST_URL}/relative_link_to_host")
       @session.click_link "host"
       @session.body.should include("Current host is #{REMOTE_TEST_URL}/request_info/host, method get")
     end
-    
+
     it "should use the last remote url when submitting a form with a relative action" do
       @session.visit("#{REMOTE_TEST_URL}/form_with_relative_action_to_host")
       @session.click_button "submit"
       @session.body.should include("Current host is #{REMOTE_TEST_URL}/request_info/host, method post")
     end
-    
+
     it "should use the last url when submitting a form with no action" do
       @session.visit("#{REMOTE_TEST_URL}/request_info/form_with_no_action")
       @session.click_button "submit"
       @session.body.should include("Current host is #{REMOTE_TEST_URL}/request_info/form_with_no_action, method post")
     end
 
+    it "should send correct user agent" do
+      @session.visit("#{REMOTE_TEST_URL}/request_info/user_agent")
+      @session.body.should include("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_0) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.853.0 Safari/535.2")
+    end
+
     it_should_behave_like "session"
     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
+end

data/spec/session/remote_mechanize_spec.rb

@@ -13,6 +13,7 @@ describe Capybara::Session do
     
     before do      
       @session = Capybara::Session.new(:mechanize)
+      @session.driver.options[:respect_data_method] = true
     end
 
     describe '#driver' do

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bbc-capybara-mechanize-with-proxy
 version: !ruby/object:Gem::Version 
-  hash: 15424037
-  prerelease: 6
+  hash: 17
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  - rc
-  - 0
-  version: 0.3.0.rc0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jeroen van Dijk
@@ -19,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-28 00:00:00 Z
+date: 2012-02-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mechanize
@@ -48,9 +46,9 @@ dependencies:
         hash: 23
         segments: 
         - 1
-        - 0
-        - 0
-        version: 1.0.0
+        - 1
+        - 2
+        version: 1.1.2
   type: :runtime
   version_requirements: *id002
 description: RackTest driver for Capybara, but with remote request support thanks to mechanize and added proxy configuration features