devise-basecamper 0.0.6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise-basecamper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JD Hendrickson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# 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 
+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 
+Gem, and community, to work with.
+
+### Use Case
+User authentication that is scoped to an account, which is identified by the subdomain of the URL.  This allows for better
+multi-tenancy, as well as for re-use of usernames under different accounts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devise-basecamper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise-basecamper
+
+## 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.  
+
+### Devise Configuration
+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]
+
+This will make sure to pass the subdomain value from the request to the appropriate Devise methods.
+
+### Configuring models
+
+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. 
+
+If you need to change any of these assumptions, you can do so by calling the `devise_basecamper` method in your devise
+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.  
+
+**subdomain_class**
+
+This option allows you to specify which model your subdomains are defined in.  By default, devise_basecamper assumes this
+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 
+in.  By default, devise_basecamper assumes this to be `subdomain`.
+
+**scope_field**
+
+This option allows you to specify the name of the field within the devise model (e.g. - User) stores the ID of the account
+you want to create a scope against.  By default, devise_basecamper assumes that this is a field called `account_id`.
+
+If your application follows the assumptions, you DO NOT need to define any of these options.
+
+### Configuring multiple models
+
+You can configure multiple models accordingly just as you can in Devise.  If you have a Devise model that does not need
+the additional features offered by Devise-Basecamper, simple do not include the module.  Devise will work just as expected.
+
+### ORM Compatability
+
+Devise-Basecamper has very minimal interaction with your data layer, however it uses the same `orm_adapter` gem as Devise
+and should work just fine with all of the ORM's supported by Devise.
+
+MORE TO COME
+
+## License
+
+MIT License.  Copyright © 2012 Digital Opera, LLC. [www.digitalopera.com](http://www.digitalopera.com/ "Digital Opera, LLC")

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/devise-basecamper.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/devise-basecamper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["JD Hendrickson"]
+  gem.email         = ["jd@digitalopera.com"]
+  gem.description   = %q{Implement basecamp style subdomain authentication with support for multiple users under a single subdomain scoped account.}
+  gem.summary       = %q{Implement basecamp style subdomain authentication}
+  gem.homepage      = "https://github.com/digitalopera/devise-basecamper"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "devise-basecamper"
+  gem.require_paths = ["lib"]
+  gem.version       = Devise::Basecamper::VERSION
+  
+  gem.add_dependency('orm_adapter', '~> 0.0.7')
+  gem.add_dependency('devise', '~> 2.0.4')
+end

data/lib/devise-basecamper.rb

@@ -0,0 +1,10 @@
+require 'devise'
+require 'devise-basecamper/version'
+require 'devise-basecamper/devise/models/authenticatable'
+
+Devise.add_module(:basecamper,
+  :strategy   => false,
+  :route      => :session,
+  :controller => :sessions,
+  :model      => 'devise-basecamper/model'
+)

data/lib/devise-basecamper/devise/models/authenticatable.rb

@@ -0,0 +1,12 @@
+module Devise
+  module Models
+    module Authenticatable
+      module ClassMethods
+        def find_for_authentication(conditions={})
+          conditions.delete(:subdomain)
+          find_first_by_auth_conditions(conditions)
+        end
+      end
+    end
+  end
+end

data/lib/devise-basecamper/model.rb

@@ -0,0 +1,33 @@
+module Devise
+  module Models
+    module Basecamper
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        def devise_basecamper(opts={})
+          defaults = {
+            :subdomain_class  => :account,
+            :subdomain_field  => :subdomain,
+            :scope_field      => :account_id            
+          }
+          @devise_basecamper_settings = defaults.merge(opts)
+        end
+                
+        def basecamper
+          self.devise_basecamper if @devise_basecamper_settings.nil?
+          return @devise_basecamper_settings
+        end
+        
+        def find_for_authentication(conditions={})
+          if conditions[:subdomain].present?
+              resource                                  = self.basecamper[:subdomain_class].to_s.camelize.constantize
+              subdomain_source                          = resource.to_adapter.find_first(self.basecamper[:subdomain_field] => conditions[:subdomain])
+              conditions[self.basecamper[:scope_field]] = (subdomain_source.nil?) ? nil : subdomain_source.id
+              conditions.delete(self.basecamper[:subdomain_field])
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/devise-basecamper/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module Basecamper
+    VERSION = "0.0.6"
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: devise-basecamper
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- JD Hendrickson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+description: Implement basecamp style subdomain authentication with support for multiple
+  users under a single subdomain scoped account.
+email:
+- jd@digitalopera.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- devise-basecamper.gemspec
+- lib/devise-basecamper.rb
+- lib/devise-basecamper/devise/models/authenticatable.rb
+- lib/devise-basecamper/model.rb
+- lib/devise-basecamper/version.rb
+homepage: https://github.com/digitalopera/devise-basecamper
+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: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Implement basecamp style subdomain authentication
+test_files: []
+has_rdoc: