radiant-users-extension 0.0.1

data/.gitignore

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

data/README.md

@@ -0,0 +1,31 @@
+# Radiant Users Extension
+
+Hook standard Radiant users to provide front end user creation and login.
+
+A good example comes from [radiant-shop-extension](http://github.com/dirkkelly/radiant-shop-extension) in the use of customers
+
+## Create a Model
+
+    class ShopCustomer < User
+      include Users::Models::User::Scoped
+    end
+
+When a customer is created the access attributes present status will prevent them from accessing the administration system.
+
+## Define Their Welcome Page
+
+    Radiant::Config['users.shop_customer.redirect'] = '/cart'
+
+## API Access
+
+Login Candy provided us with authentication hooks allowing for API login, there is currently no login mechanism. Contributions are welcome
+
+# Installation
+
+Gemfile
+
+    gem 'radiant-users-extension', :require => nil
+    
+config/environment.rb
+
+    config.gem 'radiant-users-extension', :lib => false

data/Rakefile

@@ -0,0 +1,136 @@
+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"]
+  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."
+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"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the users extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UsersExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the users extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/config/routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+
+  map.with_options(:controller => 'admin/welcome') do |welcome|
+    welcome.login   'login',    :action => 'login'
+    welcome.logout  'logout',   :action => 'logout'
+  end
+    
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/db/migrate/20100311014641_add_api_key_to_users.rb

@@ -0,0 +1,14 @@
+class AddApiKeyToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :api_key, :string, :limit => 40, :default => ''
+    
+    User.all.each do |u|
+      u.generate_api_key
+      u.save
+    end
+  end
+
+  def self.down
+    remove_column :users, :api_key
+  end
+end

data/db/migrate/20100311021835_add_access_to_user.rb

@@ -0,0 +1,9 @@
+class AddAccessToUser < ActiveRecord::Migration
+  def self.up
+    add_column :users, :access, :string, :default => ''
+  end
+
+  def self.down
+    remove_column :users, :access
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :login_candy
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/lib/tasks/users_extension_tasks.rake

@@ -0,0 +1,54 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :users do
+      
+      desc "Runs the migration of the Users extension"
+      task :migrate => [ :environment, 'radiant:extensions:forms:migrate' ] do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          UsersExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          UsersExtension.migrator.migrate
+        end
+        Rake::Task['db:schema:dump'].invoke
+      end
+      
+      desc "Copies public assets of the Users to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from UsersExtension"
+        Dir[UsersExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(UsersExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless UsersExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from UsersExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join UsersExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = UsersExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/lib/users/lib/login_system.rb

@@ -0,0 +1,40 @@
+module Users
+  module Lib
+    module LoginSystem
+      
+      def self.included(base)
+        base.class_eval do
+          protected
+            alias_method :authorize_radiant, :authorize
+            alias_method :current_user_radiant, :current_user
+            
+            def authorize
+              if user_has_backend_access?
+                authorize_radiant
+              else
+                path = Radiant::Config["scoped.#{current_user.access}.welcome"]
+                path = "/#{path}".gsub('//','/')
+                
+                respond_to do |format|
+                  format.any(:html, :xml, :json) { redirect_to(path) }
+                end
+              end
+            end
+
+            def user_has_backend_access?
+              current_user.access.blank?
+            end
+            
+            def current_user
+              @current_user ||= (current_user_radiant || login_from_api_key)
+            end
+
+            def login_from_api_key
+              self.current_user = User.find_by_api_key(params[:api_key]) if params[:api_key].present?
+            end 
+        end
+      end
+      
+    end
+  end
+end

data/lib/users/models/user/scoped.rb

@@ -0,0 +1,15 @@
+module Users
+  module Models
+    module User
+      module Scoped
+      
+        def self.included(base)
+          base.class_eval do
+            default_scope :conditions => { :access => self.name.underscore }
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/users/models/user.rb

@@ -0,0 +1,22 @@
+module Users
+  module Models
+    module User
+      
+      def self.included(base)
+        base.class_eval do
+          attr_protected :access
+          after_initialize :generate_api_key
+          
+          def generate_api_key
+            begin
+              self.api_key = self.sha1(Time.now + Radiant::Config['session_timeout'].to_i)
+            rescue
+              logger.error "attempt to create api key failed - please migrate radiant-scoped-extension"
+            end
+          end
+        end
+      end
+      
+    end
+  end
+end

data/radiant-users-extension.gemspec

@@ -0,0 +1,63 @@
+# 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{radiant-users-extension}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christopher Rankin", "Dirk Kelly"]
+  s.date = %q{2010-11-10}
+  s.description = %q{Users creates support for non-admin users with API access}
+  s.email = %q{dk@squaretalent.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "config/routes.rb",
+     "cucumber.yml",
+     "db/migrate/20100311014641_add_api_key_to_users.rb",
+     "db/migrate/20100311021835_add_access_to_user.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "lib/tasks/users_extension_tasks.rake",
+     "lib/users/lib/login_system.rb",
+     "lib/users/models/user.rb",
+     "lib/users/models/user/scoped.rb",
+     "radiant-users-extension.gemspec",
+     "spec/datasets/scoped_users_dataset.rb",
+     "spec/models/user_spec.rb",
+     "spec/models/visitor_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "users_extension.rb"
+  ]
+  s.homepage = %q{http://github.com/dirkkelly/radiant-users-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Users Extension for Radiant CMS}
+  s.test_files = [
+    "spec/datasets/scoped_users_dataset.rb",
+     "spec/models/user_spec.rb",
+     "spec/models/visitor_spec.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::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/datasets/scoped_users_dataset.rb

@@ -0,0 +1,20 @@
+class ScopedUsersDataset < Dataset::Base
+  
+  def load
+    create_model :user, :admin, 
+      :name   => 'Admin',
+      :email  => 'admin@example.com',
+      :login  => 'admin',
+      :password               => 'radiant',
+      :password_confirmation  => 'radiant'
+      
+    create_model :user, :visitor,
+      :name   => 'Visitor',
+      :email  => 'visitor@example.com',
+      :login  => 'visitor',
+      :access => 'some_visitor',
+      :password               => 'radiant',
+      :password_confirmation  => 'radiant'
+  end
+  
+end

data/spec/models/user_spec.rb

@@ -0,0 +1,24 @@
+require 'spec/spec_helper'
+
+describe User do
+
+  dataset :users
+  
+  describe '#access attribute' do
+    it 'should be protected' do
+      @user = User.new({
+        :access => 'everything'
+      })
+      
+      @user.access.should === ''
+    end
+  end
+  
+  describe '#generate_api_key' do
+    it 'should generate an api key on initialize' do
+      @user = User.new
+      @user.api_key.should_not be_nil
+    end
+  end
+  
+end

data/spec/models/visitor_spec.rb

@@ -0,0 +1,40 @@
+require 'spec/spec_helper'
+
+class SomeVisitor < User
+  include Users::Models::User::Scoped
+end
+
+describe SomeVisitor do
+
+  dataset :scoped_users
+  
+  describe 'scope' do
+    it 'should return only users with scoped access' do
+      SomeVisitor.count.should === User.all({:conditions => { :access => 'some_visitor' } }).count
+    end
+  end
+  
+  describe 'before_save set_access filter' do
+    before :each do
+      mock.instance_of(SomeVisitor).save { true }
+    end
+    
+    context 'a new object with no access set' do
+      it 'should set access to visitor' do        
+        @visitor = SomeVisitor.new
+        @visitor.access.should === 'some_visitor'
+        @visitor.save
+        @visitor.access.should === 'some_visitor'
+      end
+    end
+    
+    context 'an existing object with access set' do
+      @visitor = SomeVisitor.new
+      @visitor.access = 'not visitor'
+      @visitor.access.should === 'not visitor'
+      @visitor.save
+      @visitor.access.should === 'not visitor'
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

data/users_extension.rb

@@ -0,0 +1,13 @@
+class UsersExtension < Radiant::Extension
+  version "0.0.1"
+  description "Users allows you to create non-admin users with API access"
+  url "http://github.com/dirkkelly/radiant-users-extension"
+
+  def activate
+    # Models
+    User.send :include, Users::Models::User
+    
+    # Controllers
+    ApplicationController.send :include, Users::Lib::LoginSystem
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-users-extension
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Christopher Rankin
+- Dirk Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-10 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Users creates support for non-admin users with API access
+email: dk@squaretalent.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- config/routes.rb
+- cucumber.yml
+- db/migrate/20100311014641_add_api_key_to_users.rb
+- db/migrate/20100311021835_add_access_to_user.rb
+- features/support/env.rb
+- features/support/paths.rb
+- lib/tasks/users_extension_tasks.rake
+- lib/users/lib/login_system.rb
+- lib/users/models/user.rb
+- lib/users/models/user/scoped.rb
+- radiant-users-extension.gemspec
+- spec/datasets/scoped_users_dataset.rb
+- spec/models/user_spec.rb
+- spec/models/visitor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- users_extension.rb
+has_rdoc: true
+homepage: http://github.com/dirkkelly/radiant-users-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Users Extension for Radiant CMS
+test_files: 
+- spec/datasets/scoped_users_dataset.rb
+- spec/models/user_spec.rb
+- spec/models/visitor_spec.rb
+- spec/spec_helper.rb