authem 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmU3ZGJiMWZhNzdlY2VkNTAzNDRkYjUyOGI3NjQwMGRlMTZjOGI5Mw==
-  data.tar.gz: !binary |-
-    ZTVmOGQ1MjEzODYwYmEzNDc5ODMyNDlhZjk4ZTgzNmE4ZTM1YzY5Zg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    Yzc2NDYxNjgzN2Q1NmFkNjhkZGU1MjA0MjkwZjA5NjA1ZDQ4ZGViMTc1MmJm
-    MTkzOWI5OGM2ZWY2ZDY2MDY0YTk0NWExOThlMzc2Yzg2MmEwZTNjYTRlNzQ1
-    ZGYzN2M4NTFjOTEyZjgwYjc1NmM1MmVhNDE3NTJjZjc2ZGY2MTM=
-  data.tar.gz: !binary |-
-    ODZhOTI1NTFmNTEyMjVlMjBhNTBmMzQxMjE3NWYzZjBmNTdmNmFlYjI3MTMw
-    MDU2OTU3MmM1YzNkOGY4ZDk3NzJmNDIxNGI3ODc4MzE0NmE5NWFlMDUyZTNl
-    YmQzNmE1ZmU1YzU2NWEyZWMzZTg0MjhjNmQxNjhhYjE3NTFjOTg=
+SHA1:
+  metadata.gz: a40c5db73a417e2772c43f44a1dba85b5e6adce1
+  data.tar.gz: 236197959698d38dff3f402bcbc1698da38d5a89
+SHA512:
+  metadata.gz: c501d7b841f08db286efb0cd4b7e5c76039fd1a23872b9e8a391d4b1abbffb151391a88a32d18d5171f7e8c8eced89f458b6ebab2cca7638d6f71ca7d20e4cee
+  data.tar.gz: 98f8ae677bb99167796480d5bd7c05ee6d378a5c1f743226ccd36de9e8c74fdc9d137ccc93ce5046b2becd73b35f50e33258f6e2e8e9108c09e11d15aa640b57

data/README.markdown

@@ -1,12 +1,13 @@
 # Authem
 
-Authem is an authentication library for Ruby web applications.
+Authem is an email-based authentication library for Ruby web applications. It ONLY supports email/password authentication. It does not automatically integrate with Twitter, Facebook, or whatever oauth or SSO service you like the best. It is meant to handle user security but allow you to fully customize your user account behavior because the code is all yours.
 
 ## Compatibility
 
