micro_auth 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+Changelog:
+0.1.0:
+- Initial version.

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012 Andrew Burleson
+
+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

@@ -0,0 +1,49 @@
+# Micro Auth
+
+An absolutely tiny session-based authentication gem, for when you need to add basic admin capability to a single-user Rails app.
+
+Need something more powerful? I recommend Sorcery for Authentication and CanCan for Authorization.
+
+## Setup
+
+Micro Auth sets up a simple administrator login for your app. To set the username
+and password just define environment variables: `LOGIN_NAME` and `PASSWORD`.
+
+If you don't provide these environment variables the login name will be `example`, and the password will be `secret`.
+
+## Usage
+
+Micro Auth adds a few simple methods to your app:
+
+    authenticate # Use this in controllers as a before_filter to require login
+    admin? # Use this in controllers or views to see if the admin is logged in
+
+Micro Auth also adds two self explanatory named routes, `login` and `logout`.
+
+Tying it all together, anywhere in your app, you could do this:
+
+    - unless admin?
+    	= link_to 'Login', login_path
+    - if admin?
+    	= link_to 'Logout', logout_path
+
+## Custom login forms
+
+Micro Auth provides a default login view for your convenience, however you can stick your own login form anywhere you want. Your form just needs to post `:login` and `:pass` to `micro_auth_sessions_path` to work. Here's the most basic example.
+
+	= form_tag micro_auth_sessions_path do
+		= label_tag :login, "Login Name"
+		= text_field_tag :login
+		= label_tag :pass, "Password"
+		= text_field_tag :pass
+		= submit_tag
+
+## That's it!
+
+This readme file takes up about as much text as the entire plugin, it's really simple. If you want to override the way it works... you might as well just implement it directly in your app.
+
+Note: this works perfectly. However this is my first effort making a plugin that touches the controller layer, so I haven't figured out how to write automated tests for it yet. I'll get to that someday soon.
+
+In the mean time feel free to fork the plugin, tweak it, and submit pull requests... perhaps if your pull requests include a test suite that will help me figure out how to do automated testing on a controller plugin.
+
+Enjoy!

data/lib/micro_auth/application_controller.rb

@@ -0,0 +1,23 @@
+module MicroAuth
+	module ApplicationController
+		module ClassMethods
+			# Add class methods here in the future if needed.
+		end
+
+		module InstanceMethods
+
+			# Simple filter method to verify user is admin in controllers.
+			def authenticate
+				unless admin?
+					session[:target] = request.path
+					redirect_to login_path
+				end
+			end
+
+			# Simple method to see if user is authenticated as admin.
+			def admin?
+				session[:admin] == true
+			end
+		end
+	end
+end

data/lib/micro_auth/engine.rb

@@ -0,0 +1,13 @@
+require 'micro_auth/application_controller'
+
+module MicroAuth
+	class Engine < Rails::Engine
+		initializer 'micro_auth.app_controller' do |app|
+			ActiveSupport.on_load(:action_controller) do
+				extend MicroAuth::ApplicationController::ClassMethods
+				include MicroAuth::ApplicationController::InstanceMethods
+				ActionController::Base.helper_method :admin?
+			end
+		end
+	end
+end

data/lib/micro_auth/version.rb

@@ -0,0 +1,3 @@
+module MicroAuth
+	VERSION = "0.1.0"
+end

data/lib/micro_auth.rb

@@ -0,0 +1,5 @@
+require 'micro_auth/version'
+
+module MicroAuth
+	require 'micro_auth/engine' if defined?(Rails)
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: micro_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Burleson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &10437730 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10437730
+description: A super simple session-based authentication gem, for when you need to
+  add basic admin capability to a single-user Rails app.
+email: andrew@eighty-b.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/micro_auth/application_controller.rb
+- lib/micro_auth/engine.rb
+- lib/micro_auth/version.rb
+- lib/micro_auth.rb
+- CHANGELOG
+- README.md
+- LICENSE
+homepage: http://github.com/burlesona/micro_auth
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: An absolutely tiny authentication gem for single-admin rails apps.
+test_files: []