devise_invitable 0.1.2 → 0.1.3

data/README.rdoc

@@ -1,6 +1,76 @@
 = devise_invitable
 
-It adds support for send invitations by email (it requires to be authenticated) and accept the invitation setting the password.
+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:
+
+  sudo gem sources -a http://gemcutter.org/
+
+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):
+
+  config.gem 'warden'
+  config.gem 'devise'
+  config.gem 'devise_invitable'
+
+== Basic Usage
+
+Follow the walkthrough for devise with the following modifications.
+
+Add t.invitable to the migration:
+
+  create_table :users do
+    ...
+    t.invitable
+    ...
+  end
+  add_index :users, :invitation_token # for invitable
+
+Add :invitable to the devise line in your model:
+
+  class User < ActiveRecord::Base
+    devise ..., :invitable
+  end
+
+If you are using devise :all, you can add :invitable to config.all in devise initializer:
+  Devise.setup do |config|
+    ...
+    config.all = [..., :invitable]
+    ...
+  end
+
+== Model configuration
+
+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.
+
+== 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.
+
+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.
+
+== Adding Invitable to a running application
+
+Define a migration to add invitable to your model:
+
+  change_table :your_table do |t|
+    t.string :invitation_token, :limit => 20
+    t.datetime :invitation_sent_at
+    t.index :invitation_token
+  end
+
+Add :invitable to the devise line of your model, or to config.all in devise initializer if your model uses devise :all.
+
+Override authenticate_resource! filter if you need to customize who can send invitations.
 
 == Note on Patches/Pull Requests
  
@@ -10,7 +80,7 @@ It adds support for send invitations by email (it requires to be authenticated)
   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)
+  bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/app/controllers/invitations_controller.rb

@@ -23,7 +23,7 @@ class InvitationsController < ApplicationController
     end
   end
 
-  # GET /resource/invitation/edit?invitation_token=abcdef
+  # GET /resource/invitation/accept?invitation_token=abcdef
   def edit
     self.resource = resource_class.new
     resource.invitation_token = params[:invitation_token]

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

@@ -2,7 +2,7 @@ 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) %>
+<%= link_to 'Accept invitation', accept_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/devise_invitable.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise_invitable}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergio Cambra"]

data/lib/devise/controllers/url_helpers.rb

@@ -1,6 +1,6 @@
 Devise::Controllers::UrlHelpers.module_eval do
   [:path, :url].each do |path_or_url|
-    [nil, :new_, :edit_].each do |action|
+    [nil, :new_, :accept_].each do |action|
       class_eval <<-URL_HELPERS
         def #{action}invitation_#{path_or_url}(resource, *args)
           resource = case resource
@@ -17,4 +17,4 @@ Devise::Controllers::UrlHelpers.module_eval do
       URL_HELPERS
     end
   end
-end
+end

data/lib/devise_invitable/routes.rb

@@ -12,15 +12,16 @@ module DeviseInvitable
     # needed routes:
     #
     #  # Invitation routes for Invitable, if User model has :invitable configured
-    #    new_user_invitation GET  /users/invitation/new(.:format)   {:controller=>"invitations", :action=>"new"}
-    #   edit_user_invitation GET  /users/invitation/edit(.:format)  {:controller=>"invitations", :action=>"edit"}
-    #        user_invitation PUT  /users/invitation(.:format)       {:controller=>"invitations", :action=>"update"}
-    #                        POST /users/invitation(.:format)       {:controller=>"invitations", :action=>"create"}
+    #     new_user_invitation GET  /users/invitation/new(.:format)     {:controller=>"invitations", :action=>"new"}
+    #         user_invitation PUT  /users/invitation(.:format)         {:controller=>"invitations", :action=>"update"}
+    #                         POST /users/invitation(.:format)         {:controller=>"invitations", :action=>"create"}
+    #  accept_user_invitation GET  /users/invitation/accept(.:format)  {:controller=>"invitations", :action=>"edit"}
     #
 
     protected
       def invitable(routes, mapping)
-        routes.resource :invitation, :only => [:new, :create, :edit, :update], :as => mapping.path_names[:invitation]
+        routes.resource :invitation, :only => [:new, :create, :update], :as => mapping.path_names[:invitation]
+        routes.send(:"accept_#{mapping.name}_invitation", mapping.path_names[:accept] || 'accept', :controller => 'invitations', :action => 'edit', :name_prefix => nil, :path_prefix => "#{mapping.as}/invitation", :conditions => { :method => :get })
       end
   end
 end

data/test/integration/invitable_test.rb

@@ -17,7 +17,7 @@ class InvitationTest < ActionController::IntegrationTest
 
   def set_password(options={}, &block)
     unless options[:visit] == false
-      visit edit_user_invitation_path(:invitation_token => options[:invitation_token])
+      visit accept_user_invitation_path(:invitation_token => options[:invitation_token])
     end
     assert_response :success
     assert_template 'invitations/edit'
@@ -59,7 +59,7 @@ class InvitationTest < ActionController::IntegrationTest
   test 'authenticated user should not be able to visit edit invitation page' do
     sign_in_as_user
 
-    get edit_user_invitation_path
+    get accept_user_invitation_path
 
     assert_response :redirect
     assert_redirected_to root_path

data/test/mailers/invitation_test.rb

@@ -56,7 +56,7 @@ class InviationTest < ActionMailer::TestCase
 
   test 'body should have link to confirm the account' do
     host = ActionMailer::Base.default_url_options[:host]
-    invitation_url_regexp = %r{<a href=\"http://#{host}/users/invitation/edit\?invitation_token=#{user.invitation_token}">}
+    invitation_url_regexp = %r{<a href=\"http://#{host}/users/invitation/accept\?invitation_token=#{user.invitation_token}">}
     assert_match invitation_url_regexp, mail.body
   end
 end

data/test/routes_test.rb

@@ -10,8 +10,8 @@ class MapRoutingTest < ActionController::TestCase
     assert_recognizes({:controller => 'invitations', :action => 'create'}, {:path => 'users/invitation', :method => :post})
   end
 
-  test 'map edit user invitation' do
-    assert_recognizes({:controller => 'invitations', :action => 'edit'}, 'users/invitation/edit')
+  test 'map accept user invitation' do
+    assert_recognizes({:controller => 'invitations', :action => 'edit'}, 'users/invitation/accept')
   end
 
   test 'map update user invitation' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Sergio Cambra