mongo_session_store 2.0.0 → 3.0.0.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51de0786fae5ce817ce7a6560c1c1e7155bb6e61
+  data.tar.gz: 755e1e50213bd4dd4920f606e1b900cab0fe4aba
+SHA512:
+  metadata.gz: 1112e027b5b5591b44fdbad4e19c216c71aad8aa5657d018384cd69c90a1ec3860181f66fac6c1182c10f63cac2d91086effba229df907a2178f8005682644a5
+  data.tar.gz: c34f5a35cc48c92e385d8ead77fa875b7a345a3752d64d409206bb2080cff74c71cf4d18247dfa1b8ac6a9942bd4b81dbe6f37c532f9b1b99a690df89fe814c3

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,43 @@
+AllCops:
+  TargetRubyVersion: 2.0
+  Include:
+    - "Gemfile"
+  Exclude:
+    - "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,37 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.3.1
+  - 2.1.10
+
+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.1
+      gemfile: gemfiles/rails-4.2-mongo.gemfile
+      script: bundle exec rubocop
+    - rvm: 2.3.1
+      gemfile: gemfiles/rails-4.2-mongo.gemfile
+      script: bundle exec danger
+
+services: mongodb
+
+addons:
+  apt:
+    sources:
+      - mongodb-3.2-precise
+    packages:
+      - mongodb-org-server
+
+script:
+  - bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+## 3.0.0 (unreleased)
+
+* Drop Ruby 1.8, 1.9 and 2.0 support - [@tombruijn](https://github.com/tombruijn).
+* Drop explicit MongoMapper support - [@tombruijn](https://github.com/tombruijn).
+* Drop MongoDB version 2 support - [@brianhempel](https://github.com/brianhempel).
+* Support MongoDB version 3 - [@brianhempel](https://github.com/brianhempel).
+* Update Mongo Ruby driver support for more recent versions - [@brianhempel](https://github.com/brianhempel), [@tombruijn](https://github.com/tombruijn).
+* Update Mongoid support for more recent versions - [@brianhempel](https://github.com/brianhempel), [@tombruijn](https://github.com/tombruijn).
+* Add Mongo Ruby driver session store support - [@brianhempel](https://github.com/brianhempel).
+* Add Rails 4 support - [@brianhempel](https://github.com/brianhempel).
+* Remove explicit Rails 3 support - [@tombruijn](https://github.com/tombruijn).
+* Move session data packing and unpacking to session models. This allows queried documents to unpack session data themselves - [@tombruijn](https://github.com/tombruijn).
+* Test more internal code - [@tombruijn](https://github.com/tombruijn).
+* Allow for easier custom classes and expanded behavior of Mongoid and Mongo session stores - [@tombruijn](https://github.com/tombruijn).
+* [#24](https://github.com/mongoid/mongo_session_store/pull/24): Add Danger, PR linter - [@tombruijn](https://github.com/tombruijn), [@dblock](https://github.com/dblock).
+* [#27](https://github.com/mongoid/mongo_session_store/pull/27): Run tests against Ruby 2.3.1 and MongoDB 3.2 only - [@dblock](https://github.com/dblock).
+* [#29](https://github.com/mongoid/mongo_session_store/pull/29): Use rails default session id generation - [@tombruijn](https://github.com/tombruijn).
+* Your contribution here.
+
+## 2.0.0
+
+* Fix MongoMapper indexes - [@nmerouze](https://github.com/nmerouze).
+* Add Rails 3 support for Mongoid - [@nmerouze](https://github.com/nmerouze).
+* Add Rails 3 support for MongoMapper - [@nmerouze](https://github.com/nmerouze).
+* Support MongoMapper 0.7.5 - [@hsbt](https://github.com/hsbt).
+* Fix issue where ActionPack expects `set_session` to return the (new) session_id when session is created successfully - [@memuller](https://github.com/memuller).
+
+## 1.1.2
+
+* Generate a new session document if the current session document doesn't exist - [@shingara](https://github.com/shingara).
+
+## 1.1.1
+
+* Fix `updated_at` index for MongoMapper session documents - [@nmerouze](https://github.com/nmerouze).
+
+## 1.1.0
+
+* Add Mongoid support - [@nmerouze](https://github.com/nmerouze).
+
+## 1.0.1
+
+* Add gemspec and specify actionpack dependency - [@nmerouze](https://github.com/nmerouze).
+
+## 1.0.0
+
+* Initial version of the gem - [@tpitale](https://github.com/tpitale), [@compressed](https://github.com/compressed).
+* MongoMapper session store support - [@tpitale](https://github.com/tpitale), [@compressed](https://github.com/compressed).

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(gem: "mongoid-danger")

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+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/README.md

@@ -1,74 +1,137 @@
 # MongoSessionStore
 
+[![Build Status](https://travis-ci.org/mongoid/mongo_session_store.svg?branch=master)](https://travis-ci.org/mongoid/mongo_session_store)
+[![Gem Version](https://badge.fury.io/rb/mongo_session_store.svg)](http://badge.fury.io/rb/mongo_session_store)
+[![Code Climate](https://codeclimate.com/github/mongoid/mongo_session_store/badges/gpa.svg)](https://codeclimate.com/github/mongoid/mongo_session_store)
+
 ## Description
 
-This is a fork of the DataMapper session store, modified to work with MongoMapper and Mongoid.
+MongoSessionStore is a [Rails][rails]-compatible session store for
+[MongoDB][mongodb] using either [Mongoid][mongoid] or the [MongoDB Ruby
+Driver][mongo]. It also allows for custom Mongo session store that works with
+any (or no!) Mongo ODM.
+
+MongoSessionStore version 3 is compatible with Rails 4.0 through 4.2. For Rails
+3 support please check out issue [#17][issue-rails3] for options and let us
+know if you need support.
 
 ## Installation
 
-The current version is only compatible with Rails 3
+Add the `mongo_session_store` gem to your `Gemfile`.
+Use either the `mongo` or `mongoid` gems in combination with this gem.
+
+```ruby
+# Gemfile
+
+gem "mongoid"
+# or gem "mongo"
+gem "mongo_session_store"
+```
+
+Configure the session store in the session_store initializer in your Rails
+project.
+
+```ruby
+# config/initializers/session_store.rb
+
+# Mongoid
+MyApp::Application.config.session_store :mongoid_store
+
+# MongoDB Ruby Driver/anything else
+MongoStore::Session.database = Mongo::Client.new(["127.0.0.1:27017"], database: "my_app_development")
+MyApp::Application.config.session_store :mongo_store
+```
+
+## Configuration
+
+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
+session_store initializer.
 
-    gem install mongo_session_store
+```ruby
+# config/initializers/session_store.rb
+MongoSessionStore.collection_name = "client_sessions"
+```
 
-However if you want to use it with Rails 2.3.x, you just have to install the latest 1.x version
+## Usage
 
-    gem install mongo_session_store --version=1.1.2
+By default nothing has to be done outside the [installation](#installation) of
+the gem.
 
-## Usage with MongoMapper
+It's possible to query your sessions.
 
-In your Gemfile:
+```ruby
+# Mongoid
+MongoidStore::Session.where(:updated_at.gt => 2.days.ago)
 
-    gem "mongo_mapper-rails3", :require => "mongo_mapper"
-    gem "mongo_session_store"
+# MongoDB Ruby Driver
+MongoStore::Session.where("updated_at" => { "$gt" => 2.days.ago })
+```
 
-In the session_store initializer (config/initializers/session_store.rb):
+## Development
 
-    require "mongo_session_store/mongo_mapper"
-    ActionController::Base.session_store = :mongo_mapper_store
+### Testing
 
-## Usage with Mongoid
+To run the tests for a specific store. You must first set a `BUNDLE_GEMFILE` in
+the environment.
 
-In your Gemfile:
+```sh
+bundle exec rake
+```
 
-    gem "mongoid"
-    gem "mongo_session_store"
+Examples:
 
-In the session_store initializer (config/initializers/session_store.rb):
+```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
+```
 
-    require "mongo_session_store/mongoid"
-    ActionController::Base.session_store = :mongoid_store
+### Performance benchmark
+
+The repository includes a performance benchmark. It runs against all available
+included stores and outputs the results.
+
+```
+bundle exec ruby perf/benchmark.rb
+```
+
+### Releases
+
+To create a new release checkout the `master` branch and make sure it's in the
+right state to release. Run the `release` Rake task and follow the
+instructions.
+
+```
+bundle exec rake release
+```
 
 ## Contributors
 
+MongoSessionStore started as a fork of the DataMapper session store, modified
+to work with MongoMapper, Mongoid and the Mongo Ruby Driver.
+
+Much thanks to all contributors:
+
 * Nicolas Mérouze
 * Chris Brickley
 * Tony Pitale
 * Nicola Racco
 * Matt Powell
+* Ryan Fitzgerald
+* Brian Hempel
+* Tom de Bruijn
 
 ## License
 
-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.
+Released under the MIT license. See the [LICENSE](LICENSE) file.
+
+[mongodb]: https://www.mongodb.com/
+[mongo]: https://github.com/mongodb/mongo-ruby-driver
+[mongoid]: http://mongoid.org/
+[rails]: http://rubyonrails.org/
+
+[issue-rails3]: https://github.com/mongoid/mongo_session_store/issues/17

data/Rakefile

@@ -0,0 +1,90 @@
+require "rspec/core/rake_task"
+
+desc "Prepare MongoDB connection"
+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
+      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
+
+desc "Release a new version of the mongo_session_store gem"
+task :release do
+  GEMSPEC_NAME = "mongo_session_store"
+  GEM_NAME = "mongo_session_store"
+  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
+
+desc "Default task for Rake. Runs test suite."
+task :default => :test