capability_tokens 0.2.0

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+cache: bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Nubel
+
+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,69 @@
+# CapabilityTokens
+
+[![Build Status](https://test-travis-frontend.oak.enova.com/rnubel/capability_tokens.png?token=6cmRdX1SLVTFvWBgBbCZ&branch=master)](https://test-travis-frontend.oak.enova.com/rnubel/capability_tokens)
+
+This gem generates, stores, and helps you retrieve short-lived tokens with
+payloads. It is intended to be part of a capability link system, which allows
+users to perform actions without explicitly logging in.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capability_tokens'
+
+And then execute:
+
+    $ bundle
+
+Then, install the migrations:
+
+    $ rake capability_tokens:install:migrations
+
+And you're set! If you need to put the table this engine creates in a schema,
+create an initializer:
+
+    # config/initializers/capability_tokens.rb
+
+    CapabilityTokens.configure do |c|
+      c.schema_name = 'my_stuff'
+    end
+
+## Usage
+
+Generate a new token:
+
+    requester = 'customer-service'
+    payload   = { account_id: 1, action: 'login' }
+    cap_token = CapabilityTokens.generate(payload, requester, Time.now + 72.hours)
+
+    cap_token.token # => "82264468-6d50-454f-a257-007a89afa18b"
+
+Disseminate the token as you see fit; e.g., in a link, like
+`http://yourapp.com/do_it/82264468-6d50-454f-a257-007a89afa18b`.
+
+When a user follows that link, your controller might do:
+
+    begin
+      token = CapabilityTokens.retrieve(params[:token])
+      login_user!(token.payload[:account_id])
+    rescue CapabilityTokens::ExpiredToken
+      raise "Too late!"
+    rescue CapabilityTokens::InvalidToken
+      raise "Hacker!"
+    end
+
+Note that `CapabilityTokens::retrieve` will always raise an exception if the
+retrieved token is either nonexistant or expired. You can rescue
+`CapabilityTokens::BadToken` to catch all errors.
+
+FYI, "requester" is required as a very basic audit trail. If your needs are
+more complex, please open an issue and I'll investigate how to accomodate.
+
+## 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/app/models/capability_tokens/capability_token.rb

@@ -0,0 +1,13 @@
+module CapabilityTokens
+  class CapabilityToken < ActiveRecord::Base
+    self.table_name = CapabilityTokens.configuration.table_name
+
+    serialize :payload
+
+    validates_presence_of :token, :expires_at, :payload, :requester
+
+    def expired?(as_of = Time.now)
+      expires_at <= as_of
+    end
+  end
+end

data/capability_tokens.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capability_tokens/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capability_tokens"
+  spec.version       = CapabilityTokens::VERSION
+  spec.authors       = ["Robert Nubel"]
+  spec.email         = ["rnubel@enova.com"]
+  spec.description   = %q{Generate and validate short-lived capability tokens.}
+  spec.summary       = %q{Facilitates short-lived capability tokens for tasks like logging in without a password.}
+  spec.homepage      = "http://www.enova.com"
+  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-rails', '~> 3.0'
+  spec.add_development_dependency 'rails', '~> 3.2'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'combustion', '~> 0.5.2'
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/db/migrate/20140821110700_create_capability_tokens.rb

@@ -0,0 +1,22 @@
+class CreateCapabilityTokens < ActiveRecord::Migration
+  def up
+    create_table capability_tokens_table_name, primary_key: 'capability_token_id' do |t|
+      t.timestamps
+      t.string    :token,       null: false
+      t.string    :requester,   null: false
+      t.timestamp :expires_at,  null: false
+      t.text      :payload,     null: false # Will serialize as YAML.
+    end
+
+    add_index capability_tokens_table_name, :token, unique: true
+  end
+
+  def down
+    drop_table capability_tokens_table_name
+  end
+
+  private
+  def capability_tokens_table_name
+    CapabilityTokens.configuration.table_name
+  end
+end

data/lib/capability_tokens.rb

@@ -0,0 +1,44 @@
+require "capability_tokens/version"
+require "capability_tokens/configuration"
+require "capability_tokens/engine"
+
+require 'securerandom'
+
+module CapabilityTokens
+  BadToken     = Class.new(StandardError)
+  ExpiredToken = Class.new(BadToken)
+  InvalidToken = Class.new(BadToken)
+  NonExpiredToken = Class.new(BadToken)
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.generate(payload, requester, expires_at = Time.now + 1.day)
+    token_model.create! payload:    payload,
+                        requester:  requester,
+                        expires_at: expires_at,
+                        token:      generate_token
+  end
+
+  def self.retrieve(token_string, expired_requested = false)
+    token = token_model.where(token: token_string).first
+    raise InvalidToken if token.nil?
+    raise ExpiredToken if token.expired? && !expired_requested
+    raise NonExpiredToken if !token.expired? && expired_requested
+    token
+  end
+
+  private
+  def self.token_model
+    CapabilityTokens::CapabilityToken
+  end
+
+  def self.generate_token
+    SecureRandom.uuid
+  end
+end

data/lib/capability_tokens/configuration.rb

@@ -0,0 +1,11 @@
+module CapabilityTokens
+  class Configuration < Struct.new(:schema_name)
+    def initialize
+      self.schema_name = nil
+    end
+
+    def table_name
+      schema_name ? "#{schema_name}.capability_tokens" : "capability_tokens"
+    end
+  end
+end

data/lib/capability_tokens/engine.rb

@@ -0,0 +1,6 @@
+module CapabilityTokens
+  class Engine < Rails::Engine
+    engine_name 'capability_tokens'
+  end
+end
+

data/lib/capability_tokens/version.rb

@@ -0,0 +1,3 @@
+module CapabilityTokens
+  VERSION = "0.2.0"
+end

data/spec/capability_token_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe CapabilityTokens::CapabilityToken do
+  let(:attributes) {
+    { token: 'asdfaasdfafds',
+      requester: 'me',
+      expires_at: Time.now + 2.hours,
+      payload: { test: 'stuff' } }
+  }
+
+  it "can create" do
+    described_class.create! attributes
+  end
+
+  it "requires a token, requester, payload, and expiration date" do
+    [:token, :requester, :payload, :expires_at].each do |missing_field|
+      expect {
+        described_class.create! attributes.except(missing_field)
+      }.to raise_error
+    end
+  end
+
+  it "can deserialize the payload" do
+    t = described_class.create! attributes
+
+    reloaded = described_class.find(t.id)
+    expect(reloaded.payload[:test]).to eql('stuff')
+  end
+
+  it "enforces unique tokens" do
+    described_class.create! attributes
+    expect { described_class.create! attributes }.to raise_error
+    expect { described_class.create! attributes.merge(token: 'newtok') }.to_not raise_error
+  end
+end

data/spec/capability_tokens_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe CapabilityTokens do
+  let(:token) {
+    CapabilityTokens.generate({ account_id: 1 },
+                              'random_person',
+                              Time.now + 72.hours)
+  }
+
+  describe 'generating a new token through the API' do
+    it 'is persisted in the database' do
+      expect(token).to be_a CapabilityTokens::CapabilityToken
+      expect(token).to_not be_new_record
+    end
+
+    it 'has a 32-byte GUID for its token' do
+      expect(token.token.gsub('-','').length).to eql(32)
+    end
+
+    it 'records the requester' do
+      expect(token.requester).to eql('random_person')
+    end
+  end
+
+  describe 'retrieving a token' do
+    it 'can locate a token' do
+      expect(CapabilityTokens.retrieve(token.token)).to eql(token)
+    end
+
+    it 'raises CapabilityTokens::ExpiredToken if the token expired' do
+      token.update_column :expires_at, Time.now - 1.minute
+     
+      expect {
+        CapabilityTokens.retrieve(token.token)
+      }.to raise_error CapabilityTokens::ExpiredToken
+    end
+
+    it 'raises CapabilityTokens::InvalidToken if the token isn\'t found' do
+      expect {
+        CapabilityTokens.retrieve('notarealtoken')
+      }.to raise_error CapabilityTokens::InvalidToken
+    end
+
+    it 'raises CapabilityTokens::NonExpiredToken if the token is not expired but requested expired token' do
+      expect {
+        CapabilityTokens.retrieve(token.token, true)
+      }.to raise_error CapabilityTokens::NonExpiredToken
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe CapabilityTokens::Configuration do
+  describe '#table_name' do
+    it 'respects schema_name' do
+      subject.schema_name = 'foo'
+
+      expect(subject.table_name).to eql 'foo.capability_tokens'
+    end
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

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

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+
+Combustion.initialize! :all
+
+require 'rspec/rails'
+require 'capability_tokens'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end
+
+

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: capability_tokens
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Nubel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 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-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+description: Generate and validate short-lived capability tokens.
+email:
+- rnubel@enova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/capability_tokens/capability_token.rb
+- capability_tokens.gemspec
+- config.ru
+- db/migrate/20140821110700_create_capability_tokens.rb
+- lib/capability_tokens.rb
+- lib/capability_tokens/configuration.rb
+- lib/capability_tokens/engine.rb
+- lib/capability_tokens/version.rb
+- spec/capability_token_spec.rb
+- spec/capability_tokens_spec.rb
+- spec/configuration_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+homepage: http://www.enova.com
+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'
+      segments:
+      - 0
+      hash: -1568415840585632650
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1568415840585632650
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Facilitates short-lived capability tokens for tasks like logging in without
+  a password.
+test_files:
+- spec/capability_token_spec.rb
+- spec/capability_tokens_spec.rb
+- spec/configuration_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb