capybara-chrome_response_headers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40557879afeee7ac4d2e7f78a51091456296d236
-  data.tar.gz: 13c0d5b75a95601b898a7550bc45543429caca99
+  metadata.gz: 37f3924dc1a7c659127afe9cf709b71eb14f2d43
+  data.tar.gz: 04d15916559bb40e738c5096c92f6d0492e6020f
 SHA512:
-  metadata.gz: 8eb6d069e6a0041632717f1795c7e1bfe52f5601cc330851d803e4b72733b6be71feb9ea30c1f15310dd4105d6fadcd8a710ea13b0f93093ddd5b7610a2a4c5c
-  data.tar.gz: a514f920197fad21066289f813d43d4e7dca6296d4abedd4f1c9bb736c7dc41c395b86d0a2d63e18406386dc8322521cfb24dfc29a8929302051795da2209be7
+  metadata.gz: 63ea74a00eee193693886351c3742b564fef85d950276f258eaaa7cbb33da7d13192dd1c054f4bf97203052650f68bfab9b3081201ec51dc0ac3ef2255784e90
+  data.tar.gz: f28e54e082305b093909b14a99c7d02bf017d076877c232c7148aefcdb06f77d8c83dbbc8e33b2f0724bd6ce933fba05ea1edcbcbb9ead23276816d097ec8f00

data/Readme.md

@@ -43,10 +43,45 @@ Example:
       end
 ```
 
+## Tracing
+
+To have it show a trace of all requests and/or responses that are made from the web pages you are interacting with, enable these settings, respectively:
+
+```
+Capybara::ChromeResponseHeaders.trace_requests  = true
+Capybara::ChromeResponseHeaders.trace_responses = true
+```
+
+The output for responses is something like this:
+```
+Response for http://127.0.0.1:40359/users/sign_in: 200 OK
+Response for http://127.0.0.1:40359/admin: 200 OK
+```
+
+By default, it tries to filter out requests for assets. (`Capybara::ChromeResponseHeaders.ignore_urls` is set to `/\.(js|css|png|gif|jpg)$/`.)
+
+You can turn off this filtering by setting `Capybara::ChromeResponseHeaders.ignore_urls = nil`, or
+set it to a different Regexp pattern to ignore.
+
+If you want other behavior to happen on each request or response, you should be able to add it via `dev_tools` (a [ChromeRemote]((https://github.com/cavalle/chrome_remote) instance):
+
+```ruby
+      dev_tools.on "Network.requestWillBeSent" do |arg|
+        request = OpenStruct.new(arg["request"])
+        puts "Requesting #{request.url}"
+      end
+
+      dev_tools.on "Network.responseReceived" do |arg|
+        response = OpenStruct.new(arg["response"])
+        puts %(Response for #{response.url}"
+      end
+```
+
 ## Why?
 
-Because it's useful to be able to check the HTTP status code, and many people have wanted that
-ability, and because the WebDriver maintainers have no intention of adding this feature:
+Because it can be useful to be able to check the HTTP status code in tests.  Many people have wanted
+that ability. And the WebDriver maintainers have no intention of adding this feature. See, for
+example:
 
 - https://github.com/seleniumhq/selenium-google-code-issue-archive/issues/141
 - https://github.com/SeleniumHQ/selenium/issues/4976

data/capybara-chrome_response_headers.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.3.0"
-  spec.add_dependency "capybara-chrome_dev_tools", [">= 0.1"]
+  spec.add_dependency "capybara-chrome_dev_tools", [">= 0.2"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/capybara/chrome_response_headers.rb

@@ -6,9 +6,13 @@ module Capybara::ChromeResponseHeaders
 
   class << self
     attr_accessor :verbose
+    attr_accessor :trace_requests
+    attr_accessor :trace_responses
     attr_accessor :ignore_urls
   end
-  self.verbose = nil
+  self.verbose = 0
+  self.trace_requests = false
+  self.trace_responses = false
   # The default is to try to ignore asset files so that hopefully what's left is just HTML/API
   # requests.
   self.ignore_urls = /\.(js|css|png|gif|jpg)$/

data/lib/capybara/chrome_response_headers/driver_extensions.rb

@@ -14,7 +14,9 @@ module Capybara::ChromeResponseHeaders
 
     def browser
       super.tap do |browser|
-        listen_to_network_traffic unless @listening_to_network_traffic
+        if Capybara::ChromeDevTools.enabled and !@listening_to_network_traffic
+          listen_to_network_traffic
+        end
       end
     end
 
@@ -28,7 +30,7 @@ module Capybara::ChromeResponseHeaders
         next if Capybara::ChromeResponseHeaders.ignore_urls && request.url.match(Capybara::ChromeResponseHeaders.ignore_urls)
 
         @request_for_url[request.url] = request
-        puts "Requesting #{request.url}" if Capybara::ChromeResponseHeaders.verbose
+        puts "Requesting #{request.url}" if Capybara::ChromeResponseHeaders.trace_requests
       end
 
       chrome.on "Network.responseReceived" do |arg|
@@ -37,7 +39,7 @@ module Capybara::ChromeResponseHeaders
 
         # TODO: Use/return a Rack::Response like Rack::Test does
         @response_for_url[response.url] = response
-        puts %(Response for #{response.url}: #{response.status} #{response.statusText}) if Capybara::ChromeResponseHeaders.verbose
+        puts %(Response for #{response.url}: #{response.status} #{response.statusText}) if Capybara::ChromeResponseHeaders.trace_responses
       end
 
       @listener_thread = Thread.new do

data/lib/capybara/chrome_response_headers/version.rb

@@ -1,7 +1,7 @@
 module Capybara
   module ChromeResponseHeaders
     def self.version
-      "0.1.0"
+      "0.2.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-chrome_response_headers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Rick
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement