omniauth 1.1.1 → 1.1.2

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--markup-provider maruku
+-
+LICENSE.md

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Michael Bleigh and Intridea, Inc.
+Copyright (c) 2010-2013 Michael Bleigh and Intridea, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,13 @@
-# OmniAuth: Standardized Multi-Provider Authentication [![CI Build Status](https://secure.travis-ci.org/intridea/omniauth.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/intridea/omniauth.png?travis)][gemnasium]
+# OmniAuth: Standardized Multi-Provider Authentication
+[![Gem Version](https://badge.fury.io/rb/omniauth.png)][gem]
+[![CI Build Status](https://secure.travis-ci.org/intridea/omniauth.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/intridea/omniauth.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
 
+[gem]: https://rubygems.org/gems/omniauth
 [travis]: http://travis-ci.org/intridea/omniauth
 [gemnasium]: https://gemnasium.com/intridea/omniauth
+[codeclimate]: https://codeclimate.com/github/intridea/omniauth
 
 **OmniAuth 1.0 has several breaking changes from version 0.x. You can set
 the dependency to `~> 0.3.2` if you do not wish to make the more difficult
@@ -9,7 +15,6 @@ upgrade. See [the wiki](https://github.com/intridea/omniauth/wiki/Upgrading-to-1
 for more information.**
 
 ## An Introduction
-
 OmniAuth is a library that standardizes multi-provider authentication for
 web applications. It was created to be powerful, flexible, and do as
 little as possible. Any developer can create **strategies** for OmniAuth
@@ -28,7 +33,6 @@ 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
 use the built-in Developer strategy in a Sinatra application I might do
@@ -63,7 +67,6 @@ You should look to the documentation for each provider you use for
 specific initialization requirements.
 
 ## Integrating OmniAuth Into Your Application
-
 OmniAuth is an extremely low-touch library. It is designed to be a
 black box that you can send your application's users into when you need
 authentication and then get information back. OmniAuth was intentionally
@@ -121,7 +124,6 @@ you how you want to implement the particulars of your application's
 authentication flow.
 
 ## Logging
-
 OmniAuth supports a configurable logger. By default, OmniAuth will log
 to `STDOUT` but you can configure this using `OmniAuth.config.logger`:
 
@@ -131,35 +133,47 @@ OmniAuth.config.logger = Rails.logger
 ```
 
 ## Resources
-
 The [OmniAuth Wiki](https://github.com/intridea/omniauth/wiki) has
 actively maintained in-depth documentation for OmniAuth. It should be
 your first stop if you are wondering about a more in-depth look at
 OmniAuth, how it works, and how to use it.
 
 ## Supported Ruby Versions
-
 OmniAuth is tested under 1.8.7, 1.9.2, 1.9.3, JRuby (1.8 mode), and Rubinius
 (1.8 and 1.9 modes).
 
-## License
+## Versioning
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+    spec.add_dependency 'omniauth', '~> 1.0'
 
-Copyright (c) 2011 Intridea, Inc.
-
-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.
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
+## License
+Copyright (c) 2010-2013 Michael Bleigh and Intridea, Inc.
+
+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/lib/omniauth.rb

@@ -4,7 +4,7 @@ require 'logger'
 
 module OmniAuth
   class Error < StandardError; end
-  
+
   module Strategies
     autoload :Developer, 'omniauth/strategies/developer'
   end

data/lib/omniauth/form.rb

@@ -101,7 +101,7 @@ module OmniAuth
     def self.build(options = {},&block)
       form = OmniAuth::Form.new(options)
       if block.arity > 0
-        yield form 
+        yield form
       else
         form.instance_eval(&block)
       end

data/lib/omniauth/strategies/developer.rb

@@ -21,7 +21,7 @@ module OmniAuth
     # @example Custom Fields
     #
     #   use OmniAuth::Builder do
-    #     provider :developer, 
+    #     provider :developer,
     #       :fields => [:first_name, :last_name],
     #       :uid_field => :last_name
     #   end

data/lib/omniauth/strategy.rb

@@ -69,7 +69,7 @@ module OmniAuth
       #     include OmniAuth::Strategy
       #
       #     option :foo, 'bar'
-      #     option 
+      #     option
       #   end
       def option(name, value = nil)
         default_options[name] = value
@@ -219,7 +219,7 @@ module OmniAuth
       callback_phase
     end
 
-    # Returns true if the environment recognizes either the 
+    # Returns true if the environment recognizes either the
     # request or callback path.
     def on_auth_path?
       on_request_path? || on_callback_path?
@@ -362,7 +362,7 @@ module OmniAuth
 
     def custom_path(kind)
       if options[kind].respond_to?(:call)
-        result = options[kind].call(env) 
+        result = options[kind].call(env)
         return nil unless result.is_a?(String)
         result
       else
@@ -405,7 +405,7 @@ module OmniAuth
           uri.path = ''
           uri.query = nil
           #sometimes the url is actually showing http inside rails because the other layers (like nginx) have handled the ssl termination.
-          uri.scheme = 'https' if(request.env['HTTP_X_FORWARDED_PROTO'] == 'https')          
+          uri.scheme = 'https' if request.ssl?
           uri.to_s
       end
     end

data/lib/omniauth/test/strategy_macros.rb

@@ -5,26 +5,26 @@ module OmniAuth
     module StrategyMacros
 
       def sets_an_auth_hash
-        it 'should set an auth hash' do
-          last_request.env['omniauth.auth'].should be_kind_of(Hash)
+        it "sets an auth hash" do
+          expect(last_request.env['omniauth.auth']).to be_kind_of(Hash)
         end
       end
 
       def sets_provider_to(provider)
-        it "should set the provider to #{provider}" do
-          (last_request.env['omniauth.auth'] || {})['provider'].should == provider
+        it "sets the provider to #{provider}" do
+          expect((last_request.env['omniauth.auth'] || {})['provider']).to eq provider
         end
       end
 
       def sets_uid_to(uid)
-        it "should set the UID to #{uid}" do
-          (last_request.env['omniauth.auth'] || {})['uid'].should == uid
+        it "sets the UID to #{uid}" do
+          expect((last_request.env['omniauth.auth'] || {})['uid']).to eq uid
         end
       end
 
       def sets_user_info_to(user_info)
-        it "should set the user_info to #{user_info}" do
-          (last_request.env['omniauth.auth'] || {})['user_info'].should == user_info
+        it "sets the user_info to #{user_info}" do
+          expect((last_request.env['omniauth.auth'] || {})['user_info']).to eq user_info
         end
       end
     end

data/lib/omniauth/version.rb

@@ -1,3 +1,3 @@
 module OmniAuth
-  VERSION = "1.1.1"
+  VERSION = "1.1.2" unless defined?(OmniAuth::VERSION)
 end

data/omniauth.gemspec

@@ -1,27 +1,26 @@
-# encoding: utf-8
-require File.expand_path('../lib/omniauth/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/version'
 
-Gem::Specification.new do |gem|
-  gem.name = 'omniauth'
-  gem.description = %q{A generalized Rack framework for multiple-provider authentication.}
-  gem.authors = ['Michael Bleigh', 'Erik Michaels-Ober']
-  gem.email = ['michael@intridea.com', 'sferik@gmail.com']
-
-  gem.add_runtime_dependency 'rack'
-  gem.add_runtime_dependency 'hashie', '~> 1.2'
-
-  gem.add_development_dependency 'maruku'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'rack-test'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 2.8'
-  gem.add_development_dependency 'yard'
-
-  gem.version = OmniAuth::VERSION
-  gem.files = `git ls-files`.split("\n")
-  gem.homepage = 'http://github.com/intridea/omniauth'
-  gem.require_paths = ['lib']
-  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if gem.respond_to? :required_rubygems_version=
-  gem.summary = gem.description
-  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+Gem::Specification.new do |spec|
+  spec.add_dependency 'hashie', '~> 1.2'
+  spec.add_dependency 'rack'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.authors       = ['Michael Bleigh', 'Erik Michaels-Ober']
+  spec.cert_chain    = ['certs/sferik.pem']
+  spec.description   = %q{A generalized Rack framework for multiple-provider authentication.}
+  spec.email         = ['michael@intridea.com', 'sferik@gmail.com']
+  spec.files         = %w(.yardopts LICENSE.md README.md Rakefile omniauth.gemspec)
+  spec.files        += Dir.glob("lib/**/*.rb")
+  spec.files        += Dir.glob("spec/**/*")
+  spec.homepage      = 'http://github.com/intridea/omniauth'
+  spec.licenses      = ['MIT']
+  spec.name          = 'omniauth'
+  spec.require_paths = ['lib']
+  spec.required_rubygems_version = '>= 1.3.6'
+  spec.signing_key   = File.expand_path("~/.gem/private_key.pem") if $0 =~ /gem\z/
+  spec.summary       = spec.description
+  spec.test_files    = Dir.glob("spec/**/*")
+  spec.version       = OmniAuth::VERSION
 end

data/spec/omniauth/auth_hash_spec.rb

@@ -2,36 +2,36 @@ require 'spec_helper'
 
 describe OmniAuth::AuthHash do
   subject{ OmniAuth::AuthHash.new }
-  it 'should convert a supplied info key into an InfoHash object' do
+  it "converts a supplied info key into an InfoHash object" do
     subject.info = {:first_name => 'Awesome'}
-    subject.info.should be_kind_of(OmniAuth::AuthHash::InfoHash)
-    subject.info.first_name.should == 'Awesome'
+    expect(subject.info).to be_kind_of(OmniAuth::AuthHash::InfoHash)
+    expect(subject.info.first_name).to eq('Awesome')
   end
 
-  describe '#valid?' do
+  describe "#valid?" do
     subject{ OmniAuth::AuthHash.new(:uid => '123', :provider => 'example', :info => {:name => 'Steven'}) }
 
-    it 'should be valid with the right parameters' do
-      subject.should be_valid
+    it "is valid with the right parameters" do
+      expect(subject).to be_valid
     end
 
-    it 'should require a uid' do
+    it "requires a uid" do
       subject.uid = nil
-      subject.should_not be_valid
+      expect(subject).not_to be_valid
     end
 
-    it 'should require a provider' do
+    it "requires a provider" do
       subject.provider = nil
-      subject.should_not be_valid
+      expect(subject).not_to be_valid
     end
 
-    it 'should require a name in the user info hash' do
+    it "requires a name in the user info hash" do
       subject.info.name = nil
-      subject.should_not be_valid?
+      expect(subject).not_to be_valid?
     end
   end
 
-  describe '#name' do
+  describe "#name" do
     subject{ OmniAuth::AuthHash.new(
       :info => {
         :name => 'Phillip J. Fry',
@@ -41,67 +41,67 @@ describe OmniAuth::AuthHash do
         :email => 'fry@planetexpress.com'
     })}
 
-    it 'should default to the name key' do
-      subject.info.name.should == 'Phillip J. Fry'
+    it "defaults to the name key" do
+      expect(subject.info.name).to eq('Phillip J. Fry')
     end
 
-    it 'should fall back to go to first_name last_name concatenation' do
+    it "falls back to go to first_name last_name concatenation" do
       subject.info.name = nil
-      subject.info.name.should == 'Phillip Fry'
+      expect(subject.info.name).to eq('Phillip Fry')
     end
 
-    it 'should display only a first or last name if only that is available' do
+    it "displays only a first or last name if only that is available" do
       subject.info.name = nil
       subject.info.first_name = nil
-      subject.info.name.should == 'Fry'
+      expect(subject.info.name).to eq('Fry')
     end
 
-    it 'should display the nickname if no name, first, or last is available' do
+    it "displays the nickname if no name, first, or last is available" do
       subject.info.name = nil
       %w(first_name last_name).each{|k| subject.info[k] = nil}
-      subject.info.name.should == 'meatbag'
+      expect(subject.info.name).to eq('meatbag')
     end
 
-    it 'should display the email if no name, first, last, or nick is available' do
+    it "displays the email if no name, first, last, or nick is available" do
       subject.info.name = nil
       %w(first_name last_name nickname).each{|k| subject.info[k] = nil}
-      subject.info.name.should == 'fry@planetexpress.com'
+      expect(subject.info.name).to eq('fry@planetexpress.com')
     end
   end
 
-  describe '#to_hash' do
+  describe "#to_hash" do
     subject{ OmniAuth::AuthHash.new(:uid => '123', :provider => 'test', :name => 'Bob Example')}
     let(:hash){ subject.to_hash }
 
-    it 'should be a plain old hash' do
-      hash.class.should == ::Hash
+    it "is a plain old hash" do
+      expect(hash.class).to eq(::Hash)
     end
 
-    it 'should have string keys' do
-      hash.keys.should be_include('uid')
+    it "has string keys" do
+      expect(hash.keys).to be_include('uid')
     end
 
-    it 'should convert an info hash as well' do
+    it "converts an info hash as well" do
       subject.info = {:first_name => 'Bob', :last_name => 'Example'}
-      subject.info.class.should == OmniAuth::AuthHash::InfoHash
-      subject.to_hash['info'].class.should == ::Hash
+      expect(subject.info.class).to eq(OmniAuth::AuthHash::InfoHash)
+      expect(subject.to_hash['info'].class).to eq(::Hash)
     end
 
-    it 'should supply the calculated name in the converted hash' do
+    it "supplies the calculated name in the converted hash" do
       subject.info = {:first_name => 'Bob', :last_name => 'Examplar'}
-      hash['info']['name'].should == 'Bob Examplar'
+      expect(hash['info']['name']).to eq('Bob Examplar')
     end
 
-    it 'should not pollute the URL hash with "name" etc' do
+    it "does 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"}
+      expect(subject.to_hash['info']['urls']).to eq({'Homepage' => "http://homepage.com"})
     end
   end
 
   describe OmniAuth::AuthHash::InfoHash do
-    describe '#valid?' do
-      it 'should be valid if there is a name' do
-        OmniAuth::AuthHash::InfoHash.new(:name => 'Awesome').should be_valid
+    describe "#valid?" do
+      it "is valid if there is a name" do
+        expect(OmniAuth::AuthHash::InfoHash.new(:name => 'Awesome')).to be_valid
       end
     end
   end

data/spec/omniauth/builder_spec.rb

@@ -1,23 +1,25 @@
 require File.expand_path('../../spec_helper', __FILE__)
 
 describe OmniAuth::Builder do
-  describe '#provider' do
-    it 'should translate a symbol to a constant' do
+  describe "#provider" do
+    it "translates a symbol to a constant" do
       OmniAuth::Strategies.should_receive(:const_get).with('MyStrategy').and_return(Class.new)
       OmniAuth::Builder.new(nil) do
         provider :my_strategy
       end
     end
 
-    it 'should also just accept a class' do
+    it "accepts a class" do
       class ::ExampleClass; end
 
-      lambda{ OmniAuth::Builder.new(nil) do
-        provider ::ExampleClass
-      end }.should_not raise_error
+      expect{
+        OmniAuth::Builder.new(nil) do
+          provider ::ExampleClass
+        end
+      }.not_to raise_error
     end
 
-    it "should raise a helpful LoadError message if it can't find the class" do
+    it "raises a helpful LoadError message if it can't find the class" do
       expect {
         OmniAuth::Builder.new(nil) do
           provider :lorax
@@ -26,8 +28,8 @@ describe OmniAuth::Builder do
     end
   end
 
-  describe '#options' do
-    it 'should merge provided options in' do
+  describe "#options" do
+    it "merges provided options in" do
       k = Class.new
       b = OmniAuth::Builder.new(nil)
       b.should_receive(:use).with(k, :foo => 'bar', :baz => 'tik')
@@ -36,7 +38,7 @@ describe OmniAuth::Builder do
       b.provider k, :baz => 'tik'
     end
 
-    it 'should add an argument if no options are provided' do
+    it "adds an argument if no options are provided" do
       k = Class.new
       b = OmniAuth::Builder.new(nil)
       b.should_receive(:use).with(k, :foo => 'bar')