omniauth-provider_registry 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c32c19d94554fc08b000e1eec80173685d24a7b
+  data.tar.gz: d7b487fa28c965bdf7271e039df49e3db1b5a090
+SHA512:
+  metadata.gz: 5216d8afd696c41ba90b591465108b2d542ce4a51771385273e8ae3b78ac6030414ee3403e7432c73730bd49b4815b294f1b7db50f6194327a1bd7026fa8520f
+  data.tar.gz: a5f9a791cc8b4a55b12e1ad72695b2d6741a263484d7971932f505026dc6fc7bb63901766b97a47e5398f2afcca710018254cf19e9e370b844b1ed128f54ad37

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem "actionpack", "~> 3.2"
+gem "byebug"
+gem "minitest"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joshua Flanagan
+
+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 @@
+# OmniAuth::ProviderRegistry
+
+Provides access to your application's configured OmniAuth providers
+
+## Motivation
+
+Your configured providers contain a lot of information that may be useful in
+other parts of your application. Sometimes you specify the information when you
+configure the provider, so you already have access to it. But there is also
+some information built into the strategy itself, that is not easy to access.
+
+The `ProviderRegistry` allows you to retrieve all information available for
+your configured strategies.
+
+## Usage
+
+```
+configured_provider = OmniAuth::ProviderRegistry.find(:github)
+configured_provider.options.client_id           # 1234567890123234
+configured_provider.options.client_options.site # https://api.github.com
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-provider_registry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-provider_registry
+
+
+## Contributing
+
+1. Fork it ( https://github.com/joshuaflanagan/omniauth-provider_registry/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test

data/lib/omniauth/provider_registry.rb

@@ -0,0 +1,25 @@
+require 'omniauth'
+require "omniauth/provider_registry/version"
+require "omniauth/provider_registry/registry"
+require "omniauth/provider_registry/rack_middleware_source"
+require "omniauth/provider_registry/rails_middleware_source"
+
+module OmniAuth
+  module ProviderRegistry
+    def self.find(name)
+      registry.find(name)
+    end
+
+    def self.registry
+      @registry ||= Registry.new(source.providers)
+    end
+
+    def self.source
+      if defined?(Rails)
+        RailsMiddlewareSource
+      else
+        RackMiddlewareSource
+      end
+    end
+  end
+end

data/lib/omniauth/provider_registry/rack_middleware_source.rb

@@ -0,0 +1,9 @@
+module OmniAuth
+  module ProviderRegistry
+    class RackMiddlewareSource
+      def self.providers
+        raise "Support for non-Rails applications has not been implemented yet"
+      end
+    end
+  end
+end

data/lib/omniauth/provider_registry/rails_middleware_source.rb

@@ -0,0 +1,25 @@
+require 'omniauth'
+
+module OmniAuth
+  module ProviderRegistry
+    class RailsMiddlewareSource
+      def self.providers
+        new(Rails.application.config.middleware).providers
+      end
+
+      def initialize(middlewares)
+        @middlewares = middlewares
+      end
+
+      def providers
+        builders = @middlewares.select{|m| m === OmniAuth::Builder }.flat_map{|b|
+          b.build(nil).instance_variable_get(:@use)
+        }
+        direct = @middlewares.select{|m| m.klass.is_a?(Class) && m.klass <= OmniAuth::Strategy}.map{|s|
+          ->{ s.build(nil) }
+        }
+        builders + direct
+      end
+    end
+  end
+end

data/lib/omniauth/provider_registry/registry.rb

@@ -0,0 +1,23 @@
+module OmniAuth
+  module ProviderRegistry
+    class Registry
+      attr_reader :factory_methods
+
+      def initialize(factory_methods)
+        @factory_methods = factory_methods
+      end
+
+      def find(name)
+        factory = factories_by_name[name.to_sym]
+        factory.call if factory
+      end
+
+      def factories_by_name
+        @factories_by_name ||= factory_methods.each_with_object({}){|f, all|
+          name = f.call.name.to_sym
+          all[name] = f
+        }
+      end
+    end
+  end
+end

data/lib/omniauth/provider_registry/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module ProviderRegistry
+    VERSION = "0.8.0"
+  end
+end

data/omniauth-provider_registry.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/provider_registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-provider_registry"
+  spec.version       = OmniAuth::ProviderRegistry::VERSION
+  spec.authors       = ["Joshua Flanagan"]
+  spec.email         = ["joshuaflanagan@gmail.com"]
+  spec.summary       = %q{Provides access to your configured OmniAuth providers}
+  spec.homepage      = "https://github.com/joshuaflanagan/omniauth-provider_registry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'omniauth', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/provider_registry_spec.rb

@@ -0,0 +1,30 @@
+require 'minitest/autorun'
+require 'omniauth/provider_registry'
+
+describe OmniAuth::ProviderRegistry do
+  describe "determining the source of providers" do
+    it "uses RailsMiddlewareSource in Rails application" do
+      Rails = OpenStruct.new(application: Object.new)
+
+      source = OmniAuth::ProviderRegistry.source
+
+      source.must_equal OmniAuth::ProviderRegistry::RailsMiddlewareSource
+    end
+
+    it "uses RackMiddlewareSource when not in Rails application" do
+      source = OmniAuth::ProviderRegistry.source
+
+      source.must_equal OmniAuth::ProviderRegistry::RackMiddlewareSource
+    end
+
+    before do
+      @original_rails_const = Object.__send__(:remove_const, :Rails) if defined?(Rails)
+    end
+
+    after do
+      Object.__send__(:remove_const, :Rails) if defined?(Rails)
+      Object.__send__(:const_set, "Rails", @original_rails_const) if @original_rails_const
+    end
+  end
+
+end

data/spec/rails_middleware_source_spec.rb

@@ -0,0 +1,94 @@
+require 'minitest/autorun'
+require 'omniauth/provider_registry/rails_middleware_source'
+require 'action_dispatch/middleware/stack'
+
+describe OmniAuth::ProviderRegistry::RailsMiddlewareSource do
+  def configured_middlewares
+    @configured_middlewares ||=
+      begin
+        stack = ActionDispatch::MiddlewareStack.new
+        stack.use UnrelatedMiddleware1
+        stack.use Strength
+        stack.use OmniAuth::Builder do
+          provider ConfiguredViaBuilder1, "X", "Y"
+          provider :configured_via_builder2, "A", "B"
+        end
+        stack.use Charisma, "CLIENT_ID", "SECRET"
+        stack.use UnrelatedMiddleware2
+        stack.use OmniAuth::Builder do
+          provider ConfiguredViaBuilder3
+        end
+        stack.use Dexterity, "CLIENT_ID", "SECRET", favorite_color: "red"
+      end
+  end
+
+  require 'byebug'
+  it "returns factory methods for all OmniAuth middleware" do
+    source = OmniAuth::ProviderRegistry::RailsMiddlewareSource.new(configured_middlewares)
+    provider_factories = source.providers
+    provider_factories.length.must_equal 6
+    provider_factories.each do |factory|
+      factory.must_respond_to :call
+    end
+  end
+
+  it "factory methods successfully return instances of strategies" do
+    source = OmniAuth::ProviderRegistry::RailsMiddlewareSource.new(configured_middlewares)
+    instances = source.providers.map{|p| p.call }
+    instances.length.must_equal 6
+    instances.each do |configured_provider|
+      configured_provider.must_be_kind_of OmniAuth::Strategy
+    end
+  end
+
+  it "providers added via 'use' have their configured values" do
+    stack = ActionDispatch::MiddlewareStack.new
+    stack.use Dexterity, "lorem", "ipsum",
+        favorite_color: "green", favorite_number: 5
+
+    source = OmniAuth::ProviderRegistry::RailsMiddlewareSource.new(stack)
+    provider = source.providers.first.call
+    provider.options["arg1"].must_equal "lorem"
+    provider.options["arg2"].must_equal "ipsum"
+    provider.options["site"].must_equal "http://example.com"
+    provider.options["favorite_color"].must_equal "green"
+    provider.options["favorite_number"].must_equal 5
+  end
+
+  it "providers added via OmniAuth::Builder have their configured values" do
+    stack = ActionDispatch::MiddlewareStack.new
+    stack.use OmniAuth::Builder do
+      provider Dexterity, "lorem", "ipsum",
+        favorite_color: "green", favorite_number: 5
+    end
+    source = OmniAuth::ProviderRegistry::RailsMiddlewareSource.new(stack)
+    provider = source.providers.first.call
+    provider.options["arg1"].must_equal "lorem"
+    provider.options["arg2"].must_equal "ipsum"
+    provider.options["site"].must_equal "http://example.com"
+    provider.options["favorite_color"].must_equal "green"
+    provider.options["favorite_number"].must_equal 5
+  end
+end
+
+class FakeStrategy
+  include OmniAuth::Strategy
+  args [:first_arg, :second_arg]
+end
+
+class Strength < FakeStrategy; end
+class Charisma < FakeStrategy; end
+class Dexterity < FakeStrategy
+  include OmniAuth::Strategy
+  args [:arg1, :arg2]
+  option :site, "http://example.com"
+  option :favorite_color, "blue"
+end
+
+class ConfiguredViaBuilder1 < FakeStrategy; end
+class OmniAuth::Strategies::ConfiguredViaBuilder2 < FakeStrategy; end
+class ConfiguredViaBuilder3
+  include OmniAuth::Strategy
+end
+class UnrelatedMiddleware1; end
+class UnrelatedMiddleware2; end

data/spec/registry_spec.rb

@@ -0,0 +1,35 @@
+require 'minitest/autorun'
+require 'omniauth/provider_registry/registry'
+
+describe OmniAuth::ProviderRegistry::Registry do
+  describe "when asked to find a provider it doesn't know about" do
+    it "returns nil" do
+      registry = OmniAuth::ProviderRegistry::Registry.new([])
+      registry.find(:unknown_provider).must_be_nil
+    end
+  end
+
+  describe "when asked to find a provider it does know about" do
+    def provider_factories
+      @provider_factories ||= [
+        -> { OpenStruct.new(name: "red") },
+        -> { OpenStruct.new(name: "orange") },
+        -> { OpenStruct.new(name: "yellow") },
+      ]
+    end
+
+    it "returns an instance of a configured strategy" do
+      registry = OmniAuth::ProviderRegistry::Registry.new(provider_factories)
+      provider = registry.find("orange")
+
+      provider.wont_be_nil
+      provider.name.to_s.must_equal "orange"
+    end
+
+    it "finds instances by symbol name" do
+      registry = OmniAuth::ProviderRegistry::Registry.new(provider_factories)
+      provider = registry.find(:orange)
+      provider.wont_be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-provider_registry
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Joshua Flanagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- joshuaflanagan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/provider_registry.rb
+- lib/omniauth/provider_registry/rack_middleware_source.rb
+- lib/omniauth/provider_registry/rails_middleware_source.rb
+- lib/omniauth/provider_registry/registry.rb
+- lib/omniauth/provider_registry/version.rb
+- omniauth-provider_registry.gemspec
+- spec/provider_registry_spec.rb
+- spec/rails_middleware_source_spec.rb
+- spec/registry_spec.rb
+homepage: https://github.com/joshuaflanagan/omniauth-provider_registry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides access to your configured OmniAuth providers
+test_files:
+- spec/provider_registry_spec.rb
+- spec/rails_middleware_source_spec.rb
+- spec/registry_spec.rb