devise-basecamper 0.2.0 → 0.2.1

data/README.md

@@ -1,9 +1,9 @@
 # Devise::Basecamper
 
-Devise-Basecamper was built to allow users of [Devise](https://github.com/plataformatec/devise) to implement "Basecamp" style subdomain scoped authentication with 
-support for multiple users.  There are a lot of [great tutorials](https://github.com/RailsApps/rails3-subdomains) out 
+Devise-Basecamper was built to allow users of [Devise](https://github.com/plataformatec/devise) to implement "Basecamp" style subdomain scoped authentication with
+support for multiple users.  There are a lot of [great tutorials](https://github.com/RailsApps/rails3-subdomains) out
 there on doing subdomain authentication with devise, but none of them seemed to fit my particular use cases.  So I took
-a stab at extending the functionality of [Devise](https://github.com/plataformatec/devise), which has been a great 
+a stab at extending the functionality of [Devise](https://github.com/plataformatec/devise), which has been a great
 Gem, and community, to work with.
 
 ### Use Case
@@ -26,12 +26,12 @@ Or install it yourself as:
 
 ## Usage
 
-To make Devise-Basecamper work properly, there are several steps that need to be taken to adjust the "out-of-the-box" 
-behavior of Devise.  None of the changes require doing any "hacking" of Devise, as they are all steps/actions and 
-configuration options that are already a part of Devise itself.  
+To make Devise-Basecamper work properly, there are several steps that need to be taken to adjust the "out-of-the-box"
+behavior of Devise.  None of the changes require doing any "hacking" of Devise, as they are all steps/actions and
+configuration options that are already a part of Devise itself.
 
 ### Devise Configuration
-Open the Devise initializer file, which can be found in `config/initializers/devise.rb`.  Add `:subdomain` to the 
+Open the Devise initializer file, which can be found in `config/initializers/devise.rb`.  Add `:subdomain` to the
 `config.request_keys` array like below.
 
     config.request_keys = [:subdomain]
@@ -40,27 +40,26 @@ This will make sure to pass the subdomain value from the request to the appropri
 
 ### Configuring models
 
-Which ever model you would like to have subdomain based authentication scoping on, just add `:basecamper` to your 
+Which ever model you would like to have subdomain based authentication scoping on, just add `:basecamper` to your
 included devise modules.
 
 ```
 class User
 	include Mongoid::Document
 	include Mongoid::Timestamps
-	
+
 	devise	:database_authenticatable,
 		:recoverable,
 		:trackable,
 		:validatable,
 		:basecamper
-	
 	...
 end
 ```
 
 By default, Devise-Basecamper assumes that your devise model "belongs to" an Account and has a field called `account_id`
 as the foreign key to that table.  Devise-Basecamper also assumes that the subdomain field exists in your Account model
-and is called `subdomain`.  Now that's a lot of assumptions, but never fear...they can be changed. 
+and is called `subdomain`.  Now that's a lot of assumptions, but never fear...they can be changed.
 
 If you need to change any of these assumptions, you can do so by calling the `devise_basecamper` method in your devise
 model.
@@ -69,22 +68,22 @@ model.
 class User
 	include Mongoid::Document
 	include Mongoid::Timestamps
-	
+
 	devise	:database_authenticatable,
 		:recoverable,
 		:trackable,
 		:validatable,
 		:basecamper
-		
+
 	devise_basecamper :subdomain_class => :my_parent_class,
 			  :subdomain_field => :my_field_name,
 			  :scope_field     => :field_to_scope_against
-			  
+
 	...
 end
 ```
 
-The `devise_basecamper` method has 3 options that can be set: subdomain_class, subdomain_field and scope_field.  
+The `devise_basecamper` method has 3 options that can be set: subdomain_class, subdomain_field and scope_field.
 
 **subdomain_class**
 
@@ -93,7 +92,7 @@ to be an `Account` object.
 
 **subdomain_field**
 
-This option allows you to specify the name of the field within the `subdomain_class` that the subdomain string is stored 
+This option allows you to specify the name of the field within the `subdomain_class` that the subdomain string is stored
 in.  By default, devise_basecamper assumes this to be `subdomain`.
 
 **scope_field**
@@ -119,27 +118,65 @@ class ApplicationController < ActionController::Base
 	protect_from_forgery
 	helper_method :subdomain, :current_account
 	before_filter :validate_subdomain, :authenticate_user!
-	
+
 	private # ----------------------------------------------------
-	
+
 	def current_acount
 		# The where clause is assuming you are using Mongoid, change appropriately
 		# for ActiveRecord or a different supported ORM.
 		@current_account ||= Association.where(subdomain: subdomain).first
 	end
-	
+
 	def subdomain
 		request.subdomain
 	end
-	
+
 	# This will redirect the user to your 404 page if the account can not be found
-	# based on the subdomain.  You can change this to whatever best fits your 
+	# based on the subdomain.  You can change this to whatever best fits your
 	# application.
 	def validate_subdomain
 		redirect_to '/404.html' if current_account.nil?
 	end
 end
 ```
+### Devise Recoverable ###
+
+Devise provides the Recoverable module to implement standard password recovery practices.  This module needs a little help working with the *basecamp style*
+authentication, making sure to find the correct user account, under the correct subdomain.
+
+To implement subdomain-based lookups using the devise Recoverable module, you will need to uncomment the `reset_password_keys` section in `devise.rb`.
+This should be around line 158 in your devise.rb file.  Then update the line to look like the following:
+
+```
+# ==> Configuration for :recoverable
+#
+# Defines which key will be used when recovering the password for an account
+config.reset_password_keys = [ :email, :subdomain ]
+```
+You can add whatever field name you would like here, but :subdomain is probably the best choice.
+
+Next we will need to override the default view for the passwords controller.  Follow the directions from the
+[devise readme](https://github.com/plataformatec/devise) if you don't know how to do this.  Find the proper view
+equivelant in your application for `devise/passwords/new.html.erb` and add a hidden field for the subdomain value.
+You will then want to default its value to the subdomain we are scoping to.  This value will then be included in the
+form submit and processed properly by devise-basecamper.
+
+Support has also been added for confirmation emails thanks to juliobetta.
+
+Example form:
+```
+<h2>Forgot your password?</h2>
+<%= render "flashes" %>
+<%= simple_form_for resource, :as => resource_name, :url => password_path(resource_name), :html => { :method => :post } do |f| %>
+	<%= hidden_field_tag 'user[subdomain]', subdomain %>
+	<%= f.input :email %>
+	<%= f.button :submit, "Send me reset password instructions" %>
+<% end %>
+
+<%= render "devise/shared/links" %>
+```
+**NOTE** Notice that the hidden field is named 'user[subdomain]'.  This is absolutely necessary to make sure that the value is passed
+to the handling devise methods.  However, *user* is **NOT** the hard rule, use whatever the appropriate model name is for your application.
 
 ### ORM Compatability
 
@@ -148,6 +185,10 @@ and should work just fine with all of the ORM's supported by Devise.
 
 MORE TO COME
 
+### Contributing ###
+
+If you would like to contribute to this project, please fork it and submit pull requests with your code changes.  I'm pretty much making updates to this as needed for my own projects right now, so it doesn't change super often and help would definately be appreciated.
+
 ## License
 
 MIT License.  Copyright &copy; 2012 Digital Opera, LLC. [www.digitalopera.com](http://www.digitalopera.com/ "Digital Opera, LLC")

data/lib/devise-basecamper/model.rb

@@ -35,11 +35,23 @@ module Devise
         # We want to override this method to find our users within the scope
         # of our subdomain.
         def send_reset_password_instructions(attributes={})
+          send_instructions_for(:reset_password, attributes)
+        end
+
+        def send_confirmation_instructions(attributes={})
+          send_instructions_for(:confirmation, attributes)
+        end
+
+        private
+
+        def send_instructions_for(action_method, attributes={})
           resource          = self.basecamper[:subdomain_class].to_s.camelize.constantize
           subdomain_source  = resource.to_adapter.find_first(self.basecamper[:subdomain_field] => attributes[:subdomain])
-          recoverable       = find_or_initialize_with_errors([self.basecamper[:scope_field], :email], { :email => attributes[:email], self.basecamper[:scope_field] => (subdomain_source.nil? ? nil : subdomain_source.id.to_s) })
-          recoverable.send_reset_password_instructions if recoverable.persisted?
-          recoverable
+          action_object     = find_or_initialize_with_errors([self.basecamper[:scope_field], :email], {
+            :email => attributes[:email], self.basecamper[:scope_field] => (subdomain_source.nil? ? nil : subdomain_source.id.to_s)
+          })
+          action_object.send("send_#{action_method.to_s}_instructions") if action_object.persisted?
+          action_object
         end
       end
     end

data/lib/devise-basecamper/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Basecamper
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-basecamper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
@@ -73,18 +73,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -987934111135055412
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -987934111135055412
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24