puffing-billy 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+log/test.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puffing-billy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    puffing-billy (0.0.1)
+      em-http-request
+      eventmachine
+      eventmachine_httpserver
+      http_parser.rb
+      yajl-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    capybara-webkit (0.12.1)
+      capybara (>= 1.0.0, < 1.2)
+      json
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
+    cookiejar (0.3.0)
+    daemons (1.1.9)
+    diff-lcs (1.1.3)
+    em-http-request (1.0.3)
+      addressable (>= 2.2.3)
+      cookiejar
+      em-socksify
+      eventmachine (>= 1.0.0.beta.4)
+      http_parser.rb (>= 0.5.3)
+    em-socksify (0.2.1)
+      eventmachine (>= 1.0.0.beta.4)
+    eventmachine (1.0.0)
+    eventmachine_httpserver (0.2.1)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faye-websocket (0.4.6)
+      eventmachine (>= 0.12.0)
+    ffi (1.1.5)
+    http_parser.rb (0.5.3)
+    json (1.7.5)
+    libwebsocket (0.1.5)
+      addressable
+    mime-types (1.19)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    nokogiri (1.5.5)
+    poltergeist (0.7.0)
+      capybara (~> 1.1)
+      childprocess (~> 0.3)
+      faye-websocket (~> 0.4, >= 0.4.4)
+      http_parser.rb (~> 0.5.3)
+      multi_json (~> 1.0)
+    rack (1.4.1)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    thin (1.4.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  capybara-webkit
+  faraday
+  poltergeist
+  puffing-billy!
+  rack
+  rspec
+  selenium-webdriver
+  thin

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Olly Smith
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Puffing Billy
+
+A stubbing proxy server for ruby. Connect it to your browser in integration tests to fake
+interactions with remote HTTP(S) servers.
+
+![](http://upload.wikimedia.org/wikipedia/commons/0/01/Puffing_Billy_1862.jpg)
+
+## Overview
+
+The thirty second version:
+
+```ruby
+it 'should stub google' do
+  proxy.stub('http://www.google.com').and_return(:text => "I'm not Google!")
+  visit 'http://www.google.com'
+  page.should have_content("I'm not Google!")
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'puffing-billy', :require => 'billy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puffing-billy
+
+## Usage
+
+In your `spec_helper.rb`:
+
+```ruby
+require 'billy/rspec'
+
+# select a driver for your chosen browser environment
+Capybara.javascript_driver = :selenium_billy
+# Capybara.javascript_driver = :webkit_billy
+# Capybara.javascript_driver = :poltergeist_billy
+```
+
+In your tests:
+
+```ruby
+# stub and return text, json, jsonp (or anything else)
+proxy.stub('http://example.com/text').and_return(:text => 'Foobar')
+proxy.stub('http://example.com/json').and_return(:json => { :foo => 'bar' })
+proxy.stub('http://example.com/jsonp').and_return(:jsonp => { :foo => 'bar' })
+proxy.stub('http://example.com/wtf').and_return(:body => 'WTF!?', :content_type => 'text/wtf')
+
+# stub redirections and other return codes
+proxy.stub('http://example.com/redirect').and_return(:redirect_to => 'http://example.com/other')
+proxy.stub('http://example.com/missing').and_return(:code => 404, :body => 'Not found')
+
+# even stub HTTPS!
+proxy.stub('https://example.com/secure').and_return(:text => 'secrets!!1!')
+```
+
+Stubs are reset between tests.  Any requests that are not stubbed will be
+proxied to the remote server.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+1. Integration for test frameworks other than rspec.
+2. Caching (for super awesome improved test performance).

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/README.md

@@ -0,0 +1 @@
+See example specs in `spec/requests/examples`.

data/examples/facebook_api.html

@@ -0,0 +1,59 @@
+<div id="fb-root"></div>
+<script>
+  // Load the SDK Asynchronously
+  (function(d){
+     var js, id = 'facebook-jssdk', ref = d.getElementsByTagName('script')[0];
+     if (d.getElementById(id)) {return;}
+     js = d.createElement('script'); js.id = id; js.async = true;
+     js.src = "//connect.facebook.net/en_US/all.js";
+     ref.parentNode.insertBefore(js, ref);
+   }(document));
+
+  // Init the SDK upon load
+  window.fbAsyncInit = function() {
+    FB.init({
+      appId      : '408416075843608', // App ID
+      //channelUrl : '//'+window.location.hostname+'/channel', // Path to your Channel File
+      status     : true, // check login status
+      cookie     : true, // enable cookies to allow the server to access the session
+      xfbml      : true  // parse XFBML
+    });
+
+    // listen for and handle auth.statusChange events
+    FB.Event.subscribe('auth.statusChange', function(response) {
+      if (response.authResponse) {
+        // user has auth'd your app and is logged into Facebook
+        FB.api('/me', function(me){
+          if (me.name) {
+            document.getElementById('auth-displayname').innerHTML = me.name;
+          }
+        })
+        document.getElementById('auth-loggedout').style.display = 'none';
+        document.getElementById('auth-loggedin').style.display = 'block';
+      } else {
+        // user has not auth'd your app, or is not logged into Facebook
+        document.getElementById('auth-loggedout').style.display = 'block';
+        document.getElementById('auth-loggedin').style.display = 'none';
+      }
+    });
+
+    // respond to clicks on the login and logout links
+    document.getElementById('auth-loginlink').addEventListener('click', function(){
+      FB.login();
+    });
+    document.getElementById('auth-logoutlink').addEventListener('click', function(){
+      FB.logout();
+    });
+  }
+</script>
+
+<h1>Facebook Client-side Authentication Example</h1>
+  <div id="auth-status">
+    <div id="auth-loggedout">
+      <a href="#" id="auth-loginlink">Login</a>
+    </div>
+    <div id="auth-loggedin" style="display:none">
+      Hi, <span id="auth-displayname"></span>
+    (<a href="#" id="auth-logoutlink">logout</a>)
+  </div>
+</div>

data/lib/billy.rb

@@ -0,0 +1,5 @@
+require "billy/version"
+require "billy/config"
+require "billy/proxy_request_stub"
+require "billy/proxy"
+require "billy/proxy_connection"

data/lib/billy/config.rb

@@ -0,0 +1,28 @@
+require 'logger'
+
+module Billy
+  class Config
+    attr_accessor :logger
+
+    def initialize
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+  end
+
+  def self.configure
+    yield config if block_given?
+    config
+  end
+
+  def self.log(*args)
+    unless config.logger.nil?
+      config.logger.send(*args)
+    end
+  end
+
+  private
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/billy/mitm.crt

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDojCCAooCCQCYeVsjl+UFxzANBgkqhkiG9w0BAQUFADCBkjELMAkGA1UEBhMC
+VVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MSEwHwYDVQQK
+ExhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxFjAUBgNVBAMTDVB1ZmZpbmcgQmls
+bHkxIzAhBgkqhkiG9w0BCQEWFG9sbHkuc21pdGhAZ21haWwuY29tMB4XDTEyMTAw
+MjA2NDIxMVoXDTEzMTAwMjA2NDIxMVowgZIxCzAJBgNVBAYTAlVTMQswCQYDVQQI
+EwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEhMB8GA1UEChMYSW50ZXJuZXQg
+V2lkZ2l0cyBQdHkgTHRkMRYwFAYDVQQDEw1QdWZmaW5nIEJpbGx5MSMwIQYJKoZI
+hvcNAQkBFhRvbGx5LnNtaXRoQGdtYWlsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQAD
+ggEPADCCAQoCggEBALW7WQIIGCgUk28x1eIV0+VDG6SZV8dosJPU3WM4zLT0KLsv
+2+5KNO373KyXhIDQqkv+4+1myVYj5wkvDSFMLYvBTNmypS7Xh6+wyKjQQ5wupXoB
+BNrJw5CbfUX9Kwq31H6aO1ItWZ6QHjW4dpE3AOu7ohwwyyL2Q0QkzTeP5b6SofbV
+9y1DpeH5L2an84LIjm1XrNbswY0p0CDT7TTsmYoXnw0MD5I73rT4arOOKWdVrD/G
+lbvfcZN6c+nN713tGI9XfM5cQEXUsbSY4NKuF+jn7B2tsx+QRVwUyMwS8ZVpDt5q
+DMBwROskWTMLKxeuxxpmjFWHlLuBlJ0M/rKII98CAwEAATANBgkqhkiG9w0BAQUF
+AAOCAQEAMkhR7JDQKcYDy5Yb80cPIjw5kaEfTb+/Vh6DLLEtwEVIc2PcIvXCBZRo
+79Esa42BaNEaWPxRVAs0Doubh4IdGk9qp9a/71gqhi3iNe//depX5VLf1+5LnQtV
+BbFruXUkzOF4kykm5Fcf9yQ9W951d0qaT6K9LefSsaoMrQjgKCeFAcIOXjqHyWns
+KAO34C1kzAFemMY20RcgZf9/+09Zs/ZiDBeoWTc+juaa9zCgvg/1FKHqsA/iLg6/
+VcdOquI9fJ5hRTZFkPoFLpxf2O1H3IpyNXmpcJDFvKfh7wIcHkLWIg5BFXc2S4+v
+bNFEKqipZH+D9++jXGyumxA8VoZOOA==
+-----END CERTIFICATE-----

data/lib/billy/mitm.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAtbtZAggYKBSTbzHV4hXT5UMbpJlXx2iwk9TdYzjMtPQouy/b
+7ko07fvcrJeEgNCqS/7j7WbJViPnCS8NIUwti8FM2bKlLteHr7DIqNBDnC6legEE
+2snDkJt9Rf0rCrfUfpo7Ui1ZnpAeNbh2kTcA67uiHDDLIvZDRCTNN4/lvpKh9tX3
+LUOl4fkvZqfzgsiObVes1uzBjSnQINPtNOyZihefDQwPkjvetPhqs44pZ1WsP8aV
+u99xk3pz6c3vXe0Yj1d8zlxARdSxtJjg0q4X6OfsHa2zH5BFXBTIzBLxlWkO3moM
+wHBE6yRZMwsrF67HGmaMVYeUu4GUnQz+sogj3wIDAQABAoIBAEM8cF7vDbjue+m8
+32wJNV9yJ60LSs2tLv9S1yHZpusgFl3DBDSyYcjW0TtNx6k9CnSZdkykJcNn/xeH
+v+zc2VEGkF9O2Axvk3TuDB9hBlKnc3OjIt+rnF5JGN0nIKCTiNvaRi5ONwUSPwsT
+F1L8rauJvR1+8/kYcaSplP+EjrSlvaKtUPNKfB8V6IktVLHiBUFs7nWoOGSaEB4/
+8jlji4s8xzVammTRg175mhOkgqdI+cWfXnn8PhOJZ2XjZz5eFOWxdvNldBbsm9Yc
+g3URB9FpOPMY8DvgZNrAYp6/7C9ACecAIZAnDK0/aQOa95UeeCEbmAv59F2OqOc2
+35HUSrkCgYEA55e+o7pxUY7YPVopBz27JWANk/zwMN1ZgDlR87Q0ENmrjOB8kPmz
+02SHuVoXMPj/SD/S4J1NY2o7u5ofSpxUsdofCETsCeCbqhshRLqCu7yCjGagHknY
+M4dJdRoFPN03gy+qHB7EKT0U89lvwRsjShc8h56wXsRHP6qM2uVgGyUCgYEAyOJh
+ZPKBa0WVG9NxFS4Ej7CDpmWA415PyCrTK9cA2LCA0sWXHAhJ9guUx4zlqwLkfYBr
+mmobAKjllFOUiECFLs49Oy/vD9Kw/ga9KO6eU9E/j9XHLVYupkPEVWeM7jzaQBul
+CvMcPGgXX/84Xgtjjim8RuAPIgmRHSDfqRFUtbMCgYEAmQwxEiZuKMXLpY/luUFU
+Yfi+QGRRnxlIwnIe9HzMQ651rl3UNEKwUi0HfLhKxzRmECsNgx6xO9fCrdHGiBoT
+5o0NIPvbORPUC3BuZesT5llHtN1FR37pf/QR2W9essBGpU1kj7zNSatyI0w4jFcQ
+1S/R8pYuXBI+O5bMCwS2pHkCgYBqFKG53RXav/PtrcqZlKNz/ZKH3DIj3zniSjsZ
+e4BG7W4Z353cf8QO2i7G8fCWTgC7BYXNFRsNTiNuIHTfPrMV9HMBPl7PzEMK4iQh
+6WBSgr0+B3YWytv3kPGs5/HUHO5jzDVrgtX2UEGHwA7UGs+H0yJJiyhyoPqwlxuE
+/FHvYQKBgEJaI/DaSpxJotq56lBHzTte1icbD8IFXMlbmWyIFxONWxlz98tQ2ypp
+WhMGIzMsFE1X+P8vRbc865t36UMpucjRuAJ3MTeeCa60EghmdfajzA2ZWh/MnEyA
+yvTr72g5gj5Yi/Zbiy1xeTo3UeaBxiCi8xyWAGodYg8891UVKqJu
+-----END RSA PRIVATE KEY-----

data/lib/billy/proxy.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+require 'uri'
+require 'eventmachine'
+
+module Billy
+  class Proxy
+    def initialize
+      reset
+    end
+
+    def start
+      Thread.new do
+        EM.run do
+          EM.error_handler do |e|
+            puts e.class.name, e
+            puts e.backtrace.join("\n")
+          end
+
+          @signature = EM.start_server('127.0.0.1', 0, ProxyConnection) do |p|
+            p.handler = self
+          end
+        end
+      end
+      sleep(0.01) while @signature.nil?
+    end
+
+    def url
+      "http://#{host}:#{port}"
+    end
+
+    def host
+      'localhost'
+    end
+
+    def port
+      Socket.unpack_sockaddr_in(EM.get_sockname(@signature)).first
+    end
+
+    def call(method, url, headers, body)
+      stub = find_stub(method, url)
+      unless stub.nil?
+        query_string = URI.parse(url).query || ""
+        params = CGI.parse(query_string)
+        stub.call(params, headers, body)
+      end
+    end
+
+    def stub(url, options = {})
+      ret = ProxyRequestStub.new(url, options)
+      @stubs << ret
+      ret
+    end
+
+    def reset
+      @stubs = []
+    end
+
+    protected
+
+    def find_stub(method, url)
+      @stubs.each do |stub|
+        return stub if stub.matches?(method, url)
+      end
+      nil
+    end
+  end
+end

data/lib/billy/proxy_connection.rb

@@ -0,0 +1,115 @@
+require 'eventmachine'
+require 'http/parser'
+require 'em-http'
+require 'evma_httpserver'
+
+module Billy
+  class ProxyConnection < EventMachine::Connection
+    attr_accessor :handler
+
+    def post_init
+      @parser = Http::Parser.new(self)
+      @header_data = ""
+    end
+
+    def receive_data(data)
+      @header_data << data if @headers.nil?
+      begin
+        @parser << data
+      rescue HTTP::Parser::Error
+        if @parser.http_method == 'CONNECT'
+          # work-around for CONNECT requests until https://github.com/tmm1/http_parser.rb/pull/15 gets merged
+          if @header_data.end_with?("\r\n\r\n")
+            restart_with_ssl(@header_data.split("\r\n").first.split(/\s+/)[1])
+          end
+        else
+          close_connection
+        end
+      end
+    end
+
+    def on_message_begin
+      @headers = nil
+      @body = ''
+    end
+
+    def on_headers_complete(headers)
+      @headers = headers
+    end
+
+    def on_body(chunk)
+      @body << chunk
+    end
+
+    def on_message_complete
+      if @parser.http_method == 'CONNECT'
+        restart_with_ssl(@parser.request_url)
+      else
+        if @ssl
+          @url = "https://#{@ssl}#{@parser.request_url}"
+        else
+          @url = @parser.request_url
+        end
+        handle_request
+      end
+    end
+
+    protected
+
+    def restart_with_ssl(url)
+      @ssl = url
+      @parser = Http::Parser.new(self)
+      send_data("HTTP/1.0 200 Connection established\r\nProxy-agent: Puffing-Billy/0.0.0\r\n\r\n")
+      start_tls(
+        :private_key_file => File.expand_path('../mitm.key', __FILE__),
+        :cert_chain_file => File.expand_path('../mitm.crt', __FILE__)
+      )
+    end
+
+    def handle_request
+      if handler && handler.respond_to?(:call)
+        result = handler.call(@parser.http_method, @url, @headers, @body)
+      end
+      if result
+        Billy.log(:info, "STUB #{@parser.http_method} #{@url}")
+        response = EM::DelegatedHttpResponse.new(self)
+        response.status = result[0]
+        response.headers = result[1].merge('Connection' => 'close')
+        response.content = result[2]
+        response.send_response
+      else
+        Billy.log(:info, "PROXY #{@parser.http_method} #{@url}")
+        proxy_request
+      end
+    end
+
+    def proxy_request
+      headers = Hash[@headers.map { |k,v| [k.downcase, v] }]
+
+      req = EventMachine::HttpRequest.new(@url)
+      req_opts = {
+        :redirects => 0,
+        :keepalive => false,
+        :head => headers,
+        :ssl => { :verify => false }
+      }
+      req_opts[:body] = @body if @body
+
+      req = req.send(@parser.http_method.downcase, req_opts)
+
+      req.errback do
+        puts "Request failed: #{url}"
+        close_connection
+      end
+
+      req.callback do
+        res = EM::DelegatedHttpResponse.new(self)
+        res.status = req.response_header.status
+        res.headers = req.response_header.merge('Connection' => 'close')
+        res.content = req.response
+        res.send_response
+      end
+    end
+
+  end
+end