rack-auth-cheat 0.1.0

data/CHANGES

@@ -0,0 +1,2 @@
+= 0.1.0 - 21-Dec-2009
+* Initial release

data/MANIFEST

@@ -0,0 +1,7 @@
+CHANGES
+MANIFEST
+README
+Rakefile
+rack-auth-cheat.gemspec
+lib/rack/auth/cheat.rb
+test/test_rack_auth_cheat.rb

data/README

@@ -0,0 +1,38 @@
+= Description
+Rack middleware that authenticates requests with matching username and password
+
+= Prerequisites
+rack 1.0.0 or later
+
+= Usage
+use "Rack::Auth::Cheat", "user_field", "password_field"
+
+= Default Fields
+The default user field is "username".
+The default password field is "password".
+
+= Details
+The rack-auth-cheat library provides a Rack middleware interface which authenticates
+any request with a matching username and password. This is useful in development
+environments, especially as a way to stub out an external authentication system. Be
+sure to include this from an environment-specific file such as
+config/environments/development.rb rather than from a global configuration file such
+as config/environment.rb
+
+The call method we've defined first checks to see if the AUTH_USER
+environment variable is set. If it is, we assume that the user has
+already been authenticated and move on.
+
+If AUTH_USER is not set, and AUTH_FAIL is not set, we then check whether
+the username and password match (the "Cheat" authentication method). If
+they match, AUTH_USER is set to the username.
+
+If they don't match then the request is passed on without modification.
+AUTH_FAIL will not be set by this class.
+
+It up to the application to check for the presence of AUTH_USER and/or
+AUTH_FAIL and act as necessary.
+
+= Authors
+Daniel Berger
+Charlie O'Keefe

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rake'
+require 'rake/testtask'
+require 'rbconfig'
+ 
+desc 'Install the rack-auth-cheat library (non-gem)'
+task :install do
+  dir = File.join(CONFIG['sitelibdir'], 'rack', 'auth')
+  FileUtils.mkdir_p(dir) unless File.exists?(dir)
+  file = 'lib/rack/auth/cheat.rb'
+  FileUtils.cp_r(file, dir, :verbose => true)
+end
+ 
+desc 'Build the gem'
+task :gem do
+  spec = eval(IO.read('rack-auth-cheat.gemspec'))
+  Gem::Builder.new(spec).build
+end
+ 
+desc 'Install the rack-auth-cheat library as a gem'
+task :install_gem => [:gem] do
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+ 
+desc 'Export the git archive to a .zip, .gz and .bz2 file in your home directory'
+task :export, :output_file do |t, args|
+  file = args[:output_file]
+ 
+  sh "git archive --prefix #{file}/ --output #{ENV['HOME']}/#{file}.tar master"
+ 
+  Dir.chdir(ENV['HOME']) do
+    sh "gzip -f #{ENV['HOME']}/#{file}.tar"
+  end
+ 
+  sh "git archive --prefix #{file}/ --output #{ENV['HOME']}/#{file}.tar master"
+ 
+  Dir.chdir(ENV['HOME']) do
+    sh "bzip2 -f #{ENV['HOME']}/#{file}.tar"
+  end
+  
+  sh "git archive --prefix #{file}/ --output #{ENV['HOME']}/#{file}.zip --format zip master"
+ 
+  Dir.chdir(ENV['HOME']) do
+    sh "unzip #{file}.zip"
+    Dir.chdir(file) do
+      sh "rake gem"
+    end
+  end
+end
+ 
+Rake::TestTask.new do |t|
+   t.verbose = true
+   t.warning = true
+end

data/lib/rack/auth/cheat.rb

