omniauth-redbooth 1.0.0 → 1.0.1.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 129ae77da55b0755c411b7662d2c83b23cfbc820
-  data.tar.gz: dea926ed3e864db82b76d1cd0ab14cd6eb93d7a0
+  metadata.gz: cf62604b882c484c140a9251fe42e6d757e2c1ee
+  data.tar.gz: a02d5e72917911eac03a8adc6298247b625dcad8
 SHA512:
-  metadata.gz: a07416b6e73b8c7922725a2c228ce689818649e095a646eb0c2b9b88c555e5b0f88b1665e00435d1873513341bb491dbb1b58cd5d82783443c31d0a636219665
-  data.tar.gz: 2135f8801275cc1b94938676f6fa1193ac56908f6a80184979ba26b9829595e8632483ad52ef9b9bec0ea42adc7831a64a910d664682af3a596c72d58fbaf0aa
+  metadata.gz: 7cd0585183d94ed193857eb67f9c7b565399a4e1c95292cb4b32d3cace5bc9f0b94bc1036edef93690c5dea25a743fe45a167353d00bbb94b80400bcb7781b22
+  data.tar.gz: 2c8a2086570a5ec790a089bb80a36c8d429de9f3a894026f8eaea1c071e199e3be46378481db9add55f19f049604e5be0bf0fc89e9d28e2eeb9132c8293af797

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 Gemfile.lock
+.byebug_history

data/.travis.yml

@@ -2,3 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.7
+  - 2.2.3

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Change Log
+
+## [Unreleased]
+
+### Added
+
+- Test on ruby 2.1 and 2.2 too.
+
+### Changed
+
+- cleaned up the code a bit.
+- cleaned up specs a bit and updated to RSpec 3.
+- Use debugger gem on ruby 1.9.x or less and byebug on 2.x
+
+### Deprecated
+### Removed
+
+### Fixed
+
+- changed omniauth-oauth2 dependency to 1.x up to 1.3.1 since [this change][1]
+  in omniauth-oauth2 1.4 breaks the strategy.
+- Stop dealing with SCRIPT_NAME since it was breaking stuff
+
+### Security
+
+## [1.0.0] - 2015-11-18
+
+### Changed
+- omniauth-oauth2 dependency to ~> 1.2
+
+## Previous changes
+
+Undocumented. Please review git commits history.
+
+[Unreleased]: https://github.com/redbooth/omniauth-redbooth/compare/v1.0.1...HEAD
+[1.0.0]: https://github.com/redbooth/omniauth-redbooth/compare/v0.3.2...v1.0.0
+
+[1]: https://github.com/intridea/omniauth-oauth2/issues/81

data/lib/omniauth/strategies/redbooth.rb

@@ -2,62 +2,34 @@ require 'omniauth-oauth2'
 
 module OmniAuth
   module Strategies
+    # @see https://redbooth.com/api/api-docs/
     class Redbooth < OmniAuth::Strategies::OAuth2
-      # Give your strategy a name.
-      option :name, 'redbooth'
+      REDBOOTH_URL = 'https://redbooth.com'.freeze
 
+      option :name, 'redbooth'
       option :provider_ignores_state, true
+      option :client_options,
+             site: "#{REDBOOTH_URL}/api/3",
+             authorize_url: "#{REDBOOTH_URL}/oauth2/authorize",
+             token_url: "#{REDBOOTH_URL}/oauth2/token"
+      option :authorize_params, response_type: 'code'
 
-      # This is where you pass the options you would pass when
-      # initializing your consumer from the OAuth gem.
-      option :client_options, {
-        site: 'https://redbooth.com/api/3',
-        authorize_url: 'https://redbooth.com/oauth2/authorize',
-        token_url: 'https://redbooth.com/oauth2/token'
-      }
-
-      option :authorize_params, {
-        response_type: 'code'
-      }
-
-      # These are called after authentication has succeeded. If
-      # possible, you should try to set the UID without making
-      # additional calls (if the user id is returned with the token
-      # or as a URI parameter). This may not be possible with all
-      # providers.
-      uid{ raw_info['id'] }
+      uid { raw_info['id'] }
 
       info do
         {
-          :name => [ raw_info['first_name'], raw_info['last_name'] ].join(' '),
-          :email => raw_info['email']
+          name: "#{raw_info['first_name']} #{raw_info['last_name']}",
+          email: raw_info['email']
         }
       end
 
       extra do
-        {
-          'raw_info' => raw_info
-        }
+        { 'raw_info' => raw_info }
       end
 
       def raw_info
