rack-redic 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf92c89449d8d8709de10c6764860f6bf170e5d0
-  data.tar.gz: bf999b9c9675ad376c52ae1eb6df3042f6c4d7a1
+SHA256:
+  metadata.gz: b5d2082c913c7e03778bf029522eaf82c69321d279d2faba665d6fb72f6d60ad
+  data.tar.gz: e3ee0c189726c401312cb2fccf54dd7c491d1788ef0baf4c74e2649715bc0f3d
 SHA512:
-  metadata.gz: 245c12a951c0c0c395064a64ab594f2d5e8774979bdcb3feb23fc855666612e50db63eead26aa5df911287a7c1f184918ea1a2cc69ae01f07f52e8fa17c0807b
-  data.tar.gz: 5a0d6bff6ad7faae40884f75174d43728e87ea4526f73eb0b826ac414a2f05851b4c10f643ee0c53fb1bae5faa6ae6fe58f52f6222c1df731ff33d331b9f8e3a
+  metadata.gz: bee20ab72c2041aeb81c944c9635d5c736f5074854ec016d0c695a85979a9ddb5ed78c1940d5993e684c2cc6b6107dd105bdf4c8b794cdb72e199e11d9eb3ce0
+  data.tar.gz: fa4455eb28f23b911dd1ce00441d6098f2386373f0fc74162e4b9f4b7e2cf614ca7f08b9391fab8f2cc923159191a9079614d1f225dea85300ec3bc682965c9a

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/gems.locked
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -0,0 +1,55 @@
+# http://rubocop.readthedocs.io
+# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  TargetRubyVersion: 2.4
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Style/Documentation:
+#   Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Next:
+  MinBodyLength: 8

data/README.md

@@ -13,7 +13,7 @@ Any other options will get passed to `Rack::Session::Abstract::Persisted`.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile or gems.rb file:
 
 ```ruby
 gem 'rack-redic', require: 'rack/session/redic'

data/Rakefile

@@ -1,3 +1,2 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 require 'bundler/gem_tasks'

data/{Gemfile → gems.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Load gem dependencies.

data/lib/rack/session/redic.rb

@@ -1,11 +1,10 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 require 'rack/session/abstract/id'
 require 'redic'
+require 'securerandom'
 
 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.
@@ -25,46 +24,64 @@ module Rack
     #   refresh the expiration set in Redis with each request.
     #
     # Any other options will get passed to Rack::Session::Abstract::Persisted.
-    #
     class Redic < Abstract::Persisted
-      REDIS_URL = 'REDIS_URL'.freeze
-
+      # Redis commands.
+      DELETE = 'DEL'
+      EX = 'EX'
+      EXISTS = 'EXISTS'
+      GET = 'GET'
+      SET = 'SET'
+
+      # Assorted.
+      REDIS_URL = 'REDIS_URL'
+      ZERO = 0
+
+      # Access the storage interface directly. Needed for testing.
+      #
+      # @return [Redic]
       attr_reader :storage
 
       def initialize(app, options = {})
         super
 
+        @expires = options[:expire_after]
+        @marshaller = options.fetch(:marshaller) { Marshal }
         @mutex = Mutex.new
-        @storage = Storage.new(
-          options[:expire_after],
-          options.fetch(:marshaller) { Marshal },
-          options.fetch(:url) { ENV.fetch(REDIS_URL) }
-        )
+        @storage = ::Redic.new(options.fetch(:url) { ENV.fetch(REDIS_URL) })
       end
 
-      # Only accept a generated session ID if it doesn't exist.
+      # Generate a session ID that doesn't already exist.
+      #
+      # Based on Rack::Session::Abstract::Persisted#generate_sid and
+      # Rack::Session::Memcache#generate_sid but without the conditional check.
+      # We always generate the session ID from SecureRandom#hex.
+      #
+      # @return [String]
       def generate_sid
         loop do
-          sid = super
-          break sid unless @storage.exists?(sid)
+          session_id = SecureRandom.hex(@sid_length)
+          break session_id unless @storage.call(EXISTS, session_id) != ZERO
         end
       end
 
       # Find the session (or generate a blank one).
-      def find_session(_req, sid)
+      def find_session(_req, session_id)
         @mutex.synchronize do
-          unless sid && session = @storage.get(sid)
-            sid, session = generate_sid, {}
+          unless session_id && (session = deserialize(@storage.call(GET, session_id)))
+            session_id, session = generate_sid, {} # rubocop:disable Style/ParallelAssignment
           end
 
-          [sid, session]
+          [session_id, session]
         end
       end
 
       # Write the session.
       def write_session(_req, session_id, new_session, _options)
+        arguments = [SET, session_id, serialize(new_session)]
+        arguments += [EX, @expires] if @expires
+
         @mutex.synchronize do
-          @storage.set(session_id, new_session)
+          @storage.call(*arguments)
 
           session_id
         end
@@ -73,105 +90,34 @@ module Rack
       # Kill the session.
       def delete_session(_req, session_id, options)
         @mutex.synchronize do
-          @storage.delete(session_id)
+          @storage.call(DELETE, session_id)
           generate_sid unless options[:drop]
         end
       end
 
-      # A wrapper around Redic to simplify calls.
-      class Storage
-        # Redis commands.
-        DELETE = 'DEL'.freeze
-        EX = 'EX'.freeze
-        EXISTS = 'EXISTS'.freeze
-        GET = 'GET'.freeze
-        SET = 'SET'.freeze
-
-        # Assorted.
-        ZERO = 0
-
-        # @param expires [Integer]
-        #   The number of seconds for Redis to retain keys.
-        # @param marshaller [#dump, #load]
-        #   The module or class used to marshal objects. It must respond to
-        #   #dump and #load.
-        # @param url [String]
-        #   The URL to access Redis at.
-        def initialize(expires, marshaller, url)
-          @expires = expires
-          @marshaller = marshaller
-          @storage = ::Redic.new(url)
-        end
-
-        # Check for an identifier's existence.
-        #
-        # @param id [String]
-        #   The key to check for.
-        # @return [Boolean]
-        def exists?(id)
-          @storage.call(EXISTS, id) != ZERO
-        end
-
-        # Retrieve an object.
-        #
-        # @param id [String]
-        #   The key in Redis to retrieve from.
-        # @return [Object, nil]
-        #   The object stored at the identifier provided, or nil.
-        def get(id)
-          deserialize(@storage.call(GET, id))
-        end
-
-        # Store an object.
-        #
-        # @param id [String]
-        #   The key to use to store the object.
-        # @param object [Object]
-        #   Any object that can be serialized.
-        # @return [String]
-        #   See {https://redis.io/commands/set#return-value Redis' docs for more}.
-        def set(id, object)
-          arguments = [SET, id, serialize(object)]
-          arguments += [EX, @expires] if @expires
-
-          @storage.call(*arguments)
-        end
-
-        # Remove an object.
-        #
-        # @param id [String]
-        #   The key to delete.
-        # @return [Integer]
-        #   The number of keys that were deleted. See
-        #   {https://redis.io/commands/del#return-value Redis' docs for more}.
-        def delete(id)
-          @storage.call(DELETE, id)
-        end
-
-        private
-
-        # Serialize an object using our marshaller.
-        #
-        # @param object [Object]
-        # @return [String]
-        #   The object serialized by the marshaller.
-        def serialize(object)
-          @marshaller.dump(object)
-        end
-
-        # Deserialize a string back into an object.
-        #
-        # @param string [String]
-        # @return [Object, nil]
-        #   Returns the object as loaded by the marshaller, or nil.
-        def deserialize(string)
-          @marshaller.load(string) if string
-
-        # In the case that loading fails, return a nil.
-        rescue
-          nil
-        end
+      # Serialize an object using our marshaller.
+      #
+      # @param object [Object]
+      # @return [String]
+      #   The object as serialized by the marshaller.
+      def serialize(object)
+        @marshaller.dump(object)
+      end
+      private :serialize
+
+      # Deserialize a string back into an object.
+      #
+      # @param string [String]
+      # @return [Object, nil]
+      #   Returns the object as loaded by the marshaller, or nil.
+      def deserialize(string)
+        @marshaller.load(string) if string
+
+      # In the case that loading fails, return a nil.
+      rescue # rubocop:disable Lint/RescueWithoutErrorClass
+        nil
       end
+      private :deserialize
     end
   end
 end

data/rack-redic.gemspec

@@ -1,8 +1,7 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 Gem::Specification.new do |spec|
   spec.name    = 'rack-redic'
-  spec.version = '1.3.0'
+  spec.version = '1.4.0'
   spec.authors = ['Evan Lecklider']
   spec.email   = ['evan@lecklider.com']
 
@@ -17,6 +16,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'redic'
 
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'msgpack'
-  spec.add_development_dependency 'oj'
+  spec.add_development_dependency 'rubocop'
 end

data/test/all.rb

@@ -1,5 +1,5 @@
-# encoding: UTF-8
 # frozen_string_literal: true
+require_relative 'helper'
 
 # Require all test files.
 Dir.glob('test/*.rb').each(&method(:require))

data/test/helper.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 
 # Add our project folder to the root of our load path.
@@ -8,7 +7,7 @@ $LOAD_PATH.unshift File.expand_path('../..', __FILE__)
 ENV['REDIS_URL'] ||= 'redis://localhost:6379'
 
 # Require our core library.
-require 'rack/session/redic'
+require 'lib/rack/session/redic'
 
 # Kick off the tests.
 require 'minitest/autorun'

data/test/session_redic_test.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 require 'rack/lint'
 require 'rack/mock'
@@ -9,7 +8,7 @@ describe Rack::Session::Redic do
   ROOT = '/'
 
   session_key = Rack::Session::Abstract::Persisted::DEFAULT_OPTIONS[:key]
-  session_match = /#{session_key}=([0-9a-fA-F]+);/
+  session_match = /#{ session_key }=([0-9a-fA-F]+);/
 
   incrementor = lambda do |env|
     env['rack.session']['counter'] ||= 0
@@ -65,8 +64,8 @@ describe Rack::Session::Redic do
     response = request.get(ROOT)
     sid = response[Rack::SET_COOKIE][session_match, 1]
 
-    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>1}'
-    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>1}'
+    assert_equal request.get("/?rack.session=#{ sid }").body, '{"counter"=>1}'
+    assert_equal request.get("/?rack.session=#{ sid }").body, '{"counter"=>1}'
   end
 
   it 'determines session from params' do
@@ -75,8 +74,8 @@ describe Rack::Session::Redic do
     response = request.get(ROOT)
     sid = response[Rack::SET_COOKIE][session_match, 1]
 
-    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>2}'
-    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>3}'
+    assert_equal request.get("/?rack.session=#{ sid }").body, '{"counter"=>2}'
+    assert_equal request.get("/?rack.session=#{ sid }").body, '{"counter"=>3}'
   end
 
   it 'survives nonexistant cookies' do
@@ -88,7 +87,7 @@ describe Rack::Session::Redic do
     assert_equal response.body, '{"counter"=>1}'
 
     cookie = response[Rack::SET_COOKIE][session_match]
-    refute_match /#{ bad_cookie }/, cookie
+    refute_match(/#{ bad_cookie }/, cookie)
   end
 
   it 'maintains freshness' do
@@ -224,10 +223,10 @@ describe Rack::Session::Redic do
 
     res0 = request.get(ROOT)
     session_id = (cookie = res0[Rack::SET_COOKIE])[session_match, 1]
-    ses0 = redic.storage.get(session_id)
+    ses0 = redic.storage.call('GET', session_id)
 
     request.get(ROOT, Rack::HTTP_COOKIE => cookie)
-    ses1 = redic.storage.get(session_id)
+    ses1 = redic.storage.call('GET', session_id)
 
     refute_equal ses1, ses0
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-redic
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -53,21 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: msgpack
-  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'
-- !ruby/object:Gem::Dependency
-  name: oj
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,21 +75,18 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - Makefile
 - README.md
 - Rakefile
+- gems.rb
 - lib/rack/session/redic.rb
 - rack-redic.gemspec
 - test/all.rb
 - test/helper.rb
 - test/session_redic_test.rb
-- test/storage_msgpack_test.rb
-- test/storage_oj_test.rb
-- test/storage_test.rb
-- test/support/storage_marshaller_interface.rb
 homepage: https://github.com/evanleck/rack-redic
 licenses:
 - MIT
@@ -124,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Rack::Session in Redis via Redic
@@ -132,7 +115,3 @@ test_files:
 - test/all.rb
 - test/helper.rb
 - test/session_redic_test.rb
-- test/storage_msgpack_test.rb
-- test/storage_oj_test.rb
-- test/storage_test.rb
-- test/support/storage_marshaller_interface.rb

data/test/storage_msgpack_test.rb

@@ -1,28 +0,0 @@
-# encoding: UTF-8
-# frozen_string_literal: true
-require 'msgpack'
-require_relative 'support/storage_marshaller_interface'
-
-MessagePack::DefaultFactory.register_type(0x00, Symbol)
-
-module MessagePackMarshaller
-  def dump(object)
-    MessagePack.pack(object)
-  end
-  module_function :dump
-
-  def load(string)
-    MessagePack.unpack(string)
-  end
-  module_function :load
-end
-
-describe Rack::Session::Redic::Storage do
-  describe 'using the MessagePack as the marshaller' do
-    include StorageMarshallerInterface
-
-    before do
-      @store = Rack::Session::Redic::Storage.new(nil, MessagePackMarshaller, ENV['REDIS_URL'])
-    end
-  end
-end

data/test/storage_oj_test.rb

@@ -1,14 +0,0 @@
-# encoding: UTF-8
-# frozen_string_literal: true
-require 'oj'
-require_relative 'support/storage_marshaller_interface'
-
-describe Rack::Session::Redic::Storage do
-  describe 'using the Oj as the marshaller' do
-    include StorageMarshallerInterface
-
-    before do
-      @store = Rack::Session::Redic::Storage.new(nil, Oj, ENV['REDIS_URL'])
-    end
-  end
-end

data/test/storage_test.rb

@@ -1,13 +0,0 @@
-# encoding: UTF-8
-# frozen_string_literal: true
-require_relative 'support/storage_marshaller_interface'
-
-describe Rack::Session::Redic::Storage do
-  describe 'using the default marshaller' do
-    include StorageMarshallerInterface
-
-    before do
-      @store = Rack::Session::Redic::Storage.new(nil, Marshal, ENV['REDIS_URL'])
-    end
-  end
-end

data/test/support/storage_marshaller_interface.rb

@@ -1,30 +0,0 @@
-# encoding: UTF-8
-# frozen_string_literal: true
-module StorageMarshallerInterface
-  def test_returns_nil_for_empty_keys
-    assert_nil @store.get('not-here')
-  end
-
-  def test_saves_objects
-    object = { saved: true }
-    @store.set('saving', object)
-
-    assert_equal @store.get('saving'), object
-  end
-
-  def test_existence_of_keys
-    @store.set('exists', false)
-
-    assert_equal @store.exists?('exists'), true
-  end
-
-  def test_deletes_objects
-    object = { deleted: true }
-    @store.set('deleted', object)
-
-    assert_equal @store.get('deleted'), object
-    @store.delete('deleted')
-
-    assert_nil @store.get('deleted')
-  end
-end