show_me_the_cookies 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b786abed42a08a5f1ca008e722475ab215db4cac
-  data.tar.gz: '029a71131e14ab735d7886e971b956f05f0c6adc'
+  metadata.gz: 40ab03246d1bebdccb7c79ed98ab3732f7aac255
+  data.tar.gz: 9a050a1f8521abc44be9a3d369c636028c7d38f1
 SHA512:
-  metadata.gz: 39f69eaac7f76adeca3ffaf1bfac7f051de22390d9d334d3a0d1df78be92ead0f850d834b8ab292e46670462defdcb84b34762396ac851ada1e194c837c6c13f
-  data.tar.gz: f1fde28a446fd7ad542505734abac440febedc3fce610c8382b6bb0fac0db869c57110375c61e583e9cd89c33b076bd5f0b343543836aca557ec27952fd42aa5
+  metadata.gz: 74558199adf4ad24cd6f137e76d640f0ef473ae5745cfdd0b7be72c2947da4a68fbfe659ad2fb8d82f8d0db3357965e047ffb1bb45a4d2379d43d3b674e20af2
+  data.tar.gz: eb0f44cf2689edea5881a3a3c25df42120f9ba8991428dd62930782e5200868eb94976372d3c40e1abc70ac1be350a658a4468d33cd6e5552bd1e1f572bbb403

data/Changelog.md

@@ -0,0 +1,24 @@
+# 5.0
+
+## Capybara-webkit removed
+
+Due to obsolescence and maintenance difficulty.
+Setting up capybara-webkit and qt has never been fun, but now it's getting
+silly: According to the [capybara-webkit wiki](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit) Qt has removed the necessary webkit bindings, and homebrew has removed the old version of qt that still had them.
+
+New / current projects should switch to headless Chrome or Firefox with webdriver, which will work with the existing adapters, but if you need the webkit driver for legacy apps stick with version 4, or copy the adapter from version 4 into your app's test support code.
+
+## Chrome and Firefox driver names
+
+Drivers are now registered matching the names used by [capybara](https://github.com/teamcapybara/capybara):
+
+:selenium => Selenium driving Firefox
+:selenium_headless => Selenium driving Firefox in a headless configuration
+:selenium_chrome => Selenium driving Chrome
+:selenium_chrome_headless => Selenium driving Chrome in a headless configuration
+
+# 4.0
+
+Changes some cookie escaping logic & supports capybara 3.
+
+For more information see the release commit: [cc0a1106d9cb00827aeda3301f5b75d6d10e80ba](https://github.com/nruth/show_me_the_cookies/commit/cc0a1106d9cb00827aeda3301f5b75d6d10e80ba)

data/Gemfile

@@ -7,9 +7,8 @@ gem 'rake' # for releases
 
 group :test do
   gem 'rspec', '~> 3.0'
-  gem 'poltergeist', git: 'https://github.com/teampoltergeist/poltergeist', ref: 'f822d3a'
+  gem 'poltergeist'
   gem 'sinatra'
   gem 'selenium-webdriver'
   gem 'chromedriver-helper' # chromedriver installer
-  gem 'capybara-webkit'
 end

data/Gemfile.lock

@@ -1,94 +1,85 @@
-GIT
-  remote: https://github.com/teampoltergeist/poltergeist
-  revision: f822d3acbe110669420c311484e3dfafa2d31e18
-  ref: f822d3a
-  specs:
-    poltergeist (1.17.0)
-      capybara (>= 2.1, < 4)
-      cliver (~> 0.3.1)
-      websocket-driver (>= 0.2.0)
-
 PATH
   remote: .
   specs:
-    show_me_the_cookies (4.0.0)
+    show_me_the_cookies (5.0.0)
       capybara (>= 2, < 4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     archive-zip (0.11.0)
       io-like (~> 0.3.0)
-    capybara (3.0.1)
+    capybara (3.13.2)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
-      xpath (~> 3.0)
-    capybara-webkit (1.15.0)
-      capybara (>= 2.3, < 4.0)
-      json
+      regexp_parser (~> 1.2)
+      xpath (~> 3.2)
     childprocess (0.9.0)
       ffi (~> 1.0, >= 1.0.11)
-    chromedriver-helper (1.2.0)
+    chromedriver-helper (2.1.0)
       archive-zip (~> 0.10)
       nokogiri (~> 1.8)
     cliver (0.3.2)
     diff-lcs (1.3)
-    ffi (1.9.23)
+    ffi (1.10.0)
     io-like (0.3.0)
-    json (2.1.0)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
-    mustermann (1.0.2)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    public_suffix (3.0.2)
-    rack (2.0.4)
-    rack-protection (2.0.1)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    mustermann (1.0.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    poltergeist (1.18.1)
+      capybara (>= 2.1, < 4)
+      cliver (~> 0.3.1)
+      websocket-driver (>= 0.2.0)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
       rack
-    rack-test (1.0.0)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (12.3.2)
+    regexp_parser (1.3.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubyzip (1.2.1)
-    selenium-webdriver (3.11.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubyzip (1.2.2)
+    selenium-webdriver (3.141.0)
       childprocess (~> 0.5)
-      rubyzip (~> 1.2)
-    sinatra (2.0.1)
+      rubyzip (~> 1.2, >= 1.2.2)
+    sinatra (2.0.5)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.1)
+      rack-protection (= 2.0.5)
       tilt (~> 2.0)
-    tilt (2.0.8)
+    tilt (2.0.9)
     websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.3)
-    xpath (3.0.0)
+    xpath (3.2.0)
       nokogiri (~> 1.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  capybara-webkit
   chromedriver-helper
-  poltergeist!
+  poltergeist
   rake
   rspec (~> 3.0)
   selenium-webdriver
@@ -96,4 +87,4 @@ DEPENDENCIES
   sinatra
 
 BUNDLED WITH
-   1.16.0
+   1.16.6

data/README.md

@@ -2,10 +2,11 @@
 
 [![Build Status](https://semaphoreapp.com/api/v1/projects/9a0dc444-fd04-4187-95a7-7a07abecbad7/201807/shields_badge.png)](https://semaphoreapp.com/nruth/show_me_the_cookies) [![Gem Version](https://badge.fury.io/rb/show_me_the_cookies.svg)](http://badge.fury.io/rb/show_me_the_cookies)
 
-Some helpers for poking around at your Capybara driven browser's cookies in integration tests. Should have been called capybara-cookies if you go by the [rubygems naming guide](http://guides.rubygems.org/name-your-gem/).
+Some helpers for poking around at your Capybara driven browser's cookies in integration tests.
 
-Provides drivers for rack-test, [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver),  [Poltergeist](https://github.com/teampoltergeist/poltergeist) (PhantomJS) and [capybara-webkit](https://github.com/thoughtbot/capybara-webkit).
-You may add new drivers for your application by implementing an adapter class and calling ShowMeTheCookies.register_adapter in your test code (e.g. a spec/support file).
+Provides drivers for rack-test, [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver), and [Poltergeist](https://github.com/teampoltergeist/poltergeist) (PhantomJS).
+
+You can add new drivers to  your application by implementing an adapter class and calling ShowMeTheCookies.register_adapter in your test code (e.g. a spec/support file). But in that case you might prefer to skip this gem and use your driver's api directly.
 
 ## API
 

data/lib/show_me_the_cookies/version.rb

@@ -1,5 +1,5 @@
 # change gem version here then use bundler's rake tasks to make a new release
 # follow semantic versioning http://guides.rubygems.org/patterns/#semantic-versioning
 module ShowMeTheCookies
-  VERSION = '4.0.0'
+  VERSION = '5.0.0'
 end

data/lib/show_me_the_cookies.rb

@@ -3,7 +3,6 @@ module ShowMeTheCookies
   require 'show_me_the_cookies/adapters/poltergeist'
   require 'show_me_the_cookies/adapters/selenium'
   require 'show_me_the_cookies/adapters/selenium_chrome'
-  require 'show_me_the_cookies/adapters/webkit'
 
   @adapters = {}
   class << self
@@ -19,11 +18,11 @@ module ShowMeTheCookies
 
   # to register your own adapter/driver do this in your test setup code somewhere e.g. spec/support
   register_adapter(:selenium, ShowMeTheCookies::Selenium)
+  register_adapter(:selenium_headless, ShowMeTheCookies::Selenium)
   register_adapter(:selenium_chrome, ShowMeTheCookies::SeleniumChrome)
+  register_adapter(:selenium_chrome_headless, ShowMeTheCookies::SeleniumChrome)
   register_adapter(:rack_test, ShowMeTheCookies::RackTest)
   register_adapter(:poltergeist, ShowMeTheCookies::Poltergeist)
-  register_adapter(:webkit, ShowMeTheCookies::Webkit)
-  register_adapter(:webkit_debug, ShowMeTheCookies::Webkit)
 
   # puts a string summary of the cookie
   def show_me_the_cookie(cookie_name)

data/spec/drivers/{selenium_firefox_spec.rb → selenium_chrome_headless_spec.rb}

@@ -1,18 +1,8 @@
 require 'spec_helper'
 require 'shared_examples_for_api'
-require 'selenium-webdriver'
 
-
-
-Capybara.register_driver :selenium do |app|
-  options = Selenium::WebDriver::Firefox::Options.new(args: ['-headless'])
-  Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
-end
-
-RSpec.describe 'Selenium Webdriver Firefox', type: :feature do
-  before(:each) do
-    Capybara.current_driver = :selenium
-  end
+RSpec.describe 'Selenium Webdriver Headless Chrome', type: :feature,
+  driver: :selenium_chrome_headless do
 
   describe 'the testing rig' do
     it 'should load the sinatra app' do

data/spec/drivers/selenium_chrome_spec.rb

@@ -1,23 +1,8 @@
 require 'spec_helper'
 require 'shared_examples_for_api'
-require "selenium/webdriver"
 
-Capybara.register_driver :selenium_chrome do |app|
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-    chromeOptions: { args: %w(headless disable-gpu) },
-  )
-
-  Capybara::Selenium::Driver.new(
-    app,
-    browser: :chrome,
-    desired_capabilities: capabilities,
-  )
-end
-
-RSpec.describe 'Selenium Webdriver Chrome', type: :feature do
-  before(:each) do
-    Capybara.current_driver = :selenium_chrome
-  end
+RSpec.describe 'Selenium Webdriver Chrome', type: :feature,
+  driver: :selenium_chrome do
 
   describe 'the testing rig' do
     it 'should load the sinatra app' do

data/spec/drivers/selenium_headless_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'shared_examples_for_api'
+
+RSpec.describe 'Selenium Webdriver Firefox Headless', type: :feature,
+  driver: :selenium_headless do
+
+  describe 'the testing rig' do
+    it 'should load the sinatra app' do
+      visit '/'
+      expect(page).to have_content('Cookie setter ready')
+    end
+  end
+
+  it_behaves_like 'the API'
+
+  it 'raises an exception when writing a cookie before visiting the app' do
+    expect { create_cookie('choc', 'milk') }.to(
+      raise_error(ShowMeTheCookies::SeleniumSiteNotVisitedError)
+    )
+  end
+end

data/spec/drivers/selenium_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'shared_examples_for_api'
+
+RSpec.describe 'Selenium Webdriver Firefox', type: :feature, driver: :selenium do
+  describe 'the testing rig' do
+    it 'should load the sinatra app' do
+      visit '/'
+      expect(page).to have_content('Cookie setter ready')
+    end
+  end
+
+  it_behaves_like 'the API'
+
+  it 'raises an exception when writing a cookie before visiting the app' do
+    expect { create_cookie('choc', 'milk') }.to(
+      raise_error(ShowMeTheCookies::SeleniumSiteNotVisitedError)
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
 require 'capybara/rspec'
 
+# load chromedriver-helper so it sets the path to the chromedriver executable
+# otherwise get errors like
+# "unable to connect to chromedriver 127.0.0.1:9515 (Selenium::WebDriver::Error::WebDriverError)" 
+# when Selenium runs the wrong executable
+require 'chromedriver-helper'
+
 # puma dependency unnecessary for this small project, just use stdlib
 Capybara.server = :webrick
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: show_me_the_cookies
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Nicholas Rutherford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -38,6 +38,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -47,16 +48,16 @@ files:
 - lib/show_me_the_cookies/adapters/rack_test.rb
 - lib/show_me_the_cookies/adapters/selenium.rb
 - lib/show_me_the_cookies/adapters/selenium_chrome.rb
-- lib/show_me_the_cookies/adapters/webkit.rb
 - lib/show_me_the_cookies/version.rb
 - show_me_the_cookies.gemspec
 - spec/app/set_cookie.rb
 - spec/drivers/poltergeist_spec.rb
 - spec/drivers/rack-test_spec.rb
+- spec/drivers/selenium_chrome_headless_spec.rb
 - spec/drivers/selenium_chrome_spec.rb
-- spec/drivers/selenium_firefox_spec.rb
+- spec/drivers/selenium_headless_spec.rb
+- spec/drivers/selenium_spec.rb
 - spec/drivers/unknown_driver_spec.rb
-- spec/drivers/webkit_spec.rb
 - spec/shared_examples_for_api.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nruth/show_me_the_cookies
@@ -87,9 +88,10 @@ test_files:
 - spec/app/set_cookie.rb
 - spec/drivers/poltergeist_spec.rb
 - spec/drivers/rack-test_spec.rb
+- spec/drivers/selenium_chrome_headless_spec.rb
 - spec/drivers/selenium_chrome_spec.rb
-- spec/drivers/selenium_firefox_spec.rb
+- spec/drivers/selenium_headless_spec.rb
+- spec/drivers/selenium_spec.rb
 - spec/drivers/unknown_driver_spec.rb
-- spec/drivers/webkit_spec.rb
 - spec/shared_examples_for_api.rb
 - spec/spec_helper.rb

data/lib/show_me_the_cookies/adapters/webkit.rb

@@ -1,59 +0,0 @@
-module ShowMeTheCookies
-  class Webkit
-    def initialize(driver)
-      @driver = driver
-    end
-
-    def get_me_the_cookie(name)
-      cookie = cookie_jar.find(name)
-      translate(cookie) unless cookie.nil?
-    end
-
-    def get_me_the_cookies
-      cookies.each.map(&method(:translate))
-    end
-
-    def expire_cookies
-      cookies.each do |cookie|
-        delete_cookie(cookie.name) if cookie.expires.nil?
-      end
-    end
-
-    # Since QTWebkit doesn't seem to offer deletion, clearing all and re-setting the rest seems to be it
-    def delete_cookie(name)
-      old_cookies = cookies
-      @driver.clear_cookies
-      old_cookies.each do |cookie|
-        @driver.set_cookie(cookie) unless cookie.name == name.to_s
-      end
-    end
-
-    def create_cookie(name, value, options)
-      host = options.delete(:domain) || (Capybara.app_host ? URI(Capybara.app_host).host : '127.0.0.1')
-      puts "Webkit create_cookie options not supported: #{options.inspect}" if options && (options != {})
-      @driver.set_cookie("#{name}=#{Rack::Utils.escape(value)}; domain=#{host}")
-    end
-
-    private
-
-    # see https://github.com/thoughtbot/capybara-webkit/blob/master/lib/capybara/webkit/cookie_jar.rb
-    def cookie_jar
-      @driver.cookies
-    end
-
-    def cookies
-      cookie_jar.send("cookies")
-    end
-
-    def translate(cookie)
-      {
-        :name => cookie.name,
-        :domain => cookie.domain,
-        :value => cookie.value,
-        :expires => (cookie.expires rescue nil),
-        :path => cookie.path,
-        :secure => cookie.secure.nil? ? false : true
-      }
-    end
-  end
-end

data/spec/drivers/webkit_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-require 'shared_examples_for_api'
-require 'capybara-webkit'
-
-Capybara::Webkit.configure do |config|
-  config.allow_url("subdomain.lvh.me")
-end
-
-RSpec.describe 'Webkit', type: :feature do
-  before(:each) do
-    Capybara.current_driver = :webkit
-  end
-
-  describe 'the testing rig' do
-    it 'should load the sinatra app' do
-      visit '/'
-      expect(page).to have_content('Cookie setter ready')
-    end
-  end
-
-  it_behaves_like 'the API'
-end