redis-client-session-store 0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db7a4a07be6c7fab4598da8a222eb32fb46145625d90842560bba0ba4a2a4d49
+  data.tar.gz: 8e2b69531d7dd324de9096cb5322a7bedffc9a01ada04fcb0fd0622743b498ec
+SHA512:
+  metadata.gz: 10e08e8ce5603ddb32ddd14eef0df85aa069dfac2965204a5571dba20ed2588e6f9296048fdbf3dca3a29d2d805a022d4b4b20bb415dd1f87353ae9df381b483
+  data.tar.gz: 7babf4ff1408aa7e23d55fd95525aecab64185d437130452f054537d3e6afbf3b14b61efd6975bab889df63c9cb09d922788c42ecee2b16a863d453b00b3d326

data/.github/workflows/ruby.yml

@@ -0,0 +1,42 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - head
+          - jruby-9.2.20.1
+          - jruby-head
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      continue-on-error: true
+    - name: Run tests
+      run: bundle exec rake
+      continue-on-error: true

data/.gitignore

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/support/redis-client"]
+	path = spec/support/redis-client
+	url = git@github.com:redis-rb/redis-client.git

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'Rakefile'
+    - 'vendor/**/*'
+    - 'spec/support/redis-client/**/*'
+
+Naming/FileName:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 140
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+Security/MarshalLoad:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,67 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-01-29 11:55:33 UTC using RuboCop version 1.25.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'redis-session-store.gemspec'
+
+# Offense count: 6
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/redis_session_store_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 9
+
+# Offense count: 5
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/redis_session_store_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 5
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 17
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+# Offense count: 13
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 2
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/redis_session_store_spec.rb'
+
+# Offense count: 20
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/redis_session_store_spec.rb'
+
+# Offense count: 16
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  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/AUTHORS.md

@@ -0,0 +1,29 @@
+Redis Session Store authors
+===========================
+
+- Andrey "Zed" Zaikin
+- Ben Marini
+- Bill Ruddock
+- 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
+- Zachary Belzer
+- Yutaka Kamei

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/zed-0xff/redis-client-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/Gemfile.lock

@@ -0,0 +1,144 @@
+PATH
+  remote: .
+  specs:
+    redis-client-session-store (0.12)
+      actionpack (>= 5.2.4.1, < 8)
+      redis-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    nokogiri (1.16.0-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    redis-client (0.19.1)
+      connection_pool
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  rake (~> 13)
+  redis-client-session-store!
+  rspec (~> 3)
+  rubocop (~> 1.25)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.8)
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.3.26

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,99 @@
+# RedisClient Session Store
+
+[![Code Climate](https://codeclimate.com/github/zed-0xff/redis-client-session-store.svg)](https://codeclimate.com/github/zed-0xff/redis-client-session-store)
+[![Gem Version](https://badge.fury.io/rb/redis-client-session-store.svg)](http://badge.fury.io/rb/redis-client-session-store)
+
+A fork of [redis-session-store](https://github.com/roidrage/redis-session-store)
+using low-level RESP3 wrapper [redis-client](https://github.com/redis-rb/redis-client)
+instead of idiomatic [redis](https://github.com/redis/redis-rb).
+
+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-client-session-store'
+```
+
+## Configuration
+
+See `lib/redis-client-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_client_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_client_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_client_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_client_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.
+
+## 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