rack-token_auth 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-token_auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 iain
+
+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,83 @@
+# Rack::TokenAuth
+
+Rack middleware for using the Authorization header with token authentication.
+
+Tokens are passed in the *Authorization* header, and look like this:
+
+```
+Token token="my secret token", option_a="value_a", option_b="value_b"
+```
+
+If you use Rails, you can use the [Rails built-in
+methods](http://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token.html)
+and you don't need this gem at all.
+
+## Usage
+
+Add to your middleware chain, add it to `config.ru`:
+
+``` ruby
+require 'rack/token_auth'
+
+use Rack::TokenAuth do |token, options|
+  token == "my secret token"
+end
+
+run YourApp
+```
+
+If the block returns true, the rest of app will be invoked, if the block
+returns false, the request will halt with a 401 (Unauthorized) response.
+
+If you're using Rails, add to `config/environments/production.rb`:
+
+``` ruby
+config.middleware.use Rack::TokenAuth do |token, options|
+  # etc...
+end
+```
+
+### Optional configuration
+
+The response in case of an unauthorized request can be modified, by specifying
+a Rack app, like this:
+
+``` ruby
+unauthorized_app = lambda { |env| [ 401, {}, ["Please speak to our sales dep. for access"] }
+use Rack::TokenAuth, :unauthorized_app => unauthorized_app do |token, options|
+  # etc...
+end
+```
+
+If the authorization header is malformed, the middleware chain will also be
+halted and a 400 response will be returned. You can also specify this:
+
+``` ruby
+unprocessable_header_app = lambda { |env| [ 400, {}, ["You idiot!"] }
+use Rack::TokenAuth, :unprocessable_header_app => unprocessable_header_app do |token, options|
+  # etc...
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-token_auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-token_auth
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rack-token_auth.rb

@@ -0,0 +1 @@
+require 'rack/token_auth'

data/lib/rack/token_auth.rb

@@ -0,0 +1,63 @@
+require 'rack/token_auth/version'
+
+module Rack
+  class TokenAuth
+
+    UnprocessableHeader = Class.new(ArgumentError)
+
+    def initialize(app, options = {}, &block)
+      @app     = app
+      @options = options
+      @block   = block
+    end
+
+    def call(env)
+      if @block.call(*token_and_options(env["HTTP_AUTHORIZATION"]))
+        @app.call(env)
+      else
+        unauthorized_app.call(env)
+      end
+    rescue UnprocessableHeader => error
+      unprocessable_header_app.call(env)
+    end
+
+    def unauthorized_app
+      @options.fetch(:unauthorized_app) { default_unauthorized_app }
+    end
+
+    def unprocessable_header_app
+      @options.fetch(:unprocessable_header_app) { default_unprocessable_header_app }
+    end
+
+    def default_unprocessable_header_app
+      lambda { |env| Rack::Response.new("Unprocessable Authorization header", 400) }
+    end
+
+    def default_unauthorized_app
+      lambda { |env| Rack::Response.new("Unauthorized", 401) }
+    end
+
+    # Taken and adapted from Rails
+    # https://github.com/rails/rails/blob/master/actionpack/lib/action_controller/metal/http_authentication.rb
+    def token_and_options(header)
+      token = header.to_s.match(/^Token (.*)/) { |m| m[1] }
+      if token
+        begin
+          values = Hash[token.split(',').map do |value|
+            value.strip!                      # remove any spaces between commas and values
+            key, value = value.split(/\=\"?/) # split key=value pairs
+            value.chomp!('"')                 # chomp trailing " in value
+            value.gsub!(/\\\"/, '"')          # unescape remaining quotes
+            [key, value]
+          end]
+          [values.delete("token"), values]
+        rescue => error
+          raise UnprocessableHeader, error
+        end
+      else
+        [nil,{}]
+      end
+    end
+
+  end
+end

data/lib/rack/token_auth/version.rb

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

data/rack-token_auth.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/token_auth/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-token_auth"
+  gem.version       = Rack::TokenAuth::VERSION
+  gem.authors       = ["iain"]
+  gem.email         = ["iain@iain.nl"]
+  gem.description   = %q{Rack middleware for using the Authorization header with token authentication}
+  gem.summary       = %q{Rack middleware for using the Authorization header with token authentication}
+  gem.homepage      = "https://github.com/iain/rack-token_auth"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "rack"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/spec/rack_token_auth_spec.rb

@@ -0,0 +1,90 @@
+require 'rack'
+require 'rack/token_auth'
+
+describe Rack::TokenAuth do
+
+  Endpoint = Rack::Response.new("OK")
+
+  describe "parsing the authorization header" do
+
+    let(:block) { lambda { |token| } }
+    let(:app) { build_app(&block) }
+
+    it "evaluates the block with token and options" do
+      block.should_receive(:call).with("abc", "foo" => "bar")
+      app.call("HTTP_AUTHORIZATION" => %(Token token="abc", foo="bar"))
+    end
+
+    it "handles absent header" do
+      block.should_receive(:call).with(nil, {})
+      app.call({})
+    end
+
+    it "handles other authorization header" do
+      block.should_receive(:call).with(nil, {})
+      app.call("HTTP_AUTHORIZATION" => %(Basic QWxhZGluOnNlc2FtIG9wZW4=))
+    end
+
+    it "handles misformed authorization header" do
+      block.should_not_receive(:call)
+      result = app.call("HTTP_AUTHORIZATION" => %(Token foobar))
+      result.status.should eq 400
+    end
+
+    it "allows specifying the unprocessable header app" do
+      unprocessable_header_app = mock :unprocessable_header_app
+      app = build_app(:unprocessable_header_app => unprocessable_header_app)
+
+      unprocessable_header_app.should_receive(:call)
+      app.call("HTTP_AUTHORIZATION" => %(Token foobar))
+    end
+
+  end
+
+  context "when block returns false" do
+
+    let(:env) { mock :env, :[] => true }
+
+    it "doesn't call the rest of the app" do
+      app = build_app do false end
+      Endpoint.should_not_receive(:call)
+      app.call(env)
+    end
+
+    it "has a default response" do
+      app = build_app do false end
+      result = app.call(env)
+      result.body.should eq ["Unauthorized"]
+      result.status.should eq 401
+    end
+
+    it "is able to set the unauthorized app" do
+      unauthorized_app = mock :unauthorized_app
+      app = build_app :unauthorized_app => unauthorized_app do false end
+
+      unauthorized_app.should_receive(:call).with(env)
+      app.call(env)
+    end
+
+  end
+
+  context "when the block returns true" do
+
+    let(:env) { mock :env, :[] => true }
+
+    it "calls the rest of your app" do
+      app = build_app do true end
+      Endpoint.should_receive(:call).with(env)
+      app.call(env)
+    end
+
+  end
+
+  def build_app(*args, &block)
+    Rack::Builder.new {
+      use Rack::TokenAuth, *args, &block
+      run Endpoint
+    }
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rack-token_auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware for using the Authorization header with token authentication
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-token_auth.rb
+- lib/rack/token_auth.rb
+- lib/rack/token_auth/version.rb
+- rack-token_auth.gemspec
+- spec/rack_token_auth_spec.rb
+homepage: https://github.com/iain/rack-token_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.23
+signing_key: 
+specification_version: 3
+summary: Rack middleware for using the Authorization header with token authentication
+test_files:
+- spec/rack_token_auth_spec.rb