devise_invitable 0.3.1 → 0.4.0

data/lib/devise_invitable.rb

@@ -1,16 +1,4 @@
-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
+require 'devise'
 
 require 'devise_invitable/mailer'
 require 'devise_invitable/routes'
@@ -18,3 +6,40 @@ 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_invitable
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sergio Cambra
@@ -15,45 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 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: 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
-  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 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -64,109 +48,64 @@ 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
+  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: 31
         segments: 
         - 1
-        - 1
+        - 2
         - 0
-        version: 1.1.0
+        version: 1.2.0
   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
-- init.rb
 - 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
-- 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/app/views/layouts/application.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/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
@@ -175,51 +114,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.5.2
 signing_key: 
 specification_version: 3
-summary: An invitation strategy for devise
-test_files: 
-- 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/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

data/Gemfile.lock

@@ -1,108 +0,0 @@
-PATH
-  remote: .
-  specs:
-    devise_invitable (0.3.0)
-      devise (~> 1.1.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.0)
-      actionpack (= 3.0.0)
-      mail (~> 2.2.5)
-    actionpack (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-      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.0)
-      activesupport (= 3.0.0)
-      builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-      arel (~> 1.0.0)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
-    bcrypt-ruby (2.1.2)
-    builder (2.1.2)
-    capybara (0.3.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.3)
-    culerity (0.2.12)
-    devise (1.1.2)
-      bcrypt-ruby (~> 2.1.2)
-      warden (~> 0.10.7)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    ffi (0.6.3)
-      rake (>= 0.8.7)
-    i18n (0.4.1)
-    json_pure (1.4.6)
-    mail (2.2.6)
-      activesupport (>= 2.3.6)
-      mime-types
-      treetop (>= 1.4.5)
-    mime-types (1.16)
-    mocha (0.9.8)
-      rake
-    nokogiri (1.4.3.1)
-    polyglot (0.3.1)
-    rack (1.2.1)
-    rack-mount (0.6.13)
-      rack (>= 1.0.0)
-    rack-test (0.5.4)
-      rack (>= 1.0)
-    rails (3.0.0)
-      actionmailer (= 3.0.0)
-      actionpack (= 3.0.0)
-      activerecord (= 3.0.0)
-      activeresource (= 3.0.0)
-      activesupport (= 3.0.0)
-      bundler (~> 1.0.0)
-      railties (= 3.0.0)
-    railties (3.0.0)
-      actionpack (= 3.0.0)
-      activesupport (= 3.0.0)
-      rake (>= 0.8.4)
-      thor (~> 0.14.0)
-    rake (0.8.7)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.0.28)
-      ffi (>= 0.6.1)
-      json_pure
-      rubyzip
-    sqlite3-ruby (1.3.1)
-    thor (0.14.0)
-    treetop (1.4.8)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.23)
-    warden (0.10.7)
-      rack (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  capybara (>= 0.3.9)
-  devise (~> 1.1.0)
-  devise_invitable!
-  mocha (>= 0.9.8)
-  rails (~> 3.0.0)
-  sqlite3-ruby

data/Rakefile

@@ -1,55 +0,0 @@
-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', '>= 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.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.1

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.