scottmotte-merb-auth-core 1.0.10

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Scott Motte
+
+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.textile

@@ -0,0 +1,115 @@
+h1. MerbAuthSliceMultisite
+
+This slice setups multisite capabilities in your merb application with an authentication check. 
+
+It works for subdomains (i.e. coolcars.yourapp.com) or for domains routed to your application via your server (i.e. coolcars.com). 
+
+It has a check to make a user to the site he's trying to login to. If the user does not match than authentication fails.
+
+h2. Instructions for installation:
+
+1. Add github as a gem source & install
+<pre><code>
+	gem sources -a http://gems.github.com
+	sudo gem install scottmotte-merb_auth_slice_multisite
+</code></pre>
+
+2. Setup your application to use the gem.* Add the following to the end of dependencies.rb.
+<pre><code>dependency "scottmotte-merb_auth_slice_multisite", :require_as => 'merb_auth_slice_multisite'</code></pre>
+
+3. Add in mixin. In your user model or in merb/merb-auth/setup.rb add the mixin 
+include Merb::Authentication::Mixins::UserBelongsToSite and then migrate your database.
+<pre><code>
+# in model
+class User
+	include Merb::Authentication::Mixins::UserBelongsToSite
+end
+
+# or as I prefer in merb/merb-auth/setup.rb
+Merb::Authentication.user_class.class_eval{ 
+  include Merb::Authentication::Mixins::SaltedUser
+  include Merb::Authentication::Mixins::ActivatedUser
+  include Merb::Authentication::Mixins::UserBelongsToSite # <-- this one
+ }
+</code></pre>
+
+_Don't forget to migrate your database schema with rake db:autoupgrade or rake db:automigrate_
+
+
+4. Setup @current_site value. I haven't worked out how to make it automatically accessible yet so for now I just paste the following into my app's application.rb file.
+<pre><code>
+before :get_site
+def get_site
+  # uses @current_site to create pages under appropriate site like @current_site.pages.new
+  # if there is a subdomain then fetch from subdomain, otherwise fetch from domain
+  if request.first_subdomain != nil
+    @current_site = Site.first(:subdomain => request.first_subdomain)
+  else
+    @current_site = Site.first(:domain => request.domain)
+  end
+end
+</pre></code>
+
+
+Check out the video. <a href="http://scottmotte.github.com/merb_auth_slice_multisite/">How to install merb_auth_slice_multisite in your application.</a>
+
+
+h2. Additional details:
+
+Schema/Migrations. The mixin requires some fields to be in-place in your user model. Where needed include these in your migrations.
+<pre><code># Relationships/Associations
+belongs_to :site
+property :site_id, Integer
+validates_is_unique :login, :scope => :site_id
+</code></pre>
+
+Site model. You're probably wondering where the heck is the site model. It's in the slice. You can override it by running one of the rake tasks or you can create your own site.rb model and add additional fields. For example, if you have pages under a site, you might do something like:
+<pre><code># site.rb
+class Site
+  has n, :pages, :order => [:position.asc]
+end
+</code></pre>
+
+@current_site. You can use @current_site in your controllers like so:
+<pre><code>
+class Pages < Application
+  # provides :xml, :yaml, :js
+
+  def index
+    @pages = @current_site.pages.all
+    display @pages
+  end
+
+  def show(id)
+    @page = @current_site.pages.get(id)
+    raise NotFound unless @page
+    display @page
+  end
+
+end # Pages	
+</pre></code>
+
+
+h2. Assumptions
+
+* works for subdomains (i.e. coolcars.yourapp.com) or for domains routed to your application via your server (i.e. coolcars.com). see lines 40-55 in lib/merb_auth_slice_multisite.rb and lib/merb_auth_slice_multisite/mixins/user_belongs_to_site/dm_user_belongs_to_site.rb for details
+* merb only
+* merb-auth-core dependency
+* merb-auth-more dependency
+* *only supports datamapper so far* (help me extend it! fork the project and request me to pull)
+* A site has n (has_many) users. A user belongs_to a site.
+* You can have multiple users with the same username and password as long as they each belong_to a different site. For example, there can be an admin user with the credentials { :login => 'admin', :email => 'admin@example.org', :site_id => 1} and an admin user with the credentials { :login => 'admin', :email => 'admin@example.org', :site_id => 66}. As long as the site_id is different then it is ok. This allows more freedom when your users want to setup multiple sites. 
+
+
+h2. How does it work?
+
+When logging in the "user" object found by merb-auth-core will be asked whether the user's site_id matches the id of the current_site. It user merb-auth's after_authentication method to do this. 
+
+The current_site is queried by using a model lookup off the request variable.
+
+
+h2. Rake tasks   
+
+To see all available tasks for MerbAuthSliceMultisite run:
+
+rake -T slices:merb_auth_slice_multisite

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb-core'
+require 'merb-core/tasks/merb'
+require 'merb-core/test/tasks/spectasks'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "merb_auth_slice_multisite"
+    gem.summary = %Q{add multisite/subdomain functionality to your merb app on top of merb-auth}
+    gem.email = "scott@scottmotte.com"
+    gem.homepage = "http://github.com/scottmotte/merb_auth_slice_multisite"
+    gem.authors = ["scottmotte"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "merb_auth_slice_multisite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+desc 'Default: run spec examples'
+task :default => 'spec'

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'merb-core'
+require 'merb-slices'
+require 'spec'
+require 'dm-core'
+require 'dm-validations'
+
+# Add merb_auth_slice_multisite.rb to the search path
+Merb::Plugins.config[:merb_slices][:auto_register] = true
+Merb::Plugins.config[:merb_slices][:search_path]   = File.join(File.dirname(__FILE__), '..', 'lib', 'merb_auth_slice_multisite.rb')
+
+# Require merb_auth_slice_multisite.rb explicitly so any dependencies are loaded
+require Merb::Plugins.config[:merb_slices][:search_path]
+
+# Using Merb.root below makes sure that the correct root is set for
+# - testing standalone, without being installed as a gem and no host application
+# - testing from within the host application; its root will be used
+Merb.start_environment(
+  :testing => true, 
+  :adapter => 'runner', 
+  :environment => ENV['MERB_ENV'] || 'test',
+  :session_store => 'memory'
+)
+
+module Merb
+  module Test
+    module SliceHelper
+      
+      # The absolute path to the current slice
+      def current_slice_root
+        @current_slice_root ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
+      end
+      
+      # Whether the specs are being run from a host application or standalone
+      def standalone?
+        Merb.root == ::MerbAuthSliceMultisite.root
+      end
+      
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(Merb::Test::ViewHelper)
+  config.include(Merb::Test::RouteHelper)
+  config.include(Merb::Test::ControllerHelper)
+  config.include(Merb::Test::SliceHelper)
+  
+  config.before(:all) do
+    DataMapper.auto_migrate! if Merb.orm == :datamapper
+  end
+end
+
+# You can add your own helpers here
+#
+Merb::Test.add_helpers do
+  def mount_slice
+    Merb::Router.prepare { add_slice(:MerbAuthSliceMultisite, "merb_auth_slice_multisite") } if standalone?
+  end
+
+  def dismount_slice
+    Merb::Router.reset! if standalone?
+  end
+end
+
+# =============================================================================
+# SITE STUFF
+# =============================================================================
+def valid_site_attributes(options = {})
+  {
+    :domain => 'http://www.example.org',
+    :subdomain => 'example',
+    :id => 1
+  }.merge(options)
+end
+
+def valid_second_site_attributes(options = {})
+  {
+    :domain => 'http://www.example2.org',
+    :subdomain => 'example2',
+    :active => true,
+    :id => 2
+  }.merge(options)
+end
+
+def valid_third_site_attributes(options = {})
+  {
+    :domain => 'http://www.example3.org',
+    :subdomain => 'example3',
+    :active => true,
+    :id => 3
+  }.merge(options)
+end
+
+# =============================================================================
+# USER STUFF - see init.rb for where this gets spoofed
+# =============================================================================
+def valid_user_attributes(options = {})
+   { :login => 'fred',
+     :email => 'fred@example.com',
+     :site_id => 1
+   }.merge(options)
+ end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: scottmotte-merb-auth-core
+version: !ruby/object:Gem::Version 
+  version: 1.0.10
+platform: ruby
+authors: 
+- Adam French, Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An Authentication framework for Merb
+email: has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- TODO
+- lib/merb-auth-core
+- lib/merb-auth-core/authenticated_helper.rb
+- lib/merb-auth-core/authentication.rb
+- lib/merb-auth-core/bootloader.rb
+- lib/merb-auth-core/callbacks.rb
+- lib/merb-auth-core/customizations.rb
+- lib/merb-auth-core/errors.rb
+- lib/merb-auth-core/merbtasks.rb
+- lib/merb-auth-core/responses.rb
+- lib/merb-auth-core/router_helper.rb
+- lib/merb-auth-core/session_mixin.rb
+- lib/merb-auth-core/strategy.rb
+- lib/merb-auth-core.rb
+- spec/helpers
+- spec/helpers/authentication_helper_spec.rb
+- spec/merb-auth-core
+- spec/merb-auth-core/activation_fixture.rb
+- spec/merb-auth-core/authentication_spec.rb
+- spec/merb-auth-core/callbacks_spec.rb
+- spec/merb-auth-core/customizations_spec.rb
+- spec/merb-auth-core/errors_spec.rb
+- spec/merb-auth-core/failed_login_spec.rb
+- spec/merb-auth-core/merb-auth-core_spec.rb
+- spec/merb-auth-core/router_helper_spec.rb
+- spec/merb-auth-core/strategy_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://merbivore.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: An Authentication framework for Merb
+test_files: []
+