radiant-users-extension 0.0.5 → 2.1.0.beta

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/MIT-LICENCE

@@ -0,0 +1,19 @@
+Copyright (C) <2011> by <Dirk Kelly [The Frontier Group Pty Ltd]>
+
+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

@@ -1,31 +1,84 @@
-# Radiant Users Extension
+# Users
 
-Hook standard Radiant users to provide front end user creation and login.
+* Radiant is lovely <3
+* The user authentication system works.
+* This extension replaces that working system with Devise.
+* Devise also works
+* Radiant-Users-Extension is also lovely <3
 
-A good example comes from [radiant-shop-extension](http://github.com/dirkkelly/radiant-shop-extension) in the use of customers
+# Installing
+  
+    git clone git@github.com:dirkkelly/radiant-users-extension vendor/extensions/users
+    cd vendor/extensions/users
+    git checkout devise
+    cd ../../../
+    rake radiant:extensions:users:migrate
 
-## Create a Model
+# Registrations
 
-    class ShopCustomer < User
-      include Users::Models::User::Scoped
+You will need to override the Devise definition in the user model
+
+    User.class_eval do
+    
+      devise :database_authenticatable, :registerable, :confirmable, :recoverable, :rememberable, :token_authenticatable, :validatable
+    
+    end
+
+You can set a custom class_name on new registrations
+
+    User.class_eval do
+    
+      protected
+      
+      def set_class_name
+        self.class_name ||= "Visitor"
+      end
+    
     end
 
-When a customer is created the access attributes present status will prevent them from accessing the administration system.
+# Migration
+
+* Passwords do not need to change, the migration will take care of updating these
+* Emails are now required for every user. You will get warned of users with missing emails and a dummy address _set@email.com_ will be applied
+
+Field changes
+
+    login    => username (setter and getter abstracted out)
+    password => encrypted_password
+    salt     => password_salt
 
-## Define Their Welcome Page
+# Inheriting Classes
 
-    Radiant::Config['users.shop_customer.redirect'] = '/cart'
+_actually, this doesn't exist yet_
 
-## API Access
+User has a field `class_name`, when you inherit a class this will get set.
 
-Login Candy provided us with authentication hooks allowing for API login, there is currently no login mechanism. Contributions are welcome
+If this field is not nil, the user will not have access to the administration system.
 
-# Installation
+# Development and Testing
 
-Gemfile
+This extension uses the following gems, define them in a development and test group.
 
-    gem 'radiant-users-extension', :require => nil
+    group :development do
+      gem 'ruby-debug',                     '~> 0.10.3'
+      gem 'jeweler',                        '~> 1.5.2'
+      gem 'rspec-rails',                    '~> 1.3.2'
+      gem 'remarkable',                     '3.1.12', :git => 'https://github.com/joerichsen/remarkable.git', :branch => 'rspec1-compat'
+      gem 'remarkable_rails',               '3.1.12', :require => 'remarkable_rails'
+    end
+
+    group :test do
+      gem 'rspec',                          '~> 1.3.1'
+      gem 'rspec-rails',                    '~> 1.3.2'
+      gem 'remarkable',                     '3.1.12', :git => 'https://github.com/joerichsen/remarkable.git', :branch => 'rspec1-compat'
+      gem 'remarkable_rails',               '3.1.12', :require => 'remarkable_rails'
+      gem 'cucumber-rails',                 '~> 0.2.4'
+      gem 'database_cleaner',               '~> 0.4.3'
+      gem 'webrat',                         '~> 0.6.0'
+      gem 'rr',                             '~> 0.10.11'
+      gem 'rcov',                           '~> 0.9.9'
+    end
     
-config/environment.rb
+# LICENCE
 
-    config.gem 'radiant-users-extension', :lib => false
+This extension was developed by [Dirk Kelly](http://twitter.com/dirkkelly) on [The Frontier Group's](http://twitter.com/frontiergroup) Time. It is licenced as MIT.

data/Rakefile

@@ -1,22 +1,36 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-users-extension/version"
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "radiant-users-extension"
-    gem.summary = %Q{Users Extension for Radiant CMS}
-    gem.description = %Q{Users creates support for non-admin users with API access}
-    gem.email = "dk@squaretalent.com"
-    gem.homepage = "http://github.com/dirkkelly/radiant-users-extension"
-    gem.authors = ["Christopher Rankin", "Dirk Kelly"]
+    gem.name        = "radiant-users-extension"
+    gem.version     = RadiantUsersExtension::VERSION
+    gem.platform    = Gem::Platform::RUBY
+    gem.authors     = ["Dirk Kelly"]
+    gem.email       = ["dk@dirkkelly.com"]
+    gem.homepage    = "http://github.com/dirkkelly/radiant-users-extension"
+    gem.summary     = %q{Users for Radiant CMS}
+    gem.description = %q{Makes Radiant better by adding users!}
+    
+    gem.files         = `git ls-files`.split("\n")
+    gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+    gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    gem.require_paths = ["lib"]
+    
+    gem.add_dependency 'radiant', '~> 0.9'
+    gem.add_dependency 'devise',  '~> 1.0.9'
+    
+    gem.post_install_message = %{
+    Add this to your radiant project with:
+      config.gem 'radiant-users-extension', :version => '#{RadiantUsersExtension::VERSION}'
+    }
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. This is only required if you plan to package users as a gem."
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package shop as a gem."
 end
 
-# In rails 1.2, plugins aren't available in the path until they're loaded.
-# Check to see if the rspec plugin is installed first and require
-# it if it is.  If not, use the gem version.
-
 # Determine where the RSpec plugin is by loading the boot
 unless defined? RADIANT_ROOT
   ENV["RAILS_ENV"] = "test"

data/app/helpers/admin/users_helper.rb

@@ -0,0 +1,5 @@
+module Admin::UsersHelper
+  def roles(user)
+    user.class_name
+  end
+end

data/app/models/administrator.rb

@@ -0,0 +1,3 @@
+class Administrator < User
+  
+end

data/app/models/designer.rb

@@ -0,0 +1,3 @@
+class Designer < User
+  
+end

data/app/models/user.rb

@@ -0,0 +1,82 @@
+class User < ActiveRecord::Base
+  
+  @@authorized_types = [ 'Administrator', 'Designer', 'User' ]
+  
+  devise :database_authenticatable, :confirmable, :recoverable, :rememberable, :token_authenticatable, :validatable
+  # When inheriting this can raise an exception on the new models
+  
+  attr_accessor :login, :new_class_name
+  
+  # Default Order
+  default_scope           :order => 'name'
+  
+  set_inheritance_column  :class_name
+  
+  # Associations
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
+  
+  before_validation       :set_class_name
+  
+  validates_presence_of   :name
+  validates_presence_of   :class_name # Has no effect
+  
+  def login
+    self[:username]
+  end
+  
+  def login=(username)
+    self[:username] = username
+  end
+  
+  def new_class_name
+    self[:class_name]
+  end
+  
+  def new_class_name=(class_name)
+    @current_user = UserActionObserver.current_user
+    self[:class_name] = @current_user.has_role?(:admin) ? class_name : self[:class_name]
+  end
+  
+  def admin?
+    has_role?(:admin)
+  end
+  
+  def designer?
+    has_role?(:designer)
+  end
+    
+  def authorized?
+    @@authorized_types.include?(class_name)
+  end
+
+  def has_role?(role)
+    class_name.downcase.to_sym == role.to_s.downcase.to_sym
+  end
+  
+  class << self
+    def unprotected_attributes
+      @unprotected_attributes ||= [:name, :email, :username, :login, :password, :password_confirmation, :locale]
+    end
+    
+    def unprotected_attributes=(array)
+      @unprotected_attributes = array.map{|att| att.to_sym }
+    end
+    
+    def find_for_authentication(conditions)
+      login = conditions.delete(:login)
+      find(:first, :conditions => ["username = ? OR email = ?", login, login])
+    end
+  end
+  
+  protected
+    
+  def password_required?
+    new_record? || destroyed? || password.present? || password_confirmation.present?
+  end
+  
+  def set_class_name
+    self[:class_name] ||= "User"
+  end
+  
+end

data/app/models/visitor.rb

@@ -0,0 +1,3 @@
+class Visitor < User
+  
+end

data/app/views/admin/users/_fields.html.haml

@@ -0,0 +1,49 @@
+= hidden_field "user", "lock_version"
+
+= render :partial => 'avatar' unless @user.new_record?
+
+= render_region :form_top, :locals => {:f => f}
+
+- render_region :form, :locals => {:f => f} do |form|
+  - form.edit_name do
+    %p
+      = f.label :name, t('name') 
+      = f.text_field :name, :class => "textbox activate", :size => 32, :maxlength => 100, :object => :user
+  
+  - form.edit_email do
+    %p
+      = f.label :email, t('email_address') , :class => "optional"
+      = f.text_field "email", :class => 'textbox', :size => 32, :maxlength => 255
+  
+  - form.edit_username do
+    %p
+      = f.label :username, t('username') 
+      = f.text_field :username, :class => "textbox", :size => 32, :maxlength => 40, :autocomplete => 'off'
+  
+  - form.edit_password do
+    = render "password_fields", :f => f
+  
+  - form.edit_roles do
+    %p
+      = f.label :new_class_name, t('role')
+      = f.text_field :new_class_name, :class => "textbox", :size => 32, :maxlength => 40, :autocomplete => 'off', :value => @user.class_name
+  
+  - form.edit_locale do
+    %p
+      = f.label :locale, t('language') 
+      = f.select "locale", available_locales_select
+  
+  - form.edit_notes do
+    %p
+      = f.label :notes, t('notes'), :class => "optional"
+      ~ f.text_area "notes", :size => "53x4", :class => "textarea"
+
+- render_region :form_bottom, :locals => {:f => f} do |form_bottom|
+  - form_bottom.edit_buttons do
+    %p.buttons
+      = save_model_button(@user)
+      = save_model_and_continue_editing_button(@user)
+      = t('or')   
+      = link_to t('cancel'), admin_users_path
+  - form_bottom.edit_timestamp do
+    = updated_stamp @user

data/app/views/admin/users/_form.html.haml

@@ -0,0 +1,6 @@
+- if @user.new_record?
+  - form_for "user", :url => admin_users_path do |f|
+    = render :partial => "fields", :locals => { :f => f }
+- else
+  - form_for "user", :url => admin_user_path(@user), :html => { :method => "put" } do |f|
+    = render :partial => "fields", :locals => { :f => f }

data/app/views/admin/users/remove.html.haml

@@ -0,0 +1,16 @@
+%h1= t('remove_user')
+
+%p 
+  = t('text.users.remove_warning')
+
+%table.index#users
+  %tbody
+    %tr.node.level_1
+      %td.user
+        %span.title= @user.name
+
+- form_tag admin_user_path(@user), :method => :delete, 'data-onsubmit_status'=>"Removing user…" do
+  %p.buttons
+    %input.button{:type=>"submit", :value => t('delete_user')}/
+    = t('or')  
+    = link_to t('cancel'), admin_users_path

data/app/views/confirmations/new.html.haml

@@ -0,0 +1,13 @@
+#single_form
+
+  %h1 Resend confirmation instructions
+
+  - form_for(resource, :as => resource_name, :url => confirmation_path(resource_name), :html => { :method => :post }) do |f|
+    %p
+      = f.label :email
+      = f.text_field :email, :class => 'password textbox', :maxlength => 40, :size => 40, :type => "email"
+    %p.buttons
+      = f.submit "Resend confirmation instructions"
+      = render "shared/links"
+
+= render "shared/version"

data/app/views/devise_mailer/confirmation_instructions.html.haml

@@ -0,0 +1,9 @@
+%p
+  Welcome 
+  =@resource.email
+
+%p
+  You can confirm your account through the link below:
+
+%p
+  = link_to 'Confirm my account', confirmation_url(@resource, :confirmation_token => @resource.confirmation_token)

data/app/views/devise_mailer/reset_password_instructions.html.haml

@@ -0,0 +1,15 @@
+%p
+  Hello
+  = @resource.email
+
+%p
+  Someone has requested a link to change your password, and you can do this through the link below.
+
+%p
+  = link_to 'Change my password', edit_password_url(@resource, :reset_password_token => @resource.reset_password_token)
+
+%p
+  If you didn't request this, please ignore this email.
+
+%p
+  Your password won't change until you access the link above and create a new one.

data/app/views/devise_mailer/unlock_instructions.html.haml

@@ -0,0 +1,12 @@
+%p
+  Hello
+  = @resource.email
+
+%p
+  Your account has been locked due to an excessive amount of unsuccessful sign in attempts.
+
+%p
+  Click the link below to unlock your account:
+
+%p
+  = link_to 'Unlock my account', unlock_url(@resource, :unlock_token => @resource.unlock_token)

data/app/views/mailer/confirmation_instructions.html.haml

@@ -0,0 +1,4 @@
+%p
+  Welcome #{@resource.email}!
+%p You can confirm your account through the link below:
+%p= link_to 'Confirm my account', confirmation_url(@resource, :confirmation_token => @resource.confirmation_token)

data/app/views/mailer/reset_password_instructions.html.haml

@@ -0,0 +1,6 @@
+%p
+  Hello #{@resource.email}!
+%p Someone has requested a link to change your password, and you can do this through the link below.
+%p= link_to 'Change my password', edit_password_url(@resource, :reset_password_token => @resource.reset_password_token)
+%p If you didn't request this, please ignore this email.
+%p Your password won't change until you access the link above and create a new one.

data/app/views/mailer/unlock_instructions.html.haml

@@ -0,0 +1,5 @@
+%p
+  Hello #{@resource.email}!
+%p Your account has been locked due to an excessive amount of unsuccessful sign in attempts.
+%p Click the link below to unlock your account:
+%p= link_to 'Unlock my account', unlock_url(@resource, :unlock_token => @resource.unlock_token)

data/app/views/passwords/edit.html.haml

@@ -0,0 +1,17 @@
+#single_form
+
+  %h1 Change your password
+
+  - form_for resource_name, resource, :url => password_path(resource_name), :html => { :method => :put } do |f|
+    = f.hidden_field :reset_password_token
+    %p
+      = f.label :password, t('new_password')
+      = f.password_field :password, :class => 'password textbox', :maxlength => 40, :size => 40
+    %p
+      = f.label :password_confirmation, t('password_confirmation')
+      = f.password_field :password_confirmation, :class => 'password textbox', :maxlength => 40, :size => 40
+    %p.buttons
+      = f.submit "Change my password"
+      = render "shared/links"
+
+= render "shared/version"