mongo_session_store-rails 7.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fae6c0b168c889f3ddc4cdde51ba533c186a3cc6
+  data.tar.gz: 6a7734c7e98396f397ca7e365a46639536bf056a
+SHA512:
+  metadata.gz: 88a8e26cc229350d17101cdc2d9e7ca2b43b6b0ff37d076b7e14fadfe4b165da6a70724a32baccec3d36eea25195c31a2b5a5e28c259335d01b8554809915eab
+  data.tar.gz: 54ebfe5d1f4a1db26444f7d5748740d960a4e3828d79504e1b313ec08ffa79c2889c8a23ecdc2b88f07920e488a6ef5cbf58e4601a50310dbf2dd5dd70b87016

data/.gitignore

@@ -0,0 +1,8 @@
+/doc
+/coverage
+Gemfile.lock
+gemfiles/*.lock
+spec/support/apps/rails_*/tmp/
+spec/support/apps/rails_*/db/*.sqlite3
+*.gem
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+  TargetRubyVersion: 2.0
+  Include:
+    - "Gemfile"
+  Exclude:
+    - "lib/mongo_session_store-rails.rb"
+    - "gemfiles/vendor/**/*"
+    - "perf/benchmark.rb"
+    - "spec/support/apps/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  DisplayCopNames: true
+  UseCache: true
+  CacheRootDirectory: ./tmp
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+cache: bundler
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+  - "2.2.0"
+  - "2.3.0"
+gemfile:
+  - "gemfiles/rails-4.0-mongo.gemfile"
+  - "gemfiles/rails-4.0-mongoid.gemfile"
+  - "gemfiles/rails-4.1-mongo.gemfile"
+  - "gemfiles/rails-4.1-mongoid.gemfile"
+  - "gemfiles/rails-4.2-mongo.gemfile"
+  - "gemfiles/rails-4.2-mongoid.gemfile"
+matrix:
+  fast_finish: true
+  include:
+    - rvm: "2.3.0"
+      gemfile: "gemfiles/rails-4.2-mongo.gemfile"
+      script: "bundle exec rubocop"
+
+before_script:
+  - wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.0.1.tgz -O /tmp/mongodb.tgz
+  - tar -xvf /tmp/mongodb.tgz
+  - mkdir /tmp/data
+  - ${PWD}/mongodb-linux-x86_64-3.0.1/bin/mongod --dbpath /tmp/data --bind_ip 127.0.0.1 &> /dev/null &
+
+script:
+  - "bundle exec rake test"

data/Gemfile

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

data/README.md

