devise_invitable 0.3.1 → 0.3.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devise_invitable (0.3.0)
+    devise_invitable (0.3.1)
       devise (~> 1.1.0)
 
 GEM

data/README.rdoc

@@ -2,21 +2,18 @@
 
 It adds support to devise[http://github.com/plataformatec/devise] for send invitations by email (it requires to be authenticated) and accept the invitation setting the password.
 
-== Installation
-
-All gems are on gemcutter, so you need to add gemcutter to your sources if you haven’t yet:
+DeviseInvitable currently only support rails 3, if you want to use it with rails 2.3 you must install version 0.2.3
 
-  sudo gem sources -a http://gemcutter.org/
+== Installation
 
 Install devise_invitable gem, it should install dependencies (such as devise and warden):
 
   sudo gem install devise_invitable
 
-Configure devise_invitable inside your app (and warden and devise if you weren't using them):
+Configure devise_invitable inside your app (and devise if you weren't using them):
 
-  config.gem 'warden'
-  config.gem 'devise'
-  config.gem 'devise_invitable'
+  gem 'devise'
+  gem 'devise_invitable'
 
 == Basic Usage
 
@@ -48,6 +45,12 @@ If you are using devise :all, you can add :invitable to config.all in devise ini
 
 DeviseInvitable adds a new configuration option, :invite_for. It's the time a invitation is valid for. Default value is nil, which means invitation doesn't expire.
 
+== Configuring views
+
+All of the views are packaged inside the gem. If you'd like to customize the views, invoke the the following generator and it will copy all views to your application:
+
+  # rails generate devise_invitable:views
+
 == Controller filters
 
 It adds authenticate_resource! filter to restrict who can send invitations. You can override this method in your ApplicationController. Default behavior is require authentication of the same resource_name, so if you only have a model with devise it will allow to all authenticated users to send invitations.
@@ -56,19 +59,19 @@ You have to configure mailer as it's required for confirmable and recoverable.
 
 == I18n
 
-It uses two flash messages, :send_invitation and :updated, which are translated as other flash messages from devise.
+It uses two flash messages, :send_instructions and :updated, which are translated as other flash messages from devise.
 
 == Sending an invitation
 
-To send an invitation to a user use send_invitation class model. You must set email in the attributes hash:
+To invite a user use invite class model. You must set email in the attributes hash:
 
-  User.send_invitation(:email => 'new_user@example.com')
+  User.invite!(:email => 'new_user@example.com')
 
-To accept an invitation with a token use accept_invitation! class model. You must set invitiation_token attribute, and you can include other attriutes in the hash, which will be updated in the record.
+To accept an invitation with a token use accept_invitation! class model. You must set invitiation_token attribute, and you can include other attributes in the hash, which will be updated in the record.
 
   User.accept_invitation!(:invitation_token => params[:invitation_token])
 
-Invitations controller implement this. You can go to /users/invitation/new to send an invitation and an email will be sent with a link to accept in invitiation with a URL like /users/invitation/accept?invitation_token=...
+Invitations controller implement this. You can go to /users/invitation/new to send an invitation and an email will be sent with a link to accept the invitation with a URL like /users/invitation/accept?invitation_token=...
 
 == Adding Invitable to a running application
 
@@ -88,6 +91,14 @@ Add :invitable to the devise line of your model, or to config.all in devise init
 
 Override authenticate_resource! filter if you need to customize who can send invitations as it's explained in controller filters section.
 
+== Contributors
+
+Check them all at:
+
+http://github.com/scambra/devise_invitable/contributors
+
+Special thanks to http://github.com/rymai:"rymai" for rails3 support, his fork was a great help.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/app/controllers/devise/invitations_controller.rb

@@ -13,11 +13,11 @@ class Devise::InvitationsController < ApplicationController
 
   # POST /resource/invitation
   def create
-    self.resource = resource_class.send_invitation(params[resource_name])
+    self.resource = resource_class.invite!(params[resource_name])
 
     if resource.errors.empty?
       set_flash_message :notice, :send_instructions
-      redirect_to after_sign_in_path_for(resource_name)
+      redirect_to after_update_path_for(resource_name)
     else
       render_with_scope :new
     end

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

@@ -1,8 +1,8 @@
-Hello <%= @resource.email %>!
+<p>Hello <%= @resource.email %>!</p>
 
-Someone has invited you to <%= root_url %>, you can accept it through the link below.
+<p>Someone has invited you to <%= root_url %>, you can accept it through the link below.</p>
 
-<%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @resource.invitation_token) %>
+<p><%= link_to 'Accept invitation', accept_invitation_url(@resource, :invitation_token => @resource.invitation_token) %></p>
 
-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.
+<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/devise_invitable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise_invitable}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergio Cambra"]
-  s.date = %q{2010-09-13}
+  s.date = %q{2010-09-15}
   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 = [
@@ -31,7 +31,6 @@ Gem::Specification.new do |s|
      "app/views/devise/mailer/invitation.html.erb",
      "config/locales/en.yml",
      "devise_invitable.gemspec",
-     "init.rb",
      "lib/devise_invitable.rb",
      "lib/devise_invitable/controllers/helpers.rb",
      "lib/devise_invitable/controllers/url_helpers.rb",
@@ -40,6 +39,7 @@ Gem::Specification.new do |s|
      "lib/devise_invitable/rails.rb",
      "lib/devise_invitable/routes.rb",
      "lib/devise_invitable/schema.rb",
+     "lib/generators/devise_invitable/views_generator.rb",
      "test/integration/invitable_test.rb",
      "test/integration_tests_helper.rb",
      "test/mailers/invitation_test.rb",

data/lib/devise_invitable/model.rb

@@ -13,29 +13,25 @@ module Devise
     # Examples:
     #
     #   User.find(1).invited?             # true/false
-    #   User.send_invitation(:email => 'someone@example.com') # send invitation
+    #   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).resend_invitation!   # reset invitation status and send invitation again
+    #   User.find(1).invite!   # reset invitation status and send invitation again
     module Invitable
-      def self.included(base)
-        base.class_eval do
-          extend ClassMethods
-        end
-      end
+      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(:validate => false)
+          self.save
         end
       end
 
       # Verifies whether a user has been invited or not
       def invited?
-        !new_record? && !invitation_token.nil?
+        persisted? && invitation_token.present?
       end
 
       # Send invitation by email
@@ -44,7 +40,7 @@ module Devise
       end
 
       # Reset invitation token and send invitation again
-      def resend_invitation!
+      def invite!
         if new_record? || invited?
           self.skip_confirmation! if self.new_record? and self.respond_to? :skip_confirmation!
           generate_invitation_token
@@ -53,6 +49,11 @@ module Devise
         end
       end
 
+      def resend_invitation!
+        ActiveSupport::Deprecation.warn('resend_invitation! has been renamed to invite!')
+        self.invite!
+      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.
@@ -96,21 +97,26 @@ module Devise
         # 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])
+        # 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.add(:email, :blank) if invitable.email.blank?
-            invitable.errors.add(:email, :invalid) unless invitable.email.match Devise.email_regexp
+            invitable.errors.clear if invitable.email.match Devise.email_regexp
           else
             invitable.errors.add(:email, :taken) unless invitable.invited?
           end
 
-          invitable.resend_invitation! if invitable.errors.empty?
+          invitable.invite! if invitable.errors.empty?
           invitable
         end
 
+        def send_invitation(attributes = {})
+          ActiveSupport::Deprecation.warn('send_invitation has been renamed to invite!')
+          self.invite!(attributes)
+        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
@@ -121,7 +127,7 @@ module Devise
           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! if invitable.valid?
+            invitable.accept_invitation!
           end
           invitable
         end

data/lib/devise_invitable/rails.rb

@@ -1,10 +1,8 @@
 module DeviseInvitable
   class Engine < ::Rails::Engine
     
-    initializer "devise_invitable.add_url_helpers" do |app|
-      ActionController::Base.send :include, DeviseInvitable::Controllers::UrlHelpers
-      ActionView::Base.send :include, DeviseInvitable::Controllers::UrlHelpers
-    end
+    ActiveSupport.on_load(:action_controller) { include DeviseInvitable::Controllers::UrlHelpers }
+    ActiveSupport.on_load(:action_view) { include DeviseInvitable::Controllers::UrlHelpers }
     
     config.after_initialize do
       Devise::Mailer.send :include, DeviseInvitable::Mailer

data/lib/generators/devise_invitable/views_generator.rb

@@ -0,0 +1,10 @@
+require 'generators/devise/views_generator'
+
+module DeviseInvitable
+  module Generators
+    class ViewsGenerator < Devise::Generators::ViewsGenerator
+      source_root File.expand_path('../../../../app/views', __FILE__)
+      desc 'Copies all DeviseInvitable views to your application.'
+    end
+  end
+end

data/test/models/invitable_test.rb

@@ -15,13 +15,13 @@ class InvitableTest < ActiveSupport::TestCase
     user = new_user
     3.times do
       token = user.invitation_token
-      user.resend_invitation!
+      user.invite!
       assert_not_equal token, user.invitation_token
     end
   end
 
   test 'should test invitation sent at with invite_for configuration value' do
-    user = create_user_with_invitation('')
+    user = create_user_with_invitation('token')
     
     User.stubs(:invite_for).returns(nil)
     user.invitation_sent_at = Time.now.utc
@@ -52,7 +52,7 @@ class InvitableTest < ActiveSupport::TestCase
     invitation_tokens = []
     3.times do
       user = new_user
-      user.resend_invitation!
+      user.invite!
       token = user.invitation_token
       assert !invitation_tokens.include?(token)
       invitation_tokens << token
@@ -96,40 +96,56 @@ class InvitableTest < ActiveSupport::TestCase
     user = new_user
     assert_difference('ActionMailer::Base.deliveries.size') do
       token = user.invitation_token
-      user.resend_invitation!
+      user.invite!
       assert_not_equal token, user.invitation_token
     end
   end
 
   test 'should return a record with invitation token and no errors to send invitation by email' do
-    invited_user = User.send_invitation(:email => "valid@email.com")
+    invited_user = User.invite!(:email => "valid@email.com")
     assert invited_user.errors.blank?
     assert_present invited_user.invitation_token
+    assert_equal 'valid@email.com', invited_user.email
+    assert invited_user.persisted?
+  end
+
+  test 'should set all attributes with no errors' do
+    invited_user = User.invite!(:email => "valid@email.com", :username => 'first name')
+    assert invited_user.errors.blank?
+    assert_equal 'first name', invited_user.username
+    assert invited_user.persisted?
   end
 
   test 'should return a record with errors if user was found by e-mail' do
     user = create_user_with_invitation('')
     user.update_attribute(:invitation_token, nil)
-    invited_user = User.send_invitation(:email => user.email)
+    invited_user = User.invite!(:email => user.email)
     assert_equal invited_user, user
     assert_equal ['has already been taken'], invited_user.errors[:email]
   end
 
   test 'should return a new record with errors if e-mail is blank' do
-    invited_user = User.send_invitation(:email => '')
+    invited_user = User.invite!(:email => '')
     assert invited_user.new_record?
-    assert_equal ["can't be blank", "is invalid"], invited_user.errors[:email]
+    assert_equal ["can't be blank"], invited_user.errors[:email]
   end
 
   test 'should return a new record with errors if e-mail is invalid' do
-    invited_user = User.send_invitation(:email => 'invalid_email')
+    invited_user = User.invite!(:email => 'invalid_email')
     assert invited_user.new_record?
     assert_equal ["is invalid"], invited_user.errors[:email]
   end
 
+  test 'should set all attributes with errors if e-mail is invalid' do
+    invited_user = User.invite!(:email => "invalid_email.com", :username => 'first name')
+    assert invited_user.new_record?
+    assert_equal 'first name', invited_user.username
+    assert invited_user.errors.present?
+  end
+
   test 'should find a user to set his password based on invitation_token' do
     user = new_user
-    user.resend_invitation!
+    user.invite!
 
     invited_user = User.accept_invitation!(:invitation_token => user.invitation_token)
     assert_equal invited_user, user
@@ -158,7 +174,7 @@ class InvitableTest < ActiveSupport::TestCase
 
   test 'should set successfully user password given the new password and confirmation' do
     user = new_user(:password => nil, :password_confirmation => nil)
-    user.resend_invitation!
+    user.invite!
 
     invited_user = User.accept_invitation!(
       :invitation_token => user.invitation_token,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 00:00:00 +02:00
+date: 2010-09-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -120,7 +120,6 @@ files:
 - app/views/devise/mailer/invitation.html.erb
 - config/locales/en.yml
 - devise_invitable.gemspec
-- init.rb
 - lib/devise_invitable.rb
 - lib/devise_invitable/controllers/helpers.rb
 - lib/devise_invitable/controllers/url_helpers.rb
@@ -129,6 +128,7 @@ files:
 - lib/devise_invitable/rails.rb
 - lib/devise_invitable/routes.rb
 - lib/devise_invitable/schema.rb
+- lib/generators/devise_invitable/views_generator.rb
 - test/integration/invitable_test.rb
 - test/integration_tests_helper.rb
 - test/mailers/invitation_test.rb

data/init.rb

@@ -1 +0,0 @@
-require 'devise_invitable'