puffing-billy 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3655cba82676b1deab3539e52a0905e2235fd121
-  data.tar.gz: 1b4fac47e1c38eed0c59038924ae10218bc753d0
+  metadata.gz: ab6b245ca1fa1295379ac58fcc023b9ae2d4be4b
+  data.tar.gz: d2ed68617bba9beca40b228fbfb116bed58f8641
 SHA512:
-  metadata.gz: 161f4b1ac60dd9f946a60f78b2abe69f16c7fdf7cfe3a4e3e8599c495de9c32b2825c5b0f7beb3df644a2bde58694b77c6b1058d83eb9db49d067d547e5590e8
-  data.tar.gz: 683a32965991b618db46c6943ccd535b9f92a11df8fc5da8dce371b1e4f8b58df4d581c54919047c347adf85f5c61ec4a48becd40597234fcd774d1c3199d814
+  metadata.gz: 7d4919dba7d0619860e035edf00580479228b3de38da97185b21356ba077f39c42add963de90f1521f30933e08f20c0e3494de359c892bb3b1e5fa1029bca704
+  data.tar.gz: dc18d1801cf9bb821a7fefa6f093cfdfe748f8ea500058f2d60f59e422c78c5135114bacf7f110acf9001c8ea0495e0899311e364d2cea7f84bf6110814db7b6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+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)
+  * Remove rspec-expectations deprecation warning for README example [#153](https://github.com/oesmith/puffing-billy/pull/153)
+  * Make stub requests accessible [#154](https://github.com/oesmith/puffing-billy/pull/154)
+
 v0.7.0, 2016-05-05
 ------------------
   * Change WebKit driver to ignore SSL errors [#140](https://github.com/oesmith/puffing-billy/pull/140)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puffing-billy (0.7.0)
+    puffing-billy (0.8.0)
       addressable
       em-http-request (~> 1.1.0)
       em-synchrony

data/README.md

@@ -23,7 +23,7 @@ you can test it!
 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!")
+  expect(page).to have_content("I'm not Google!")
 end
 ```
 
@@ -145,7 +145,7 @@ end
 And /^a stub for 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!")
+  expect(page).to have_content("I'm not Google!")
 end
 ```
 
@@ -284,6 +284,25 @@ 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'].
 
+`c.after_cache_handles_request` is used to configure a callback that can operate on the response after it has been retrieved from the cache but before it is returned. The callback receives the request and response as arguments, with a request object like: `{ method: method, url: url, headers: headers, body: body }`. An example usage would be manipulating the Access-Control-Allow-Origin header so that your test server doesn't always have to run on the same port in order to accept cached responses to CORS requests:
+
+```
+Billy.configure do |c|
+  ...
+  fix_cors_header = proc do |_request, response|
+    allowed_origins = response[:headers]['Access-Control-Allow-Origin']
+    if allowed_origins.present?
+      localhost_port_pattern = %r{(?<=http://127\.0\.0\.1:)(\d+)}
+      allowed_origins.sub!(
+        localhost_port_pattern, Capybara.current_session.server.port.to_s
+      )
+    end
+  end
+  c.after_cache_handles_request = fix_cors_header
+  ...
+end
+```
+
 ### Cache Scopes
 
 If you need to cache different responses to the same HTTP request, you can use
@@ -346,6 +365,27 @@ RSpec.configure do |config|
 end
 ```
 
+## Stub requests recording
+
+If you want to record requests to stubbed URIs, set the following configuration option:
+
+```ruby
+Billy.configure do |c|
+  c.record_stub_requests = true
+end
+```
+
+Example usage:
+
+```ruby
+it 'should intercept a GET request' do
+  stub = proxy.stub('http://example.com/')
+  visit 'http://example.com/'
+  expect(stub.has_requests?).to be true
+  expect(stub.requests).not_to be_empty
+end
+```
+
 ## Proxy timeouts
 
 By default, the Puffing Billy proxy will use the EventMachine:HttpRequest timeouts of 5 seconds

data/examples/intercept_request.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<body>
+  <h1>Intercept request example</h1>
+  <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/', { foo: 'bar' });
+  })
+  </script>
+</body>

data/lib/billy/config.rb

@@ -10,7 +10,8 @@ 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, :cache_request_body_methods
+                  :strip_query_params, :proxied_request_host, :proxied_request_port, :cache_request_body_methods, :after_cache_handles_request,
+                  :record_stub_requests
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -40,6 +41,8 @@ module Billy
       @proxied_request_host = nil
       @proxied_request_port = 80
       @cache_request_body_methods = ['post']
+      @after_cache_handles_request = nil
+      @record_stub_requests = false
     end
   end
 

data/lib/billy/handlers/cache_handler.rb

@@ -25,6 +25,11 @@ module Billy
             replace_response_callback(response, url)
           end
 
+          if Billy.config.after_cache_handles_request
+            request = { method: method, url: url, headers: headers, body: body }
+            Billy.config.after_cache_handles_request.call(request, response)
+          end
+
           return response
         end
       end

data/lib/billy/handlers/stub_handler.rb

@@ -10,7 +10,7 @@ module Billy
         if (stub = find_stub(method, url))
           query_string = Addressable::URI.parse(url).query || ''
           params = CGI.parse(query_string)
-          stub.call(params, headers, body).tap do |response|
+          stub.call(method, url, params, headers, body).tap do |response|
             Billy.log(:info, "puffing-billy: STUB #{method} for '#{url}'")
             return { status: response[0], headers: response[1], content: response[2] }
           end

data/lib/billy/proxy_request_stub.rb

@@ -2,10 +2,13 @@ require 'multi_json'
 
 module Billy
   class ProxyRequestStub
+    attr_reader :requests
+
     def initialize(url, options = {})
       @options = { method: :get }.merge(options)
       @method = @options[:method].to_s.upcase
       @url = url
+      @requests = []
       @response = { code: 204, headers: {}, text: '' }
     end
 
@@ -14,7 +17,9 @@ module Billy
       self
     end
 
-    def call(params, headers, body)
+    def call(method, url, params, headers, body)
+      push_request(method, url, params, headers, body)
+
       if @response.respond_to?(:call)
         res = @response.call(params, headers, body)
       else
@@ -52,6 +57,10 @@ module Billy
       [code, headers, body]
     end
 
+    def has_requests?
+      @requests.any?
+    end
+
     def matches?(method, url)
       if method == @method
         if @url.is_a?(Regexp)
@@ -61,5 +70,21 @@ module Billy
         end
       end
     end
+
+    private
+
+    attr_writer :requests
+
+    def push_request(method, url, params, headers, body)
+      if Billy.config.record_stub_requests
+        @requests.push({
+          method: method,
+          url: url,
+          params: params,
+          headers: headers,
+          body: body
+        })
+      end
+    end
   end
 end

data/lib/billy/version.rb

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

data/spec/features/examples/intercept_request_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'timeout'
+
+describe 'intercept request example', type: :feature, js: true do
+  before do
+    Billy.config.record_stub_requests = true
+  end
+
+  it 'should intercept a GET request directly' do
+    stub = proxy.stub('http://example.com/').and_return(
+      headers: { 'Access-Control-Allow-Origin' => '*' },
+      code: 200
+    )
+    visit 'http://example.com/'
+    expect(stub.has_requests?).to be true
+    expect(stub.requests).not_to be_empty
+  end
+
+  it 'should intercept a POST request through an intermediary page' do
+    stub = proxy.stub('http://example.com/', method: 'post').and_return(
+      headers: { 'Access-Control-Allow-Origin' => '*' },
+      code: 200
+    )
+    visit '/intercept_request.html'
+    Timeout::timeout(5) do
+      sleep(0.1) until stub.has_requests?
+    end
+    request = stub.requests.shift
+    expect(request[:body]).to eql 'foo=bar'
+  end
+end

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

@@ -97,6 +97,23 @@ describe Billy::CacheHandler do
                                       other_request[:headers],
                                       other_request[:body])).to eql(status: 200, headers: { 'Connection' => 'close' }, content: 'no jsonp but has parentheses()')
       end
+
+      context 'when after_cache_handles_request is set' do
+        it "should call the callback with the request and response" do
+          allow(Billy.config).to receive(:after_cache_handles_request) do
+            proc do |request, response|
+              response[:headers]['Access-Control-Allow-Origin'] = "*"
+              response[:content] = request[:body]
+            end
+          end
+          expect(Billy::Cache.instance).to receive(:cached?).and_return(true)
+          expect(Billy::Cache.instance).to receive(:fetch).and_return(status: 200, headers: { 'Connection' => 'close' }, content: 'The response body')
+          expect(handler.handle_request(request[:method],
+                                        request[:url],
+                                        request[:headers],
+                                        request[:body])).to eql(status: 200, headers: { 'Connection' => 'close', 'Access-Control-Allow-Origin' => "*" }, content: 'Some body')
+        end
+      end
     end
 
     context 'updating jsonp callback names disabled' do

data/spec/lib/billy/proxy_request_stub_spec.rb

@@ -62,7 +62,7 @@ describe Billy::ProxyRequestStub do
     let(:subject) { Billy::ProxyRequestStub.new('url') }
 
     it 'returns a 204 empty response' do
-      expect(subject.call({}, {}, nil)).to eql [204, { 'Content-Type' => 'text/plain' }, '']
+      expect(subject.call('', '', {}, {}, nil)).to eql [204, { 'Content-Type' => 'text/plain' }, '']
     end
   end
 
@@ -71,7 +71,7 @@ describe Billy::ProxyRequestStub do
 
     it 'should generate bare responses' do
       subject.and_return body: 'baz foo bar'
-      expect(subject.call({}, {}, nil)).to eql [
+      expect(subject.call('', '', {}, {}, nil)).to eql [
         200,
         {},
         'baz foo bar'
@@ -80,7 +80,7 @@ describe Billy::ProxyRequestStub do
 
     it 'should generate text responses' do
       subject.and_return text: 'foo bar baz'
-      expect(subject.call({}, {}, nil)).to eql [
+      expect(subject.call('', '', {}, {}, nil)).to eql [
         200,
         { 'Content-Type' => 'text/plain' },
         'foo bar baz'
@@ -89,7 +89,7 @@ describe Billy::ProxyRequestStub do
 
     it 'should generate JSON responses' do
       subject.and_return json: { foo: 'bar' }
-      expect(subject.call({}, {}, nil)).to eql [
+      expect(subject.call('', '', {}, {}, nil)).to eql [
         200,
         { 'Content-Type' => 'application/json' },
         '{"foo":"bar"}'
@@ -99,7 +99,7 @@ describe Billy::ProxyRequestStub do
     context 'JSONP' do
       it 'should generate JSONP responses' do
         subject.and_return jsonp: { foo: 'bar' }
-        expect(subject.call({ 'callback' => ['baz'] }, {}, nil)).to eql [
+        expect(subject.call('', '', { 'callback' => ['baz'] }, {}, nil)).to eql [
           200,
           { 'Content-Type' => 'application/javascript' },
           'baz({"foo":"bar"})'
@@ -108,7 +108,7 @@ describe Billy::ProxyRequestStub do
 
       it 'should generate JSONP responses with custom callback parameter' do
         subject.and_return jsonp: { foo: 'bar' }, callback_param: 'cb'
-        expect(subject.call({ 'cb' => ['bap'] }, {}, nil)).to eql [
+        expect(subject.call('', '', { 'cb' => ['bap'] }, {}, nil)).to eql [
           200,
           { 'Content-Type' => 'application/javascript' },
           'bap({"foo":"bar"})'
@@ -117,7 +117,7 @@ describe Billy::ProxyRequestStub do
 
       it 'should generate JSONP responses with custom callback name' do
         subject.and_return jsonp: { foo: 'bar' }, callback: 'cb'
-        expect(subject.call({}, {}, nil)).to eql [
+        expect(subject.call('', '', {}, {}, nil)).to eql [
           200,
           { 'Content-Type' => 'application/javascript' },
           'cb({"foo":"bar"})'
@@ -127,7 +127,7 @@ describe Billy::ProxyRequestStub do
 
     it 'should generate redirection responses' do
       subject.and_return redirect_to: 'http://example.com'
-      expect(subject.call({}, {}, nil)).to eql [
+      expect(subject.call('', '', {}, {}, nil)).to eql [
         302,
         { 'Location' => 'http://example.com' },
         nil
@@ -136,7 +136,7 @@ describe Billy::ProxyRequestStub do
 
     it 'should set headers' do
       subject.and_return text: 'foo', headers: { 'HTTP-X-Foo' => 'bar' }
-      expect(subject.call({}, {}, nil)).to eql [
+      expect(subject.call('', '', {}, {}, nil)).to eql [
         200,
         { 'Content-Type' => 'text/plain', 'HTTP-X-Foo' => 'bar' },
         'foo'
@@ -145,7 +145,7 @@ describe Billy::ProxyRequestStub do
 
     it 'should set status codes' do
       subject.and_return text: 'baz', code: 410
-      expect(subject.call({}, {}, nil)).to eql [
+      expect(subject.call('', '', {}, {}, nil)).to eql [
         410,
         { 'Content-Type' => 'text/plain' },
         'baz'
@@ -163,11 +163,52 @@ describe Billy::ProxyRequestStub do
         expect(body).to eql 'body text'
         { code: 418, text: 'success' }
       end)
-      expect(subject.call(expected_params, expected_headers, expected_body)).to eql [
+      expect(subject.call('', '', expected_params, expected_headers, expected_body)).to eql [
         418,
         { 'Content-Type' => 'text/plain' },
         'success'
       ]
     end
   end
+
+  context '#stub_requests' do
+    let(:subject) { Billy::ProxyRequestStub.new('url') }
+
+    before :each do
+      Billy.config.record_stub_requests = true
+    end
+
+    it 'should record requests' do
+      subject.call('', '', {}, {}, nil)
+      expect(subject.has_requests?).to be true
+    end
+
+    it 'should record multiple requests' do
+      expected_amount = 3
+      expected_amount.times do
+        subject.call('', '', {}, {}, nil)
+      end
+
+      expect(subject.requests.length).to eql expected_amount
+    end
+
+    it 'should set a request' do
+      expected_request = {
+        method: 'POST',
+        url: 'test-url',
+        params: { 'param1' => ['one'], 'param2' => ['two'] },
+        headers: { 'header1' => 'three', 'header2' => 'four' },
+        body: 'body text'
+      }
+
+      subject.call(
+        expected_request[:method],
+        expected_request[:url],
+        expected_request[:params],
+        expected_request[:headers],
+        expected_request[:body]
+      )
+      expect(subject.requests[0]).to eql expected_request
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Olly Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -298,6 +298,7 @@ files:
 - bin/proxy.rb
 - examples/README.md
 - examples/facebook_api.html
+- examples/intercept_request.html
 - examples/post_api.html
 - examples/preflight_request.html
 - examples/tumblr_api.html
@@ -325,6 +326,7 @@ files:
 - log/.gitkeep
 - puffing-billy.gemspec
 - spec/features/examples/facebook_api_spec.rb
+- spec/features/examples/intercept_request_spec.rb
 - spec/features/examples/post_api_spec.rb
 - spec/features/examples/preflight_request_spec.rb
 - spec/features/examples/tumblr_api_spec.rb
@@ -366,6 +368,7 @@ specification_version: 4
 summary: Easy request stubs for browser tests.
 test_files:
 - spec/features/examples/facebook_api_spec.rb
+- spec/features/examples/intercept_request_spec.rb
 - spec/features/examples/post_api_spec.rb
 - spec/features/examples/preflight_request_spec.rb
 - spec/features/examples/tumblr_api_spec.rb