omniauth_configure 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+# OS X
+.DS_Store
+
+# Ruby
+*.gem
+Gemfile.lock

data/Gemfile

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

data/README.md

@@ -0,0 +1,61 @@
+# OmnAuth Configure
+
+Centralize OmniAuth strategy configurations on the server. This has a couple 
+advantages over storing configuration details (e.g. client secret and urls) in 
+source control or the environment for the user running the application server.
+
+* Keeping sensitive information out of source code
+* Keeping configurations where they belong (/etc)
+
+## Installation
+
+1. Add the `omniauth_configure` gem to the Gemfile
+
+## Congiguration
+
+```
+# /etc/nubic/omniauth/local.yml
+
+defaults:
+  nucats_membership:
+    site: http://membership-staging.nubic.northwestern.edu
+    authorize_url: /auth
+    token_url: /token
+nucats_assist:
+  nucats_membership:
+    client_id: abc123
+    client_secret: def456
+  facebok:
+    client_id: asdf213
+    client_secret: jimbo
+nitro:
+  nucats_membership:
+    client_id: xyz987
+    client_secret:ufw654
+```
+
+## Rack
+
+```
+# server.ru
+
+OmniauthConfigure.configure {
+  app :example
+  strategies :nucats_membership
+  central '/etc/nubic/omniauth/local.yml'
+}
+
+OmniauthConfigure::Rack.use_in(self)
+```
+
+## Rails
+
+```
+# config/environments/development.rb
+
+OmniAuthConfigure.configure {
+  app :example
+  strategies :nucats_membership
+  central '/etc/nubic/omniauth/local.yml'
+}
+```

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth_configure.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+require File.join('omniauth_configure', 'central_parameters')
+require File.join('omniauth_configure', 'configuration')
+require File.join('omniauth_configure', 'rack')
+require File.join('omniauth_configure', 'railtie') if defined?(Rails)
+
+module OmniAuthConfigure
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure(&block)
+    @configuration ||= OmniAuthConfigure::Configuration.new
+    @configuration.enhance(&block)
+  end
+end

data/lib/omniauth_configure/central_parameters.rb

@@ -0,0 +1,54 @@
+# -*- encoding : utf-8 -*-
+require 'yaml'
+
+module OmniAuthConfigure
+  class CentralParameters
+    attr_writer :entries, :raw_values
+
+    def entries
+      @entries ||= {}
+    end
+
+    def raw_values
+      @raw_values ||= {}
+    end
+
+    def initialize(file_path)
+      @raw_values = YAML::load( File.open(file_path) )
+
+      @raw_values = nested_symbolize_keys!(deep_clone(raw_values))
+    end
+
+    def [](app, provider)
+      unless entries.key?(app)
+        entries[app] = {}
+        entries[app][provider] = 
+            {}.merge((raw_values[:default] || {})[provider] || {}).
+            merge((raw_values[:defaults] || {})[provider] || {}).
+            merge((raw_values[app] || {})[provider] || {})
+      end
+      entries[app][provider]
+    end
+
+    #######
+    private
+
+    def deep_clone(src)
+      clone = { }
+      src.each_pair do |k, v|
+        clone[k] = v.is_a?(Hash) ? deep_clone(v) : v
+      end
+      clone
+    end
+
+    def nested_symbolize_keys!(target)
+      target.keys.each do |k|
+        v = target[k]
+        nested_symbolize_keys!(v) if v.respond_to?(:keys)
+        target.delete(k)
+        target[k.to_sym] = v
+      end
+      target
+    end
+  end
+end

