devise_certifiable 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in devise_certifiable.gemspec
+gemspec
+
+group :test do
+  gem 'sqlite3'
+  gem "capybara"
+  gem "launchy"
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Luis Gracia
+
+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.rdoc

@@ -0,0 +1,53 @@
+= devise_certifiable
+
+Sign up certification strategy for devise[http://github.com/plataformatec/devise]. New sign up users need to be certified before they can sign in. After sign up an email is sent to the email address specified in the devise configuration option _config.mailer_sender_.
+
+Devise_certifiable has been tested with Devise 1.2.1 and Rails 3.0.6 using ActiveRecord, but similar version should work as well (ie. Devise 1.2.x and Rails 3.0.x). 
+
+== Installation
+
+ rails generate devise_certifiable MODEL
+
+will add _:certifiable_ to model _MODEL_ and create a migration file.
+
+== Configuration
+
+There are no configuration options at the moment.
+
+=== Controllers
+
+By default devise_certifiable follows Devise authentication to allow certifications. You can customize how to authenticate for a certifier overriding _:authenticate_certifier!_ in _application_controller.rb_. For example using CanCan[https://github.com/ryanb/cancan]:
+
+ def authenticate_certifier!
+    authorize! :certify, User
+  end
+
+=== Views
+
+You can customize the views and mails by doing:
+
+ rails generate devise_certifiable:install views
+
+This will copy the views to app/views/devise.
+
+=== Localization
+
+Localization can be customized by:
+
+ rails generate devise_certifiable:install
+
+This will copy the locale file to your rails tree.
+
+== Contributing to devise_certifiable
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Luis Gracia. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+desc 'Default: run tests for all ORMs.'
+task :default => :pre_commit
+
+desc 'Run Devise tests for all ORMs.'
+task :pre_commit do
+  Dir[File.join(File.dirname(__FILE__), 'test', 'orm', '*.rb')].each do |file|
+    orm = File.basename(file).split(".").first
+    # "Some day, my son, rake's inner wisdom will reveal itself.  Until then,
+    # take this `system` -- may its brute force protect you well."
+    #exit 1 unless system "rake test DEVISE_ORM=#{orm}"
+    system "rake test DEVISE_ORM=#{orm}"
+  end
+end
+
+desc 'Run std unit tests.'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib'
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/app/controllers/devise/certifications_controller.rb

@@ -0,0 +1,34 @@
+class Devise::CertificationsController < ApplicationController
+  include Devise::Controllers::InternalHelpers
+  before_filter :authenticate_certifier!
+  
+  # GET /resource/certification/edit?certification_token=abcdef
+  def edit
+    self.resource = resource_class.find_resource_by_token(params[:certification_token])
+    
+    if resource.errors.empty?
+      render_with_scope :edit
+    else
+      set_flash_message(:alert, :certification_token_invalid)
+      redirect_to self.resource
+    end
+  end
+
+  # PUT /resource/certification
+  def update
+    self.resource = resource_class.certify_by_token(params[resource_name][:certification_token], current_certifier)
+    params[resource_name].delete(:certification_token)
+    self.resource.update_attributes(params[resource_name])
+    if resource.errors.empty?
+      set_flash_message :notice, :certified
+      redirect_to self.resource
+    else
+      render_with_scope :edit
+    end
+  end
+
+  protected
+  def current_certifier
+    current_user
+  end
+end

data/app/views/devise/certifications/edit.html.erb

@@ -0,0 +1,14 @@
+<h2><%= resource_name.capitalize %> Certification</h2>
+
+<%= form_for(resource, :as => resource_name, :url => certification_path(resource_name), :html => { :method => :put }) do |f| %>
+  <%= devise_error_messages! %>
+
+  <table>
+    <tr>
+      <td><%= f.label :email %></td>
+      <td><%= f.label :email, resource.email %></td>
+    </tr>
+  </table>
+  <%= f.hidden_field :certification_token -%>
+  <p><%= f.submit "Certify" %></p>
+<% end %>

data/app/views/devise/mailer/certification_request.html.erb

@@ -0,0 +1,8 @@
+<p>Dear Admin,</p>
+
+<p>The following user has requested access to the site:</p>
+<table>
+  <tr><td>Email:</td><td><%= @resource.email %></td></tr>
+</table>
+
+<p><%= link_to 'Certify', edit_certification_url(@resource, :certification_token => @resource.certification_token) %></p>

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  errors:
+    messages:
+      certification_authority_missing: '(certification authority) not specified'
+      already_certified: 'was already certified!'
+
+
+  devise:
+    failure:
+      :uncertified: 'Your account needs to be certified.'
+    mailer:
+      certification_request:
+        subject: 'Certification request'
+    certifications:
+      certification_token_invalid: 'The certification token provided is not valid!'
+      certified: 'Successfuly certified user'
+      

data/devise_certifiable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devise_certifiable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devise_certifiable"
+  s.version     = DeviseCertifiable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luis Gracia"]
+  s.email       = ["lgraval@gmail.com"]
+  s.homepage    = "https://github.com/luisico/devise_certifiable"
+  s.summary     = %q{Sign up certification strategy for devise}
+  s.description = %q{New sign ups need to be certified before they can sign in}
+
+  s.add_dependency('rails',  '~> 3.0.0')
+  s.add_dependency('devise', '~> 1.2.0')
+
+  s.add_development_dependency('devise_invitable', '~> 0.4.0')
+  s.add_development_dependency('bundler', '~> 1.0.12')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/devise_certifiable.rb

@@ -0,0 +1,13 @@
+require 'devise'
+
+require 'devise_certifiable/mailer'
+require 'devise_certifiable/routes'
+require 'devise_certifiable/schema'
+require 'devise_certifiable/controllers/url_helpers'
+require 'devise_certifiable/controllers/helpers'
+require 'devise_certifiable/rails'
+
+module Devise
+end
+
+Devise.add_module :certifiable, :model => 'devise_certifiable/model', :route => :certification, :controller => :certifications

data/lib/devise_certifiable/controllers/helpers.rb

@@ -0,0 +1,7 @@
+module DeviseCertifiable::Controllers::Helpers
+  protected
+  def authenticate_certifier!
+    send(:"authenticate_#{resource_name}!", true)
+  end
+end
+ActionController::Base.send :include, DeviseCertifiable::Controllers::Helpers

data/lib/devise_certifiable/controllers/url_helpers.rb

@@ -0,0 +1,24 @@
+module DeviseCertifiable
+  module Controllers
+    module UrlHelpers
+      [:path, :url].each do |path_or_url|
+        [nil, :edit_].each do |action|
+          class_eval <<-URL_HELPERS, __FILE__, __LINE__ + 1
+            def #{action}certification_#{path_or_url}(resource, *args)
+              resource = case resource
+                when Symbol, String
+                  resource
+                when Class
+                  resource.name.underscore
+                else
+                  resource.class.name.underscore
+              end
+              
+              send("#{action}\#{resource}_certification_#{path_or_url}", *args)
+            end
+          URL_HELPERS
+        end
+      end
+    end
+  end
+end

data/lib/devise_certifiable/mailer.rb

@@ -0,0 +1,10 @@
+module DeviseCertifiable
+  module Mailer
+    # Request certification from  certification authority
+    def certification_request(record)
+      mail = setup_mail(record, :certification_request)
+      mail.to = mailer_sender(@devise_mapping)
+      return mail
+    end
+  end
+end

data/lib/devise_certifiable/model.rb

@@ -0,0 +1,98 @@
+module Devise
+  module Models
+    module Certifiable
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :certified_by, :polymorphic => true
+        before_create :generate_certification_token, :if => :certification_required?
+        after_create :request_certification, :if => :certification_required?
+        alias_method_chain :send_confirmation_instructions, :certification
+      end
+      
+      def certify!(certification_authority)
+        unless_certified do
+          unless certification_authority.blank?
+            self.certification_token = nil
+            self.certified_at = Time.now
+            self.certified_by = certification_authority
+            save(:validate => false)
+            send_confirmation_instructions if confirmation_required?
+          else
+            self.errors.add(:certified_by, :certification_authority_missing)
+            false
+          end
+        end
+      end
+
+      def certified?
+        !!certified_at
+      end
+
+      # Deliver certification request to certification authority
+      def request_certification
+        if self.respond_to?(:invite!) && self.invitation_token.present?
+          certify!(self.invited_by)
+        else
+          generate_certification_token! if self.certification_token.nil?
+          ::Devise.mailer.certification_request(self).deliver
+        end
+      end
+      
+      def active_for_authentication?
+        super && certified?
+      end
+      
+      def inactive_message
+        !certified? ? :uncertified : super
+      end
+      protected
+      
+      def certification_required?
+        !certified?
+      end
+
+      def send_confirmation_instructions_with_certification
+        send_confirmation_instructions_without_certification if certified?
+      end
+      
+      def unless_certified
+        unless certified?
+          yield
+        else
+          self.errors.add(:email, :already_certified)
+          false
+        end
+      end
+
+      # Generate certification token
+      def generate_certification_token
+        self.certification_token = self.class.certification_token
+        self.certified_at = nil
+        self.certified_by = nil
+      end
+
+      def generate_certification_token!
+        generate_certification_token && save(:validate => false)
+      end
+
+      module ClassMethods
+        # Generate token
+        def certification_token
+          generate_token(:certification_token)
+        end
+
+        def certify_by_token(certification_token, certification_authority)
+          certifiable = find_resource_by_token(certification_token)
+          certifiable.certify!(certification_authority) if certifiable.persisted?
+          certifiable
+        end
+
+        def find_resource_by_token(certification_token)
+          certifiable = find_or_initialize_with_error_by(:certification_token, certification_token)
+        end
+
+      end
+    end
+  end
+end

data/lib/devise_certifiable/rails.rb

@@ -0,0 +1,12 @@
+module DeviseCertifiable
+  class Engine < ::Rails::Engine
+
+    ActiveSupport.on_load(:action_controller) { include DeviseCertifiable::Controllers::UrlHelpers }
+    ActiveSupport.on_load(:action_view)       { include DeviseCertifiable::Controllers::UrlHelpers }
+
+    config.to_prepare do
+      require 'devise/mailer'
+      Devise::Mailer.send :include, DeviseCertifiable::Mailer
+    end
+  end
+end

data/lib/devise_certifiable/routes.rb

@@ -0,0 +1,10 @@
+module ActionDispatch::Routing
+  class Mapper
+    
+    protected
+    def devise_certification(mapping, controllers)
+      resource :certification, :only => [:edit, :update],
+      :path => mapping.path_names[:certification], :controller => controllers[:certifications]
+    end
+  end
+end

data/lib/devise_certifiable/schema.rb

@@ -0,0 +1,12 @@
+module DeviseCertifiable
+  module Schema
+    def certifiable
+      apply_devise_schema :certification_token, String, :limit => 60
+      apply_devise_schema :certified_at, DateTime
+      apply_devise_schema :certified_by_id, Integer 
+      apply_devise_schema :certified_by_type, String 
+    end
+  end
+end
+
+Devise::Schema.send :include, DeviseCertifiable::Schema

data/lib/devise_certifiable/version.rb

@@ -0,0 +1,3 @@
+module DeviseCertifiable
+  VERSION = "0.1.0"
+end

data/lib/generators/active_record/devise_certifiable_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class DeviseCertifiableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_devise_migration
+        migration_template "migration.rb", "db/migrate/devise_certifiable_add_to_#{table_name}"
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,18 @@
+class DeviseCertifiableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table :<%= table_name %> do |t|
+      t.string     :certification_token, :limit => 60
+      t.datetime   :certified_at
+      t.references :certified_by, :polymorphic => true
+      t.index      :certification_token
+      t.index      :certified_by_id
+    end
+  end
+  
+  def self.down
+    change_table :<%= table_name %> do |t|
+      t.remove_references :certified_by, :polymorphic => true
+      t.remove :certification_token, :certified_at
+    end
+  end
+end