registrar 0.0.1.alpha → 0.0.2.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aaaffc536d54dfded534286d5d7f0520f2e293f
-  data.tar.gz: 8018ff192a4cceccc8d5340a3f8d3c1ff296f34e
+  metadata.gz: 9f413572ed2bac2448931df73018fadc01778795
+  data.tar.gz: 090638ae3e238888f75927ed70da14e891ff81d2
 SHA512:
-  metadata.gz: 0bcd8c5426ae1b9181a26e9895e638111d3ad4c89b4edf8087b8b640620615ed752f24f90cd6ac57e9529082502fcabff9e808773a76c169e3bd69a0c25ec751
-  data.tar.gz: ab2cb5cecbb5f1c1736ab80cfce3cddceed39bb1411fb479b302760cd1c4dbdaa5650467fc2e30161d473514cbbe502241e7c101f6bade5859c668aef5b45b06
+  metadata.gz: 41717567d87d943da6342e616257369ae6e2f43f91ffa31faf8e293fa90c01451df6224a642a32758d87f9488ccbb44e4ada0e50e95c3b023762826c2bfd7ea6
+  data.tar.gz: 1e82ad6b625df0038bf959334525d3909e1467b4e148f7c287eeb811b1a9bfc54a1f5d24f8e2c3b12346bb14dd40837dfc3f0f8251190c2741097497a59ef858

data/README.md

@@ -1,5 +1,19 @@
+[github]: https://github.com/JanOwiesniak/registrar
+[doc]: http://rubydoc.info/github/JanOwiesniak/registrar/master/file/README.md
+[gem]: https://rubygems.org/gems/registrar
+[gem-badge]: https://img.shields.io/gem/v/registrar.svg
+[rack-playground]: https://github.com/JanOwiesniak/rack-playground/blob/master/lib/app_builder.rb
+
 # Registrar
 
+[![Gem Version][gem-badge]][gem]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
+
+# Description
+
 Registrar standardizes Authentication Responses through Rack Middleware and works well with common authentication mechanisms like OmniAuth.
 
 ## Installation
