omniauth 1.0.0.pr2 → 1.0.0.rc1

data/README.md

@@ -18,7 +18,13 @@ one or more strategies. These strategies are generally released
 individually as RubyGems, and you can see a [community maintained list](https://github.com/intridea/omniauth/wiki/List-of-Strategies) 
 on the wiki for this project.
 
-## Adding OmniAuth to Your Application
+One strategy, called `Developer`, is included with OmniAuth and provides
+a completely unsecure, non-production-usable strategy that directly
+prompts a user for authentication information and then passes it
+straight through. You can use it as a placeholder when you start
+development and easily swap in other strategies later.
+
+## Getting Started
 
 Each OmniAuth strategy is a Rack Middleware. That means that you can use
 it the same way that you use any other Rack middleware. For example, to
@@ -79,7 +85,7 @@ something like this:
 
     class SessionsController < ApplicationController
       def create
-        @user = ̈User.find_or_create_from_auth_hash(auth_hash)
+        @user = User.find_or_create_from_auth_hash(auth_hash)
         self.current_user = @user
         redirect_to '/'
       end

data/lib/omniauth.rb

@@ -2,7 +2,9 @@ require 'rack'
 require 'singleton'
 
 module OmniAuth
-  module Strategies; end
+  module Strategies
+    autoload :Developer, 'omniauth/strategies/developer'
+  end
 
   autoload :Builder,  'omniauth/builder'
   autoload :Strategy, 'omniauth/strategy'

data/lib/omniauth/auth_hash.rb

@@ -6,6 +6,8 @@ module OmniAuth
   # is able to provide into the InfoHash (stored as the `'info'`
   # key).
   class AuthHash < Hashie::Mash
+    def self.subkey_class; Hashie::Mash end
+
     # Tells you if this is considered to be a valid
     # OmniAuth AuthHash. The requirements for that
     # are that it has a provider name, a uid, and a
@@ -23,6 +25,8 @@ module OmniAuth
     end
 
     class InfoHash < Hashie::Mash
+      def self.subkey_class; Hashie::Mash end
+
       def name
         return self[:name] if self[:name]
         return "#{first_name} #{last_name}".strip if first_name? || last_name?

data/lib/omniauth/form.rb

@@ -97,8 +97,8 @@ module OmniAuth
       header(options[:title],options[:header_info])
     end
 
-    def self.build(title=nil,&block)
-      form = OmniAuth::Form.new(:title => title)
+    def self.build(options = {},&block)
+      form = OmniAuth::Form.new(options)
       if block.arity > 0
         yield form 
       else

data/lib/omniauth/strategies/developer.rb

@@ -0,0 +1,60 @@
+require 'omniauth'
+
+module OmniAuth
+  module Strategies
+    # The Developer strategy is a very simple strategy that can be used as a
+    # placeholder in your application until a different authentication strategy
+    # is swapped in. It has zero security and should *never* be used in a
+    # production setting.
+    #
+    # ## Usage
+    #
+    # To use the Developer strategy, all you need to do is put it in like any
+    # other strategy:
+    #
+    # @example Basic Usage
+    #
+    #   use OmniAuth::Builder do
+    #     provider :developer
+    #   end
+    #
+    # @example Custom Fields
+    #
+    #   use OmniAuth::Builder do
+    #     provider :developer, 
+    #       :fields => [:first_name, :last_name],
+    #       :uid_field => :last_name
+    #   end
+    #
+    # This will create a strategy that, when the user visits `/auth/developer`
+    # they will be presented a form that prompts for (by default) their name
+    # and email address. The auth hash will be populated with these fields and
+    # the `uid` will simply be set to the provided email.
+    class Developer
+      include OmniAuth::Strategy
+
+      option :fields, [:name, :email]
+      option :uid_field, :email
+
+      def request_phase
+        form = OmniAuth::Form.new(:title => "User Info", :url => callback_path)
+        options.fields.each do |field|
+          form.text_field field.to_s.capitalize.gsub("_", " "), field.to_s
+        end
+        form.button "Sign In"
+        form.to_response
+      end
+
+      uid do
+        request.params[options.uid_field.to_s]
+      end
+
+      info do
+        options.fields.inject({}) do |hash, field|
+          hash[field] = request.params[field.to_s]
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/version.rb

@@ -1,3 +1,3 @@
 module OmniAuth
-  VERSION = "1.0.0.pr2"
+  VERSION = "1.0.0.rc1"
 end

data/omniauth.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.email = ['michael@intridea.com', 'sferik@gmail.com']
 
   gem.add_runtime_dependency 'rack'
-  gem.add_runtime_dependency 'hashie'
+  gem.add_runtime_dependency 'hashie', '~> 1.2'
 
   gem.add_development_dependency 'maruku', '~> 0.6'
   gem.add_development_dependency 'simplecov', '~> 0.4'

data/spec/omniauth/auth_hash_spec.rb

@@ -91,6 +91,11 @@ describe OmniAuth::AuthHash do
       subject.info = {:first_name => 'Bob', :last_name => 'Examplar'}
       hash['info']['name'].should == 'Bob Examplar'
     end
+
+    it 'should not pollute the URL hash with "name" etc' do
+      subject.info = {'urls' => {'Homepage' => "http://homepage.com"}}
+      subject.to_hash['info']['urls'].should == {'Homepage' => "http://homepage.com"}
+    end
   end
 
   describe OmniAuth::AuthHash::InfoHash do

data/spec/omniauth/form_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe OmniAuth::Form do
+  describe '.build' do
+    it 'should yield the instance when called with a block and argument' do
+      OmniAuth::Form.build{|f| f.should be_kind_of(OmniAuth::Form)}
+    end
+
+    it 'should evaluate in the instance when called with a block and no argument' do
+      OmniAuth::Form.build{ self.class.should == OmniAuth::Form }
+    end
+  end
+
+  describe '#initialize' do
+    it 'the :url option should supply to the form that is built' do
+      OmniAuth::Form.new(:url => '/awesome').to_html.should be_include("action='/awesome'")
+    end
+
+    it 'the :title option should set an H1 tag' do
+      OmniAuth::Form.new(:title => 'Something Cool').to_html.should be_include('<h1>Something Cool</h1>')
+    end
+  end
+end

data/spec/omniauth/strategies/developer_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Developer do
+  let(:app){ Rack::Builder.new do |b|
+    b.use Rack::Session::Cookie
+    b.use OmniAuth::Strategies::Developer
+    b.run lambda{|env| [200, {}, ['Not Found']]}
+  end.to_app }
+
+  context 'request phase' do
+    before(:each){ get '/auth/developer' }
+
+    it 'should display a form' do
+      last_response.status.should == 200
+      last_response.body.should be_include("<form")
+    end
+
+    it 'should have the callback as the action for the form' do
+      last_response.body.should be_include("action='/auth/developer/callback'")
+    end
+
+    it 'should have a text field for each of the fields' do
+      last_response.body.scan('<input').size.should == 2
+    end
+  end
+
+  context 'callback phase' do
+    let(:auth_hash){ last_request.env['omniauth.auth'] }
+
+    context 'with default options' do
+      before do
+        post '/auth/developer/callback', :name => 'Example User', :email => 'user@example.com'
+      end
+
+      it 'should set the name in the auth hash' do
+        auth_hash.info.name.should == 'Example User'
+      end
+
+      it 'should set the email in the auth hash' do
+        auth_hash.info.email.should == 'user@example.com'
+      end
+
+      it 'should set the uid to the email' do
+        auth_hash.uid.should == 'user@example.com'
+      end
+    end
+
+    context 'with custom options' do
+      let(:app){ Rack::Builder.new do |b|
+        b.use Rack::Session::Cookie
+        b.use OmniAuth::Strategies::Developer, :fields => [:first_name, :last_name], :uid_field => :last_name
+        b.run lambda{|env| [200, {}, ['Not Found']]}
+      end.to_app }
+
+      before do
+        @options = {:uid_field => :last_name, :fields => [:first_name, :last_name]}
+        post '/auth/developer/callback', :first_name => 'Example', :last_name => 'User'
+      end
+
+      it 'should set info fields properly' do
+        auth_hash.info.name.should == 'Example User'
+      end
+
+      it 'should set the uid properly' do
+        auth_hash.uid.should == 'User'
+      end
+    end
+  end
+end

data/spec/omniauth/strategy_spec.rb

@@ -546,9 +546,17 @@ describe OmniAuth::Strategy do
         strategy.call(make_env('/auth/test/callback', 'rack.session' => {'omniauth.origin' => 'http://example.com/origin'}))
         strategy.env['omniauth.origin'].should == 'http://example.com/origin'
       end
+      
+      after do
+        OmniAuth.config.test_mode = false
+      end
     end
 
     context 'custom full_host' do
+      before do
+        OmniAuth.config.test_mode = true
+      end
+      
       it 'should be the string when a string is there' do
         OmniAuth.config.full_host = 'my.host.com'
         strategy.full_host.should == 'my.host.com'
@@ -559,10 +567,18 @@ describe OmniAuth::Strategy do
         strategy.call(make_env('/auth/test', 'HOST' => 'my.host.net'))
         strategy.full_host.should == 'my.host.net'
       end
+      
+      after do
+        OmniAuth.config.test_mode = false
+      end
     end
   end
 
   context 'setup phase' do
+    before do
+      OmniAuth.config.test_mode = true
+    end
+    
     context 'when options[:setup] = true' do
       let(:strategy){ ExampleStrategy.new(app, :setup => true) }
       let(:app){lambda{|env| env['omniauth.strategy'].options[:awesome] = 'sauce' if env['PATH_INFO'] == '/auth/test/setup'; [404, {}, 'Awesome'] }}
@@ -597,5 +613,9 @@ describe OmniAuth::Strategy do
         strategy.options[:awesome].should == 'sauce'
       end
     end
+    
+    after do
+      OmniAuth.config.test_mode = false
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pr2
+  version: 1.0.0.rc1
   prerelease: 6
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000Z
+date: 2011-10-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70329368740800 !ruby/object:Gem::Requirement
+  requirement: &70099446657480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,21 +22,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70329368740800
+  version_requirements: *70099446657480
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70329368740380 !ruby/object:Gem::Requirement
+  requirement: &70099446656940 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70329368740380
+  version_requirements: *70099446656940
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70329368739880 !ruby/object:Gem::Requirement
+  requirement: &70099446656300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *70329368739880
+  version_requirements: *70099446656300
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70329368739380 !ruby/object:Gem::Requirement
+  requirement: &70099446655720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70329368739380
+  version_requirements: *70099446655720
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70329368738920 !ruby/object:Gem::Requirement
+  requirement: &70099446648340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70329368738920
+  version_requirements: *70099446648340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70329368738460 !ruby/object:Gem::Requirement
+  requirement: &70099446647380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *70329368738460
+  version_requirements: *70099446647380
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70329368738000 !ruby/object:Gem::Requirement
+  requirement: &70099446646720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70329368738000
+  version_requirements: *70099446646720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70329368737540 !ruby/object:Gem::Requirement
+  requirement: &70099446645920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +99,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70329368737540
+  version_requirements: *70099446645920
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70329368737080 !ruby/object:Gem::Requirement
+  requirement: &70099446645460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,7 +110,7 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70329368737080
+  version_requirements: *70099446645460
 description: A generalized Rack framework for multiple-provider authentication.
 email:
 - michael@intridea.com
@@ -133,6 +133,7 @@ files:
 - lib/omniauth/auth_hash.rb
 - lib/omniauth/builder.rb
 - lib/omniauth/form.rb
+- lib/omniauth/strategies/developer.rb
 - lib/omniauth/strategy.rb
 - lib/omniauth/test.rb
 - lib/omniauth/test/phony_session.rb
@@ -142,6 +143,8 @@ files:
 - omniauth.gemspec
 - spec/omniauth/auth_hash_spec.rb
 - spec/omniauth/builder_spec.rb
+- spec/omniauth/form_spec.rb
+- spec/omniauth/strategies/developer_spec.rb
 - spec/omniauth/strategy_spec.rb
 - spec/omniauth_spec.rb
 - spec/spec_helper.rb
@@ -172,6 +175,8 @@ summary: A generalized Rack framework for multiple-provider authentication.
 test_files:
 - spec/omniauth/auth_hash_spec.rb
 - spec/omniauth/builder_spec.rb
+- spec/omniauth/form_spec.rb
+- spec/omniauth/strategies/developer_spec.rb
 - spec/omniauth/strategy_spec.rb
 - spec/omniauth_spec.rb
 - spec/spec_helper.rb