devise_invitable 0.3.5 → 0.3.6

data/app/controllers/devise/invitations_controller.rb~

@@ -0,0 +1,48 @@
+class Devise::InvitationsController < ApplicationController
+  include Devise::Controllers::InternalHelpers
+
+  before_filter :authenticate_inviter!, :only => [:new, :create]
+  before_filter :require_no_authentication, :only => [:edit, :update]
+  helper_method :after_sign_in_path_for
+
+  # GET /resource/invitation/new
+  def new
+    build_resource
+    render_with_scope :new
+  end
+
+  # POST /resource/invitation
+  def create
+    self.resource = resource_class.invite!(params[resource_name])
+
+    if resource.errors.empty?
+      puts params.inspect
+      set_flash_message :notice, :send_instructions, :email => self.resource.email
+      redirect_to after_sign_in_path_for(resource_name)
+    else
+      render_with_scope :new
+    end
+  end
+
+  # GET /resource/invitation/accept?invitation_token=abcdef
+  def edit
+    if params[:invitation_token] && self.resource = resource_class.first(:conditions => { :invitation_token => params[:invitation_token] })
+      render_with_scope :edit
+    else
+      set_flash_message(:alert, :invitation_token_invalid)
+      redirect_to after_sign_out_path_for(resource_name)
+    end
+  end
+
+  # PUT /resource/invitation
+  def update
+    self.resource = resource_class.accept_invitation!(params[resource_name])
+
+    if resource.errors.empty?
+      set_flash_message :notice, :updated
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :edit
+    end
+  end
+end

data/config/locales/en.yml

@@ -4,5 +4,5 @@ en:
       send_instructions: 'An email with instructions about how to set the password has been sent.'
       updated: 'Your password was set successfully. You are now signed in.'
     mailer:
-      invitiation:
+      invitation:
         subject: 'Invitation'

data/lib/devise_invitable/model.rb

@@ -61,6 +61,11 @@ module Devise
         invited? && invitation_period_valid?
       end
 
+      # Only verify password when is not invited
+      def valid_password?(password)
+        super unless invited?
+      end
+
       protected
 
         # Checks if the invitation for the user is within the limit time.

data/lib/devise_invitable/model.rb~

@@ -0,0 +1,129 @@
+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.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.invitation_token = nil
+          self.save
+        end
+      end
+
+      # Verifies whether a user has been invited or not
+      def invited?
+        persisted? && invitation_token.present?
+      end
+
+      # Send invitation by email
+      def send_invitation
+        ::Devise.mailer.invitation(self).deliver
+      end
+
+      # Reset invitation token and send invitation again
+      def invite!
+        if new_record? || invited?
+          self.skip_confirmation! if self.new_record? and self.respond_to? :skip_confirmation!
+          generate_invitation_token
+          save(:validate=>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.
+        # 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 attributes[:invitation_token] && !invitable.new_record? && !invitable.valid_invitation?
+          if invitable.errors.empty?
+            invitable.attributes = attributes
+            invitable.accept_invitation!
+          end
+          invitable
+        end
+
+        Devise::Models.config(self, :invite_for)
+      end
+    end
+  end
+end

data/lib/devise_invitable/version.rb

@@ -0,0 +1,3 @@
+module DeviseInvitable
+  VERSION = '0.3.6'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 31
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 +01:00
+date: 2011-02-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,85 +96,47 @@ dependencies:
         version: 1.1.0
   type: :runtime
   version_requirements: *id005
-description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation setting the password
-email: sergio@entrecables.com
+description: It adds support for send invitations by email (it requires to be authenticated) and accept the invitation by setting a password.
+email: 
+- sergio@entrecables.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- 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
+- app/controllers/devise/invitations_controller.rb~
+- app/controllers/devise/invitations_controller.rb
 - 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/generators/active_record/devise_invitable_generator.rb
-- lib/generators/active_record/templates/migration.rb
+- lib/devise_invitable/mailer.rb
+- lib/devise_invitable/routes.rb
+- lib/devise_invitable/version.rb
+- lib/devise_invitable/model.rb
+- lib/devise_invitable/model.rb~
+- lib/devise_invitable/controllers/helpers.rb
+- lib/devise_invitable/controllers/url_helpers.rb
+- lib/devise_invitable.rb
+- lib/generators/devise_invitable/views_generator.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/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/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
+- lib/generators/active_record/devise_invitable_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- LICENSE
+- README.rdoc
 has_rdoc: true
-homepage: http://github.com/scambra/devise_invitable
+homepage: https://github.com/scambra/devise_invitable
 licenses: []
 
 post_install_message: 
 rdoc_options: 
+- --main
+- README.rdoc
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -183,53 +145,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 59
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: An invitation strategy for devise
-test_files: 
-- 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/models/octopussy.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/inflections.rb
-- test/rails_app/config/initializers/devise.rb
-- test/rails_app/config/initializers/session_store.rb
-- test/rails_app/config/initializers/mime_types.rb
-- test/rails_app/config/initializers/secret_token.rb
-- test/rails_app/config/routes.rb
-- test/rails_app/config/application.rb
-- test/routes_test.rb
-- test/test_helper.rb
-- test/generators_test.rb
+summary: An invitation strategy for Devise
+test_files: []
+

data/.document

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

data/.gitignore

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

data/Gemfile

@@ -1,3 +0,0 @@
-source :rubygems
-
-gemspec

data/Gemfile.lock

@@ -1,117 +0,0 @@
-PATH
-  remote: .
-  specs:
-    devise_invitable (0.3.2)
-      devise (~> 1.1.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.1)
-      actionpack (= 3.0.1)
-      mail (~> 2.2.5)
-    actionpack (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4.1)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.12)
-      rack-test (~> 0.5.4)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.1)
-      activesupport (= 3.0.1)
-      builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-      arel (~> 1.0.0)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-    activesupport (3.0.1)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
-    bcrypt-ruby (2.1.2)
-    builder (2.1.2)
-    capybara (0.4.0)
-      celerity (>= 0.7.9)
-      culerity (>= 0.2.4)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (>= 0.0.27)
-      xpath (~> 0.1.2)
-    celerity (0.8.2)
-    childprocess (0.1.3)
-      ffi (~> 0.6.3)
-    culerity (0.2.12)
-    devise (1.1.3)
-      bcrypt-ruby (~> 2.1.2)
-      warden (~> 0.10.7)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    ffi (0.6.3)
-      rake (>= 0.8.7)
-    i18n (0.4.2)
-    json_pure (1.4.6)
-    mail (2.2.9)
-      activesupport (>= 2.3.6)
-      i18n (~> 0.4.1)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
-    mocha (0.9.9)
-      rake
-    nokogiri (1.4.3.1)
-    polyglot (0.3.1)
-    rack (1.2.1)
-    rack-mount (0.6.13)
-      rack (>= 1.0.0)
-    rack-test (0.5.6)
-      rack (>= 1.0)
-    rails (3.0.1)
-      actionmailer (= 3.0.1)
-      actionpack (= 3.0.1)
-      activerecord (= 3.0.1)
-      activeresource (= 3.0.1)
-      activesupport (= 3.0.1)
-      bundler (~> 1.0.0)
-      railties (= 3.0.1)
-    railties (3.0.1)
-      actionpack (= 3.0.1)
-      activesupport (= 3.0.1)
-      rake (>= 0.8.4)
-      thor (~> 0.14.0)
-    rake (0.8.7)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.0.29)
-      childprocess (>= 0.0.7)
-      ffi (~> 0.6.3)
-      json_pure
-      rubyzip
-    sqlite3-ruby (1.3.2)
-    thor (0.14.3)
-    treetop (1.4.8)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.23)
-    warden (0.10.7)
-      rack (>= 1.0.0)
-    xpath (0.1.2)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  capybara (>= 0.3.9)
-  devise (~> 1.1.0)
-  devise_invitable!
-  mocha (>= 0.9.8)
-  rails (~> 3.0.0)
-  sqlite3-ruby