RubyGems - dougjohnston-devise_invitable - Versions diffs - 0.4.rc - Mend

dougjohnston-devise_invitable 0.4.rc

Files changed (64) hide show

data/.document +5 -0
data/Gemfile +8 -0
data/Gemfile.lock +117 -0
data/LICENSE +20 -0
data/README.rdoc +187 -0
data/Rakefile +57 -0
data/app/controllers/devise/invitations_controller.rb +47 -0
data/app/views/devise/invitations/edit.html.erb +14 -0
data/app/views/devise/invitations/new.html.erb +12 -0
data/app/views/devise/mailer/invitation.html.erb +8 -0
data/app/views/devise/mailer/invitation_instructions.html.erb +8 -0
data/config/locales/en.yml +9 -0
data/devise_invitable.gemspec +157 -0
data/lib/devise_invitable.rb +16 -0
data/lib/devise_invitable/controllers/helpers.rb +7 -0
data/lib/devise_invitable/controllers/url_helpers.rb +24 -0
data/lib/devise_invitable/mailer.rb +14 -0
data/lib/devise_invitable/model.rb +130 -0
data/lib/devise_invitable/rails.rb +13 -0
data/lib/devise_invitable/routes.rb +13 -0
data/lib/devise_invitable/schema.rb +33 -0
data/lib/devise_invitable/version.rb +3 -0
data/lib/generators/active_record/devise_invitable_generator.rb +13 -0
data/lib/generators/active_record/templates/migration.rb +20 -0
data/lib/generators/devise_invitable/devise_invitable_generator.rb +16 -0
data/lib/generators/devise_invitable/install_generator.rb +35 -0
data/lib/generators/devise_invitable/views_generator.rb +10 -0
data/test/generators_test.rb +45 -0
data/test/integration/invitation_test.rb +107 -0
data/test/integration_tests_helper.rb +58 -0
data/test/mailers/invitation_mail_test.rb +63 -0
data/test/model_tests_helper.rb +41 -0
data/test/models/invitable_test.rb +213 -0
data/test/models_test.rb +32 -0
data/test/rails_app/app/controllers/admins_controller.rb +6 -0
data/test/rails_app/app/controllers/application_controller.rb +3 -0
data/test/rails_app/app/controllers/home_controller.rb +4 -0
data/test/rails_app/app/controllers/users_controller.rb +12 -0
data/test/rails_app/app/helpers/application_helper.rb +2 -0
data/test/rails_app/app/models/octopussy.rb +11 -0
data/test/rails_app/app/models/user.rb +4 -0
data/test/rails_app/app/views/home/index.html.erb +0 -0
data/test/rails_app/app/views/layouts/application.html.erb +16 -0
data/test/rails_app/app/views/users/invitations/new.html.erb +15 -0
data/test/rails_app/config.ru +4 -0
data/test/rails_app/config/application.rb +46 -0
data/test/rails_app/config/boot.rb +14 -0
data/test/rails_app/config/database.yml +22 -0
data/test/rails_app/config/environment.rb +5 -0
data/test/rails_app/config/environments/development.rb +26 -0
data/test/rails_app/config/environments/production.rb +49 -0
data/test/rails_app/config/environments/test.rb +35 -0
data/test/rails_app/config/initializers/backtrace_silencers.rb +7 -0
data/test/rails_app/config/initializers/devise.rb +174 -0
data/test/rails_app/config/initializers/inflections.rb +10 -0
data/test/rails_app/config/initializers/mime_types.rb +5 -0
data/test/rails_app/config/initializers/secret_token.rb +7 -0
data/test/rails_app/config/initializers/session_store.rb +8 -0
data/test/rails_app/config/locales/en.yml +5 -0
data/test/rails_app/config/routes.rb +4 -0
data/test/rails_app/script/rails +6 -0
data/test/routes_test.rb +20 -0
data/test/test_helper.rb +31 -0
metadata +297 -0

