RubyGems - puffing-billy - Versions diffs - 2.3.1 → 3.0.1 - Mend

puffing-billy 2.3.1 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +17 -0
data/README.md +18 -5
data/lib/billy/browsers/capybara.rb +13 -9
data/lib/billy/browsers/watir.rb +4 -2
data/lib/billy/config.rb +2 -1
data/lib/billy/handlers/proxy_handler.rb +4 -0
data/lib/billy/proxy.rb +1 -1
data/lib/billy/ssl/certificate_helpers.rb +1 -1
data/lib/billy/version.rb +1 -1
metadata +29 -80
data/.gitignore +0 -6
data/.rspec +0 -2
data/.travis.yml +0 -36
data/Dockerfile +0 -14
data/Gemfile +0 -4
data/Guardfile +0 -23
data/Rakefile +0 -11
data/bin/proxy.rb +0 -3
data/examples/README.md +0 -1
data/examples/facebook_api.html +0 -59
data/examples/intercept_request.html +0 -10
data/examples/post_api.html +0 -16
data/examples/preflight_request.html +0 -22
data/examples/tumblr_api.html +0 -22
data/examples/tumblr_api_https.html +0 -22
data/lib/tasks/billy.rake +0 -87
data/log/.gitkeep +0 -0
data/puffing-billy.gemspec +0 -39
data/spec/features/examples/facebook_api_spec.rb +0 -23
data/spec/features/examples/intercept_request_spec.rb +0 -31
data/spec/features/examples/post_api_spec.rb +0 -15
data/spec/features/examples/preflight_request_spec.rb +0 -29
data/spec/features/examples/tumblr_api_spec.rb +0 -59
data/spec/lib/billy/browsers/capybara_spec.rb +0 -28
data/spec/lib/billy/cache_spec.rb +0 -158
data/spec/lib/billy/handlers/cache_handler_spec.rb +0 -191
data/spec/lib/billy/handlers/handler_spec.rb +0 -16
data/spec/lib/billy/handlers/proxy_handler_spec.rb +0 -254
data/spec/lib/billy/handlers/request_handler_spec.rb +0 -200
data/spec/lib/billy/handlers/request_log_spec.rb +0 -74
data/spec/lib/billy/handlers/stub_handler_spec.rb +0 -117
data/spec/lib/billy/proxy_connection_spec.rb +0 -20
data/spec/lib/billy/proxy_request_stub_spec.rb +0 -252
data/spec/lib/billy/resource_utils_spec.rb +0 -55
data/spec/lib/billy/ssl/authority_spec.rb +0 -84
data/spec/lib/billy/ssl/certificate_chain_spec.rb +0 -39
data/spec/lib/billy/ssl/certificate_spec.rb +0 -89
data/spec/lib/billy/watir/watir_spec.rb +0 -18
data/spec/lib/proxy_spec.rb +0 -431
data/spec/spec_helper.rb +0 -52
data/spec/support/test_server.rb +0 -79

data/examples/tumblr_api_https.html DELETED Viewed

@@ -1,22 +0,0 @@
-<!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/tasks/billy.rake DELETED Viewed

