ez_auth 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hubert Liu
+
+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,44 @@
+# EasyAuth
+
+An easy(ish) way to use API tokens in your services
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_auth
+
+## Usage
+
+Set your API token for your service:
+
+    $ export API_TOKEN=your_api_token
+
+Include in your controller
+
+```ruby
+class ApplicationController < ActionController::Base
+  include EasyAuth
+  before_filter :easy_authenticate!
+end
+```
+
+Add your API token to your request header on your client:
+
+    $ curl --header "HTTP_X_API_TOKEN: your_api_token" api.yourservice.com
+
+## 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/easy_auth.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ez_auth"
+  spec.version       = EasyAuth::VERSION
+  spec.authors       = ["Hubert Liu"]
+  spec.email         = ["hubert.liu@rigor.com"]
+  spec.description   = %q{Simple Token-based security for Rails Apps}
+  spec.summary       = %q{Protect your Rails API with token-based security}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rspec-rails"
+end

data/lib/easy_auth/version.rb

@@ -0,0 +1,3 @@
+module EasyAuth
+  VERSION = "0.0.1"
+end

data/lib/easy_auth.rb

@@ -0,0 +1,25 @@
+require "easy_auth/version"
+
+module EasyAuth
+
+  def authenticate_token
+    reject_request unless authenticated?
+  end
+  alias_method :easy_authenticate!, :authenticate_token
+
+  def reject_request
+    render(:text => 'bad api token', :status => :unauthorized) and return
+  end
+
+  def authenticated?
+    request_auth_token == authentication_token
+  end
+
+  def request_auth_token
+    request.env['HTTP_X_API_TOKEN'] || params[:api_token]
+  end
+
+  def authentication_token
+    ENV.fetch('API_TOKEN') { 'DEV_TOKEN' }
+  end
+end

data/spec/easy_auth_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe EasyAuth do
+
+  describe '#authenticate!' do
+
+    context 'with correct token' do
+      it 'does not reject the request' do
+        ENV['API_TOKEN'] = 'good_token'
+        controller = FakeController.new(:request => FakeRequest.new('good_token'))
+        expect(controller).to_not receive(:reject_request)
+        controller.easy_authenticate!
+      end
+    end
+
+    context 'with wrong token' do
+      it 'returns unauthorized' do
+        ENV['API_TOKEN'] = 'THIS_WILL_NOT_MATCH_TOKEN'
+        controller = FakeController.new(:request => FakeRequest.new('bad_token'))
+        expect(controller).to receive(:render).with({:text => "bad api token", :status => :unauthorized})
+        controller.easy_authenticate!
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'easy_auth'
+require 'support/fake_controller'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/fake_controller.rb

@@ -0,0 +1,28 @@
+require 'rails/all'
+
+class FakeController < ActionController::Base
+
+  include EasyAuth
+
+  attr_reader :request
+
+  def initialize *args
+    opts = args.extract_options!
+    @request = opts.fetch(:request) { FakeRequest.new('random_token') }
+  end
+
+end
+
+class FakeRequest
+
+  attr_accessor :token
+
+  def initialize token
+    @token = token
+  end
+
+  def env
+    {'HTTP_X_API_TOKEN' => token}
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ez_auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hubert Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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-rails
+  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: Simple Token-based security for Rails Apps
+email:
+- hubert.liu@rigor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_auth.gemspec
+- lib/easy_auth.rb
+- lib/easy_auth/version.rb
+- spec/easy_auth_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_controller.rb
+homepage: ''
+licenses:
+- MIT
+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: Protect your Rails API with token-based security
+test_files:
+- spec/easy_auth_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_controller.rb