@@ -20,11 +34,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Click [here][rack-playground] to see how to use the different components.
+
+## Short summary of the components
+
+### Gatekeeper
+
+It normalizes the interface.
+
+## Adapter
+
+It normalizes the response.
+
+## ProfileFactory
+
+It passes the normalized response to a profile factory and stores a hash version
+of the returned object in the env.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/registrar/fork )
+1. Fork it ( https://github.com/JanOwiesniak/registrar/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`)

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new(:specs) do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :specs

data/lib/registrar.rb

@@ -1,7 +1,7 @@
 require "registrar/version"
 require 'registrar/adapter'
-require 'registrar/profile_builder'
-require 'registrar/profile_gateway_stub'
+require 'registrar/gatekeeper'
+require 'registrar/profile_factory'
 require 'registrar/debug'
 
 module Registrar

data/lib/registrar/adapter/omni_auth.rb

@@ -13,52 +13,41 @@ module Registrar
       private
 
       def try_to_normalize_auth(env)
-        if env["omniauth.auth"]
-          env['registrar.auth'] = AuthNormalizer.normalized(env)
+        if auth = env['omniauth.auth']
+          env['registrar.auth'] = AuthNormalizer.normalized(auth)
         end
       end
 
       class AuthNormalizer
-        def self.normalized(env)
-          normalizer = new(env)
-          normalizer.send(:normalize)
-          normalizer.send(:normalized)
+        def self.normalized(auth)
+          new(auth).normalize
         end
 
-        private
-
-        attr_reader :auth, :normalized
-
-        def initialize(env)
-          @auth = env["omniauth.auth"]
-          @normalized = {}
+        def initialize(auth)
+          @auth = auth
         end
 
         def normalize
-          normalize_provider
-          normalize_profile
+          normalized = {}
+          normalized['provider'] = normalize_provider
+          normalized['profile'] = normalize_profile
+          normalized
         end
 
-        def normalize_provider
-          provider_name = auth["provider"]
-          provider_uid = auth["uid"]
+        private
+
+        attr_reader :auth
 
-          normalized.merge!(
-            'provider' => {
-              'name' => provider_name,
-              'uid' => provider_uid
-            }
-          )
+        def normalize_provider
+          {
+            'name' => auth['provider'],
+            'uid' => auth['uid'],
+            'access_token' => auth['credentials']['token']
+          }
         end
 
         def normalize_profile
-          normalized.merge!(
-            'profile' => {}
-          )
-
-          auth["info"].to_hash.each_pair do |k, v|
-            normalized['profile'][k] = v
-          end
+          auth['info'].to_hash
         end
       end
     end

data/lib/registrar/gatekeeper.rb

@@ -0,0 +1,82 @@
+module Registrar
+  class Gatekeeper
+    def initialize(app, &block)
+      @app = app
+      @dispatcher = Dispatcher.new
+      try_to_eval_dispatcher(&block)
+    end
+
+    def call(env)
+      if dispatch?(env)
+        dispatch(env).tap do |d|
+          env["PATH_INFO"] = d.request_path
+          env["REQUEST_METHOD"] = d.request_method
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    attr_reader :dispatcher
+
+    def try_to_eval_dispatcher(&block)
+      if block_given?
+        dispatcher.instance_eval &block
+      end
+    end
+
+    def dispatch?(env)
+      !!dispatch(env)
+    end
+
+    def dispatch(env)
+      return @dispatch if @dispatch
+
+      request_path = env["PATH_INFO"]
+      request_method = env["REQUEST_METHOD"]
+      uid = "#{request_path}_#{request_method}"
+
+      @dispatch = dispatcher.dispatches[uid]
+    end
+
+    class Dispatcher
+      def initialize
+        @dispatches = {}
+      end
+
+      def get(from, to)
+        add_dispatch(from, to, "GET")
+      end
+
+      def post(from, to)
+        add_dispatch(from, to, "POST")
+      end
+
+      def dispatches
+        @dispatches
+      end
+
+      private
+
+      def add_dispatch(from, to, request_method)
+        lookup_key = "#{from}_#{request_method}"
+        @dispatches[lookup_key] = build_dispatch(to, request_method)
+      end
+
+      def build_dispatch(request_path, request_method)
+        Dispatch.new(request_path, request_method)
+      end
+
+      class Dispatch
+        attr_reader :request_path, :request_method
+
+        def initialize(request_path, request_method)
+          @request_path = request_path
+          @request_method = request_method
+        end
+      end
+    end
+  end
+end

data/lib/registrar/{profile_builder.rb → profile_factory.rb}

@@ -1,18 +1,18 @@
 module Registrar
-  class ProfileBuilder
+  class ProfileFactory
     def initialize(app, callable)
       @app = app
       @callable = callable
     end
 
     def call(env)
-      try_to_call(env)
+      build_profile(env)
       @app.call(env)
     end
 
     private
 
-    def try_to_call(env)
+    def build_profile(env)
       if auth_hash = env['registrar.auth']
         profile = @callable.call(auth_hash)
         env['registrar.profile'] = profile.to_hash

data/lib/registrar/version.rb

@@ -1,3 +1,3 @@
 module Registrar
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.2.alpha"
 end

data/registrar.gemspec

@@ -20,4 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "omniauth"
 end

data/spec/gatekeeper_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+class GatekeeperSpec < Spec
+  it 'delegates get requests to the defined endpoints' do
+    get '/login/base'
+
+    assert_path '/auth/developer'
+    assert_method 'GET'
+  end
+
+  it 'delegates post requests to the defined endpoints' do
+    post '/login/base'
+
+    assert_path '/auth/developer/callback'
+    assert_method 'POST'
+  end
+
+  private
+
+  def assert_path(request_path)
+    assert_equal request_path, env["PATH_INFO"]
+  end
+
+  def assert_method(request_method)
+    assert_equal request_method, env["REQUEST_METHOD"]
+  end
+
+  def env
+    last_request.env
+  end
+
+  def response
+    last_response
+  end
+
+  def app
+    @app ||= build_app
+  end
+
+  def build_app
+    builder.to_app
+  end
+
+  def builder
+    Rack::Builder.new do
+      use Registrar::Gatekeeper do
+        get '/login/base', '/auth/developer'
+        post '/login/base', '/auth/developer/callback'
+      end
+
+      app = Proc.new do |env|
+        ['200', {'Content-Type' => 'text/html'}, ['A barebones rack app.']]
+      end
+
+      run app
+    end
+  end
+end

data/spec/omni_auth_adapter_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'omniauth'
+
+class OmniAuthAdapterSpec < Spec
+  it 'normalizes OmniAuth Auth Hash Schema 1.0 and later' do
+    get '/'
+    assert_normalizes_auth env
+  end
+
+  private
+
+  def assert_normalizes_auth(env)
+    assert_normalizes_provider(env)
+    assert_normalizes_profile(env)
+  end
+
+  def assert_normalizes_provider(env)
+    assert_equal(
+      {
+        'name' => 'facebook',
+        'uid' => '100000100277322',
+        'access_token' => 'CAACEdEose0cBAGxad8Y14t3tu3kMlA3SgnxZBfZCQcSyb9hnn1kNZCpBDzZBIpNNpYSsJTFDs4Ar4ZBZBoMRRAzzFJGhPW4mtM1Rmm62BsQiZCkpJpG1pAC8tslbD3s3BiSYEGdjhOZBt7QVHZB1Sea14ojiZAOZBhFWi1BZBfIGgRI3El6FmEYMKPQ2XgJR0ottKdTQBR1ia2NuZABxpsAMYY8Sb'
+      }, env['registrar.auth']['provider'])
+  end
+
+  def assert_normalizes_profile(env)
+    assert_equal(
+      {
+        "name" => "Jan Ow",
+        "first_name" => "Jan",
+        "last_name" => "Ow",
+        "image" => "http://graph.facebook.com/100000100277322/picture",
+        "urls" => {
+          "Facebook" => "http://www.facebook.com/100000100277322"
+        },
+        "verified" => true
+      }, env['registrar.auth']['profile'])
+  end
+
+  def env
+    last_request.env
+  end
+
+  def response
+    last_response
+  end
+
+  def app
+    @app ||= build_app
+  end
+
+  def build_app
+    builder.to_app
+  end
+
+  class OmniAuthFacebookStub
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env['omniauth.auth'] = stubbed_auth_response
+      @app.call(env)
+    end
+
+    private
+
+    def stubbed_auth_response
+      Marshal.load(auth_response_file)
+    end
+
+    def auth_response_file
+      File.read(auth_response_path)
+    end
+
+    def auth_response_path
+      "#{current_path}/fixtures/omniauth_1_0_auth_hash_schema"
+    end
+
+    def current_path
+      File.expand_path(File.dirname(__FILE__))
+    end
+  end
+
+  def builder
+    Rack::Builder.new do
+      use OmniAuthFacebookStub
+
+      use Registrar::Adapter::OmniAuth
+
+      app = Proc.new do |env|
+        ['200', {'Content-Type' => 'text/html'}, ['A barebones rack app.']]
+      end
+
+      run app
+    end
+  end
+end

data/spec/profile_factory_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+class ProfileFactorySpec < Spec
+  it 'passes auth hash to callable and stores callable#to_hash in the env' do
+    get '/'
+    assert_stores_profile env
+  end
+
+  private
+
+  def assert_stores_profile(env)
+    assert_equal(
+      {
+        'internal_uid' => '1',
+        'external_uid' => 'facebook_123',
+        'name' => 'Bob'
+      },
+      env['registrar.profile'])
+  end
+
+  def env
+    last_request.env
+  end
+
+  def response
+    last_response
+  end
+
+  def app
+    @app ||= build_app
+  end
+
+  def build_app
+    builder.to_app
+  end
+
+  class RegistrarAuthStub
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      auth_hash = {
+        'provider' => {
+          'name' => 'facebook',
+          'uid' => '123'
+        },
+        'profile' => {
+          'name' => 'Bob'
+        }
+      }
+      env['registrar.auth'] = auth_hash
+      @app.call(env)
+    end
+
+    private
+
+    def stubbed_auth_response
+      Marshal.load(auth_response_file)
+    end
+
+    def auth_response_file
+      File.read(auth_response_path)
+    end
+
+    def auth_response_path
+      "#{current_path}/fixtures/omniauth_1_0_auth_hash_schema"
+    end
+
+    def current_path
+      File.expand_path(File.dirname(__FILE__))
+    end
+  end
+
+  class ProfileGatewayStub
+    def call(auth_hash)
+      Profile.new(auth_hash)
+    end
+
+    class Profile
+      def initialize(auth_hash)
+        provider_name = auth_hash['provider']['name']
+        uid = auth_hash['provider']['uid']
+
+        @internal_uid = '1'
+        @external_uid = "#{provider_name}_#{uid}"
+        @name = auth_hash['profile']['name']
+      end
+
+      def to_hash
+        {
+          'internal_uid' => @internal_uid,
+          'external_uid' => @external_uid,
+          'name' => @name
+        }
+      end
+    end
+  end
+
+  def builder
+    Rack::Builder.new do
+      use RegistrarAuthStub
+
+      use Registrar::ProfileFactory, ProfileGatewayStub.new
+
+      app = Proc.new do |env|
+        ['200', {'Content-Type' => 'text/html'}, ['A barebones rack app.']]
+      end
+
+      run app
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'rack'
+require 'rack/test'
+require 'registrar'
+
+class Spec < Minitest::Spec
+  include Rack::Test::Methods
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: registrar
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.2.alpha
 platform: ruby
 authors:
 - Jan Owiesniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: Registrar standardizes Authentication Responses through Rack Middleware
   and works well with common authentication mechanisms like OmniAuth.
 email:
@@ -55,10 +111,15 @@ files:
 - lib/registrar/adapter.rb
 - lib/registrar/adapter/omni_auth.rb
 - lib/registrar/debug.rb
-- lib/registrar/profile_builder.rb
-- lib/registrar/profile_gateway_stub.rb
+- lib/registrar/gatekeeper.rb
+- lib/registrar/profile_factory.rb
 - lib/registrar/version.rb
 - registrar.gemspec
+- spec/fixtures/omniauth_1_0_auth_hash_schema
+- spec/gatekeeper_spec.rb
+- spec/omni_auth_adapter_spec.rb
+- spec/profile_factory_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -83,4 +144,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 'Registrar: Standardized Multi-Provider Registration'
-test_files: []
+test_files:
+- spec/fixtures/omniauth_1_0_auth_hash_schema
+- spec/gatekeeper_spec.rb
+- spec/omni_auth_adapter_spec.rb
+- spec/profile_factory_spec.rb
+- spec/spec_helper.rb

data/lib/registrar/profile_gateway_stub.rb

@@ -1,27 +0,0 @@
-module Registrar
-  class ProfileGatewayStub
-    def call(auth_hash)
-      Profile.new(auth_hash)
-    end
-
-    class Profile
-      def initialize(auth_hash)
-        provider_name = auth_hash['provider']['name']
-        uid = auth_hash['provider']['uid']
-
-        @internal_uid = 1
-        @external_uid = "#{provider_name}_#{uid}"
-        @name = auth_hash['profile']['name']
-      end
-
-      def to_hash
-        {
-          :internal_uid => @internal_uid,
-          :external_uid => @external_uid,
-          :access_token => 'verified',
-          :name => @name
-        }
-      end
-    end
-  end
-end