puffing-billy 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 036f99aa36198814c89f3764027a28b63d46e4d3
-  data.tar.gz: 14820ad20ea2e08038d8c9ed03921be8058831ac
+  metadata.gz: 3655cba82676b1deab3539e52a0905e2235fd121
+  data.tar.gz: 1b4fac47e1c38eed0c59038924ae10218bc753d0
 SHA512:
-  metadata.gz: 5e19c8f782fe8f99743bdb2349123447f7dd8cc6187721facec412650ef12d9d72d9a93155ee2bbcaaf0edfd7084abd61ef4882a6dd2d5e8f721caa96444370b
-  data.tar.gz: d1146aef57cad65dec0692f0492d2a662f923213dc7306128c345a627bbad3da45a79dadc26c2a77b0014a3f87b5caffa08c68cc7c86ad431f746d54946b0533
+  metadata.gz: 161f4b1ac60dd9f946a60f78b2abe69f16c7fdf7cfe3a4e3e8599c495de9c32b2825c5b0f7beb3df644a2bde58694b77c6b1058d83eb9db49d067d547e5590e8
+  data.tar.gz: 683a32965991b618db46c6943ccd535b9f92a11df8fc5da8dce371b1e4f8b58df4d581c54919047c347adf85f5c61ec4a48becd40597234fcd774d1c3199d814

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
+before_install:
+  - gem install bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-script: bundle exec rspec spec
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+v0.7.0, 2016-05-05
+------------------
+  * Change WebKit driver to ignore SSL errors [#140](https://github.com/oesmith/puffing-billy/pull/140)
+  * Add documentation and specs for stubbing out options requests [#141](https://github.com/oesmith/puffing-billy/pull/141)
+  * Support distinguishing non-POST requests in cache based on request body [#148](https://github.com/oesmith/puffing-billy/pull/148)
+  * Allow Puffing Billy to run with custom host [#150](https://github.com/oesmith/puffing-billy/pull/150)
+
 v0.6.2, 2015-11-23
 ------------------
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puffing-billy (0.6.2)
+    puffing-billy (0.7.0)
       addressable
       em-http-request (~> 1.1.0)
       em-synchrony
@@ -13,7 +13,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.4.0)
     builder (3.2.2)
     capybara (2.4.4)
       mime-types (>= 1.16)
@@ -28,7 +28,7 @@ GEM
       ffi (~> 1.0, >= 1.0.11)
     cliver (0.3.2)
     coderay (1.1.0)
-    cookiejar (0.3.2)
+    cookiejar (0.3.0)
     cucumber (2.0.2)
       builder (>= 2.1.2)
       cucumber-core (~> 1.2.0)
@@ -40,15 +40,15 @@ GEM
       gherkin (~> 2.12.0)
     daemons (1.2.3)
     diff-lcs (1.2.5)
-    em-http-request (1.1.2)
+    em-http-request (1.1.3)
       addressable (>= 2.3.4)
-      cookiejar
+      cookiejar (<= 0.3.0)
       em-socksify (>= 0.3)
       eventmachine (>= 1.0.3)
       http_parser.rb (>= 0.6.0)
-    em-socksify (0.3.0)
+    em-socksify (0.3.1)
       eventmachine (>= 1.0.0.beta.4)
-    em-synchrony (1.0.4)
+    em-synchrony (1.0.5)
       eventmachine (>= 1.0.0.beta.1)
     eventmachine (1.0.8)
     eventmachine_httpserver (0.2.1)
@@ -152,4 +152,4 @@ DEPENDENCIES
   thin
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -92,6 +92,22 @@ proxy.stub('https://example.com:443/secure/').and_return(:text => 'secrets!!1!')
 proxy.stub('https://example.com/proc/').and_return(Proc.new { |params, headers, body|
   { :text => "Hello, #{params['name'][0]}"}
 })
+
+# Stub out a POST. Don't forget to allow a CORS request and set the method to 'post'
+proxy.stub('http://example.com/api', :method => 'post').and_return(
+  :headers => { 'Access-Control-Allow-Origin' => '*' },
+  :code => 201
+)
+
+# Stub out an OPTIONS request. Set the headers to the values you require.
+proxy.stub('http://example.com/api', :method => :options).and_return(
+  :headers => {
+    'Access-Control-Allow-Methods' => 'GET, PATCH, POST, PUT, OPTIONS',
+    'Access-Control-Allow-Headers' => 'X-Requested-With, X-Prototype-Version, Content-Type',
+    'Access-Control-Allow-Origin'  => '*'
+  },
+  :code => 200
+)
 ```
 
 Stubs are reset between tests.  Any requests that are not stubbed will be
@@ -198,6 +214,7 @@ Billy.configure do |c|
   c.proxy_port = 12345 # defaults to random
   c.proxied_request_host = nil
   c.proxied_request_port = 80
+  c.cache_request_body_methods = ['post', 'patch', 'put'] # defaults to ['post']
 end
 ```
 
@@ -265,6 +282,8 @@ continuous integration).
 `c.proxied_request_host` and `c.proxied_request_port` are used if an internal proxy
 server is required to access the internet.  Most common in larger companies.
 
+`c.cache_request_body_methods` is used to specify HTTP methods of requests that you would like to cache separately based on the contents of the request body. The default is ['post'].
+
 ### Cache Scopes
 
 If you need to cache different responses to the same HTTP request, you can use
@@ -401,4 +420,3 @@ Note that this approach may cause unexpected behavior if your backend sends the
 
 1. Integration for test frameworks other than rspec.
 2. Show errors from the EventMachine reactor loop in the test output.
-

data/examples/post_api.html

@@ -0,0 +1,16 @@
+<!doctype html>
+<body>
+  <h1>POST to API</h1>
+  <div id="result"></div>
+  <script type='text/javascript' src='http://code.jquery.com/jquery-1.8.2.min.js'></script>
+  <script type='text/javascript'>
+  $(function () {
+    $.post('http://example.com/api', { foo: 'bar' }).done(function(data) {
+      $('#result').append('Success!');
+    })
+    .fail(function(data) {
+      $('#result').append('Fail!');
+    });
+  })
+  </script>
+</body>

data/examples/preflight_request.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<body>
+  <h1>Cross Domain Request</h1>
+  <div id="result"></div>
+  <script type='text/javascript' src='http://code.jquery.com/jquery-1.8.2.min.js'></script>
+  <script type='text/javascript'>
+  $(function () {
+    $.ajax(
+      {
+        url: 'http://example.com/api',
+        method: 'GET',
+        contentType: 'json' // setting this forces an OPTIONS request
+      }
+    ).done(function(data) {
+      $('#result').append('Success!');
+    })
+    .fail(function(data) {
+      $('#result').append('Fail!');
+    });
+  })
+  </script>
+</body>

data/lib/billy.rb

@@ -43,7 +43,7 @@ module Billy
     if defined?(Capybara::Webkit::Driver)
       Capybara.register_driver :webkit_billy do |app|
         options = {
-          ignore_ssl_errors: false,
+          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))

data/lib/billy/cache.rb

@@ -80,7 +80,7 @@ module Billy
             end
       body_msg = ''
 
-      if method == 'post' && !ignore_params && !merge_cached_response_key
+      if Billy.config.cache_request_body_methods.include?(method) && !ignore_params && !merge_cached_response_key
         body_formatted = JSONUtils.json?(body.to_s) ? JSONUtils.sort_json(body.to_s) : body.to_s
         body_msg = " with body '#{body_formatted}'"
         key += '_' + Digest::SHA1.hexdigest(body_formatted)

data/lib/billy/config.rb

@@ -10,7 +10,7 @@ module Billy
                   :persist_cache, :ignore_cache_port, :non_successful_cache_disabled, :non_successful_error_level,
                   :non_whitelisted_requests_disabled, :cache_path, :proxy_host, :proxy_port, :proxied_request_inactivity_timeout,
                   :proxied_request_connect_timeout, :dynamic_jsonp, :dynamic_jsonp_keys, :merge_cached_responses_whitelist,
-                  :strip_query_params, :proxied_request_host, :proxied_request_port
+                  :strip_query_params, :proxied_request_host, :proxied_request_port, :cache_request_body_methods
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -39,6 +39,7 @@ module Billy
       @strip_query_params = true
       @proxied_request_host = nil
       @proxied_request_port = 80
+      @cache_request_body_methods = ['post']
     end
   end
 

data/lib/billy/handlers/request_handler.rb

@@ -21,7 +21,7 @@ module Billy
         end
       end
 
-      body_msg = method == 'post' ? " with body '#{body}'" : ''
+      body_msg = Billy.config.cache_request_body_methods.include?(method) ? " with body '#{body}'" : ''
       { error: "Connection to #{url}#{body_msg} not cached and new http connections are disabled" }
     end
 

data/lib/billy/proxy.rb

@@ -47,7 +47,7 @@ module Billy
           Billy.log :error, e.backtrace.join("\n")
         end
 
-        @signature = EM.start_server('127.0.0.1', Billy.config.proxy_port, ProxyConnection) do |p|
+        @signature = EM.start_server(host, Billy.config.proxy_port, ProxyConnection) do |p|
           p.handler = request_handler
           p.cache = @cache if defined?(@cache)
           p.errback do |msg|

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/lib/tasks/billy.rake

@@ -75,7 +75,7 @@ namespace :cache do
   def print_cache_details(cache)
     puts "   Scope: #{cache[:scope]}" if cache[:scope]
     puts "     URL: #{cache[:url]}"
-    puts "    Body: #{cache[:body]}" if cache[:method] == 'post'
+    puts "    Body: #{cache[:body]}" if Billy.config.cache_request_body_methods.include?(cache[:method])
     puts " Details: Request method '#{cache[:method]}' returned response status code: '#{cache[:status]}'"
     puts "Filename: #{cache[:filename]}"
     puts "\n\n"

data/spec/features/examples/post_api_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'jQuery POST API example', type: :feature, js: true do
+  before do
+    proxy.stub('http://example.com/api', method: 'post').and_return(
+      headers: { 'Access-Control-Allow-Origin' => '*' },
+      code: 201
+    )
+  end
+
+  it 'posts to an API' do
+    visit '/post_api.html'
+    expect(page.find('#result')).to have_content 'Success!'
+  end
+end

data/spec/features/examples/preflight_request_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'jQuery preflight request example', type: :feature, js: true do
+  let(:url) { 'http://example.com/api' }
+
+  before do
+    proxy.stub(url, method: 'get').and_return(
+      headers: { 'Access-Control-Allow-Origin' => '*' },
+      code: 201
+    )
+  end
+
+  it 'stubs out the OPTIONS request' do
+    visit '/preflight_request.html'
+    expect(page.find('#result')).to have_content 'Fail!'
+
+    proxy.stub(url, method: 'options').and_return(
+      headers: {
+        'Access-Control-Allow-Methods' => 'GET, OPTIONS',
+        'Access-Control-Allow-Headers' => 'Content-Type',
+        'Access-Control-Allow-Origin' => '*'
+      },
+      code: 200
+    )
+
+    visit '/preflight_request.html'
+    expect(page.find('#result')).to have_content 'Success!'
+  end
+end

data/spec/lib/billy/cache_spec.rb

@@ -86,5 +86,33 @@ describe Billy::Cache do
         expect(cache.key('post', analytics_url2, 'body')).to eq identical_cache_key
       end
     end
+
+    context 'with cache_request_body_methods set' do
+      before do
+        allow(Billy.config).to receive(:cache_request_body_methods) {
+          ['patch']
+        }
+      end
+
+      context "for requests with methods specified in cache_request_body_methods" do
+        it "should have a different cache key for requests with different bodies" do
+          key1 = cache.key('patch', "http://example.com", "body1")
+          key2 = cache.key('patch', "http://example.com", "body2")
+          expect(key1).not_to eq key2
+        end
+
+        it "should have the same cache key for requests with the same bodies" do
+          key1 = cache.key('patch', "http://example.com", "body1")
+          key2 = cache.key('patch', "http://example.com", "body1")
+          expect(key1).to eq key2
+        end
+      end
+
+      it "should have the same cache key for request with different bodies if their methods are not included in cache_request_body_methods" do
+          key1 = cache.key('put', "http://example.com", "body1")
+          key2 = cache.key('put', "http://example.com", "body2")
+          expect(key1).to eq key2
+      end
+    end
   end
 end

data/spec/lib/billy/handlers/request_handler_spec.rb

@@ -97,8 +97,8 @@ describe Billy::RequestHandler do
         expect(subject.handle_request(*args)).to eql(error: 'Connection to url not cached and new http connections are disabled')
       end
 
-      it 'returns an error hash with body message if POST request is not handled' do
-        args[0] = 'post'
+      it 'returns an error hash with body message if request cached based on body is not handled' do
+        args[0] = Billy.config.cache_request_body_methods[0]
         expect(stub_handler).to receive(:handle_request).with(*args)
         expect(cache_handler).to receive(:handle_request).with(*args)
         expect(proxy_handler).to receive(:handle_request).with(*args)

data/spec/lib/billy/proxy_request_stub_spec.rb

@@ -12,11 +12,22 @@ describe Billy::ProxyRequestStub do
         .matches?('GET', 'http://example.com')).to be
       expect(Billy::ProxyRequestStub.new('http://example.com', method: :post)
         .matches?('GET', 'http://example.com')).to_not be
+      expect(Billy::ProxyRequestStub.new('http://example.com', method: :options)
+        .matches?('GET', 'http://example.com')).to_not be
 
       expect(Billy::ProxyRequestStub.new('http://example.com', method: :post)
         .matches?('POST', 'http://example.com')).to be
       expect(Billy::ProxyRequestStub.new('http://fooxample.com', method: :post)
         .matches?('POST', 'http://example.com')).to_not be
+        expect(Billy::ProxyRequestStub.new('http://fooxample.com', method: :options)
+          .matches?('POST', 'http://example.com')).to_not be
+
+      expect(Billy::ProxyRequestStub.new('http://example.com', method: :options)
+        .matches?('OPTIONS', 'http://example.com')).to be
+      expect(Billy::ProxyRequestStub.new('http://example.com', method: :options)
+        .matches?('OPTIONS', 'http://zzzzzexample.com')).to_not be
+      expect(Billy::ProxyRequestStub.new('http://example.com', method: :post)
+        .matches?('OPTIONS', 'http://example.com')).to_not be
     end
 
     it 'should match regexps' do

data/spec/lib/proxy_spec.rb

@@ -22,6 +22,10 @@ shared_examples_for 'a proxy server' do
   it 'should proxy DELETE requests' do
     expect(http.delete('/echo').body).to eql 'DELETE /echo'
   end
+
+  it 'should proxy OPTIONS requests' do
+    expect(http.run_request(:options, '/echo', nil, nil).body).to eql 'OPTIONS /echo'
+  end
 end
 
 shared_examples_for 'a request stub' do
@@ -60,6 +64,12 @@ shared_examples_for 'a request stub' do
       .and_return(text: 'hello, DELETE!')
     expect(http.delete('/bam').body).to eql 'hello, DELETE!'
   end
+
+  it 'should stub OPTIONS requests' do
+    proxy.stub("#{url}/bim", method: :options)
+      .and_return(text: 'hello, OPTIONS!')
+    expect(http.run_request(:options, '/bim', nil, nil).body).to eql 'hello, OPTIONS!'
+  end
 end
 
 shared_examples_for 'a cache' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Olly Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -298,6 +298,8 @@ files:
 - bin/proxy.rb
 - examples/README.md
 - examples/facebook_api.html
+- examples/post_api.html
+- examples/preflight_request.html
 - examples/tumblr_api.html
 - lib/billy.rb
 - lib/billy/cache.rb
@@ -323,6 +325,8 @@ files:
 - log/.gitkeep
 - puffing-billy.gemspec
 - spec/features/examples/facebook_api_spec.rb
+- spec/features/examples/post_api_spec.rb
+- spec/features/examples/preflight_request_spec.rb
 - spec/features/examples/tumblr_api_spec.rb
 - spec/fixtures/test-server.crt
 - spec/fixtures/test-server.key
@@ -356,12 +360,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Easy request stubs for browser tests.
 test_files:
 - spec/features/examples/facebook_api_spec.rb
+- spec/features/examples/post_api_spec.rb
+- spec/features/examples/preflight_request_spec.rb
 - spec/features/examples/tumblr_api_spec.rb
 - spec/fixtures/test-server.crt
 - spec/fixtures/test-server.key
@@ -376,4 +382,3 @@ test_files:
 - spec/lib/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb
-has_rdoc: