show_me_the_cookies 1.1.4 → 2.0.0

data/README.md

@@ -2,8 +2,8 @@
 
 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 adapters for other
-drivers may be added (at time of writing Akephalos is also available).
+Supports Capybara's bundled drivers (rack-test, Selenium Webdriver) and Poltergeist (PhantomJS).
+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
 
@@ -27,20 +27,6 @@ drivers may be added (at time of writing Akephalos is also available).
       # removes session cookies and expired persistent cookies
       expire_cookies
 
-## Contributing
-
-If you find this useful, the best way to say thanks is to take a poke around the code and send feedback upstream.
-Bugs / requests / suggestions should be raised in the [Github issues](https://github.com/nruth/show_me_the_cookies/issues) tracker.
-
-Code contributions should be sent by github pull request, or contact [me](https://github.com/nruth) with a link
-to your repository branch.
-Patches should be small, isolated, testable, and preferably tested.
-
-New drivers should be accompanied by a passing API spec.
-Driver-specific edge cases should not be added to the shared spec unless thought to be of general interest.
-API spec should not be changed because something doesn't work – try to fix the driver, or make an addon gem.
-
-More tests are welcome.
 
 ## Installation
 
@@ -54,7 +40,7 @@ Add to your gemfile's test group:
 in step_helper or your support directory:
 
     RSpec.configure do |config|
-      config.include ShowMeTheCookies, :type => :request
+      config.include ShowMeTheCookies, :type => :feature
     end
 
 ### Example usage
@@ -116,6 +102,20 @@ Install by loading the gem and adding the following to your stepdefs or support
       expire_cookies
     end
 
+
+## Contributing
+
+If you find this useful some ways to say thanks are reviewing the code and/or kind words or other feedback by Github message.
+Bugs should be raised in the [issue tracker](https://github.com/nruth/show_me_the_cookies/issues).
+
+Code contributions should be sent as Github pull requests, or by messaging [me](https://github.com/nruth) with a link
+to your repository branch. Please run the tests, and add new ones.
+
+New drivers are unlikely to be accepted at this stage. You can instead add them to your application's test setup. 
+If you come up with an interesting new driver/adapter mail me with a link to a repository or gist and I'll link to it here.
+Hopefully the API shared-spec will come in useful when working on your own driver.
+
+
 ## History, Credits, and Acknowledgements
 
 [Contributors](https://github.com/nruth/show_me_the_cookies/contributors)

data/lib/show_me_the_cookies.rb

@@ -1,8 +1,22 @@
 module ShowMeTheCookies
-  require 'show_me_the_cookies/rack_test'
-  require 'show_me_the_cookies/selenium'
-  require 'show_me_the_cookies/akephalos'
-  require 'show_me_the_cookies/poltergeist'
+  require 'show_me_the_cookies/adapters/rack_test'
+  require 'show_me_the_cookies/adapters/selenium'
+
+  @adapters = {}
+  class << self
+    attr_reader :adapters
+    
+    # Register your own capybara-driver cookie adapter. 
+    # Use the same name as the one Capybara does to identify that driver.
+    # Implement the interface of spec/shared_examples_for_api, as seen in lib/show_me_the_cookies/drivers
+    def register_adapter(driver, adapter)
+      adapters[driver] = adapter
+    end
+  end
+
+  # 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(:rack_test, ShowMeTheCookies::RackTest)
 
   # puts a string summary of the cookie
   def show_me_the_cookie(cookie_name)
@@ -37,19 +51,10 @@ module ShowMeTheCookies
   end
 
 private
-  def adapters
-    @@drivers ||= {
-      :selenium     => ShowMeTheCookies::Selenium,
-      :rack_test    => ShowMeTheCookies::RackTest,
-      :akephalos    => ShowMeTheCookies::Akephalos,
-      :poltergeist  => ShowMeTheCookies::Poltergeist
-    }
-  end
-
   def current_driver_adapter
-    adapter = adapters[Capybara.current_driver]
+    adapter = ShowMeTheCookies.adapters[Capybara.current_driver]
     if adapter.nil?
-      if driver_uses_selenium?
+      if driver_uses_selenium? # to support custom selenium drivers / configs (whatever they are?)
         adapter = adapters[:selenium]
       else
         raise("Unsupported driver #{Capybara.current_driver}, use one of #{adapters.keys}")

data/lib/show_me_the_cookies/{selenium.rb → adapters/selenium.rb}

@@ -1,7 +1,6 @@
 class ShowMeTheCookies::Selenium
   def initialize(driver)
     @browser = driver.browser
-    self
   end
 
   def get_me_the_cookie(cookie_name)

data/lib/show_me_the_cookies/version.rb

@@ -1,3 +1,3 @@
 module ShowMeTheCookies
-  VERSION = "1.1.4"
+  VERSION = "2.0.0"
 end

data/show_me_the_cookies.gemspec

@@ -17,9 +17,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency('capybara', '~> 1.0')
+  s.add_dependency('capybara', '~> 2.0')
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'sinatra'
-  s.add_development_dependency 'akephalos2'
-  s.add_development_dependency 'poltergeist'
 end

data/spec/{request → drivers}/rack-test_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'shared_examples_for_api'
 
-describe "RackTest", :type => :request do
+describe "RackTest", :type => :feature do
   before(:each) do
     Capybara.current_driver = :rack_test
   end

data/spec/{request → drivers}/selenium_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'shared_examples_for_api'
 
-describe "Selenium Webdriver", :type => :request do
+describe "Selenium Webdriver", :type => :feature do
   before(:each) do
     Capybara.current_driver = :selenium
   end

data/spec/spec_helper.rb

@@ -5,5 +5,5 @@ Capybara.app = Sinatra::Application
 
 require 'show_me_the_cookies'
 RSpec.configure do |config|
-  config.include ShowMeTheCookies, :type => :request
+  config.include ShowMeTheCookies, :type => :feature
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: show_me_the_cookies
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-05 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,38 +59,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: akephalos2
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: poltergeist
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Cookie manipulation for Capybara drivers -- viewing, deleting, ...
 email:
 - nick.rutherford@gmail.com
@@ -103,18 +71,13 @@ files:
 - README.md
 - Rakefile
 - lib/show_me_the_cookies.rb
-- lib/show_me_the_cookies/akephalos.rb
-- lib/show_me_the_cookies/poltergeist.rb
-- lib/show_me_the_cookies/rack_test.rb
-- lib/show_me_the_cookies/selenium.rb
+- lib/show_me_the_cookies/adapters/rack_test.rb
+- lib/show_me_the_cookies/adapters/selenium.rb
 - lib/show_me_the_cookies/version.rb
 - show_me_the_cookies.gemspec
 - spec/app/set_cookie.rb
-- spec/request/akephalos_spec.rb
-- spec/request/custom_spec.rb
-- spec/request/poltergeist_spec.rb
-- spec/request/rack-test_spec.rb
-- spec/request/selenium_spec.rb
+- spec/drivers/rack-test_spec.rb
+- spec/drivers/selenium_spec.rb
 - spec/shared_examples_for_api.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nruth/show_me_the_cookies
@@ -130,18 +93,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2634854024742574363
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2634854024742574363
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -150,10 +107,7 @@ specification_version: 3
 summary: Cookie manipulation for Capybara drivers
 test_files:
 - spec/app/set_cookie.rb
-- spec/request/akephalos_spec.rb
-- spec/request/custom_spec.rb
-- spec/request/poltergeist_spec.rb
-- spec/request/rack-test_spec.rb
-- spec/request/selenium_spec.rb
+- spec/drivers/rack-test_spec.rb
+- spec/drivers/selenium_spec.rb
 - spec/shared_examples_for_api.rb
 - spec/spec_helper.rb

data/lib/show_me_the_cookies/akephalos.rb

@@ -1,61 +0,0 @@
-class ShowMeTheCookies::Akephalos
-  def initialize(driver)
-    @driver = driver
-    @browser = driver.browser
-  end
-
-  def get_me_the_cookie(cookie_name)
-    cookie = get_me_the_raw_cookie(cookie_name)
-    cookie && _translate_cookie(cookie)
-  end
-
-  def get_me_the_cookies
-    cookies.map {|c| _translate_cookie(c) }
-  end
-
-  def delete_cookie(cookie_name)
-    cookie = get_me_the_raw_cookie(cookie_name)
-    @browser.cookies.delete(cookie) if cookie
-  end
-
-  def expire_cookies
-    cookies.each do |c|
-      # it drops expired cookies for us, so just remove session cookies
-      # we don't care that it's a badly decoded java date object, just that it's present
-      delete_cookie(c.name)  if c.expires == nil
-    end
-  end
-
-private
-  def get_me_the_raw_cookie(cookie_name)
-    @browser.cookies[cookie_name.to_s]
-  end
-
-  def cookies
-    @browser.cookies.to_a
-  end
-
-  def _translate_cookie(cookie)
-    c = {:name => cookie.name.to_s, 
-        :domain => cookie.domain,
-        :value => cookie.value, 
-        :expires => cookie.expires,
-        :path => cookie.path
-    }
-    # Akephalos2 returns a java.util.Date or somesuch that looks like this, so we
-    # remove it if necessary
-    #
-    # {:value=>"249920784.1048820629.1318215489.1318215489.1318215489.1",
-    #  :path=>"/",
-    # :domain=>"gw.lvh.me",
-    # :name=>"__utma",
-    # :expires=>
-    #  #<DRb::DRbUnknown:0x11d7825d0
-    #   @buf=
-    #    "\004\bU:\031Java::JavaUtil::Date\"3\254?sr\000\016java.util.Datehj\201\001KYt\031\003\000\000xpw\b\000\000\001A\233&\250\200x",
-    #   @name="Java::">},
-    #
-    c[:expires] = nil if c[:expires].class.name == "DRb::DRbUnknown"
-    c
-  end
-end

data/lib/show_me_the_cookies/poltergeist.rb

@@ -1,42 +0,0 @@
-class ShowMeTheCookies::Poltergeist
-  def initialize(driver)
-    @browser = driver.browser
-  end
-
-  def get_me_the_cookie(name)
-    cookie = cookies_hash[name.to_s]
-    translate(cookie) unless cookie.nil?
-  end
-
-  def get_me_the_cookies
-    cookies_hash.values.map(&method(:translate))
-  end
-
-  def expire_cookies
-    cookies_hash.each do |name, cookie|
-      delete_cookie(name) if (cookie.expires rescue nil).nil?
-    end
-  end
-
-  def delete_cookie(name)
-    @browser.remove_cookie(name.to_s)
-  end
-
-  private
-
-  def cookies_hash
-    @browser.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?,
-      :httponly => cookie.httponly?
-    }
-  end
-end

data/spec/request/akephalos_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require 'shared_examples_for_api'
-require 'akephalos'
-
-describe "Akephalos (HTMLUnit)", :type => :request do
-  before(:each) do
-    Capybara.current_driver = :akephalos
-  end
-
-  describe "the testing rig" do
-    it "should load the sinatra app" do
-      visit '/'
-      page.should have_content("Cookie setter ready")
-    end
-  end
-
-  it_behaves_like "the API"
-end

data/spec/request/custom_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-require 'shared_examples_for_api'
-
-describe "Custom Webdriver", :type => :request do
-  before(:all) do
-    Capybara.register_driver :custom do |app|
-      Capybara::Selenium::Driver.new(app, :resynchronize => true)
-    end
-  end
-  before(:each) do
-    Capybara.current_driver = :custom
-  end
-
-  describe "the testing rig" do
-    it "should load the sinatra app" do
-      visit '/'
-      page.should have_content("Cookie setter ready")
-    end
-  end
-
-  it_behaves_like "the API"
-end

data/spec/request/poltergeist_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require 'shared_examples_for_api'
-require 'capybara/poltergeist'
-
-describe "Poltergeist", :type => :request do
-  before(:each) do
-    Capybara.current_driver = :poltergeist
-  end
-
-  describe "the testing rig" do
-    it "should load the sinatra app" do
-      visit '/'
-      page.should have_content("Cookie setter ready")
-    end
-  end
-
-  it_behaves_like "the API"
-end