brevio-session-store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8f67e9e361415ba43f4f011b43ca47afbd756dfd5be138a561931d61e8c4dfc
+  data.tar.gz: 817478ad26708c2499f0fb1ac1aee1ac1dc6396fa3d48e332aca42910d1ba610
+SHA512:
+  metadata.gz: 512e40cfb34c3040642f5ecd76c81131acb3ff72a647fa96f47634f233be5e8cb5f99bbe0c7c3ec5e8bd4aee61e85087cfc1443c58999d0c8434efac5726d0ec
+  data.tar.gz: 923603e66e37be4604d16afa90e88b8fe39b6de2d321f0d507c0113c82caed001db689f2a4509f6c391867cb75cc201bfe6b5f3fd9af8373a08d921fc5021625

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'Rakefile'
+    - 'vendor/**/*'
+
+Naming/FileName:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 120
+
+Security/MarshalLoad:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/YodaCondition:
+  # temporary work around for rubocop bug 'An error occurred while Style/YodaCondition...' (v0.49.1)
+  Exclude:
+    - 'spec/redis_session_store_spec.rb'

data/.simplecov

@@ -0,0 +1,5 @@
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.3
+- 2.4
+- 2.5
+- 2.6
+- ruby-head
+- jruby-9.2.12.0
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  - rvm: jruby-9.2.12.0
+notifications:
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: jL1lH/wfeRa5MoZRHvkXcZP/Ch7huFxqzbvhEV7UZhiDUBnApcJWkb346jeLEDYnFObUhqhaCZ1/l4fDeSFg2GgatSfEnoWATFVkIf1e4TTGAePlS+4qqsGOcr+XrjP6CEf4o4JACdLuSoT9dtUFj0xkFLnDWILxneXIrqDE9VU=
+  gem: redis-session-store
+  on:
+    tags: true
+    repo: roidrage/redis-session-store
+    rvm: 2.6.6

data/AUTHORS.md

@@ -0,0 +1,25 @@
+Redis Session Store authors
+===========================
+
+- Ben Marini
+- Dan Buch
+- Donald Plummer
+- Edwin Cruz
+- Gonçalo Silva
+- Ian C. Anderson
+- Jesse Doyle
+- Jorge Pardiñas
+- Justin McNally
+- Mathias Meyer
+- Michael Fields
+- Michael Xavier
+- Olek Poplavsky
+- Tim Lossen
+- Todd Bealmear
+- Aleksey Dashkevych
+- Olle Jonsson
+- Nicolas Rodriguez
+- Sergey Nebolsin
+- Anton Kolodii
+- Peter Karman
+- Zach Margolis

data/CHANGELOG.md