data/lib/omniauth_configure/configuration.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+module OmniAuthConfigure
+  class Configuration < Struct.new(:app, :central)
+    attr_reader :strategies
+
+    def initialize(&config)
+      self.enhance(&config) if config
+    end
+
+    def strategies=(*strategies)
+      @strategies ||= strategies
+    end
+
+    ##
+    # Updates the configuration via the {ConfiguratorLanguage DSL}.
+    #
+    # @return [Configuration] itself
+    def enhance(&additional_config)
+      Configurator.new(self, &additional_config)
+      self
+    end
+
+    def parameters_for(app, provider)
+      ::OmniAuthConfigure::CentralParameters.new(central)[app, provider]
+    end
+  end
+
+  module ConfiguratorLanguage
+    def method_missing(m, *args, &block)
+      if @config.respond_to?(:"#{m}=")
+        @config.send(:"#{m}=", *args)
+      else
+        super
+      end
+    end
+  end
+
+  ##
+  # @private
+  class Configurator
+    include ConfiguratorLanguage
+
+    def initialize(target, &block)
+      @config = target
+      instance_eval(&block)
+    end
+  end
+end

data/lib/omniauth_configure/rack.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+module OmniAuthConfigure::Rack
+  def self.use_in(builder, configuration=nil, &block)
+    effective_configuration = configuration || OmniAuthConfigure.configuration
+    unless effective_configuration
+      fail "No configuration was provided. " <<
+        "Please set one or the other before calling use_in."
+    end
+
+    app = effective_configuration.app
+    klasses = effective_configuration.strategies
+
+    klasses.each do |klass|
+      if klass.is_a?(Class)
+        middleware = klass
+      else
+        begin
+          middleware = OmniAuth::Strategies.const_get("#{OmniAuth::Utils.camelize(klass.to_s)}")
+        rescue NameError
+          raise LoadError, "Could not find matching strategy for #{klass.inspect}. You may need to install an additional gem (such as omniauth-#{klass})."
+        end
+      end
+
+      p = effective_configuration.parameters_for(app, klass)
+
+      middleware.args [:client_id, :client_secret]
+
+      cid = p[:client_id]
+      cs  = p[:client_secret]
+      s   = p[:site]
+      au  = p[:authorize_url]
+      tu  = p[:token_url]
+
+      args = [cid, cs]
+      if s || au || tu
+        middleware.args [:client_id, :client_secret, :client_options]
+        args << {:site => s, :authorize_url => au, :token_url => tu }
+      end
+      args << {} # Last argument to provider strategy is empty hash
+
+      builder.use middleware, *args, &block
+    end
+  end
+end

data/lib/omniauth_configure/railtie.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+module OmniAuthConfigure
+  class Railtie < Rails::Railtie
+    initializer 'OmniAuthConfigure::Rails middleware installation' do |app|
+      Rails.logger.debug "Installing OmniAuthConfigure rack middleware"
+      OmniAuthConfigure::Rack.use_in(app.middleware)
+    end
+  end
+end

data/lib/omniauth_configure/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+module OmniAuthConfigure
+  VERSION = '0.1.0'
+end

data/omniauth_configure.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth_configure/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{omniauth_configure}
+  s.version = OmniAuthConfigure::VERSION
+
+  s.authors = ['John Dzak']
+  s.email = %q{j-dzak@northwestern.edu}
+  s.description = %q{Allows centralized OmniAuth strategy configurations}
+  s.summary = %q{Allows centralized OmniAuth strategy configurations}
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency 'omniauth', '~> 1.2'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+end
+

data/spec/omniauth_configure/configuration_spec.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe OmniAuthConfigure::Configuration do
+  def config_from(&block)
+    OmniAuthConfigure::Configuration.new(&block)
+  end
+
+  describe '#parameters_for' do
+    let(:config) do 
+      config_from { 
+        central File.expand_path("../test_configuration.yml", __FILE__) 
+      }
+    end
+
+    let (:northwestern) do
+      config.parameters_for(:patient_tracker, :northwestern) 
+    end
+
+    let (:facebook) do
+      config.parameters_for(:patient_tracker, :facebook)
+    end
+
+    it 'aquires the default parameters' do
+      expect(northwestern[:site]).to eq('http://northwestern.edu')
+    end
+
+    it 'aquires the parameters' do
+      expect(northwestern[:client_id]).to eq('c1980')
+      expect(facebook[:client_id]).to eq('c1995')
+    end
+
+    it 'aquires the overridden parameters' do
+      expect(northwestern[:token_url]).to eq('/override/token')
+    end
+  end
+
+  describe '#strategies' do
+    it 'stores strategies' do
+      c = config_from { strategies :northwestern, :facebook, :twitter }
+      expect(c.strategies).to eq([:northwestern, :facebook, :twitter])
+    end 
+  end
+end

