RubyGems - omniauth-slooob - Versions diffs - 1.0.0 - Mend

omniauth-slooob 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (126) hide show

data/examples/rails_example/public/422.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/examples/rails_example/public/500.html ADDED

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/examples/rails_example/public/apple-touch-icon-precomposed.png ADDED

File without changes

data/examples/rails_example/public/apple-touch-icon.png ADDED

File without changes

data/examples/rails_example/public/favicon.ico ADDED

File without changes

data/examples/rails_example/public/robots.txt ADDED

	@@ -0,0 +1 @@
1	+ # See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/examples/rails_example/test/application_system_test_case.rb ADDED

@@ -0,0 +1,5 @@
+require "test_helper"
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end

data/examples/rails_example/test/controllers/.keep ADDED

File without changes

data/examples/rails_example/test/controllers/books_controller_test.rb ADDED

@@ -0,0 +1,48 @@
+require 'test_helper'
+class BooksControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @book = books(:one)
+  end
+  test "should get index" do
+    get books_url
+    assert_response :success
+  end
+  test "should get new" do
+    get new_book_url
+    assert_response :success
+  end
+  test "should create book" do
+    assert_difference('Book.count') do
+      post books_url, params: { book: {  } }
+    end
+    assert_redirected_to book_url(Book.last)
+  end
+  test "should show book" do
+    get book_url(@book)
+    assert_response :success
+  end
+  test "should get edit" do
+    get edit_book_url(@book)
+    assert_response :success
+  end
+  test "should update book" do
+    patch book_url(@book), params: { book: {  } }
+    assert_redirected_to book_url(@book)
+  end
+  test "should destroy book" do
+    assert_difference('Book.count', -1) do
+      delete book_url(@book)
+    end
+    assert_redirected_to books_url
+  end
+end

data/examples/rails_example/test/controllers/sessions_controller_test.rb ADDED

@@ -0,0 +1,9 @@
+require 'test_helper'
+class SessionsControllerTest < ActionDispatch::IntegrationTest
+  test "should get create" do
+    get sessions_create_url
+    assert_response :success
+  end
+end

data/examples/rails_example/test/fixtures/.keep ADDED

File without changes

data/examples/rails_example/test/fixtures/books.yml ADDED

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+# This model initially had no columns defined. If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+# column: value

data/examples/rails_example/test/fixtures/files/.keep ADDED

File without changes

data/examples/rails_example/test/fixtures/users.yml ADDED

@@ -0,0 +1,9 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+one:
+  uid: MyString
+  name: MyString
+two:
+  uid: MyString
+  name: MyString

data/examples/rails_example/test/helpers/.keep ADDED

File without changes

data/examples/rails_example/test/integration/.keep ADDED

File without changes

data/examples/rails_example/test/mailers/.keep ADDED

File without changes

data/examples/rails_example/test/models/.keep ADDED

File without changes

data/examples/rails_example/test/models/book_test.rb ADDED

@@ -0,0 +1,7 @@
+require 'test_helper'
+class BookTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/examples/rails_example/test/models/user_test.rb ADDED

@@ -0,0 +1,7 @@
+require 'test_helper'
+class UserTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/examples/rails_example/test/system/.keep ADDED

File without changes

data/examples/rails_example/test/system/books_test.rb ADDED

@@ -0,0 +1,9 @@
+require "application_system_test_case"
+class BooksTest < ApplicationSystemTestCase
+  # test "visiting the index" do
+  #   visit books_url
+  #
+  #   assert_selector "h1", text: "Book"
+  # end
+end

data/examples/rails_example/test/test_helper.rb ADDED

@@ -0,0 +1,9 @@
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+  # Add more helper methods to be used by all tests here...
+end

data/examples/rails_example/vendor/.keep ADDED

File without changes

data/lib/omniauth-slooob.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'omniauth/slooob'

data/lib/omniauth/slooob.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'omniauth/strategies/slooob'

data/lib/omniauth/slooob/version.rb ADDED

@@ -0,0 +1,7 @@
+module OmniAuth
+    module Slooob
+        VERSION = '1.0.0'
+    end
+end

data/lib/omniauth/strategies/slooob.rb ADDED

@@ -0,0 +1,95 @@
+require 'multi_json'
+require 'omniauth/strategies/oauth2'
+module OmniAuth
+    module Strategies
+        class Slooob < OmniAuth::Strategies::OAuth2
+            DEFAULT_SCOPE = 'email public'
+            option :name, :slooob
+            option :authorize_options, %i[incremental_authorization image_size scope state]
+            option :client_options, {
+                site: 'https://api.slooob.com',
+                authorize_url: '/oauth/authorize'
+            }
+            def authorize_params
+                super.tap do |params|
+                    options[:authorize_options].each do |k|
+                        params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
+                    end
+                    params[:scope] = get_scope params
+                    session['omniauth.state'] = params[:state] if params[:state]
+                end
+            end
+            uid { raw_info[:id] }
+            info do
+                prune!(
+                    email: raw_info[:email],
+                    username: raw_info[:username],
+                    name: raw_info[:name],
+                    first_name: raw_info[:first_name],
+                    last_name: raw_info[:last_name],
+                    description: raw_info[:name],
+                    image: image_url,
+                    location: raw_info[:location],
+                    confirmed: raw_info[:email_confirmed],
+                    urls: {
+                        website: raw_info[:website],
+                        slooob: raw_info[:profile]
+                    }
+                )
+            end
+            extra do
+                hash = {}
+                hash[:raw_info] = raw_info unless skip_info?
+                prune! hash
+            end
+            def raw_info
+                @raw_info ||= access_token.get('/identity/v1/resource.json').parsed
+            end
+            private
+            # https://github.com/intridea/omniauth-oauth2/issues/81
+            def callback_url
+                options[:redirect_uri] || (full_host + script_name + callback_path)
+            end
+            def prune! hash
+                hash.delete_if do |_, v|
+                    prune!(v) if v.is_a?(Hash)
+                    v.nil? || (v.respond_to?(:empty?) && v.empty?)
+                end
+            end
+            def get_scope params
+                raw_scope = params[:scope] || DEFAULT_SCOPE
+                scope_list = raw_scope.split(' ').map { |item| item.split(',') }.flatten
+                scope_list.map! { |s| s =~ %r{^https?://} }
+                scope_list.join(' ')
+            end
+            def image_url
+                return nil unless raw_info['avatar']
+                image_size = options[:image_size] || 'raw'
+                image_url = raw_info['avatar'].has_key?(image_size) ? raw_info['avatar'][image_size] : raw_info['avatar']
+                return image_url
+            end
+        end
+    end
+end

data/omniauth-slooob.gemspec ADDED

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path File.join('..', 'lib', 'omniauth', 'slooob', 'version'), __FILE__
+Gem::Specification.new do |gem|
+    gem.name                  = 'omniauth-slooob'
+    gem.version               = OmniAuth::Slooob::VERSION
+    gem.platform              = Gem::Platform::RUBY
+    gem.summary               = 'Slooob OAuth2 strategy for OmniAuth'
+    gem.description           = 'Slooob OAuth2 Strategy for OmniAuth. Built on Slooob Identity API v1.'
+    gem.authors               = 'Slooob'
+    gem.email                 = 'developer@slooob.com'
+    gem.homepage              = 'https://developer.slooob.com/docs/api/identity/v1'
+    gem.license               = 'MIT'
+    gem.files                 = `git ls-files`.split("\n")
+    gem.require_paths         = ['lib']
+    gem.required_ruby_version = '>= 2.0'
+    gem.add_runtime_dependency 'omniauth', '>= 1.1.1'
+    gem.add_runtime_dependency 'omniauth-oauth2', '>= 1.3.1'
+    gem.add_runtime_dependency 'multi_json', '~> 1.12'
+    gem.add_development_dependency 'shoulda', '~> 3.5'
+    gem.add_development_dependency 'shoulda-let', '~> 0.0'
+    gem.add_development_dependency 'tzinfo-data', '~> 1.2017'
+    gem.add_development_dependency 'rubocop', '~> 0.49'
+end

data/test/test.rb ADDED

@@ -0,0 +1,239 @@
+# Configure Rails Envinronment
+ENV['RAILS_ENV'] = 'test'
+# # Test Coverage
+# require 'simplecov'
+# SimpleCov.start
+require 'shoulda'
+require 'shoulda/let'
+class Test
+    let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
+    let(:app) do
+        lambda do
+            [200, {}, ['Hello.']]
+        end
+    end
+    setup do
+        OmniAuth::Strategies::Slooob.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+            allow(strategy).to receive(:request) do
+                request
+            end
+        end
+    end
+    before do
+        OmniAuth.config.test_mode = true
+    end
+    after do
+        OmniAuth.config.test_mode = false
+    end
+    context '#client_options' do
+        should 'have correct site' do
+            assert_equal 'https://api.slooob.com', subject.client.site
+        end
+        should 'have correct authorize_url' do
+            assert_equal '/oauth/authorize', subject.client.options[:authorize_url]
+        end
+        should 'have correct token_url' do
+            assert_equal '/oauth/token', subject.client.options[:token_url]
+        end
+        context 'overrides' do
+            context 'as strings' do
+                should 'allow overriding the site' do
+                    @options = { client_options: { site: 'https://example.com' } }
+                    assert_equal 'https://example.com', subject.client.site
+                end
+                should 'allow overriding the authorize_url' do
+                    @options = { client_options: { authorize_url: 'https://example.com' } }
+                    assert_equal 'https://example.com', subject.client.options[:authorize_url]
+                end
+                should 'allow overriding the token_url' do
+                    @options = { client_options: { token_url: 'https://example.com' } }
+                    assert_equal 'https://example.com', subject.client.options[:token_url]
+                end
+            end
+            context 'as symbols' do
+                should 'allow overriding the site' do
+                    @options = { client_options: { site: 'https://example.com' } }
+                    assert_equal 'https://example.com', subject.client.site
+                end
+                should 'allow overriding the authorize_url' do
+                    @options = { client_options: { authorize_url: 'https://example.com' } }
+                    assert_equal 'https://example.com', subject.client.options[:authorize_url]
+                end
+                should 'allow overriding the token_url' do
+                    @options = { client_options: { token_url: 'https://example.com' } }
+                    assert_equal 'https://example.com', subject.client.options[:token_url]
+                end
+            end
+        end
+    end
+    context '#authorize_options' do
+        %i[email image_size redirect_uri incremental_authorization scope state].each do |k|
+            should "support #{k}" do
+                @options = { k => 'https://example.com' }
+                assert_equal 'https://example.com', subject.authorize_params[k.to_s]
+            end
+        end
+        context 'redirect_uri' do
+            should 'default to nil' do
+                @options = {}
+                assert_equal nil, subject.authorize_params['redirect_uri']
+            end
+            should 'set the redirect_uri parameter if present' do
+                @options = { redirect_uri: 'https://example.com' }
+                assert_equal 'https://example.com', subject.authorize_params['redirect_uri']
+            end
+        end
+        context 'email' do
+            should 'default to nil' do
+                assert_equal nil, subject.authorize_params['email']
+            end
+            should 'set the email parameter if present' do
+                @options = { email: 'john@example.com' }
+                assert_equal 'john@example.com', subject.authorize_params['email']
+            end
+        end
+        context 'image_size' do
+            should 'default to nil' do
+                assert_equal nil, subject.authorize_params['image_size']
+            end
+            should 'set the image_size parameter if present' do
+                @options = { image_size: 'raw' }
+                assert_equal 'raw', subject.authorize_params['image_size']
+            end
+        end
+        context 'incremental_authorization' do
+            should 'default to nil' do
+                assert_equal nil, subject.authorize_params['incremental_authorization']
+            end
+            should 'set the incremental_authorization parameter if present' do
+                @options = { incremental_authorization: true }
+                assert_equal true, subject.authorize_params['incremental_authorization']
+            end
+        end
+        context 'scope' do
+            should 'join scopes' do
+                @options = { scope: 'public,email' }
+                assert_equal 'public email', subject.authorize_params['scope']
+            end
+            should 'deal with whitespace when joining scopes' do
+                @options = { scope: 'public, email' }
+                assert_equal 'public email', subject.authorize_params['scope']
+            end
+            should 'set default scope to `email public`' do
+                assert_equal 'public email', subject.authorize_params['scope']
+            end
+            should 'support space delimited scopes' do
+                @options = { scope: 'public email' }
+                assert_equal 'public email', subject.authorize_params['scope']
+            end
+        end
+        context 'state' do
+            should 'set the state parameter' do
+                @options = { state: 'some_state' }
+                assert_equal 'some_state', subject.authorize_params['state']
+                assert_equal 'some_state', subject.authorize_params[:state]
+                assert_equal 'some_state', subject.session['omniauth.state']
+            end
+        end
+        context 'overrides' do
+            should 'include top-level options that are marked as :authorize_options' do
+                @options = { authorize_options: %i[scope], scope: 'messaging' }
+                assert_equal 'messaging', subject.authorize_params['scope']
+            end
+            context 'request overrides' do
+                %i[incremental_authorization scope state].each do |k|
+                    context "authorize option #{k}" do
+                        let(:request) { double('Request', params: { k.to_s => 'http://example.com' }, cookies: {}, env: {}) }
+                        should "set the #{k} authorize option dynamically in the request" do
+                            @options = { k: '' }
+                            assert_equal 'http://example.com', subject.authorize_params[k.to_s]
+                        end
+                    end
+                end
+                context 'custom authorize_options' do
+                    let(:request) { double('Request', params: { 'foo' => 'bar' }, cookies: {}, env: {}) }
+                    should 'support request overrides from custom authorize_options' do
+                        @options = { authorize_options: [:foo], foo: '' }
+                        assert_equal 'bar', subject.authorize_params['foo']
+                    end
+                end
+            end
+        end
+    end
+    context '#authorize_params' do
+        should 'include any authorize params passed in the :authorize_params option' do
+            @options = { authorize_params: { scope: 'something', foo: 'bar', baz: 'zip' }, incremental_authorization: true, bad: 'not_included' }
+            assert_equal 'something', subject.authorize_params['scope']
+            assert_equal 'bar', subject.authorize_params['foo']
+            assert_equal 'zip', subject.authorize_params['baz']
+            assert_equal true, subject.authorize_params['incremental_authorization']
+            assert_equal nil, subject.authorize_params['bad']
+        end
+    end
+    context '#token_params' do
+        should 'include any token params passed in the :token_params option' do
+            @options = { token_params: { foo: 'bar', baz: 'zip' } }
+            assert_equal 'bar', subject.token_params['foo']
+            assert_equal 'zip', subject.token_params['baz']
+        end
+    end
+    context '#token_options' do
+        should 'include top-level options that are marked as :token_options' do
+            @options = { token_options: %i[scope foo], scope: 'bar', foo: 'baz', bad: 'not_included' }
+            assert_equal 'bar', subject.token_params['scope']
+            assert_equal 'baz', subject.token_params['foo']
+            assert_equal nil, subject.token_params['bad']
+        end
+    end
+    context '#callback_path' do
+        should 'have the correct default callback path' do
+            assert_equal '/auth/slooob/callback', subject.callback_path
+        end
+        should 'set the callback_path parameter if present' do
+            @options = { callback_path: '/auth/foo/callback' }
+            assert_equal '/auth/foo/callback', subject.callback_path
+        end
+    end
+end