authority_engine 0.1.5

data/README.rdoc

@@ -0,0 +1,53 @@
+== Overview
+
+One of the things I was most looking forward to in rails 3 was the plugin / engine architecture. Recently, I sat down to figure out how to create my first engine and package it up as a gem and it took me awhile of time just to get the structure of the engine setup. It's missing a lot of the "rails" you get in a normal rails app.
+
+In it's simplest form engines are quite easy, however for a full-featured engine (such as creating a forum) there are a lot of extras that you're going to want. These are the things I spent time figuring out that I've packaged up into an easy starting point:
+
+* Namespacing models & controllers so they don't collide with those in the main app
+* Creating a global layout within your engine that gets nested within your application layout
+* Generating migrations from your engine
+* Creating an "acts_as_[plugin]" declaration for use inside your main app's models
+* Easy plugin configuration file editable from main app directory
+* Rake tasks within engine
+* Writing tests for models complete with fixtures
+* Serving static assets within engine
+* Packaging and distributing as a gem
+* Code is here - I've created an engine stub that has all the things setup for you already. I want to see a lot more rails 3 engines get created, I hope this helps! I'd love to hear feedback from you if you try it out.
+
+Here’s how you get ready to create your first gem by using this starting point:
+
+* git clone git@github.com:krschacht/rails_3_engine_demo.git
+* cd rails_3_engine_demo
+* [edit test/database.yml]
+* rake test (this will initialize your test database and run the basic test suite)
+
+Now, create a plain rails app and set it up to use your engine. FYI: even though the engine's directory is 'rails_3_engine_demo', internally the engine is named 'authority'
+
+* cd .. [ this is to take you outside the 'rails_3_engine_demo' directory that was created above' ]
+* rails new demo_app_to_use_gem -d mysql
+* cd demo_app_to_use_gem
+* [edit config/database.yml]
+* [edit Gemfile, add line: ] gem ‘authority’, :path => "../rails_3_engine_demo"
+* rails generate authority
+* [examine config/initializers/authority.rb to see basic config parameters]
+* rake db:create
+* rake db:migrate (one of the migrations that you'll see run came from the engine)
+
+You have now setup a empty rails app that utilizes your engine. To test out the functionality, startup the demo app’s webserver:
+
+* rails server
+* Then visit: http://localhost:3000/authority (this is a controller included within the engine)
+* rake authority:reports (this is a a rake task that is included inside the engine)
+
+Lastly, let's package up your engine as a real gem. You’ll need Jeweler installed for this:
+
+* cd rails_3_engine_demo
+* sudo gem install jeweler
+* rake gemspec
+* rake build
+* rake install (you have now installed your engine as a gem locally)
+* [ At this point if you wanted your demo app to use your installed gem, edit the Gemfile in your demo app and remove the 'path' option from your gem line. It should look like this: ] gem ‘authority’
+* rake gemcutter:release (this pushes your gem up to Gemcutter, a public gem repository)
+
+Now you’re ready to start customizing this engine for your own purposes. Do a global find in your engine directory and replace every instance of "authority" and "authority" with your engine name (be sure to preserve capitalization). Likewise, rename every directory and file that’s named "authority" with your engine name. I should really automate this but I haven’t figured out how to create a rake task that I can run from within the engine directory itself.

data/app/controllers/authority_controller.rb

@@ -0,0 +1,32 @@
+class AuthorityController < ActionController::Base
+
+  unloadable
+  
+  def ensure_super_admin!
+    if controller_name != "sessions"
+      super_user_role = Role.find(1)
+      if !current_user.roles.include? super_user_role
+        raise 'Unauthorized Action'
+      end  
+    end
+  end
+  
+  def ensure_admin!
+    if controller_name != "sessions"
+      admin_user_role = Role.find_by_name(ADMIN_ROLE_NAME)
+      if !current_user.roles.include? admin_user_role
+        raise 'Unauthorized Action'
+      end
+    end
+  end
+  
+  def ensure_accessible!
+    if controller_name != "sessions"
+      accessible_user_role = Role.find_by_name(ACCESSIBLE_ROLE_NAME)
+      if !current_user.roles.include? accessible_user_role
+        raise 'Unauthorized Action'
+      end
+    end
+  end
+  
+end

data/app/models/role.rb

@@ -0,0 +1,5 @@
+class Role < ActiveRecord::Base
+  establish_connection :authority
+  has_many :user_roles
+  has_many :users, :through => :user_roles
+end

data/app/models/user.rb

@@ -0,0 +1,19 @@
+class User < ActiveRecord::Base
+  establish_connection :authority
+  # Include default devise modules. Others available are:
+  # :token_authenticatable, :confirmable, :lockable and :timeoutable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable, :invitable
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation, :remember_me
+  
+  has_many :user_roles, :dependent => :destroy
+  has_many :roles, :through => :user_roles
+  
+  def admin?
+    admin_user_role = Role.find_by_name(ADMIN_ROLE_NAME)
+    current_user.roles.include? admin_user_role
+  end
+  
+end

data/app/models/user_role.rb

@@ -0,0 +1,8 @@
+class UserRole < ActiveRecord::Base
+  establish_connection :authority
+  belongs_to :user
+  belongs_to :role
+  
+  validates_presence_of :user_id
+  validates_presence_of :role_id
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do |map|
+
+  mount_at = Authority::Engine.config.mount_at
+
+  devise_for :user
+end

data/lib/application_helper.rb

@@ -0,0 +1,3 @@
+module ApplicationHelper
+  
+end

data/lib/authority_engine.rb

@@ -0,0 +1,148 @@
+module AuthorityEngine
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'devise'
+  require 'haml'
+  require 'devise_invitable'  
+    Devise.setup do |config|
+      # ==> Mailer Configuration
+      # Configure the e-mail address which will be shown in DeviseMailer.
+      config.mailer_sender = "website@ahfmr.ab.ca"
+
+      # Configure the class responsible to send e-mails.
+      # config.mailer = "Devise::Mailer"
+
+      config.invite_for = 2.weeks
+
+      # ==> ORM configuration
+      # Load and configure the ORM. Supports :active_record (default) and
+      # :mongoid (bson_ext recommended) by default. Other ORMs may be
+      # available as additional gems.
+      require 'devise/orm/active_record'
+
+      # ==> Configuration for any authentication mechanism
+      # Configure which keys are used when authenticating an user. By default is
+      # just :email. You can configure it to use [:username, :subdomain], so for
+      # authenticating an user, both parameters are required. Remember that those
+      # parameters are used only when authenticating and not when retrieving from
+      # session. If you need permissions, you should implement that in a before filter.
+      # config.authentication_keys = [ :email ]
+
+      # Tell if authentication through request.params is enabled. True by default.
+      # config.params_authenticatable = true
+
+      # Tell if authentication through HTTP Basic Auth is enabled. True by default.
+      # config.http_authenticatable = true
+
+      # Set this to true to use Basic Auth for AJAX requests.  True by default.
+      # config.http_authenticatable_on_xhr = true
+
+      # The realm used in Http Basic Authentication
+      # config.http_authentication_realm = "Application"
+
+      # ==> Configuration for :database_authenticatable
+      # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+      # using other encryptors, it sets how many times you want the password re-encrypted.
+      config.stretches = 10
+
+      # Define which will be the encryption algorithm. Devise also supports encryptors
+      # from others authentication tools as :clearance_sha1, :authlogic_sha512 (then
+      # you should set stretches above to 20 for default behavior) and :restful_authentication_sha1
+      # (then you should set stretches to 10, and copy REST_AUTH_SITE_KEY to pepper)
+      # config.encryptor = :bcrypt
+
+      # Setup a pepper to generate the encrypted password.
+      config.pepper = "32f1d04431dbac7d3d8fb42d4a3f000342c745bd774e03d4c180a627f5074412c55a02cedca0291047dd8f3db933000a5cc4b12f35686eec626a6da092ab0b07"
+
+      # ==> Configuration for :confirmable
+      # The time you want to give your user to confirm his account. During this time
+      # he will be able to access your application without confirming. Default is nil.
+      # When confirm_within is zero, the user won't be able to sign in without confirming. 
+      # You can use this to let your user access some features of your application 
+      # without confirming the account, but blocking it after a certain period 
+      # (ie 2 days). 
+      # config.confirm_within = 2.days
+
+      # ==> Configuration for :rememberable
+      # The time the user will be remembered without asking for credentials again.
+      # config.remember_for = 2.weeks
+
+      # If true, a valid remember token can be re-used between multiple browsers.
+      # config.remember_across_browsers = true
+
+      # If true, extends the user's remember period when remembered via cookie.
+      # config.extend_remember_period = false
+
+      # ==> Configuration for :validatable
+      # Range for password length
+      # config.password_length = 6..20
+
+      # Regex to use to validate the email address
+      # config.email_regexp = /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i
+
+      # ==> Configuration for :timeoutable
+      # The time you want to timeout the user session without activity. After this
+      # time the user will be asked for credentials again.
+      # config.timeout_in = 10.minutes
+
+      # ==> Configuration for :lockable
+      # Defines which strategy will be used to lock an account.
+      # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+      # :none            = No lock strategy. You should handle locking by yourself.
+      # config.lock_strategy = :failed_attempts
+
+      # Defines which strategy will be used to unlock an account.
+      # :email = Sends an unlock link to the user email
+      # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+      # :both  = Enables both strategies
+      # :none  = No unlock strategy. You should handle unlocking by yourself.
+      # config.unlock_strategy = :both
+
+      # Number of authentication tries before locking an account if lock_strategy
+      # is failed attempts.
+      # config.maximum_attempts = 20
+
+      # Time interval to unlock the account if :time is enabled as unlock_strategy.
+      # config.unlock_in = 1.hour
+
+      # ==> Configuration for :token_authenticatable
+      # Defines name of the authentication token params key
+      # config.token_authentication_key = :auth_token
+
+      # ==> Scopes configuration
+      # Turn scoped views on. Before rendering "sessions/new", it will first check for
+      # "users/sessions/new". It's turned off by default because it's slower if you
+      # are using only default views.
+      # config.scoped_views = true
+
+      # Configure the default scope given to Warden. By default it's the first
+      # devise role declared in your routes.
+      # config.default_scope = :user
+
+      # Configure sign_out behavior. 
+      # By default sign_out is scoped (i.e. /users/sign_out affects only :user scope).
+      # In case of sign_out_all_scopes set to true any logout action will sign out all active scopes.
+      # config.sign_out_all_scopes = false
+
+      # ==> Navigation configuration
+      # Lists the formats that should be treated as navigational. Formats like
+      # :html, should redirect to the sign in page when the user does not have
+      # access, but formats like :xml or :json, should return 401.
+      # If you have any extra navigational formats, like :iphone or :mobile, you
+      # should add them to the navigational formats lists. Default is [:html]
+      # config.navigational_formats = [:html, :iphone]
+
+      # ==> Warden configuration
+      # If you want to use other strategies, that are not (yet) supported by Devise,
+      # you can configure them inside the config.warden block. The example below
+      # allows you to setup OAuth, using http://github.com/roman/warden_oauth
+      #
+      # config.warden do |manager|
+      #   manager.oauth(:twitter) do |twitter|
+      #     twitter.consumer_secret = <YOUR CONSUMER SECRET>
+      #     twitter.consumer_key  = <YOUR CONSUMER KEY>
+      #     twitter.options :site => 'http://twitter.com'
+      #   end
+      #   manager.default_strategies(:scope => :user).unshift :twitter_oauth
+      # end
+    end
+end

data/lib/engine.rb

@@ -0,0 +1,24 @@
+require 'authority_engine'
+require 'rails'
+require 'action_controller'
+require 'application_helper'
+
+module Authority
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/'
+        
+    # Check the gem config
+    initializer "check config" do |app|
+
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+    
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,56 @@
+ENV["RAILS_ENV"] = "test"
+
+require 'test/unit'
+require 'rubygems'
+require 'yaml'
+require 'active_record'
+require 'mysql'
+
+require 'app/models/authority/widget.rb'
+
+def authority_widget( fixture_name )
+  id = @@fixtures['authority_widget'][ fixture_name.to_s ][ 'id' ]
+  authority::Widget.find( id )
+end
+
+def load_schema
+  config = YAML::load( IO.read( File.dirname(__FILE__) + '/database.yml') )
+
+  # Manually initialize the database
+  conn = Mysql.real_connect( config['mysql']['host'], config['mysql']['username'], config['mysql']['password'] )
+  conn.query( "CREATE DATABASE IF NOT EXISTS #{config['mysql']['database']}" )
+  
+  ActiveRecord::Base.establish_connection( config['mysql'] )
+  ActiveRecord::Base.connection()
+  
+  load(File.dirname(__FILE__) + "/../" +
+    "lib/rails/generators/authority/templates/schema.rb")
+
+  @@fixtures = {}
+  
+  load_fixture( 'authority_widget' )
+end
+
+def load_fixture( table )
+  @@fixtures[ table ] = {}
+  fixture = YAML::load( IO.read( File.dirname(__FILE__) + "/fixtures/#{table}.yml") )
+  @@fixtures[ table ] = fixture
+
+  klass = class_eval table.titleize.gsub(/ /, '::')
+
+  fixture.each do |record_name, record|
+    record.each do |column, value|
+      if ( match = column.match(/(.*)_id/) )
+        fixture_reference = "authority_" + match[1].pluralize
+        if value.is_a? Symbol
+          r = class_eval "#{fixture_reference}( '#{value}' )"
+          record[ column ] = r.id
+        end
+      end
+    end
+      
+    r = klass.create( record )
+    @@fixtures[ table ][ record_name ][ 'id' ] = r.id
+  end
+
+end

data/test/unit/widget_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class WidgetTest < Test::Unit::TestCase
+  load_schema
+
+  def test_fixtures_are_working
+    assert_equal authority_widget(:first).title, "This is the title"
+  end
+  
+    
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: authority_engine
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
+platform: ruby
+authors: 
+- Jordan Yeo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aihs_devise
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aihs_devise_invitable
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: formtastic
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: 
+email: jordan.yeo@albertainnovates.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- README.rdoc
+files: 
+- app/controllers/authority_controller.rb
+- app/models/role.rb
+- app/models/user.rb
+- app/models/user_role.rb
+- config/routes.rb
+- lib/application_helper.rb
+- lib/authority_engine.rb
+- lib/engine.rb
+- README
+- README.rdoc
+- test/test_helper.rb
+- test/unit/widget_test.rb
+has_rdoc: true
+homepage: 
+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: Authentication engine for AIHS
+test_files: 
+- test/test_helper.rb
+- test/unit/widget_test.rb