active_model-password_reset 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af0f8e094ac95633ffa336d7aa15341262c1f38b
+  data.tar.gz: ce44163e6df01e2e6b6cffb82cddc911a47ef503
+SHA512:
+  metadata.gz: dcd9e401896b3f804773aea3cfefb6e3466469b756180f4b6cd493fd67788666cdf914c50459f1069531a475ed5d25fe2eca275d5b1953ed62c649151125bc3f
+  data.tar.gz: 6cb84665fbe2e7e409117e6c72d67b71fab6e22f5d8d69ab096596f80883d550d4478b6aa28990a1425cdcaaa3d9a6cbe160a743e568771bb5341497945b0223

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,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,88 @@
+# ActiveModel::PasswordReset
+
+`ActiveModel::PasswordReset` is a lightweight password reset model implemented on top of `ActiveModel::Model`. It does not require storing any additional information in the database. Resulting token is signed by `ActiveSupport::MessageVerifier` class, using `secret_key_base` and salt. Token is invalidated when:
+
+* user changed password
+* expiration time passed (default: 24 hours)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "active_model-password_reset"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model-password_reset
+
+## Usage
+
+The most popular workflow is:
+
+    class PasswordResetsController < ApplicationController
+      def new
+        @password_reset = ActiveModel::PasswordReset.new
+      end
+
+      def create
+        @password_reset = ActiveModel::PasswordReset.new(password_reset_params)
+        if @password_reset.valid?
+          UserMailer.reset_password(password_reset.email, password_reset.token).deliver
+          redirect_to root_url, notice: "You will receive an email with instructions."
+        else
+          render :new
+        end
+      end
+
+      private
+
+      def password_reset_params
+        params.require(:password_reset).permit(:email)
+      end
+    end
+
+    class PasswordsController < ApplicationController
+      def edit
+        # find raises TokenInvalid, TokenExpired, EmailInvalid, PasswordChanged exceptions
+        @password_reset = ActiveModel::PasswordReset.find(params[:id])
+        @user = @password_reset.user
+      rescue ActiveModel::PasswordReset::Error
+        raise ActiveRecord::RecordNotFound # display 404
+      end
+
+      def update
+        @password_reset = ActiveModel::PasswordReset.find(params[:id])
+        @user = @password_reset.user
+        if @user.update(user_params)
+          redirect_to root_url, notice: "Password changed successfully, you can now log in."
+        else
+          render :edit
+        end
+      rescue ActiveModel::PasswordReset::Error
+        raise ActiveRecord::RecordNotFound # display 404
+      end
+
+      private
+
+      def user_params
+        params.require(:user).permit(:password, :password_confirmation)
+      end
+    end
+
+If you don't like the default behavior, you can always inherit the session model and override some defaults:
+
+    class PasswordReset < ActiveModel::PasswordReset
+      EXPIRATION_TIME = 1.hour
+
+      def user
+        @user = Admin.find_by(email: email)
+      end
+    end
+
+## Copyright
+
+Copyright © 2014 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-password_reset.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/password_reset/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model-password_reset"
+  spec.version       = ActiveModel::PasswordReset::VERSION
+  spec.authors       = ["Kuba Kuźma"]
+  spec.email         = ["kuba@jah.pl"]
+  spec.description   = %q{Simple password reset model implemented on top of ActiveModel::Model}
+  spec.summary       = %q{Simple password reset model implemented on top of ActiveModel::Model}
+  spec.homepage      = "https://github.com/cowbell/active_model-password_reset"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "activemodel", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/active_model/password_reset.rb

@@ -0,0 +1,49 @@
+require "active_model/password_reset/version"
+require "active_model/password_reset/error"
+require "active_model/password_reset/message_verifier"
+require "active_model"
+
+module ActiveModel
+  class PasswordReset
+    EXPIRATION_TIME = 60 * 60 * 24 # 24 hours
+
+    include Model
+
+    attr_accessor :email
+
+    validates :email, presence: true
+    validate :existence, if: -> { email.present? }
+    delegate :id, to: :user, prefix: true, allow_nil: true
+
+    def user
+      return @user if defined?(@user)
+      @user = User.find_by(email: email)
+    end
+
+    def token
+      email = user.email
+      digest = Digest::MD5.digest(user.password_digest)
+      expires_at = Time.now.to_i + EXPIRATION_TIME
+      MessageVerifier.generate([email, digest, expires_at])
+    end
+
+    def self.find(token)
+      email, digest, expires_at = MessageVerifier.verify(token)
+      raise TokenExpired if Time.now.to_i > expires_at.to_i
+      new(email: email).tap do |password_reset|
+        raise EmailInvalid if password_reset.invalid?
+        raise PasswordChanged if password_reset.send(:digest) != digest
+      end
+    end
+
+    private
+
+    def digest
+      Digest::MD5.digest(user.password_digest)
+    end
+
+    def existence
+      errors.add(:email, :invalid) if user.blank?
+    end
+  end
+end

