super_simple_admin 0.1.1

data/LICENSE

@@ -0,0 +1,16 @@
+Super Simple Admin
+Basic authentication system al a Ryan Bates screen cast on super simple authentication
+Copyright (C) 2010  Christopher Small
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README

@@ -0,0 +1,87 @@
+h1. Super Simple Admin README
+
+Super Simple Authentication is a gem which makes it super easy to encapsulate the behavior of the Ryan Bates screen cast on super simple authentication.
+
+This is still a work in progress, so don't expect too detailed instructions just yet. I'll update as things move forward.
+
+h2. Basic Usage
+
+In your ApplicationController do
+
+bc. class ApplicationController
+	include SuperSimpleAdmin::ApplicationController
+end
+
+Create a sessions controller that looks like this
+
+bc. class SessionsController
+	include SuperSimpleAdmin::SessionsController
+end
+
+Now create a app/views/sessions/new.html.haml file (you are using haml, aren't you?) that looks something like this
+
+bc. #login_form
+	%p
+		- form_tag sessions_path do
+			= label_tag :password, "Password:"
+			= password_field_tag :password
+			= submit_tag "Submit"
+
+You can now use the @admin?@ helper method in any of your views to change what website users see based on whether they are logged in and also use @authorize@ in before filters in your controllers to restrict access as you see fit.
+
+And that's it!
+
+h2. Customization, configuration and defaults
+
+So you're probably wondering how to customize this bugger. There are two easy ways to do this, and both are perfectly acceptable are interoperable. However, there are defaults for everything so that you can get up and running without having to think. You'll obviously at least want to set your own password once in production though.
+
+h3. Hash access
+
+The innards of this gem refer to the @SuperSimpleAdmin.config@ hash for all of the configurable settings. As such (by way of example), you can specify or access settings like this
+
+bc. SuperSimpleAdmin.config[:password] = "verysecret"
+SuperSimpleAdmin.config[:password] == params[:password]
+
+Cake right?
+
+h3. Configuration file
+
+When the parent SuperSimpleAdmin module is loaded it looks to see if there is a admin_config.yml file in your config directory and if there is loads it up for you. Anything set here will override gem defaults. This is only loaded once though, which means you can still use hash access later on in your code to modify config parameters (as above).
+
+Environment independent settings are specified within all_environments, while environment specific setting are set within @RAILS_ENV@ as below
+
+bc. all_environments:
+	password: somewhatsecret
+	unauthorization_message: "You are not authorized to view this page"
+production:
+	password: verysecret
+
+
+h3. Defaults
+
+The default options are as follows
+
+bc. SuperSimpleAdmin.config = {
+  :password => "secret",
+  :unauthorized_message => "Unauthorized access",
+  :unauthorized_redirect => "/",
+  :login_success_message => "Successfully logged in",
+  :login_success_redirect => "/",
+  :login_failure_message => "Incorrect password",
+  :login_failures_redirect => "sessions/new",
+  :logout_message => "Logout successful",
+  :logout_redirect => "/"
+}
+
+h2. TODO
+
+These are the ideas I have for improvements. If you feel inspired to help with any of them, fork and send a request. I'd especially appreciate help with speccing, as I have no experience speccing gems (even a shove in the right direction here would be great).
+
+* Want to have a generator for the new sessions page.
+* Consider if there is a way to be more supportive of gems like cancan
+* Auto setup of login and logout routes
+* Specs
+
+h3. Fixes
+
+* Add @helper_method :admin@ to ApplicationController

data/lib/super_simple_admin.rb

@@ -0,0 +1,78 @@
+# Parent Module. Right now just contains the ApplicationController and
+# SessionsController submodules.
+module SuperSimpleAdmin
+  # This sets default configuration parameters for the gem and
+  # makes them accessible in the application through the
+  # SuperSimpleAdmin.config hash
+  class << self; attr_accessor :config end
+  @config = {
+    :password => "secret",
+    :unauthorized_message => "Unauthorized access",
+    :unauthorized_redirect => "/",
+    :login_success_message => "Successfully logged in",
+    :login_success_redirect => "/",
+    :login_failure_message => "Incorrect password",
+    :login_failure_redirect => "/sessions/new",
+    :logout_message => "Logout successful",
+    :logout_redirect => "/"
+  }
+  # This sets the Admin variables based off of the values set in the
+  # admin_config.yml file if there is one and overrides any default
+  # values set above
+  begin
+    raw_config = File.read(RAILS_ROOT + "/config/admin_config.yml")
+    yml = YAML.load(raw_config)
+    @config.merge yml["all_environments"].symbolize_keys
+    @config.merge yml[RAILS_ENV].symbolize_keys
+  rescue Errno::ENOENT
+  end
+  
+  # Load this module into your application controller
+  module ApplicationController
+    # Sets up the admin? helper method for use in views
+    def self.included(controller)
+      controller.send :helper_method, :admin?
+    end
+    protected
+    # This method can be used in before 
+    # filters in other controllers to restrict access.
+    # May update this later to be operable with
+    # CanCan or AuthLogic.
+    def authorize
+      unless admin?
+        flash[:notice] = SuperSimpleAdmin.config[:unauthorized_message]
+        redirect_to SuperSimpleAdmin.config[:unauthorized_redirect]
+        false
+      end
+    end
+    # The admin method tells us whether we are logged in.
+    def admin?
+      session[:password] == SuperSimpleAdmin.config[:password]
+    end
+  end
+  
+  
+  # This contains code for the sessions controller to hook into
+  module SessionsController
+    def create
+      session[:password] = params[:password]
+      if session[:password] == SuperSimpleAdmin.config[:password]
+        flash[:notice] = SuperSimpleAdmin.config[:login_success_message]
+        redirect_to SuperSimpleAdmin.config[:login_success_redirect]
+      else 
+        flash[:notice] = SuperSimpleAdmin.config[:login_failure_message]
+        redirect_to SuperSimpleAdmin.config[:login_failure_redirect]
+      end
+    end
+
+    def destroy
+      reset_session
+      flash[:notice] = SuperSimpleAdmin.config[:logout_message]
+      redirect_to SuperSimpleAdmin.config[:logout_redirect]
+    end
+
+    def new
+
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: super_simple_admin
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Christopher Small
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Provides super simple authentication al a Ryan Bates old screen cast. Creates admin access feature which allows for a single password login for admin tool access.
+email: metasoarous@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Changelog
+- LICENSE
+- lib/super_simple_admin.rb
+has_rdoc: true
+homepage: http://www.sharp-logic.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Provides super simple authentication al a Ryan Bates old screen cast.
+test_files: []
+