authn 3.7.4 → 3.8.4

data/.gitignore

@@ -22,19 +22,8 @@
 # Ignores that should be in the global gitignore
 # /*.rbc
 # /.config
-# /.yardoc
-# /InstalledFiles
-# /_yardoc
-# /coverage/
-# /doc/
-# /lib/bundler/man/
+/.yardoc
+/coverage/
+/doc/
 # /rdoc/
 # /spec/reports/
-# /test/tmp/
-# /test/version_tmp/
-
-# Ignore sub-gems
-/lib/authn/activation
-/lib/authn/recovery
-/lib/authn/protection
-/lib/authn/rails

data/.rvmrc

@@ -6,10 +6,10 @@
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
 # Only full ruby name is supported here, for short names use:
 #     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p194@authn"
+environment_id="ruby-1.9.3-p392@authn"
 
 # Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.13.8 (master)" # 1.10.1 seams as a safe start
+# rvmrc_rvm_version="1.18.18 (stable)" # 1.10.1 seams as a safe start
 # eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
 #   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
 #   return 1

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 ---------
 
+3.8.4 / 2013-03-20
+==================
+
+  * Fixing a bug with current user getting called
+  * Cleaning up documentation
+
 3.7.4 / 2012-09-21
 ==================
 
@@ -17,7 +23,7 @@ CHANGELOG
 
   * Updating the readme with new details about authn-rails
   * Commenting out non-working tests
-  * Adding a convience before filter to require login
+  * Adding a convenience before filter to require login
 
 1.0.0 / 2012-MM-DD
 ==================

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Kurtis Rainbolt-Greene
+Copyright (c) 2013 Kurtis Rainbolt-Greene
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,14 @@
 AuthN
 -----
 
+  - [![Gem Version](https://badge.fury.io/rb/authn.png)](https://rubygems.org/gems/authn)
+  - [![Code Climate](https://codeclimate.com/github/krainboltgreene/authn.png)](https://codeclimate.com/github/krainboltgreene/authn)
+  - [![Build Status](https://travis-ci.org/krainboltgreene/authn.png)](https://travis-ci.org/krainboltgreene/authn)
+  - [![Dependency Status](https://gemnasium.com/krainboltgreene/authn.png)](https://gemnasium.com/krainboltgreene/authn)
+  - [![Coverage Status](https://coveralls.io/repos/krainboltgreene/authn/badge.png?branch=master)](https://coveralls.io/r/krainboltgreene/authn)
+
+
+
 authn is a simplistic and barebones authentication library.
 It only does a few things for you, such as:
 
@@ -19,7 +27,17 @@ In addition you can bring in other behavior sets like:
 Using AuthN
 ===========
 
-To start using authn you simply need to install and hook up to your existing "user" model:
+**The Model**
+
+In order to use AuthN in your model you'll only need to follow a few steps:
+
+  * ActiveModel's SecurePassword requires the model have an accessor called `password_digest`. (See schema below, for the ActiveRecord version)
+  * The `AuthN::Model` module will need to be included into the model. (See codeblock below)
+  * The singleton method `has_authentication` will need to be called.
+  * The singleton method `has_secure_password` will need to be called.
+
+That's it!
+Now for those fun code examples:
 
 ``` ruby
 # create_table :accounts do |t|
@@ -46,8 +64,9 @@ end
 
 See?
 No muss, no fuss.
-Now what about all those addons?
-We'll you can see their own pages, but here's a taste:
+Of course authn does (and will) provide extras, like activation or rails integration.
+You'll need to read those repositories for more information.
+Here's a taste of what a "fully loaded" model looks like:
 
 ``` ruby
 # create_table :accounts do |t|
@@ -79,8 +98,8 @@ class Account < ActiveRecord::Base
 
   has_authentication
   has_password_recovery mailer: "PasswordRecoveryMailer"
-  has_activation mailer: "ActivationMailer", on_create: false
-  has_login_protection maximum: 3, redirect: { controller: :accounts, action: :maximum_login_failure }
+  has_activation mailer: "ActivationMailer", on_create_send: false
+  has_login_protection maximum: 3
   has_secure_password
 
   validates :email, uniqueness: true, presence: true, length: 5..255
@@ -90,11 +109,23 @@ class Account < ActiveRecord::Base
 end
 ```
 
-You'll notice that there are options after some of the addon singleton methods.
-These are used to overwrite the global configuration.
-authn assumes quite a few things, but never stops you from changing how it works.
-As above you can change how each of your "user" models functions (for say admin recovery emails vs support recovery emails).
-In addition you can either programatically write the "global" configuration or have a `authn.yml` file ready to be loaded.
+You'll notice that each singleton method can take some options passed to it in the form of a Hash (or similar).
+These options *supercede* the global config options given by your AuthN config.
+Those options supercede the default config in the gem.
+
+
+**The Controller**
+
+Inside your controllers you have access to these methods:
+
+  * `login email: "jpublic@mail.com", password: "12341234"`, for logging accounts in if the creds match
+  * `auto_login Account.find(23)`, for automatically logging in a certain account
+  * `logged_in?` for checking if there's a current user
+  * `current_user` which returns the current user instance
+  * `require_login`, which redirects to the `unauthorized` action if the user isn't logged in
+  * `logout`, for logging out of the current user
+
+For more information, check the [wiki](/wiki)
 
 Installing AuthN
 ================

data/Rakefile

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
-require 'bundler/gem_tasks'
-require 'rake/clean'
-require 'rake/testtask'
-require 'yard'
+require "bundler/gem_tasks"
+require "rake/clean"
+require "rake/testtask"
+require "yard"
 
 begin
   Bundler.setup :default, :development
@@ -16,16 +16,14 @@ Bundler::GemHelper.install_tasks
 
 desc "Run all of the tests"
 Rake::TestTask.new do |config|
-  config.libs << 'test'
-  config.pattern = 'test/**/*_test*'
-  config.verbose = true
-  config.warning = true
+  config.libs << "test"
+  config.pattern = "test/**/*_test.rb"
 end
 
 desc "Generate all of the docs"
 YARD::Rake::YardocTask.new do |config|
-  config.files = Dir['lib/**/*.rb']
+  config.files = Dir["lib/**/*.rb"]
 end
 
-desc 'Default: run tests, and generate docs'
+desc "Default: run tests, and generate docs"
 task :default => [ :test, :yard ]

data/authn.gemspec

@@ -1,27 +1,31 @@
-# encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'authn/version'
+require "authn/version"
 
-Gem::Specification.new do |gem|
-  gem.name          = "authn"
-  gem.version       = AuthN::VERSION
-  gem.authors       = ["Kurtis Rainbolt-Greene"]
-  gem.email         = ["me@kurtisrainboltgreene.name"]
-  gem.summary       = %q{An incredibly bare bones authentication library}
-  gem.description   = gem.summary
-  gem.homepage      = "http://krainboltgreene.github.com/authn"
+Gem::Specification.new do |spec|
+  spec.name          = "authn"
+  spec.version       = AuthN::VERSION
+  spec.authors       = ["Kurtis Rainbolt-Greene"]
+  spec.email         = ["me@kurtisrainboltgreene.name"]
+  spec.summary       = %q{An incredibly bare bones authentication library}
+  spec.description   = spec.summary
+  spec.homepage      = "http://krainboltgreene.github.com/authn"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/)
+  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"]
 
-  gem.add_runtime_dependency 'activemodel', '~> 3.0'
-  gem.add_runtime_dependency 'astruct', '~> 2.9'
-  gem.add_runtime_dependency 'bcrypt-ruby', '~> 3.0'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'kramdown'
-  # gem.add_runtime_dependency 'gemname', '~> 1.0'
-  # gem.add_development_dependency 'gemname', '~> 1.0'
+  spec.add_runtime_dependency 'activemodel', '~> 3.0'
+  spec.add_runtime_dependency 'astruct', '~> 2.9'
+  spec.add_runtime_dependency 'bcrypt-ruby', '~> 3.0'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "kramdown"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls"
 end

data/lib/authn/session.rb

@@ -1,6 +1,7 @@
 module AuthN
   module Session
     private
+
     def login(identifiers, klass = AuthN.config.account_klass)
       generate_session_and_instance_from find_instance_klass(klass).authenticate identifiers
     end
@@ -36,7 +37,7 @@ module AuthN
     end
 
     def klass_as_name(klass)
-      klass.name.downcase
+      (klass.respond_to?(:name) ? klass.name : klass).downcase
     end
 
     def generate_session_and_instance_from(instance)

data/lib/authn/version.rb

@@ -1,3 +1,3 @@
 module AuthN
-  VERSION = "3.7.4"
+  VERSION = "3.8.4"
 end

data/test/lib/authn_test.rb

@@ -6,7 +6,7 @@ class TestAuthN < MiniTest::Unit::TestCase
     assert true
   end
 
-  def test_that_AuthN_is_defined
+  def test_that_namespace_defined
     assert(defined?(AuthN))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authn
 version: !ruby/object:Gem::Version
-  version: 3.7.4
+  version: 3.8.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,88 +9,168 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
+  prerelease: false
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
+        version: '2.9'
+    none: false
+  prerelease: false
   name: astruct
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
-- !ruby/object:Gem::Dependency
+        version: '3.0'
+    none: false
+  prerelease: false
   name: bcrypt-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+    none: false
+  type: :development
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
   prerelease: false
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  type: :development
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
   prerelease: false
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  type: :development
 description: An incredibly bare bones authentication library
 email:
 - me@kurtisrainboltgreene.name
@@ -118,32 +198,33 @@ files:
 - test/lib/authn/session_test.rb
 - test/lib/authn_test.rb
 homepage: http://krainboltgreene.github.com/authn
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      hash: 2952794838346421510
       version: '0'
       segments:
       - 0
-      hash: 2261638177236117174
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      hash: 2952794838346421510
       version: '0'
       segments:
       - 0
-      hash: 2261638177236117174
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: An incredibly bare bones authentication library