show_me_the_cookies 2.4.0 → 2.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjEyNjJhYzcwMDI4MTc5MTQ0OWJmODEwNWMwYmQxMzI0YzY0NjhhMA==
+    ZjRjNmQ2OGNiNGIzMzMzYjI4Y2FkNzM5Yzk0MjkyYWE5YTRhMTIxMg==
   data.tar.gz: !binary |-
-    MzlmMDQyOTkzNzViYmQxYWEyNTQyMzVkNDE0Mzc0OTg2YjBlMmYzYw==
+    MjliMmU5ZDJhOGJhMmJjY2YxNDc3OTljNWQyYWZlZTg1MGNmOTk1Mg==
 SHA512:
   metadata.gz: !binary |-
-    MDU4NDM0MTIzYjE3MzE5MzFjYzMyNDNiNGYxNTU0NzBkOWNmNjIyNmUxYzVk
-    ZjBlMTEwZTcyMzgxMjhiOGEyOWE1MjM1MTNjNmQ2ZmM4YWQwNzk1NDI5MjUw
-    M2Q0ODk2OTM4YmM4YzJmNWEzMmJlNWRiMWQ4YzcwZGFjZjI3ODQ=
+    YWEzNmJhMjA3YzE1ZmM5YWVkYzM2NDU2ZGVhMGI4M2IyZDBmYTdlOWUwMjc2
+    ZTEwMWZhZTQ1ZjE2MGU4ZWJjMzZkZDJjZDE4ZGUxZDhkNGRmZjYwOTIyMGU1
+    NTMyNWM3MWJmOTE3MGNkZGVmMGM3NzdhNzQ5ZmU5YWZiNWIwNjk=
   data.tar.gz: !binary |-
-    ZjRlZmNlYjNhZDFmZGRlMGZjN2MzNDQwYTJkYjcwMmRkNDk3OWZmZTgyYTZl
-    NGVlZWY0OWZjNjU0Nzc2ZmMwMGRjYWNiY2ViYTc2YTdlOTkxNGNlNTM5N2Qy
-    NmZkYzBhYWE2NGUyM2NlMDAyM2NlNWVhMTRmYmVhODhiMjExNjY=
+    M2ZhOTAyNGRkN2EyYmI3MjQ5N2EwNzlmOTYwNzRlZjQ4NmE4ZThiYWE3MWMz
+    YjgwMzRmZTQwOGFlYTYzNTdiNDUzZWI2NWNjY2JmYzdmMjBhMzRlOGQ4NjZj
+    OTNiYmM4NGRkMjdmODY0MjM2ZmEzNjAwNDVmM2NlOGIzMzBlYWU=

data/Gemfile

@@ -2,7 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in show_me_the_cookies.gemspec
 gemspec
-
-group :development do
- gem "bundler",  ">=1.0.15"
-end

data/README.md

@@ -1,10 +1,10 @@
 # Show me the cookies
 
-![Build status](https://semaphoreapp.com/api/v1/projects/9a0dc444-fd04-4187-95a7-7a07abecbad7/201807/shields_badge.png)
+[![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.
 
-Supports Capybara's bundled drivers (rack-test, Selenium Webdriver) and Poltergeist (PhantomJS).
+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).
 
 ## API
@@ -117,6 +117,10 @@ for example
 
 which indicates how to use the selenium adapter with a custom selenium testing profile.
 
+## Usage / License / Support
+
+This software is provided free of charge for use at your own risk, see [MIT License](http://opensource.org/licenses/MIT). If you have trouble making the software work try posting on stackoverflow. If you find a bug or don't understand the documentation open a [github issue](https://github.com/nruth/show_me_the_cookies/issues).
+
 ## Contributing
 
 Bugs should be raised in the [issue tracker](https://github.com/nruth/show_me_the_cookies/issues).
@@ -126,6 +130,23 @@ to your repository branch. Please run the tests, and add new ones.
 
 New drivers will be selectively accepted. Be sure that the api spec passes. If you prefer to keep the driver in your own repository send me the address and I'll add a link in the docs.
 
+### Development and running the tests
+
+    bundle install
+    bundle exec rspec
+
+If you get DNS lookup failures try this in the terminal
+
+    host lvh.me
+
+You should get a quick response of 
+
+    lvh.me has address 127.0.0.1
+
+If you don't see this your router or similar is interfering with the DNS for security reasons, blocking a loopback lookup result.
+You can get around this by changing your DNS server to [Google's public DNS service](https://developers.google.com/speed/public-dns/) 8.8.8.8 to run the tests. You can turn this off again afterwards.
+Alternatively you can add an /etc/hosts entry looping back lvh.me to 127.0.0.1.
+
 ## History, Credits, and Acknowledgements
 
 [Contributors](https://github.com/nruth/show_me_the_cookies/contributors)

data/lib/show_me_the_cookies.rb

@@ -54,8 +54,11 @@ module ShowMeTheCookies
     current_driver_adapter.expire_cookies
   end
 
-  def create_cookie(name, value)
-    current_driver_adapter.create_cookie(name, value)
+  # can take the following options:
+  # :path
+  # :domain
+  def create_cookie(name, value, options = {})
+    current_driver_adapter.create_cookie(name, value, options)
   end
 
 private

data/lib/show_me_the_cookies/adapters/poltergeist.rb

@@ -23,8 +23,9 @@ class ShowMeTheCookies::Poltergeist
     @browser.remove_cookie(name.to_s)
   end
 
-  def create_cookie(name, value)
-    @driver.set_cookie(name, value)
+  def create_cookie(name, value, options)
+    # see: https://github.com/jonleighton/poltergeist#manipulating-cookies
+    @driver.set_cookie(name, value, options)
   end
 
 private

data/lib/show_me_the_cookies/adapters/rack_test.rb

@@ -26,8 +26,11 @@ class ShowMeTheCookies::RackTest
     end
   end
 
-  def create_cookie(name, value)
-    cookie_jar[name] = value
+  def create_cookie(name, value, options)
+    cookie_raw = "#{name}=#{Rack::Utils.escape(value)}"
+    (cookie_raw = "#{cookie_raw}; domain=#{options[:domain]}") if options.has_key?(:domain)
+    (cookie_raw = "#{cookie_raw}; path=#{options[:path]}")     if options.has_key?(:path)
+    cookie_jar.merge(cookie_raw)
   end
 
 private

data/lib/show_me_the_cookies/adapters/selenium.rb

@@ -22,13 +22,13 @@ class ShowMeTheCookies::Selenium
     @browser.manage.delete_cookie(cookie_name)
   end
 
-  def create_cookie(cookie_name, cookie_value)
+  def create_cookie(cookie_name, cookie_value, options)
     unless is_on_the_page?
       raise ShowMeTheCookies::Selenium::SiteNotVisitedError.new(
         "Can't set a cookie on about:blank. Visit a url in your app first."
       )
     end
-    @browser.manage.add_cookie(name: cookie_name, value: cookie_value)
+    @browser.manage.add_cookie({name: cookie_name, value: cookie_value}.merge(options))
   end
 
 private

data/lib/show_me_the_cookies/adapters/webkit.rb

@@ -28,8 +28,10 @@ class ShowMeTheCookies::Webkit
     end
   end
 
-  def create_cookie(name, value)
-    @browser.set_cookie("#{name}=#{value}; domain=127.0.0.1")
+  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 != {})
+    @browser.set_cookie("#{name}=#{value}; domain=#{host}")
   end
 
   private

data/lib/show_me_the_cookies/version.rb

@@ -1,3 +1,3 @@
 module ShowMeTheCookies
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/spec/app/set_cookie.rb

@@ -27,3 +27,8 @@ get '/set_stale/:key/:value' do
   response.set_cookie params[:key], {:value => params[:value], :path => '/', :expires => Time.now}
   "Setting #{params[:key]}=#{params[:value]}"
 end
+
+get '/set_with_domain/:key/:value' do
+  response.set_cookie params[:key], {:value => params[:value], :path => '/', :domain => '.lvh.me'}
+  "Setting #{params[:key]}=#{params[:value]}"
+end

data/spec/shared_examples_for_api.rb

@@ -1,19 +1,5 @@
 shared_examples "the API" do
 
-  def cookies_should_contain(key, value)
-    key_present = get_me_the_cookies.any? {|c| c[:name] == key}
-    value_present = get_me_the_cookies.any? {|c| c[:value] == value}
-    msg = "Cookie not found: #{key}=#{value} in #{get_me_the_cookies.inspect}"
-    (key_present and value_present).should be_true, msg
-  end
-
-  def cookies_should_not_contain(key, value)
-    key_present = get_me_the_cookies.any? {|c| c[:name] == key}
-    value_present = get_me_the_cookies.any? {|c| c[:value] == value}
-    msg = "Unwanted cookie found: #{key}=#{value} in #{get_me_the_cookies.inspect}"
-    (key_present and value_present).should be_false, msg
-  end
-
   describe "for getting cookie hashes" do
     describe "get_me_the_cookie" do
       it "returns the cookie hash" do
@@ -56,6 +42,7 @@ shared_examples "the API" do
     end
   end
 
+
   describe "for manipulating cookies" do
     describe "delete_cookie(cookie_name)" do
       it "deletes a k/v pair from the session cookie" do
@@ -80,20 +67,38 @@ shared_examples "the API" do
     describe "create_cookie(cookie_name, cookie_value)" do
       it "creates a cookie" do
         # need to first hit a page to set a cookie (selenium)
-        visit('/')
-        create_cookie('choc', 'milk')
-        visit '/get/choc' 
-        cookies_should_contain('choc', 'milk')
+        visit("/")
+        create_cookie("choc", "milk")
+        visit "/get/choc"
+        cookies_should_contain("choc", "milk")
         page.should have_content("Got cookie choc=milk")
       end
 
       it "accepts symbols" do
-        visit('/')
+        # need to first hit a page to set a cookie (selenium)
+        visit("/")
         create_cookie(:choc, :milk)
-        visit '/get/choc'
-        cookies_should_contain('choc', 'milk')
+        visit "/get/choc"
+        cookies_should_contain("choc", "milk")
         page.should have_content("Got cookie choc=milk")
       end
+
+      it "creates a cookie with path and domain" do
+        # need to first hit a page to set a cookie (selenium)
+        visit("/")
+        create_cookie("choc", "milk", path: "/", domain: ".lvh.me")
+        cookies_should_contain("choc", "milk")
+
+        visit("/get/choc")
+        page.should have_content("Got cookie choc=milk")
+
+        visit '/set_with_domain/choc/doublemilk'
+        cookies_should_contain("choc", "doublemilk")
+        cookies_should_not_contain('choc', 'milk')
+
+        visit("/get/choc")
+        page.should have_content("Got cookie choc=doublemilk")
+      end
     end
 
     describe "expire_cookies" do

data/spec/spec_helper.rb

@@ -6,4 +6,21 @@ Capybara.app = Sinatra::Application
 require 'show_me_the_cookies'
 RSpec.configure do |config|
   config.include ShowMeTheCookies, :type => :feature
+end
+
+Capybara.server_port = 36363
+Capybara.app_host = "http://subdomain.lvh.me:#{Capybara.server_port}"
+
+def cookies_should_contain(key, value)
+  key_present = get_me_the_cookies.any? {|c| c[:name] == key}
+  value_present = get_me_the_cookies.any? {|c| c[:value] == value}
+  msg = "Cookie not found: #{key}=#{value} in #{get_me_the_cookies.inspect}"
+  (key_present and value_present).should be_true, msg
+end
+
+def cookies_should_not_contain(key, value)
+  key_present = get_me_the_cookies.any? {|c| c[:name] == key}
+  value_present = get_me_the_cookies.any? {|c| c[:value] == value}
+  msg = "Unwanted cookie found: #{key}=#{value} in #{get_me_the_cookies.inspect}"
+  (key_present and value_present).should be_false, msg
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: show_me_the_cookies
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Nicholas Rutherford