auth-assistant 0.4.0

data/app/views/auth_assist/menu/_login_items.html.erb

@@ -0,0 +1,11 @@
+<% user_block do %>
+  <li>
+  <%= link_to('Logout', destroy_user_session_path) %>        
+  </li>
+<% end %>
+<% not_user_block do %>
+  <li>
+  <%= link_to('Login', new_user_session_path)  %>  
+  </li>
+<% end %>
+

data/app/views/auth_assist/menu/_registration_items.html.erb

@@ -0,0 +1,10 @@
+<% user_block do %>
+  <li>
+  <%= link_to('Edit registration', edit_user_registration_path) %>
+  </li>
+<% end %>
+<% not_user_block do %>
+  <li>
+  <%= link_to('Register', new_user_registration_path)  %>
+  </li>
+<% end %>

data/auth-assistant.gemspec

@@ -0,0 +1,115 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{auth-assistant}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-05-18}
+  s.description = %q{Provides assistance for setting up an auth solution using devise and cancan auth frameworks}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.markdown"
+  ]
+  s.files = [
+    ".DS_Store",
+    ".document",
+    ".gitignore",
+    "Changelog.txt",
+    "LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "app/.DS_Store",
+    "app/views/.DS_Store",
+    "app/views/auth_assist/menu/_admin_login_items.html.erb",
+    "app/views/auth_assist/menu/_login_items.html.erb",
+    "app/views/auth_assist/menu/_registration_items.html.erb",
+    "auth-assistant.gemspec",
+    "config/locales/en.yml",
+    "init.rb",
+    "lib/.DS_Store",
+    "lib/auth-assistant.rb",
+    "lib/auth_assistant/configure.rb",
+    "lib/auth_assistant/helpers/admin_role.rb",
+    "lib/auth_assistant/helpers/all.rb",
+    "lib/auth_assistant/helpers/localhost.rb",
+    "lib/auth_assistant/helpers/roles.rb",
+    "lib/auth_assistant/helpers/user_role.rb",
+    "lib/auth_assistant/model/user_config.rb",
+    "lib/auth_assistant/role_strategies/admin_field.rb",
+    "lib/auth_assistant/role_strategies/all.rb",
+    "lib/auth_assistant/role_strategies/multi_role_assignment.rb",
+    "lib/auth_assistant/role_strategies/role_assignment.rb",
+    "lib/auth_assistant/role_strategies/role_field.rb",
+    "lib/auth_assistant/role_strategies/roles_field.rb",
+    "lib/auth_assistant/role_strategies/roles_mask.rb",
+    "lib/auth_assistant/role_strategies/shared.rb",
+    "lib/auth_assistant/translate/authlabels.rb",
+    "lib/auth_assistant/view/all.rb",
+    "lib/auth_assistant/view/auth_menu_item.rb",
+    "lib/auth_assistant/view/registration_link.rb",
+    "lib/auth_assistant/view/rest_link.rb",
+    "lib/auth_assistant/view/session_link.rb",
+    "lib/generators/.DS_Store",
+    "lib/generators/auth_assist/.DS_Store",
+    "lib/generators/auth_assist/clear/clear_generator.rb",
+    "lib/generators/auth_assist/config/.DS_Store",
+    "lib/generators/auth_assist/config/config_generator.rb",
+    "lib/generators/auth_assist/templates/ability.rb",
+    "lib/generators/auth_assist/templates/auth_assistant.rb",
+    "lib/generators/auth_assist/templates/permits.rb",
+    "lib/generators/auth_assist/templates/remove_multi_role_assignments_migration.rb",
+    "lib/generators/auth_assist/templates/remove_role_assignments_migration.rb",
+    "lib/generators/auth_assist/templates/role_assignments_migration.rb",
+    "lib/generators/auth_assist/templates/roles_migration.rb",
+    "lib/generators/auth_assist/test.rb",
+    "lib/generators/auth_assist/views/views_generator.rb",
+    "lib/generators/auth_code_refactor.rb",
+    "lib/generators/migration_helper.rb",
+    "lib/generators/reverse_migrations.rb",
+    "lib/generators/role_migrations.rb",
+    "lib/permits.rb",
+    "spec/auth-assistant_spec.rb",
+    "spec/generators/ability_gen_spec.rb",
+    "spec/sandbox.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/devise-assistant}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Provides assistance for setting up an auth solution}
+  s.test_files = [
+    "spec/auth-assistant_spec.rb",
+    "spec/generators/ability_gen_spec.rb",
+    "spec/sandbox.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<devise>, [">= 1.0"])
+      s.add_runtime_dependency(%q<cancan>, [">= 1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_dependency(%q<devise>, [">= 1.0"])
+      s.add_dependency(%q<cancan>, [">= 1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    s.add_dependency(%q<devise>, [">= 1.0"])
+    s.add_dependency(%q<cancan>, [">= 1.0"])
+  end
+end
+

data/config/locales/en.yml

@@ -0,0 +1,14 @@
+en:
+  auth_assistant:
+    confirm: 'Are you sure?'
+    actions:  
+      index: "Index"
+      new: "New"
+      edit: "Edit"
+      delete: "Delete"
+      show: "Show"
+      sign_in: "Sign in"
+      sign_out: "Sign out"      
+      sign_up: "Sign up"  
+      edit_registration: "Edit registration"        
+      

data/init.rb

@@ -0,0 +1 @@
+require 'auth-assistant'

data/lib/auth-assistant.rb

@@ -0,0 +1,24 @@
+require 'auth_assistant/configure'    
+
+module ApplicationHelper 
+  def self.auth_assist_helpers
+    include AuthAssistant::ViewHelpers
+  end
+end
+
+class ApplicationController
+  private
+    def current_ability
+      @current_ability ||= Ability.new(current_user, request)
+    end
+end
+
+
+module AuthAssistant
+  module ViewHelpers
+    include AuthAssistant::ViewHelpers::SessionLink
+    include AuthAssistant::ViewHelpers::RegistrationLink
+    include AuthAssistant::ViewHelpers::RestLink        
+    include AuthAssistant::ViewHelpers::AuthMenuItem       
+  end
+end

data/lib/auth_assistant/configure.rb

@@ -0,0 +1,16 @@
+require 'auth_assistant/helpers/all'
+require 'auth_assistant/model/user_config'
+require 'auth_assistant/translate/authlabels'  
+require 'auth_assistant/view/all'  
+
+if defined? ActionController
+  ActionController::Base.class_eval do 
+    include AuthAssistant::Helpers::AdminRole
+    include AuthAssistant::Helpers::UserRole
+    include AuthAssistant::Helpers::Roles
+    include AuthAssistant::Helpers::LocalHost
+    include AuthAssistant::Helpers::AuthLabel    
+  end
+else
+    puts "ActionController not defined"  
+end

data/lib/auth_assistant/helpers/admin_role.rb

@@ -0,0 +1,59 @@
+module AuthAssistant
+  module Helpers
+    module AdminRole
+      def admin_block(&block)
+        with_output_buffer(&block) if admin?
+      end  
+
+      def not_admin_block(&block)
+        with_output_buffer(&block) if !admin?
+      end  
+
+      def admin_or_owner_block(obj, &block)
+        if admin? || owner?(obj)
+          with_output_buffer(&block)
+        end 
+      end  
+
+      def admin?  
+        devise_admin?(on) || cancan_admin?(on)
+      end
+
+      def admin_area(&block)
+        admin_block do
+          do_admin_area(&block)
+        end
+      end  
+
+      def not_admin_area(&block)
+        not_admin_block do
+          do_admin_area(&block)
+        end
+      end  
+
+      def self.included(base)
+        base.helper_method :admin_block, :not_admin_block, :admin_area, :not_admin_area, :admin_or_owner_block, :admin? 
+      end         
+    
+      protected
+        def do_admin_area(&block)
+          content = with_output_buffer(&block)      
+          content_tag :div, content, :class => 'admin'    
+        end
+      
+        def owner?(obj)
+          current_user == obj.user if obj.repond_to? :user      
+          current_user == obj.owner if obj.repond_to? :owner
+        end      
+
+        def devise_admin?        
+          admin_signed_in? if respond_to? :admin_signed_in?
+        end
+
+        def cancan_admin?               
+          current_user.admin?
+        end
+    
+    end
+  end
+end    

data/lib/auth_assistant/helpers/all.rb

@@ -0,0 +1,4 @@
+require 'auth_assistant/helpers/admin_role'
+require 'auth_assistant/helpers/localhost'
+require 'auth_assistant/helpers/roles'
+require 'auth_assistant/helpers/user_role'

data/lib/auth_assistant/helpers/localhost.rb

@@ -0,0 +1,22 @@
+module AuthAssistant
+  module Helpers
+    module LocalHost
+      def localhost_block(&block)
+        with_output_buffer(&block) if localhost?      
+      end  
+
+      def not_localhost_block(&block)
+        with_output_buffer(&block) if !localhost?
+      end  
+  
+      def localhost?
+         ['localhost', '127.0.0.1'].include?(request.host)
+      end      
+      
+      def self.included(base)
+        base.helper_method :localhost_block, :not_localhost_block, :localhost?      
+      end         
+
+    end
+  end
+end

data/lib/auth_assistant/helpers/roles.rb

@@ -0,0 +1,52 @@
+module AuthAssistant 
+  module Helpers
+    module Roles
+      def roles_area(*user_roles, options, &block)
+        options ||= {}
+        roles_block user_roles do             
+          clazz = options[:class] || 'special'          
+          do_roles_area(clazz, &block)
+        end
+      end  
+
+      def not_roles_area(*user_roles, options, &block)
+        options ||= {}        
+        not_roles_block user_roles do             
+          clazz = options[:class] || 'special'
+          do_roles_area(clazz, &block)
+        end
+      end  
+  
+      def roles_block(*user_roles, &block)
+        with_output_buffer(&block) if role?(user_roles)
+      end 
+
+      def not_roles_block(*user_roles, &block)
+        with_output_buffer(&block) if !role?(user_roles)
+      end 
+    
+      def role?(*user_roles)
+        devise_role?(user_roles) || cancan_role?(user_roles)
+      end
+
+      def self.included(base)
+        base.helper_method :roles_block, :not_roles_block, :roles_area, :not_roles_area, :role? 
+      end
+    
+      protected
+        def do_roles_area(clazz, &block)
+          content = with_output_buffer(&block)
+          content_tag :div, content, :class => clazz    
+        end
+      
+        def devise_role?(user_roles)        
+          user_roles.flatten.any?{|role| warden.authenticate?(:scope => role.to_sym)}
+        end
+
+        def cancan_role?(user_roles)                
+          union = current_user.roles & user_roles
+          !union.empty?
+        end                
+    end
+  end
+end

data/lib/auth_assistant/helpers/user_role.rb

@@ -0,0 +1,47 @@
+module AuthAssistant
+  module Helpers
+    module UserRole
+      def user_area(&block)
+        user_block do
+          do_user_area(&block)
+        end
+      end  
+
+      def not_user_area(&block)
+        not_user_block do
+          do_user_area(&block)
+        end
+      end  
+
+      def user_block(&block)
+        with_output_buffer(&block) if user? 
+      end  
+
+      def not_user_block(&block)
+        with_output_buffer(&block) if !user? 
+      end  
+
+      def user?
+        devise_user? || cancan_user?
+      end
+        
+      def self.included(base)
+        base.helper_method :user_block, :not_user_block, :user_area, :not_user_area, :user? 
+      end         
+    
+      protected
+        def do_user_area(&block)
+          content = with_output_buffer(&block)
+          content_tag :div, content, :class => 'user'    
+        end
+
+        def devise_user?        
+          user_signed_in? if respond_to? :user_signed_in?
+        end
+
+        def cancan_user?
+          !current_user.admin?
+        end    
+    end
+  end
+end

data/lib/auth_assistant/model/user_config.rb

@@ -0,0 +1,42 @@
+require 'auth_assistant/role_strategies/all'
+require 'singleton'
+
+module AuthAssistant
+  def self.configure(&block)
+    block.arity < 1 ? AuthAssistant::Configuration.instance.class_eval(&block) : block.call(AuthAssistant::Configuration.instance)   
+  end
+
+  class Configuration 
+    include Singleton  
+    
+    attr_accessor :role_strategy
+    attr_accessor :available_roles
+
+
+    def available_strategies
+      [:admin_field, :role_field, :roles_field, :roles_mask, :role_assignment, :multi_role_assignment]
+    end              
+  
+    def strategy(name)
+      n = name.to_s
+      available_strategies.include?(n.to_sym) ? n.to_sym : :roles_field
+    end
+
+    def role_strategy=(strategy_name)  
+      # puts "Applying role strategy: #{strategy_name}"
+
+      if !available_strategies.include? strategy_name.to_sym              
+        raise UnknownStrategy, "unknown strategy: #{strategy_name.inspect}, must be one of: #{available_strategies.inspect}" 
+      end
+      @role_strategy = strategy(strategy_name)
+      camel = @role_strategy.to_s.camelize
+      User.class_eval do
+        include AuthAssistant::RoleStrategy::Shared
+        include "AuthAssistant::RoleStrategy::#{camel}".constantize
+        set_scope if respond_to? :set_scope         
+        set_relationships if respond_to? :set_relationships
+      end
+    end
+  end
+end
+

data/lib/auth_assistant/role_strategies/admin_field.rb

@@ -0,0 +1,37 @@
+module AuthAssistant          
+  module RoleStrategy
+    module AdminField
+            
+      def roles=(*roles)
+        new_role = roles.first.to_s
+        self.admin = new_role == 'admin'
+      end
+
+      def roles
+        [role]
+      end
+
+      def role=(role)
+        self.roles = [role]
+      end
+
+      def role
+        admin == true ? 'admin' : 'default' 
+      end
+
+      def role?(_role)
+        role == _role.to_s
+      end  
+
+      module ClassMethods
+        def set_scope
+          scope :with_role, lambda { |role| {:conditions => ["role == ?", role]} }
+        end
+      end
+      
+      def self.included(base)  
+        base.extend(ClassMethods)
+      end          
+    end
+  end
+end