authn-activation 1.7.0

data/.gitignore

@@ -0,0 +1,35 @@
+# 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/
+

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-activation"
+
+# 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,140 @@
+AuthN Activation
+----------------
+
+authn-activation is an extention of the AuthN library to allow for activation type business logic.
+This means that AuthN-behaving models can be "activated" and "deactivated".
+It would also be trivial to implement an invite business logic.
+
+
+Using AuthN Activation
+======================
+
+To start using authn-activation you simply need to install authn, authn-activation, and hook up to your existing "user" model:
+
+``` ruby
+# create_table :accounts do |t|
+#   t.string :email
+#   t.binary :password_digest
+#
+#   t.timestamps
+# end
+# add_index :accounts, :email
+#
+
+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
+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
+#   t.binary :password_digest
+#
+#   t.string :activation_token
+#   t.boolean :activation_state, default: false
+#   t.datetime :activation_expires_at
+#
+#   t.string :password_recovery_token
+#   t.datetime :password_recovery_expires_at
+#
+#   t.string :login_protection_token
+#   t.datetime :login_protection_expires_at
+#   t.integer :login_protection_attempts, default: 0
+#
+#   t.timestamps
+# end
+# add_index :accounts, :email
+# add_index :accounts, :activation_token
+# add_index :accounts, :activation_state
+# add_index :accounts, :password_recovery_token
+# add_index :accounts, :login_protection_token
+#
+
+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
+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 Activation
+===========================
+
+Add this line to your application's Gemfile:
+
+    gem 'authn-activation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authn-activation
+
+You're all setup and can follow the examples above.
+
+
+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-activation.gemspec

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

@@ -0,0 +1,9 @@
+require 'authn'
+require_relative 'authn/activation/version'
+require_relative 'authn/model'
+
+module AuthN
+  module Activation
+
+  end
+end

data/lib/authn/activation/model.rb

@@ -0,0 +1,52 @@
+module AuthN
+  module Activation
+    module Model
+      def activate(token)
+        activate_instance if token_matches(token) && can_activate?
+      end
+
+      def activate!
+        activate_instance
+      end
+
+      def activated?
+        send_activation_state
+      end
+
+      def deactivate!
+        activate_instance false
+      end
+
+      private
+
+      def send_activation_token
+        send config.activation_token_method
+      end
+
+      def send_activation_state(value = nil)
+        send config.activation_state_method, value
+      end
+
+      def send_activation_expires_at
+        send config.activation_expires_at_method
+      end
+
+      def activate_instance(value = true)
+        send_activation_state value
+        send_activation_mail if method_defined?(send_activation_mail)
+      end
+
+      def token_matches(token)
+        send_activation_token != token
+      end
+
+      def can_activate?
+        !send_activation_state && activation_expired?
+      end
+
+      def activation_expired?
+        send_activation_expires_at >= DateTime.now
+      end
+    end
+  end
+end

data/lib/authn/activation/version.rb

@@ -0,0 +1,5 @@
+module AuthN
+  module Activation
+    VERSION = "1.7.0"
+  end
+end

data/lib/authn/config.rb

@@ -0,0 +1,9 @@
+module AuthN
+  class Config
+    @@defaults.merge!(
+      mailer_klass: "ActivationMailer",
+      activation_state_method: :activation_state,
+      activation_token_method: :activation_token,
+      activation_expires_at_method: :activation_expires_at)
+  end
+end

data/lib/authn/model.rb

@@ -0,0 +1,9 @@
+require_relative 'activation/model'
+
+module AuthN
+  module Model
+    module ClassMethods
+      extend AuthN::Activation::Model
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,54 @@
+require 'authn-activation'
+
+module ActiveModel::Model
+  def self.included(base)
+    base.class_eval do
+      extend  ActiveModel::Naming
+      extend  ActiveModel::Translation
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+      include ActiveModel::SecurePassword
+    end
+  end
+
+  def initialize(params={})
+    params.each do |attr, value|
+      self.public_send("#{attr}=", value)
+    end if params
+  end
+
+  def persisted?
+    false
+  end
+end
+
+
+class Account
+  include ActiveModel::Model
+  include AuthN::Model
+
+  has_authentication
+  has_activation
+  has_secure_password
+
+  attr_accessor :password_digest
+
+  def self.password(password=nil)
+    if password
+      @password = password
+    else
+      @password
+    end
+  end
+
+  def self.where(hash)
+    account = if hash[:email] == "kurtis@example.com"
+      Account.new(password: password, password_confirmation: password)
+    end
+    [account]
+  end
+
+  def id
+    @id ||= rand(100000)
+  end
+end

data/test/lib/authn-activation_test.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'helper'
+
+class TestAuthNActivation < MiniTest::Unit::TestCase
+  def test_that_things_work
+    assert true
+  end
+
+  def test_that_AuthN_is_defined
+    assert(defined?(AuthN::Activation))
+  end
+end

data/test/lib/authn/activation/model_test.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'helper'
+
+class TestAuthNActivationModel < MiniTest::Unit::TestCase
+  def test_that_things_work
+    assert true
+  end
+end

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

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require_relative '../../helper'
+
+class TestAuthNActivationVersion < MiniTest::Unit::TestCase
+  def test_that_version_is_latest
+    assert_equal "1.7.0", AuthN::Activation::VERSION
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: authn-activation
+version: !ruby/object:Gem::Version
+  version: 1.7.0
+  prerelease: 
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-05 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: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.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:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authn-activation.gemspec
+- lib/authn-activation.rb
+- lib/authn/activation/model.rb
+- lib/authn/activation/version.rb
+- lib/authn/config.rb
+- lib/authn/model.rb
+- test/helper.rb
+- test/lib/authn-activation_test.rb
+- test/lib/authn/activation/model_test.rb
+- test/lib/authn/activation/version_test.rb
+- test/lib/authn/config_test.rb
+- test/lib/authn/model_test.rb
+homepage: http://krainboltgreene.github.com/authn-activation
+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: -2462880146099724815
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2462880146099724815
+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-activation_test.rb
+- test/lib/authn/activation/model_test.rb
+- test/lib/authn/activation/version_test.rb
+- test/lib/authn/config_test.rb
+- test/lib/authn/model_test.rb
+has_rdoc: