authn-rails 1.0.0

data/.gitignore

@@ -0,0 +1,40 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore
+
+# Ignore all of the generated gem stuff
+/pkg
+/*.gem
+
+# Ignore bundler config
+/.bundle
+/Gemfile.lock
+
+# Ignore all bundler caching
+/vendor/cache
+/vendor/ruby
+
+# Ignore all tempfiles
+/tmp
+
+# Ignores that should be in the global gitignore
+# /*.rbc
+# /.config
+# /.yardoc
+# /InstalledFiles
+# /_yardoc
+# /coverage/
+# /doc/
+# /lib/bundler/man/
+# /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

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# 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-rails"
+
+# 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
+# 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
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1 @@
+- 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+CHANGELOG
+---------
+
+
+1.0.0 / YYYY-MM-DD
+==================
+
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in example.gemspec
+gemspec
+
+gem 'rails'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kurtis Rainbolt-Greene
+
+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,144 @@
+AuthN (Rails)
+-------------
+
+authn-rails is an extention of the AuthN library.
+
+Using AuthN
+===========
+
+To start using authn you simply need to install and hook up to your existing "user" model:
+
+``` ruby
+# create_table :accounts do |t|
+#   t.string :email, null: false, default: nil
+#   t.binary :password_digest, null: false, default: nil
+#   t.timestamps
+# end
+# add_index :accounts, :email, unique: true
+#
+
+class Account < ActiveRecord::Base
+  include AuthN::Model
+
+  has_authentication
+  has_secure_password
+
+  validates :email, uniqueness: true, presence: true, length: 5..255
+  validates :password, length: 10..1024
+
+  attr_accessible :email
+  attr_accessible :password, :password_confirmation
+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:
+
+``` ruby
+# create_table :accounts do |t|
+#   t.string :email, null: false, default: nil
+#   t.binary :password_digest, null: false, default: nil
+#
+#   t.string :activation_token, default: nil
+#   t.boolean :activation_state, null: false, default: false
+#   t.datetime :activation_expires_at, default: nil
+#
+#   t.string :password_recovery_token, default: nil
+#   t.datetime :password_recovery_expires_at, default: nil
+#
+#   t.string :login_protection_token, default: nil
+#   t.datetime :login_protection_expires_at, default: nil
+#   t.integer :login_protection_attempts, default: 0
+#
+#   t.timestamps
+# end
+# add_index :accounts, :email, unique: true
+# add_index :accounts, :activation_token, unique: true
+# add_index :accounts, :activation_state
+# add_index :accounts, :password_recovery_token, unique: true
+# add_index :accounts, :login_protection_token, unique: true
+#
+
+class Account < ActiveRecord::Base
+  include AuthN::Model
+
+  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_secure_password
+
+  validates :email, uniqueness: true, presence: true, length: 5..255
+  validates :password, length: 10..1024
+
+  attr_accessible :email
+  attr_accessible :password, :password_confirmation
+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.
+
+Installing AuthN (Rails)
+========================
+
+Add this line to your application's Gemfile:
+
+    gem 'authn-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authn-rails
+
+You're all setup and can follow the examples above.
+However if you want to fine tune your AuthN install simply run this generator:
+
+    $ rails generate authen:config
+
+To install the config files of the addons simply use:
+
+    $ rails generate authen:config:[addonname]
+
+Contributing
+============
+
+  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request
+
+License
+=======
+
+    Copyright (c) 2012 Kurtis Rainbolt-Greene
+
+    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/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+require 'yard'
+
+begin
+  Bundler.setup :default, :development
+rescue Bundler::BundlerError => error
+  $stderr.puts error.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit error.status_code
+end
+
+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
+end
+
+desc "Generate all of the docs"
+YARD::Rake::YardocTask.new do |config|
+  config.files = Dir['lib/**/*.rb']
+end
+
+desc 'Default: run tests, and generate docs'
+task :default => [ :test, :yard ]

data/authn-rails.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authn/rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "authn-rails"
+  gem.version       = AuthN::Rails::VERSION
+  gem.authors       = ["Kurtis Rainbolt-Greene"]
+  gem.email         = ["kurtisrainboltgreene@gmail.com"]
+  gem.summary       = %q{The plugin library for AuthN and Rails}
+  gem.description   = gem.summary
+  gem.homepage      = "http://github.com/krainboltgreene/authn-rails"
+
+  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"]
+
+  gem.add_runtime_dependency 'authn', '~> 1.0'
+  gem.add_runtime_dependency 'rails', '~> 3.2'
+  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'
+end

data/lib/authn.rb

@@ -0,0 +1,2 @@
+require 'authn'
+require 'rails'

data/lib/authn/engine.rb

@@ -0,0 +1,16 @@
+require 'authn'
+require 'rails'
+
+module AuthN
+  # The AuthN engine takes care of extending ActiveRecord (if used) and ActionController,
+  # With the plugin logic.
+  class Engine < Rails::Engine
+    config.authn = AuthN.config
+
+    initializer "extend Controller with AuthN" do |app|
+      ActionController::Base.send :include, AuthN::Session
+      ActionController::Base.helper_method :current_user
+      ActionController::Base.helper_method :logged_in?
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require 'authn'

data/test/lib/authn/rails/version_test.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require_relative '../../../helper'
+
+class TestAuthNRailsVersion < MiniTest::Unit::TestCase
+  def setup
+    # Setup logic here
+  end
+
+  def test_that_version_is_latest
+    assert_equal "1.0.0", AuthN::Rails::VERSION
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: authn-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: authn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: astruct
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: bcrypt-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The plugin library for AuthN and Rails
+email:
+- kurtisrainboltgreene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authn-rails.gemspec
+- lib/authn.rb
+- lib/authn/engine.rb
+- test/helper.rb
+- test/lib/authn/rails/version_test.rb
+homepage: http://github.com/krainboltgreene/authn-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3489654314563009080
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3489654314563009080
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The plugin library for AuthN and Rails
+test_files:
+- test/helper.rb
+- test/lib/authn/rails/version_test.rb
+has_rdoc: