puffing-billy 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab6b245ca1fa1295379ac58fcc023b9ae2d4be4b
-  data.tar.gz: d2ed68617bba9beca40b228fbfb116bed58f8641
+  metadata.gz: 9df069d25b0352ca1208074cf35c1b8abec1ba03
+  data.tar.gz: 1768ffd02817406f80450fcfa92153f56144e2f0
 SHA512:
-  metadata.gz: 7d4919dba7d0619860e035edf00580479228b3de38da97185b21356ba077f39c42add963de90f1521f30933e08f20c0e3494de359c892bb3b1e5fa1029bca704
-  data.tar.gz: dc18d1801cf9bb821a7fefa6f093cfdfe748f8ea500058f2d60f59e422c78c5135114bacf7f110acf9001c8ea0495e0899311e364d2cea7f84bf6110814db7b6
+  metadata.gz: 421ec2e524b8cd62ffd2ade27c9119c6b06c7c9217f18c594ac0d1ff51530fb34b7a56d73a07e6b7e8060e89ecb7ec07003b47ae3de75f42b3b63eb9ef7ad04a
+  data.tar.gz: 4397dafabee3b83d326f398a27a0767c5318f1f956d8031214db7a8b366a49e63343ca6d16c1b713c1bc5416d7e3ca5b94f3c047ee4290097f1ef2a850d3b960

data/.travis.yml

@@ -1,6 +1,11 @@
 language: ruby
 before_install:
   - gem install bundler
+  - mkdir travis-phantomjs
+  - wget https://s3.amazonaws.com/travis-phantomjs/phantomjs-2.0.0-ubuntu-12.04.tar.bz2 -O $PWD/travis-phantomjs/phantomjs-2.0.0-ubuntu-12.04.tar.bz2
+  - tar -xvf $PWD/travis-phantomjs/phantomjs-2.0.0-ubuntu-12.04.tar.bz2 -C $PWD/travis-phantomjs
+  - export PATH=$PWD/travis-phantomjs:$PATH
+  - phantomjs --version
 rvm:
   - 1.9.3
   - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.9.0, 2016-07-23
