devise_invitable 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/rails_app/log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sergio Cambra
+
+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,18 @@
+= devise_invitable
+
+It adds support for send invitations by email (it requires to be authenticated) and accept the invitation setting the password.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Sergio Cambra. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "devise_invitable"
+    gem.summary = %Q{An invitation strategy for devise}
+    gem.description = %Q{It adds support for send invitations by email (it requires to be authenticated) and accept the invitation setting the password}
+    gem.email = "sergio@entrecables.com"
+    gem.homepage = "http://github.com/scambra/devise_invitable"
+    gem.authors = ["Sergio Cambra"]
+    gem.add_development_dependency 'mocha'
+    gem.add_development_dependency 'webrat'
+    gem.add_dependency 'devise', '>= 0.7.1'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "devise_invitable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/invitations_controller.rb

@@ -0,0 +1,48 @@
+class InvitationsController < ApplicationController
+  include Devise::Controllers::Helpers
+
+  before_filter :authenticate_resource!, :only => [:new, :create]
+  before_filter :require_no_authentication, :only => [:edit, :update]
+
+  # GET /resource/invitation/new
+  def new
+    build_resource
+    render_with_scope :new
+  end
+
+  # POST /resource/invitation
+  def create
+    self.resource = resource_class.send_invitation(params[resource_name])
+
+    if resource.errors.empty?
+      set_flash_message :success, :send_invitation
+      redirect_to after_sign_in_path_for(resource_name)
+    else
+      render_with_scope :new
+    end
+  end
+
+  # GET /resource/invitation/edit?invitation_token=abcdef
+  def edit
+    self.resource = resource_class.new
+    resource.invitation_token = params[:invitation_token]
+    render_with_scope :edit
+  end
+
+  # PUT /resource/invitation
+  def update
+    self.resource = resource_class.accept_invitation!(params[resource_name])
+
+    if resource.errors.empty?
+      set_flash_message :success, :updated
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :edit
+    end
+  end
+
+  protected
+  def authenticate_resource!
+    authenticate!(resource_name)
+  end
+end

data/app/views/devise_mailer/invitation.html.erb

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

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

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

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

@@ -0,0 +1,10 @@
+<h2>Send invitation</h2>
+
+<% form_for resource_name, resource, :url => invitation_path(resource_name) do |f| %>
+  <%= f.error_messages %>
+
+  <p><%= f.label :email %></p>
+  <p><%= f.text_field :email %></p>
+
+  <p><%= f.submit "Send an invitation" %></p>
+<% end %>

data/devise_invitable.gemspec

@@ -0,0 +1,121 @@
+# 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.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergio Cambra"]
+  s.date = %q{2009-12-10}
+  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",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/invitations_controller.rb",
+     "app/views/devise_mailer/invitation.html.erb",
+     "app/views/invitations/edit.html.erb",
+     "app/views/invitations/new.html.erb",
+     "devise_invitable.gemspec",
+     "init.rb",
+     "lib/devise/controllers/url_helpers.rb",
+     "lib/devise/models/invitable.rb",
+     "lib/devise_invitable.rb",
+     "lib/devise_invitable/locales/en.yml",
+     "lib/devise_invitable/mailer.rb",
+     "lib/devise_invitable/rails.rb",
+     "lib/devise_invitable/routes.rb",
+     "lib/devise_invitable/schema.rb",
+     "rails/init.rb",
+     "test/integration/invitable_test.rb",
+     "test/integration_tests_helper.rb",
+     "test/mailers/invitation_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/user.rb",
+     "test/rails_app/app/views/home/index.html.erb",
+     "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/inflections.rb",
+     "test/rails_app/config/initializers/new_rails_defaults.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/routes.rb",
+     "test/rails_app/vendor/plugins/devise_invitable/init.rb",
+     "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.5}
+  s.summary = %q{An invitation strategy for devise}
+  s.test_files = [
+    "test/model_tests_helper.rb",
+     "test/integration_tests_helper.rb",
+     "test/models_test.rb",
+     "test/mailers/invitation_test.rb",
+     "test/routes_test.rb",
+     "test/integration/invitable_test.rb",
+     "test/models/invitable_test.rb",
+     "test/test_helper.rb",
+     "test/rails_app/app/controllers/application_controller.rb",
+     "test/rails_app/app/controllers/admins_controller.rb",
+     "test/rails_app/app/controllers/home_controller.rb",
+     "test/rails_app/app/controllers/users_controller.rb",
+     "test/rails_app/app/models/user.rb",
+     "test/rails_app/app/helpers/application_helper.rb",
+     "test/rails_app/config/routes.rb",
+     "test/rails_app/config/initializers/backtrace_silencers.rb",
+     "test/rails_app/config/initializers/new_rails_defaults.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/initializers/inflections.rb",
+     "test/rails_app/config/environments/test.rb",
+     "test/rails_app/config/environments/development.rb",
+     "test/rails_app/config/environments/production.rb",
+     "test/rails_app/config/environment.rb",
+     "test/rails_app/config/boot.rb",
+     "test/rails_app/vendor/plugins/devise_invitable/init.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<webrat>, [">= 0"])
+      s.add_runtime_dependency(%q<devise>, [">= 0.7.1"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<webrat>, [">= 0"])
+      s.add_dependency(%q<devise>, [">= 0.7.1"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<webrat>, [">= 0"])
+    s.add_dependency(%q<devise>, [">= 0.7.1"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'rails/init'

data/lib/devise/controllers/url_helpers.rb

@@ -0,0 +1,20 @@
+Devise::Controllers::UrlHelpers.module_eval do
+  [:path, :url].each do |path_or_url|
+    [nil, :new_, :edit_].each do |action|
+      class_eval <<-URL_HELPERS
+        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

data/lib/devise/models/invitable.rb

@@ -0,0 +1,143 @@
+module Devise
+  module Models
+
+    # Invitable is responsible to send emails with invitations.
+    # When an invitation is sent to an email, an account is created for it.
+    # An invitation has a link to set the password, as reset password from recoverable.
+    #
+    # Configuration:
+    #
+    #   invite_for: the time you want the user will have to confirm the account after
+    #               is invited. When invite_for is zero, the invitation won't expire.
+    #               By default invite_for is 0.
+    #
+    # Examples:
+    #
+    #   User.find(1).invited?             # true/false
+    #   User.send_invitation(: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).reset_invitation!    # reset invitation status and send invitation again
+    module Invitable
+
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+          callbacks = []
+          callbacks.concat before_create_callback_chain.select {|c| c.method == :generate_confirmation_token}
+          callbacks.concat after_create_callback_chain.select {|c| c.method == :send_confirmation_instructions}
+          callbacks.each do |c|
+            c.options[:unless] = lambda{|r| r.class.devise_modules.include?(:invitable) && r.invitation_token}
+          end
+        end
+      end
+
+      # Accept an invitation by clearing invitation token and confirming it if model
+      # is confirmable
+      def accept_invitation!
+        if self.invited?
+          self.invitation_token = nil
+          if self.class.devise_modules.include? :confirmable
+            self.confirm!
+          else
+            save
+          end
+        end
+      end
+
+      # Verifies whether a user has been invited or not
+      def invited?
+        !new_record? && !invitation_token.nil?
+      end
+
+      # Send invitation by email
+      def send_invitation
+        ::DeviseMailer.deliver_invitation(self)
+      end
+
+      # Reset invitation token and send invitation again
+      def reset_invitation!
+        if new_record? || invited?
+          generate_invitation_token
+          save(false)
+          send_invitation
+        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 = Devise.friendly_token
+          self.invitation_sent_at = Time.now.utc
+        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.
+        # Options must contain the user email
+        def send_invitation(attributes={})
+          invitable = find_or_initialize_by_email(attributes[:email])
+          if invitable.email.blank?
+            invitable.errors.add(:email, :blank)
+          elsif invitable.new_record? || invitable.invited?
+            invitable.reset_invitation!
+          else
+            invitable.errors.add(:email, :already_exits, :default => 'already exists')
+          end
+          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[:invitation_token])
+          invitable.errors.add(:invitation_token, :invalid) if attributes[:invitation_token] && !invitable.new_record? && !invitable.valid_invitation?
+          if invitable.errors.empty?
+            invitable.password = attributes[:password]
+            invitable.password_confirmation = attributes[:password_confirmation]
+            invitable.accept_invitation! if invitable.valid?
+          end
+          invitable
+        end
+
+        Devise::Models.config(self, :invite_for)
+      end
+    end
+  end
+end