ateam-merb-auth 0.0.1

data/LICENSE

@@ -0,0 +1,44 @@
+Copyright (c) 2008 Daniel Neighman
+
+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.
+
+Based on the Rails plugin by Rick Olsen
+
+Licence of restful_authentication
+ 
+Copyright (c) 2005 Rick Olson
+ 
+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

@@ -0,0 +1,212 @@
+MerbAuth
+=====================
+
+A slice for the Merb framework. 
+
+MerbAuth is an authentication framework for the Merb Web Framework.  
+
+Currently DataMapper and ActiveRecord supportis available.  It should be pretty easy to add your own.
+
+MerbAuth provides your model with a mixin that gives your model all the required behavior
+and links it to the controllers.  
+
+As an example.  In your normal applications model directory create your user model.
+
+class User
+  include MerbAuth::Adapter::DataMapper
+  include MerbAuth::Adapter::DataMapper::DefaultModelSetup
+end
+
+This will give the User class the required behavior and provide access to the class through
+MerbAuth[:user] for other slice authors.  To save key presses a handy constant is available
+MA.
+
+So using the MA constant you can declare your class like this
+
+class Person
+  include MA::Adapter::DataMapper
+  include MerbAuth::Adapter::DataMapper::DefaultModelSetup
+end
+
+And in your custom slice, get access to the user class with MA[:user]
+
+If you don't want to use the default setup for options.  i.e. you want to see the properties in your model, change the 
+validations or whatever, you can just enter them into your model.  To find out the required properties and validations that the
+default uses use the rake task to get a print out that you can paste into your model.
+
+rake slices:merb_auth:dm:setup # Datamapper defaults
+
+rake slices:merb_auth:ar:setup # ActiveRecord defaults
+
+===Useful Helpers
+
+The normal merb-auth helpers are available for your application, but also there is some consistent 
+helpers for other slice authors. Most notably is the controller helper
+
+:current_ma_user also aliased as :current_person, or :current_user or whatever your user class name is.
+
+=== Controllers
+
+The controllers that drive MerbAuth are always named MA::Users, and MA::Sessions
+
+These are then mapped to appropriately named routes.  
+
+=== Options
+
+See notes after installation instructions
+
+------------------------------------------------------------------------------
+
+Instructions for installation:
+
+=== Quick Install
+# config/init.rb
+dependency "merb-slices"
+dependency "merb-auth"
+
+# router
+r.add_slice(:MerbAuth, "path/to/mount/at")
+
+# Boot strap to your app
+rake slices:merb_auth:install
+
+
+=== Long Install INstructions
+
+# add the slice as a regular dependency
+
+dependency 'merb-auth'
+
+# if needed, configure which slices to load and in which order
+
+Merb::Plugins.config[:merb_slices] = { :queue => ["MerbAuth", ...] }
+
+
+
+=== Configure Your Router
+
+In config/router.rb you need to activate your brand new MerbAuth Slice.  You can do this a number of ways.
+
+The easiest way is like this:
+
+r.add_slices
+
+If you'd like to specify MerbAuth for mounting or other routeing options given in slices
+
+r.add_slice(:MerbAuth)
+
+By default this will mount the slice at /merb-auth.  So your login url will be at 
+
+/merb-auth/login
+
+If you'd like to specify a different mount point in your application do it like this.
+
+r.add_slice(:MerbAuth, 'authentcation') 
+
+Your login url will now be /authentication/login, your signup url will be at /authentication/users/new
+
+Alternatively you can just mount merb-auth directly onto your application. (Recommended)
+
+r.add_slice(:MerbAuth, :path => "", :default_routes => false)
+
+If you'd like to set more options, I suggest you look up the merb-slices documentation.
+
+
+
+=== Install your slice
+
+You need to install the slice.
+
+rake slices:merb_auth:install
+
+=== Configuring your install.
+
+If you don't have any configuration applied some simple defaults will be assumed.  You configure your installation
+by writing it to the config/slices.yml file
+
+==== Login Field
+
+By default merb-auth uses the "email" field to login.  If you want to use a different field, even one of your own,
+you can use the
+\:login_field: jid
+
+option.  This example will set the "jid" field to be the default field used for logging in.  One thing to bear in mind is
+that this needs to actually be a field in the database.
+
+==== Routing options
+
+\:route_path_model:    first choice for model route path.  defaults to "users" (used to make single_model_path and 
+
+\:route_path_session:  first choice for the sessions route path.  Defaults to "sessions"
+
+
+===== Named routes for the MA::Users resource
+
+\:user:
+  \:new:       # ||= :"new_#{single_model_name}"
+  \:show:      # ||= :"#{single_model_name}"
+  \:edit:      # ||= :"edit_#{single_model_name}"
+  \:delete:    # ||= :"delete_#{single_model_name}"
+  \:index:     # ||= :"#{plural_model_path}"
+  \:activate:  # ||= :"#{single_model_name}_activation"
+
+  
+A named route called :login, :logout and :signup are also included.
+
+
+=== Including activation emails for account verification
+
+To include activation email to your uses use the
+
+\:use_activation: true option
+
+
+To not use it either leave it out, or set it false like this
+
+\:use_activation: false
+
+
+If this option is turned off, it will just automatically complete the relevant fields
+to have an activated user.  This way, if you decide later that you'd like to include activation
+then the previously signed up users are already fully active and ready to fit into the new behavior :)
+
+There is also the subjects that you can setup for your emails
+
+\:from_email
+\:welcome_subject:       # ||= "Welcome"
+\:activation_subject:    # ||= "Please Activate Your Account"
+
+------------------------------------------------------------------------------
+
+=== Override the Views
+
+You can override the views MerbAuth provides.  Lets face it.  They're pretty  basic.
+
+To do this, you need to edit the files in the bootstrapped directories in your application.
+
+Merb.root/slices/merb-auth/app/views/
+
+==== Example
+
+To change the login form you'd head on over to 
+
+Merb.root/slices/merb-auth/app/views/users/new.html.(haml|erb)
+
+And put in your own view there.  The same is available for any of the components of merbful authentication
+
+You can also add your own overrides to the controllers similarly.  
+
+=== Using Your own Layout
+
+To setup merbful authentication to use your own layout use a before_app_loads block.  
+
+==== Example
+
+Merb::Slices.config[:merb_auth] = { :layout => :application }
+
+=== Migrations
+
+There is a migration task for merb-auth to generate your migrations.  Make sure you have use_orm selected so that
+it knows which generator to use.  Then from your host application
+
+rake slices:merb_auth:generate_migration

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb-core/version'
+require 'merb-core/test/tasks/spectasks'
+require 'merb-core/tasks/merb_rake_helper'
+
+NAME = "merb-auth"
+AUTHOR = "Merb Core"
+EMAIL = "has.sox@gmail.com"
+HOMEPAGE = "http://merbivore.com/"
+SUMMARY = "Merb Slice that provides authentication"
+GEM_VERSION = "0.1.0"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-slices', '>= 0.9.4')
+  s.add_dependency('merb-mailer', '>= 0.9.4')
+  s.add_dependency('merb_helpers', '>= 0.9.4')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,app,public,stubs,activerecord_generators,datamapper_generators,plugins}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install MerbAuth as a gem"
+task :install => [:package] do
+  sh %{#{sudo} gem install pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+  
+end

data/TODO

@@ -0,0 +1,14 @@
+TODO:
+
+- Fix MerbAuth.description and MerbAuth.version
+- Fix LICENSE with your name
+- Fix Rakefile with your name and contact info
+- Add your code to lib/merb_auth.rb
+- Add your Merb rake tasks to lib/merb_auth/merbtasks.rb
+
+Remove anything that you don't need:
+
+- app/controllers/main.rb MerbAuth::Main controller
+- app/views/layout/merb_auth.html.erb
+- spec/controllers/main_spec.rb controller specs
+- public/* any public files

data/activerecord_generators/ma_migration/ma_migration_generator.rb

@@ -0,0 +1,41 @@
+class MaMigrationGenerator < Merb::GeneratorBase
+  
+  attr_accessor :plural_name, :single_name, :time_stamp
+  
+  def initialize(runtime_args, runtime_options = {})
+    @base = File.dirname(__FILE__)
+    super
+    @name = args.shift
+  end
+  
+  def manifest
+    record do |m|
+      @m = m
+      
+      @time_stamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      @table_name = @name.split("::").last.snake_case.singularize.pluralize
+      
+      @assigns = {
+        :time_stamp => @time_stamp,
+        :class_name => @name,
+        :table_name => @table_name
+      }
+      
+      copy_dirs
+      copy_files
+    end
+    
+  end
+  
+    protected
+      def banner
+        <<-EOS
+  Creates a migration for merb-auth user model
+
+  USAGE: #{$0} #{spec.name} name"
+  EOS
+      end
+  
+end
+      
+      

data/activerecord_generators/ma_migration/templates/schema/migrations/%time_stamp%_add_ma_user.rb

@@ -0,0 +1,21 @@
+class AddMaUser < ActiveRecord::Migration
+  def self.up
+    create_table "<%= table_name %>", :force => true do |t|
+      t.column :login,                      :string
+      t.column :email,                      :string
+      t.column :crypted_password,           :string, :limit => 40
+      t.column :salt,                       :string, :limit => 40
+      t.column :created_at,                 :datetime
+      t.column :updated_at,                 :datetime
+      t.column :remember_token,             :string
+      t.column :remember_token_expires_at,  :datetime
+      t.column :activation_code,            :string, :limit => 40
+      t.column :activated_at,               :datetime
+      t.column :password_reset_key,         :string
+    end
+  end
+ 
+  def self.down
+    drop_table "<%= table_name %>"
+  end
+end

data/app/controllers/application.rb

@@ -0,0 +1,7 @@
+module MerbAuth
+  class Application < Merb::Controller
+  
+    controller_for_slice
+  
+  end
+end

data/app/controllers/sessions.rb

@@ -0,0 +1,3 @@
+class MerbAuth::Sessions < MerbAuth::Application
+
+end

data/app/controllers/users.rb

@@ -0,0 +1,3 @@
+class MerbAuth::Users < MerbAuth::Application
+  
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,64 @@
+module Merb
+  module MerbAuth
+    module ApplicationHelper
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def image_path(*segments)
+        public_path_for(:image, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def javascript_path(*segments)
+        public_path_for(:javascript, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def stylesheet_path(*segments)
+        public_path_for(:stylesheet, *segments)
+      end
+      
+      # Construct a path relative to the public directory
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def public_path_for(type, *segments)
+        File.join(::MerbAuth.public_dir_for(type), *segments)
+      end
+      
+      # Construct an app-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the host application, with added segments.
+      def app_path_for(type, *segments)
+        File.join(::MerbAuth.app_dir_for(type), *segments)
+      end
+      
+      # Construct a slice-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the slice source (Gem), with added segments.
+      def slice_path_for(type, *segments)
+        File.join(::MerbAuth.dir_for(type), *segments)
+      end
+      
+    end
+  end
+end