scottmotte-merb-auth-slice-multisite 0.0.1

data/LICENSE

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

@@ -0,0 +1,7 @@
+= merb-auth-slice-multisite
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 scottmotte. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1

data/lib/merb-auth-slice-multisite.rb

@@ -0,0 +1,105 @@
+if defined?(Merb::Plugins)
+
+  $:.unshift File.dirname(__FILE__)
+
+  require 'merb-slices'
+  require 'merb-auth-core'
+  require 'merb-auth-more'
+  require(File.expand_path(File.dirname(__FILE__) / "merb-auth-slice-multisite" / "mixins") / "user_belongs_to_site")
+  
+  Merb::Plugins.add_rakefiles "merb-auth-slice-multisite/merbtasks", "merb-auth-slice-multisite/slicetasks", "merb-auth-slice-multisite/spectasks"
+
+  # Register the Slice for the current host application
+  Merb::Slices::register(__FILE__)
+  
+  # Slice configuration - set this in a before_app_loads callback.
+  # By default a Slice uses its own layout, so you can swicht to 
+  # the main application layout or no layout at all if needed.
+  # 
+  # Configuration options:
+  # :layout - the layout to use; defaults to :merb-auth-slice-multisite
+  # :mirror - which path component types to use on copy operations; defaults to all
+  Merb::Slices::config[:"merb-auth-slice-multisite"][:layout] ||= :application
+  
+  # All Slice code is expected to be namespaced inside a module
+  module MerbAuthSliceMultisite
+    
+    # Slice metadata
+    self.description = "Merb Slice that adds basic multisite functionality to merb-auth."
+    self.version = "0.2"
+    self.author = "Scott Motte"
+    
+    # Stub classes loaded hook - runs before LoadClasses BootLoader
+    # right after a slice's classes have been loaded internally.
+    def self.loaded
+    end
+    
+    # Initialization hook - runs before AfterAppLoads BootLoader
+    def self.init
+      # Actually check if the user belongs to the site 
+      ::Merb::Authentication.after_authentication do |user, request, params|
+        # clean this up somehow
+        if request.first_subdomain != nil
+          current_site = Site.first(:subdomain => request.first_subdomain)
+          if user.site_id != current_site.id
+            errors = request.session.authentication.errors
+            errors.clear!
+            errors.add("Label", "User does not belong to this site.")
+            nil
+          else
+            user
+          end
+        else
+          current_site = Site.first(:domain => request.domain)
+          if user.site_id != current_site.id
+            errors = request.session.authentication.errors
+            errors.clear!
+            errors.add("Label", "User does not belong to this site.")
+            nil
+          else
+            user
+          end
+        end
+      end
+    end
+    
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+    end
+    
+    # Deactivation hook - triggered by Merb::Slices.deactivate(MerbAuthSliceMultisite)
+    def self.deactivate
+    end
+    
+    # Setup routes inside the host application
+    #
+    # @param scope<Merb::Router::Behaviour>
+    #  Routes will be added within this scope (namespace). In fact, any 
+    #  router behaviour is a valid namespace, so you can attach
+    #  routes at any level of your router setup.
+    #
+    # @note prefix your named routes with :"merb-auth-slice-multisite-
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+    end
+    
+  end
+  
+  # Setup the slice layout for MerbAuthSliceMultisite
+  #
+  # Use MerbAuthSliceMultisite.push_path and MerbAuthSliceMultisite.push_app_path
+  # to set paths to merb-auth-slice-multisite-level and app-level paths. Example:
+  #
+  # MerbAuthSliceMultisite.push_path(:application, MerbAuthSliceMultisite.root)
+  # MerbAuthSliceMultisite.push_app_path(:application, Merb.root / 'slices' / 'merb-auth-slice-multisite')
+  # ...
+  #
+  # Any component path that hasn't been set will default to MerbAuthSliceMultisite.root
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  MerbAuthSliceMultisite.setup_default_structure!
+  
+  # Add dependencies for other MerbAuthSliceMultisite classes below. Example:
+  # dependency "merb-auth-slice-multisite/other"
+  
+end

data/lib/merb-auth-slice-multisite/merbtasks.rb

@@ -0,0 +1,103 @@
+namespace :slices do
+  namespace :"merb-auth-slice-multisite" do
+  
+    desc "Install MerbAuthSliceMultisite"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    
+    desc "Test for any dependencies"
+    task :preflight do # see slicetasks.rb
+    end
+  
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      MerbAuthSliceMultisite.mirrored_components.each do |type|
+        if File.directory?(MerbAuthSliceMultisite.dir_for(type))
+          if !File.directory?(dst_path = MerbAuthSliceMultisite.app_dir_for(type))
+            relative_path = dst_path.relative_path_from(Merb.root)
+            puts "- creating directory :#{type} #{File.basename(Merb.root) / relative_path}"
+            mkdir_p(dst_path)
+          end
+        end
+      end
+    end
+    
+    desc "Copy stub files to host application"
+    task :stubs do
+      puts "Copying stubs for MerbAuthSliceMultisite - resolves any collisions"
+      copied, preserved = MerbAuthSliceMultisite.mirror_stubs!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Copy stub files and views to host application"
+    task :patch => [ "stubs", "freeze:views" ]
+  
+    desc "Copy public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for MerbAuthSliceMultisite - resolves any collisions"
+      copied, preserved = MerbAuthSliceMultisite.mirror_public!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Migrate the database"
+    task :migrate do # see slicetasks.rb
+    end
+    
+    desc "Freeze MerbAuthSliceMultisite into your app (only merb-auth-slice-multisite/app)" 
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+      
+      # desc "Freezes MerbAuthSliceMultisite by installing the gem into application/gems"
+      # task :gem do
+      #   ENV["GEM"] ||= "merb-auth-slice-multisite"
+      #   Rake::Task['slices:install_as_gem'].invoke
+      # end
+      
+      desc "Freezes MerbAuthSliceMultisite by copying all files from merb-auth-slice-multisite/app to your application"
+      task :app do
+        puts "Copying all merb-auth-slice-multisite/app files to your application - resolves any collisions"
+        copied, preserved = MerbAuthSliceMultisite.mirror_app!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all views into your application for easy modification" 
+      task :views do
+        puts "Copying all view templates to your application - resolves any collisions"
+        copied, preserved = MerbAuthSliceMultisite.mirror_files_for :view
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all models into your application for easy modification" 
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = MerbAuthSliceMultisite.mirror_files_for :model
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freezes MerbAuthSliceMultisite as a gem and copies over merb-auth-slice-multisite/app"
+      task :app_with_gem => [:gem, :app]
+      
+      desc "Freezes MerbAuthSliceMultisite by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking MerbAuthSliceMultisite files to your application - resolves any collisions"
+        copied, preserved = MerbAuthSliceMultisite.unpack_slice!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+    end
+    
+  end
+end

data/lib/merb-auth-slice-multisite/mixins/user_belongs_to_site.rb

@@ -0,0 +1,62 @@
+module Merb
+  class Authentication
+    module Mixins
+      # This mixin provides basic user authentication by a site_id.
+      #
+      # Added properties:
+      #  :site_id, Integer
+      #
+      # Added Relationships
+      #  belongs_to :site
+      #
+      # Added Validations
+      # validates_is_unique :login, :scope => :site_id
+      #
+      #
+      # To use it simply require it and include it into your user class.
+      #
+      # class User
+      #   include Authentication::Mixins::UserBelongsToSite
+      #
+      # end
+      #
+      #
+      # OR I RECOMMEND recommend that you put it in your application under merb/merb-auth/setup.rb so it looks like this:
+      # # require 'merb-auth-more/mixins/salted_user'
+      # # Merb::Authentication.user_class.class_eval{ 
+      # #  include Merb::Authentication::Mixins::SaltedUser
+      # #  include Merb::Authentication::Mixins::UserBelongsToSite
+      # # }
+      #
+      module UserBelongsToSite
+        def self.included(base)
+          base.class_eval do
+            include Merb::Authentication::Mixins::UserBelongsToSite::InstanceMethods
+            extend  Merb::Authentication::Mixins::UserBelongsToSite::ClassMethods
+
+            path = File.expand_path(File.dirname(__FILE__)) / "user_belongs_to_site"
+            if defined?(DataMapper) && DataMapper::Resource > self
+              require path / "dm_user_belongs_to_site"
+              extend(Merb::Authentication::Mixins::UserBelongsToSite::DMClassMethods)
+            elsif defined?(ActiveRecord) && ancestors.include?(ActiveRecord::Base)
+              require path / "ar_user_belongs_to_site"
+              extend(Merb::Authentication::Mixins::UserBelongsToSite::ARClassMethods)
+            elsif defined?(Sequel) && ancestors.include?(Sequel::Model)
+              require path / "sq_user_belongs_to_site"
+              extend(Merb::Authentication::Mixins::UserBelongsToSite::SQClassMethods)
+            end
+
+          end # base.class_eval
+        end # self.included
+        
+        module ClassMethods
+          # 
+        end # ClassMethods
+        
+        module InstanceMethods
+          # 
+        end # InstanceMethods
+      end # UserBelongsToSite
+    end # Mixins
+  end # Authentication
+end # Merb

data/lib/merb-auth-slice-multisite/mixins/user_belongs_to_site/dm_user_belongs_to_site.rb

@@ -0,0 +1,26 @@
+module Merb
+  class Authentication
+    module Mixins
+      module UserBelongsToSite
+        module DMClassMethods
+          def self.extended(base)
+            base.class_eval do
+              # Schema
+              property :site_id, Integer
+              # Validations
+              validates_is_unique :login, :scope => :site_id
+              # Relationships/Associations
+              belongs_to :site
+            end # base.class_eval
+          end # self.extended
+        end # DMClassMethods
+      end # UserBelongsToSite
+    end # Mixins
+  end # Authentication
+  
+  class Request
+    def first_subdomain
+      subdomains.first #subdomains is a request variable array so we take the first array entry
+    end #first_subdomain
+  end #Request
+end #Merb

data/lib/merb-auth-slice-multisite/slicetasks.rb

@@ -0,0 +1,20 @@
+namespace :slices do
+  namespace :"merb-auth-slice-multisite" do 
+    
+    # add your own merb-auth-slice-multisite tasks here
+    
+    # # Uncomment the following lines and edit the pre defined tasks
+    #
+    # # implement this to test for structural/code dependencies
+    # # like certain directories or availability of other files
+    # desc "Test for any dependencies"
+    # task :preflight do
+    # end
+    # 
+    # # implement this to perform any database related setup steps
+    # desc "Migrate the database"
+    # task :migrate do
+    # end
+    
+  end
+end

data/lib/merb-auth-slice-multisite/spectasks.rb

@@ -0,0 +1,53 @@
+namespace :slices do
+  namespace :"merb-auth-slice-multisite" do
+      
+    desc "Run slice specs within the host application context"
+    task :spec => [ "spec:explain", "spec:default" ]
+    
+    namespace :spec do
+      
+      slice_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      
+      task :explain do
+        puts "\nNote: By running MerbAuthSliceMultisite specs inside the application context any\n" +
+             "overrides could break existing specs. This isn't always a problem,\n" +
+             "especially in the case of views. Use these spec tasks to check how\n" +
+             "well your application conforms to the original slice implementation."
+      end
+      
+      Spec::Rake::SpecTask.new('default') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+
+      desc "Run all model specs, run a spec for a specific Model with MODEL=MyModel"
+      Spec::Rake::SpecTask.new('model') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MODEL'])
+          t.spec_files = Dir["#{slice_root}/spec/models/**/#{ENV['MODEL']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/models/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all request specs, run a spec for a specific request with REQUEST=MyRequest"
+      Spec::Rake::SpecTask.new('request') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['REQUEST'])
+          t.spec_files = Dir["#{slice_root}/spec/requests/**/#{ENV['REQUEST']}_spec.rb"].sort
+        else    
+          t.spec_files = Dir["#{slice_root}/spec/requests/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all specs and output the result in html"
+      Spec::Rake::SpecTask.new('html') do |t|
+        t.spec_opts = ["--format", "html"]
+        t.libs = ['lib', 'server/lib' ]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+      
+    end
+    
+  end
+end

data/spec/merb-auth-slice-multisite_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "MerbAuthSliceMultisite (module)" do
+  
+  # Implement your MerbAuthSliceMultisite specs here
+  
+  # To spec MerbAuthSliceMultisite you need to hook it up to the router like this:
+  
+  # before :all do
+  #   Merb::Router.prepare { add_slice(:MerbAuthSliceMultisite) } if standalone?
+  # end
+  # 
+  # after :all do
+  #   Merb::Router.reset! if standalone?
+  # end
+  #
+  #
+  # it "should have proper specs"
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'merb-core'
+require 'merb-slices'
+require 'spec'
+
+# 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)
+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

data/test/merb_auth_slice_multisite_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class MerbAuthSliceMultisiteTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'merb_auth_slice_multisite'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: scottmotte-merb-auth-slice-multisite
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- scottmotte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: scott@scottmotte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/merb-auth-slice-multisite
+- lib/merb-auth-slice-multisite/merbtasks.rb
+- lib/merb-auth-slice-multisite/mixins
+- lib/merb-auth-slice-multisite/mixins/user_belongs_to_site
+- lib/merb-auth-slice-multisite/mixins/user_belongs_to_site/dm_user_belongs_to_site.rb
+- lib/merb-auth-slice-multisite/mixins/user_belongs_to_site.rb
+- lib/merb-auth-slice-multisite/slicetasks.rb
+- lib/merb-auth-slice-multisite/spectasks.rb
+- lib/merb-auth-slice-multisite.rb
+- lib/merb_auth_slice_multisite.rb
+- test/merb_auth_slice_multisite_test.rb
+- test/test_helper.rb
+- spec/merb-auth-slice-multisite_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/scottmotte/merb-auth-slice-multisite
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Merb Slice that adds basic multisite functionality to merb-auth.
+test_files: []
+