mongo_session_store 2.0.0 → 3.0.0.beta.1

data/spec/lib/mongo_session_store/mongo_store_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+if mongo_orm == "mongo"
+  describe MongoStore do
+    describe ".session_class" do
+      subject { described_class.session_class }
+
+      it "returns mongo session class" do
+        expect(subject).to eq(described_class::Session)
+      end
+    end
+  end
+end

data/spec/lib/mongo_session_store/mongoid_store/session_spec.rb

@@ -0,0 +1,82 @@
+require "spec_helper"
+
+if mongo_orm == "mongoid"
+  describe MongoidStore::Session do
+    before { described_class.collection.drop }
+
+    it "is a Mongoid model" do
+      expect(subject).to be_kind_of(Mongoid::Document)
+    end
+
+    describe "#before_save" do
+      let(:session) { described_class.new(attributes) }
+      before do
+        session.save
+        session.reload
+      end
+
+      context "without data" do
+        let(:attributes) { {} }
+
+        it "saves an empty hash" do
+          expect(session._data).to be_kind_of(BSON::Binary)
+          expect(session.data).to eq({})
+        end
+      end
+
+      context "with data" do
+        let(:attributes) { { :data => { :foo => "bar" } } }
+
+        it "saves session data as a BSON Binary" do
+          expect(session._data).to be_kind_of(BSON::Binary)
+          expect(session.data).to eq(:foo => "bar")
+        end
+      end
+    end
+
+    describe "#data" do
+      let(:session) { described_class.new(:data => { "something" => "dark side" }) }
+
+      it "returns unpacked session data" do
+        expect(session.data).to eq("something" => "dark side")
+      end
+    end
+
+    describe "#data=" do
+      let(:session) { described_class.new }
+      before { session.data = { :bar => :baz } }
+
+      it "saves data on _data field" do
+        expect(session._data).to be_kind_of(BSON::Binary)
+        expect(session.data).to eq(:bar => :baz)
+      end
+    end
+
+    describe "#reload" do
+      it "reloads the record and reset the data attribute cache" do
+        # Create record
+        session = described_class.create :data => { :original => "true" }
+        expect(session.data).to eq(:original => "true")
+
+        # Update record in another object
+        database_record = described_class.find(session.id)
+        database_record.update_attributes!(:data => { :updated => "true" })
+        expect(database_record.data).to eq(:updated => "true")
+
+        # Reload original object
+        session.reload
+        # Should have updated values
+        expect(session.data).to eq(:updated => "true")
+      end
+    end
+
+    describe ".collection_name" do
+      # Where the name comes from:
+      # - "test_database" set in spec_helper
+      # - "sessions" is derived from model name
+      it "saves in the given collection_name" do
+        expect(described_class.collection.namespace).to eq("test_database.sessions")
+      end
+    end
+  end
+end

data/spec/lib/mongo_session_store/mongoid_store_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+if mongo_orm == "mongoid"
+  describe MongoidStore do
+    describe ".session_class" do
+      subject { described_class.session_class }
+
+      it "returns mongoid session class" do
+        expect(subject).to eq(described_class::Session)
+      end
+    end
+  end
+end

data/spec/lib/mongo_session_store_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe MongoSessionStore do
+  describe ".collection_name" do
+    subject { described_class.collection_name }
+
+    it "defaults to 'sessions'" do
+      expect(subject).to eq("sessions")
+    end
+
+    context "with modified collection name" do
+      around do |example|
+        collection_name = described_class.send :instance_variable_get, :@collection_name
+        described_class.send :remove_instance_variable, :@collection_name
+        example.run
+        described_class.collection_name = collection_name
+      end
+
+      context "without collection name" do
+        it "returns nil" do
+          expect(subject).to be_nil
+        end
+      end
+
+      context "with collection name" do
+        before { described_class.collection_name = "foo" }
+
+        it "returns the set collection name" do
+          expect(subject).to eq("foo")
+        end
+      end
+    end
+  end
+
+  describe ".collection_name=" do
+    subject { described_class.collection_name }
+    around do |example|
+      collection_name = described_class.send :instance_variable_get, :@collection_name
+      described_class.send :remove_instance_variable, :@collection_name
+      example.run
+      described_class.collection_name = collection_name
+    end
+
+    if mongo_orm == "mongoid"
+      context "with mongo" do
+        before { described_class.collection_name = "foo" }
+        subject { MongoidStore::Session.collection.name }
+
+        it "returns the set collection name" do
+          expect(subject).to eq("foo")
+        end
+      end
+    elsif mongo_orm == "mongo"
+      context "with mongo" do
+        before { described_class.collection_name = "foo" }
+        subject { MongoStore::Session.collection.name }
+
+        it "returns the set collection name" do
+          expect(subject).to eq("foo")
+        end
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,19 @@
+ENV["RAILS_ENV"] = "test"
+require "spec_helper"
+require "rails"
+rails_version = Gem.loaded_specs["rails"].version.to_s[/^\d\.\d/]
+require "support/apps/rails_#{rails_version}_app/config/environment"
+require "rspec/rails"
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+
+  config.before :suite do
+    Rails.logger.level = 4
+    load Rails.root.join("db", "schema.rb") unless User.table_exists?
+  end
+
+  config.before :each do
+    User.delete_all
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require "mongo"
+require "mongoid" if Gem.loaded_specs["mongoid"]
+require "mongo_session_store"
+require "support/helpers/test_database_helper"
+require "support/helpers/session_id_helper"
+
+def mongo_orm
+  defined?(Mongoid) ? "mongoid" : "mongo"
+end
+
+case mongo_orm
+when "mongo"
+  require "mongo_session_store/mongo_store"
+when "mongoid"
+  require "mongo_session_store/mongoid_store"
+end
+
+RSpec.configure do |config|
+  config.include TestDatabaseHelper
+  config.include SessionIdHelper
+
+  config.order = "random"
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before :suite do
+    Mongo::Logger.logger.level = ::Logger::INFO
+
+    if mongo_orm == "mongoid"
+      Mongoid.logger.level = Logger::INFO
+      Mongoid.configure do |c|
+        c.load_configuration(
+          "clients" => {
+            "default" => {
+              "database" => TestDatabaseHelper.test_database_name,
+              "hosts" => ["127.0.0.1:27017"]
+            }
+          }
+        )
+      end
+    else
+      MongoStore::Session.database = Mongo::Client.new(
+        ["127.0.0.1:27017"],
+        :database => TestDatabaseHelper.test_database_name
+      )
+    end
+  end
+
+  config.before do
+    drop_collections_in(test_database)
+  end
+end

data/spec/support/apps/rails_4.0_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails40App::Application.load_tasks

data/spec/support/apps/rails_4.0_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/support/apps/rails_4.0_app/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/spec/support/apps/rails_4.0_app/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable
+end

data/spec/support/apps/rails_4.0_app/app/views/home/index.html.erb

@@ -0,0 +1,10 @@
+You are signed
+<% if user_signed_in? %>
+    in as <%= current_user.email %>.
+    <form method="post" action="<%= destroy_user_session_path %>">
+        <input type="hidden" name="_method" value="delete" />
+        <input type="submit" value="Sign out" />
+    </form>
+<% else %>
+    out.  <%= link_to "Sign in", new_user_session_path %>
+<% end %>

data/spec/support/apps/rails_4.0_app/app/views/layouts/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails40App</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= notice %>
+<%= alert %>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/support/apps/rails_4.0_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+load Gem.bin_path("bundler", "bundle")

data/spec/support/apps/rails_4.0_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../../config/application",  __FILE__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/support/apps/rails_4.0_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/support/apps/rails_4.0_app/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/support/apps/rails_4.0_app/config/application.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../boot", __FILE__)
+
+require "action_controller/railtie"
+require "active_record/railtie"
+
+Bundler.require(:default, Rails.env)
+
+module Rails40App
+  class Application < Rails::Application
+  end
+end

data/spec/support/apps/rails_4.0_app/config/boot.rb

@@ -0,0 +1,4 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/support/apps/rails_4.0_app/config/database.yml

@@ -0,0 +1,11 @@
+test:
+  adapter: <%= RUBY_PLATFORM == "java" ? "jdbcsqlite3" : "sqlite3" %>
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  adapter: <%= RUBY_PLATFORM == "java" ? "jdbcsqlite3" : "sqlite3" %>
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/support/apps/rails_4.0_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails40App::Application.initialize!

data/spec/support/apps/rails_4.0_app/config/environments/development.rb

@@ -0,0 +1,12 @@
+Rails40App::Application.configure do
+  config.cache_classes = false
+
+  config.eager_load = false
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.active_support.deprecation = :log
+
+  config.active_record.migration_error = :page_load
+end

data/spec/support/apps/rails_4.0_app/config/environments/test.rb

@@ -0,0 +1,19 @@
+Rails40App::Application.configure do
+  config.cache_classes = true
+
+  config.eager_load = false
+
+  config.serve_static_files   = true
+  config.static_cache_control = "public, max-age=3600"
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_dispatch.show_exceptions = false
+
+  config.action_controller.allow_forgery_protection = false
+
+  config.active_support.test_order = :random
+
+  config.active_support.deprecation = :stderr
+end

data/spec/support/apps/rails_4.0_app/config/initializers/devise.rb

@@ -0,0 +1,254 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # The secret key used by Devise. Devise uses this key to generate
+  # random tokens. Changing this key will render invalid all existing
+  # confirmation, reset password and unlock tokens in the database.
+  # config.secret_key = 'e757e9f98c1f53b25c1adef7d90a786c4224a963b67ec3e0011b89cc5c1349a46423d4ae047aa0ca57e658154996ab281439fea2ea5185f5c3dadcd8fb878472'
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [ :email ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :email ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication. The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = '267f77e7a8218e1066a6820bdf87edfa152fb3fba5e8a9ec063732dcbdd24e7ee6ae7a13620e1f32f291e8d9cd276c2514ad04c951d450d4da2fba08ae660350'
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming their account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming their account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming their account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length.
+  config.password_length = 8..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = false
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: '/my_engine'
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+end