authem 1.0.0.rc1 → 1.0.0.rc2

data/README.markdown

@@ -8,6 +8,102 @@ Authem is tested against Ruby 1.9.2, 1.9.3, Rubinius
 
 [![Build Status](https://secure.travis-ci.org/paulelliott/authem.png)](http://travis-ci.org/paulelliott/authem)
 
+## Installation
+
+Add the following to your project's Gemfile:
+
+    gem 'authem'
+
+## Usage
+
+### Model Setup
+
+Tell authem which of your classes will be used for authentication
+
+    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
+
+Then in your model
+
+    include Authem::Model
+
+#### Model Usage
+
+Now that your class is all set up using Authem...
+
+Provide your instance with the following attributes:
+
+* email
+* password
+* password\_confirmation
+
+Example:
+
+    User.new(
+      email: 'matt@example.com',
+      password: '$ushi',
+      password_confirmation: '$ushi'
+    )
+
+When saved, the password is hashed and stored as `crypted_password` 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:
+
+    include Authem::ControllerSupport
+
+Which gives you access to
+
+* `current_user`
+* `signed_in?`
+* `require_user`
+* `sign_in`
+* `sign_out`
+* `remember_me!`
+* `establish_presence`
+* `redirect_back_or_to`
+
+Then require authentication for a whole controller or action(s) with:
+
+    before_filter :require_user
+
+For signing in users, try a SessionsController like the following
+
+    class UserSessionsController < ApplicationController
+      skip_before_filter :require_user, except: :destroy
+
+      def create
+        if sign_in(params[:email], params[:password])
+          redirect_back_or_to(new_post_path)
+        else
+          render :new
+        end
+      end
+    end
+
+## Configuration
+
+Currently, authem lets you configure the user class and sign in path:
+
+    Authem.configure do |config|
+      config.user_class   = Admin
+      config.sign_in_path = :log_in
+    end
+
 ## Contribute
 
 Pull requests are welcome; please provide spec coverage for new code.
@@ -15,3 +111,9 @@ Pull requests are welcome; please provide spec coverage for new code.
 * `bundle install`
 * `rake`
 
+## Thanks
+
+* mattonrails
+* narwen
+* mattpolito
+* knwang

data/lib/authem/controller_support.rb

@@ -26,7 +26,7 @@ module Authem::ControllerSupport
 
   def require_user
     unless current_user
-      session[:return_to_url] = request.url
+      session[:return_to_url] = request.url unless request.url.xhr?
       redirect_to Authem::Config.sign_in_path
     end
   end
@@ -43,6 +43,7 @@ module Authem::ControllerSupport
 
   included do
     helper_method :current_user
+    helper_method :signed_in?
   end
 
 end

data/lib/authem/version.rb

@@ -1,3 +1,3 @@
 module Authem
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

data/lib/generators/authem/model/model_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/base'
+
+module Authem
+  class ModelGenerator < Rails::Generators::Base
+
+    argument :model_name, type: :string, default: "user"
+
+    def generate_model
+      generate("model #{model_name} email:string, password_digest:string, reset_password_token:string, session_token:string")
+    end
+
+    def update_model_to_include_authem
+      insert_into_file "app/models/#{model_name}.rb", "\n  include Authem::User\n\n", after: "class #{model_name.camelize} < ActiveRecord::Base\n"
+    end
+
+    def add_initializer
+      create_file 'config/initializers/authem.rb' do
+        %Q(Authem.configure do |config|\n  config.user_class = #{model_name.camelize}\nend)
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authem
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,7 @@ files:
 - lib/authem/user.rb
 - lib/authem/version.rb
 - lib/authem.rb
+- lib/generators/authem/model/model_generator.rb
 - LICENSE
 - README.markdown
 - Rakefile