data/lib/active_model/password_reset/error.rb

@@ -0,0 +1,9 @@
+module ActiveModel
+  class PasswordReset
+    class Error < StandardError; end
+    class EmailInvalid < Error; end
+    class TokenInvalid < Error; end
+    class TokenExpired < Error; end
+    class PasswordChanged < Error; end
+  end
+end

data/lib/active_model/password_reset/message_verifier.rb

@@ -0,0 +1,29 @@
+require "singleton"
+
+module ActiveModel
+  class PasswordReset
+    class MessageVerifier
+      include Singleton
+
+      attr_reader :message_verifier
+
+      class << self
+        def generate(object)
+          instance.message_verifier.generate(object)
+        end
+
+        def verify(string)
+          instance.message_verifier.verify(string)
+        rescue ActiveSupport::MessageVerifier::InvalidSignature
+          raise TokenInvalid
+        end
+      end
+
+      def initialize
+        key_generator = ActiveSupport::KeyGenerator.new(Rails.application.config.secret_key_base, iterations: 1000)
+        secret = key_generator.generate_key("password reset salt")
+        @message_verifier = ActiveSupport::MessageVerifier.new(secret)
+      end
+    end
+  end
+end

data/lib/active_model/password_reset/version.rb

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

data/test/password_reset_test.rb

@@ -0,0 +1,69 @@
+require "test_helper"
+
+class User
+  attr_accessor :id, :password_digest, :email
+
+  RECORDS = {
+    {email: "alice@example.com"} => {id: 1, email: "alice@example.com", password_digest: "alicedigest"}
+  }
+
+  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_digest = options[:password_digest]
+  end
+end
+
+class PasswordResetTest < Test::Unit::TestCase
+  include ActiveModel::Lint::Tests
+
+  def setup
+    @model = @password_reset = ActiveModel::PasswordReset.new
+  end
+
+  def test_basic_workflow
+    @password_reset.email = "alice@example.com"
+    @password_reset.valid?
+    token = @password_reset.token
+    assert token.present?
+    password_reset = ActiveModel::PasswordReset.find(token)
+    assert_equal @password_reset.email, password_reset.email
+    assert password_reset.user.present?
+  end
+
+  def test_is_invalid_with_invalid_email
+    @password_reset.email = "invalid@example.com"
+    assert @password_reset.invalid?
+    assert @password_reset.errors[:email].present?
+  end
+
+  def test_is_invalid_without_email
+    @password_reset.email = nil
+    assert @password_reset.invalid?
+    assert @password_reset.errors[:email].present?
+  end
+
+  def test_find_raises_exception_with_invalid_email
+    token = ActiveModel::PasswordReset::MessageVerifier.generate(["invalid@example.com", Digest::MD5.digest("alicedigest"), Time.now.to_i + 3600])
+    assert_raises(ActiveModel::PasswordReset::EmailInvalid) { ActiveModel::PasswordReset.find(token) }
+  end
+
+  def test_find_raises_exception_with_invalid_token
+    assert_raises(ActiveModel::PasswordReset::TokenInvalid) { ActiveModel::PasswordReset.find("invalidtoken") }
+  end
+
+  def test_find_raises_exception_with_expired_token
+    token = ActiveModel::PasswordReset::MessageVerifier.generate(["alice@example.com", Digest::MD5.digest("alicedigest"), Time.now.to_i - 3600])
+    assert_raises(ActiveModel::PasswordReset::TokenExpired) { ActiveModel::PasswordReset.find(token) }
+  end
+
+  def test_find_raises_exception_with_changed_password
+    token = ActiveModel::PasswordReset::MessageVerifier.generate(["alice@example.com", Digest::MD5.digest("anotheralicedigest"), Time.now.to_i + 3600])
+    assert_raises(ActiveModel::PasswordReset::PasswordChanged) { ActiveModel::PasswordReset.find(token) }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+require "active_model/password_reset"
+require "ostruct"
+
+class Rails
+  def self.application
+    OpenStruct.new(config: OpenStruct.new(secret_key_base: "12345678901234567890123456789012345678901234567890123456789012345678901234567890"))
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: active_model-password_reset
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kuba Kuźma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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 password reset model implemented on top of ActiveModel::Model
+email:
+- kuba@jah.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model-password_reset.gemspec
+- lib/active_model/password_reset.rb
+- lib/active_model/password_reset/error.rb
+- lib/active_model/password_reset/message_verifier.rb
+- lib/active_model/password_reset/version.rb
+- test/password_reset_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cowbell/active_model-password_reset
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Simple password reset model implemented on top of ActiveModel::Model
+test_files:
+- test/password_reset_test.rb
+- test/test_helper.rb