@@ -0,0 +1,32 @@
+require 'test/test_helper'
+class Invitable < ActiveRecord::Base
+  set_table_name 'users'
+  devise :database_authenticatable, :invitable, :encryptable, :invite_for => 5.days
+end
+class ModelsTest < ActiveSupport::TestCase
+  def include_module?(klass, mod)
+    klass.devise_modules.include?(mod) &&
+    klass.included_modules.include?(Devise::Models::const_get(mod.to_s.classify))
+  end
+  def assert_include_modules(klass, *modules)
+    modules.each do |mod|
+      assert include_module?(klass, mod), "#{klass} not include #{mod}"
+    end
+  end
+  test 'add invitable module only' do
+    assert_include_modules Invitable, :invitable
+  end
+  test 'set a default value for invite_for' do
+    assert_equal 5.days, Invitable.invite_for
+  end
+  test 'invitable attributes' do
+    assert_not_nil Invitable.columns_hash['invitation_token']
+    assert_not_nil Invitable.columns_hash['invitation_sent_at']
+  end
+end

data/test/rails_app/app/controllers/admins_controller.rb ADDED

@@ -0,0 +1,6 @@
+class AdminsController < ApplicationController
+  before_filter :authenticate_admin!
+  def index
+  end
+end

data/test/rails_app/app/controllers/application_controller.rb ADDED

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/rails_app/app/controllers/home_controller.rb ADDED

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/test/rails_app/app/controllers/users_controller.rb ADDED

@@ -0,0 +1,12 @@
+class UsersController < ApplicationController
+  before_filter :authenticate_user!
+  def index
+    user_session[:cart] = "Cart"
+  end
+  def expire
+    user_session['last_request_at'] = 31.minutes.ago.utc
+    render :text => 'User will be expired on next request'
+  end
+end

data/test/rails_app/app/helpers/application_helper.rb ADDED

	@@ -0,0 +1,2 @@
1	+ module ApplicationHelper
2	+ end

data/test/rails_app/app/models/octopussy.rb ADDED

@@ -0,0 +1,11 @@
+# This model is here for the generators' specs
+if DEVISE_ORM == :active_record
+  class Octopussy < ActiveRecord::Base
+    devise :database_authenticatable, :validatable, :confirmable, :encryptable
+  end
+elsif DEVISE_ORM == :mongoid
+  class Octopussy
+    include Mongoid::Document
+    devise :database_authenticatable, :validatable, :confirmable, :encryptable
+  end
+end

data/test/rails_app/app/models/user.rb ADDED

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :confirmable, :invitable, :validatable, :encryptable
+  attr_accessible :username, :email, :password, :password_confirmation
+end

data/test/rails_app/app/views/home/index.html.erb ADDED

File without changes

data/test/rails_app/app/views/layouts/application.html.erb ADDED

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsApp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+<%= content_tag :p, flash[:notice], :id => 'notice' unless flash[:notice].blank? %>
+<%= content_tag :p, flash[:alert], :id => 'alert' unless flash[:alert].blank? %>
+<%= yield %>
+</body>
+</html>

data/test/rails_app/app/views/users/invitations/new.html.erb ADDED

@@ -0,0 +1,15 @@
+<h2>Send an invitation</h2>
+<%= form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => { :method => :post } do |f| %>
+  <%= devise_error_messages! %>
+  <p><%= f.label :username %></p>
+  <p><%= f.text_field :username %></p>
+  <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/test/rails_app/config.ru ADDED

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+run TestApp::Application

data/test/rails_app/config/application.rb ADDED

@@ -0,0 +1,46 @@
+require File.expand_path('../boot', __FILE__)
+DEVISE_ORM = (ENV["DEVISE_ORM"] || :active_record).to_sym unless defined? DEVISE_ORM
+require 'rails/all'
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+require 'devise'
+require 'devise_invitable'
+module RailsApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/rails_app/config/boot.rb ADDED

@@ -0,0 +1,14 @@
+require 'rubygems'
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)

data/test/rails_app/config/database.yml ADDED

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/rails_app/config/environment.rb ADDED

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+# Initialize the rails application
+RailsApp::Application.initialize!

data/test/rails_app/config/environments/development.rb ADDED

@@ -0,0 +1,26 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end

data/test/rails_app/config/environments/production.rb ADDED

@@ -0,0 +1,49 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+  # Enable threaded mode
+  # config.threadsafe!
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/rails_app/config/environments/test.rb ADDED

@@ -0,0 +1,35 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/rails_app/config/initializers/backtrace_silencers.rb ADDED

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+Rails.backtrace_cleaner.remove_silencers!

data/test/rails_app/config/initializers/devise.rb ADDED

@@ -0,0 +1,174 @@
+# Use this hook to configure devise mailer, warden hooks and so forth. The first
+# four configuration values can also be set straight in your models.
+Devise.setup do |config|
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in DeviseMailer.
+  config.mailer_sender = "please-change-me@config-initializers-devise.com"
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating an user. By default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating an user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply hash where the value is a boolean expliciting if authentication
+  # should be aborted or not if the value is not present. By default is empty.
+  # config.authentication_keys = [ :email ]
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+  # Tell if authentication through request.params is enabled. True by default.
+  # config.params_authenticatable = true
+  # Tell if authentication through HTTP Basic Auth is enabled. False by default.
+  # config.http_authenticatable = false
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+  # The realm used in Http Basic Authentication. "Application" by default.
+  # config.http_authentication_realm = "Application"
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  config.stretches = 10
+  # ==> Configuration for :invitable
+  # Time interval where the invitation token is valid.
+  # If invite_for is 0 or nil, the invitation will never expire.
+  # Default: 0
+  # config.invite_for = 2.weeks
+  # ==> Configuration for :confirmable
+  # The time you want to give your user to confirm his account. During this time
+  # he will be able to access your application without confirming. Default is nil.
+  # When confirm_within is zero, the user won't be able to sign in without confirming.
+  # You can use this to let your user access some features of your application
+  # without confirming the account, but blocking it after a certain period
+  # (ie 2 days).
+  # config.confirm_within = 2.days
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+  # If true, a valid remember token can be re-used between multiple browsers.
+  # config.remember_across_browsers = true
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+  # If true, uses the password salt as remember token. This should be turned
+  # to false if you are not using database authenticatable.
+  config.use_salt_as_remember_token = true
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 6..20.
+  # config.password_length = 6..20
+  # Regex to use to validate the email address
+  # config.email_regexp = /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper)
+  config.encryptor = :sha1
+  # Setup a pepper to generate the encrypted password.
+  config.pepper = "c9ed39f2a5faea59e2f9634cd5466703ead30a1fe25ab08cad00fe4d41d23467401fd731eaca1b1326d97b3065217daa81a18368ecc435978e6e868442b753ac"
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+  # If true, authentication through token does not store user in session and needs
+  # to be supplied on each request. Useful if you are using the token as API token.
+  # config.stateless_token = false
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+  # Configure sign_out behavior.
+  # Sign_out action can be scoped (i.e. /users/sign_out affects only :user scope).
+  # The default is true, which means any logout action will sign out all active scopes.
+  # config.sign_out_all_scopes = true
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists. Default is [:html]
+  # config.navigational_formats = [:html, :iphone]
+  # The default HTTP method used to sign out a resource. Default is :get.
+  # config.sign_out_via = :get
+  # ==> OAuth2
+  # Add a new OAuth2 provider. Check the README for more information on setting
+  # up on your models and hooks. By default this is not set.
+  # config.oauth :github, 'APP_ID', 'APP_SECRET',
+  #   :site              => 'https://github.com/',
+  #   :authorize_path    => '/login/oauth/authorize',
+  #   :access_token_path => '/login/oauth/access_token',
+  #   :scope             => %w(user public_repo)
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.failure_app = AnotherApp
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+end