@@ -1,87 +0,0 @@
-require 'addressable/uri'
-namespace :cache do
-  desc 'Print out all cache file information'
-  task :print_all do
-    cache_array = load_cache
-    sort_cache(cache_array).each do |cache|
-      print_cache_details(cache)
-    end
-  end
-  desc 'Print out specific cache file information'
-  task :print_details, :sha do |_t, args|
-    fail "Missing sha; usage: rake cache:print_details['<sha>']" unless args[:sha]
-    cache_array = load_cache(Billy.config.cache_path, '*' + args[:sha] + '*.yml')
-    sort_cache(cache_array).each do |cache|
-      print_cache_details(cache)
-    end
-  end
-  desc 'Find specific cache files by URL'
-  task :find_by_url, :api_path do |_t, args|
-    fail "Missing api path; usage: rake cache:find_by_url['<api_path>']" unless args[:api_path]
-    cache_array = load_cache
-    filtered_cache_array = cache_array.select { |f| f[:url_path].include?(args[:api_path]) }
-    sort_cache(filtered_cache_array).each do |cache|
-      print_cache_details(cache)
-    end
-  end
-  desc 'Find specific cache files by scope'
-  task :find_by_scope, :scope do |_t, args|
-    fail "Missing scope; usage: rake cache:find_by_scope['<scope>']" unless args[:scope]
-    cache_array = load_cache
-    filtered_cache_array = cache_array.select { |f| f[:scope] && f[:scope].include?(args[:scope]) }
-    sort_cache(filtered_cache_array).each do |cache|
-      print_cache_details(cache)
-    end
-  end
-  desc 'Find cache files with non-successful status codes'
-  task :find_non_successful do
-    cache_array = load_cache
-    filtered_cache_array = cache_array.select { |f| !(200..299).include?(f[:status]) }
-    sort_cache(filtered_cache_array).each do |cache|
-      print_cache_details(cache)
-    end
-  end
-  def load_cache(cache_directory = Billy.config.cache_path, file_pattern = '*.yml')
-    cache_path  = Rails.root.join(cache_directory)
-    cache_array = []
-    Dir.glob(cache_path + file_pattern) do |filename|
-      data = load_cache_file(filename)
-      url = Addressable::URI.parse(data[:url])
-      data[:url_path] = "#{url.path}#{url.query ? '?' + url.query : ''}#{url.fragment ? '#' + url.fragment : ''}"
-      data[:filename] = filename.gsub(Rails.root.to_s + '/', '')
-      cache_array << data
-    end
-    cache_array
-  end
-  def load_cache_file(filename)
-    YAML.load_file(filename)
-  rescue ArgumentError => e
-    puts "Could not parse YAML: #{e.message}"
-  end
-  def print_cache_details(cache)
-    puts "   Scope: #{cache[:scope]}" if cache[:scope]
-    puts "     URL: #{cache[:url]}"
-    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"
-  end
-  def sort_cache(cache, key = :url_path)
-    cache.sort_by { |hsh| hsh[key] }
-  end
-end

data/log/.gitkeep DELETED Viewed

File without changes

data/puffing-billy.gemspec DELETED Viewed

@@ -1,39 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/billy/version', __FILE__)
-Gem::Specification.new do |gem|
-  gem.authors       = ['Olly Smith']
-  gem.email         = ['olly.smith@gmail.com']
-  gem.description   = 'A stubbing proxy server for ruby. Connect it to your browser in integration tests to fake interactions with remote HTTP(S) servers.'
-  gem.summary       = 'Easy request stubs for browser tests.'
-  gem.homepage      = 'https://github.com/oesmith/puffing-billy'
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = 'puffing-billy'
-  gem.require_paths = ['lib']
-  gem.version       = Billy::VERSION
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'thin'
-  gem.add_development_dependency 'faraday', '>= 0.9.0'
-  gem.add_development_dependency 'apparition'
-  gem.add_development_dependency 'capybara'
-  gem.add_development_dependency 'selenium-webdriver'
-  gem.add_development_dependency 'rack'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'guard'
-  gem.add_development_dependency 'rb-inotify'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'cucumber'
-  gem.add_development_dependency 'watir', '~> 6.10.0'
-  gem.add_development_dependency 'webdrivers'
-  gem.add_runtime_dependency 'addressable', '~> 2.5'
-  gem.add_runtime_dependency 'eventmachine', '~> 1.2'
-  gem.add_runtime_dependency 'em-synchrony'
-  gem.add_runtime_dependency 'em-http-request', '~> 1.1', '>= 1.1.0'
-  gem.add_runtime_dependency 'eventmachine_httpserver'
-  gem.add_runtime_dependency 'http_parser.rb', '~> 0.6.0'
-  gem.add_runtime_dependency 'multi_json'
-end

data/spec/features/examples/facebook_api_spec.rb DELETED Viewed

@@ -1,23 +0,0 @@
-require 'spec_helper'
-require 'base64'
-# FIXME: Looks like Facebook API changed recently and this test fails consistently now -RS 2018-03-05
-xdescribe 'Facebook API example', type: :feature, js: true do
-  before do
-    proxy.stub('https://www.facebook.com:443/dialog/oauth').and_return(proc do |params, _, _|
-      # mock a signed request from facebook.  the JS api never verifies the
-      # signature, so all it needs is the base64-encoded payload
-      signed_request = "xxxxxxxxxx.#{Base64.encode64('{"user_id":"1234567"}')}"
-      # redirect to the 'redirect_uri', with some extra crap in the query string
-      { redirect_to: "#{params['redirect_uri'][0]}&access_token=foobar&expires_in=600&base_domain=localhost&https=1&signed_request=#{signed_request}" }
-    end)
-    proxy.stub('https://graph.facebook.com:443/me').and_return(jsonp: { name: 'Tester 1' })
-  end
-  it 'should show me as logged-in' do
-    visit '/facebook_api.html'
-    click_on 'Login'
-    expect(page).to have_content 'Hi, Tester 1'
-  end
-end

data/spec/features/examples/intercept_request_spec.rb DELETED Viewed

@@ -1,31 +0,0 @@
-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/features/examples/post_api_spec.rb DELETED Viewed

@@ -1,15 +0,0 @@
-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 DELETED Viewed

@@ -1,29 +0,0 @@
-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/features/examples/tumblr_api_spec.rb DELETED Viewed

@@ -1,59 +0,0 @@
-require 'spec_helper'
-RSpec.shared_examples 'tumblr/expectations' do
-  it 'should show news stories' do
-    visit '/tumblr_api.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
-describe 'Tumblr API example', type: :feature, js: true do
-  context 'without scope external references' do
-    before do
-      proxy.stub('http://blog.howmanyleft.co.uk/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'
-            }
-          ]
-        })
-    end
-    include_examples 'tumblr/expectations'
-  end
-  context 'with scope external references' do
-    let(:posts) do
-      [
-        {
-          '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'
-        }
-      ]
-    end
-    before do
-      proxy.stub('http://blog.howmanyleft.co.uk/api/read/json')
-           .and_return(proc { { jsonp: { posts: posts } } })
-    end
-    include_examples 'tumblr/expectations'
-  end
-end

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

@@ -1,28 +0,0 @@
-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/cache_spec.rb DELETED Viewed

