puffing-billy 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6445deb6e30f295a1f15a5f4b1a094be474a587b375ecc6f23023baf0c74a9a0
-  data.tar.gz: b1da2a249c2d37d679f4134714ee1c33f6f6eb77fabefdb34637d1ebdf88b655
+  metadata.gz: 9abe93dc66216bc06e928bc9b61d92c52aaa718c196664afbaece19ef9dedd06
+  data.tar.gz: 76967de33848f166cc247c0a20ac917537331293237e33d8a5693fd1756221ba
 SHA512:
-  metadata.gz: fde48ead48a81d1f6b98e307aac098f3fd5357629a147fda05800120708e86f51a78433d15266e559ac856d22dd99f931e7a6c3a3ae10e158eb786b9d095381b
-  data.tar.gz: d4e2312af4c9a8e67c5d7316b0c9a0384d451974a78b3c9b3077d5392a492710460df32c08e4767a17f3e9e6f883e6ce98a9b81168e2e6dced1250ba6204104a
+  metadata.gz: 234b170df43cc3954a49e7fdae65593b1de7e07b0ae4fc3e68dfc9da620c348d700af14f533d379448f1da764cd484f2e07752b2254d59c602b76d96ebb14449
+  data.tar.gz: 21e5760521c6c6d74d9a969834cc1856f780f98350665793a3028140f8b2f738a4df6060a2d8043946d977b6f504c74625df12a763fc7e8b29619f9aba7c8423

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v2.3.0, 2019-12-26
+-------------------
+  * Add `cache_whitelist` config option [#279](https://github.com/oesmith/puffing-billy/pull/279)
+  * Ignore certificate errors in Chrome [#280](https://github.com/oesmith/puffing-billy/pull/280)
+
 v2.2.0, 2019-10-26
 -------------------
   * Before handle request method [#273](https://github.com/oesmith/puffing-billy/pull/273)

data/README.md

@@ -21,7 +21,7 @@ you can test it!
 
 ```ruby
 it 'should stub google' do
-  proxy.stub('http://www.google.com/').and_return(:text => "I'm not Google!")
+  proxy.stub('http://www.google.com/').and_return(text: "I'm not Google!")
   visit 'http://www.google.com/'
   expect(page).to have_content("I'm not Google!")
 end
@@ -85,21 +85,21 @@ require 'billy/watir/rspec'
 
 ```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/headers/').and_return({
-  :headers => { 'Access-Control-Allow-Origin' => '*' },
-  :json    => { :foo => 'bar' }
-})
-proxy.stub('http://example.com/wtf/').and_return(:body => 'WTF!?', :content_type => 'text/wtf')
+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/headers/').and_return(
+  headers: { 'Access-Control-Allow-Origin' => '*' },
+  json: { 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')
+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:443/secure/').and_return(:text => 'secrets!!1!')
+proxy.stub('https://example.com:443/secure/').and_return(text: 'secrets!!1!')
 
 # Pass a Proc (or Proc-style object) to create dynamic responses.
 #
@@ -111,8 +111,8 @@ proxy.stub('https://example.com:443/secure/').and_return(:text => 'secrets!!1!')
 #   method:  The HTTP verb which was requested
 proxy.stub('https://example.com/proc/').and_return(Proc.new { |params, headers, body, url, method|
   {
-    :code => 200,
-    :text => "Hello, #{params['name'][0]}"
+    code: 200,
+    text: "Hello, #{params['name'][0]}"
   }
 })
 
@@ -122,7 +122,7 @@ proxy.stub('https://example.com/proc/').and_return(Proc.new { |params, headers,
 # server. The scope of the delivered callable is the user scope where
 # it was defined. Setting method to 'all' will intercept requests regardless of
 # the method.
-proxy.stub('http://example.com/', method => 'all').and_return(Proc.new { |*args|
+proxy.stub('http://example.com/', method: 'all').and_return(Proc.new { |*args|
   response = Billy.pass_request(*args)
   response[:headers]['Content-Type'] = 'text/plain'
   response[:body] = 'Hello World!'
@@ -131,19 +131,19 @@ proxy.stub('http://example.com/', method => 'all').and_return(Proc.new { |*args|
 })
 
 # 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
+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 => {
+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
+  code: 200
 )
 ```
 
@@ -154,7 +154,7 @@ If for any reason you'd need to reset stubs manually you can do it in two ways:
 
 ```ruby
 # reset a single stub
-example_stub = proxy.stub('http://example.com/text/').and_return(:text => 'Foobar')
+example_stub = proxy.stub('http://example.com/text/').and_return(text: 'Foobar')
 proxy.unstub example_stub
 
 # reset all stubs
@@ -193,7 +193,7 @@ Before('@billy') do
 end
 
 And /^a stub for google$/ do
-  proxy.stub('http://www.google.com/').and_return(:text => "I'm not Google!")
+  proxy.stub('http://www.google.com/').and_return(text: "I'm not Google!")
   visit 'http://www.google.com/'
   expect(page).to have_content("I'm not Google!")
 end
@@ -224,7 +224,7 @@ Before('@billy') do
 end
 
 And /^a stub for google$/ do
-  proxy.stub('http://www.google.com/').and_return(:text => "I'm not Google!")
+  proxy.stub('http://www.google.com/').and_return(text: "I'm not Google!")
   @browser.goto 'http://www.google.com/'
   expect(@browser.text).to eq("I'm not Google!")
 end
@@ -263,6 +263,8 @@ server = Capybara.current_session.server
 Billy.config.whitelist = ["#{server.host}:#{server.port}"]
 ```
 
+If you would like to cache whitelisted URLs, you can define them in `c.cache_whitelist`. This is useful for scenarios where you may want to set `c.non_whitelisted_requests_disabled` to `true` to only allow whitelisted URLs to be accessed, but still allow specific URLs to be treated as if they were non-whitelisted.
+
 If you want to use puffing-billy like you would [VCR](https://github.com/vcr/vcr)
 you can turn on cache persistence. This way you don't have to manually mock out
 everything as requests are automatically recorded and played back. With cache
@@ -292,6 +294,7 @@ Billy.configure do |c|
   c.proxy_port = 12345 # defaults to random
   c.proxied_request_host = nil
   c.proxied_request_port = 80
+  c.cache_whitelist = []
   c.record_requests = true # defaults to false
   c.cache_request_body_methods = ['post', 'patch', 'put'] # defaults to ['post']
 end

data/examples/tumblr_api_https.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<body>
+  <h1>Latest news</h1>
+  <div id="news"></div>
+
+  <script type='text/javascript' src='http://code.jquery.com/jquery-1.8.2.min.js'></script>
+  <script type='text/javascript'>
+  $(function () {
+    var url = 'https://blog.howmanyleft.co.uk/api/read/json?callback=?&type=text&num=3&filter=text';
+    $.getJSON(url, function (data) {
+      $.each(data.posts, function (idx, post) {
+        var title = post['regular-title'];
+        var href = post['url-with-slug'];
+        var body = post['regular-body'];
+        $('#news').append(
+          '<h3><a href="' + href + '">' + title + '</a></h3>' +
+          '<p>' + body + '</p>');
+      });
+    });
+  })
+  </script>
+</body>

data/lib/billy/browsers/capybara.rb

@@ -64,6 +64,7 @@ module Billy
 
         ::Capybara.register_driver :selenium_chrome_billy do |app|
           options = Selenium::WebDriver::Chrome::Options.new
+          options.add_argument('--ignore-certificate-errors')
           options.add_argument("--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}")
 
           ::Capybara::Selenium::Driver.new(
@@ -79,6 +80,7 @@ module Billy
             options = Selenium::WebDriver::Chrome::Options.new
             options.headless!
             options.add_argument('--enable-features=NetworkService,NetworkServiceInProcess')
+            options.add_argument('--ignore-certificate-errors')
             options.add_argument("--proxy-server=#{Billy.proxy.host}:#{Billy.proxy.port}")
             options.add_argument('--disable-gpu') if Gem.win_platform?
             options.add_argument('--no-sandbox') if ENV['CI']

data/lib/billy/config.rb

@@ -6,7 +6,7 @@ module Billy
     DEFAULT_WHITELIST = ['127.0.0.1', 'localhost']
     RANDOM_AVAILABLE_PORT = 0 # https://github.com/eventmachine/eventmachine/wiki/FAQ#wiki-can-i-start-a-server-on-a-random-available-port
 
-    attr_accessor :logger, :cache, :cache_request_headers, :whitelist, :path_blacklist, :ignore_params, :allow_params,
+    attr_accessor :logger, :cache, :cache_request_headers, :whitelist, :cache_whitelist, :path_blacklist, :ignore_params, :allow_params,
                   :persist_cache, :ignore_cache_port, :non_successful_cache_disabled, :non_successful_error_level,
                   :non_whitelisted_requests_disabled, :cache_path, :certs_path, :proxy_host, :proxy_port, :proxied_request_inactivity_timeout,
                   :proxied_request_connect_timeout, :dynamic_jsonp, :dynamic_jsonp_keys, :dynamic_jsonp_callback_name, :merge_cached_responses_whitelist,
@@ -21,6 +21,7 @@ module Billy
     def reset
       @cache = true
       @cache_request_headers = false
+      @cache_whitelist = []
       @whitelist = DEFAULT_WHITELIST
       @path_blacklist = []
       @merge_cached_responses_whitelist = []

data/lib/billy/handlers/proxy_handler.rb

@@ -110,7 +110,7 @@ module Billy
 
       url = Addressable::URI.parse(url)
       # Cache the responses if they aren't whitelisted host[:port]s but always cache blacklisted paths on any hosts
-      cacheable_status?(status) && (!whitelisted_url?(url) || blacklisted_path?(url.path))
+      cacheable_status?(status) && (!whitelisted_url?(url) || blacklisted_path?(url.path) || cache_whitelisted_url?(url))
     end
 
     def whitelisted_url?(url)
@@ -123,6 +123,16 @@ module Billy
       end
     end
 
+    def cache_whitelisted_url?(url)
+      Billy.config.cache_whitelist.any? do |value|
+        if value.is_a?(Regexp)
+          url.to_s =~ value || url.omit(:port).to_s =~ value
+        else
+          value =~ /^#{url.host}(?::#{url.port})?$/
+        end
+      end
+    end
+
     def blacklisted_path?(path)
       !Billy.config.path_blacklist.index { |bl| bl.is_a?(Regexp) ? path =~ bl : path.include?(bl) }.nil?
     end

data/lib/billy/version.rb

@@ -1,3 +1,3 @@
 module Billy
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/lib/billy/browsers/capybara_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'Capybara drivers', type: :feature, js: true do
+  it 'allows HTTPS calls' do
+    proxy.stub('https://blog.howmanyleft.co.uk:443/api/read/json').and_return(
+      jsonp: {
+        posts: [
+          {
+            'regular-title' => 'News Item 1',
+            'url-with-slug' => 'http://example.com/news/1',
+            'regular-body' => 'News item 1 content here'
+          },
+          {
+            'regular-title' => 'News Item 2',
+            'url-with-slug' => 'http://example.com/news/2',
+            'regular-body' => 'News item 2 content here'
+          }
+        ]
+      })
+
+    visit '/tumblr_api_https.html'
+
+    expect(page).to have_link('News Item 1', href: 'http://example.com/news/1')
+    expect(page).to have_content('News item 1 content here')
+    expect(page).to have_link('News Item 2', href: 'http://example.com/news/2')
+    expect(page).to have_content('News item 2 content here')
+  end
+end

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

@@ -175,6 +175,34 @@ describe Billy::ProxyHandler do
                                request[:body])
       end
 
+      it 'does NOT cache the response if the host is whitelisted but not cache_whitelisted' do
+        uri = Addressable::URI.parse(request[:url])
+
+        expect(subject).to receive(:allowed_response_code?).and_return(true)
+        expect(Billy.config).to receive(:whitelist).and_return([uri.host])
+        expect(Billy.config).to receive(:cache_whitelist).and_return([])
+
+        expect(Billy::Cache.instance).not_to receive(:store)
+        subject.handle_request(request[:method],
+                               request[:url],
+                               request[:headers],
+                               request[:body])
+      end
+
+      it 'caches the response if the host is whitelisted AND cache_whitelisted' do
+        uri = Addressable::URI.parse(request[:url])
+
+        expect(subject).to receive(:allowed_response_code?).and_return(true)
+        expect(Billy.config).to receive(:whitelist).and_return([uri.host])
+        expect(Billy.config).to receive(:cache_whitelist).and_return([uri.host])
+
+        expect(Billy::Cache.instance).to receive(:store)
+        subject.handle_request(request[:method],
+                               request[:url],
+                               request[:headers],
+                               request[:body])
+      end
+
       it 'uses the timeouts defined in configuration' do
         allow(Billy.config).to receive(:proxied_request_inactivity_timeout).and_return(42)
         allow(Billy.config).to receive(:proxied_request_connect_timeout).and_return(24)

data/spec/lib/proxy_spec.rb

@@ -118,6 +118,29 @@ shared_examples_for 'a cache' do
     end
   end
 
+  context 'cache_whitelist GET requests' do
+    before do
+      Billy.config.whitelist = [http.host]
+      Billy.config.cache_whitelist = [http.host]
+    end
+
+    it 'should be cached' do
+      assert_cached_url
+    end
+
+    context 'with ports' do
+      before do
+        rack_app_url = URI(http.url_prefix)
+        Billy.config.whitelist = ["#{rack_app_url.host}:#{rack_app_url.port + 1}"]
+        Billy.config.cache_whitelist = Billy.config.whitelist
+      end
+
+      it 'should be cached' do
+        assert_cached_url
+      end
+    end
+  end
+
   context 'ignore_params GET requests' do
     before do
       Billy.config.ignore_params = ['/analytics']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffing-billy
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Olly Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2019-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -336,6 +336,7 @@ files:
 - examples/post_api.html
 - examples/preflight_request.html
 - examples/tumblr_api.html
+- examples/tumblr_api_https.html
 - lib/billy.rb
 - lib/billy/browsers/capybara.rb
 - lib/billy/browsers/watir.rb
@@ -375,6 +376,7 @@ files:
 - spec/features/examples/post_api_spec.rb
 - spec/features/examples/preflight_request_spec.rb
 - spec/features/examples/tumblr_api_spec.rb
+- spec/lib/billy/browsers/capybara_spec.rb
 - spec/lib/billy/cache_spec.rb
 - spec/lib/billy/handlers/cache_handler_spec.rb
 - spec/lib/billy/handlers/handler_spec.rb
@@ -421,6 +423,7 @@ test_files:
 - spec/features/examples/post_api_spec.rb
 - spec/features/examples/preflight_request_spec.rb
 - spec/features/examples/tumblr_api_spec.rb
+- spec/lib/billy/browsers/capybara_spec.rb
 - spec/lib/billy/cache_spec.rb
 - spec/lib/billy/handlers/cache_handler_spec.rb
 - spec/lib/billy/handlers/handler_spec.rb