has_email_authentication 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfdfe7668bddb4d05f86c79270ccf8e4a018fa42
+  data.tar.gz: a9b0a059b801a3ef99e78fc005d2069041f474c6
+SHA512:
+  metadata.gz: 8c559d07630a1e680a9fdaeec91a3761be7adc6bb7ef2e109a0ef15b56126be09031d42501f76bcf440d8899becc2cea76ba58a1b77da3c2138c18598047d17d
+  data.tar.gz: c650c67a21c94b9266ebd78fdffe01831406543c77d7c5266ae0ac7ee033928ac4b0614a9b6fd56243f174292038b3b36ca86f261452316887862941fec72efa

data/.gemfiles/4.0.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "activerecord", "~> 4.0.0"
+gemspec path: "../"

data/.gemfiles/4.1.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "activerecord", "~> 4.1.0"
+gemspec path: "../"

data/.gemfiles/4.2.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "activerecord", "4.2.0.beta1"
+gemspec path: "../"

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - rbx-2.2
+gemfile:
+  - .gemfiles/4.0.gemfile
+  - .gemfiles/4.1.gemfile
+  - .gemfiles/4.2.gemfile

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael van Rooijen
+
+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,106 @@
+# Has Email Authentication
+
+[![Gem Version](https://badge.fury.io/rb/has_email_authentication.svg)](http://badge.fury.io/rb/has_email_authentication)
+[![Code Climate](https://codeclimate.com/github/meskyanichi/has_email_authentication.png)](https://codeclimate.com/github/meskyanichi/has_email_authentication)
+[![Build Status](https://travis-ci.org/meskyanichi/has_email_authentication.svg)](https://travis-ci.org/meskyanichi/has_email_authentication)
+
+HasEmailAuthentication, for Rails/ActiveRecord 4.0.0+, is a micro library that compliments `has_secure_password` by providing `has_email_authentication`.
+
+This library was developed for- and extracted from [HireFire].
+
+The documentation can be found on [RubyDoc].
+
+
+### Compatibility
+
+- Rails/ActiveRecord 4.0.0+
+- Ruby (MRI) 2.0+
+- Ruby (RBX) 2.2+
+
+
+### Installation
+
+Add the gem to your Gemfile and run `bundle`.
+
+```rb
+gem "has_email_authentication"
+```
+
+
+### Example
+
+This library requires you to have an `email` column in the table associated
+with the model you're using.
+
+```rb
+class User < ActiveRecord::Base
+  has_email_authentication
+end
+```
+
+This does a few things:
+
+- Adds presence, format and uniqueness validations on `email`
+- Downcases `email` before saving the record
+- Provides a `User.find_by_email(params[:email])`
+    convenience method which downcases the provided email
+
+
+### Contributing
+
+Contributions are welcome, but please conform to these requirements:
+
+- Ruby (MRI) 2.0+
+- Ruby (RBX) 2.2+
+- ActiveRecord 4.0.0+
+- 100% Spec Coverage
+  - Generated by when running the test suite
+- 100% [Passing Specs]
+  - Run test suite with `$ rspec spec`
+- 4.0 [Code Climate Score]
+  - Run `$ rubycritic lib` to generate the score locally and receive tips
+  - No code smells
+  - No duplication
+
+To start contributing, fork the project, clone it, and install the development dependencies:
+
+```
+git clone git@github.com:USERNAME/has_email_authentication.git
+cd has_email_authentication
+bundle
+```
+
+Ensure that everything works:
+
+```
+rspec spec
+rubycritic lib
+```
+
+To run the local documentation server:
+
+```
+yard server --reload
+```
+
+Create a new branch and start hacking:
+
+```
+git checkout -b my-contributions
+```
+
+Submit a pull request.
+
+
+### Author / License
+
+Copyright (c) 2014 Michael van Rooijen ( [@meskyanichi] )<br />
+Released under the MIT [License].
+
+[@meskyanichi]: https://twitter.com/meskyanichi
+[HireFire]: http://hirefire.io
+[Passing Specs]: https://travis-ci.org/meskyanichi/has_email_authentication
+[Code Climate Score]: https://codeclimate.com/github/meskyanichi/has_email_authentication
+[RubyDoc]: http://rubydoc.info/github/meskyanichi/has_email_authentication/master/frames
+[License]: https://github.com/meskyanichi/has_email_authentication/blob/master/LICENSE
+[RubyGems.org]: https://rubygems.org/gems/has_email_authentication

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/has_email_authentication.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "has_email_authentication/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "has_email_authentication"
+  spec.version = HasEmailAuthentication::VERSION
+  spec.authors = ["Michael van Rooijen"]
+  spec.email = ["michael@vanrooijen.io"]
+  spec.summary = %q{A micro library that compliments has_secure_password by providing has_email_authentication.}
+  spec.homepage = "http://meskyanichi.github.io/has_email_authentication/"
+  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 "activerecord", ">= 4.0.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
+end

data/lib/has_email_authentication/module.rb

@@ -0,0 +1,48 @@
+module HasEmailAuthentication::Module
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    # Generates the +find_by_email+ class method. Downcases the +:email+
+    # attribute before saving. Validates the presence, format and uniqueness
+    # of the +:email+ attribute.
+    #
+    # @example
+    #
+    #   class User < ActiveRecord::Base
+    #     has_email_authentication
+    #   end
+    #
+    #   User.create(email: "MICHAEL@example.com")
+    #   User.find_by_email("michael@EXAMPLE.com)
+    #
+    def has_email_authentication
+      validates :email,
+        presence: true,
+        format: { with: /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i },
+        uniqueness: { case_sensitive: false }
+
+      before_save do
+        self.email = email.try(:downcase)
+      end
+
+      extend(FindByEmail)
+    end
+  end
+
+  module FindByEmail
+
+    # Convenience method for finding a record by email. Attempts
+    # to downcase the provided +email+ prior to searching the database for it.
+    #
+    # @param email [String] the email to find the record by.
+    # @return [Object, nil]
+    #
+    def find_by_email(email)
+      find_by(email: email.try(:downcase))
+    end
+  end
+end

data/lib/has_email_authentication/version.rb

@@ -0,0 +1,3 @@
+module HasEmailAuthentication
+  VERSION = "0.0.1"
+end

data/lib/has_email_authentication.rb

@@ -0,0 +1,8 @@
+module HasEmailAuthentication
+  require "has_email_authentication/module"
+  require "has_email_authentication/version"
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, HasEmailAuthentication::Module)
+end

data/spec/lib/has_email_authentication_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+RSpec.describe HasEmailAuthentication do
+
+  let(:user) { User.new }
+
+  it "validates the presence of the email" do
+    expect(User.create.errors[:email]).to include("can't be blank")
+  end
+
+  it "validates the format of the email" do
+    ["mike", "mike@", "mike@example", "mike@example."].each do |value|
+      expect(User.create(email: value).errors[:email])
+        .to include("is invalid")
+    end
+  end
+
+  it "validates the uniqueness of the email" do
+    email = "michael@example.com"
+    User.create!(email: email)
+    expect(User.create(email: email).errors[:email])
+      .to include("has already been taken")
+  end
+
+  it "should downcase the email" do
+    user = User.create(email: "MICHAEL@example.com")
+    expect(user.reload.email).to eq("michael@example.com")
+  end
+
+  it "should provide a method to find by downcased email" do
+    user = User.create(email: "michael@example.com")
+    expect(User.find_by_email("MICHAEL@EXAMPLE.COM").id).to eq(user.id)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require File.expand_path("../support/env", __FILE__)
+
+require "database_cleaner"
+require "simplecov"
+SimpleCov.start
+
+require "has_email_authentication"
+require File.expand_path("../support/models", __FILE__)
+
+RSpec.configure do |config|
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/db.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3", database: ":memory:"
+)
+
+class Schema < ActiveRecord::Migration
+
+  def change
+    create_table :users do |t|
+      t.string :email
+    end
+  end
+end
+
+silence_stream(STDOUT) do
+  Schema.new.change
+end

data/spec/support/env.rb

@@ -0,0 +1,10 @@
+require "pry"
+require "sqlite3"
+require "active_record"
+
+ROOT_PATH = File.expand_path("../../..", __FILE__)
+SPEC_PATH = File.join(ROOT_PATH, "spec")
+
+I18n.enforce_available_locales = true
+
+require "#{SPEC_PATH}/support/db"

data/spec/support/models.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_email_authentication
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: has_email_authentication
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: 
+email:
+- michael@vanrooijen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemfiles/4.0.gemfile"
+- ".gemfiles/4.1.gemfile"
+- ".gemfiles/4.2.gemfile"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_email_authentication.gemspec
+- lib/has_email_authentication.rb
+- lib/has_email_authentication/module.rb
+- lib/has_email_authentication/version.rb
+- spec/lib/has_email_authentication_spec.rb
+- spec/spec_helper.rb
+- spec/support/db.rb
+- spec/support/env.rb
+- spec/support/models.rb
+homepage: http://meskyanichi.github.io/has_email_authentication/
+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.2
+signing_key: 
+specification_version: 4
+summary: A micro library that compliments has_secure_password by providing has_email_authentication.
+test_files:
+- spec/lib/has_email_authentication_spec.rb
+- spec/spec_helper.rb
+- spec/support/db.rb
+- spec/support/env.rb
+- spec/support/models.rb
+has_rdoc: