rack-auth 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3636f14f64b0dcc8e9fa7b8b54a8f0f93cf4b0f6
+  data.tar.gz: dde899f25266ea6610350ab71bae36b6f272cee3
+SHA512:
+  metadata.gz: d05cddb7cb85bbfc9b74e1c05a280ac62952707d682279097af1c07a3447f53d6dd5fd3ac844fe9fb91a081f1fcb7fc4f38afc74f6c67e65138c1633c333a717
+  data.tar.gz: a6ca077e40c9ef7029f556c82e8f117b9c0786676a671bf2514fd1959b00c2ff0a50b58a5aecb7768b97dfb59a5d50999c5d0f366beeeddbcca5cdcb21471b17

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Symer
+
+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,84 @@
+# Rack::Auth
+
+Rackish authentication for Rack apps.
+
+## Why
+
+There is no simple authentication gem in existence. Current ones implement more than what's required, provide poor access to basic auth data, and have too many dependencies.
+
+While I say this general thing about most software, it rings true for this gem. `rack-auth` provides a simple addition to `Rack::Request` that handles reading the `Authorization` header. Nothing more. `rack-auth` doesn't try to handle persistence, token generation, nor token granting.
+
+`rack/auth` also beats its competitors on amount of code. There's ~60 SLOC in `rack/auth` and closer to 500 for other gems.
+
+## Usage
+
+`rack-auth` uses token handlers to allow a developer to write their own token lookup code.
+
+Token handlers are **optional**, **defined by token type** and **return a hash** containing auth information:
+    
+    # If a handler is not given
+    # Rack::Request#auth will return client-provided
+    # auth data in a hash
+
+    Rack::Request::AuthHandlers.bearer do |token|
+      # Look up `token`
+    end
+    
+    Rack::Request::AuthHandlers.mac do |token|
+      # Look up `token`
+    end
+    
+    # You probably don't need this handler.
+    Rack::Request::AuthHandlers.basic do |username, password|
+      # Look up username and password
+    end
+    
+You can put handlers *anywhere*, as long as the class variable is assigned before `Rack::Request#auth` is called. I'd put them inside a class definition like below. (You should put it anywhere global/semi-global)
+    
+    class MyApp
+      ### put handlers here
+  
+      def call env
+        [200, {}, ["Hello world!"]]
+      end
+    end
+    
+Then you can access auth information on each `Rack::Request`:
+    
+    r = Rack::Request.new env
+    r.auth # gets auth from `authenticator` block
+    r.authenticated! # raises TokenPresenceError if auth is nil (invalid)
+    r.authenticated?
+    
+`rack-auth` throws errors:
+
+* `Rack::TokenPresenceError` - The request is unauthorized.
+* `Rack::TokenValidityError` - The authorization is bad.
+
+You can catch them and/or use things like Sansom's `Sansomable#error` method or Sinatra's error catching contraption
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-auth
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/sansomrb/rack-auth/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rack/auth.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require "rack"
+require "base64"
+
+module Rack
+  TokenPresenceError = Class.new StandardError
+  TokenValidityError = Class.new StandardError
+  class Request
+    class AuthHandlers
+      TOKENS = [:basic, :bearer, :mac].freeze
+      NIL_BLOCK = lambda { |*_| nil }.freeze
+      
+      def self.blocks
+        @@blocks ||= nil
+        @@blocks = {} if @@blocks.nil?
+        @@blocks
+      end
+      
+      def self.method_missing meth, *args, &block
+        super unless TOKENS.include? meth
+        blocks[meth] = block
+      end
+      
+      def self.[] type
+        return NIL_BLOCK unless TOKENS.include? type
+        blocks[type] || NIL_BLOCK
+      end
+      
+      def self.reset!
+        blocks.clear
+      end
+      
+      def self.delete! type
+        blocks.delete type
+      end
+    end
+    
+	  def auth
+      return @auth if @auth
+      return nil if @env["HTTP_AUTHORIZATION"].to_s.empty?
+
+      type, token = @env["HTTP_AUTHORIZATION"].split(" ", 2).map(&:strip)
+      type = type.strip.downcase.to_sym
+      
+      raise TokenValidityError, "Invalid token type." unless AuthHandlers::TOKENS.include? type
+      raise TokenValidityError, "Authorization data cannot have a zero length." if token.empty?
+      
+      args = case type
+      when :bearer, :mac then { "token" => token }
+      when :basic then Hash[["username","password"].zip(Base64.decode64(token).split(":"))]
+      end
+      
+      @auth ||= AuthHandlers[type].call(*args.values) || args
+	  end
+    
+    def authenticated?
+      !auth.nil?
+    end
+  
+	  def authenticated!
+			raise TokenPresenceError, "No valid token provided." if auth.nil?
+	    auth
+	  end
+  end
+end

data/rack-auth.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-auth"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Nathaniel Symer"]
+  spec.email         = ["nate@natesymer.com"]
+  spec.summary       = "Rackish authentication for Rack apps."
+  spec.description   = spec.summary + " " + "Provides access to the `Authorization` HTTP header."
+  spec.homepage      = "https://github.com/sansomrb/rack-auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/auth_spec.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require_relative "./spec_helper.rb"
+
+describe Rack::Request do
+  context "when reading auth information" do
+    context "with a handler" do
+      it "reads basic auth headers" do
+        Rack::Request::AuthHandlers.basic { |username, password| { "this" => "that" } }
+        expect(@basic.authenticated?).to be_truthy
+        expect(@basic.auth).to_not be_empty
+        expect(@basic.auth["this"]).to eq("that")
+        Rack::Request::AuthHandlers.delete! :basic
+      end
+      
+      it "reads OAuth 2 (bearer) auth headers" do
+        Rack::Request::AuthHandlers.bearer { |token| { "this" => "that" } }
+        expect(@bearer.authenticated?).to be_truthy
+        expect(@bearer.auth).to_not be_empty
+        expect(@bearer.auth["this"]).to eq("that")
+        Rack::Request::AuthHandlers.delete! :bearer
+      end
+    end
+    
+    context "without a handler" do
+      it "reads basic auth headers" do
+        expect(@basic.authenticated?).to be_truthy
+        expect(@basic.auth).to_not be_empty
+      end
+    
+      it "reads OAuth 2 (bearer) auth headers" do
+        expect(@bearer.authenticated?).to be_truthy
+        expect(@bearer.auth).to_not be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "rspec"
+
+module Setup
+  require_relative File.dirname(File.dirname(__FILE__)) + "/lib/rack/auth.rb"
+  require "rack"
+  require "stringio"
+  
+  def auth_env auth_str
+    @env = {
+      "HTTP_AUTHORIZATION" => auth_str,
+      "CONTENT_TYPE" => "text/plain",
+      "QUERY_STRING" => "",
+      "REQUEST_METHOD" => "GET",
+      "REQUEST_PATH" => "/",
+      "REQUEST_URI" => "/",
+      "HTTP_HOST" => "localhost:2000",
+      "SERVER_NAME" => "localhost",
+      "SERVER_PORT" => "2000",
+      "PATH_INFO" => "/",
+      "rack.url_scheme" => "http",
+      "rack.input" => StringIO.new
+    }
+  end
+end
+
+RSpec.configure do |c|
+  c.include Setup
+  c.before :each do
+    @basic = Rack::Request.new auth_env("Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==")
+    @bearer = Rack::Request.new auth_env("Bearer d6503c9fdd3ee788cd749eee130f0927")
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rack-auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathaniel Symer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Rackish authentication for Rack apps. Provides access to the `Authorization`
+  HTTP header.
+email:
+- nate@natesymer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/auth.rb
+- rack-auth.gemspec
+- spec/auth_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sansomrb/rack-auth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rackish authentication for Rack apps.
+test_files:
+- spec/auth_spec.rb
+- spec/spec_helper.rb