rack-redic 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89dbdee0222ddd8f07c8649924aca577ac8a42b1
+  data.tar.gz: df6c71a5eadc62632208e36295d44031fc05b32b
+SHA512:
+  metadata.gz: f676a33174d537d2b3b95385b4dc3cdc45a3f77c7906b0126163c6ee017e26364207037bbae4b4747953541c601a07315a3d83403dc2921c32ab843707ca5a14
+  data.tar.gz: 0fd50ee339a37fd7425ec16e4d653c9880ba71512d4f3158e50d61543349e50d3ce31d8152c87385fffae6da167a021549ae16e9f1301a42a35f986eb5414a7f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at evan@lecklider.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Evan Lecklider
+
+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,66 @@
+# Rack::Redic
+
+Rack::Session::Redic provides simple cookie based session management.
+Session data is stored in Redis via the Redic gem. The corresponding
+session key is maintained in the cookie.
+
+You may optionally supply the class/module you would like to use when
+marshalling objects in and out of Redis. All that is required is that
+this class respond to the  `load` and `dump` methods, returning the
+session hash and a string respectively.
+
+Addtionally, you may pass in the URL for your Redis server. The default
+URL is fetched from the ENV as 'REDIS_URL' in keeping with Heroku and
+others' practices.
+
+Any other options will get passed to Rack::Session::Abstract::Persisted.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-redic', require: 'rack/session/redic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-redic
+
+
+## Usage
+
+Anywhere in your Rack application just add:
+
+```ruby
+# Most basic usage.
+use Rack::Session::Redic
+
+# Optionally pass in a marshaller.
+use Rack::Session::Redic, marshaller: Oj
+
+# And/or pass in the URL of your Redis server.
+use Rack::Session::Redic, marshaller: Oj, url: 'redis://host'
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evanleck/rack-redic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,3 @@
+require 'bundler/gem_tasks'
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'rack/session/redic'
+require 'irb'
+
+IRB.start

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/rack/session/redic.rb

@@ -0,0 +1,116 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+require 'rack/session/abstract/id'
+require 'zlib'
+
+module Rack
+  module Session
+    #
+    # Rack::Session::Redic provides simple cookie based session management.
+    # Session data is stored in Redis via the Redic gem. The corresponding
+    # session key is maintained in the cookie.
+    #
+    # You may optionally supply the class/module you would like to use when
+    # marshalling objects in and out of Redis. All that is required is that
+    # this class respond to the  `load` and `dump` methods, returning the
+    # session hash and a string respectively.
+    #
+    # Addtionally, you may pass in the URL for your Redis server. The default
+    # URL is fetched from the ENV as 'REDIS_URL' in keeping with Heroku and
+    # others' practices.
+    #
+    # Any other options will get passed to Rack::Session::Abstract::Persisted.
+    #
+    class Redic < Abstract::Persisted
+      def initialize(app, options = {})
+        super
+
+        @mutex = Mutex.new
+        @marshaller = options.delete(:marshaller) { Marshal }
+        @storage = StorageWrapper.new(@marshaller, options.delete(:url) { ENV.fetch('REDIS_URL') })
+      end
+
+      # Only accept a generated session ID if it doesn't exist.
+      def generate_sid
+        loop do
+          sid = super
+          break sid unless @storage.exists?(sid)
+        end
+      end
+
+      # Find the session (or generate a blank one).
+      def find_session(req, sid)
+        @mutex.synchronize do
+          unless sid and session = @storage.get(sid)
+            sid, session = generate_sid, {}
+            @storage.set(sid, session)
+          end
+
+          [sid, session]
+        end
+      end
+
+      # Write the session.
+      def write_session(req, session_id, new_session, options)
+        @mutex.synchronize do
+          @storage.set(session_id, new_session)
+
+          session_id
+        end
+      end
+
+      # Kill the session.
+      def delete_session(req, session_id, options)
+        @mutex.synchronize do
+          @storage.delete(session_id)
+          generate_sid unless options[:drop]
+        end
+      end
+
+      private
+
+      # Generic storage wrapper.
+      #   Currently using Redis via Redic.
+      class StorageWrapper
+        DELETE = 'DEL'
+        EXISTS = 'EXISTS'
+        GET = 'GET'
+        SET = 'SET'
+
+        def initialize(marshaller, url)
+          @marshaller = marshaller
+          @storage = ::Redic.new(url)
+        end
+
+        def exists?(id)
+          @storage.call(EXISTS, id) != 0
+        end
+
+        def get(id)
+          deserialize(@storage.call(GET, id))
+        end
+
+        def set(id, object)
+          @storage.call(SET, id, serialize(object))
+        end
+
+        def delete(id)
+          @storage.call(DELETE, id)
+        end
+
+        private
+
+        # Should always return a string.
+        def serialize(object)
+          [Zlib::Deflate.deflate(@marshaller.dump(object))].pack('m')
+        end
+
+        # Should always return the session object.
+        def deserialize(string)
+          return unless string
+          @marshaller.load(Zlib::Inflate.inflate(string.unpack('m').first))
+        end
+      end
+    end
+  end
+end

data/rack-redic.gemspec

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+Gem::Specification.new do |spec|
+  spec.name    = 'rack-redic'
+  spec.version = '0.0.9'
+  spec.authors = ['Evan Lecklider']
+  spec.email   = ['evan@lecklider.com']
+
+  spec.summary     = 'Rack::Session in Redis via Redic'
+  spec.description = 'Rack::Session in Redis via Redic'
+  spec.homepage    = 'https://github.com/evanleck/rack-redic'
+  spec.license     = 'MIT'
+  spec.files       = `git ls-files`.split("\n")
+
+  spec.add_dependency 'rack'
+  spec.add_dependency 'redic'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rack-redic
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+platform: ruby
+authors:
+- Evan Lecklider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: redic
+  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'
+description: Rack::Session in Redis via Redic
+email:
+- evan@lecklider.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/session/redic.rb
+- rack-redic.gemspec
+homepage: https://github.com/evanleck/rack-redic
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Rack::Session in Redis via Redic
+test_files: []