bona_fide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: f74be48b01fbc32e5c08c193c7963c6275ddcf95
+  data.tar.gz: 565c0042dec150887e41694211d37d1f1b3f726e
+SHA512: 
+  metadata.gz: 5a2fd4d5ee93481e31961b2f0a9c0a293e6d8149a30d6d612a78aedb2b4aaddba7e32e5c70d9df2ea10e5700a6315010d12e6ee170d57099aabfd8e734f441a8
+  data.tar.gz: 750d866dd36607929d5f5445598168cb06c9d6506bb01d7eedec8a57868529f542b4e0674bc38de425bb216c8dc835bd89dbf8e69e5242472f61a6d35f0672e7

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails', '>= 3.0'
+gem 'rake', '~> 10'
+gem 'rspec', '~> 2.14'

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    bona_fide (0.0.1.beta)
+      rack (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.4)
+    journey (1.0.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    multi_json (1.7.7)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.14)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bona_fide!
+  rails (>= 3.0)
+  rake (~> 10)
+  rspec (~> 2.14)

data/README.md

@@ -0,0 +1,57 @@
+# BonaFide
+
+[![Build Status](https://travis-ci.org/Tyr0/bona_fide.png?branch=master)](https://travis-ci.org/Tyr0/bona_fide)
+
+Low level Rack authentication enforcement.
+
+## Features
+
+BonaFide was built to bring advanced middleware functionality to all Rails apps. By providing the key functions to setup user state, limit access, and redirect others, BonaFide is a simple solution to a complex problem.
+
+Essentially, BonaFide injects it's middleware just before Rails and it's routing are called, allowing it to read the current request's cookies, and call your designated model with the requested user state cookie. By setting user state before routing is called, BonaFide allows for more inteligent routing, as well as reduce request initialization code.
+
+## Installation
+
+Install BonaFide gem
+
+```ruby
+gem install bona_fide
+```
+
+Configure BonaFide settings
+
+Create initializer in `config/initializers/bona_fide.rb`:
+
+```ruby
+BonaFide.configure do |config|
+  config.base_class = User
+  config.setter = :authenticate
+  config.cookie_name = "user_cookie"
+end
+```
+
+## Usage
+
+BonaFide provides a helper for routing via `BonaFide::Constraint` which allows for calling methods on the configured base class. For example:
+
+```ruby
+ExampleApp::Applicatoin.routes.draw do
+
+  # routes where User.admin? is true
+  constraints(BonaFide::Constraint.new(:admin?)) do
+    root to: "index#admin"
+  end
+
+  # routes where User.user? is true
+  constraints(BonaFide::Constraint.new(:user?)) do
+    root to: "index#user"
+  end
+
+  # fallback route
+  root to: "index#visitor"
+end
+```
+
+## License
+
+BonaFide is released under the [MIT License](http://www.opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Default"
+task :default => [:all]
+
+desc 'Test the engine under all supported Rails versions'
+task :all do |t|
+  exec 'rake spec'
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/bona_fide.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bona_fide/version'
+
+Gem::Specification.new do |s|
+  # human readable information
+  s.name = "bona_fide"
+  s.version = BonaFide.version
+  s.authors = ["Tyler Calderone"]
+  s.email = "bona_fide@tylercalderone.com"
+  s.homepage = "http://github.com/tyr0/bona_fide"
+  s.summary = "Low level Rack authentication enforcement"
+  # file requirements
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.extra_rdoc_files = %w(README.md)
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  # gem requirements
+  s.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+  s.add_dependency("rack", ">= 1.0")
+end

data/lib/bona_fide.rb

@@ -0,0 +1,25 @@
+require 'bona_fide/configuration'
+require 'bona_fide/constraint'
+require 'bona_fide/version'
+if defined?(Rails)
+  require 'bona_fide/engine'
+end
+
+module BonaFide
+  class << self
+    attr_accessor :config
+  end
+
+  # Configure BonaFide settings via a block
+  # 
+  #   BonaFide.configure do |config|
+  #     config.base_class = User
+  #     config.setter = :authenticate
+  #     config.cookie_name = "user_cookie"
+  #   end
+  #
+  def self.configure
+    @config ||= BonaFide::Configuration.new
+    yield config
+  end
+end

data/lib/bona_fide/configuration.rb

@@ -0,0 +1,12 @@
+module BonaFide
+  class Configuration
+    attr_accessor \
+      :base_class,
+      :cookie_name,
+      :setter
+
+    def call_setter(cookie) #:nodoc:
+      @base_class.send(@setter, cookie)
+    end
+  end
+end

data/lib/bona_fide/constraint.rb

@@ -0,0 +1,17 @@
+module BonaFide
+  class Constraint
+    # Sets up a constraint for use with <tt>ActionDispatch::Routing</tt>. Pass
+    # in a method, +getter+, to be called on the specified +base_class+ for the
+    # current <tt>BonaFide</tt> session.
+    def initialize(getter)
+      @getter = getter
+    end
+
+    # Called from <tt>ActionDispatch::Routing</tt>, calls the requested +getter+ method
+    # on the <tt>BonaFide::Configuration</tt> +base_class+. The response should be
+    # either +true+ or +false+.
+    def matches?(request)
+      BonaFide.config.base_class.send(@getter)
+    end
+  end
+end

data/lib/bona_fide/engine.rb

@@ -0,0 +1,15 @@
+# This file ensures BonaFide is loaded as middleware on application initialization
+# See: http://api.rubyonrails.org/classes/Rails/Engine.html
+require 'bona_fide/session'
+
+module BonaFide
+  # This is a subclass of <tt>Rails::Engine</tt> so that it gets
+  # called on startup of <tt>Rails</tt> applications, although
+  # the basic setup for <tt>BonaFide::Configuration</tt> is
+  # still required.
+  class Engine < Rails::Engine
+    initializer "bona_fide.initializer" do |app|
+      app.middleware.use BonaFide::Session
+    end
+  end
+end

data/lib/bona_fide/session.rb

@@ -0,0 +1,35 @@
+module BonaFide
+  class Session
+    def initialize(app)
+      @app = app
+    end
+
+    # Called on every web request,
+    def call(env)
+      @env = env
+      # reset cookies on each request
+      @cookies = nil
+
+      if cookie = get_cookie
+        BonaFide.config.call_setter(cookie)
+      end
+      
+      @app.call(env)
+    end
+    
+    private
+
+    def cookies
+      @cookies ||= @env["action_dispatch.cookies"] || Rack::Request.new(@env).cookies
+    end
+
+    def get_cookie
+      return if cookies.nil?
+
+      cookie_name = BonaFide.config.cookie_name
+      return if cookie_name.nil?
+
+      cookies[cookie_name]
+    end
+  end
+end

data/lib/bona_fide/version.rb

@@ -0,0 +1,10 @@
+module BonaFide
+  def self.version
+    Gem::Version.new("0.1.0")
+  end
+  
+  module VERSION
+    MAJOR, MINOR, TINY, PRE = BonaFide.version.segments
+    STRING = BonaFide.version.to_s
+  end
+end

data/spec/bona_fide/configuraton_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "BonaFide::Configuration" do
+  before(:all) { require 'bona_fide' }
+  
+  let (:config) { BonaFide::Configuration.new }
+
+  it "should allow read/write of :base_class" do
+    config.should respond_to(:base_class)
+    config.should respond_to(:base_class=)
+  end
+
+  it "should allow read/write of :cookie_name" do
+    config.should respond_to(:cookie_name)
+    config.should respond_to(:cookie_name=)
+  end
+
+  it "should allow read/write of :setter" do
+    config.should respond_to(:setter)
+    config.should respond_to(:setter=)
+  end
+
+  it "should reset on initialize" do
+    config.base_class.should eq(nil)
+    config.cookie_name.should eq(nil)
+    config.setter.should eq(nil)
+  end
+
+  describe "#call_base" do
+    it "should respond to :call_setter" do
+      config.should respond_to(:call_setter)
+    end
+    
+    it "should call :setter on :base_class" do
+      config.base_class = BonaFideHelper::User
+      config.setter = :authenticate
+
+      config.send(:call_setter, BonaFideHelper::User::TEST_TOKEN).should eq(true)
+    end
+  end
+end

data/spec/bona_fide/constraints_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "BonaFide::Constraint" do
+  before(:all) { require 'bona_fide' }
+
+  before(:all) {
+    intialize_default_configuration
+  }
+
+  it "should initialize with getter" do
+    expect { BonaFide::Constraint.new(:getter) }.not_to raise_error
+  end
+
+  it "should return true for true" do
+    constraint = BonaFide::Constraint.new(:true_method)
+    constraint.matches?(nil).should be(true)
+  end
+
+  it "should return false for false" do
+    constraint = BonaFide::Constraint.new(:false_method)
+    constraint.matches?(nil).should be(false)
+  end
+end

data/spec/bona_fide/engine_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "BonaFide::Engine" do
+  it "should be valid" do
+    expect { BonaFide::Engine }.not_to raise_error
+  end
+end

data/spec/bona_fide/session_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "BonaFide::Session" do
+  before(:all) { BonaFideHelper::Application.initialize! }
+  
+  it "should be valid" do
+    expect { BonaFide::Session.new(nil) }.not_to raise_error
+  end
+
+  it "should intialize fine" do
+    session = BonaFide::Session.new(BonaFideHelper::Application)
+    session.call(Rack::MockRequest.env_for("/"))
+  end
+
+  it "should read requested cookie" do
+    session = BonaFide::Session.new(BonaFideHelper::Application)
+
+    # setup mock request
+    env = Rack::MockRequest.env_for("/")
+    # add cookie to request
+    env["action_dispatch.cookies"] = {
+      BonaFideHelper::User::COOKIE_NAME => "session_spec_test"
+    }
+
+    # make sure it raises the proper error (better way to check?)
+    expect { session.call(env) }.to raise_error(StandardError, "RAISE_FOR_SUCCESS")
+  end
+end

data/spec/bona_fide_helper.rb

@@ -0,0 +1,30 @@
+module BonaFideHelper
+  class User
+    COOKIE_NAME = "user_cookie"
+    TEST_TOKEN = "test_token"
+
+    def self.authenticate(token)
+      case token
+      when BonaFideHelper::User::TEST_TOKEN.to_s
+        return true
+      when "session_spec_test"
+        raise StandardError, "RAISE_FOR_SUCCESS"
+      end
+
+      false
+    end
+
+    def self.true_method
+      true
+    end
+
+    def self.false_method
+      false
+    end
+  end
+  
+  class Application < Rails::Application
+    config.active_support.deprecation = :stderr
+    config.threadsafe!
+  end
+end

data/spec/bona_fide_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper.rb'
+
+describe "BonaFide" do
+  it "should load without errors" do
+    expect { require 'bona_fide' }.not_to raise_error
+  end
+
+  it "should be valid" do
+    BonaFide.should be_a(Module)
+  end
+  
+  it "should be configurable" do
+    intialize_default_configuration
+
+    BonaFide.config.base_class.should eq(BonaFideHelper::User)
+    BonaFide.config.setter.should eq(:authenticate)
+    BonaFide.config.cookie_name.should eq(BonaFideHelper::User::COOKIE_NAME)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rspec/expectations'
+require 'rails'
+require 'bona_fide_helper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.include RSpec::Matchers
+  config.include BonaFideHelper
+end
+
+def intialize_default_configuration
+  BonaFide.configure do |config|
+    config.base_class = BonaFideHelper::User
+    config.setter = :authenticate
+    config.cookie_name = BonaFideHelper::User::COOKIE_NAME
+  end
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: bona_fide
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tyler Calderone
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: bona_fide@tylercalderone.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bona_fide.gemspec
+- lib/bona_fide.rb
+- lib/bona_fide/configuration.rb
+- lib/bona_fide/constraint.rb
+- lib/bona_fide/engine.rb
+- lib/bona_fide/session.rb
+- lib/bona_fide/version.rb
+- spec/bona_fide/configuraton_spec.rb
+- spec/bona_fide/constraints_spec.rb
+- spec/bona_fide/engine_spec.rb
+- spec/bona_fide/session_spec.rb
+- spec/bona_fide_helper.rb
+- spec/bona_fide_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tyr0/bona_fide
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Low level Rack authentication enforcement
+test_files: 
+- spec/bona_fide/configuraton_spec.rb
+- spec/bona_fide/constraints_spec.rb
+- spec/bona_fide/engine_spec.rb
+- spec/bona_fide/session_spec.rb
+- spec/bona_fide_helper.rb
+- spec/bona_fide_spec.rb
+- spec/spec_helper.rb