active_model-session 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58616671194c332ccf649d8a53b7a50b3fed26a2
+  data.tar.gz: e891618fed80a5f384b1dfbe6f1065a2d6afc249
+SHA512:
+  metadata.gz: 6b8b06d26142b4793f9bbf021d7ceb3882037d8c18d5e129f293373effa3475e9cdc3b5f91ccce8ee0517d36fba9146b841cdcd8c359a0c3e2cc8950369dc500
+  data.tar.gz: f9b384dc4ad955779a72d0e1af1a722bb37d973f5283056ceb3e4f6ec81e45be258968d450f4f6faa41e200f9918c2dbb8450efc5b3d7633b5c9ee5abfa0b47b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activemodel"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kuba Kuźma
+
+MIT License
+
+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,66 @@
+# ActiveModel::Session
+
+A simple session model implemented using `ActiveModel::Model`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "active_model-session"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemodel-session
+
+## Usage
+
+The most popular workflow is:
+
+    class SessionController < ApplicationController
+      def new
+        @session = ActiveModel::Session.new
+      end
+
+      def create
+        @session = ActiveModel::Session.new(session_params)
+        if @session.valid?
+          session[:user_id] = @session.user_id
+          redirect_to root_url, notice: "You have been successfully logged in."
+        else
+          render :new
+        end
+      end
+
+      private
+
+      def session_params
+        params.require(:session).permit(:email, :password)
+      end
+    end
+
+It uses `User` model by default, and executes `authenticate` method
+provided normally by `has_secure_password` in `User` model. If you
+need to authenticate a different type of user, you can do:
+
+     @session = ActiveModel::Session.new(session_params)
+     @session.user = Admin.find_by(email: session.email)
+     if @session.valid?
+       # ...
+
+If you don't like the default behavior, you can always inherit the
+session model and override some defaults:
+
+     class Session < ActiveModel::Session
+       def email=(email)
+         @email = email.downcase if email.present?
+       end
+     end
+
+
+## Copyright
+
+Copyright © 2013 Kuba Kuźma. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs += %w[lib test]
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test

data/active_model-session.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_model/session/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model-session"
+  spec.version       = ActiveModel::Session::VERSION
+  spec.authors       = ["Kuba Kuźma"]
+  spec.email         = ["kuba@jah.pl"]
+  spec.description   = %q{Simple session model implemented on top of ActiveModel::Model}
+  spec.summary       = %q{Simple session model implemented on top of ActiveModel::Model}
+  spec.homepage      = "https://github.com/cowbell/active_model-session"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/active_model/session.rb

@@ -0,0 +1,26 @@
+require "active_model/session/version"
+require "active_model"
+
+module ActiveModel
+  class Session
+    include Model
+
+    attr_accessor :email, :password
+    attr_writer :user
+
+    validates :email, presence: true
+    validate :authenticity, if: -> { email.present? }
+    delegate :id, :authenticate, to: :user, prefix: true, allow_nil: true
+
+    def user
+      return @user if defined?(@user)
+      @user = User.find_by(email: email)
+    end
+
+    private
+
+    def authenticity
+      errors.add(:password, :invalid) unless user_authenticate(password)
+    end
+  end
+end

data/lib/active_model/session/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  class Session
+    VERSION = "1.0.0"
+  end
+end

data/test/session_with_user_model_test.rb

@@ -0,0 +1,65 @@
+require "test_helper"
+
+class User
+  attr_accessor :id, :password, :email
+
+  RECORDS = {
+    {email: "alice@example.com"} => {id: 1, email: "alice@example.com", password: "alicesecret"},
+    {email: "bob@example.com"}   => {id: 2, email: "bob@example.com",   password: "bobsecret"}
+  }
+
+  def self.find_by(options)
+    attributes = RECORDS[options]
+    new(attributes) if attributes.present?
+  end
+
+  def initialize(options)
+    self.id       = options[:id]
+    self.email    = options[:email]
+    self.password = options[:password]
+  end
+
+  def authenticate(password)
+    self.password == password
+  end
+end
+
+class SessionWithUserModelTest < Test::Unit::TestCase
+  include ActiveModel::Lint::Tests
+
+  def setup
+    @model = @session = ActiveModel::Session.new
+  end
+
+  test "is valid with valid credentials" do
+    @session.email = "alice@example.com"
+    @session.password = "alicesecret"
+    assert @session.valid?
+  end
+
+  test "returns user_id when valid" do
+    @session.email = "bob@example.com"
+    @session.password = "bobsecret"
+    assert @session.valid?
+    assert_equal 2, @session.user_id
+  end
+
+  test "is invalid when user does not exist" do
+    @session.email = "non-existing@example.com"
+    assert @session.invalid?
+    assert @session.errors[:password].present?
+  end
+
+  test "is invalid with incorrect password" do
+    @session.email = "alice@example.com"
+    @session.password = "wrong-password"
+    assert @session.invalid?
+    assert @session.errors[:password].present?
+  end
+
+  test "is invalid without email" do
+    @session.email = nil
+    assert @session.invalid?
+    assert @session.errors[:email].present?
+  end
+end

data/test/session_without_user_model_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+class SessionWithoutUserModelTest < Test::Unit::TestCase
+  def setup
+    Object.send(:remove_const, :User) if defined?(User)
+  end
+
+  test "is invalid when user model is nil" do
+    session = ActiveModel::Session.new(user: nil, email: "alice@example.com", password: "secret")
+    assert session.invalid?
+  end
+
+  test "is invalid when user does not authenticate" do
+    user = Object.new
+    def user.authenticate(password)
+      password == "secret"
+    end
+    session = ActiveModel::Session.new(user: user, email: "alice@example.com", password: "wrongsecret")
+    assert session.invalid?
+  end
+
+  test "is valid when user authenticates" do
+    user = Object.new
+    def user.authenticate(password)
+      password == "secret"
+    end
+    session = ActiveModel::Session.new(user: user, email: "alice@example.com", password: "secret")
+    assert session.valid?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "test/unit"
+require "active_model/session"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: active_model-session
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kuba Kuźma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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'
+description: Simple session model implemented on top of ActiveModel::Model
+email:
+- kuba@jah.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_model-session.gemspec
+- lib/active_model/session.rb
+- lib/active_model/session/version.rb
+- test/session_with_user_model_test.rb
+- test/session_without_user_model_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cowbell/active_model-session
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple session model implemented on top of ActiveModel::Model
+test_files:
+- test/session_with_user_model_test.rb
+- test/session_without_user_model_test.rb
+- test/test_helper.rb