devise_invitable 0.3.0 → 0.4.0

data/lib/devise_invitable/routes.rb

@@ -1,29 +1,13 @@
-module DeviseInvitable
-  module Routes #:doc:
-    # Adds route generation for invitable. This method is responsible to
-    # generate all needed routes for devise, based on what modules you have
-    # defined in your model.
-    # Examples: Let's say you have an User model configured to use
-    # invitable module. After creating this inside your routes:
-    #
-    #   map.devise_for :users
-    #
-    # this method is going to look inside your User model and create the
-    # needed routes:
-    #
-    #  # Invitation routes for Invitable, if User model has :invitable configured
-    #     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, :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 })
+module ActionDispatch::Routing
+  class Mapper
+    
+  protected
+    def devise_invitation(mapping, controllers)
+      resource :invitation, :only => [:new, :create, :update],
+        :path => mapping.path_names[:invitation], :controller => controllers[:invitations] do
+        get :edit, :path => mapping.path_names[:accept], :as => :accept
       end
+    end
+    
   end
 end
-
-ActionDispatch::Routing::Mapper.send :include, DeviseInvitable::Routes

data/lib/devise_invitable/schema.rb

@@ -1,9 +1,34 @@
 module DeviseInvitable
   module Schema
-    # Creates invitation_token and invitation_sent_at.
+    # Add invitation_token and invitation_sent_at columns in the resource's database table.
+    #
+    # Examples
+    #
+    #   # For a new resource migration:
+    #   create_table :the_resources do
+    #     t.database_authenticatable :null => false # you need at least this
+    #     t.invitable
+    #     ...
+    #   end
+    #   add_index :the_resources, :invitation_token # for invitable
+    #
+    #   # or if the resource's table already exists, define a migration and put this in:
+    #   change_table :the_resources do |t|
+    #     t.string   :invitation_token, :limit => 60
+    #     t.datetime :invitation_sent_at
+    #     t.index    :invitation_token # for invitable
+    #   end
+    #
+    #   # And allow encrypted_password to be null:
+    #   change_column :the_resources, :encrypted_password, :string, :null => true
+    #   # the following line is only if you use Devise's encryptable module!
+    #   change_column :the_resources, :password_salt,      :string, :null => true
     def invitable
-      apply_schema :invitation_token,   String, :limit => 20
-      apply_schema :invitation_sent_at, DateTime
+      apply_devise_schema :invitation_token,   String, :limit => 60
+      apply_devise_schema :invitation_sent_at, DateTime
+      apply_devise_schema :invitation_limit, Integer
+      apply_devise_schema :invited_by_id, Integer
+      apply_devise_schema :invited_by_type, String
     end
   end
 end

data/lib/devise_invitable/version.rb

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

data/lib/devise_invitable.rb

@@ -1,17 +1,45 @@
-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'
-
-module DeviseInvitable; end
+require 'devise'
 
 require 'devise_invitable/mailer'
 require 'devise_invitable/routes'
 require 'devise_invitable/schema'
+require 'devise_invitable/controllers/url_helpers'
+require 'devise_invitable/controllers/helpers'
 require 'devise_invitable/rails'
+
+module Devise
+  # Public: Validity period of the invitation token (default: 0). If 
+  # invite_for is 0 or nil, the invitation will never expire.
+  # Set invite_for in the Devise configuration file (in config/initializers/devise.rb).
+  #
+  #   config.invite_for = 2.weeks # => The invitation token will be valid 2 weeks
+  mattr_accessor :invite_for
+  @@invite_for = 0
+
+  # Public: Flag that force a record to be valid before being actually invited 
+  # (default: false).
+  #
+  # Examples (in config/initializers/devise.rb)
+  #
+  #   config.validate_on_invite = true
+  mattr_accessor :validate_on_invite
+  @@validate_on_invite = false
+
+  # Public: number of invitations the user is allowed to send
+  #
+  # Examples (in config/initializers/devise.rb)
+  #
+  #   config.invitation_limit = nil
+  mattr_accessor :invitation_limit
+  @@invitation_limit = nil
+  
+  # Public: The key to be used to check existing users when sending an invitation
+  #
+  # Examples (in config/initializers/devise.rb)
+  #
+  #   config.invite_key = :email
+  mattr_accessor :invite_key
+  @@invite_key = :email
+end
+
+Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation

data/lib/generators/active_record/devise_invitable_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class DeviseInvitableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_devise_migration
+        migration_template "migration.rb", "db/migrate/devise_invitable_add_to_#{table_name}"
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,25 @@
+class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table :<%= table_name %> do |t|
+      t.string     :invitation_token, :limit => 60
+      t.datetime   :invitation_sent_at
+      t.integer    :invitation_limit
+      t.references :invited_by, :polymorphic => true
+      t.index      :invitation_token # for invitable
+      t.index      :invited_by_id
+    end
+    
+    # And allow null encrypted_password and password_salt:
+    change_column_null :<%= table_name %>, :encrypted_password, true
+<% if class_name.constantize.columns_hash['password_salt'] -%>
+    change_column_null :<%= table_name %>, :password_salt,      true
+<% end -%>
+  end
+  
+  def self.down
+    change_table :<%= table_name %> do |t|
+      remove_references :invited_by, :polymorphic => true
+      remove :invitation_limit, :invitation_sent_at, :invitation_token
+    end
+  end
+end

data/lib/generators/devise_invitable/devise_invitable_generator.rb

@@ -0,0 +1,20 @@
+module DeviseInvitable
+  module Generators
+    class DeviseInvitableGenerator < Rails::Generators::NamedBase
+      namespace "devise_invitable"
+
+      desc "Add :invitable directive in the given model. Also generate migration for ActiveRecord"
+
+      # def devise_generate_model
+      #   invoke "devise", [name]
+      # end
+
+      def inject_devise_invitable_content
+        path = File.join("app", "models", "#{file_path}.rb")
+        inject_into_file(path, "invitable, :", :after => "devise :") if File.exists?(path)
+      end
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/devise_invitable/install_generator.rb

@@ -0,0 +1,49 @@
+module DeviseInvitable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Add DeviseInvitable config variables to the Devise initializer and copy DeviseInvitable locale files to your application."
+      
+      # def devise_install
+      #   invoke "devise:install"
+      # end
+      
+      def add_config_options_to_initializer
+        devise_initializer_path = "config/initializers/devise.rb"
+        if File.exist?(devise_initializer_path)
+          old_content = File.read(devise_initializer_path)
+          
+          if old_content.match(Regexp.new(/^\s# ==> Configuration for :invitable\n/))
+            false
+          else
+            inject_into_file(devise_initializer_path, :before => "  # ==> Configuration for :confirmable\n") do
+<<-CONTENT
+  # ==> 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
+  
+  # Number of invitations users can send.
+  # If invitation_limit is nil, users can send unlimited invitations.
+  # If invitation_limit is 0, users can't send invitations.
+  # If invitation_limit n > 0, users can send n invitations.
+  # Default: nil
+  # config.invitation_limit = 5
+  
+  # The key to be used to check existing users when sending an invitation
+  # config.invite_key = :email
+  
+CONTENT
+            end
+          end
+        end
+      end
+      
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/devise_invitable.en.yml"
+      end
+      
+    end
+  end
+end

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/lib/generators/mongoid/devise_invitable_generator.rb

@@ -0,0 +1,8 @@
+require 'generators/devise/orm_helpers'
+
+module Mongoid
+  module Generators
+    class DeviseInvitableGenerator < Rails::Generators::NamedBase
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -14,160 +15,128 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 +02:00
+date: 2011-03-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
+        - 1
         - 0
-        version: "0"
+        - 7
+        version: 1.0.7
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: webrat
+  name: rails
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
+        - 3
         - 0
-        version: "0"
-  type: :development
+        - 0
+        version: 3.0.0
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: devise
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 1
-        - 1
+        - 2
         - 0
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   version_requirements: *id003
-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
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- app/controllers/invitations_controller.rb
-- app/views/devise_mailer/invitation.html.erb
-- app/views/invitations/edit.html.erb
-- app/views/invitations/new.html.erb
-- devise_invitable.gemspec
-- init.rb
+- 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_instructions.html.erb
+- config/locales/en.yml
 - 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
+- lib/devise_invitable/controllers/helpers.rb
+- lib/devise_invitable/controllers/url_helpers.rb
+- lib/devise_invitable/version.rb
+- lib/generators/active_record/devise_invitable_generator.rb
+- lib/generators/active_record/templates/migration.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/mongoid/devise_invitable_generator.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
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      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: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+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/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
+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/Rakefile

@@ -1,54 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "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

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

data/app/controllers/invitations_controller.rb

@@ -1,44 +0,0 @@
-class InvitationsController < ApplicationController
-  include Devise::Controllers::InternalHelpers
-
-  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/accept?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
-end

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

@@ -1,8 +0,0 @@
-Hello <%= @resource.email %>!
-
-Someone has invited you to <%= root_url %>, you can accept it through the link below.
-
-<%= 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/app/views/invitations/edit.html.erb

@@ -1,14 +0,0 @@
-<h2>Set your password</h2>
-
-<% form_for resource_name, resource, :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 %>