puffing-billy 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6557e02e504855ec7a7776eeee317695021c9e50
-  data.tar.gz: c25a26247ee30db7daa8158f739503b19848615f
+  metadata.gz: 556d5bc9c625544467f4dfcfcde6a1e5666b3c24
+  data.tar.gz: 5ef5ee675e69541bde2bb75807db1c252a154f5f
 SHA512:
-  metadata.gz: 94a428edbe74084084326f1daad96992928f8c22dcc6e52d0c95bc153e3d4296bd754f3bd3dfb02d1a435729e62e46726f5ed772fd6a646ce9c8e95a1ae0452d
-  data.tar.gz: c0d6395651e775a9bde1a67cb164617fceb901baa758e204dc4fc5adea37932cd68a0095471906f5d31fbaae3868c9b9092d4cd8e43705553f781d1266836357
+  metadata.gz: 12b4fe682ddd846585f468dfe16f54dce866d4e14a5176d4bf5a409a0e5d4553e701fad2c956887ea207142072e7ed7f6a1dd9ab738f4ea89ed2909e1b883652
+  data.tar.gz: 773d1bbd8d4aac55a7f67bd1903e86e801d21bc7619b55cbf7a3e19bac6efa12e8d95e5bea444f5484164b1bb4ccdda12a872579fb3fd4fc936637112b4750fe

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+v0.5.0, 2015-02-22
+------------------
+
+  * Rubocop code cleanup (#89)
+  * Create option for strip query params in request stub (#93)
+  * Require compatible version of em-http-request (#94)
+
 v0.4.1, 2015-01-02
 ------------------
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    puffing-billy (0.4.1)
+    puffing-billy (0.5.0)
       addressable
-      em-http-request
+      em-http-request (~> 1.1.0)
       em-synchrony
       eventmachine
       eventmachine_httpserver

data/Guardfile

@@ -1,18 +1,18 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 
   # Rails example
   watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
   watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
+  watch('config/routes.rb')                           { 'spec/routing' }
+  watch('app/controllers/application_controller.rb')  { 'spec/controllers' }
 
   # Capybara request specs
   watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }

data/README.md

@@ -137,6 +137,12 @@ It's good practice to reset the driver after each scenario, so having an
 stubs are reset after each step, so any usage of a stub should be in the 
 same step that it was created in.
 
+## Minitest Usage
+
+Please see [this link](https://gist.github.com/sauy7/1b081266dd453a1b737b) for
+details and report back to [Issue #49](https://github.com/oesmith/puffing-billy/issues/49)
+if you get it fully working.
+
 ## Caching
 
 Requests routed through the external proxy are cached.
@@ -202,6 +208,12 @@ caching. You should mostly use this for analytics and various social buttons as
 they use cache avoidance techniques, but return practically the same response
 that most often does not affect your test results.
 
+`c.strip_query_params` is used to strip query parameters when you stub some requests
+with query parameters. Default value is true. For example, `proxy.stub('http://myapi.com/user/?country=FOO')`
+is considered the same as: `proxy.stub('http://myapi.com/user/?anything=FOO')` and
+generally the same as: `proxy.stub('http://myapi.com/user/')`. When you need to distinguish between all these requests,
+you may set this config value to false.
+
 `c.dynamic_jsonp` is used to rewrite the body of JSONP responses based on the
 callback parameter. For example, if a request to `http://example.com/foo?callback=bar` 
 returns `bar({"some": "json"});` and is recorded, then a later request to
@@ -327,7 +339,7 @@ and tell it to ignore SSL certificate warnings. See
 to see how Billy's default drivers are configured.
 
 ## Working with VCR and Webmock
-If you use VCR and Webmock elsewhere in your specs, you will need to disable them
+If you use VCR and Webmock elsewhere in your specs, you may need to disable them
 for your specs utilizing Puffing Billy. To do so, you can configure your `spec_helper.rb`
 as shown below:
 
@@ -341,6 +353,12 @@ RSpec.configure do |config|
 end
 ```
 
+## Resources
+
+[Bring Ruby VCR to Javascript testing with Capybara and puffing-billy](http://architects.dzone.com/articles/bring-ruby-vcr-javascript)
+[Integration Testing Stripe.js With Mocked Network Requests](http://dev.contractual.ly/testing-stripe-js-with-mocked-network/)
+[Clean-up unused cache files periodically with this config](https://github.com/oesmith/puffing-billy/pull/26#issuecomment-29905030)
+
 ## FAQ
 
 1. Why name it after a train?

data/Rakefile

@@ -1,2 +1,2 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/billy.rb

@@ -1,15 +1,15 @@
-require "billy/version"
-require "billy/config"
-require "billy/handlers/handler"
-require "billy/handlers/request_handler"
-require "billy/handlers/stub_handler"
-require "billy/handlers/proxy_handler"
-require "billy/handlers/cache_handler"
-require "billy/proxy_request_stub"
-require "billy/cache"
-require "billy/proxy"
-require "billy/proxy_connection"
-require "billy/railtie" if defined?(Rails)
+require 'billy/version'
+require 'billy/config'
+require 'billy/handlers/handler'
+require 'billy/handlers/request_handler'
+require 'billy/handlers/stub_handler'
+require 'billy/handlers/proxy_handler'
+require 'billy/handlers/cache_handler'
+require 'billy/proxy_request_stub'
+require 'billy/cache'
+require 'billy/proxy'
+require 'billy/proxy_connection'
+require 'billy/railtie' if defined?(Rails)
 
 module Billy
   def self.proxy
@@ -44,8 +44,8 @@ module Billy
       Capybara.register_driver :webkit_billy do |app|
         driver = Capybara::Webkit::Driver.new(app)
         driver.browser.ignore_ssl_errors
-        driver.browser.set_proxy(:host => Billy.proxy.host,
-                                 :port => Billy.proxy.port)
+        driver.browser.set_proxy(host: Billy.proxy.host,
+                                 port: Billy.proxy.port)
         driver
       end
     end
@@ -55,9 +55,9 @@ module Billy
         profile = Selenium::WebDriver::Firefox::Profile.new
         profile.assume_untrusted_certificate_issuer = false
         profile.proxy = Selenium::WebDriver::Proxy.new(
-          :http => "#{Billy.proxy.host}:#{Billy.proxy.port}",
-          :ssl => "#{Billy.proxy.host}:#{Billy.proxy.port}")
-        Capybara::Selenium::Driver.new(app, :profile => profile)
+          http: "#{Billy.proxy.host}:#{Billy.proxy.port}",
+          ssl: "#{Billy.proxy.host}:#{Billy.proxy.port}")
+        Capybara::Selenium::Driver.new(app, profile: profile)
       end
     end
   end

data/lib/billy/cache.rb

@@ -17,51 +17,50 @@ module Billy
     def cached?(method, url, body)
       # Only log the key the first time it's looked up (in this method)
       key = key(method, url, body, true)
-      !@cache[key].nil? or persisted?(key)
+      !@cache[key].nil? || persisted?(key)
     end
 
     def persisted?(key)
-      Billy.config.persist_cache and File.exists?(cache_file(key))
+      Billy.config.persist_cache && File.exist?(cache_file(key))
     end
 
     def fetch(method, url, body)
       key = key(method, url, body)
-      @cache[key] or fetch_from_persistence(key)
+      @cache[key] || fetch_from_persistence(key)
     end
 
     def fetch_from_persistence(key)
-      begin
-        @cache[key] = YAML.load(File.open(cache_file(key))) if persisted?(key)
-      rescue ArgumentError => e
-        Billy.log :error, "Could not parse YAML: #{e.message}"
-        nil
-      end
+      @cache[key] = YAML.load(File.open(cache_file(key))) if persisted?(key)
+    rescue ArgumentError => e
+      Billy.log :error, "Could not parse YAML: #{e.message}"
+      nil
     end
 
     def store(method, url, request_headers, body, response_headers, status, content)
       cached = {
-        :scope => scope,
-        :url => format_url(url),
-        :body => body,
-        :status => status,
-        :method => method,
-        :headers => response_headers,
-        :content => content
+        scope: scope,
+        url: format_url(url),
+        body: body,
+        status: status,
+        method: method,
+        headers: response_headers,
+        content: content
       }
 
-      cached.merge!({:request_headers => request_headers}) if Billy.config.cache_request_headers
+      cached.merge!(request_headers: request_headers) if Billy.config.cache_request_headers
 
       key = key(method, url, body)
       @cache[key] = cached
 
       if Billy.config.persist_cache
-        Dir.mkdir(Billy.config.cache_path) unless File.exists?(Billy.config.cache_path)
+        Dir.mkdir(Billy.config.cache_path) unless File.exist?(Billy.config.cache_path)
 
         begin
           File.open(cache_file(key), 'w') do |f|
-            f.write(cached.to_yaml(:Encoding => :Utf8))
+            f.write(cached.to_yaml(Encoding: :Utf8))
           end
         rescue StandardError => e
+          Billy.log :error, "Error storing cache file: #{e.message}"
         end
       end
     end
@@ -75,33 +74,33 @@ module Billy
       merge_cached_response_key = _merge_cached_response_key(orig_url)
       url = Addressable::URI.parse(format_url(orig_url, ignore_params))
       key = if merge_cached_response_key
-          method+'_'+Digest::SHA1.hexdigest(scope.to_s + merge_cached_response_key)
-        else
-          method+'_'+url.host+'_'+Digest::SHA1.hexdigest(scope.to_s + url.to_s)
-        end
+              method + '_' + Digest::SHA1.hexdigest(scope.to_s + merge_cached_response_key)
+            else
+              method + '_' + url.host + '_' + Digest::SHA1.hexdigest(scope.to_s + url.to_s)
+            end
       body_msg = ''
 
       if method == 'post' && !ignore_params && !merge_cached_response_key
-        body_formatted = JSONUtils::json?(body.to_s) ? JSONUtils::sort_json(body.to_s) : body.to_s
+        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)
+        key += '_' + Digest::SHA1.hexdigest(body_formatted)
       end
 
       Billy.log(:info, "puffing-billy: CACHE KEY for '#{orig_url}#{body_msg}' is '#{key}'") if log_key
       key
     end
 
-    def format_url(url, ignore_params=false, dynamic_jsonp=Billy.config.dynamic_jsonp)
+    def format_url(url, ignore_params = false, dynamic_jsonp = Billy.config.dynamic_jsonp)
       url = Addressable::URI.parse(url)
       port_to_include = Billy.config.ignore_cache_port ? '' : ":#{url.port}"
-      formatted_url = url.scheme+'://'+url.host+port_to_include+url.path
+      formatted_url = url.scheme + '://' + url.host + port_to_include + url.path
 
       return formatted_url if ignore_params
 
       if url.query
         query_string = if dynamic_jsonp
                          query_hash = Rack::Utils.parse_query(url.query)
-                         Billy.config.dynamic_jsonp_keys.each{|k| query_hash.delete(k) }
+                         Billy.config.dynamic_jsonp_keys.each { |k| query_hash.delete(k) }
                          Rack::Utils.build_query(query_hash)
                        else
                          url.query
@@ -110,7 +109,7 @@ module Billy
         formatted_url += "?#{query_string}"
       end
 
-      formatted_url += '#'+url.fragment if url.fragment
+      formatted_url += '#' + url.fragment if url.fragment
 
       formatted_url
     end
@@ -124,10 +123,10 @@ module Billy
     end
 
     def with_scope(use_scope = nil, &block)
-      raise ArgumentError, 'Expected a block but none was received.' if block.nil?
+      fail ArgumentError, 'Expected a block but none was received.' if block.nil?
       original_scope = scope
       scope_to use_scope
-      block.call()
+      block.call
     ensure
       scope_to original_scope
     end

data/lib/billy/config.rb

@@ -9,7 +9,8 @@ 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_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, :merge_cached_responses_whitelist,
+                  :strip_query_params
 
     def initialize
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -25,7 +26,7 @@ module Billy
       @ignore_params = []
       @persist_cache = false
       @dynamic_jsonp = false
-      @dynamic_jsonp_keys = ["callback"]
+      @dynamic_jsonp_keys = ['callback']
       @ignore_cache_port = true
       @non_successful_cache_disabled = false
       @non_successful_error_level = :warn
@@ -34,6 +35,7 @@ module Billy
       @proxy_port = RANDOM_AVAILABLE_PORT
       @proxied_request_inactivity_timeout = 10 # defaults from https://github.com/igrigorik/em-http-request/wiki/Redirects-and-Timeouts
       @proxied_request_connect_timeout = 5
+      @strip_query_params = true
     end
   end
 

data/lib/billy/handlers/cache_handler.rb

@@ -7,6 +7,8 @@ module Billy
     extend Forwardable
     include Handler
 
+    attr_reader :cache
+
     def_delegators :cache, :reset, :cached?
 
     def initialize
@@ -29,7 +31,7 @@ module Billy
       nil
     end
 
-    def handles_request?(method, url, headers, body)
+    def handles_request?(method, url, _headers, body)
       cached?(method, url, body)
     end
 
@@ -38,15 +40,11 @@ module Billy
     def replace_response_callback(response, url)
       request_uri = Addressable::URI.parse(url)
       if request_uri.query
-        params = CGI::parse(request_uri.query)
-        if params['callback'].any? and response[:content].match(/\w+\(/)
+        params = CGI.parse(request_uri.query)
+        if params['callback'].any? && response[:content].match(/\w+\(/)
           response[:content].sub!(/\w+\(/, params['callback'].first + '(')
         end
       end
     end
-
-    def cache
-      @cache
-    end
   end
 end

data/lib/billy/handlers/handler.rb

@@ -15,7 +15,7 @@ module Billy
     # @return [Hash]                A hash with the keys [:status, :headers, :content]
     #                               Returns {:error => "Some error message"} if a failure occurs.
     #                               Returns nil if the request cannot be fulfilled.
-    def handle_request(http_method, url, headers, body)
+    def handle_request(_http_method, _url, _headers, _body)
       { error: 'The handler has not overridden the handle_request method!' }
     end
 
@@ -29,7 +29,7 @@ module Billy
     # @param  [String] body         The body of the HTTP request.
     # @return [Boolean]             True if the Handler can respond to the request, else false.
     #
-    def handles_request?(http_method, url, headers, body)
+    def handles_request?(_http_method, _url, _headers, _body)
       false
     end
 

data/lib/billy/handlers/proxy_handler.rb

@@ -7,20 +7,20 @@ module Billy
   class ProxyHandler
     include Handler
 
-    def handles_request?(method, url, headers, body)
+    def handles_request?(_method, url, _headers, _body)
       !disabled_request?(url)
     end
 
     def handle_request(method, url, headers, body)
       if handles_request?(method, url, headers, body)
-        req = EventMachine::HttpRequest.new(url, {
-            :inactivity_timeout => Billy.config.proxied_request_inactivity_timeout,
-            :connect_timeout => Billy.config.proxied_request_connect_timeout})
+        req = EventMachine::HttpRequest.new(url,
+                                            inactivity_timeout: Billy.config.proxied_request_inactivity_timeout,
+                                            connect_timeout: Billy.config.proxied_request_connect_timeout)
 
         req = req.send(method.downcase, build_request_options(headers, body))
 
         if req.error
-          return { :error => "Request to #{url} failed with error: #{req.error}" }
+          return { error: "Request to #{url} failed with error: #{req.error}" }
         end
 
         if req.response
@@ -28,7 +28,7 @@ module Billy
 
           unless allowed_response_code?(response[:status])
             if Billy.config.non_successful_error_level == :error
-              return { :error => "Request failed due to response status #{response[:status]} for '#{url}' which was not allowed." }
+              return { error: "Request failed due to response status #{response[:status]} for '#{url}' which was not allowed." }
             else
               Billy.log(:warn, "puffing-billy: Received response status code #{response[:status]} for '#{url}'")
             end
@@ -48,14 +48,14 @@ module Billy
     private
 
     def build_request_options(headers, body)
-      headers = Hash[headers.map { |k,v| [k.downcase, v] }]
+      headers = Hash[headers.map { |k, v| [k.downcase, v] }]
       headers.delete('accept-encoding')
 
       req_opts = {
-          :redirects => 0,
-          :keepalive => false,
-          :head => headers,
-          :ssl => { :verify => false }
+        redirects: 0,
+        keepalive: false,
+        head: headers,
+        ssl: { verify: false }
       }
       req_opts[:body] = body if body
       req_opts
@@ -63,9 +63,9 @@ module Billy
 
     def process_response(req)
       response = {
-          :status  => req.response_header.status,
-          :headers => req.response_header.raw,
-          :content => req.response.force_encoding('BINARY') }
+        status: req.response_header.status,
+        headers: req.response_header.raw,
+        content: req.response.force_encoding('BINARY') }
       response[:headers].merge!('Connection' => 'close')
       response[:headers].delete('Transfer-Encoding')
       response
@@ -84,7 +84,7 @@ module Billy
       successful_status?(status)
     end
 
-    def cacheable?(url, headers, status)
+    def cacheable?(url, _headers, status)
       return false unless Billy.config.cache
 
       url = Addressable::URI.parse(url)
@@ -99,7 +99,7 @@ module Billy
     end
 
     def blacklisted_path?(path)
-      !Billy.config.path_blacklist.index{|bl| path.include?(bl)}.nil?
+      !Billy.config.path_blacklist.index { |bl| path.include?(bl) }.nil?
     end
 
     def successful_status?(status)