spree_auth_disabler 0.0.1

data/README.rdoc

@@ -0,0 +1,93 @@
+= SpreeAuthDisabler extension
+
+This extension aims to extend the spree auth logic by options for disabling:
+
+* Client singup
+* Password recovery
+* Client login
+
+Since the extension included in your Gemfile all listed features will be 
+disabled by default.
+
+Use Spree::Auth::Disabler::Config (spree_auth_disabler:app/models/spree_auth_disabler_configuration.rb) 
+for switch this preferences:
+
+* :client_signup_enabled,      :default => false
+* :password_recoverty_enabled, :default => false
+* :client_login_enabled,       :default => false
+
+NOTE: it is recomended to enable client login if client signup enabled, lest 
+clients will get 'Authorization failed' after signup (but the user and the session 
+will be created). See issues below.
+
+== Installing
+
+==== Add into your Gemfile
+
+  gem 'spree_auth_disabler'
+
+or
+
+  gem 'spree_auth_disabler', :git => 'git://github.com/x2es/spree_auth_disabler.git'
+
+NOTE: this extension overrides several views. Loading order does matter. You should place
+this gem above an your theme, at least.
+If other your extensions overrides an auth-views you should decide right loading order.
+You may find useful the gem 'painless_partials' for inspecting the usage roadmap of views.
+
+==== Setup your Spree::Auth::Disabler::Config propertly (see bellow).
+
+== Configuration ways
+
+You can use the Spree::Auth::Disabler::Config in such manner as the Spree::Config or Spreee::Auth::Config
+
+  Spree::Auth::Disabler::Config[:client_login_enabled]              # Returns the foo preference
+  Spree::Auth::Disabler::Config[]                                   # Returns a Hash with all the preferences
+  Spree::Auth::Disabler::Config.instance                            # Returns the configuration object
+  Spree::Auth::Disabler::Config.set(:client_login_enabled => true)  # Set the spree auth preferences as especified in +preference_hash+
+
+Default values initialized in spree_auth_disabler:app/models/spree_auth_disabler_configuration.rb
+
+TODO: two words about overriding preferences class facilities
+
+See the guide http://edgeguides.spreecommerce.com/preferences.html for more details
+
+== Configuration explanation
+
+* unless :client_signup_enabled
+
+  * signup actions will be disabled (new and create), the user will be redirected to root_url, flash[:error] will be supplied
+  * link to signup from login form will be hidden
+
+* unless :password_recoverty_enabled
+  
+  * password recovery actions will be disabled (new and create), redirect and flash[:error] are same as above
+  * link to password recovery from login form will be hidden
+
+* unless :client_login_enabled
+
+  * login actions will deny client login (only create), redirect and flash[:error] are same as above
+  * link to login form will be hidden
+
+  NOTE: 
+    If you have overrided layouts/spree_application.html.erb, you may want to remove the <li> tag
+    surrond the <%= render 'shared/login_bar' %> since an <li> alerady exists in this partial
+
+== Extensions collisions
+
+This extension overrides some views. If you already overrided views, which overrided in this extension too, 
+you may want to checkout differences and apply some changes to your views.
+
+= TODO
+
+* Specs!
+
+== Issues
+
+* 'Autorization failed' ISSUE, when client login disabled, but client signup enabled (after signup)
+
+= Help me
+
+* to fix English grammar in this text (now I am tring to setup articles, but I am not feel yet this aspect to do this job propertly)
+
+ 

data/app/controllers/password_resets_controller_decorator.rb

@@ -0,0 +1,14 @@
+PasswordResetsController.class_eval do
+  before_filter :password_reset_disabler, :only => [:new, :create]
+
+private
+
+  def password_reset_disabler
+    unless Spree::Auth::Disabler::Config[:password_recovery_enabled]
+      # TODO: workaround wariants
+      flash[:error] = t('spree_auth_disabler.password_recovery_disabled')
+      redirect_to root_url
+    end
+  end
+
+end

data/app/controllers/user_sessions_controller_decorator.rb

@@ -0,0 +1,17 @@
+UserSessionsController.class_eval do
+  before_filter :client_login_disabler, :only => :create
+
+private
+
+  # TODO: to create specs for this
+  def client_login_disabler
+    unless Spree::Auth::Disabler::Config[:client_login_enabled]
+      # TODO: add variants of workaround (404 and so on)
+      if (user = User.find_by_email(params[:user_session]['login'])) && (!user.has_role? :admin)
+        flash[:error] = t('spree_auth_disabler.client_login_disabled')
+        redirect_to root_url 
+      end
+    end
+  end
+
+end

data/app/controllers/users_controller_decorator.rb

@@ -0,0 +1,16 @@
+UsersController.class_eval do
+
+  before_filter :signup_disabler, :only => [:new, :create]
+
+private
+
+  # TODO: to create specs for this
+  def signup_disabler
+    unless Spree::Auth::Disabler::Config[:client_signup_enabled]
+      # TODO: create variants of workaround (root redirect, 404 and so on)
+      flash[:error] = t('spree_auth_disabler.client_signup_disabled') 
+      redirect_to root_url
+    end
+  end
+
+end

data/app/models/spree_auth_disabler_configuration.rb

@@ -0,0 +1,14 @@
+class SpreeAuthDisablerConfiguration < Configuration
+  
+  # Usage
+  #   Spree::Auth::Disabler::Config[:client_signup_enabled]
+  #   Spree::Auth::Disabler::Config.set :client_signup_enabled => true/false
+  #   ...
+  #   (see lib/spree_auth_disable_config.rb)
+  #
+  #   or you may override this class such as regular spree configurations 
+
+  preference :client_signup_enabled,     :boolean, :default => false
+  preference :password_recovery_enabled, :boolean, :default => false
+  preference :client_login_enabled,      :boolean, :default => false
+end

data/app/views/shared/_login_bar.html.erb

@@ -0,0 +1,6 @@
+<% if current_user %>
+  <li><%= link_to t('my_account'), account_path %></li>
+  <li><%= link_to t('logout'), logout_path %></li>
+<% elsif Spree::Auth::Disabler::Config[:client_login_enabled] %>
+  <li><%= link_to t('log_in'), login_path %></li>
+<% end %>

data/app/views/user_sessions/new.html.erb

@@ -0,0 +1,17 @@
+<% @body_id = 'login' %>
+<div id="existing-customer">
+  <h2><%= t("login_as_existing") %></h2>
+  <%= hook :login do %>
+    <%= render :partial => 'shared/login' %>
+    <%=
+      account_links = []
+      account_links << link_to(t("create_a_new_account"), signup_path) if Spree::Auth::Disabler::Config[:client_signup_enabled]
+      account_links << link_to(t("forgot_password"), new_password_reset_path) if Spree::Auth::Disabler::Config[:password_recovery_enabled]
+
+      if account_links.any?
+        "#{t('or')} #{account_links.join(' | ')}".html_safe
+      end
+    %>
+  <% end %>
+</div>
+

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+---
+en:
+  spree_auth_disabler:
+    client_signup_disabled: 'Signup disallowed'
+    password_recovery_disabled: 'Password recovery disabled'
+    client_login_disabled: 'Client login disallowed'
+
+  

data/config/locales/ru-RU.yml

@@ -0,0 +1,8 @@
+---
+ru-RU:
+  spree_auth_disabler:
+    client_signup_disabled: 'Регистрация не возможна'
+    password_recovery_disabled: 'Восстановление пароля отключено'
+    client_login_disabled: 'Личный кабинет пользователей отключен'
+
+  

data/lib/spree_auth_disabler.rb

@@ -0,0 +1,18 @@
+require 'spree_core'
+require 'spree_auth_disabler_hooks'
+require 'spree_auth_disabler_config'
+
+module SpreeAuthDisabler
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_auth_disabler_config.rb

@@ -0,0 +1,24 @@
+module Spree
+  module Auth
+    module Disabler
+      # Singleton class to access the shipping configuration object and it's preferences (this seems like spree_auth:/lib/spree/auth/config.rb).
+      #
+      # Usage:
+      #   Spree::Auth::Disabler::Config[:foo]                  # Returns the foo preference
+      #   Spree::Auth::Disabler::Config[]                      # Returns a Hash with all the preferences
+      #   Spree::Auth::Disabler::Config.instance               # Returns the configuration object
+      #   Spree::Auth::Disabler::Config.set(preferences_hash)  # Set the spree auth preferences as especified in +preference_hash+
+      class Config
+        include Singleton
+        include Spree::PreferenceAccess
+
+        class << self
+          def instance
+            return nil unless ActiveRecord::Base.connection.tables.include?('configurations')
+            SpreeAuthDisablerConfiguration.find_or_create_by_name("spree_auth_disabler")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree_auth_disabler_hooks.rb

@@ -0,0 +1,3 @@
+class SpreeAuthDisablerHooks < Spree::ThemeSupport::HookListener
+  # custom hooks go here
+end

data/lib/tasks/install.rake

@@ -0,0 +1,26 @@
+namespace :spree_auth_disabler do
+  desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['spree_auth_disabler:install:migrations'].invoke
+    Rake::Task['spree_auth_disabler:install:assets'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+
+    desc "Copies all assets (NOTE: This will be obsolete with Rails 3.1)"
+    task :assets do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+      destination = File.join(Rails.root, 'public')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end

data/lib/tasks/spree_auth_disabler.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: spree_auth_disabler
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- x@ES
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-15 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 30
+        - 1
+        version: 0.30.1
+  type: :runtime
+  version_requirements: *id001
+description: "[Spree-0.30+] extension for disabling client signup/auth features. See details in README on github."
+email: KEIvanov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/spree_auth_disabler_hooks.rb
+- lib/spree_auth_disabler.rb
+- lib/spree_auth_disabler_config.rb
+- lib/tasks/install.rake
+- lib/tasks/spree_auth_disabler.rake
+- config/locales/en.yml
+- config/locales/ru-RU.yml
+- app/views/shared/_login_bar.html.erb
+- app/views/user_sessions/new.html.erb
+- app/controllers/password_resets_controller_decorator.rb
+- app/controllers/users_controller_decorator.rb
+- app/controllers/user_sessions_controller_decorator.rb
+- app/models/spree_auth_disabler_configuration.rb
+has_rdoc: true
+homepage: https://github.com/x2es/spree_auth_disabler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "[Spree-0.30+] extension for disabling client signup/auth features. See details in README on github."
+test_files: []
+