puffing-billy 0.1.0

data/lib/billy/proxy_request_stub.rb

@@ -0,0 +1,65 @@
+require 'yajl'
+
+module Billy
+  class ProxyRequestStub
+    def initialize(url, options = {})
+      @options = {:method => :get}.merge(options)
+      @method = @options[:method].to_s.upcase
+      @url = url
+      @response = [204, {}, ""]
+    end
+
+    def and_return(response)
+      @response = response
+      self
+    end
+
+    def call(params, headers, body)
+      if @response.respond_to?(:call)
+        res = @response.call(params, headers, body)
+      else
+        res = @response
+      end
+
+      code = res[:code] || 200
+
+      headers = res[:headers] || {}
+      headers['Content-Type'] = res[:content_type] if res[:content_type]
+
+      if res[:json]
+        headers = {'Content-Type' => 'application/json'}.merge(headers)
+        body = Yajl::Encoder.encode(res[:json])
+      elsif res[:jsonp]
+        headers = {'Content-Type' => 'application/javascript'}.merge(headers)
+        if res[:callback]
+          callback = res[:callback]
+        elsif res[:callback_param]
+          callback = params[res[:callback_param]][0]
+        else
+          callback = params['callback'][0]
+        end
+        body = "#{callback}(#{Yajl::Encoder::encode(res[:jsonp])})"
+      elsif res[:text]
+        headers = {'Content-Type' => 'text/plain'}.merge(headers)
+        body = res[:text]
+      elsif res[:redirect_to]
+        code = 302
+        headers = {'Location' => res[:redirect_to]}
+      else
+        body = res[:body]
+      end
+
+      [code, headers, body]
+    end
+
+    def matches?(method, url)
+      if method == @method
+        if @url.is_a?(Regexp)
+          url.match(@url)
+        else
+          url.split('?')[0] == @url
+        end
+      end
+    end
+  end
+end

data/lib/billy/rspec.rb

@@ -0,0 +1,60 @@
+require 'rspec'
+require 'billy'
+
+$billy_proxy = Billy::Proxy.new
+$billy_proxy.start
+
+module Billy
+  def self.proxy
+    $billy_proxy
+  end
+
+  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
+
+if defined?(Capybara)
+
+  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::Driver::Webkit)
+    Capybara.register_driver :webkit_billy do |app|
+      driver = Capybara::Driver::Webkit.new(app)
+      driver.browser.set_proxy(:host => Billy.proxy.host,
+                               :port => Billy.proxy.port)
+      driver.browser.ignore_ssl_errors
+      driver
+    end
+  end
+
+  if defined?(Selenium::WebDriver)
+    Capybara.register_driver :selenium_billy do |app|
+      profile = Selenium::WebDriver::Firefox::Profile.new
+      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
+  end
+end

data/lib/billy/version.rb

@@ -0,0 +1,3 @@
+module Billy
+  VERSION = "0.1.0"
+end

data/puffing-billy.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/billy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Olly Smith"]
+  gem.email         = ["olly.smith@gmail.com"]
+  gem.description   = %q{A stubbing proxy server for ruby. Connect it to your browser in integration tests to fake interactions with remote HTTP(S) servers.}
+  gem.summary       = %q{Easy request stubs for browser tests.}
+  gem.homepage      = "https://github.com/oesmith/puffing-billy"
+
+  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.name          = "puffing-billy"
+  gem.require_paths = ["lib"]
+  gem.version       = Billy::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "thin"
+  gem.add_development_dependency "faraday"
+  gem.add_development_dependency "capybara"
+  gem.add_development_dependency "poltergeist"
+  gem.add_development_dependency "selenium-webdriver"
+  gem.add_development_dependency "capybara-webkit"
+  gem.add_development_dependency "rack"
+  gem.add_runtime_dependency "eventmachine"
+  gem.add_runtime_dependency "em-http-request"
+  gem.add_runtime_dependency "eventmachine_httpserver"
+  gem.add_runtime_dependency "http_parser.rb"
+  gem.add_runtime_dependency "yajl-ruby"
+end

data/spec/fixtures/test-server.crt

@@ -0,0 +1,15 @@
+-----BEGIN CERTIFICATE-----
+MIICazCCAdQCCQD9MxXmqmRKtTANBgkqhkiG9w0BAQUFADB6MQswCQYDVQQGEwJV
+UzELMAkGA1UECBMCQ0ExITAfBgNVBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEWMBQGA1UEAxMNUHVmZmluZyBCaWxseTEjMCEGCSqGSIb3DQEJARYUb2xseS5z
+bWl0aEBnbWFpbC5jb20wHhcNMTIxMDA0MDgwNzMxWhcNMTIxMTAzMDgwNzMxWjB6
+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExITAfBgNVBAoTGEludGVybmV0IFdp
+ZGdpdHMgUHR5IEx0ZDEWMBQGA1UEAxMNUHVmZmluZyBCaWxseTEjMCEGCSqGSIb3
+DQEJARYUb2xseS5zbWl0aEBnbWFpbC5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0A
+MIGJAoGBAKsUa8bzUeTfC05JFwjBXnD+nBlil5aVTDOB719WJkiq1eDY5WWBaMhk
+OqlZkNhl1rg7LmG/0NhBBUdICYTblNRXzhEfaejqOIGQ3FZMR3W/b87cBp4S+8b/
+q9xJPSUgFvQUzX4v+2+//wdiO8qPioinDdRG9RhxwNvS34bqJqpfAgMBAAEwDQYJ
+KoZIhvcNAQEFBQADgYEADnHq4MP+LgTdp4+ycyearUZh4uhAPzxYXTGDirkkFFQ4
+YA2QT0zXgPq1JmrZwV5Wo1wKoIq8LtfeYoDou0VDKtZ6Up13c98R+1yuQE2kgNoG
+9VGn/2la4mvLpj+9Zt8wfNxibFi+ajZ7/zsebI7UM+pW0a3SDowDeU0nVPAmDRM=
+-----END CERTIFICATE-----

data/spec/fixtures/test-server.key

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXgIBAAKBgQCrFGvG81Hk3wtOSRcIwV5w/pwZYpeWlUwzge9fViZIqtXg2OVl
+gWjIZDqpWZDYZda4Oy5hv9DYQQVHSAmE25TUV84RH2no6jiBkNxWTEd1v2/O3Aae
+EvvG/6vcST0lIBb0FM1+L/tvv/8HYjvKj4qIpw3URvUYccDb0t+G6iaqXwIDAQAB
+AoGBAJccJ4KIYzqUZGkWmBjsq92Elx64/gpM/wyz5VpBPvmKo/XBvwWkg4gVN9dj
+vFPXyAvcgkBm7DJHZEEs+PN3/IEMyLHWVA+C+C3AHisR/E2yl/AyD9oX8F0KDu+Q
+8bnsL1rFL5zP1saw+QiyofQ13HKtCOj8zjhAUCyZl1NBdiqxAkEA2PNxBHFBSnPU
+L6+PiCvDOJcbqrHQa5kYcS312SNqX/VQ9BtIJfIQ7QA/ueKIUd40OfNBc/jiOC1x
+mlSwlsLnFwJBAMnfWagBvlinIwXw4yhAgsqt012gOzPIHCM7FWipJPbCm9LtJykE
+dGuA06TRE2ZKQq+Oh2yomNni4/LfPVQ6Y/kCQHkej/4W7IiQWem1bcBsDjVNx1ho
+pR8s/YRSUGrFZuHjpyphAMqOdfyaovk4CzsJfsbLk8MXM9SBKmcq2NuSPEkCQQCM
+MvTmTIewtCsLtjdcvijXsA9KR7y2ArUf9qmwrUABrDhiLdfzkad0/dx+68FIWiyk
+Fh2RZin5sKzVARtrwr2pAkEAgIDCCl3YC7Jk5GOm1xVjb999hZSyasOasiVsAafa
+4UzoA4HlDjTWEROObX8ijbsWRU16/yotbWXDa9XXxnDV3A==
+-----END RSA PRIVATE KEY-----

data/spec/lib/billy/proxy_request_stub_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe Billy::ProxyRequestStub do
+  context '#matches?' do
+    it 'should match urls and methods' do
+      Billy::ProxyRequestStub.new('http://example.com').
+        matches?('GET', 'http://example.com').should be
+      Billy::ProxyRequestStub.new('http://example.com').
+        matches?('POST', 'http://example.com').should_not be
+      Billy::ProxyRequestStub.new('http://example.com', :method => :get).
+        matches?('GET', 'http://example.com').should be
+      Billy::ProxyRequestStub.new('http://example.com', :method => :post).
+        matches?('GET', 'http://example.com').should_not be
+      Billy::ProxyRequestStub.new('http://example.com', :method => :post).
+        matches?('POST', 'http://example.com').should be
+      Billy::ProxyRequestStub.new('http://fooxample.com', :method => :post).
+        matches?('POST', 'http://example.com').should_not be
+    end
+
+    it 'should match regexps' do
+      Billy::ProxyRequestStub.new(/http:\/\/.+\.com/, :method => :post).
+        matches?('POST', 'http://example.com').should be
+      Billy::ProxyRequestStub.new(/http:\/\/.+\.co\.uk/, :method => :get).
+        matches?('GET', 'http://example.com').should_not be
+    end
+
+    it 'should match up to but not including query strings' do
+      stub = Billy::ProxyRequestStub.new('http://example.com/foo/bar/')
+      stub.matches?('GET', 'http://example.com/foo/').should_not be
+      stub.matches?('GET', 'http://example.com/foo/bar/').should be
+      stub.matches?('GET', 'http://example.com/foo/bar/?baz=bap').should be
+    end
+  end
+
+  context '#and_return + #call' do
+    let(:subject) { Billy::ProxyRequestStub.new('url') }
+
+    it 'should generate bare responses' do
+      subject.and_return :body => 'baz foo bar'
+      subject.call({}, {}, nil).should == [
+        200,
+        {},
+        'baz foo bar'
+      ]
+    end
+
+    it 'should generate text responses' do
+      subject.and_return :text => 'foo bar baz'
+      subject.call({}, {}, nil).should == [
+        200,
+        {'Content-Type' => 'text/plain'},
+        'foo bar baz'
+      ]
+    end
+
+    it 'should generate JSON responses' do
+      subject.and_return :json => { :foo => 'bar' }
+      subject.call({}, {}, nil).should == [
+        200,
+        {'Content-Type' => 'application/json'},
+        '{"foo":"bar"}'
+      ]
+    end
+
+    context 'JSONP' do
+      it 'should generate JSONP responses' do
+        subject.and_return :jsonp => { :foo => 'bar' }
+        subject.call({ 'callback' => ['baz'] }, {}, nil).should == [
+          200,
+          {'Content-Type' => 'application/javascript'},
+          'baz({"foo":"bar"})'
+        ]
+      end
+
+      it 'should generate JSONP responses with custom callback parameter' do
+        subject.and_return :jsonp => { :foo => 'bar' }, :callback_param => 'cb'
+        subject.call({ 'cb' => ['bap'] }, {}, nil).should == [
+          200,
+          {'Content-Type' => 'application/javascript'},
+          'bap({"foo":"bar"})'
+        ]
+      end
+
+      it 'should generate JSONP responses with custom callback name' do
+        subject.and_return :jsonp => { :foo => 'bar' }, :callback => 'cb'
+        subject.call({}, {}, nil).should == [
+          200,
+          {'Content-Type' => 'application/javascript'},
+          'cb({"foo":"bar"})'
+        ]
+      end
+    end
+
+    it 'should generate redirection responses' do
+      subject.and_return :redirect_to => 'http://example.com'
+      subject.call({}, {}, nil).should == [
+        302,
+        {'Location' => 'http://example.com'},
+        nil
+      ]
+    end
+
+    it 'should set headers' do
+      subject.and_return :text => 'foo', :headers => {'HTTP-X-Foo' => 'bar'}
+      subject.call({}, {}, nil).should == [
+        200,
+        {'Content-Type' => 'text/plain', 'HTTP-X-Foo' => 'bar'},
+        'foo'
+      ]
+    end
+
+    it 'should set status codes' do
+      subject.and_return :text => 'baz', :code => 410
+      subject.call({}, {}, nil).should == [
+        410,
+        {'Content-Type' => 'text/plain'},
+        'baz'
+      ]
+    end
+
+    it 'should use a callable' do
+      expected_params = { 'param1' => ['one'], 'param2' => ['two'] }
+      expected_headers = { 'header1' => 'three', 'header2' => 'four' }
+      expected_body = 'body text'
+
+      subject.and_return(Proc.new { |params, headers, body|
+        params.should == expected_params
+        headers.should == expected_headers
+        body.should == 'body text'
+        {:code => 418, :text => 'success'}
+      })
+      subject.call(expected_params, expected_headers, expected_body).should == [
+        418,
+        {'Content-Type' => 'text/plain'},
+        'success'
+      ]
+    end
+  end
+end