-        @raw_info ||= access_token.get("#{options[:client_options][:site]}/me").parsed
-      end
-
-      # Override OmniAuth's `request` method and make sure that
-      # `request.url` is properly defined when `PATH_INFO` doesn't
-      # start with a slash.
-      #
-      # This is needed because when mounting an engine on the root,
-      # the `path_prefix` cannot start with a slash. Because of that
-      # `request.url` becomes host:portpath (notice the lack of a slash).
-      #
-      # This code sets the `SCRIPT_NAME` environment variable to a slash
-      # if it's empty (meaning that it's the root) and then calls
-      # the parent code which instantiates a request.
-      def request
-        @env['SCRIPT_NAME'] = '/' if @env['SCRIPT_NAME'] == ''
-        super
+        @raw_info ||=
+          access_token.get("#{options[:client_options][:site]}/me").parsed
       end
     end
   end

data/lib/omniauth-redbooth/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Redbooth
-    VERSION = '1.0.0'
+    VERSION = '1.0.1.rc.1'
   end
 end

data/omniauth-redbooth.gemspec

@@ -13,8 +13,15 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = OmniAuth::Redbooth::VERSION
 
-  gem.add_dependency 'omniauth-oauth2', '~> 1.2'
-  gem.add_development_dependency 'rspec', '~> 2.7'
+  # Using 1.3.x branch since 1.4 added a non backward compatible change which
+  # prevents this gem from working.
+  #
+  # The issue is documented here:
+  # https://github.com/intridea/omniauth-oauth2/issues/81
+  gem.add_dependency 'omniauth-oauth2', '>= 1.0', '<= 1.3.1'
+
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rspec-its', '~> 1.2'
   gem.add_development_dependency 'rack-test', '~> 0.6'
   gem.add_development_dependency 'simplecov', '~> 0.10'
   gem.add_development_dependency 'webmock', '~> 1.22'
@@ -25,4 +32,10 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'growl', '~> 1.0'
   gem.add_development_dependency 'sinatra', '~> 1.4'
   gem.add_development_dependency 'rake', '~> 10.4'
+
+  if Gem.ruby_version < Gem::Version.new('2.0.0')
+    gem.add_development_dependency 'debugger'
+  else
+    gem.add_development_dependency 'byebug'
+  end
 end

data/spec/omniauth/strategies/redbooth_spec.rb

@@ -1,102 +1,118 @@
 require 'spec_helper'
 
-describe OmniAuth::Strategies::Redbooth do
+RSpec.describe OmniAuth::Strategies::Redbooth do
   let(:app) do
-    lambda do |env|
-      [200, {}, ["Hello."]]
-    end
+    ->(_env) { [200, {}, ['Hello.']] }
   end
-  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
-  let(:fresh_strategy){ Class.new(OmniAuth::Strategies::Redbooth) }
 
-  let(:redbooth_strategy) do
-    fresh_strategy.new(app, '_your_app_id_', '_your_app_secret_', @options || {}).tap do |strategy|
-      strategy.stub(:request) {
-        request
-      }
-    end
-  end
+  let(:app_id) { '_app_id_' }
+  let(:app_secret) { '_app_secret_' }
+  let(:request) { double(params: {}, cookies: {}, env: {}) }
+  let(:options) { Hash.new }
 
-  subject { redbooth_strategy }
+  let(:strategy) { described_class.new(app, app_id, app_secret, options) }
 
-  before do
-    OmniAuth.config.test_mode = true
-  end
+  before { allow(strategy).to receive(:request) { request } }
 
-  after do
+  around do |example|
+    OmniAuth.config.test_mode = true
+    example.run
     OmniAuth.config.test_mode = false
   end
 
-  describe '#client_options' do
+  describe '#client' do
+    let(:example_site) { 'https://example.com' }
+    subject { strategy.client }
 
-    it 'should be initialized with correct authorize url' do
-      expect(subject.client.options[:authorize_url]).to eql 'https://redbooth.com/oauth2/authorize'
-    end
+    context 'with the default config' do
+      its(:site) { is_expected.to eq('https://redbooth.com/api/3') }
 
-    it 'should be initialized with correct token url' do
-      expect(subject.client.options[:token_url]).to eql 'https://redbooth.com/oauth2/token'
-    end
+      describe 'the client options' do
+        subject { strategy.client.options }
 
-    describe "overrides" do
-      it 'should allow overriding the site' do
-        @options = {:client_options => {'site' => 'https://example.com'}}
-        subject.client.site.should == 'https://example.com'
+        its([:authorize_url]) do
+          is_expected.to eq('https://redbooth.com/oauth2/authorize')
+        end
+        its([:token_url]) do
+          is_expected.to eq('https://redbooth.com/oauth2/token')
+        end
       end
