aihs_devise_invitable 0.4.rc

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

@@ -0,0 +1,14 @@
+<h2>Set your password</h2>
+
+<%= form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => { :method => :put } do |f| %>
+  <%= devise_error_messages! %>
+  <%= f.hidden_field :invitation_token %>
+
+  <p><%= f.label :password %><br />
+  <%= f.password_field :password %></p>
+
+  <p><%= f.label :password_confirmation %><br />
+  <%= f.password_field :password_confirmation %></p>
+
+  <p><%= f.submit "Set my password" %></p>
+<% end %>

data/app/views/devise/invitations/new.html.erb

@@ -0,0 +1,12 @@
+<h2>Send invitation</h2>
+
+<%= form_for resource, :as => resource_name, :url => invitation_path(resource_name) do |f| %>
+  <%= devise_error_messages! %>
+
+  <p><%= f.label :email %><br />
+  <%= f.text_field :email %></p>
+
+  <p><%= f.submit "Send an invitation" %></p>
+<% end %>
+
+<%= link_to "Home", after_sign_in_path_for(resource_name) %><br />

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

@@ -0,0 +1,8 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Someone has invited you to <%= root_url %>, you can accept it through the link below.</p>
+
+<p><%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @resource.invitation_token) %></p>
+
+<p>If you don't want to accept the invitation, please ignore this email.<br />
+Your account won't be created until you access the link above and set your password.</p>

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

@@ -0,0 +1,8 @@
+<p>Hello <%= @resource.email %>!</p>
+
+<p>Someone has invited you to <%= root_url %>, you can accept it through the link below.</p>
+
+<p><%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @resource.invitation_token) %></p>
+
+<p>If you don't want to accept the invitation, please ignore this email.<br />
+Your account won't be created until you access the link above and set your password.</p>

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  devise:
+    invitations:
+      send_instructions: 'An invitation email has been sent to %{email}.'
+      invitation_token_invalid: 'The invitation token provided is not valid!'
+      updated: 'Your password was set successfully. You are now signed in.'
+  mailer:
+    invitation_instructions:
+      subject: 'Invitation instructions'

data/devise_invitable.gemspec

@@ -0,0 +1,143 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{devise_invitable}
+  s.version = "0.4.rc"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergio Cambra"]
+  s.date = %q{2010-10-05}
+  s.description = %q{It adds support for send invitations by email (it requires to be authenticated) and accept the invitation setting the password}
+  s.email = %q{sergio@entrecables.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "app/controllers/devise/invitations_controller.rb",
+     "app/views/devise/invitations/edit.html.erb",
+     "app/views/devise/invitations/new.html.erb",
+     "app/views/devise/mailer/invitation.html.erb",
+     "config/locales/en.yml",
+     "devise_invitable.gemspec",
+     "lib/devise_invitable.rb",
+     "lib/devise_invitable/controllers/helpers.rb",
+     "lib/devise_invitable/controllers/url_helpers.rb",
+     "lib/devise_invitable/mailer.rb",
+     "lib/devise_invitable/model.rb",
+     "lib/devise_invitable/rails.rb",
+     "lib/devise_invitable/routes.rb",
+     "lib/devise_invitable/schema.rb",
+     "lib/devise_invitable/version.rb",
+     "lib/generators/active_record/devise_invitable_generator.rb",
+     "lib/generators/active_record/templates/migration.rb",
+     "lib/generators/devise_invitable/devise_invitable_generator.rb",
+     "lib/generators/devise_invitable/install_generator.rb",
+     "lib/generators/devise_invitable/views_generator.rb",
+     "test/generators_test.rb",
+     "test/integration/invitation_test.rb",
+     "test/integration_tests_helper.rb",
+     "test/mailers/invitation_mail_test.rb",
+     "test/model_tests_helper.rb",
+     "test/models/invitable_test.rb",
+     "test/models_test.rb",
+     "test/rails_app/app/controllers/admins_controller.rb",
+     "test/rails_app/app/controllers/application_controller.rb",
+     "test/rails_app/app/controllers/home_controller.rb",
+     "test/rails_app/app/controllers/users_controller.rb",
+     "test/rails_app/app/helpers/application_helper.rb",
+     "test/rails_app/app/models/octopussy.rb",
+     "test/rails_app/app/models/user.rb",
+     "test/rails_app/app/views/home/index.html.erb",
+     "test/rails_app/app/views/layouts/application.html.erb",
+     "test/rails_app/app/views/users/invitations/new.html.erb",
+     "test/rails_app/config.ru",
+     "test/rails_app/config/application.rb",
+     "test/rails_app/config/boot.rb",
+     "test/rails_app/config/database.yml",
+     "test/rails_app/config/environment.rb",
+     "test/rails_app/config/environments/development.rb",
+     "test/rails_app/config/environments/production.rb",
+     "test/rails_app/config/environments/test.rb",
+     "test/rails_app/config/initializers/backtrace_silencers.rb",
+     "test/rails_app/config/initializers/devise.rb",
+     "test/rails_app/config/initializers/inflections.rb",
+     "test/rails_app/config/initializers/mime_types.rb",
+     "test/rails_app/config/initializers/secret_token.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/locales/en.yml",
+     "test/rails_app/config/routes.rb",
+     "test/rails_app/script/rails",
+     "test/routes_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/scambra/devise_invitable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An invitation strategy for devise}
+  s.test_files = [
+    "test/generators_test.rb",
+     "test/integration/invitation_test.rb",
+     "test/integration_tests_helper.rb",
+     "test/mailers/invitation_mail_test.rb",
+     "test/model_tests_helper.rb",
+     "test/models/invitable_test.rb",
+     "test/models_test.rb",
+     "test/rails_app/app/controllers/admins_controller.rb",
+     "test/rails_app/app/controllers/application_controller.rb",
+     "test/rails_app/app/controllers/home_controller.rb",
+     "test/rails_app/app/controllers/users_controller.rb",
+     "test/rails_app/app/helpers/application_helper.rb",
+     "test/rails_app/app/models/octopussy.rb",
+     "test/rails_app/app/models/user.rb",
+     "test/rails_app/config/application.rb",
+     "test/rails_app/config/boot.rb",
+     "test/rails_app/config/environment.rb",
+     "test/rails_app/config/environments/development.rb",
+     "test/rails_app/config/environments/production.rb",
+     "test/rails_app/config/environments/test.rb",
+     "test/rails_app/config/initializers/backtrace_silencers.rb",
+     "test/rails_app/config/initializers/devise.rb",
+     "test/rails_app/config/initializers/inflections.rb",
+     "test/rails_app/config/initializers/mime_types.rb",
+     "test/rails_app/config/initializers/secret_token.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/routes.rb",
+     "test/routes_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_development_dependency(%q<capybara>, [">= 0.3.9"])
+      s.add_development_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_dependency(%q<capybara>, [">= 0.3.9"])
+      s.add_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    s.add_dependency(%q<capybara>, [">= 0.3.9"])
+    s.add_dependency(%q<rails>, ["~> 3.0.0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+  end
+end
+

data/lib/devise_invitable.rb

@@ -0,0 +1,16 @@
+require 'devise'
+
+require 'devise_invitable/mailer'
+require 'devise_invitable/routes'
+require 'devise_invitable/schema'
+require 'devise_invitable/controllers/url_helpers'
+require 'devise_invitable/controllers/helpers'
+require 'devise_invitable/rails'
+
+module Devise
+  # The period the generated invitation token is valid.
+  mattr_accessor :invite_for
+  @@invite_for = 0
+end
+
+Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation

data/lib/devise_invitable/controllers/helpers.rb

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

data/lib/devise_invitable/controllers/url_helpers.rb

@@ -0,0 +1,24 @@
+module DeviseInvitable
+  module Controllers
+    module UrlHelpers
+      [:path, :url].each do |path_or_url|
+        [nil, :new_, :accept_].each do |action|
+          class_eval <<-URL_HELPERS, __FILE__, __LINE__ + 1
+            def #{action}invitation_#{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}_invitation_#{path_or_url}", *args)
+            end
+          URL_HELPERS
+        end
+      end
+    end
+  end
+end

data/lib/devise_invitable/mailer.rb

@@ -0,0 +1,14 @@
+module DeviseInvitable
+  module Mailer
+    
+    # Deliver an invitation email
+    def invitation_instructions(record)
+      setup_mail(record, :invitation_instructions)
+    end
+    
+    def invitation(record)
+      ActiveSupport::Deprecation.warn('invitation has been renamed to invitation_instructions')
+      invitation_instructions(record)
+    end
+  end
+end

data/lib/devise_invitable/model.rb

@@ -0,0 +1,130 @@
+module Devise
+  module Models
+    # Invitable is responsible for sending invitation emails.
+    # When an invitation is sent to an email address, an account is created for it.
+    # Invitation email contains a link allowing the user to accept the invitation
+    # by setting a password (as reset password from Devise's recoverable module).
+    #
+    # Configuration:
+    #
+    #   invite_for: The period the generated invitation token is valid, after
+    #               this period, the invited resource won't be able to accept the invitation.
+    #               When invite_for is 0 (the default), the invitation won't expire.
+    #
+    # Examples:
+    #
+    #   User.find(1).invited?                               # => true/false
+    #   User.invite!(:email => 'someone@example.com')       # => send invitation
+    #   User.accept_invitation!(:invitation_token => '...') # => accept invitation with a token
+    #   User.find(1).accept_invitation!                     # => accept invitation
+    #   User.find(1).invite!                                # => reset invitation status and send invitation again
+    module Invitable
+      extend ActiveSupport::Concern
+
+      # Accept an invitation by clearing invitation token and confirming it if model
+      # is confirmable
+      def accept_invitation!
+        if self.invited? && self.valid?
+          self.invitation_token = nil
+          self.save
+        end
+      end
+
+      # Verifies whether a user has been invited or not
+      def invited?
+        persisted? && invitation_token.present?
+      end
+
+      # Reset invitation token and send invitation again
+      def invite!
+        if new_record? || invited?
+          self.skip_confirmation! if self.new_record? && self.respond_to?(:skip_confirmation!)
+          generate_invitation_token if self.invitation_token.nil?
+          self.invitation_sent_at = Time.now.utc
+          save(:validate => false)
+          ::Devise.mailer.invitation_instructions(self).deliver
+        end
+      end
+
+      # Verify whether a invitation is active or not. If the user has been
+      # invited, we need to calculate if the invitation time has not expired
+      # for this user, in other words, if the invitation is still valid.
+      def valid_invitation?
+        invited? && invitation_period_valid?
+      end
+
+      protected
+
+        # Checks if the invitation for the user is within the limit time.
+        # We do this by calculating if the difference between today and the
+        # invitation sent date does not exceed the invite for time configured.
+        # Invite_for is a model configuration, must always be an integer value.
+        #
+        # Example:
+        #
+        #   # invite_for = 1.day and invitation_sent_at = today
+        #   invitation_period_valid?   # returns true
+        #
+        #   # invite_for = 5.days and invitation_sent_at = 4.days.ago
+        #   invitation_period_valid?   # returns true
+        #
+        #   # invite_for = 5.days and invitation_sent_at = 5.days.ago
+        #   invitation_period_valid?   # returns false
+        #
+        #   # invite_for = nil
+        #   invitation_period_valid?   # will always return true
+        #
+        def invitation_period_valid?
+          invitation_sent_at && (self.class.invite_for.to_i.zero? || invitation_sent_at.utc >= self.class.invite_for.ago)
+        end
+
+        # Generates a new random token for invitation, and stores the time
+        # this token is being generated
+        def generate_invitation_token
+          self.invitation_token   = self.class.invitation_token
+        end
+
+      module ClassMethods
+        # Attempt to find a user by it's email. If a record is not found, create a new
+        # user and send invitation to it. If user is found, returns the user with an
+        # email already exists error.
+        # Attributes must contain the user email, other attributes will be set in the record
+        def invite!(attributes={})
+          invitable = find_or_initialize_with_error_by(:email, attributes.delete(:email))
+          invitable.attributes = attributes
+
+          if invitable.new_record?
+            invitable.errors.clear if invitable.email.try(:match, Devise.email_regexp)
+          else
+            invitable.errors.add(:email, :taken) unless invitable.invited?
+          end
+
+          invitable.invite! if invitable.errors.empty?
+          invitable
+        end
+
+        # Attempt to find a user by it's invitation_token to set it's password.
+        # If a user is found, reset it's password and automatically try saving
+        # the record. If not user is found, returns a new user containing an
+        # error in invitation_token attribute.
+        # Attributes must contain invitation_token, password and confirmation
+        def accept_invitation!(attributes={})
+          invitable = find_or_initialize_with_error_by(:invitation_token, attributes.delete(:invitation_token))
+          invitable.errors.add(:invitation_token, :invalid) if invitable.invitation_token && invitable.persisted? && !invitable.valid_invitation?
+          if invitable.errors.empty?
+            invitable.attributes = attributes
+            invitable.accept_invitation!
+          end
+          invitable
+        end
+
+        # Generate a token checking if one does not already exist in the database.
+        def invitation_token
+          generate_token(:invitation_token)
+        end
+
+        Devise::Models.config(self, :invite_for)
+      end
+    end
+  end
+end

data/lib/devise_invitable/rails.rb

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

data/lib/devise_invitable/routes.rb

@@ -0,0 +1,13 @@
+module ActionDispatch::Routing
+  class Mapper
+    
+  protected
+    def devise_invitation(mapping, controllers)
+      resource :invitation, :only => [:new, :create, :update],
+        :path => mapping.path_names[:invitation], :controller => controllers[:invitations] do
+        get :edit, :path => mapping.path_names[:accept], :as => :accept
+      end
+    end
+    
+  end
+end

data/lib/devise_invitable/schema.rb

@@ -0,0 +1,33 @@
+module DeviseInvitable
+  module Schema
+    # Add invitation_token and invitation_sent_at columns in the resource's database table.
+    #
+    # Examples
+    #
+    #   # For a new resource migration:
+    #   create_table :the_resources do
+    #     t.database_authenticatable :null => false # you need at least this
+    #     t.invitable
+    #     ...
+    #   end
+    #   add_index :the_resources, :invitation_token # for invitable
+    #
+    #   # or if the resource's table already exists, define a migration and put this in:
+    #   change_table :the_resources do |t|
+    #     t.string   :invitation_token, :limit => 60
+    #     t.datetime :invitation_sent_at
+    #     t.index    :invitation_token # for invitable
+    #   end
+    #
+    #   # And allow encrypted_password to be null:
+    #   change_column :the_resources, :encrypted_password, :string, :null => true
+    #   # the following line is only if you use Devise's encryptable module!
+    #   change_column :the_resources, :password_salt,      :string, :null => true
+    def invitable
+      apply_devise_schema :invitation_token,   String, :limit => 60
+      apply_devise_schema :invitation_sent_at, DateTime
+    end
+  end
+end
+
+Devise::Schema.send :include, DeviseInvitable::Schema