capybara-sessionkeeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 479123ea32d6a302bf33982ee38f4d092fd60b9c
+  data.tar.gz: 8b40efcf2f17754d5958860d9f645949fe67da5d
+SHA512:
+  metadata.gz: e780cecdc7817e5422aad08024224fa0660a1c112be88424ec8311bd11c8c7c573d3fdd6059033fc0f3c4a13cfda489152eb0734c7eb69ad0278d49e34f1b3e0
+  data.tar.gz: 8942a49e8e78597447031c5fdf53cbdba57ccd5ae9dec92809de23e8dbda4e1e3edd8f5fcf89fd17b1cd1ebd7817470b8bb4dfb51f5b06b654a038214d2d13ae

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+dist: trusty
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+  - CHROMEDRIVER_VERSION=$(curl -s http://chromedriver.storage.googleapis.com/LATEST_RELEASE)
+  - echo $CHROMEDRIVER_VERSION $PWD $PATH
+  - curl -L -O "http://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip"
+  - unzip chromedriver_linux64.zip -d chromedriver
+  - export PATH=$PATH:$PWD/chromedriver

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capybara-sessionkeeper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kazuho Yamaguchi
+
+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/README.md

@@ -0,0 +1,132 @@
+# Capybara::Sessionkeeper
+
+[![Gem Version](https://badge.fury.io/rb/capybara-sessionkeeper.svg)](https://badge.fury.io/rb/capybara-sessionkeeper)
+[![Build Status](https://travis-ci.org/kyamaguchi/capybara-sessionkeeper.svg?branch=master)](https://travis-ci.org/kyamaguchi/capybara-sessionkeeper)
+
+Save and restore cookies of capybara session
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-sessionkeeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-sessionkeeper
+
+## Usage
+
+Require with capybara
+
+```
+require "capybara"
+require "capybara/sessionkeeper"
+```
+
+### Supported drivers
+
+[Recommended] Chrome driver is supported.
+
+```
+Capybara.register_driver :chrome do |app|
+  Capybara::Selenium::Driver.new(app, browser: :chrome)
+end
+```
+
+Firefox(:selenium option) also works.
+
+```
+session = Capybara::Session.new(:selenium)
+```
+
+### Location of cookie file
+
+It follows `Capybara.save_path`.
+
+### Save cookies
+
+```
+session = Capybara::Session.new(:chrome)
+session.visit 'https://github.com/'
+path = session.save_cookies
+```
+
+Save cookie file with specified file name.
+
+```
+session.save_cookies('user1.cookies.txt')
+```
+
+### Restore cookies
+
+You have to visit the site which you are trying to restore cookie beforehand.  
+Otherwise, you will get error.
+
+```
+session = Capybara::Session.new(:chrome)
+session.visit 'https://github.com/'
+cookies = session.restore_cookies
+```
+
+Restore cookie file with specified file name.
+
+```
+session.restore_cookies('user1.cookies.txt')
+```
+
+### Read cookies of current session
+
+```
+session.driver.browser.manage.all_cookies
+```
+
+### Notice of cookie restoration
+
+On restoring cookies, this gem ignores `Selenium::WebDriver::Error::InvalidCookieDomainError`.  
+If you repeat `save_cookies` and `restore_cookies` in a single file, you could lose some cookies of domains you haven't visited.  
+
+This behavior can be changed in the future.  
+
+Some use cases are,  
+Save/Restore cookies by users/use cases/sites.  
+You can switch signed-in users easily.  
+You don't need to sign in every time.  
+You just need to sign in once(or occasionally) and save/restore cookies.  
+
+## Development
+
+### Testing spec which requires signin using envchain
+
+There are some spec requiring GitHub signin.  
+
+You can store environment variables in macOS Keychain.  
+Check out [envchain](https://github.com/sorah/envchain)
+
+```
+brew install envchain
+envchain --set github GITHUB_USERNAME GITHUB_PASSWORD
+
+envchain github rspec
+```
+
+### Testing with :selenium(Firefox) driver
+
+```
+SELENIUM=true rspec
+SELENIUM=true envchain github rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kyamaguchi/capybara-sessionkeeper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara/sessionkeeper"
+
+# 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-sessionkeeper.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capybara/sessionkeeper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-sessionkeeper"
+  spec.version       = Capybara::Sessionkeeper::VERSION
+  spec.authors       = ["Kazuho Yamaguchi"]
+  spec.email         = ["kzh.yap@gmail.com"]
+
+  spec.summary       = %q{Save and restore cookies of capybara session.}
+  spec.description   = %q{Save and restore cookies of capybara session.}
+  spec.homepage      = "https://github.com/kyamaguchi/capybara-sessionkeeper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.add_dependency "capybara"
+  spec.add_dependency "selenium-webdriver"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/capybara/sessionkeeper.rb

@@ -0,0 +1,55 @@
+require 'capybara'
+require "capybara/sessionkeeper/version"
+
+module Capybara
+  module Sessionkeeper
+    class CookieError < StandardError; end
+
+    def save_cookies(path = nil)
+      path = prepare_path(path, cookie_file_extension)
+      data = Marshal.dump driver.browser.manage.all_cookies
+      File.write(path, data)
+      path
+    end
+
+    def restore_cookies(path = nil)
+      raise CookieError, "visit must be performed to restore cookies" if driver.browser.manage.all_cookies.empty?
+      path ||= find_latest_cookie_file
+      return nil if path.nil?
+      data = File.read(path)
+      Marshal.load(data).each do |d|
+        begin
+          driver.browser.manage.add_cookie d
+        rescue => e
+          skip_invalid_cookie_domain_error(e)
+        end
+      end
+      driver.browser.manage.all_cookies
+    end
+
+    def cookie_file_extension
+      'cookies.txt'
+    end
+
+    private
+
+    def find_latest_cookie_file
+      Dir.glob(File.join(Capybara.save_path, "*.#{cookie_file_extension}")).max_by{|f| File.mtime(f) }
+    end
+
+    def skip_invalid_cookie_domain_error(e)
+      if e.message =~ /InvalidCookieDomainError/
+        # Case of :selenium driver(Firefox). e.message -> "ReferenceError: InvalidCookieDomainError is not defined"
+        # Selenium::WebDriver::Error::UnknownError: ReferenceError: InvalidCookieDomainError is not defined
+      elsif e.message =~ /invalid cookie domain/
+        # Case of :chrome driver. e.message -> 'invalid cookie domain: invalid domain:".github.com"'
+        # Selenium::WebDriver::Error::InvalidCookieDomainError
+        # puts "Skipped invalid cookie domain: #{d[:domain]} - #{d.inspect}"
+      else
+        raise(e)
+      end
+    end
+  end
+end
+
+Capybara::Session.send(:include, Capybara::Sessionkeeper)

data/lib/capybara/sessionkeeper/version.rb

@@ -0,0 +1,5 @@
+module Capybara
+  module Sessionkeeper
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: capybara-sessionkeeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuho Yamaguchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Save and restore cookies of capybara session.
+email:
+- kzh.yap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara-sessionkeeper.gemspec
+- lib/capybara/sessionkeeper.rb
+- lib/capybara/sessionkeeper/version.rb
+homepage: https://github.com/kyamaguchi/capybara-sessionkeeper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Save and restore cookies of capybara session.
+test_files: []