aihs_devise_invitable 0.4.rc

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+#gemspec
+gem 'mocha', '>= 0.9.8'
+gem 'capybara', '>= 0.3.9'
+gem 'rails', '~> 3.0.0'
+gem 'sqlite3-ruby'
+gem 'devise', :path => '../devise'

data/Gemfile.lock

@@ -0,0 +1,117 @@
+GIT
+  remote: git://github.com/plataformatec/devise.git
+  revision: 976d77defed17adaca81381222b5b80cdd34f8ac
+  specs:
+    devise (1.2.rc)
+      bcrypt-ruby (~> 2.1.2)
+      orm_adapter (~> 0.0.2)
+      warden (~> 1.0.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)
+    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)
+    orm_adapter (0.0.3)
+    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 (1.0.1)
+      rack (>= 1.0.0)
+    xpath (0.1.2)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.3.9)
+  devise!
+  mocha (>= 0.9.8)
+  rails (~> 3.0.0)
+  sqlite3-ruby

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,187 @@
+= DeviseInvitable
+
+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.
+
+DeviseInvitable currently only support Rails 3, if you want to use it with Rails 2.3 you must install version {0.2.3}[http://rubygems.org/gems/devise_invitable/versions/0.2.3]
+
+== Installation for Rails ~> 3.0 and Devise ~> 1.1
+
+Install DeviseInvitable gem, it will also install dependencies (such as devise and warden):
+
+  gem install devise_invitable
+
+Add DeviseInvitable to your Gemfile (and Devise if you weren't using them):
+
+  gem 'devise',           '~> 1.1.3'
+  gem 'devise_invitable', '~> 0.3.4'
+
+=== Automatic installation
+
+Run the following generator to add DeviseInvitable’s configuration option in the Devise configuration file (config/initializers/devise.rb):
+
+  rails generate devise_invitable:install
+
+When you are done, you are ready to add DeviseInvitable to any of your Devise models using the following generator:
+
+  rails generate devise_invitable MODEL
+
+Replace MODEL by the class name you want to add DeviseInvitable, like User, Admin, etc. This will add the :invitable flag to your model's Devise modules. The generator will also create a migration file (if your ORM support them). Continue reading this file to understand exactly what the generator produces and how to use it.
+
+=== Manual installation
+
+Follow the walkthrough for Devise and after it's done, follow this walkthrough.
+
+Add :invitable to the <tt>devise</tt> call in your model (we’re assuming here you already have a User model with some Devise modules):
+
+  class User < ActiveRecord::Base
+    devise :database_authenticatable, :confirmable, :invitable
+  end
+
+Add t.invitable to your Devise model migration:
+
+  create_table :users do
+    ...
+    t.invitable
+    ...
+  end
+  add_index :users, :invitation_token
+
+or for a model that already exists, define a migration to add DeviseInvitable to your model:
+
+  change_table :users do |t|
+    t.string   :invitation_token, :limit => 60
+    t.datetime :invitation_sent_at
+    t.index    :invitation_token
+  end
+
+  # Allow null encrypted_password
+  change_column_null :users, :encrypted_password, true
+  # Allow null password_salt (add it if you are using Devise's encryptable module)
+  change_column_null :users, :password_salt, true
+
+== Model configuration
+
+DeviseInvitable adds a new configuration option:
+
+* 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.
+
+You can set this configuration option in the Devise initializer as follow:
+
+  # ==> Configuration for :invitable
+  # 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.
+  # config.invite_for = 2.weeks
+
+or directly as parameters to the <tt>devise</tt> method:
+
+  devise :database_authenticatable, :confirmable, :invitable, :invite_for => 2.weeks
+
+For more details, see <tt>config/initializers/devise.rb</tt> (after you invoked the "devise_invitable:install" generator described above).
+
+== Configuring views
+
+All the views are packaged inside the gem. If you'd like to customize the views, invoke the following generator and it will copy all the views to your application:
+
+  rails generate devise_invitable:views
+
+You can also use the generator to generate scoped views:
+
+  rails generate devise_invitable:views users
+
+Please refer to {Devise's README}[http://github.com/plataformatec/devise] for more information about views.
+
+== Usage
+
+=== Send an invitation
+
+To send an invitation to a user, use the <tt>invite!</tt> class method. <tt>:email</tt> must be present in the parameters hash. You can also include other attributes in the hash. The record will not be validated.
+
+  User.invite!(:email => "new_user@example.com", :name => "John Doe")
+  # => an invitation email will be sent to new_user@example.com
+
+=== Accept an invitation
+
+To accept an invitation with a token use the <tt>accept_invitation!</tt> class method. <tt>:invitation_token</tt> must be present in the parameters hash. You can also include other attributes in the hash.
+
+  User.accept_invitation!(:invitation_token => params[:invitation_token], :password => "ad97nwj3o2", :name => "John Doe")
+
+== Integration in a Rails application
+
+Since the invitations controller take care of all the creation/acceptation of an invitation, in most cases you wouldn't call the <tt>invite!</tt> and <tt>accept_invitation!</tt> methods directly.
+Instead, in your views, put a link to <tt>new_user_invitation_path</tt> or <tt>new_invitation_path(:user)</tt> or even <tt>/users/invitation/new</tt> to prepare and send an invitation (to a user in this example).
+After an invitation is created and sent, the inviter will be redirected to after_sign_in_path_for(resource_name).
+
+The invitation email includes a link to accept the invitation that looks like this:  <tt>/users/invitation/accept?invitation_token=abcd123</tt>. When clicked, the invited must set a password in order to accept its invitation. Note that if the invitation_token is not present or not valid, the invited is redirected to after_sign_out_path_for(resource_name).
+You can also overwrite after_sign_in_path_for and after_sign_out_path_for to customize your redirect hooks. More on {Devise's README}[http://github.com/plataformatec/devise], "Controller filters and helpers" section.
+
+== Controller filter
+
+InvitationsController uses authenticate_inviter! filter to restrict who can send invitations. You can override this method in your ApplicationController.
+
+Default behavior requires authentication of the same resource as the invited one. For example, if your model User is invitable, it will allow all authenticated users to send invitations to other users.
+
+You would have a User model which is configured as invitable and an Admin model which is not. If you want to allow only admins to send invitations, simply overwrite the authenticate_inviter! method as follow:
+
+  class ApplicationController < ActionController::Base
+  protected
+    def authenticate_inviter!
+      authenticate_admin!
+    end
+  end
+
+== I18n
+
+DeviseInvitable uses flash messages with I18n with the flash keys <tt>:send_instructions</tt>, <tt>:invitation_token_invalid</tt> and <tt>:updated</tt>. To customize your app, you can modify the generated locale file:
+
+  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.'
+
+You can also create distinct messages based on the resource you've configured using the singular name given in routes:
+
+  en:
+    devise:
+      invitations:
+        user:
+          send_instructions: 'A new user invitation has been sent to %{email}.'
+          invitation_token_invalid: 'Your invitation token is not valid!'
+          updated: 'Welcome on board! You are now signed in.'
+
+The DeviseInvitable mailer uses the same pattern as Devise to create mail subject messages:
+
+  en:
+    devise:
+      mailer:
+        invitation_instructions:
+          subject: 'You got an invitation!'
+          user_subject: 'You got a user invitation!'
+
+Take a look at the generated locale file (in <tt>config/locales/devise_invitable.en.yml</tt>) to check all available messages.
+
+== Other ORMs
+
+DeviseInvitable supports ActiveRecord and Mongoid, like Devise.
+
+== Contributors
+
+Check them all at:
+
+http://github.com/scambra/devise_invitable/contributors
+
+Special thanks to rymai[http://github.com/rymai] for the Rails 3 support, his fork was a great help.
+
+== 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,57 @@
+require 'rake'
+require File.join(File.dirname(__FILE__), 'lib', 'devise_invitable', 'version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "aihs_devise_invitable"
+    gem.version = DeviseInvitable::VERSION.dup
+    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', '>= 0.9.8'
+    gem.add_development_dependency 'capybara', '>= 0.3.9'
+    gem.add_development_dependency 'rails', '~> 3.0.0'
+    gem.add_development_dependency 'sqlite3-ruby'
+    #gem.add_dependency 'devise', '~> 1.2.0'
+  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/app/controllers/devise/invitations_controller.rb

@@ -0,0 +1,47 @@
+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?
+      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