capybara-chrome_response_headers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40557879afeee7ac4d2e7f78a51091456296d236
+  data.tar.gz: 13c0d5b75a95601b898a7550bc45543429caca99
+SHA512:
+  metadata.gz: 8eb6d069e6a0041632717f1795c7e1bfe52f5601cc330851d803e4b72733b6be71feb9ea30c1f15310dd4105d6fadcd8a710ea13b0f93093ddd5b7610a2a4c5c
+  data.tar.gz: a514f920197fad21066289f813d43d4e7dca6296d4abedd4f1c9bb736c7dc41c395b86d0a2d63e18406386dc8322521cfb24dfc29a8929302051795da2209be7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capybara-chrome_response_headers.gemspec
+gemspec

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2018 Tyler Rick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,59 @@
+# Capybara::ChromeResponseHeaders
+
+Allows you to get HTTP status_code, response_headers, etc. when using Capybara::Selenium::Driver
+just like you can when using Rack::Test.
+
+The [Capybara docs]()https://github.com/teamcapybara/capybara) say:
+
+> Some drivers allow access to response headers and HTTP status code, but this kind of functionality is not provided by some drivers, such as Selenium.
+
+But with this gem, you can have it for your Chrome Selenium driver, too!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-chrome_response_headers'
+```
+
+## Usage
+
+Inspect `status_code` or `response_headers` in your tests to get the HTTP status code or headers,
+respectively, for the current URL (the web page that you last visited or were redirected to).
+
+You can access the `response` information for other assets using `response_for_url`.
+
+Example:
+
+```ruby
+      it do
+        visit '/test/test_redirect?to=/test/basic_page%3Fmy_param=1'
+        expect_uri '/test/basic_page?my_param=1'
+
+        # Since it automatically follows redirects, you can't check if it was a redirect using this
+        expect(status_code).to eq 200
+
+        expect(response_headers["Content-Type"]).to eq "text/html; charset=utf-8"
+        expect(response_headers.keys).to include *["Content-Type", "ETag", "Cache-Control", "Set-Cookie", "X-Meta-Request-Version", "X-Request-Id", "X-Runtime", "X-Frame-Options", "X-Content-Type-Options", "X-XSS-Protection", "Referrer-Policy", "Content-Security-Policy", "Transfer-Encoding"]
+
+        # Could do the same for asset paths, like response_for_url["#{current_host_with_port}/asset/logo.png"]
+        expect(response_for_url["#{current_host_with_port}/users/sign_in"].status).to eq 200
+        expect(response_for_url["#{current_host_with_port}/users/sign_in"].headers).to be_a Hash
+      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:
+
+- https://github.com/seleniumhq/selenium-google-code-issue-archive/issues/141
+- https://github.com/SeleniumHQ/selenium/issues/4976
+- https://github.com/SeleniumHQ/selenium/issues/5194
+- https://groups.google.com/forum/#!msg/selenium-users/mlwxk0jKYtM/gc1ZBwZIRuEJ;context-place=searchin/selenium-users/get$20HTTP$20status$20code%7Csort:date
+- https://stackoverflow.com/questions/6509628/how-to-get-http-response-code-using-selenium-webdriver
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/capybara-chrome_response_headers.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara/chrome_response_headers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-chrome_response_headers.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capybara/chrome_response_headers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-chrome_response_headers"
+  spec.version       = Capybara::ChromeResponseHeaders.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Allows you to get HTTP status_code, response_headers, etc. when using Capybara::Selenium::Driver just like you can when using Rack::Test}
+  #spec.description   = %q{}
+  spec.homepage      = "https://github.com/TylerRick/capybara-chrome_response_headers"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.add_dependency "capybara-chrome_dev_tools", [">= 0.1"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/capybara/chrome_response_headers.rb

@@ -0,0 +1,48 @@
+require "capybara/chrome_response_headers/version"
+
+module Capybara::ChromeResponseHeaders
+  autoload :DriverExtensions, 'capybara/chrome_response_headers/driver_extensions'
+  autoload :DSL,              'capybara/chrome_response_headers/dsl'
+
+  class << self
+    attr_accessor :verbose
+    attr_accessor :ignore_urls
+  end
+  self.verbose = nil
+  # 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)$/
+end
+
+Capybara::Selenium::Driver.class_eval do
+  prepend Capybara::ChromeResponseHeaders::DriverExtensions
+end
+
+Capybara::Session.class_eval do
+  ##
+  # Returns a client for the browser's dev tools protocol. Not supported by all drivers.
+  def status_text
+    driver.status_text
+  end
+
+  # Can't call it request_for because that conflicts with a method by that name in
+  # selenium/webdriver/remote/http/default.rb
+  def request_for_url
+    driver.request_for_url
+  end
+
+  def response_for_url
+    driver.response_for_url
+  end
+
+  # For some reason, current_host includes scheme and host but not port
+  def current_host_with_port
+    uri = URI.parse(current_url)
+    "#{uri.scheme}://#{uri.host}:#{uri.port}"
+  end
+
+end
+
+module Capybara::DSL
+  include Capybara::ChromeResponseHeaders::DSL
+end

data/lib/capybara/chrome_response_headers/driver_extensions.rb

@@ -0,0 +1,71 @@
+module Capybara::ChromeResponseHeaders
+  module DriverExtensions
+    attr_reader :listening_to_network_traffic
+    attr_reader :listener_thread
+
+    attr_reader :request_for_url
+    attr_reader :response_for_url
+
+    def initialize(*)
+      super
+      @request_for_url  = {}
+      @response_for_url = {}
+    end
+
+    def browser
+      super.tap do |browser|
+        listen_to_network_traffic unless @listening_to_network_traffic
+      end
+    end
+
+    def listen_to_network_traffic
+      @listening_to_network_traffic = true
+      chrome = dev_tools
+      chrome.send_cmd "Network.enable"
+
+      chrome.on "Network.requestWillBeSent" do |arg|
+        request = OpenStruct.new(arg["request"])
+        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
+      end
+
+      chrome.on "Network.responseReceived" do |arg|
+        response = OpenStruct.new(arg["response"])
+        next if Capybara::ChromeResponseHeaders.ignore_urls && response.url.match(Capybara::ChromeResponseHeaders.ignore_urls)
+
+        # 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
+      end
+
+      @listener_thread = Thread.new do
+        chrome.listen
+        @listening_to_network_traffic = false
+      end
+    end
+
+    def request
+      #@request_for_url[current_url] or byebug
+      @request_for_url[current_url]
+    end
+
+    def response
+      #@response_for_url[current_url] or byebug
+      @response_for_url[current_url]
+    end
+
+    def response_headers
+      response&.headers
+    end
+
+    def status_code
+      response&.status
+    end
+
+    def status_text
+      response&.statusText
+    end
+  end
+end

data/lib/capybara/chrome_response_headers/dsl.rb

@@ -0,0 +1,11 @@
+module Capybara::ChromeResponseHeaders::DSL
+  [
+    :request_for_url,
+    :response_for_url,
+    :current_host_with_port,
+  ].each do |method|
+    define_method method do |*args, &block|
+      page.send method, *args, &block
+    end
+  end
+end

data/lib/capybara/chrome_response_headers/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: capybara-chrome_response_headers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara-chrome_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- bin/console
+- bin/setup
+- capybara-chrome_response_headers.gemspec
+- lib/capybara/chrome_response_headers.rb
+- lib/capybara/chrome_response_headers/driver_extensions.rb
+- lib/capybara/chrome_response_headers/dsl.rb
+- lib/capybara/chrome_response_headers/version.rb
+homepage: https://github.com/TylerRick/capybara-chrome_response_headers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/capybara-chrome_response_headers
+  source_code_uri: https://github.com/TylerRick/capybara-chrome_response_headers
+  changelog_uri: https://github.com/TylerRick/capybara-chrome_response_headers/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: Allows you to get HTTP status_code, response_headers, etc. when using Capybara::Selenium::Driver
+  just like you can when using Rack::Test
+test_files: []