@@ -0,0 +1,269 @@
+# Change Log
+
+**ATTN**: This project uses [semantic versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.11.3] - 2020-07-23
+### Fixed
+- https://github.com/roidrage/redis-session-store/issues/121
+
+## [0.11.2] - 2020-07-22
+### Changed
+- Silence deprecation warning when using with redis gem v4.2+
+
+## [0.11.1] - 2019-08-22
+### Changed
+- Remove the `has_rdoc` parameter from the `.gemspec` file as it has been deprecated.
+- Actionpack to '>= 3', remove upper dependency
+
+## [0.11.0] - 2018-08-13
+### Changed
+- JRuby to jruby-9.2.0.0
+- Travis Ruby support: 2.3.7, 2.4.4, 2.5.1
+
+### Added
+- :ttl configuration option
+
+## [0.10.0] - 2018-04-14
+### Changed
+- JRuby to jruby-9.1.15.0
+- Redis to '>= 3', '< 5'
+- Actionpack to '>= 3', '< 6'
+- Rake to 12
+
+### Added
+- with_indifferent_access if defined ActiveSupport
+
+## [0.9.2] - 2017-10-31
+### Changed
+- Actionpack to 5.1
+- Travis use jruby 9.1.13.0
+
+## [0.9.1] - 2016-07-03
+### Added
+- More specific runtime dependencies
+
+### Changed
+- Documentation and whitespace
+
+## [0.9.0] - 2016-07-02
+### Added
+- [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)
+- Method alias for `#delete_session` -&gt; `#destroy_session`
+
+### Changed
+- Tested version of Ruby 2 up to 2.3.1
+- Session config examples to use `redis: { url: '...' }`
+
+### Removed
+- Ruby 1.9.3 support due to Rack 2 requirements
+
+## [0.8.1] - 2016-01-25
+### Added
+- Support for Rails 5 and Rack 2
+
+### Changed
+- Error support for redis-rb v3 gem
+
+## [0.8.0] - 2014-08-28
+### Added
+- Allow for injection of custom redis client
+- Explicitly declare actionpack dependency
+
+### Changed
+- Spec updates for rspec 3
+
+## [0.7.0] - 2014-04-22
+### Fixed
+- Issue #38, we now delay writing to redis until a session exists. This is a
+  backwards-incompatible change, as it removes the `on_sid_collision` option.
+  There is now no checking for sid collisions, however that is very unlikely.
+
+## [0.6.6] - 2014-04-08
+### Fixed
+- Issue #37, use correct constant for `ENV_SESSION_OPTIONS_KEY` if not passed.
+
+## [0.6.5] - 2014-04-04
+### Fixed
+- Issue #36, use setnx to get a new session id instead of get. This prevents a
+  very rare id collision.
+
+## [0.6.4] - 2014-04-04
+### Removed
+- `#setnx` usage in v0.6.3 so we can change our sessions
+
+## [0.6.3] - 2014-04-01
+### Changed
+- Setting session ID with a multi-call `#setnx` and `#expire` instead of
+  `#setex`.
+
+### Removed
+- `#setnx` change in v0.6.2 as it behaved badly under load, hitting yet another
+  race condition issue and pegging the CPU.
+
+## [0.6.2] - 2014-03-31
+### Changed
+- Use `#setnx` instead of `#get` when checking for session ID collisions, which
+  is slightly more paranoid and should help avoid a particularly nasty edge
+  case.
+
+## [0.6.1] - 2014-03-17
+### Fixed
+- Compatibility with `ActionDispatch::Request::Session::Options` when destroying
+  sessions.
+
+## [0.6.0] - 2014-03-17
+### Added
+- Custom serializer configuration
+- Custom handling capability for session load errors
+
+### Changed
+- Always destroying sessions that cannot be loaded
+
+## [0.5.0] - 2014-03-16
+### Added
+- Support for `on_sid_collision` handler option
+- Support for `on_redis_down` handler option
+
+### Changed
+- Keep generating session IDs until one is found that doesn't collide
+  with existing session IDs
+
+### Removed
+- **BACKWARD INCOMPATIBLE** Drop support for `:raise_errors` option
+
+## [0.4.2] - 2014-03-14
+### Changed
+- Renaming `load_session` method to not conflict with AbstractStore
+
+## [0.4.1] - (2014-03-13) [YANKED]
+### Changed
+- Regenerate session ID when session is missing
+
+## [0.4.0] - 2014-02-19
+### Added
+- Support for `ENV_SESSION_OPTIONS_KEY` rack env option
+- Support for `:raise_errors` session option (kinda like Dalli)
+
+### Changed
+- Increasing test coverage
+
+## [0.3.1] - 2014-02-19
+### Added
+- `#destroy_session` method
+
+### Changed
+- Clean up remaining RuboCop offenses
+- Documentation updates
+
+## [0.3.0] - 2014-02-13
+### Added
+- Rails 3 compatibility
+- Add test coverage
+
+### Changed
+- Switch from minitest to rspec
+- RuboCop cleanup
+
+## [0.2.4] - 2014-03-16
+### Changed
+- Keep generating session IDs until one is found that doesn't collide
+  with existing session IDs
+
+## [0.2.3] - 2014-03-14
+### Changed
+- Renaming `load_session` method to not conflict with AbstractStore
+
+## [0.2.2] - 2014-03-13 [YANKED]
+### Changed
+- Regenerate session ID when session is missing
+
+## [0.2.1] - 2013-09-17
+### Added
+- Explicit MIT license metadata in gemspec
+
+## [0.2.0] - 2013-09-13
+### Added
+- Gemfile, gemspec, and git updates
+- `#destroy` method
+- Travis integration
+- Some minimal tests to ensure backward compatibility session options
+
+### Changed
+- Nest redis-specific options inside a `:redis` key of session options
+- Rescue only `Errno::ECONNREFUSED` exceptions
+- Handle `nil` cookies during `#destroy`
+
+## [0.1.9] - 2012-03-06
+### Changed
+- Use `@redis.setex` when expiry provided, else `@redis.set`
+- gemification
+- Options hash to no longer expect redis options at same level
+
+## [0.1.8] - 2010-12-09
+### Removed
+- Use of `@redis.pipelined`
+
+## 0.1.7 - 2010-12-08
+### Changed
+- Using latest redis gem API
+
+## 0.1.6 - 2010-04-18
+### Changed
+- Using pipelined format with `set` and `expire`
+- Changing default port from 6370 to 6379
+
+## 0.1.5 - 2010-04-07
+
+## 0.1.4 - 2010-03-26
+### Changed
+- Redis parameter from `:server` to `:host`
+
+## 0.1.3 - 2009-12-30
+### Changed
+- Documentation updates
+
+## 0.1.2 - 2009-12-30
+### Changed
+- Documentation updates
+
+## 0.1.1 - 2009-12-30
+### Changed
+- library file renamed to `redis-session-store.rb` to play nicely with
+  rails require
+
+## 0.1 - 2009-12-30
+### Added
+- first working version
+
+[Unreleased]: https://github.com/roidrage/redis-session-store/compare/v0.11.1...HEAD
+[0.11.1]: https://github.com/roidrage/redis-session-store/compare/v0.11.0...v0.11.1
+[0.11.0]: https://github.com/roidrage/redis-session-store/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/roidrage/redis-session-store/compare/v0.9.2...v0.10.0
+[0.9.2]: https://github.com/roidrage/redis-session-store/compare/v0.9.1...v0.9.2
+[0.9.1]: https://github.com/roidrage/redis-session-store/compare/v0.9.0...v0.9.1
+[0.9.0]: https://github.com/roidrage/redis-session-store/compare/v0.8.1...v0.9.0
+[0.8.1]: https://github.com/roidrage/redis-session-store/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/roidrage/redis-session-store/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/roidrage/redis-session-store/compare/v0.6.6...v0.7.0
+[0.6.6]: https://github.com/roidrage/redis-session-store/compare/v0.6.5...v0.6.6
+[0.6.5]: https://github.com/roidrage/redis-session-store/compare/v0.6.4...v0.6.5
+[0.6.4]: https://github.com/roidrage/redis-session-store/compare/v0.6.3...v0.6.4
+[0.6.3]: https://github.com/roidrage/redis-session-store/compare/v0.6.2...v0.6.3
+[0.6.2]: https://github.com/roidrage/redis-session-store/compare/v0.6.1...v0.6.2
+[0.6.1]: https://github.com/roidrage/redis-session-store/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/roidrage/redis-session-store/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/roidrage/redis-session-store/compare/v0.4.2...v0.5.0
+[0.4.2]: https://github.com/roidrage/redis-session-store/compare/v0.4.1...v0.4.2
+[0.4.1]: https://github.com/roidrage/redis-session-store/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/roidrage/redis-session-store/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/roidrage/redis-session-store/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/roidrage/redis-session-store/compare/v0.2.4...v0.3.0
+[0.2.4]: https://github.com/roidrage/redis-session-store/compare/v0.2.3...v0.2.4
+[0.2.3]: https://github.com/roidrage/redis-session-store/compare/v0.2.2...v0.2.3
+[0.2.2]: https://github.com/roidrage/redis-session-store/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/roidrage/redis-session-store/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/roidrage/redis-session-store/compare/v0.1.9...v0.2.0
+[0.1.9]: https://github.com/roidrage/redis-session-store/compare/v0.1.8...v0.1.9
+[0.1.8]: https://github.com/roidrage/redis-session-store/compare/v0.1.7...v0.1.8

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# 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 via [github
+issues](https://github.com/roidrage/redis-session-store/issues). 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/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+Redis Session Store contribution guidelines
+===========================================
+
+- Pull requests welcome!
+- Please add yourself to the [AUTHORS.md](AUTHORS.md) file
+alphabetically by first name.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Mathias Meyer and contributors
+
+MIT License
+
+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,119 @@
+# Redis Session Store
+
+[![Build Status](https://travis-ci.org/roidrage/redis-session-store.svg?branch=master)](https://travis-ci.org/roidrage/redis-session-store)
+[![Code Climate](https://codeclimate.com/github/roidrage/redis-session-store.svg)](https://codeclimate.com/github/roidrage/redis-session-store)
+[![Gem Version](https://badge.fury.io/rb/redis-session-store.svg)](http://badge.fury.io/rb/redis-session-store)
+
+A simple Redis-based session store for Rails.  But why, you ask,
+when there's [redis-store](http://github.com/jodosha/redis-store/)?
+redis-store is a one-size-fits-all solution, and I found it not to work
+properly with Rails, mostly due to a problem that seemed to lie in
+Rack's `Abstract::ID` class. I wanted something that worked, so I
+blatantly stole the code from Rails' `MemCacheStore` and turned it
+into a Redis version. No support for fancy stuff like distributed
+storage across several Redis instances. Feel free to add what you
+see fit.
+
+This library doesn't offer anything related to caching, and is
+only suitable for Rails applications. For other frameworks or
+drop-in support for caching, check out
+[redis-store](http://github.com/jodosha/redis-store/).
+
+## Installation
+
+For Rails 3+, adding this to your `Gemfile` will do the trick.
+
+``` ruby
+gem 'redis-session-store'
+```
+
+## Configuration
+
+See `lib/redis-session-store.rb` for a list of valid options.
+In your Rails app, throw in an initializer with the following contents:
+
+``` ruby
+Rails.application.config.session_store :redis_session_store, {
+  key: 'your_session_key',
+  redis: {
+    expire_after: 120.minutes,  # cookie expiration
+    ttl: 120.minutes,           # Redis expiration, defaults to 'expire_after'
+    key_prefix: 'myapp:session:',
+    url: 'redis://localhost:6379/0',
+  }
+}
+```
+
+### Redis unavailability handling
+
+If you want to handle cases where Redis is unavailable, a custom
+callable handler may be provided as `on_redis_down`:
+
+``` ruby
+Rails.application.config.session_store :redis_session_store, {
+  # ... other options ...
+  on_redis_down: ->(e, env, sid) { do_something_will_ya!(e) }
+  redis: {
+    # ... redis options ...
+  }
+}
+```
+
+### Serializer
+
+By default the Marshal serializer is used. With Rails 4, you can use JSON as a
+custom serializer:
+
+* `:json` - serialize cookie values with `JSON` (Requires Rails 4+)
+* `:marshal` - serialize cookie values with `Marshal` (Default)
+* `:hybrid` - transparently migrate existing `Marshal` cookie values to `JSON` (Requires Rails 4+)
+* `CustomClass` - You can just pass the constant name of any class that responds to `.load` and `.dump`
+
+``` ruby
+Rails.application.config.session_store :redis_session_store, {
+  # ... other options ...
+  serializer: :hybrid
+  redis: {
+    # ... redis options ...
+  }
+}
+```
+
+**Note**: Rails 4 is required for using the `:json` and `:hybrid` serializers
+because the `Flash` object doesn't serialize well in 3.2. See [Rails #13945](https://github.com/rails/rails/pull/13945) for more info.
+
+### Session load error handling
+
+If you want to handle cases where the session data cannot be loaded, a
+custom callable handler may be provided as `on_session_load_error` which
+will be given the error and the session ID.
+
+``` ruby
+Rails.application.config.session_store :redis_session_store, {
+  # ... other options ...
+  on_session_load_error: ->(e, sid) { do_something_will_ya!(e) }
+  redis: {
+    # ... redis options ...
+  }
+}
+```
+
+**Note** The session will *always* be destroyed when it cannot be loaded.
+
+### Other notes
+
+It returns with_indifferent_access if ActiveSupport is defined
+
+## Rails 2 Compatibility
+
+This gem is currently only compatible with Rails 3+.  If you need
+Rails 2 compatibility, be sure to pin to a lower version like so:
+
+``` ruby
+gem 'redis-session-store', '< 0.3'
+```
+
+## Contributing, Authors, & License
+
+See [CONTRIBUTING.md](CONTRIBUTING.md), [AUTHORS.md](AUTHORS.md), and
+[LICENSE](LICENSE), respectively.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: [:rubocop, :coverage]
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs with coverage'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+  Rake::Task['spec'].invoke
+end
+
+RuboCop::RakeTask.new