@@ -1,158 +0,0 @@
-require 'spec_helper'
-describe Billy::Cache do
-  let(:cache) { Billy::Cache.instance }
-  let(:params) { '?foo=bar' }
-  let(:callback) { '&callback=quux' }
-  let(:fragment) { '#baz' }
-  let(:base_url) { 'http://example.com' }
-  let(:pipe_url) { 'https://fonts.googleapis.com:443/css?family=Cabin+Sketch:400,700|Love+Ya+Like+A+Sister' }
-  let(:fragment_url) { "#{base_url}/#{fragment}" }
-  let(:params_url) { "#{base_url}#{params}" }
-  let(:params_url_with_callback) { "#{base_url}#{params}#{callback}" }
-  let(:params_fragment_url) { "#{base_url}#{params}#{fragment}" }
-  describe 'format_url' do
-    context 'with ignore_params set to false' do
-      it 'is a no-op if there are no params' do
-        expect(cache.format_url(base_url)).to eq base_url
-      end
-      it 'appends params if there are params' do
-        expect(cache.format_url(params_url)).to eq params_url
-      end
-      it 'appends params and fragment if both are present' do
-        expect(cache.format_url(params_fragment_url)).to eq params_fragment_url
-      end
-      it 'does not raise error for URLs with pipes' do
-        expect { cache.format_url(pipe_url) }.not_to raise_error
-      end
-      context 'when dynamic_jsonp is true' do
-        it 'omits the callback param by default' do
-          expect(cache.format_url(params_url_with_callback, false, true)).to eq params_url
-        end
-        it 'omits the params listed in Billy.config.dynamic_jsonp_keys' do
-          allow(Billy.config).to receive(:dynamic_jsonp_keys) { ['foo'] }
-          expect(cache.format_url(params_url_with_callback, false, true)).to eq "#{base_url}?callback=quux"
-        end
-      end
-      it 'retains the callback param is dynamic_jsonp is false' do
-        expect(cache.format_url(params_url_with_callback)).to eq params_url_with_callback
-      end
-    end
-    context 'with ignore_params set to true' do
-      it 'is a no-op if there are no params' do
-        expect(cache.format_url(base_url, true)).to eq base_url
-      end
-      it 'omits params if there are params' do
-        expect(cache.format_url(params_url, true)).to eq base_url
-      end
-      it 'omits params and fragment if both are present' do
-        expect(cache.format_url(params_fragment_url, true)).to eq base_url
-      end
-    end
-    context 'with merge_cached_responses_whitelist set' do
-      let(:analytics_url1) { 'http://www.example-analytics.com/user/SDF879932/' }
-      let(:analytics_url2) { 'http://www.example-analytics.com/user/OIWEMLW39/' }
-      let(:regular_url) { 'http://www.example-analytics.com/user.js' }
-      let(:regex_to_match_analytics_urls_only) do
-        # Note that it matches the forward slash at the end of the URL, which doesn't match regular_url:
-        /www\.example\-analytics\.com\/user\//
-      end
-      before do
-        allow(Billy.config).to receive(:merge_cached_responses_whitelist) {
-          [regex_to_match_analytics_urls_only]
-        }
-      end
-      it "has one cache key for the two analytics urls that match, and a separate one for the other that doesn't" do
-        expect(cache.key('post', analytics_url1, 'body')).to eq cache.key('post', analytics_url2, 'body')
-        expect(cache.key('post', analytics_url1, 'body')).not_to eq cache.key('post', regular_url, 'body')
-      end
-      it 'More specifically, the cache keys should be identical for the 2 analytics urls' do
-        identical_cache_key = 'post_5fcb7a450e4cd54dcffcb526212757ee0ca9dc17'
-        distinct_cache_key = 'post_www.example-analytics.com_81f097654a523bd7ddb10fd4aee781723e076a1a_02083f4579e08a612425c0c1a17ee47add783b94'
-        expect(cache.key('post', analytics_url1, 'body')).to eq identical_cache_key
-        expect(cache.key('post', regular_url, 'body')).to eq distinct_cache_key
-        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
-  describe 'key' do
-    context 'with use_ignore_params set to false' do
-      before do
-        allow(Billy.config).to receive(:use_ignore_params) { false }
-      end
-      it "should use the same cache key if the base url IS NOT whitelisted in allow_params" do
-        key1 = cache.key('put', params_url, 'body')
-        key2 = cache.key('put', params_url, 'body')
-        expect(key1).to eq key2
-      end
-      it "should have the same cache key if the base IS whitelisted in allow_params" do
-        allow(Billy.config).to receive(:allow_params) { [base_url] }
-        key1 = cache.key('put', params_url, 'body')
-        key2 = cache.key('put', params_url, 'body')
-        expect(key1).to eq key2
-      end
-      it "should have different cache keys if the base url is added in between two requests" do
-        key1 = cache.key('put', params_url, 'body')
-        allow(Billy.config).to receive(:allow_params) { [base_url] }
-        key2 = cache.key('put', params_url, 'body')
-        expect(key1).not_to eq key2
-      end
-      it "should not use ignore_params when whitelisted" do
-        allow(Billy.config).to receive(:allow_params) { [base_url] }
-        expect(cache).to receive(:format_url).once.with(params_url, true).and_call_original
-        expect(cache).to receive(:format_url).once.with(params_url, false).and_call_original
-        key1 = cache.key('put', params_url, 'body')
-      end
-      it "should use ignore_params when not whitelisted" do
-        expect(cache).to receive(:format_url).twice.with(params_url, true).and_call_original
-        cache.key('put', params_url, 'body')
-      end
-    end
-  end
-end