active_model-email_confirmation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbbd8c6fd557d779d89dbaa280361da273368eed
+  data.tar.gz: aa48ed884b58b84e9085d2bcfc8a9c0be1e21086
+SHA512:
+  metadata.gz: 98641f6d16d2ffbd31498617255165f0139c4fc758b5e6c7872d092815a4154bb341abbfb19bc26769dfe353db9895087afd1c1e028323e192580aac72d4a26f
+  data.tar.gz: f2a10b220d387bf551ec27ba3079ff601a8117ea006214840cf9d890e76d2e36c5f7a9c108e5343c8463bd0b2585ec112cd4f1934fb6a6aad2b4f63ee747a0a3

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

@@ -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,55 @@
+# ActiveModel::EmailConfirmation
+
+`ActiveModel::EmailConfirmation` is a lightweight email confirmation 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "active_model-email_confirmation"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model-email_confirmation
+
+## Usage
+
+The most popular workflow is:
+
+    class UsersController < ApplicationController
+      def create
+        # ...
+        @email_confirmation = ActiveModel::EmailConfirmation.new(user: @user)
+        UserMailer.confirm_email(@user.email, @email_confirmation.token).deliver
+        # ...
+      end
+    end
+
+    class EmailConfirmationsController < ApplicationController
+      def show
+        # find raises TokenInvalid, EmailInvalid exceptions
+        @email_confirmation = ActiveModel::EmailConfirmation.find(params[:id])
+        @user = @email_confirmation.user
+        @user.update(confirmed_at: DateTime.now)
+        # ...
+      rescue ActiveModel::EmailConfirmation::Error
+        raise ActiveRecord::RecordNotFound # display 404
+      end
+    end
+
+If you don't like the default behavior, you can always inherit the model and override some defaults:
+
+    class EmailConfirmation < ActiveModel::EmailConfirmation
+      def email=(email)
+        @email = email
+        @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-email_confirmation.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/email_confirmation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model-email_confirmation"
+  spec.version       = ActiveModel::EmailConfirmation::VERSION
+  spec.authors       = ["Kuba Kuźma"]
+  spec.email         = ["kuba@jah.pl"]
+  spec.description   = %q{Simple email confirmation model implemented on top of ActiveModel::Model}
+  spec.summary       = %q{Simple email confirmation model implemented on top of ActiveModel::Model}
+  spec.homepage      = "https://github.com/cowbell/active_model-email_confirmation"
+  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/email_confirmation.rb

@@ -0,0 +1,55 @@
+require "active_model/email_confirmation/version"
+require "active_model/email_confirmation/error"
+require "active_model"
+
+module ActiveModel
+  class EmailConfirmation
+    include Model
+
+    attr_reader :email
+    attr_writer :user
+
+    validates :email, presence: true
+    validate :existence, if: -> { email.present? }
+    delegate :id, to: :user, prefix: true, allow_nil: true
+
+    def email=(email)
+      remove_instance_variable(:@user) if defined?(@user)
+      @email = email
+    end
+
+    def user
+      return @user if defined?(@user)
+      @user = User.find_by(email: email)
+    end
+
+    def token
+      self.class.generate_token(user.email)
+    end
+
+    def self.find(token)
+      email = verify_token(token)
+      new(email: email).tap { |email_confirmation| raise EmailInvalid if email_confirmation.invalid? }
+    end
+
+    private
+
+    def self.message_verifier
+      Rails.application.message_verifier("email confirmation salt")
+    end
+
+    def self.generate_token(*args)
+      Base64.urlsafe_encode64(message_verifier.generate(*args))
+    end
+
+    def self.verify_token(string)
+      message_verifier.verify(Base64.urlsafe_decode64(string))
+    rescue ActiveSupport::MessageVerifier::InvalidSignature, ArgumentError
+      raise TokenInvalid
+    end
+
+    def existence
+      errors.add(:email, :invalid) if user.blank?
+    end
+  end
+end

data/lib/active_model/email_confirmation/error.rb

@@ -0,0 +1,7 @@
+module ActiveModel
+  class EmailConfirmation
+    class Error < StandardError; end
+    class EmailInvalid < Error; end
+    class TokenInvalid < Error; end
+  end
+end

data/lib/active_model/email_confirmation/version.rb

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

data/test/email_confirmation_test.rb

@@ -0,0 +1,71 @@
+require "test_helper"
+
+class User
+  attr_accessor :id, :email
+
+  RECORDS = {
+    {email: "alice@example.com"} => {id: 1, email: "alice@example.com"}
+  }
+
+  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]
+  end
+end
+
+module ActiveModel
+  def EmailConfirmation.message_verifier
+    key_generator = ActiveSupport::KeyGenerator.new("12345678901234567890123456789012345678901234567890123456789012345678901234567890", iterations: 1000)
+    secret = key_generator.generate_key("email confirmation salt")
+    ActiveSupport::MessageVerifier.new(secret)
+  end
+end
+
+class EmailConfirmationTest < Test::Unit::TestCase
+  include ActiveModel::Lint::Tests
+
+  def setup
+    @model = @email_confirmation = ActiveModel::EmailConfirmation.new
+  end
+
+  def test_basic_workflow
+    @email_confirmation.email = "alice@example.com"
+    @email_confirmation.valid?
+    token = @email_confirmation.token
+    assert token.present?
+    assert !token.include?("/")
+    email_confirmation = ActiveModel::EmailConfirmation.find(token)
+    assert_equal @email_confirmation.email, email_confirmation.email
+    assert email_confirmation.user.present?
+  end
+
+  def test_is_invalid_with_invalid_email
+    @email_confirmation.email = "invalid@example.com"
+    assert @email_confirmation.invalid?
+    assert @email_confirmation.errors[:email].present?
+  end
+
+  def test_is_invalid_without_email
+    @email_confirmation.email = nil
+    assert @email_confirmation.invalid?
+    assert @email_confirmation.errors[:email].present?
+  end
+
+  def test_find_raises_exception_with_invalid_email
+    token = ActiveModel::EmailConfirmation.generate_token("invalid@example.com")
+    assert_raises(ActiveModel::EmailConfirmation::EmailInvalid) { ActiveModel::EmailConfirmation.find(token) }
+  end
+
+  def test_find_raises_exception_with_invalid_token
+    assert_raises(ActiveModel::EmailConfirmation::TokenInvalid) { ActiveModel::EmailConfirmation.find("invalidtoken") }
+  end
+
+  def test_find_raises_exception_with_non_base64_token
+    assert_raises(ActiveModel::EmailConfirmation::TokenInvalid) { ActiveModel::EmailConfirmation.find("%%%%%%%%%") }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "test/unit"
+require "active_model/email_confirmation"
+require "ostruct"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: active_model-email_confirmation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kuba Kuźma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-21 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 email confirmation 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-email_confirmation.gemspec
+- lib/active_model/email_confirmation.rb
+- lib/active_model/email_confirmation/error.rb
+- lib/active_model/email_confirmation/version.rb
+- test/email_confirmation_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cowbell/active_model-email_confirmation
+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 email confirmation model implemented on top of ActiveModel::Model
+test_files:
+- test/email_confirmation_test.rb
+- test/test_helper.rb