simple_api_auth 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    simple_api_auth (0.0.1)
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rack (1.2.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 2.5)
+  simple_api_auth!

data/README.md

@@ -0,0 +1,27 @@
+# Simple API Key Authentication
+
+A Rack middleware and Railtie(for Rails3) for API key authentication.
+It will authenticate all requests to /api/* or /apis/*
+  
+## Usage
+
+### Gemfile
+
+  gem "simple_api_auth"
+
+### config/api_key.yml
+
+  api_key: you_api_key
+
+### Generate a random API key
+
+  rake generate
+
+### Run spec
+
+  bundle exec rspec spec
+
+## License
+
+Copyright © 2011 Wen-Tien Chang
+Licensed under the MIT: http://www.opensource.org/licenses/mit-license.php

data/Rakefile

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+require 'lib/simple_api_auth'
+
+task :generate do
+  puts SimpleApiAuth.generate
+end

data/lib/simple_api_auth.rb

@@ -0,0 +1,2 @@
+require 'simple_api_auth/simple_api_auth'
+require 'simple_api_auth/railtie' if defined?(Rails)

data/lib/simple_api_auth/railtie.rb

@@ -0,0 +1,9 @@
+module SimpleApiAuth
+  class Railtie < Rails::Railtie
+    initializer "simple_api_auth_railtie.configure_rails_initialization" do |config|
+      SimpleApiAuth::Middleware.api_key = YAML.load_file("#{Rails.root}/config/api_key.yml")["api_key"]
+      config.middleware.use SimpleApiAuth::Middleware          
+    end
+  end
+
+end

data/lib/simple_api_auth/simple_api_auth.rb

@@ -0,0 +1,35 @@
+module SimpleApiAuth
+  
+  class Middleware
+    
+    @@api_path_matcher = /^\/api\//
+    @@unauthorized_response = [401, {"Content-Type" => "text/plain"}, ["Unauthorized."]]
+    
+    def self.api_key=(key)
+      @@api_key = key
+    end
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      path  = env['PATH_INFO']
+      if path =~ @@api_path_matcher
+        api_key = env["Authorization"] || Rack::Request.new(env).params['api_key']      
+        unless api_key == @@api_key
+          return @@unauthorized_response
+        end
+      end
+      
+      @app.call(env)
+    end
+    
+  end
+  
+  def self.generate(length = 40)
+    require "digest/sha1"
+    Digest::SHA1.hexdigest(Time.now.to_s + rand(99999999).to_s)[0..length-1]
+  end
+  
+end

data/simple_api_auth.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "simple_api_auth"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Wen-Tien Chang"]
+  s.email       = ["ihower@gmail.com"]
+  s.homepage    = "http://ihower.tw"
+  s.summary     = %q{Simple API Key Authentication}
+  s.description = %q{A Rack middleware and Railtie(for Rails3) for API key authentication.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "rack"
+  s.add_development_dependency "rspec", "~> 2.5"
+end

data/spec/lib/simple_api_auth_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe SimpleApiAuth do
+    
+    before do
+      SimpleApiAuth::Middleware.api_key = "abc"
+    end
+    
+    let(:app) {
+      Rack::Builder.new do
+        use SimpleApiAuth::Middleware
+        run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]] }
+      end      
+    }
+    
+    describe SimpleApiAuth::Middleware do
+      it "should pass if request is not for /api" do
+        response = Rack::MockRequest.new(app).get('/')
+        response.status.should == 200
+      end
+      
+      it "should pass if request is authorized by header" do
+        
+        response = Rack::MockRequest.new(app).get('/api/test', "Authorization" => "abc" )
+        response.status.should == 200
+      end
+            
+      it "should pass if request is authorized by params[:api_key]" do
+        response = Rack::MockRequest.new(app).get('/api/test?api_key=abc')
+        response.status.should == 200
+      end
+      
+      it "should return 401 if request is unauthorized" do
+        response = Rack::MockRequest.new(app).get('/api/test')
+        response.status.should == 401
+      end
+    end
+    
+    describe "#generate" do
+      it "should generate a random string" do
+        SimpleApiAuth.generate.should be_a_kind_of String
+        SimpleApiAuth.generate.size.should == 40
+      end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../../lib/simple_api_auth", __FILE__)
+require 'rack/mock'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+  
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: simple_api_auth
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Wen-Tien Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id002
+description: A Rack middleware and Railtie(for Rails3) for API key authentication.
+email: 
+- ihower@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/simple_api_auth.rb
+- lib/simple_api_auth/railtie.rb
+- lib/simple_api_auth/simple_api_auth.rb
+- simple_api_auth.gemspec
+- spec/lib/simple_api_auth_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://ihower.tw
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple API Key Authentication
+test_files: 
+- spec/lib/simple_api_auth_spec.rb
+- spec/spec_helper.rb