puffing-billy 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11f63ec36c7471c6290b07e64f35879c9b4efd7e
-  data.tar.gz: d309c50f0918f9893ddb9da69beb034bf3b26133
+  metadata.gz: dc029e59d0433abc3e3cafc5a7a8e473fc81d2ba
+  data.tar.gz: 9c9098d75fd2b8a2657a58ebf7264d503391523c
 SHA512:
-  metadata.gz: 24b195fd2c7711efa8f9846b7cf97b2e55ddfab4ae181483645bcecaf78bd5c112e5d886d4ed51ba2de2e6fdfd1876a21eb52360efe323fe953515ce89643612
-  data.tar.gz: c88c7270b7921f76bc72eba910f2e8a6062cf0db17c8506d5389127ac18bb9677878fc6a3a2225bc195bdd5ea60d58f1b0db159e44320a5f6520373561d62e4b
+  metadata.gz: deecb813ec9e291ecf787fcf4c7fc01c514521908ccbae514fe25cc2eef01ce52fb8af233f41eb3d64d070bbade8ba610c437bcbcdfe3ed6d45a6af1c676b871
+  data.tar.gz: c0916575398630111b70ae5f333986d25dcd7a52958fada47986e62347e9a9d44d0ce6e4dab72a5845cf0cbe9755b92269087b0848bc46e50057c940266ce3b5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.10.0, 2017-04-06
+-------------------
+  * Allow to simulate network delays when responding from cache [#182](https://github.com/oesmith/puffing-billy/pull/182)
+  * Allow the dynamic jsonp callback name to be configured [#185](https://github.com/oesmith/puffing-billy/pull/185)
+
 v0.9.2, 2017-01-18
 ------------------
   * Ensure that files are closed after being opened [#175](https://github.com/oesmith/puffing-billy/pull/175)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puffing-billy (0.9.2)
+    puffing-billy (0.10.0)
       addressable (~> 2.4.0)
       em-http-request (~> 1.1.0)
       em-synchrony
@@ -155,4 +155,4 @@ DEPENDENCIES
   watir-webdriver
 
 BUNDLED WITH
-   1.12.4
+   1.14.6

data/README.md

@@ -291,6 +291,9 @@ using `c.dynamic_jsonp`. This is helpful when JSONP APIs use cache-busting
 parameters. For example, if you want `http://example.com/foo?callback=bar&id=1&cache_bust=12345` and `http://example.com/foo?callback=baz&id=1&cache_bust=98765` to be cache hits for each other, you would set `c.dynamic_jsonp_keys = ['callback', 'cache_bust']` to ignore both params. Note
 that in this example the `id` param would still be considered important.
 
+`c.dynamic_jsonp_callback_name` is used to configure the name of the JSONP callback 
+parameter. The default is `callback`.
+
 `c.path_blacklist = []` is used to always cache specific paths on any hostnames,
 including whitelisted ones.  This is useful if your AUT has routes that get data
 from external services, such as `/api` where the ajax request is a local URL but
@@ -346,6 +349,10 @@ Billy.configure do |c|
 end
 ```
 
+`c.cache_simulates_network_delays` is used to add some delay before cache returns response. When set to `true`, cached requests will wait from configured delay time before responding. This allows to catch various race conditions in asynchronous front-end requests. The default is `false`.
+
+`c.cache_simulates_network_delay_time` is used to configure time (in seconds) to wait until responding from cache. The default is `0.1`.
+
 ### Cache Scopes
 
 If you need to cache different responses to the same HTTP request, you can use

data/lib/billy/config.rb

@@ -9,9 +9,9 @@ module Billy
     attr_accessor :logger, :cache, :cache_request_headers, :whitelist, :path_blacklist, :ignore_params,
                   :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,
+                  :proxied_request_connect_timeout, :dynamic_jsonp, :dynamic_jsonp_keys, :dynamic_jsonp_callback_name, :merge_cached_responses_whitelist,
                   :strip_query_params, :proxied_request_host, :proxied_request_port, :cache_request_body_methods, :after_cache_handles_request,
-                  :record_stub_requests
+                  :cache_simulates_network_delays, :cache_simulates_network_delay_time, :record_stub_requests
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -28,6 +28,7 @@ module Billy
       @persist_cache = false
       @dynamic_jsonp = false
       @dynamic_jsonp_keys = ['callback']
+      @dynamic_jsonp_callback_name = 'callback'
       @ignore_cache_port = true
       @non_successful_cache_disabled = false
       @non_successful_error_level = :warn
@@ -42,6 +43,8 @@ module Billy
       @proxied_request_port = 80
       @cache_request_body_methods = ['post']
       @after_cache_handles_request = nil
+      @cache_simulates_network_delays = false
+      @cache_simulates_network_delay_time = 0.1
       @record_stub_requests = false
     end
   end

data/lib/billy/handlers/cache_handler.rb

@@ -30,6 +30,10 @@ module Billy
             Billy.config.after_cache_handles_request.call(request, response)
           end
 
+          if Billy.config.cache_simulates_network_delays
+            Kernel.sleep(Billy.config.cache_simulates_network_delay_time)
+          end
+
           return response
         end
       end
@@ -46,8 +50,9 @@ module Billy
       request_uri = Addressable::URI.parse(url)
       if request_uri.query
         params = CGI.parse(request_uri.query)
-        if params['callback'].any? && response[:content].match(/\w+\(/)
-          response[:content].sub!(/\w+\(/, params['callback'].first + '(')
+        callback_name = Billy.config.dynamic_jsonp_callback_name
+        if params[callback_name].any? && response[:content].match(/\w+\(/)
+          response[:content].sub!(/\w+\(/, params[callback_name].first + '(')
         end
       end
     end

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = '0.9.2'
+  VERSION = '0.10.0'
 end

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

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe Billy::CacheHandler do
   let(:handler) { Billy::CacheHandler.new }
+  let(:request_url) { 'http://example.test:8080/index?some=param&callback=dynamicCallback5678' }
   let(:request) do
     {
       method:   'post',
-      url:      'http://example.test:8080/index?some=param&callback=dynamicCallback5678',
+      url:      request_url,
       headers:  { 'Accept-Encoding'  => 'gzip',
                   'Cache-Control'    => 'no-cache' },
       body:     'Some body'
@@ -114,6 +115,26 @@ describe Billy::CacheHandler do
                                         request[:body])).to eql(status: 200, headers: { 'Connection' => 'close', 'Access-Control-Allow-Origin' => "*" }, content: 'Some body')
         end
       end
+
+      context 'when dynamic_jsonp_callback_name is set' do
+        let(:dynamic_jsonp_callback_name) { 'customCallback' }
+        let(:request_url) { "http://example.test:8080/index?some=param&#{dynamic_jsonp_callback_name}=dynamicCallback5678" }
+
+        before do
+          allow(Billy.config).to receive(:dynamic_jsonp_callback_name) do
+            dynamic_jsonp_callback_name
+          end
+        end
+
+        it 'should call the callback with the specified name' do
+          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: 'dynamicCallback1234({"yolo":"kitten"})')
+          expect(handler.handle_request(request[:method],
+                                        request[:url],
+                                        request[:headers],
+                                        request[:body])).to eql(status: 200, headers: { 'Connection' => 'close' }, content: 'dynamicCallback5678({"yolo":"kitten"})')
+        end
+      end
     end
 
     context 'updating jsonp callback names disabled' do
@@ -139,5 +160,32 @@ describe Billy::CacheHandler do
                                     request[:headers],
                                     request[:body])).to be nil
     end
+
+    context 'network delay simulation' do
+      before do
+        allow(Billy::Cache.instance).to receive(:cached?).and_return(true)
+        allow(Billy::Cache.instance).to receive(:fetch).and_return(status: 200, headers: { 'Connection' => 'close' }, content: 'dynamicCallback1234({"yolo":"kitten"})')
+      end
+
+      context 'when cache_simulates_network_delays is disabled' do
+        it 'does not sleep for default delay before responding' do
+          expect(Kernel).not_to receive(:sleep)
+          handler.handle_request(request[:method], request[:url], request[:headers], request[:body])
+        end
+      end
+
+      context 'when cache_simulates_network_delays is enabled' do
+        around do |example|
+          Billy.config.cache_simulates_network_delays = true
+          example.call
+          Billy.config.cache_simulates_network_delays = false
+        end
+
+        it 'sleeps for default delay before responding' do
+          expect(Kernel).to receive(:sleep).with(Billy.config.cache_simulates_network_delay_time)
+          handler.handle_request(request[:method], request[:url], request[:headers], request[:body])
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Olly Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -386,7 +386,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Easy request stubs for browser tests.
@@ -411,4 +411,3 @@ test_files:
 - spec/lib/proxy_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb
-has_rdoc: