mechanize-cookie_store 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a51392cdff41056325f7792b45956555f2769bb9dc6184a5bc83edeeee00d083
+  data.tar.gz: 99ce99c06cd142209a57c725ed9df72af97c1b5f8941d78a920c5bcf8205a042
+SHA512:
+  metadata.gz: bb5d2b8610d78cd404d726ebceb9a9c5e3fd7477b33e81b3564d608066df9aa13903f71ec248485c250a91603a7a3e51655fcffb2beeeb3dfde3698146ec8bfa
+  data.tar.gz: 120b9be8e427d293cbbb4f60ca44bc2757b4fdd05c488928bffba7d9e7f51545572187ace7837b49dbcc53e8810e7b5d9aabad7f5d51803974b78692ac01274e

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug command history
+.byebug_history
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+gemfiles/*.gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1
+services:
+  - redis-server

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@cedarcode.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 mechanize-cookie_store.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 hello@cedarcode.com
+
+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,104 @@
+# Mechanize::CookieStore
+
+[![Build Status](https://travis-ci.org/cedarcode/mechanize-cookie_store.svg?branch=master)](https://travis-ci.org/cedarcode/mechanize-cookie_store)
+
+mechanize-cookie_store is an extension to [Mechanize gem](https://github.com/sparklemotion/mechanize) that allow you to persist the Mechanize agent cookie set, in a smarter way than serialized or plain files in the server's system. This allows you to share your cookies across multiple server instances, among other benefits.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mechanize-cookie_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mechanize-cookie_store
+
+## Configuration
+
+For *Rails* applications you can create `config/initializers/mechanize-cookie_store.rb` and provide the necessary
+configuration params to access your desired persistance method.
+
+If your not using Rails, you just need to make sure to run the same configuration code before using Mechanize.
+
+Please see below the available built-in stores and their specific configurations:
+
+***Currently, the only supported store is Redis.***
+
+### For Redis
+
+```ruby
+Mechanize::CookieStore.configure do |config|
+  config.connection_params = {
+    url: "your-redis-url",
+    namespace: "your-redis-namespace" # optional
+  }
+end
+```
+
+- `url` must have a valid redis server url
+- `namespace` parameter is optional, default namespace is `mechanize_cookies`
+
+
+## Usage
+
+After configuring it, usage looks pretty similar to the way you would use
+mechanize without this gem.
+
+Instantiate a mechanize session and use it:
+
+```ruby
+agent = Mechanize.new
+
+agent.get("https://www.google.com")
+```
+
+
+Then `save` or`load` your cookie_jar the same way you would do it without `mechanize-cookie_store`.
+
+```ruby
+agent.cookie_jar.save # to persist cookies to storage
+
+agent.cookie_jar.load # to load back back into the agent from storage
+```
+
+Or use if you want to load specific cookie set you can pass to `load` the options
+`domain`, `path` and `name` like this:
+
+```ruby
+agent.cookie_jar.load(domain: "example.com", path: "/mypath", name: "myCookie")
+```
+
+Please note, that these options correpond to the fields of the [HTTP::Cookie](https://github.com/sparklemotion/http-cookie/blob/v1.0.3/lib/http/cookie.rb#L27) class, an inherited dependency from Mechanize.
+
+
+## Dependencies
+
+This gem depends on:
+
+- [Mechanize](https://github.com/sparklemotion/mechanize)
+- [Redis Namespace](https://github.com/resque/redis-namespace)
+
+## Contributing
+
+1. Fork it ( https://github.com/cedarcode/mechanize=cookie_store/ )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+To run the test suite, make sure you have Redis server running in `localhost:6379`. Then just run `bundle exec rake`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mechanize::CookieStore project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cedarcode/mechanize-cookie_store/blob/master/CODE_OF_CONDUCT.md).

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 "mechanize/cookie_store"
+
+# 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/lib/mechanize/cookie_store.rb

@@ -0,0 +1,18 @@
+require "mechanize"
+require "mechanize/cookie_store/version"
+require "mechanize/cookie_store/cookie_jar"
+require "mechanize/cookie_store/redis"
+
+module Mechanize::CookieStore
+
+  class << self
+
+    attr_accessor :connection_params
+
+    def configure
+      yield self
+    end
+
+  end
+
+end

data/lib/mechanize/cookie_store/cookie_jar.rb

@@ -0,0 +1,21 @@
+module Mechanize::CookieStore
+  module CookieJar
+
+    def save
+      each do |cookie|
+        ::Mechanize::CookieStore::Redis.save(cookie)
+      end
+    end
+
+    def load(options = {})
+      ::Mechanize::CookieStore::Redis.all(options).each do |cookie|
+        add(cookie)
+      end
+    end
+
+  end
+end
+
+class Mechanize::CookieJar
+  prepend Mechanize::CookieStore::CookieJar
+end

data/lib/mechanize/cookie_store/redis.rb

@@ -0,0 +1,52 @@
+require "redis-namespace"
+
+class Mechanize::CookieStore::Redis
+
+    DEFAULT_NAMESPACE = "mechanize_cookies".freeze
+
+    def self.connection
+      return @store_connection if @store_connection
+
+      namespace = Mechanize::CookieStore.connection_params[:namespace] || DEFAULT_NAMESPACE
+      redis_connection  = ::Redis.new(Mechanize::CookieStore.connection_params)
+
+      @store_connection = ::Redis::Namespace.new(namespace, redis: redis_connection)
+    end
+
+    def self.all(options = {})
+      normalized_keys(options).each_with_object([]) do |key, cookies|
+        serialized_cookie = connection.get(key)
+
+        if serialized_cookie
+          cookie = Marshal.load(serialized_cookie)
+
+          unless cookie_expired?(cookie)
+            cookies << cookie
+          end
+        end
+      end
+    end
+
+    def self.save(cookie)
+      return if cookie_expired?(cookie)
+
+      key = "#{cookie.domain}:#{cookie.path}:#{cookie.name}"
+
+      connection.set(key, Marshal.dump(cookie)) == "OK"
+    end
+
+    def self.cookie_expired?(cookie)
+      cookie.expires && cookie.expires < Time.now.utc ||
+        cookie.created_at && cookie.max_age &&
+        cookie.created_at + cookie.max_age < Time.now.utc
+    end
+
+    def self.normalized_keys(options = {})
+      domain = options[:domain] || "*"
+      path   = options[:path]   || "*"
+      name   = options[:name]   || "*"
+
+      connection.keys("#{domain}:#{path}:#{name}")
+    end
+
+end

data/lib/mechanize/cookie_store/version.rb

@@ -0,0 +1,5 @@
+class Mechanize
+  module CookieStore
+    VERSION = "1.0.0"
+  end
+end

data/mechanize-cookie_store.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "mechanize/cookie_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mechanize-cookie_store"
+  spec.version       = Mechanize::CookieStore::VERSION
+  spec.authors       = ["Braulio Martinez"]
+  spec.email         = ["braulio@cedarcode.com"]
+
+  spec.summary       = "A Mechanize extension that allows cookies to be saved in more advanced stores than serialized filesystem files."
+  spec.homepage      = "https://github.com/cedarcode/mechanize-cookie_store"
+  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 "mechanize", "~> 2.7"
+  spec.add_dependency "redis-namespace", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: mechanize-cookie_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Braulio Martinez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 
+email:
+- braulio@cedarcode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mechanize/cookie_store.rb
+- lib/mechanize/cookie_store/cookie_jar.rb
+- lib/mechanize/cookie_store/redis.rb
+- lib/mechanize/cookie_store/version.rb
+- mechanize-cookie_store.gemspec
+homepage: https://github.com/cedarcode/mechanize-cookie_store
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A Mechanize extension that allows cookies to be saved in more advanced stores
+  than serialized filesystem files.
+test_files: []