data/spec/requests/examples/facebook_api_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'base64'
+
+describe 'Facebook API example', :type => :request, :js => true do
+  before do
+    proxy.stub('https://www.facebook.com:443/dialog/oauth').and_return(Proc.new { |params,_,_|
+      # mock a signed request from facebook.  the JS api never verifies the
+      # signature, so all it needs is the base64-encoded payload
+      signed_request = "xxxxxxxxxx.#{Base64.encode64('{"user_id":"1234567"}')}"
+      # redirect to the 'redirect_uri', with some extra crap in the query
+      # string
+      {:redirect_to => "#{params['redirect_uri'][0]}&access_token=foobar&expires_in=600&base_domain=localhost&https=1&signed_request=#{signed_request}"}
+    })
+
+    proxy.stub('https://graph.facebook.com:443/me').and_return(:jsonp => {:name => 'Tester 1'})
+  end
+
+  it 'should show me as logged-in', :js => true do
+    visit '/facebook_api.html'
+    page.should have_content "Hi, Tester 1"
+  end
+end
+

data/spec/requests/proxy_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'billy'
+
+shared_examples_for 'a proxy server' do
+  it 'should proxy GET requests' do
+    http.get('/echo').body.should == 'GET /echo'
+  end
+
+  it 'should proxy POST requests' do
+    http.post('/echo', :foo => 'bar').body.should == "POST /echo\nfoo=bar"
+  end
+
+  it 'should proxy PUT requests' do
+    http.post('/echo', :foo => 'bar').body.should == "POST /echo\nfoo=bar"
+  end
+
+  it 'should proxy HEAD requests' do
+    http.head('/echo').headers['http_x_echoserver'].should == 'HEAD /echo'
+  end
+
+  it 'should proxy DELETE requests' do
+    http.delete('/echo').body.should == 'DELETE /echo'
+  end
+end
+
+shared_examples_for 'a request stub' do
+  it 'should stub GET requests' do
+    proxy.stub("#{url}/foo").
+      and_return(:text => 'hello, GET!')
+    http.get('/foo').body.should == 'hello, GET!'
+  end
+
+  it 'should stub POST requests' do
+    proxy.stub("#{url}/bar", :method => :post).
+      and_return(:text => 'hello, POST!')
+    http.post('/bar', :foo => :bar).body.should == 'hello, POST!'
+  end
+
+  it 'should stub PUT requests' do
+    proxy.stub("#{url}/baz", :method => :put).
+      and_return(:text => 'hello, PUT!')
+    http.put('/baz', :foo => :bar).body.should == 'hello, PUT!'
+  end
+
+  it 'should stub HEAD requests' do
+    proxy.stub("#{url}/bap", :method => :head).
+      and_return(:headers => {'HTTP-X-Hello' => 'hello, HEAD!'})
+    http.head('/bap').headers['http_x_hello'] == 'hello, HEAD!'
+  end
+
+  it 'should stub DELETE requests' do
+    proxy.stub("#{url}/bam", :method => :delete).
+      and_return(:text => 'hello, DELETE!')
+    http.delete('/bam').body.should == 'hello, DELETE!'
+  end
+end
+
+describe Billy::Proxy do
+
+  before do
+    @http = Faraday.new @http_url,
+      :proxy => { :uri => proxy.url },
+      :keepalive => false,
+      :timeout => 0.5
+    @https = Faraday.new @https_url,
+      :ssl => { :verify => false },
+      :proxy => { :uri => proxy.url },
+      :keepalive => false,
+      :timeout => 0.5
+  end
+
+  context 'proxying' do
+
+    context 'HTTP' do
+      let!(:http) { @http }
+      it_should_behave_like 'a proxy server'
+    end
+
+    context 'HTTPS' do
+      let!(:http) { @https }
+      it_should_behave_like 'a proxy server'
+    end
+
+  end
+
+  context 'stubbing' do
+
+    context 'HTTP' do
+      let!(:url) { @http_url }
+      let!(:http) { @http }
+      it_should_behave_like 'a request stub'
+    end
+
+    context 'HTTPS' do
+      let!(:url) { @https_url }
+      let!(:http) { @https }
+      it_should_behave_like 'a request stub'
+    end
+
+  end
+
+end