-Authem is tested against Ruby 1.9.2, 1.9.3, Rubinius
+Authem is tested against Ruby 1.9.2, 1.9.3, 2.0.0, and Rubinius
 
 [![Build Status](https://secure.travis-ci.org/paulelliott/authem.png)](http://travis-ci.org/paulelliott/authem)
+[![Code Climate](https://codeclimate.com/github/paulelliott/authem.png)](https://codeclimate.com/github/paulelliott/authem)
 
 ## Installation
 
@@ -14,26 +15,34 @@ Add the following to your project's Gemfile:
 
     gem 'authem'
 
+Or for Rails 4:
+
+    gem 'authem', github: 'paulelliott/authem', branch: 'rails4'
+
 ## Usage
 
 ### Model Setup
 
-Tell authem which of your classes will be used for authentication
+Tell authem which of your classes will be used for authentication in `config/initializers/authem.rb`
 
     Authem.configure do |config|
       config.user_class = User
     end
 
 Once you've decided which class to use for authentication, make sure it has
-access to database columns called:
-
-* email
-* salt
-* crypted\_password
+the right stuff in the database.
+
+    create_table :users do |t|
+      t.column :email, :string
+      t.column :password_digest, :string
+      t.column :remember_token, :string
+      t.column :reset_password_token, :string
+      t.column :session_token, :string
+    end
 
 Then in your model
 
-    include Authem::Model
+    include Authem::User
 
 #### Model Usage
 
@@ -53,13 +62,9 @@ Example:
       password_confirmation: '$ushi'
     )
 
-When saved, the password is hashed and stored as `crypted_password` in your
+When saved, the password is hashed and stored as `password_digest` in your
 database.
 
-You can call back to the model with `User#authenticate`, passing it email and
-password, which returns self if the credentials are correct, otherwise
-it returns nil.
-
 ### Controller Usage
 
 In your application controller:
@@ -68,40 +73,92 @@ In your application controller:
 
 Which gives you access to
 
-* `current_user`
-* `signed_in?`
-* `require_user`
 * `sign_in`
 * `sign_out`
-* `remember_me!`
-* `establish_presence`
+* `current_user`
+* `require_user`
+* `signed_in?`
 * `redirect_back_or_to`
 
 Then require authentication for a whole controller or action(s) with:
 
-    before_filter :require_user
+    before_filter :require_user, only: [:edit, :update]
+
+Or get even crazier:
 
-For signing in users, try a SessionsController like the following
+    before_filter :maybe_require_user_under_certain_circumstances
+
+    private
+
+    def maybe_require_user_under_certain_circumstances
+      require_user if sky.blue? and rain.expected?
+    end
+
+For signing in/out users, try a SessionsController like the following
 
     class UserSessionsController < ApplicationController
-      skip_before_filter :require_user, except: :destroy
+      //works best with decent_exposure :)
+      expose(:user) { User.find_by_email(params[:email]) }
 
+      // expects params: { email: 'foo@example.com', password: 'bar' }
       def create
-        if sign_in(params[:email], params[:password])
-          redirect_back_or_to(new_post_path)
+        if user && user.authenticate(params[:password])
+          sign_in(user)
+          redirect_back_or_to(:profile)
         else
+          flash.now.alert = "Your email and password do not match"
           render :new
         end
       end
+
+      def destroy
+        sign_out
+        redirect_to :root
+      end
     end
 
+Resetting passwords is a little more involved, but would look like this:
+
+    class PasswordResetsController < ApplicationController
+      //works best with decent_exposure :)
+      expose(:user_by_email) { User.find_by_email(params[:email]) }
+      expose(:user_by_token) { User.find_by_reset_password_token(params[:id]) }
+      expose(:reset_password_email) { UserMailer.reset_password_email(user_by_email) }
+
+      before_filter :verify_user, only: [:edit, :update]
+
+      // expects params: { email: 'foo@example.com' }
+      def create
+        reset_password_email.deliver if user_by_email
+        redirect_to [:new, :password_reset], alert: "Instructions for resetting your password have been sent to #{params[:email]}"
+      end
+
+      // expects params: { user: { password: 'bar', password_confirmation: 'bar' } }
+      def update
+        if user_by_token.reset_password(params[:user][:password], params[:user][:password_confirmation])
+          sign_in(user_by_token)
+          redirect_to :root
+        else
+          render :edit
+        end
+      end
+
+      protected
+
+      def verify_user
+        unless user_by_token
+          redirect_to [:new, :password_reset], alert: "We can't find your account with that token. You should try requesting another one."
+        end
+      end
+    end
+
+
 ## Configuration
 
-Currently, authem lets you configure the user class and sign in path:
+Authem lets you configure the user class:
 
     Authem.configure do |config|
       config.user_class   = Admin
-      config.sign_in_path = :log_in
     end
 
 ## Contribute
@@ -110,10 +167,3 @@ Pull requests are welcome; please provide spec coverage for new code.
 
 * `bundle install`
 * `rake`
-
-## Thanks
-
-* mattonrails
-* narwen
-* mattpolito
-* knwang

data/Rakefile

@@ -1,5 +1,3 @@
-require 'bundler'
-
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = "spec/**/*_spec.rb"

data/lib/authem/base_user.rb

@@ -4,10 +4,8 @@ module Authem::BaseUser
   extend ::ActiveSupport::Concern
 
   included do
-    attr_accessible :email, :password, :password_confirmation
-
     validates_uniqueness_of :email
-    validates_format_of :email, with: /^\S+@\S+$/
+    validates_format_of :email, with: /\A\S+@\S+\z/
     validates_presence_of :password, on: :create
     validates_confirmation_of :password
   end

data/lib/authem/version.rb

@@ -1,3 +1,3 @@
 module Authem
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: authem
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Elliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.rc1
 - !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: 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: pg
   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'
 description: Authem provides a simple solution for email-based authentication.
@@ -164,17 +164,17 @@ 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.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Authem authenticates them by email