active_session 0.0.6 → 0.1.0

data/lib/active_session/version.rb

@@ -1,3 +1,3 @@
 module ActiveSession
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/active_session.rb

@@ -4,7 +4,43 @@ require "active_session/attribute_methods"
 require "active_session/errors"
 
 module ActiveSession
+  # Adds a simple session mechanism for a given model.
+  #
+  # <tt>authenticates :user</tt> adds <tt>user</tt> and
+  # <tt>user=(new_user)</tt> methods.
+  #
+  # Options are:
+  # * <tt>:class_name</tt> - Specifies the class name of the
+  #   association. Use it only if that name can't be inferred from the
+  #   name. So <tt>authenticates :user</tt> will by default be linked
+  #   to the User class, but if the real class name is Admin, you'll
+  #   have to specify it using this option.
+  # * <tt>:foreign_key</tt> - Specifies the foreign key of the
+  #   association. Use it only if the key can't be inferred from the
+  #   name. So <tt>authenticates :user</tt> will by default add
+  #   <tt>user_id</tt> and <tt>user_id=(new_user_id)</tt> methods.
+  # * <tt>:primary_key</tt> - Specifies the primary key of the
+  #   association. Use it only if the key is different than <tt>id</tt>.
+  # * <tt>:finder_method</tt> - Specifies the finder_method for the
+  #   association. Uses <tt>find_for_authentication</tt> method by
+  #   default.
+  # * <tt>:persists</tt> - Specifies if the session model is
+  #   persistable in the store. If set to <tt>true</tt> (default)
+  #   <tt>foreign_key</tt> will be used to store session. So
+  #   <tt>authenticates :user</tt> will by default store the session
+  #   using <tt>:user_id</tt> key in the store, and use
+  #   <tt>user_id</tt> method to fetch the stored value. You can
+  #   change it to <tt>:email</tt> if you want to use <tt>:email</tt>
+  #   key and <tt>email</tt> method to store the session. You can also
+  #   turn the persistence off by passing <tt>false</tt>. Adds
+  #   <tt>save</tt>, <tt>destroy</tt>, <tt>persisted?</tt> and a class
+  #   method <tt>find</tt> when turned on. When turned off adds only
+  #   <tt>persisted?</tt> method that returns false to comply with
+  #   <tt>ActiveModel::Lint</tt>.
+
   def authenticates(name, options = {})
+    options.assert_valid_keys(:class_name, :foreign_key, :primary_key, :finder_method, :persists)
+
     klass         = options.fetch(:class_name, name.to_s.classify)
     foreign_key   = options.fetch(:foreign_key, "#{name}_id").to_sym
     primary_key   = options.fetch(:primary_key, "id").to_sym

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_session
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-10-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &17538940 !ruby/object:Gem::Requirement
+  requirement: &11440600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *17538940
+  version_requirements: *11440600
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &17538440 !ruby/object:Gem::Requirement
+  requirement: &11440080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *17538440
+  version_requirements: *11440080
 description: ActiveModel session
 email:
 - qoobaa@gmail.com