@@ -0,0 +1,58 @@
+module Rack
+  module Auth
+    class Cheat
+      # Creates a new Rack::Auth::Cheat object. The +user_field+ and +password_field+
+      # are the params looked for in the call method. The defaults are 'username'
+      # and 'password', respectively.
+      #
+      def initialize(app, user_field = 'username', password_field = 'password')
+        @app = app
+        @user_field = user_field
+        @password_field = password_field
+      end
+
+      # The call method we've defined first checks to see if the AUTH_USER
+      # environment variable is set. If it is, we assume that the user has
+      # already been authenticated and move on.
+      #
+      # If AUTH_USER is not set, and AUTH_FAIL is not set, we then check whether
+      # the username and password match (the "Cheat" authentication method). If
+      # they match, AUTH_USER is set to the username.
+      #
+      # If they don't match then the request is passed on without modification.
+      # AUTH_FAIL will not be set by this class.
+      #
+      # It up to the application to check for the presence of AUTH_USER and/or
+      # AUTH_FAIL and act as necessary.
+      #
+      def call(env)
+        request = Rack::Request.new(env)
+
+        user = request.params[@user_field]
+        password = request.params[@password_field]
+
+        # Only authenticate user if both the username and password fields are present
+        unless user && password
+          return @app.call(env)
+        end
+
+        # Do not authenticate if either one of these is set
+        if env['AUTH_USER'] || env['AUTH_FAIL']
+          return @app.call(env)
+        end
+
+        if user == password
+          env['AUTH_USER'] = user
+          env['AUTH_TYPE'] = "Cheat"
+          env['AUTH_TYPE_USER'] = user
+          env['AUTH_TYPE_THIS_REQUEST'] = "Cheat"
+          env['AUTH_DATETIME'] = Time.now.utc
+          
+          env.delete('AUTH_FAIL')
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/rack-auth-cheat.gemspec

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+Gem::Specification.new do |gem|
+  gem.name      = 'rack-auth-cheat'
+  gem.version   = '0.1.0'
+  gem.authors   = ["Daniel Berger", "Charlie O'Keefe"]
+  gem.email     = 'cokeefe@globe.gov'
+  gem.homepage  = 'http://www.github.com/rack-auth-cheat'
+  gem.summary   = 'Rack middleware that authenticates requests with matching username and password'
+  gem.test_file = 'test/test_rack_auth_cheat.rb'
+  gem.files     = Dir['**/*'].delete_if{ |item| item.include?('git') } 
+
+  gem.extra_rdoc_files = ['CHANGES', 'README', 'MANIFEST']
+
+  gem.add_dependency('rack', '>= 1.0.0')
+  
+  gem.description = <<-EOF
+    The rack-auth-cheat library provides a Rack middleware interface which authenticates
+    any request with a matching username and password. This is useful in development
+    environments, especially as a way to stub out an external authentication system. Be
+    sure to include this from an environment-specific file such as
+    config/environments/development.rb rather than from a global configuration file such
+    as config/environment.rb
+  EOF
+end

data/test/test_rack_auth_cheat.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'rack/auth/cheat'
+
+class TC_Rack_Auth_Cheat < Test::Unit::TestCase
+  def setup
+    @app  = 1 # Placeholder
+    @env  = 1 # Placeholder
+    @rack = Rack::Auth::Cheat.new(@app)
+  end
+
+  def test_constructor_basic
+    assert_nothing_raised{ Rack::Auth::Cheat.new(@app) }
+  end
+
+  def test_version
+    assert_equal('0.1.0', Rack::Auth::Cheat::VERSION)
+  end
+
+  def teardown
+    @rack = nil
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rack-auth-cheat
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Berger
+- Charlie O'Keefe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: "    The rack-auth-cheat library provides a Rack middleware interface which authenticates\n    any request with a matching username and password. This is useful in development\n    environments, especially as a way to stub out an external authentication system. Be\n    sure to include this from an environment-specific file such as\n    config/environments/development.rb rather than from a global configuration file such\n    as config/environment.rb\n"
+email: cokeefe@globe.gov
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
+files: 
+- CHANGES
+- lib/rack/auth/cheat.rb
+- MANIFEST
+- rack-auth-cheat.gemspec
+- Rakefile
+- README
+- test/test_rack_auth_cheat.rb
+has_rdoc: true
+homepage: http://www.github.com/rack-auth-cheat
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware that authenticates requests with matching username and password
+test_files: 
+- test/test_rack_auth_cheat.rb