@@ -0,0 +1,144 @@
+# MongoSessionStore
+
+[![Build Status](https://travis-ci.org/appsignal/mongo_session_store.png?branch=master)](https://travis-ci.org/appsignal/mongo_session_store) [![Gem Version](https://badge.fury.io/rb/mongo_session_store-rails.svg)](http://badge.fury.io/rb/mongo_session_store-rails)
+
+## Description
+
+MongoSessionStore is a Rails-compatible session store for Mongo using either
+Mongoid or the Ruby MongoDB driver. It also allows for custom Mongo session
+store that works with any (or no!) Mongo ODM.
+
+## Usage
+
+MongoSessionStore is compatible with Rails 4.0 through 4.2.
+
+In your Gemfile:
+
+```ruby
+gem "mongoid"
+# or gem "mongo"
+gem "mongo_session_store-rails"
+```
+
+In the session_store initializer:
+
+```ruby
+# config/initializers/session_store.rb
+
+# Mongoid
+MyApp::Application.config.session_store :mongoid_store
+
+# anything else
+MongoStore::Session.database = Mongo::Client.new(["127.0.0.1:27017"], database: "my_app_development")
+MyApp::Application.config.session_store :mongo_store
+```
+
+By default, the sessions will be stored in the "sessions" collection in
+MongoDB. If you want to use a different collection, you can set that in the
+initializer:
+
+```ruby
+# config/initializers/session_store.rb
+MongoSessionStore.collection_name = "client_sessions"
+```
+
+And if you want to query your sessions:
+
+```ruby
+# Mongoid
+MongoidStore::Session.where(:updated_at.gt => 2.days.ago)
+
+# Plain old Mongo
+MongoStore::Session.where('updated_at' => { '$gt' => 2.days.ago })
+```
+
+## Changelog
+
+7.0.0 Drops explicit MongoMapper support, but can be readded manually with a
+custom session class. Drops explicit JRuby support. Moved session data packing
+and unpacking to the session models themselves. Adds more tests to internals.
+
+6.0.0 supports the Mongo Ruby Driver 2.0 for the generic MongoStore. The other
+stores are unchanged. Tests added for Rails 4.2. Tests against MongoDB 3.0.1 on
+Travis CI.
+
+5.1.0 generates a new session ID when a session is not found. Previously, when
+a session ID is provided in the request but the session was not found (because
+for example, it was removed from Mongo by a sweeper job) a new session with the
+provided ID would be created. This would cause a write error if two
+simultaneous requests both create a session with the same ID and both try to
+insert a new document with that ID.
+
+5.0.1 suppresses a warning from Mongoid 4 when setting the _id field type to
+String.
+
+5.0.0 introduces Rails 4.0 and 4.1 support and Mongoid 4 support alongside the
+existing Rails 3.1, 3.2, and Mongoid 3 support. Ruby 1.8.7 support is dropped.
+The database is no longer set automatically for the MongoStore when MongoMapper
+or Mongoid is present. You have to set the database manually whenever you
+choose to use the vanilla MongoStore.
+
+The last version to support Ruby 1.8.7 is [version
+4.1.1](https://rubygems.org/gems/mongo_session_store-rails3/versions/4.1.1).
+
+The last version to support Rails 3.0 or Mongoid 2 is [version
+3.0.6](https://rubygems.org/gems/mongo_session_store-rails3/versions/3.0.6).
+
+## Development
+
+To run all the tests:
+
+```sh
+rake
+```
+
+To run the tests for a specific store:
+
+```sh
+BUNDLE_GEMFILE=gemfiles/rails-4.0-mongo.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails-4.0-mongoid.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails-4.1-mongo.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails-4.1-mongoid.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails-4.2-mongo.gemfile bundle exec rake
+BUNDLE_GEMFILE=gemfiles/rails-4.2-mongoid.gemfile bundle exec rake
+```
+
+## Previous contributors
+
+MongoSessionStore started as a fork of the DataMapper session store, modified
+to work with MongoMapper and Mongoid. Much thanks to all the previous
+contributors:
+
+* Nicolas Mérouze
+* Chris Brickley
+* Tony Pitale
+* Nicola Racco
+* Matt Powell
+* Ryan Fitzgerald
+* Brian Hempel
+
+## License
+
+Copyright (c) 2016 Tom de Bruijn  
+Copyright (c) 2011-2015 Brian Hempel  
+Copyright (c) 2010 Nicolas Mérouze  
+Copyright (c) 2009 Chris Brickley  
+Copyright (c) 2009 Tony Pitale  
+
+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/Rakefile

@@ -0,0 +1,87 @@
+require "rspec/core/rake_task"
+
+task :mongo_prepare do
+  # Wait for mongod to start on Travis.
+  # From the Mongo Ruby Driver gem.
+  if ENV["TRAVIS"]
+    require "mongo"
+    client = Mongo::Client.new(["127.0.0.1:27017"])
+    begin
+      puts "Waiting for MongoDB..."
+      client.command("ismaster" => 1)
+    rescue Mongo::Error::NoServerAvailable => e
+      sleep(2)
+      # 1 Retry
+      puts "Waiting for MongoDB..."
+      client.cluster.scan!
+      client.command(Mongo::Error::NoServerAvailable)
+    end
+  end
+end
+
+desc "Run the mongo_session_store gem test suite."
+RSpec::Core::RakeTask.new :test => :mongo_prepare
+
+task :release do
+  GEMSPEC_NAME = "mongo_session_store"
+  GEM_NAME = "mongo_session_store-rails"
+  VERSION_FILE = "lib/mongo_session_store/version.rb"
+
+  def reload_version
+    if defined?(MongoSessionStore::VERSION)
+      MongoSessionStore.send(:remove_const, :VERSION)
+    end
+    load File.expand_path(VERSION_FILE)
+  end
+
+  raise "$EDITOR should be set" unless ENV["EDITOR"]
+
+  def build_and_push_gem
+    puts '# Building gem'
+    puts `gem build #{GEMSPEC_NAME}.gemspec`
+    puts '# Publishing Gem'
+    puts `gem push #{GEM_NAME}-#{gem_version}.gem`
+  end
+
+  def update_repo
+    puts `git commit -am "Bump to #{version} [ci skip]"`
+    begin
+      puts `git tag #{version}`
+      puts `git push origin #{version}`
+      puts `git push origin master`
+    rescue
+      raise %(Tag: "#{version}" already exists)
+    end
+  end
+
+  def changes
+    git_status_to_array(`git status -s -u`)
+  end
+
+  def gem_version
+    MongoSessionStore::VERSION
+  end
+
+  def version
+    @version ||= "v" << gem_version
+  end
+
+  def git_status_to_array(changes)
+    changes.split("\n").map { |change| change.gsub(/^.. /, "") }
+  end
+
+  raise "Branch should hold no uncommitted file change)" unless changes.empty?
+
+  reload_version
+
+  system("$EDITOR #{VERSION_FILE}")
+  if changes.include?(VERSION_FILE)
+    reload_version
+    build_and_push_gem
+    update_repo
+  else
+    raise "Actually change the version in: #{VERSION_FILE}"
+  end
+end
+
+task :default => :test

data/gemfiles/rails-4.0-mongo.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "mongo"
+
+gem "rails", "4.0"
+gem "devise", "~> 3.5"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails-4.0-mongoid.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "mongoid"
+
+gem "rails", "4.0"
+gem "devise", "~> 3.5"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails-4.1-mongo.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "mongo"
+
+gem "rails", "4.1"
+gem "devise", Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1") ? "3.5.10" : ">= 4.2"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails-4.1-mongoid.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "mongoid"
+
+gem "rails", "4.1"
+gem "devise", Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1") ? "3.5.10" : ">= 4.2"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails-4.2-mongo.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "mongo"
+
+gem "rails", "4.2"
+gem "devise", Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1") ? "3.5.10" : ">= 4.2"
+gem "sqlite3"
+
+gemspec :path => "../"

data/gemfiles/rails-4.2-mongoid.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "mongoid"
+
+gem "rails", "4.2"
+gem "devise", Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1") ? "3.5.10" : ">= 4.2"
+gem "sqlite3"
+
+gemspec :path => "../"

data/lib/mongo_session_store-rails.rb

@@ -0,0 +1 @@
+require "mongo_session_store"

data/lib/mongo_session_store.rb

@@ -0,0 +1,27 @@
+module MongoSessionStore
+  def self.collection_name
+    @collection_name
+  end
+
+  def self.collection_name=(name)
+    @collection_name = name
+
+    if defined?(MongoStore::Session)
+      MongoStore::Session.reset_collection
+    elsif defined?(MongoidStore::Session)
+      MongoidStore::Session.store_in \
+        :collection => MongoSessionStore.collection_name
+    end
+
+    @collection_name
+  end
+
+  # default collection name for all the stores
+  self.collection_name = "sessions"
+end
+
+if defined?(Mongoid)
+  require "mongo_session_store/mongoid_store"
+elsif defined?(Mongo)
+  require "mongo_session_store/mongo_store"
+end

data/lib/mongo_session_store/mongo_store.rb

@@ -0,0 +1,102 @@
+require "mongo_session_store/mongo_store_base"
+
+module ActionDispatch
+  module Session
+    class MongoStore < MongoStoreBase
+      class Session
+        class << self
+          attr_writer :database
+
+          def load(options = {})
+            options[:data] = options["data"] if options["data"]
+            options[:data] =
+              if options[:data]
+                unpack(options[:data])
+              else
+                {}
+              end
+            new(options)
+          end
+
+          def where(query = {})
+            collection.find(query).map { |doc| load(doc) }
+          end
+
+          def database
+            return @database if @database
+
+            raise NoMongoClientError, "MongoStore needs a database, e.g. "\
+              "MongoStore::Session.database = Mongo::Client.new("\
+              "[\"127.0.0.1:27017\"], database: \"my_app_development\")"
+          end
+
+          def collection
+            @collection ||= database[MongoSessionStore.collection_name]
+          end
+
+          def reset_collection
+            @collection = nil
+          end
+
+          private
+
+          def unpack(packed)
+            return unless packed
+            data = packed.respond_to?(:data) ? packed.data : packed.to_s
+            Marshal.load(StringIO.new(data))
+          end
+        end
+
+        class NoMongoClientError < StandardError; end
+
+        attr_accessor :_id, :data, :created_at, :updated_at
+
+        def initialize(options = {})
+          @_id        = options[:_id]
+          @data       = options[:data]
+          @created_at = options[:created_at]
+          @updated_at = options[:updated_at]
+        end
+
+        def save
+          @created_at ||= Time.now.utc
+          @updated_at = Time.now.utc
+
+          scope.replace_one(attributes_for_save, :upsert => true)
+        end
+
+        def destroy
+          scope.delete_one
+        end
+
+        private
+
+        def collection
+          self.class.collection
+        end
+
+        def attributes_for_save
+          {
+            :data => pack(data),
+            :created_at => created_at,
+            :updated_at => updated_at
+          }
+        end
+
+        def scope
+          collection.find(:_id => _id)
+        end
+
+        def pack(data)
+          BSON::Binary.new(Marshal.dump(data || {}), :generic)
+        end
+
+        def unpack(packed)
+          self.class.unpack(packed)
+        end
+      end
+    end
+  end
+end
+
+MongoStore = ActionDispatch::Session::MongoStore