+    end
 
-      it 'should allow overriding the authorize_url' do
-        @options = {:client_options => {'authorize_url' => 'https://example.com'}}
-        subject.client.options[:authorize_url].should == 'https://example.com'
-      end
+    context 'changing default :site' do
+      let(:options) { { client_options: { site: example_site } } }
 
-      it 'should allow overriding the token_url' do
-        @options = {:client_options => {'token_url' => 'https://example.com'}}
-        subject.client.options[:token_url].should == 'https://example.com'
-      end
+      its(:site) { is_expected.to eq(example_site) }
     end
-  end
 
-  describe '#authorize_params' do
+    context 'changing default :authorize_url' do
+      subject { strategy.client.options }
+      let(:options) { { client_options: { authorize_url: example_site } } }
 
-    it 'should include any authorize params passed in the :authorize_params option' do
-      @options = {:authorize_params => {:request_visible_actions => 'something', :foo => 'bar', :baz => 'zip'}, :bad => 'not_included'}
-      subject.authorize_params['request_visible_actions'].should eq('something')
-      subject.authorize_params['foo'].should eq('bar')
-      subject.authorize_params['baz'].should eq('zip')
-      subject.authorize_params['bad'].should eq(nil)
+      its([:authorize_url]) { is_expected.to eq(example_site) }
     end
 
-    it 'should include :response_type option' do
-      expect(subject.authorize_params).to include('response_type')
-      expect(subject.authorize_params['response_type']).to eql('code')
-    end
+    context 'changing default :token_url' do
+      subject { strategy.client.options }
+      let(:options) { { client_options: { token_url: example_site } } }
 
-    it 'should include random state in the authorize params' do
-      expect(subject.authorize_params).to include('state')
-      subject.session['omniauth.state'].should_not be_empty
+      its([:token_url]) { is_expected.to eq(example_site) }
     end
   end
 
-  describe '#token_params' do
-    it 'should include any token params passed in the :token_params option' do
-      @options = {:token_params => {:foo => 'bar', :baz => 'zip'}}
-      subject.token_params['foo'].should eq('bar')
-      subject.token_params['baz'].should eq('zip')
+  describe ':authorize_params' do
+    let(:options) do
+      {
+        authorize_params: {
+          request_visible_actions: 'something',
+          foo: 'bar',
+          baz: 'zip'
+        },
+        bad: 'not_included'
+      }
     end
+
+    subject { strategy.authorize_params }
+
+    its([:request_visible_actions]) { is_expected.to eq('something') }
+    its([:foo]) { is_expected.to eq('bar') }
+    its([:baz]) { is_expected.to eq('zip') }
+    its([:bad]) { is_expected.to be_nil }
+    its([:response_type]) { is_expected.to eq('code') }
+    it { is_expected.to include(:state) }
   end
 
-  describe "#token_options" do
-    it 'should include top-level options that are marked as :token_options' do
-      @options = {:token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz', :bad => 'not_included'}
-      subject.token_params['scope'].should eq('bar')
-      subject.token_params['foo'].should eq('baz')
-      subject.token_params['bad'].should eq(nil)
+  describe ':token_params' do
+    let(:options) do
+      { token_params: { foo: 'bar', baz: 'zip' } }
     end
+
+    subject { strategy.token_params }
+
+    its([:foo]) { is_expected.to eq('bar') }
+    its([:baz]) { is_expected.to eq('zip') }
   end
 
-  describe '#callback_path' do
-    it 'has the correct callback path' do
-      subject.callback_path.should eq('/auth/redbooth/callback')
+  describe ':token_options' do
+    let(:options) do
+      {
+        token_options: [:scope, :foo],
+        scope: 'bar',
+        foo: 'baz',
+        bad: 'not_included'
+      }
     end
+
+    subject { strategy.token_params }
+
+    its([:scope]) { is_expected.to eq('bar') }
+    its([:foo]) { is_expected.to eq('baz') }
+    its([:bad]) { is_expected.to be_nil }
   end
 
+  describe '#callback_path' do
+    subject { strategy.callback_path }
+
+    it { is_expected.to eq('/auth/redbooth/callback') }
+  end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require 'rack/test'
 require 'webmock/rspec'
 require 'omniauth'
 require 'omniauth-redbooth'
+require 'rspec/its'
 
 RSpec.configure do |config|
   config.include WebMock::API

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-redbooth
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1.rc.1
 platform: ruby
 authors:
 - Andres Bravo
@@ -10,36 +10,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +200,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Official OmniAuth strategy for Redbooth.com.
 email:
 - support@redbooth.com
@@ -190,6 +224,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -216,9 +251,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1