perens-instant-user 0.0.1

data/README.rdoc

@@ -0,0 +1,56 @@
+= Perens::InstantUser
+
+Perens::InstantUser is a Rails Engine that makes it as easy as possible to
+add user management: logins, authentication, sign-up, etc., to your Rails
+application.
+
+* All of the user management services are provided by the Devise gem, but
+  we've done most of the *work* that it would otherwise take to install devise.
+  The engine provides pre-configured routes and a User model.
+
+* Rails >= 3.1, Devise >= 2.0.0.rc, and Ruby >= 1.9.3 are required.
+  It's time to make the jump to
+  Ruby 1.9 if you haven't already done so, as Rails 4.0 will require Ruby
+  1.9.3 or greater.
+
+* This engine is in a *very* early state of development. 
+  There is no inline documentation in the code, and there are no tests!
+  But it works (at least for me), and provides
+  a good example of how to use Devise in an engine.
+
+* My thanks to Devise author and Rails committer José Valim,
+  who upon my request added a set of features to Devise that made it possible
+  to use Devise from an engine.
+
+== Installation
+
+* Edit your Gemfile or gemspec to add a dependency on the perens-instant-user gem.
+* <tt>bundle update</tt>
+* <tt>rake perens_instant_user:install:migrations</tt>
+* <tt>rake migrate</tt>
+* Edit <tt>config/routes.rb</tt>, adding this line:
+    mount Perens::InstantUser::Engine => '/'
+* Copy http://github.com/plataformatec/devise/blob/master/lib/generators/templates/devise.rb into <tt>config/initializers/devise.rb</tt> and edit it.
+* Edit one of your environment files, like <tt>config/application.rb</tt>, to add the
+  URL info to be used in email messages to users from the user management
+  system. While testing, this might be:
+    config.action_mailer.default_url_options = { :host => 'localhost:3000' }
+  but it must be set to the correct external URL when your application is
+  running for
+  real users.
+* Add <tt>user_authenticate!</tt> and other Devise helpers to your controllers
+  as appropriate. See the Devise README.rdoc[https://github.com/plataformatec/devise#readme] for information on the available features.
+ 
+== Bugs
+* Report issues here[https://github.com/BrucePerens/perens-instant-user/issues].
+
+== To Do
+* I'm planning to provide a web interface to set the configuration information,
+  removing the need to copy and edit the Devise configuration file and the
+  environment files.
+
+== Why <tt>Perens::InstantUser</tt> instead of <tt>InstantUser</tt>, and why <tt>perens-instant-user</tt> instead of <tt>instant-user</tt>?
+Ruby and Rails are large enough that we should not all be sharing the
+same global namespace. Thus, all of my code will be in the
+<tt>Perens</tt> module and my gem names will start with <tt>perens-</tt>.
+

data/app/models/perens/instant_user/user.rb

@@ -0,0 +1,10 @@
+class Perens::InstantUser::User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :encryptable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable,
+         :confirmable, :lockable, :token_authenticatable
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation, :remember_me
+end

data/app/models/perens/instant_user.rb

@@ -0,0 +1,5 @@
+module Perens::InstantUser
+  def self.table_name_prefix
+    'perens_instant_user_'
+  end
+end

data/config/initializers/devise.rb

@@ -0,0 +1,3 @@
+Devise.setup do |config|
+  config.router_name = :perens_instant_user
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+Perens::InstantUser::Engine.routes.draw do
+  devise_for :users, {
+    class_name:		'Perens::InstantUser::User',
+    module: :devise,
+  }
+end

data/db/migrate/20120103011557_create_perens_instant_user_users.rb

@@ -0,0 +1,50 @@
+class CreatePerensInstantUserUsers < ActiveRecord::Migration
+  def change
+    create_table(:perens_instant_user_users) do |t|
+      ## Database authenticatable
+      t.string :email,              :null => false, :default => ""
+      t.string :encrypted_password, :null => false, :default => ""
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      t.integer  :sign_in_count, :default => 0
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## Encryptable
+      # t.string :password_salt
+
+      ## Confirmable
+      t.string   :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      t.integer  :failed_attempts, :default => 0 # Only if lock strategy is :failed_attempts
+      t.string   :unlock_token # Only if unlock strategy is :email or :both
+      t.datetime :locked_at
+
+      # Token authenticatable
+      t.string :authentication_token
+
+
+      t.timestamps
+    end
+
+    add_index :perens_instant_user_users, :email,                :unique => true
+    add_index :perens_instant_user_users, :reset_password_token, :unique => true
+    add_index :perens_instant_user_users, :confirmation_token,   :unique => true
+    add_index :perens_instant_user_users, :unlock_token,         :unique => true
+    add_index :perens_instant_user_users, :authentication_token, :unique => true
+  end
+
+end

data/lib/perens/instant_user/engine.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'devise'
+
+require 'perens/instant_user/version'
+
+module Perens
+  module InstantUser
+    class Engine < Rails::Engine
+      isolate_namespace ::Perens::InstantUser
+    end
+  end
+end

data/lib/perens/instant_user/version.rb

@@ -0,0 +1,5 @@
+module Perens
+  module InstantUser
+    VERSION = "0.0.1"
+  end
+end

data/lib/perens-instant-user.rb

@@ -0,0 +1,2 @@
+require 'devise'
+require 'perens/instant_user/engine.rb'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: perens-instant-user
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bruce Perens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: &17906180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0rc
+  type: :runtime
+  prerelease: false
+  version_requirements: *17906180
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &17905020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: *17905020
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &17904000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17904000
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: &22098660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22098660
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &22098240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22098240
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &22097740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: *22097740
+description: An engine that implements user and login handling instantly for an application.
+  It uses the Devise gem to provide all facilities.
+email:
+- bruce@perens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./app/models/perens/instant_user/user.rb
+- ./app/models/perens/instant_user.rb
+- ./perens-instant-user-0.0.1.gem
+- ./db/migrate/20120103011557_create_perens_instant_user_users.rb
+- ./config/routes.rb
+- ./config/initializers/devise.rb
+- ./lib/perens-instant-user.rb
+- ./lib/perens/instant_user/engine.rb
+- ./lib/perens/instant_user/version.rb
+- ./README.rdoc
+homepage: http://perens.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: perens-instant-user
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: An engine that implements user and login handling instantly for an application.
+test_files: []