data/spec/omniauth_configure/rack_spec.rb

@@ -0,0 +1,73 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+require 'omniauth'
+
+describe OmniAuthConfigure::Rack do
+  describe '#use_in' do
+    let(:builder) { OmniAuthConfigure::Spec::MockBuilder.new }
+
+    it "fails with a useful message if there's no configuration" do
+        builder.reset!
+        OmniAuthConfigure.configuration = nil
+
+        lambda { OmniAuthConfigure::Rack.use_in(builder) }.
+          should raise_error(/Please set one or the other before calling use_in./)
+      end
+
+    it 'adds middleware' do
+      OmniAuthConfigure.configure {
+        app :patient_tracker
+        strategies :northwestern, :facebook
+        central File.expand_path("../test_configuration.yml", __FILE__) 
+      }
+
+      OmniAuthConfigure::Rack.use_in(builder)
+      expect(builder.uses[0].first).to eq(OmniAuth::Strategies::Northwestern)
+      expect(builder.uses[0].first.args).to eq([:client_id, :client_secret, :client_options])
+
+      expect(builder.uses[1].first).to eq(OmniAuth::Strategies::Facebook)
+      expect(builder.uses[1].first.args).to eq([:client_id, :client_secret])
+    end
+  end
+end
+
+module OmniAuthConfigure
+  module Spec
+    ##
+    # Record only version of Rack::Builder taken
+    # from Aker
+    #
+    # @see https://github.com/NUBIC/aker
+    #      Aker: a flexible security framework for Rack (and Rails)
+    class MockBuilder
+      def reset!
+        self.uses.clear
+      end
+
+      def use(cls, *params, &block)
+        self.uses << [cls, params, block]
+      end
+
+      def uses
+        @uses ||= []
+      end
+
+      def using?(klass, *params)
+        self.uses.detect { |cls, prms, block| cls == klass && params == prms }
+      end
+
+      alias :find_use_of :using?
+    end
+  end
+end
+
+module OmniAuth
+  module Strategies
+    class Northwestern
+     include OmniAuth::Strategy
+    end
+    class Facebook
+     include OmniAuth::Strategy
+    end
+  end
+end

data/spec/omniauth_configure/test_configuration.yml

@@ -0,0 +1,13 @@
+defaults:
+  northwestern:
+    site: http://northwestern.edu
+    authorize_url: /oauth/auth
+    token_url: /oauth/token
+patient_tracker:
+  northwestern:
+    client_id: c1980
+    client_secret: kareem
+    token_url: /override/token
+  facebook:
+    client_id: c1995
+    client_secret: seagal

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+require File.join('bundler', 'setup')
+require 'rspec'
+
+require 'omniauth_configure'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: omniauth_configure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John Dzak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: 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'
+description: Allows centralized OmniAuth strategy configurations
+email: j-dzak@northwestern.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth_configure.rb
+- lib/omniauth_configure/central_parameters.rb
+- lib/omniauth_configure/configuration.rb
+- lib/omniauth_configure/rack.rb
+- lib/omniauth_configure/railtie.rb
+- lib/omniauth_configure/version.rb
+- omniauth_configure.gemspec
+- spec/omniauth_configure/configuration_spec.rb
+- spec/omniauth_configure/rack_spec.rb
+- spec/omniauth_configure/test_configuration.yml
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+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: -1431042663031854455
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1431042663031854455
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Allows centralized OmniAuth strategy configurations
+test_files: []