lperichon-devise_invitable 0.3.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,92 @@
+= devise_invitable
+
+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
+
+  # Allow null encrypted_password and password_salt
+  change_column :your_table, :encrypted_password, :string, :null => true
+  change_column :your_table, :password_salt, :string, :null => true
+
+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
+ 
+* 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 = "lperichon-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', '~> 1.1.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/VERSION

@@ -0,0 +1 @@
+0.3.0

data/app/controllers/devise/invitations_controller.rb

@@ -0,0 +1,52 @@
+class Devise::InvitationsController < ApplicationController
+  include Devise::Controllers::InternalHelpers
+  include Devise::Controllers::Helpers
+
+  before_filter :authenticate_resource!, :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.send_invitation(params[resource_name])
+
+    if resource.errors.empty?
+      set_flash_message :notice, :send_instructions
+      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 :notice, :updated
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :edit
+    end
+  end
+  
+protected
+  
+  def authenticate_resource!
+    send :"authenticate_#{resource_name}!"
+  end
+  
+end

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

@@ -0,0 +1,14 @@
+<h2>Set your password</h2>
+
+<% form_for resource, :as => resource_name, :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/devise/invitations/new.html.erb

@@ -0,0 +1,12 @@
+<h2>Send invitation</h2>
+
+<% form_for resource, :as => resource_name, :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 %>
+
+<%= link_to "Home", after_sign_in_path_for(resource_name) %><br />

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/devise_invitable.gemspec

@@ -0,0 +1,123 @@
+# 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.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergio Cambra"]
+  s.date = %q{2010-05-17}
+  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/devise/invitations_controller.rb",
+     "app/views/devise/mailer/invitation.html.erb",
+     "app/views/devise/invitations/edit.html.erb",
+     "app/views/devise/invitations/new.html.erb",
+     "devise_invitable.gemspec",
+     "init.rb",
+     "lib/devise_invitable.rb",
+     "lib/devise_invitable/controllers/helpers.rb",
+     "lib/devise_invitable/controllers/url_helpers.rb",
+     "lib/devise_invitable/locales/en.yml",
+     "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",
+     "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/devise.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.6}
+  s.summary = %q{An invitation strategy for devise}
+  s.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/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/new_rails_defaults.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/initializers/devise.rb",
+     "test/rails_app/config/routes.rb",
+     "test/rails_app/vendor/plugins/devise_invitable/init.rb",
+     "test/routes_test.rb",
+     "test/test_helper.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>, ["~> 1.1.0"])
+    else
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<webrat>, [">= 0"])
+      s.add_dependency(%q<devise>, ["~> 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<webrat>, [">= 0"])
+    s.add_dependency(%q<devise>, ["~> 1.1.0"])
+  end
+end
+

data/init.rb

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

data/lib/devise_invitable.rb

@@ -0,0 +1,21 @@
+unless defined?(Devise)
+  require 'devise'
+end
+
+Devise.module_eval do
+  # Time interval where the invitation token is valid.
+  mattr_accessor :invite_for
+  @@invite_for = 0
+end
+
+Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation
+
+module DeviseInvitable; end
+
+# Had to comment those two lines out and add them to the application initialized
+
+require 'devise_invitable/mailer'
+require 'devise_invitable/routes'
+require 'devise_invitable/schema'
+require 'devise_invitable/controllers/url_helpers'
+require 'devise_invitable/rails'

data/lib/devise_invitable/controllers/helpers.rb

@@ -0,0 +1,6 @@
+module Devise::Controllers::Helpers
+  protected
+  def authenticate_resource!
+    send :"authenticate_#{resource_name}!"
+  end
+end