au_pair 1.0.0

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bantik
+
+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,53 @@
+# AuPair
+
+AuPair provides token-based authentication and versioning for Rails API applications.
+
+## Installation
+
+In your Gemfile:
+
+    gem 'au_pair'
+
+## API Authentication
+
+AuPair's authentication functionality allows you to limit access to your API to those clients that provide
+registered names and associated tokens through their request, either via headers or path variables.
+
+For header-based authentication, clients must set the `x-api-vendor` and `x-api-token` headers.
+
+For path-based authentication, clients pass in `api_token` and `api_vendor` parameters through the request. 
+
+To set up tokens, create a configuration file in config/initializers/au_pair.rb to specify client apps and their associated auth tokens:
+
+    AuPair.configure do |config|
+
+      config.tokens = {
+        'my_sample_app' => '12345'
+      }
+
+    end
+
+Then in your application controller, or in individual controllers if you want to limit authentication to certain actions:
+
+    class ApplicationController < ActionController::Base
+      include AuPair::Authenticates
+      before_filter :authenticate!
+    end
+
+## API Versioning Support
+
+Specify groups of routes per API version In your routes file:
+
+    constraints(AuPair::ApiConstraint.new('v1')) do
+      resources :widgets
+    end
+
+Client apps can then specify the API version that they want to use by passing in an `x-api-version` header or an `api_version` URL parameter.
+ 
+## 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 @@
+require "bundler/gem_tasks"

data/au_pair.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'au_pair/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "au_pair"
+  spec.version       = AuPair::VERSION
+  spec.authors       = ["Corey Ehmke"]
+  spec.email         = ["cehmke@apartments.com"]
+  spec.description   = %q{Provides API versioning and token authentication services to Apts.com client apps}
+  spec.summary       = %q{API versioning and token authentication}
+  spec.homepage      = ""
+  spec.license       = "Private"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/au_pair.rb

@@ -0,0 +1,25 @@
+require "au_pair/version"
+require "au_pair/authentication_token"
+require "au_pair/authenticates"
+require 'au_pair/api_constraint'
+
+module AuPair 
+
+  def self.configure(&block)
+    @config = Configuration.new
+    yield(config)
+  end
+
+  def self.config
+    @config || Configuration.new
+  end
+
+  def self.tokens
+    config.tokens
+  end
+
+  class Configuration
+    attr_accessor :tokens
+  end
+
+end

data/lib/au_pair/api_constraint.rb

@@ -0,0 +1,28 @@
+class AuPair::ApiConstraint
+
+  attr_accessor :numeric_version
+
+  def initialize(path_part)
+    @path_part = path_part.downcase
+    @numeric_version = path_part.gsub(/.?([0-9]+)/, "\\1").to_i
+  end
+
+  def matches?(request)
+    path_matches?(request) || header_matches?(request) || param_matches?(request)
+  end
+
+  private
+
+  def path_matches?(request)
+    ! (request.path =~ /\/#{@path_part}\//).nil?
+  end
+
+  def header_matches?(request)
+    ! (request.headers['x-api-version'] =~ /#{@numeric_version}/).nil?
+  end
+
+  def param_matches?(request)
+    request.request_parameters["api_version"].to_i == numeric_version || request.query_parameters["api_version"].to_i == numeric_version
+  end
+
+end

data/lib/au_pair/authenticates.rb

@@ -0,0 +1,16 @@
+module AuPair::Authenticates
+
+  def token
+    request.headers['x-api-token'] || params[:api_token]
+  end
+
+  def vendor_name
+    request.headers['x-api-vendor'] || params[:api_vendor]
+  end
+
+  def authenticate!
+    return true if AuPair::AuthenticationToken.valid?(token, vendor_name)
+    render(:json => {'error' => 'Invalid authentication token.'}, :status => 401) and return
+  end
+
+end

data/lib/au_pair/authentication_token.rb

@@ -0,0 +1,7 @@
+class AuPair::AuthenticationToken
+
+  def self.valid?(key, vendor)
+    AuPair.tokens[vendor] == key
+  end
+
+end

data/lib/au_pair/version.rb

@@ -0,0 +1,3 @@
+module AuPair
+  VERSION = "1.0.0"
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/authentication_token_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe AuPair::AuthenticationToken do
+
+  context 'token validation from config' do
+
+    before do
+      AuPair.configure{ |config| config.tokens = {'foo' => '1234', 'bar' => '5678'} }
+    end
+
+    it 'identifies a valid token' do
+      expect(AuPair::AuthenticationToken.valid?('1234', 'foo')).to be_true
+    end
+
+    it 'detects an invalid token' do
+      expect(AuPair::AuthenticationToken.valid?('4567', 'foo')).to be_false
+    end
+
+    it 'detects an invalid vendor' do
+      expect(AuPair::AuthenticationToken.valid?('4567', 'food')).to be_false
+    end
+
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AuPair do
+
+  it 'accepts tokens as part of its configuration' do
+    tokens = [{'foo' => '1234'}]
+    AuPair.configure{ |config| config.tokens = tokens }
+    expect(AuPair.config.tokens).to eq tokens
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'au_pair'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: au_pair
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Corey Ehmke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Provides API versioning and token authentication services to Apts.com
+  client apps
+email:
+- cehmke@apartments.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- au_pair.gemspec
+- lib/au_pair.rb
+- lib/au_pair/api_constraint.rb
+- lib/au_pair/authenticates.rb
+- lib/au_pair/authentication_token.rb
+- lib/au_pair/version.rb
+- spec/.rspec
+- spec/authentication_token_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Private
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3911207844321360357
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3911207844321360357
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: API versioning and token authentication
+test_files:
+- spec/.rspec
+- spec/authentication_token_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb