beta 0.0.3

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+spec/dummy/log/
+spec/dummy/log/*.log

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use ruby-1.9.3-p0@beta_gem

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+## 1.0.0
+
+* Public release
+* Added Beta.environments to control what environments Beta access is controlled for
+* Added specs
+
+## 0.0.2 
+
+* Internal release

data/Gemfile

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

data/README.md

@@ -0,0 +1,40 @@
+# Beta
+
+Beta is an access control library that uses a Redis whitelist to control authorization.
+
+# Install
+
+`gem install beta`
+
+or
+
+`gem 'beta'`
+
+# Usage
+
+First we setup our initializer.
+
+``` ruby
+Beta.config do |config|
+  redis = $redis
+  uid = 'mlg_id'
+  namespace    = 'awesome-app'
+  redirect_url = 'http://majorleaguegaming.com'
+  environments = [:production]
+end
+```
+
+Then, in our controller, include our access helpers and add the before filter:
+
+```
+include Beta::AccessHelpers
+before_filter :whitelist
+
+```
+
+Requires the existence of a `current_user` method.
+
+## Other helpers
+
+* `is_whitelisted?(user)` checks to see if the given user is on the list.
+* `current_user_on_whitelist?` leverages `is_whitelisted?` to tell you if the current user is special. Requires the existence of a `current_user` method.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
+end
+
+task :default => :spec

data/beta.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "beta/version"
+
+Gem::Specification.new do |s|
+  s.name        = "beta"
+  s.version     = Beta::VERSION
+  s.authors     = ["Andrew Nordman", "Logan Koester", "Matt Wilson", "David Czarnecki"]
+  s.email       = ["cadwallion@gmail.com", "lkoester@majorleaguegaming.com", "mwilson@majorleaguegaming.com", "dczarnecki@majorleaguegaming.com"]
+  s.homepage    = "https://github.com/agoragames/beta"
+  s.summary     = %q{Beta restriction gem}
+  s.description = %q{Gem to handle multiple common cases of beta rollout}
+
+  s.rubyforge_project = "beta"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rails", "~>3.1.0"
+  s.add_development_dependency "fakeredis"
+
+  s.add_dependency "redis"
+end

data/lib/beta.rb

@@ -0,0 +1,7 @@
+require "beta/version"
+require "beta/configuration"
+require "beta/access_helpers"
+
+module Beta
+  extend Configuration
+end

data/lib/beta/access_helpers.rb

@@ -0,0 +1,37 @@
+module Beta
+  # AccessHelpers encapsulates the functionality for whitespacing.  This will
+  # usually be included in ApplicationController and acccessed as before_filters
+  module AccessHelpers
+    # Uses redis whitelist and cookies to detect beta access. Redirects on failure.
+    #
+    # @param [String, nil] Location to redirect to on failure. Defaults to system config of Beta URL
+    def whitelist redirection = nil
+      return true unless Beta.environments.include?(::Rails.env)
+
+      if cookies.signed["#{Beta.namespace}-beta"] == "#{Beta.namespace}-beta-#{request.remote_addr}"
+        return true
+      end
+
+      return false unless authenticate
+
+      unless current_user_on_whitelist?
+        redirect_to(redirection || Beta.redirect_url)
+        return
+      end
+
+      cookies.signed["#{Beta.namespace}-beta"] = "#{Beta.namespace}-beta-#{request.remote_addr}"
+    end
+
+    # Uses redis whitelist to detect if the given user has beta access
+    #
+    # @param [User] the user to be checked against the list
+    def is_whitelisted? user
+      Beta.redis.sismember("#{Beta.namespace}:#{::Rails.env}:beta", user.try(Beta.uid))
+    end
+
+    # Uses `is_whitelisted?` with the value of `current_user`
+    def current_user_on_whitelist?
+      is_whitelisted? current_user
+    end
+  end
+end

data/lib/beta/configuration.rb

@@ -0,0 +1,13 @@
+module Beta
+  module Configuration
+    attr_accessor :redis, :namespace, :redirect_url, :uid, :environments
+    
+    def config
+      yield self
+    end
+
+    def environments
+      @environments ||= ["production"]
+    end
+  end
+end

data/lib/beta/version.rb

@@ -0,0 +1,3 @@
+module Beta
+  VERSION = "0.0.3"
+end

data/spec/access_helpers_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+class HelperInstance
+  include Beta::AccessHelpers
+
+  def current_user
+    User.new
+  end
+end
+
+class User
+  def uid
+    35
+  end
+end
+
+describe Beta::AccessHelpers do
+  before(:each) do
+    @redis = Redis.new
+    @redis.flushdb
+
+    Beta.config do |config|
+      config.redis = @redis
+      config.namespace = 'gem'
+      config.redirect_url = 'http://www.site.com/not-authorized'
+      config.uid = 'uid'
+    end
+  end
+
+  describe "#is_whitelisted?" do
+    it 'should return true if a user is whitelisted' do
+      user = User.new
+      helper = HelperInstance.new
+      @redis.sadd("#{Beta.namespace}:#{::Rails.env}:beta", user.uid)
+      helper.is_whitelisted?(user).should be(true)
+    end
+
+    it 'should return false if a user is not whitelisted' do
+      user = User.new
+      helper = HelperInstance.new
+      helper.is_whitelisted?(user).should be(false)
+    end
+  end
+
+  describe "current_user_on_whitelist?" do
+    it 'should return true if a user is on whitelist' do
+      helper = HelperInstance.new
+      @redis.sadd("#{Beta.namespace}:#{::Rails.env}:beta", 35)
+      helper.current_user_on_whitelist?.should be(true)
+    end
+
+    it 'should return false if a user is not the whitelist' do
+      user = User.new
+      helper = HelperInstance.new
+      helper.current_user_on_whitelist?.should be(false)
+    end
+  end
+end

data/spec/controllers/dummy_controller_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe DummyController do
+  before(:each) do
+    @redis = Redis.new
+    @redis.flushdb
+
+    Beta.config do |config|
+      config.redis = @redis
+      config.namespace = 'gem'
+      config.redirect_url = 'http://www.site.com/not-authorized'
+      config.uid = 'uid'
+      config.environments = ["test"]
+    end
+  end
+
+  it 'should redirect if user is not whitelisted' do
+    get 'index'
+
+    response.should be_redirect
+    response.should redirect_to('http://www.site.com/not-authorized')
+    response.cookies.should be_empty
+  end
+
+  it 'should not redirect if user is whitelisted' do
+    Beta.redis.sadd("#{Beta.namespace}:#{::Rails.env}:beta", 35)
+    get 'index'
+
+    response.should be_ok
+    response.cookies.should_not be_empty
+    response.cookies["#{Beta.namespace}-beta"].should_not be_nil
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,16 @@
+class DummyController < ApplicationController
+  include Beta::AccessHelpers
+  before_filter :whitelist
+  
+  def index
+    @user = params[:user] || "David"
+  end
+
+  def current_user
+    User.new
+  end
+
+  def authenticate
+    true
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User
+end

data/spec/dummy/app/views/dummy/index.html.erb

@@ -0,0 +1 @@
+Dummy#index

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test: &test
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000
+
+cucumber:
+  <<: *test

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+