sequel-sessions 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4201628cc2942c6e826292a9821a3e7e74d25eb6
+  data.tar.gz: 439063bfe5bbfa96d88d2285b2fc6e637925101e
+SHA512:
+  metadata.gz: 073f31a44929aa4a89784c2bd37fe261013be2ac0d456a0a656db1c83ce38bc1ed56339409bfc63feec9373dfb1410f9dda8dc866877c43b22e94b97f9b9d070
+  data.tar.gz: 759b68e936ba516e84adabfb3038dfbec45fc8e7aa9c96ed89c320aa2a784411ba7a556d31c159ddf9aa25556704b47dd26fc125f667d158f48f2069b30ce250

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec  

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Tom Wardrop
+
+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,28 @@
+[sequel-sessions]
+=================
+
+Sequel-based session middleware for Rack 2.0 and above.
+
+https://github.com/wardrop/sequel-sessions
+
+## Installation
+
+gem install sequel-sessions
+
+## Usage
+
+Simplest example using in-memory SQLite database:
+
+```ruby
+use Rack::Session::Sequel, Sequel.sqlite
+```
+
+A more fleshed out example with multiple options:
+
+```ruby
+db_connection = Sequel.connect(adapter: 'mysql', host: 'localhost', username: 'root', database: 'blog')
+use Rack::Session::Sequel, db: db_connection, table_name: :user_sessions, :expire_after => 3600
+```
+
+## License
+Copyright © 2017 Tom Wardrop. Distributed under the [MIT license](http://www.opensource.org/licenses/mit-license).

data/lib/rack/session/sequel.rb

@@ -0,0 +1,74 @@
+module Rack
+  module Session
+    class Sequel < Abstract::Persisted
+
+      DEFAULT_OPTIONS = Abstract::Persisted::DEFAULT_OPTIONS.merge(:table_name => :sessions)
+
+      # Options arguments can be either a Sequel::Database instance, or a hash. Options beyond those defined in
+      # Rack::Session::Abstract::Persisted include:
+      #   :db => The a Sequel database object.
+      #   :table_name => The name of the table to store session data. Defaults to :sessions.
+      def initialize(app, options={})
+        options = {:db => options } if options.is_a? ::Sequel::Database
+        super
+        @mutex = Mutex.new
+        setup_database
+      end
+
+      def find_session(env, sid)
+        record = table.filter(sid: sid).first
+        if record
+          session = Marshal.load(record[:session].unpack('m*').first)
+        else
+          sid, session = generate_sid, {}
+        end
+        [sid, session]
+      end
+
+      def write_session(req, sid, session, options)
+        with_lock(req) do
+          begin
+            table.insert(sid: sid, session: [Marshal.dump(session)].pack('m*'), :created_at => Time.now.utc)
+          rescue ::Sequel::UniqueConstraintViolation
+            table.filter(sid: sid).update(sid: sid, session: [Marshal.dump(session)].pack('m*'), :updated_at => Time.now.utc)
+          end
+          sid
+        end
+      end
+
+      def delete_session(req, sid, options)
+        with_lock(req) do
+          table.filter(sid: sid).delete
+          generate_sid unless options[:drop]
+        end
+      end
+
+      def db
+        @default_options[:db]
+      end
+
+      def table
+        db[@default_options[:table_name].to_sym]
+      end
+
+    protected
+
+      def with_lock(req)
+        @mutex.lock if req.env['rack.multithread']
+        yield
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+
+      def setup_database
+        db.create_table(@default_options[:table_name]) do
+          String :sid, :unique => true, :null => false, :primary_key => true
+          text :session, :null => false
+          DateTime :created_at, :null => false
+          DateTime :updated_at
+        end unless db.table_exists? @default_options[:table_name]
+      end
+
+    end
+  end
+end

data/lib/rack/session/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Session
+    class Sequel
+      VERSION = "1.0"
+    end
+  end
+end

data/lib/sequel-sessions.rb

@@ -0,0 +1,5 @@
+require 'rack'
+require 'rack/session/abstract/id'
+require 'sequel'
+require 'rack/session/sequel'
+require 'rack/session/version'

data/sequel-sessions.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rack/session/version'
+
+Gem::Specification.new 'sequel-sessions', Rack::Session::Sequel::VERSION do |s|
+  s.summary           = 'Sequel-based session middleware for Rack 2.0+'
+  s.description       = 'Sequel-based session middleware for Rack 2.0+'
+  s.authors           = ['Tom Wardrop']
+  s.email             = 'tom@tomwardrop.com'
+  s.homepage          = 'https://github.com/wardrop/sequel-sessions'
+  s.license           = 'MIT'
+  s.files             = Dir.glob(`git ls-files`.split("\n") - %w[.gitignore])
+  s.test_files        = Dir.glob('spec/**/*_spec.rb')
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_runtime_dependency "rack", '>= 2.0'
+  s.add_runtime_dependency "sequel", '>= 4.0'
+  s.add_development_dependency "sqlite3", '>= 1.3'
+  s.add_development_dependency "minitest", '>= 5.1'
+end

data/spec/sequel_sessions_spec.rb

@@ -0,0 +1,217 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# Based on Rack's test/spec_session_pool.rb.
+require 'minitest/autorun'
+require 'thread'
+require 'rack/lint'
+require 'rack/mock'
+require 'sequel-sessions'
+
+describe Rack::Session::Sequel do
+
+  session_key = Rack::Session::Pool::DEFAULT_OPTIONS[:key]
+  session_match = /#{session_key}=[0-9a-fA-F]+;/
+
+  let(:db) { Sequel.sqlite }
+
+  incrementor = lambda do |env|
+    env["rack.session"]["counter"] ||= 0
+    env["rack.session"]["counter"] += 1
+    Rack::Response.new(env["rack.session"].inspect).to_a
+  end
+
+  session_id = Rack::Lint.new(lambda do |env|
+    Rack::Response.new(env["rack.session"].inspect).to_a
+  end)
+
+  nothing = Rack::Lint.new(lambda do |env|
+    Rack::Response.new("Nothing").to_a
+  end)
+
+  drop_session = Rack::Lint.new(lambda do |env|
+    env['rack.session.options'][:drop] = true
+    incrementor.call(env)
+  end)
+
+  renew_session = Rack::Lint.new(lambda do |env|
+    env['rack.session.options'][:renew] = true
+    incrementor.call(env)
+  end)
+
+  defer_session = Rack::Lint.new(lambda do |env|
+    env['rack.session.options'][:defer] = true
+    incrementor.call(env)
+  end)
+
+  incrementor = Rack::Lint.new(incrementor)
+
+  it "creates a new cookie" do
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    res = Rack::MockRequest.new(pool).get("/")
+    res["Set-Cookie"].must_include "#{session_key}="
+    res.body.must_equal '{"counter"=>1}'
+  end
+
+  it "determines session from a cookie" do
+    middleware = Rack::Session::Sequel.new(incrementor, db)
+    req = Rack::MockRequest.new(middleware)
+    cookie = req.get("/")["Set-Cookie"]
+    req.get("/", "HTTP_COOKIE" => cookie).
+      body.must_equal '{"counter"=>2}'
+    req.get("/", "HTTP_COOKIE" => cookie).
+      body.must_equal '{"counter"=>3}'
+  end
+
+  it "survives nonexistant cookies" do
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    res = Rack::MockRequest.new(pool).
+      get("/", "HTTP_COOKIE" => "#{session_key}=blarghfasel")
+    res.body.must_equal '{"counter"=>1}'
+  end
+
+  it "does not send the same session id if it did not change" do
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    req = Rack::MockRequest.new(pool)
+
+    res0 = req.get("/")
+    cookie = res0["Set-Cookie"][session_match]
+    res0.body.must_equal '{"counter"=>1}'
+    pool.table.count.must_equal 1
+
+    res1 = req.get("/", "HTTP_COOKIE" => cookie)
+    res1["Set-Cookie"].must_be_nil
+    res1.body.must_equal '{"counter"=>2}'
+    pool.table.count.must_equal 1
+
+    res2 = req.get("/", "HTTP_COOKIE" => cookie)
+    res2["Set-Cookie"].must_be_nil
+    res2.body.must_equal '{"counter"=>3}'
+    pool.table.count.must_equal 1
+  end
+
+  it "deletes cookies with :drop option" do
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    req = Rack::MockRequest.new(pool)
+    drop = Rack::Utils::Context.new(pool, drop_session)
+    dreq = Rack::MockRequest.new(drop)
+
+    res1 = req.get("/")
+    session = (cookie = res1["Set-Cookie"])[session_match]
+    res1.body.must_equal '{"counter"=>1}'
+    pool.table.count.must_equal 1
+
+    res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
+    res2["Set-Cookie"].must_be_nil
+    res2.body.must_equal '{"counter"=>2}'
+    pool.table.count.must_equal 0
+
+    res3 = req.get("/", "HTTP_COOKIE" => cookie)
+    res3["Set-Cookie"][session_match].wont_equal session
+    res3.body.must_equal '{"counter"=>1}'
+    pool.table.count.must_equal 1
+  end
+
+  it "provides new session id with :renew option" do
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    req = Rack::MockRequest.new(pool)
+    renew = Rack::Utils::Context.new(pool, renew_session)
+    rreq = Rack::MockRequest.new(renew)
+
+    res1 = req.get("/")
+    session = (cookie = res1["Set-Cookie"])[session_match]
+    res1.body.must_equal '{"counter"=>1}'
+    pool.table.count.must_equal 1
+
+    res2 = rreq.get("/", "HTTP_COOKIE" => cookie)
+    new_cookie = res2["Set-Cookie"]
+    new_session = new_cookie[session_match]
+    new_session.wont_equal session
+    res2.body.must_equal '{"counter"=>2}'
+    pool.table.count.must_equal 1
+
+    res3 = req.get("/", "HTTP_COOKIE" => new_cookie)
+    res3.body.must_equal '{"counter"=>3}'
+    pool.table.count.must_equal 1
+
+    res4 = req.get("/", "HTTP_COOKIE" => cookie)
+    res4.body.must_equal '{"counter"=>1}'
+    pool.table.count.must_equal 2
+  end
+
+  it "omits cookie with :defer option" do
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    defer = Rack::Utils::Context.new(pool, defer_session)
+    dreq = Rack::MockRequest.new(defer)
+
+    res1 = dreq.get("/")
+    res1["Set-Cookie"].must_be_nil
+    res1.body.must_equal '{"counter"=>1}'
+    pool.table.count.must_equal 1
+  end
+
+  # anyone know how to do this better?
+  it "should merge sessions when multithreaded" do
+    unless $DEBUG
+      1.must_equal 1
+      next
+    end
+
+    warn 'Running multithread tests for Session::Pool'
+    pool = Rack::Session::Sequel.new(incrementor, db)
+    req = Rack::MockRequest.new(pool)
+
+    res = req.get('/')
+    res.body.must_equal '{"counter"=>1}'
+    cookie = res["Set-Cookie"]
+    sess_id = cookie[/#{pool.key}=([^,;]+)/,1]
+
+    delta_incrementor = lambda do |env|
+      # emulate disconjoinment of threading
+      env['rack.session'] = env['rack.session'].dup
+      Thread.stop
+      env['rack.session'][(Time.now.usec*rand).to_i] = true
+      incrementor.call(env)
+    end
+    tses = Rack::Utils::Context.new pool, delta_incrementor
+    treq = Rack::MockRequest.new(tses)
+    tnum = rand(7).to_i+5
+    r = Array.new(tnum) do
+      Thread.new(treq) do |run|
+        run.get('/', "HTTP_COOKIE" => cookie, 'rack.multithread' => true)
+      end
+    end.reverse.map{|t| t.run.join.value }
+    r.each do |resp|
+      resp['Set-Cookie'].must_equal cookie
+      resp.body.must_include '"counter"=>2'
+    end
+
+    session = pool.pool[sess_id]
+    session.size.must_equal tnum+1 # counter
+    session['counter'].must_equal 2 # meeeh
+  end
+
+  it "does not return a cookie if cookie was not read/written" do
+    app = Rack::Session::Sequel.new(nothing, db)
+    res = Rack::MockRequest.new(app).get("/")
+    res["Set-Cookie"].must_be_nil
+  end
+
+  it "does not return a cookie if cookie was not written (only read)" do
+    app = Rack::Session::Sequel.new(session_id, db)
+    res = Rack::MockRequest.new(app).get("/")
+    res["Set-Cookie"].must_be_nil
+  end
+
+  it "returns even if not read/written if :expire_after is set" do
+    app = Rack::Session::Sequel.new(nothing, :expire_after => 3600, :db => db)
+    res = Rack::MockRequest.new(app).get("/", 'rack.session' => {'not' => 'empty'})
+    res["Set-Cookie"].wont_be :nil?
+  end
+
+  it "returns no cookie if no data was written and no session was created previously, even if :expire_after is set" do
+    app = Rack::Session::Sequel.new(nothing, :expire_after => 3600, :db => db)
+    res = Rack::MockRequest.new(app).get("/")
+    res["Set-Cookie"].must_be_nil
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: sequel-sessions
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Tom Wardrop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Sequel-based session middleware for Rack 2.0+
+email: tom@tomwardrop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/rack/session/sequel.rb
+- lib/rack/session/version.rb
+- lib/sequel-sessions.rb
+- sequel-sessions.gemspec
+- spec/sequel_sessions_spec.rb
+homepage: https://github.com/wardrop/sequel-sessions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Sequel-based session middleware for Rack 2.0+
+test_files:
+- spec/sequel_sessions_spec.rb