+------------------
+  * Add Watir web driver support [#158](https://github.com/oesmith/puffing-billy/pull/158)
+  * Fix response headers by anticipating EventMachine::HttpResponse behavior [#162](https://github.com/oesmith/puffing-billy/pull/162)
+  * Support using a Regexp in path_blacklist [#163](https://github.com/oesmith/puffing-billy/pull/163)
+
 v0.8.0, 2016-06-02
 ------------------
   * Add optional after_cache_handles_request callback for manipulating cached responses [#149](https://github.com/oesmith/puffing-billy/pull/149)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puffing-billy (0.8.0)
+    puffing-billy (0.9.0)
       addressable
       em-http-request (~> 1.1.0)
       em-synchrony
@@ -126,6 +126,8 @@ GEM
       eventmachine (~> 1.0)
       rack (~> 1.0)
     thor (0.19.1)
+    watir-webdriver (0.9.1)
+      selenium-webdriver (>= 2.46.2)
     websocket (1.2.2)
     websocket-driver (0.6.2)
       websocket-extensions (>= 0.1.0)
@@ -150,6 +152,7 @@ DEPENDENCIES
   rspec
   selenium-webdriver
   thin
+  watir-webdriver
 
 BUNDLED WITH
-   1.11.2
+   1.12.4

data/README.md

@@ -1,4 +1,4 @@
-# Puffing Billy
+# Puffing Billy [![Gem Version](https://badge.fury.io/rb/puffing-billy.svg)](https://badge.fury.io/rb/puffing-billy) [![Build Status](https://travis-ci.org/oesmith/puffing-billy.svg?branch=master)](https://travis-ci.org/oesmith/puffing-billy)
 
 A rewriting web proxy for testing interactions between your browser and
 external sites. Works with ruby + rspec.
@@ -46,10 +46,12 @@ Or install it yourself as:
 
 ## RSpec Usage
 
+### Setup for Capybara
+
 In your `rails_helper.rb`:
 
 ```ruby
-require 'billy/rspec'
+require 'billy/capybara/rspec'
 
 # select a driver for your chosen browser environment
 Capybara.javascript_driver = :selenium_billy # Uses Firefox
@@ -58,11 +60,24 @@ Capybara.javascript_driver = :selenium_billy # Uses Firefox
 # Capybara.javascript_driver = :poltergeist_billy
 ```
 
-Note: :poltergeist_billy doesn't support proxying any localhosts, so you must use
-:webkit_billy for headless specs when using puffing-billy for other local rack apps.
+> __Note__: `:poltergeist_billy` doesn't support proxying any localhosts, so you must use
+`:webkit_billy` for headless specs when using puffing-billy for other local rack apps.
 See [this phantomjs issue](https://github.com/ariya/phantomjs/issues/11342) for any updates.
 
-In your tests:
+### Setup for Watir
+
+In your `rails_helper.rb`:
+
+```ruby
+require 'billy/watir/rspec'
+
+# select a driver for your chosen browser environment
+@browser = Billy::Browsers::Watir.new :firefox
+# @browser = Billy::Browsers::Watir.new = :chrome
+# @browser = Billy::Browsers::Watir.new = :phantomjs
+```
+
+### In your tests (Capybara/Watir)
 
 ```ruby
 # Stub and return text, json, jsonp (or anything else)
@@ -115,16 +130,6 @@ proxied to the remote server.
 
 ## Cucumber Usage
 
-In your `features/support/env.rb`:
-
-```ruby
-require 'billy/cucumber'
-
-After do
-  Capybara.use_default_driver
-end
-```
-
 An example feature:
 
 ```
@@ -135,6 +140,18 @@ Feature: Stubbing via billy
     And a stub for google
 ```
 
+### Capybara
+
+In your `features/support/env.rb`:
+
+```ruby
+require 'billy/capybara/cucumber'
+
+After do
+  Capybara.use_default_driver
+end
+```
+
 And in steps:
 
 ```ruby
@@ -154,6 +171,32 @@ It's good practice to reset the driver after each scenario, so having an
 stubs are reset after each step, so any usage of a stub should be in the
 same step that it was created in.
 
+### Watir
+
+In your `features/support/env.rb`:
+
+```ruby
+require 'billy/watir/cucumber'
+
+After do
+  @browser.close
+end
+```
+
+And in steps:
+
+```ruby
+Before('@billy') do
+  @browser = Billy::Browsers::Watir.new :firefox
+end
+
+And /^a stub for google$/ do
+  proxy.stub('http://www.google.com/').and_return(:text => "I'm not Google!")
+  @browser.goto 'http://www.google.com/'
+  expect(@browser.text).to eq("I'm not Google!")
+end
+```
+
 ## Minitest Usage
 
 Please see [this link](https://gist.github.com/sauy7/1b081266dd453a1b737b) for

data/lib/billy.rb

@@ -19,53 +19,4 @@ module Billy
       proxy
     )
   end
-
-  def self.register_drivers
-    ['capybara/poltergeist', 'capybara/webkit', 'selenium/webdriver'].each do |d|
-      begin
-        require d
-      rescue LoadError
-      end
-    end
-
-    if defined?(Capybara::Poltergeist)
-      Capybara.register_driver :poltergeist_billy do |app|
-        options = {
-          phantomjs_options: [
-            '--ignore-ssl-errors=yes',
-            "--proxy=#{Billy.proxy.host}:#{Billy.proxy.port}"
-          ]
-        }
-        Capybara::Poltergeist::Driver.new(app, options)
-      end
-    end
-
-    if defined?(Capybara::Webkit::Driver)
-      Capybara.register_driver :webkit_billy do |app|
-        options = {
-          ignore_ssl_errors: true,
-          proxy: {host: Billy.proxy.host, port: Billy.proxy.port}
-        }
-        Capybara::Webkit::Driver.new(app, Capybara::Webkit::Configuration.to_hash.merge(options))
-      end
-    end
-
-    if defined?(Selenium::WebDriver)
-      Capybara.register_driver :selenium_billy do |app|
-        profile = Selenium::WebDriver::Firefox::Profile.new
-        profile.assume_untrusted_certificate_issuer = false
-        profile.proxy = Selenium::WebDriver::Proxy.new(
-          http: "#{Billy.proxy.host}:#{Billy.proxy.port}",
-          ssl: "#{Billy.proxy.host}:#{Billy.proxy.port}")
-        Capybara::Selenium::Driver.new(app, profile: profile)
-      end
-
-      Capybara.register_driver :selenium_chrome_billy do |app|
-        Capybara::Selenium::Driver.new(
-          app, browser: :chrome,
-          switches: ["--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}"]
-        )
-      end
-    end
-  end
 end

data/lib/billy/browsers/capybara.rb

@@ -0,0 +1,64 @@
+require 'billy'
+
+module Billy
+  module Browsers
+    class Capybara
+
+      DRIVERS = {
+        poltergeist: 'capybara/poltergeist',
+        webkit: 'capybara/webkit',
+        selenium: 'selenium/webdriver'
+      }
+
+      def self.register_drivers
+        DRIVERS.each do |name, driver|
+          require driver rescue next
+          send("register_#{name}_driver")
+        end
+      end
+
+      private
+
+      def self.register_poltergeist_driver
+        ::Capybara.register_driver :poltergeist_billy do |app|
+          options = {
+            phantomjs_options: [
+              '--ignore-ssl-errors=yes',
+              "--proxy=#{Billy.proxy.host}:#{Billy.proxy.port}"
+            ]
+          }
+          ::Capybara::Poltergeist::Driver.new(app, options)
+        end
+      end
+
+      def self.register_webkit_driver
+        ::Capybara.register_driver :webkit_billy do |app|
+          options = {
+            ignore_ssl_errors: true,
+            proxy: {host: Billy.proxy.host, port: Billy.proxy.port}
+          }
+          ::Capybara::Webkit::Driver.new(app, ::Capybara::Webkit::Configuration.to_hash.merge(options))
+        end
+      end
+
+      def self.register_selenium_driver
+        ::Capybara.register_driver :selenium_billy do |app|
+          profile = Selenium::WebDriver::Firefox::Profile.new
+          profile.assume_untrusted_certificate_issuer = false
+          profile.proxy = Selenium::WebDriver::Proxy.new(
+            http: "#{Billy.proxy.host}:#{Billy.proxy.port}",
+            ssl: "#{Billy.proxy.host}:#{Billy.proxy.port}")
+          ::Capybara::Selenium::Driver.new(app, profile: profile)
+        end
+
+        ::Capybara.register_driver :selenium_chrome_billy do |app|
+          ::Capybara::Selenium::Driver.new(
+            app, browser: :chrome,
+            switches: ["--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}"]
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/billy/browsers/watir.rb

@@ -0,0 +1,44 @@
+require 'billy'
+require 'watir-webdriver'
+
+module Billy
+  module Browsers
+    class Watir < ::Watir::Browser
+
+      def initialize(name, args = {})
+        args = case name
+          when :chrome then configure_chrome(args)
+          when :phantomjs then configure_phantomjs(args)
+          when :firefox then configure_firefox(args)
+          else
+            raise NameError, "Invalid browser driver specified. (Expected: :chrome, :phantomjs, :firefox)"
+        end
+        super
+      end
+
+      private
+
+      def configure_chrome(args)
+        args[:switches] ||= []
+        args[:switches] += %W[--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}]
+        args
+      end
+
+      def configure_phantomjs(args)
+        args[:args] ||= []
+        args[:args] += %W[--proxy=#{Billy.proxy.host}:#{Billy.proxy.port}]
+        args
+      end
+
+      def configure_firefox(args)
+        args[:profile] ||= Selenium::WebDriver::Firefox::Profile.new
+        args[:profile].proxy = Selenium::WebDriver::Proxy.new(
+          http: "#{Billy.proxy.host}:#{Billy.proxy.port}",
+          ssl: "#{Billy.proxy.host}:#{Billy.proxy.port}"
+        )
+        args
+      end
+
+    end
+  end
+end

data/lib/billy/capybara/cucumber.rb

@@ -0,0 +1,5 @@
+require 'capybara/cucumber'
+require 'billy/browsers/capybara'
+require 'billy/init/cucumber'
+
+Billy::Browsers::Capybara.register_drivers

data/lib/billy/capybara/rspec.rb

@@ -0,0 +1,5 @@
+require 'capybara/rspec'
+require 'billy/browsers/capybara'
+require 'billy/init/rspec'
+
+Billy::Browsers::Capybara.register_drivers

data/lib/billy/cucumber.rb

@@ -1,19 +1,4 @@
-require 'cucumber'
-require 'capybara/cucumber'
-require 'billy'
+# Deprecated
+require 'billy/capybara/cucumber'
 
-Billy.register_drivers
-
-module Billy
-  module CucumberHelper
-    def proxy
-      Billy.proxy
-    end
-  end
-end
-
-World(Billy::CucumberHelper)
-
-After('@billy') do
-  proxy.reset
-end
+warn "[DEPRECATION] `require 'billy/cucumber'` is deprecated. Please use `require 'billy/capybara/cucumber'` instead."

data/lib/billy/handlers/proxy_handler.rb

@@ -73,9 +73,9 @@ module Billy
       response = {
         status: req.response_header.status,
         headers: req.response_header.raw,
-        content: req.response.force_encoding('BINARY') }
+        content: req.response.force_encoding('BINARY')
+      }
       response[:headers].merge!('Connection' => 'close')
-      response[:headers].delete('Transfer-Encoding')
       response
     end
 
@@ -111,7 +111,7 @@ module Billy
     end
 
     def blacklisted_path?(path)
-      !Billy.config.path_blacklist.index { |bl| path.include?(bl) }.nil?
+      !Billy.config.path_blacklist.index { |bl| bl.is_a?(Regexp) ? path =~ bl : path.include?(bl) }.nil?
     end
 
     def successful_status?(status)

data/lib/billy/init/cucumber.rb

@@ -0,0 +1,15 @@
+require 'cucumber'
+
+module Billy
+  module CucumberHelper
+    def proxy
+      Billy.proxy
+    end
+  end
+end
+
+World(Billy::CucumberHelper)
+
+After('@billy') do
+  proxy.reset
+end

data/lib/billy/init/rspec.rb

@@ -0,0 +1,15 @@
+module Billy
+  module RspecHelper
+    def proxy
+      Billy.proxy
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(Billy::RspecHelper)
+
+  config.after(:each) do
+    proxy.reset
+  end
+end

data/lib/billy/proxy_connection.rb

@@ -74,12 +74,25 @@ module Billy
 
     private
 
+    def prepare_response_headers_for_evma_httpserver(headers)
+      # Remove the headers below because they will be added later by evma_httpserver (EventMachine::DelegatedHttpResponse).
+      # See https://github.com/eventmachine/evma_httpserver/blob/master/lib/evma_httpserver/response.rb
+      headers_to_remove = [
+        'transfer-encoding',
+        'content-length',
+        'content-encoding'
+      ]
+
+      headers.delete_if {|key, value| headers_to_remove.include?(key.downcase) }
+    end
+
     def send_response(response)
       res = EM::DelegatedHttpResponse.new(self)
       res.status = response[:status]
-      res.headers = response[:headers]
+      res.headers = prepare_response_headers_for_evma_httpserver(response[:headers])
       res.content = response[:content]
       res.send_response
     end
+    
   end
 end

data/lib/billy/rspec.rb

@@ -1,20 +1,4 @@
-require 'capybara/rspec'
-require 'billy'
+# Deprecated
+require 'billy/capybara/rspec'
 
-Billy.register_drivers
-
-module Billy
-  module RspecHelper
-    def proxy
-      Billy.proxy
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include(Billy::RspecHelper)
-
-  config.after(:each) do
-    proxy.reset
-  end
-end
+warn "[DEPRECATION] `require 'billy/rspec'` is deprecated. Please use `require 'billy/capybara/rspec'` instead."

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/billy/watir/cucumber.rb

@@ -0,0 +1,2 @@
+require 'billy/browsers/watir'
+require 'billy/init/cucumber'

data/lib/billy/watir/rspec.rb

@@ -0,0 +1,2 @@
+require 'billy/browsers/watir'
+require 'billy/init/rspec'

data/puffing-billy.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rb-inotify'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'watir-webdriver'
   gem.add_runtime_dependency 'addressable'
   gem.add_runtime_dependency 'eventmachine', '~> 1.0.4'
   gem.add_runtime_dependency 'em-synchrony'

data/spec/lib/billy/proxy_connection_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Billy::ProxyConnection do
+  context '#prepare_response_headers_for_evma_httpserver' do
+    let(:subject) { Billy::ProxyConnection.new('') }
+    
+    it 'should remove duplicated headers fields' do
+        provided_headers = {
+            'transfer-encoding' => '',
+            'content-length' => '',
+            'content-encoding' => '',
+            'key' => 'value'
+        }
+        expected_headers = { 'key' => 'value' }
+        headers = subject.send(:prepare_response_headers_for_evma_httpserver, provided_headers)
+
+        expect(headers).to eql expected_headers
+    end
+  end
+end

data/spec/lib/billy/watir/watir_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'Watir-specific tests', type: :feature, js: true do
+  before do
+    proxy.stub('http://www.example.com/get').and_return(
+      text: 'Success!'
+    )
+  end
+
+  it 'should raise a NameError if an invalid browser driver is specified' do
+    expect{Billy::Browsers::Watir.new :invalid}.to raise_error(NameError)
+  end
+
+  it 'should respond to a stubbed GET request' do
+    @browser.goto 'http://www.example.com/get'
+    expect(@browser.text).to eq 'Success!'
+  end
+end

data/spec/lib/proxy_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'billy'
 require 'resolv'
 
 shared_examples_for 'a proxy server' do
@@ -135,6 +134,20 @@ shared_examples_for 'a cache' do
     it 'should be cached' do
       assert_cached_url('/api')
     end
+
+    context 'path_blacklist includes regex' do
+      before do
+        Billy.config.path_blacklist = [/widgets$/]
+      end
+
+      it 'should not cache a non-match' do
+        assert_noncached_url('/widgets/5/edit')
+      end
+
+      it 'should cache a match' do
+        assert_cached_url('/widgets')
+      end
+    end
   end
 
   context 'cache persistence' do

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
 Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
 
 require 'pry'
-require 'billy/rspec'
+require 'billy/capybara/rspec'
+require 'billy/watir/rspec'
 require 'rack'
 require 'logger'
 
+browser = Billy::Browsers::Watir.new :phantomjs
 Capybara.app = Rack::Directory.new(File.expand_path('../../examples', __FILE__))
 Capybara.javascript_driver = :poltergeist_billy
 
@@ -20,6 +22,7 @@ RSpec.configure do |config|
 
   config.before :all do
     start_test_servers
+    @browser = browser
   end
 
   config.before :each do
@@ -29,4 +32,8 @@ RSpec.configure do |config|
   config.after :each do
     Billy.config.reset
   end
+
+  config.after :suite do
+    browser.close
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Olly Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -303,7 +317,11 @@ files:
 - examples/preflight_request.html
 - examples/tumblr_api.html
 - lib/billy.rb
+- lib/billy/browsers/capybara.rb
+- lib/billy/browsers/watir.rb
 - lib/billy/cache.rb
+- lib/billy/capybara/cucumber.rb
+- lib/billy/capybara/rspec.rb
 - lib/billy/config.rb
 - lib/billy/cucumber.rb
 - lib/billy/handlers/cache_handler.rb
@@ -311,6 +329,8 @@ files:
 - lib/billy/handlers/proxy_handler.rb
 - lib/billy/handlers/request_handler.rb
 - lib/billy/handlers/stub_handler.rb
+- lib/billy/init/cucumber.rb
+- lib/billy/init/rspec.rb
 - lib/billy/json_utils.rb
 - lib/billy/mitm.crt
 - lib/billy/mitm.key
@@ -320,6 +340,8 @@ files:
 - lib/billy/railtie.rb
 - lib/billy/rspec.rb
 - lib/billy/version.rb
+- lib/billy/watir/cucumber.rb
+- lib/billy/watir/rspec.rb
 - lib/puffing-billy.rb
 - lib/puffing-billy/rspec.rb
 - lib/tasks/billy.rake
@@ -338,8 +360,10 @@ files:
 - spec/lib/billy/handlers/proxy_handler_spec.rb
 - spec/lib/billy/handlers/request_handler_spec.rb
 - spec/lib/billy/handlers/stub_handler_spec.rb
+- spec/lib/billy/proxy_connection_spec.rb
 - spec/lib/billy/proxy_request_stub_spec.rb
 - spec/lib/billy/resource_utils_spec.rb
+- spec/lib/billy/watir/watir_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb
@@ -380,8 +404,10 @@ test_files:
 - spec/lib/billy/handlers/proxy_handler_spec.rb
 - spec/lib/billy/handlers/request_handler_spec.rb
 - spec/lib/billy/handlers/stub_handler_spec.rb
+- spec/lib/billy/proxy_connection_spec.rb
 - spec/lib/billy/proxy_request_stub_spec.rb
 - spec/lib/billy/resource_utils_spec.rb
+- spec/lib/billy/watir/watir_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb