devise_invitable 0.3.4 → 0.6.0

data/lib/devise_invitable/rails.rb

@@ -2,9 +2,12 @@ module DeviseInvitable
   class Engine < ::Rails::Engine
     
     ActiveSupport.on_load(:action_controller) { include DeviseInvitable::Controllers::UrlHelpers }
-    ActiveSupport.on_load(:action_view) { include DeviseInvitable::Controllers::UrlHelpers }
+    ActiveSupport.on_load(:action_view)       { include DeviseInvitable::Controllers::UrlHelpers }
     
-    config.after_initialize do
+    # We use to_prepare instead of after_initialize here because Devise is a Rails engine; its
+    # mailer is reloaded like the rest of the user's app.  Got to make sure that our mailer methods
+    # are included each time Devise::Mailer is (re)loaded.
+    config.to_prepare do
       require 'devise/mailer'
       Devise::Mailer.send :include, DeviseInvitable::Mailer
     end

data/lib/devise_invitable/routes.rb

@@ -1,10 +1,13 @@
 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
+    
+  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

data/lib/devise_invitable/schema.rb

@@ -1,9 +1,36 @@
 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.datetime :invitation_accepted_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_devise_schema :invitation_token,   String, :limit => 20
+      apply_devise_schema :invitation_token,   String, :limit => 60
       apply_devise_schema :invitation_sent_at, DateTime
+      apply_devise_schema :invitation_accepted_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.6.0'
+end

data/lib/devise_invitable.rb

@@ -1,16 +1,58 @@
 require 'devise'
 
-module Devise
-  # Time interval where the invitation token is valid.
-  mattr_accessor :invite_for
-  @@invite_for = 0
+module DeviseInvitable
+  autoload :Inviter, 'devise_invitable/inviter'
 end
 
-Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation
-
 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
+
+  # Public: Resend invitation if user with invited status is invited again
+  # (default: true)
+  #
+  # Example (in config/initializers/devise.rb)
+  #
+  #   config.resend_invitation = false
+  mattr_accessor :resend_invitation
+  @@resend_invitation = true
+end
+
+Devise.add_module :invitable, :controller => :invitations, :model => 'devise_invitable/model', :route => :invitation

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

@@ -1,18 +1,26 @@
 class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
   def self.up
     change_table :<%= table_name %> do |t|
-      t.string   :invitation_token, :limit => 20
-      t.datetime :invitation_sent_at
-      t.index    :invitation_token # for invitable
+      t.string     :invitation_token, :limit => 60
+      t.datetime   :invitation_sent_at
+      t.datetime   :invitation_accepted_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 :<%= table_name %>, :encrypted_password, :string, :null => true
-    change_column :<%= table_name %>, :password_salt,      :string, :null => true
+    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
-    remove_column :<%= table_name %>, :invitation_sent_at
-    remove_column :<%= table_name %>, :invitation_token
+    change_table :<%= table_name %> do |t|
+      t.remove_references :invited_by, :polymorphic => true
+      t.remove :invitation_limit, :invitation_sent_at, :invitation_accepted_at, :invitation_token
+    end
   end
 end

data/lib/generators/devise_invitable/devise_invitable_generator.rb

@@ -5,6 +5,10 @@ module DeviseInvitable
 
       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)

data/lib/generators/devise_invitable/install_generator.rb

@@ -4,6 +4,10 @@ module DeviseInvitable
       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)
@@ -15,10 +19,25 @@ module DeviseInvitable
             inject_into_file(devise_initializer_path, :before => "  # ==> Configuration for :confirmable\n") do
 <<-CONTENT
   # ==> Configuration for :invitable
-  # Time interval where the invitation token is valid (default: 0).
-  # If invite_for is 0 or nil, the invitation will never expire.
+  # 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
+  
+  # Flag that force a record to be valid before being actually invited 
+  # Default: false
+  # config.validate_on_invite = true
+
 CONTENT
             end
           end

data/lib/generators/devise_invitable/views_generator.rb

@@ -2,9 +2,18 @@ require 'generators/devise/views_generator'
 
 module DeviseInvitable
   module Generators
-    class ViewsGenerator < Devise::Generators::ViewsGenerator
-      source_root File.expand_path("../../../../app/views", __FILE__)
+    class ViewsGenerator < Rails::Generators::Base
       desc 'Copies all DeviseInvitable views to your application.'
+
+      argument :scope, :required => false, :default => nil,
+                       :desc => "The scope to copy views to"
+
+      include ::Devise::Generators::ViewPathTemplates
+      source_root File.expand_path("../../../../app/views/devise", __FILE__)
+      def copy_views
+        view_directory :invitations
+        view_directory :mailer
+      end
     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,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 0
-  - 3
-  - 4
-  version: 0.3.4
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,48 +15,31 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 +02:00
-default_executable: 
+date: 2011-11-15 00:00:00 Z
 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: 43
+        hash: 25
         segments: 
+        - 1
         - 0
-        - 9
-        - 8
-        version: 0.9.8
+        - 7
+        version: 1.0.7
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: capybara
+  name: rails
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 3
-        - 9
-        version: 0.3.9
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rails
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
       - !ruby/object:Gem::Version 
         hash: 7
         segments: 
@@ -64,117 +47,78 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
+    - - <
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
+        - 3
+        - 2
+        version: "3.2"
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: devise
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 11
         segments: 
         - 1
+        - 4
+        - 6
+        version: 1.4.6
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
         - 1
-        - 0
-        version: 1.1.0
+        - 6
+        version: "1.6"
   type: :runtime
-  version_requirements: *id005
-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
+  version_requirements: *id003
+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
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
 - 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.html.erb
+- app/views/devise/mailer/invitation_instructions.html.erb
 - config/locales/en.yml
-- devise_invitable.gemspec
 - lib/devise_invitable.rb
-- lib/devise_invitable/controllers/helpers.rb
-- lib/devise_invitable/controllers/url_helpers.rb
 - 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
+- lib/devise_invitable/controllers/helpers.rb
+- lib/devise_invitable/controllers/url_helpers.rb
+- lib/devise_invitable/version.rb
+- lib/devise_invitable/inviter.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/devise_invitable/views_generator.rb
-- test/generators_test.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/octopussy.rb
-- test/rails_app/app/models/user.rb
-- test/rails_app/app/views/home/index.html.erb
-- test/rails_app/app/views/layouts/application.html.erb
-- test/rails_app/app/views/users/invitations/new.html.erb
-- test/rails_app/config.ru
-- test/rails_app/config/application.rb
-- 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/mime_types.rb
-- test/rails_app/config/initializers/secret_token.rb
-- test/rails_app/config/initializers/session_store.rb
-- test/rails_app/config/locales/en.yml
-- test/rails_app/config/routes.rb
-- test/rails_app/script/rails
-- test/routes_test.rb
-- test/test_helper.rb
-has_rdoc: true
-homepage: http://github.com/scambra/devise_invitable
+- lib/generators/mongoid/devise_invitable_generator.rb
+- LICENSE
+- README.rdoc
+homepage: https://github.com/scambra/devise_invitable
 licenses: []
 
 post_install_message: 
 rdoc_options: 
+- --main
+- README.rdoc
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -183,53 +127,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      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: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: An invitation strategy for devise
-test_files: 
-- test/generators_test.rb
-- test/test_helper.rb
-- test/integration/invitable_test.rb
-- test/routes_test.rb
-- test/rails_app/app/helpers/application_helper.rb
-- test/rails_app/app/models/octopussy.rb
-- test/rails_app/app/models/user.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/config/initializers/devise.rb
-- test/rails_app/config/initializers/inflections.rb
-- test/rails_app/config/initializers/mime_types.rb
-- test/rails_app/config/initializers/secret_token.rb
-- test/rails_app/config/initializers/session_store.rb
-- test/rails_app/config/initializers/backtrace_silencers.rb
-- test/rails_app/config/environment.rb
-- test/rails_app/config/environments/production.rb
-- test/rails_app/config/environments/test.rb
-- test/rails_app/config/environments/development.rb
-- test/rails_app/config/routes.rb
-- test/rails_app/config/application.rb
-- test/rails_app/config/boot.rb
-- test/integration_tests_helper.rb
-- test/model_tests_helper.rb
-- test/models_test.rb
-- test/mailers/invitation_test.rb
-- test/models/invitable_test.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/Gemfile

@@ -1,3 +0,0 @@
-source :rubygems
-
-gemspec