rack-authentication 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-authentication.gemspec
+gemspec
+
+group :test do
+  gem "sinatra"
+  gem "rack-test"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dane Harrigan
+
+MIT License
+
+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,67 @@
+# Rack::Authentication
+
+A modular implementation of Rack::Auth
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-authentication'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-authentication
+
+## Usage
+
+    require "rack/authentication"
+    require "rack/authentication/adapters/basic"
+
+    class App < Sinatra::Base
+      use Rack::Authentication do |config|
+        config.realm "My App"
+        config.adapter Rack::Authentication::Adapters::Basic
+      end
+    end
+
+### Want to make your own custom authentication adapter?
+
+Just inherit from `Rack::Authentication::Adapters::Base`. Three methods wil be defined
+for you:
+
+* `type` -  The type of authentication (eg: Basic, Bearer)
+* `env` - The rack app's environment
+* `credentials` - The username/password of the request. This will always be an array
+
+You're required to define `good?` and `authorized?`.
+
+    # my_adapter.rb
+    class MyAdapter < Rack::Authentication::Adapters::Base
+      def good?
+        "Basic" == type
+      end
+
+      def authorized?
+        User.exists?(username: credentials[0], password: credentials[1])
+      end
+    end
+
+    # app.rb
+    class App < Sinatra::Base
+      use Rack::Authentication do |config|
+        config.realm "My App"
+        config.adapter MyAdapter
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/lib/rack-authentication.rb

@@ -0,0 +1 @@
+require "rack/authentication"

data/lib/rack-authentication/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Authentication
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/authentication.rb

@@ -0,0 +1,47 @@
+require "rack/authentication/version"
+require "rack/authentication/request"
+require "rack/authentication/config"
+require "rack/authentication/adapters/base"
+
+module Rack
+  class Authentication
+    def initialize(app)
+      @app    = app
+      @config = Config.new
+      yield(@config)
+    end
+
+    def call(env)
+      @env = env
+      @req = Request.new(env, @config)
+
+      return bad_request  unless @req.good?
+      return unauthorized unless @req.authorized?
+
+      @app.call(env)
+    end
+
+    private
+
+    def unauthorized
+      return [ 401,
+        {
+          "Content-Type"     => "text/plain",
+          "Content-Length"   => "0",
+          "WWW-Authenticate" => ('%s realm="%s"' % [@req.type, @config.realm])
+        },
+        []
+      ]
+    end
+
+    def bad_request
+      return [ 400,
+        {
+          "Content-Type"   => "text/plain",
+          "Content-Length" => "0"
+        },
+        []
+      ]
+    end
+  end
+end

data/lib/rack/authentication/adapters/base.rb

@@ -0,0 +1,19 @@
+module Rack::Authentication::Adapters
+  class Base
+    attr :type, :credentials, :env
+
+    def initialize(args={})
+      @type = args[:type]
+      @env  = args[:env]
+      @credentials = args[:credentials]
+    end
+  end
+
+  def good?
+    false
+  end
+
+  def authorized?
+    false
+  end
+end

data/lib/rack/authentication/adapters/basic.rb

@@ -0,0 +1,13 @@
+module Rack::Authentication::Adapters
+  class Basic < Base
+    def good?
+      "Basic" == type
+    end
+
+    def authorized?
+      username, password = credentials
+      return false if username.nil? || password.nil?
+      ENV["#{username.upcase}_PASSWORD"] == password
+    end
+  end
+end

data/lib/rack/authentication/config.rb

@@ -0,0 +1,9 @@
+class Rack::Authentication::Config
+	def realm(str=nil)
+		@realm ||= str
+	end
+
+	def adapter(obj=nil)
+		@adapter ||= obj
+	end
+end

data/lib/rack/authentication/request.rb

@@ -0,0 +1,44 @@
+require "base64"
+
+class Rack::Authentication::Request
+	def initialize(env, config)
+		@env     = env
+		@adapter = config.adapter.new({
+			type: type,
+			credentials: credentials,
+			env: @env
+		})
+	end
+
+	def authorized?
+		@adapter.authorized?
+	end
+
+	def good?
+		@adapter.good?
+	end
+
+	def type
+		@type ||= params[0].to_s
+	end
+
+	private
+
+	def credentials
+		return [] if params.empty?
+		@credentials ||= if "Basic" == type
+			Base64.decode64(params[1]).split(":")
+		else
+			params[1].split(":")
+		end
+	end
+
+	def params
+		@params ||= @env[authorization_key].to_s.split(" ")
+	end
+
+	def authorization_key
+		keys = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION']
+		@authorization_key ||= keys.detect { |key| @env.has_key?(key) }
+	end
+end

data/lib/rack/authentication/version.rb

@@ -0,0 +1,5 @@
+module Rack
+	class Authentication
+		VERSION = "0.0.1"
+	end
+end

data/rack-authentication.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/authentication/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dane Harrigan"]
+  gem.email         = ["dane.harrigan@gmail.com"]
+  gem.description   = %q{A modular implementation of Rack Auth}
+  gem.summary       = %q{A modular implementation of Rack Auth}
+  gem.homepage      = "https://github.com/daneharrigan/rack-authentication"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rack-authentication"
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::Authentication::VERSION
+end

data/test/rack/authentication_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+class Rack::AuthenticationTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def test_bad_request
+    header "Authorization", "Fail Token"
+    get "/"
+
+    assert_equal 400, last_response.status
+  end
+
+  def test_unauthorized
+    authorize "bad-user", "bad-password"
+    get "/"
+
+    assert_equal 401, last_response.status
+  end
+
+  def test_good_request
+    authorize "user", "secret"
+    get "/"
+
+    assert_equal 200,  last_response.status
+    assert_equal "OK", last_response.body
+  end
+
+  def app
+    App.new
+  end
+end

data/test/support/app.rb

@@ -0,0 +1,10 @@
+class App < Sinatra::Base
+  use Rack::Authentication do |c|
+    c.realm "Sample App"
+    c.adapter Rack::Authentication::Adapters::Basic
+  end
+
+  get "/" do
+    "OK"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "rack/test"
+require "sinatra/base"
+require "rack/authentication"
+require "rack/authentication/adapters/basic"
+
+require_relative "support/app"
+
+ENV["USER_PASSWORD"] = "secret"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rack-authentication
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dane Harrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies: []
+description: A modular implementation of Rack Auth
+email:
+- dane.harrigan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-authentication.rb
+- lib/rack-authentication/version.rb
+- lib/rack/authentication.rb
+- lib/rack/authentication/adapters/base.rb
+- lib/rack/authentication/adapters/basic.rb
+- lib/rack/authentication/config.rb
+- lib/rack/authentication/request.rb
+- lib/rack/authentication/version.rb
+- rack-authentication.gemspec
+- test/rack/authentication_test.rb
+- test/support/app.rb
+- test/test_helper.rb
+homepage: https://github.com/daneharrigan/rack-authentication
+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.23
+signing_key: 
+specification_version: 3
+summary: A modular implementation of Rack Auth
+test_files:
+- test/rack/authentication_test.rb
+- test/support/app.rb
+- test/test_helper.rb