abstract_auth 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc
+*.sw[a|o|p]
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in abstract_auth.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    abstract_auth (0.0.1)
+      module_ext (~> 0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    module_ext (0.1.0)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  abstract_auth!
+  module_ext (~> 0.1.0)
+  rake (~> 0.8.7)

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Ryan Cook and Quick Left, Inc.
+
+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,110 @@
+#AbstractAuth
+
+##A Short Story
+One day you, Sir Lucius Leftfoot, are hacking your little heart out, and
+you realize that you're writing the same code over and over again to for
+your clients. So, you think to yourself, "What if I packaged this up all
+nice-like and set it free in the world for all the other knightly
+developers to use in their apps?" Quickly, you realize that you can't go
+calling...
+
+    current_user.role? :king_of_the_hood
+
+...all willy-nilly to make sure you're dealing with an administrator of
+the host application, even though that's the API you're used to using.
+What's one to do when the authentication procedures of the end-use host
+application are unknown? Have no fear - AbstractAuth is here to save
+you!
+
+##Use Case
+
+AbstractAuth is for developers creating reusable components (e.g. Rails
+3 Engine gems) that require authentication information from their host
+applications. It aims to provide a consistent and configurable API that
+you, the component creator, can setup and use, which the developer of the
+host application will need to implement, so that you can properly secure
+your functionality.
+
+##How It Works
+
+AbstractAuth works by allowing the developers implementing your tools to
+specify code blocks that will be executed to produce the desired
+response. The blocks are executed when you call them, and in the context
+in which you call them.
+
+##Examples
+
+AbstractAuth will only step in if you instruct it to. Therefore, by
+default, nothing will happen. Oh, you wanted something to happen? Try
+this somewhere in a setup area of your app...
+
+    # Your setup code defining the API you expect your users to implement
+    AbstractAuth.setup do |config|
+      config.requires :authenticated_resource
+    end
+
+Then, when you need it, you should be able to call `AbstractAuth.authenticated_resource`
+and expect the host application to have provided the code that will
+return to you the resource object that is currently authenticated (e.g.
+User). How do you go about making sure a host application complies with
+your every whim? In a Rails application, for instance, you could
+instruct them to setup an abstract_auth.rb initializer in `config/initializers`
+
+    # The user's implementation of your desired API
+    AbstractAuth.implement :authenticated_resource do
+      current_user
+    end
+
+We'll hold on to that fancy block of code and execute it at the right
+time so that we're returning you exactly what you need.
+
+Maybe, you want to create a separate login page with access to a
+super-secret web page. The part of the process that's different here is
+how you instruct your users to implement the desired functionality.
+Continuing the Rails application example, say you setup the following
+in your code...
+
+    # Your setup code defining the API you expect your users to implement
+    AbstractAuth.setup do |config|
+      config.requires :authenticate_resource, :authenticated_resource
+    end
+
+Thus, a developer might implement the following...
+
+    # The user's implementation of your desired API
+    AbstractAuth.implement :authenticated_resource do
+
+      # A fancy helper method in the host app
+      current_user
+
+    end
+
+    # The user's implementation of your desired API
+    # Note the arguments
+    AbstractAuth.implement :authenticate_resource do |username,password|
+
+      # Your user's custom authentication procedure
+      User.fancy_authenticate(username,password)
+
+    end
+
+Assuming everything goes as planned, you would be able to call...
+
+    AbstractAuth.invoke( :authenticate_resource , username , password )
+
+...to determine whether a resource was authenticated.
+
+Finally, if you make a call to expected API that the host app has not
+implemented, an `AbstractAuth::NotImplementedError` will be thrown.
+
+##Notes
+
+Remember above, when I said that AbstractAuth will, by default, not
+intrude on your code unless you set it up to do so? I lied just a
+little bit. AbstractAuth does require another gem called ModuleExt,
+which monkey-patches the Module class to add some convenience
+attributes functions. Don't be mad.
+
+##License
+
+MIT. See the LICENSE file.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+desc 'Gotta run those tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+

data/abstract_auth.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "abstract_auth/version"
+
+Gem::Specification.new do |s|
+  s.name        = "abstract_auth"
+  s.version     = AbstractAuth::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Cook"]
+  s.email       = ["ryan@quickleft.com"]
+  s.homepage    = "https://github.com/cookrn/abstract_auth"
+  s.summary     = %q{A gem to safely provide external application resources with a coherent and configurable API to a host application's authentication procedures.}
+  s.description = %q{A gem to safely provide external application resources with a coherent and configurable API to a host application's authentication procedures.}
+
+  s.rubyforge_project = "abstract_auth"
+
+  s.add_dependency "module_ext", "~> 0.1.0"
+  s.add_development_dependency "rake", "~> 0.8.7"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/abstract_auth/abstract_auth.rb

@@ -0,0 +1,21 @@
+module AbstractAuth
+
+  def self.requires(*args)
+    args.each do |required_api|
+      raise AbstractAuth::Errors::MalformedRequirementError.new('You must define a requirement with a symbol!') unless required_api.is_a?(Symbol)
+      @@requirements.push required_api
+    end
+  end
+
+  def self.implement( requirement , &blk )
+    raise AbstractAuth::Errors::MalformedImplementationError.new('You must define an implementation with a symbol!') unless requirement.is_a?(Symbol)
+    @@implementations.merge!( { requirement => blk } )
+  end
+
+  def self.invoke( method , *args )
+    raise AbstractAuth::Errors::NonRequiredImplementationCallError.new('The requested implementation was not required!') unless @@requirements.include?(method)
+    raise AbstractAuth::Errors::NotImplementedError.new('The requirement was not implemented!') unless @@implementations.has_key?(method)
+    @@implementations[method].call(args)
+  end
+
+end

data/lib/abstract_auth/errors.rb

@@ -0,0 +1,16 @@
+module AbstractAuth
+
+  module Errors
+
+    class MalformedImplementationError < StandardError; end
+
+    class MalformedRequirementError < StandardError; end
+
+    class NonRequiredImplementationCallError < StandardError; end
+
+    class NotImplementedError < StandardError; end
+
+  end
+
+end
+

data/lib/abstract_auth/version.rb

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

data/lib/abstract_auth.rb

@@ -0,0 +1,26 @@
+# Requires
+require 'module_ext'
+
+module AbstractAuth
+
+  # Autoloads
+  autoload :Errors , 'abstract_auth/errors'
+
+  # Requires
+  require 'abstract_auth/abstract_auth'
+
+  # Define our container to hold implemented APIs
+  mattr_accessor :implementations
+  @@implementations = {}
+
+  # Define our container to hold APIs required to be implemented
+  mattr_accessor :requirements
+  @@requirements = []
+
+  # Yield AbstractAuth on setup for fancy configuration
+  def self.setup
+    yield self
+  end
+
+end
+

data/test/abstract_auth_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+class AbstractAuthTest < Test::Unit::TestCase
+
+  def test_yields_self_on_setup
+    AbstractAuth.setup do |config|
+      assert_equal AbstractAuth , config
+    end
+  end
+
+  def test_only_use_symbols_to_define_requirements
+    assert_raise AbstractAuth::Errors::MalformedRequirementError do
+      AbstractAuth.setup do |config|
+        config.requires "bad_def"
+      end
+    end
+  end
+
+  def test_only_use_symbols_to_define_implementations
+    assert_raise AbstractAuth::Errors::MalformedImplementationError do
+      AbstractAuth.implement "bad_def" do
+        p "don't do this"
+      end
+    end
+  end
+
+  def test_can_add_a_requirement
+    AbstractAuth.setup do |config|
+      config.requires :authenticated_user
+    end
+    assert AbstractAuth.requirements.include? :authenticated_user
+  end
+
+  def test_can_add_multiple_requirements
+    AbstractAuth.setup do |config|
+      config.requires :authenticated_user, :authenticated_admin
+    end
+    assert AbstractAuth.requirements.include? :authenticated_user
+    assert AbstractAuth.requirements.include? :authenticated_admin
+  end
+
+  def test_can_add_implementation
+    AbstractAuth.requires :authenticated_user
+    AbstractAuth.implement :authenticated_user do
+      TestUser.new
+    end
+    assert AbstractAuth.implementations.has_key? :authenticated_user
+    assert AbstractAuth.implementations[:authenticated_user].is_a? Proc
+  end
+
+  def test_cannot_call_non_required_methods
+    assert_raise AbstractAuth::Errors::NonRequiredImplementationCallError do
+      AbstractAuth.invoke :not_required_method
+    end
+  end
+
+  def test_cannot_call_non_implemented_methods
+    assert_raise AbstractAuth::Errors::NotImplementedError do
+      AbstractAuth.requires :a_sample_method
+      AbstractAuth.invoke :a_sample_method
+    end
+  end
+
+  def test_can_invoke_requirement
+    AbstractAuth.requires :authenticate_user
+    AbstractAuth.implement :authenticate_user do |user_id,password|
+      return TestUser.new(user_id,password)
+    end
+    new_user = AbstractAuth.invoke( :authenticate_user , 'ronald' , 'macdonald' )
+    assert new_user.is_a? TestUser
+    assert_equal 'ronald' , new_user.username
+    assert_equal 'macdonald' , new_user.password
+  end
+
+end
+
+class TestUser
+  def initialize(username,password)
+    @username = username
+    @password = password
+  end
+  def username
+    @username
+  end
+  def password
+    @password
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'abstract_auth'
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: abstract_auth
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: module_ext
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+description: A gem to safely provide external application resources with a coherent and configurable API to a host application's authentication procedures.
+email: 
+- ryan@quickleft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- abstract_auth.gemspec
+- lib/abstract_auth.rb
+- lib/abstract_auth/abstract_auth.rb
+- lib/abstract_auth/errors.rb
+- lib/abstract_auth/version.rb
+- test/abstract_auth_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/cookrn/abstract_auth
+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: abstract_auth
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem to safely provide external application resources with a coherent and configurable API to a host application's authentication procedures.
+test_files: 
+- test/abstract_auth_test.rb
+- test/test_helper.rb