omniauth-icalia 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 639cd1645e7cf5c313a531d912ee22f9050ab57dac3cff0badd3042bd55fe249
-  data.tar.gz: 1925f26f026e334cc4274318f603563d6f1accb95cef046fcbb6e72f5f8299ea
+  metadata.gz: 6cad58273fb22cba6b5c8d71664759576620fa2537740fdfccde10cb60f2fff0
+  data.tar.gz: 7e276c2f58291e30add46bebb595658afddc43e6b2c7d06f21aa7096b726b68e
 SHA512:
-  metadata.gz: f37cf9a8b6572028d3ca09bf2f3d277d5689bf5a240e4cd42787f8f7744f5e9b809292fd7e7a1c475903f73f24cd17c79dbe6131c0cf8a54e75b91b2bbb23a74
-  data.tar.gz: ea3586542406a86fba4f17dccc6b0cae09a6df54be04b2d44a1e6886ecdf26ef6acf6fabae0a3d0d4c396638693bd900d193d24e93396c7819422b8c65e3c080
+  metadata.gz: 0aca0652ac4f348489ad9486182bdb3cee95c926c307865aa0a9d91b2c84287c5fe2b562dc46f76857a542ef0b256d2a433fbdcc4544b2b3c979dd6baef3845d
+  data.tar.gz: 469abd58dd314111be50a440e7055d3939c3b1b133b25ebc13e46ea04549dd8aae48d63ed274b299f1993fc9ff246f6d6ac681678257601af3c39475a657f68b

data/README.md

@@ -24,6 +24,33 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+## System Testing on your app
+
+You can use the included service stub in your system tests.
+
+On your spec_helper, or test setup file:
+
+```ruby
+require 'omniauth-icalia/service_stubs'
+```
+
+Then, in your test setup, call `prepare`:
+
+```ruby
+# For example, in RSpec:
+before { Icalia::StubbedSSOService.prepare }
+
+# Use a block if you need to set the data returned by the service:
+before do 
+  Icalia::StubbedSSOService.prepare do |config|
+    # Optionally add example data about the expected token owner:
+    config.example_resource_owner_id = SecureRandom.uuid
+    config.example_resource_owner_given_name = 'George'
+    config.example_resource_owner_family_name = 'Harrison'
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/icalia/stubbed_sso_service.rb

@@ -0,0 +1,176 @@
+require 'sinatra/base'
+
+require 'capybara'
+require 'capybara/server'
+
+require 'socket'
+
+module Icalia
+  class StubbedSSOService < Sinatra::Base
+    FIND_AVAILABLE_PORT = 0
+    CODE = 'icalia_oauth_authorization_code'.freeze
+
+    post '/oauth/token' do
+      if params[:code] == CODE
+        response.headers['Content-Type'] = 'application/json'
+        flow = oauth_flows.last
+        data = flow.slice('state').merge(
+          access_token: 'ACCESS_TOKEN',
+          token_type: 'Bearer',
+          created_at: DateTime.now.to_i
+        )
+        flow[:granted_access_data] = data
+        data.to_json
+      else
+        status 400
+        {
+          error: 'invalid_grant',
+          error_description: "Authorization code does not exist: #{code}",
+        }.to_json
+      end
+    end
+
+    get '/oauth/authorize' do
+      store_oauth_flow_data params
+      uri = URI(params[:redirect_uri])
+      uri.query = URI.encode_www_form(state: params[:state], code: CODE)
+      redirect uri
+    end
+
+    get '/oauth/token/info' do
+      flow = oauth_flows.last
+      data = {
+        data: {
+          id: SecureRandom.uuid,
+          type: 'oauth-access-token',
+          attributes: {
+            scopes: [],
+            'expires-at': nil,
+            'created-at': Time.at(flow.dig(:granted_access_data, :created_at))
+          },
+          relationships: {
+            'resource-owner': {
+              data: { type: 'person', id: example_resource_owner_id }
+            }
+          }
+        },
+        included: [
+          {
+            type: 'person',
+            id: example_resource_owner_id,
+            attributes: {
+              'full-name': example_resource_owner_full_name,
+              'given-name': example_resource_owner_given_name,
+              'family-name': example_resource_owner_family_name,
+              'gender-type': example_resource_owner_gender_type,
+              'custom-gender': example_resource_owner_custom_gender
+            }
+          }
+        ]
+      }
+      response.headers['Content-Type'] = 'application/vnd.api+json'
+      data.to_json
+    end
+
+    %i[example_resource_owner_id example_resource_owner_given_name
+      example_resource_owner_family_name example_resource_owner_gender_type
+      example_resource_owner_custom_gender].each do |method_name|
+        define_singleton_method method_name do
+          class_variable_get("@@#{method_name}")
+        end
+        
+        define_singleton_method "#{method_name}=".to_sym do |value|
+          class_variable_set("@@#{method_name}", value)
+        end
+      end
+
+    %i[oauth_flows store_oauth_flow_data example_resource_owner_id
+      example_resource_owner_given_name example_resource_owner_family_name
+      example_resource_owner_gender_type example_resource_owner_full_name
+      example_resource_owner_custom_gender].each do |method_name|
+        define_method method_name do |*args|
+          self.class.public_send method_name, *args
+        end
+      end
+
+    class << self
+      def oauth_flows
+        @oauth_flows ||= []
+      end
+
+      def reset
+        oauth_flows.clear
+    
+        self.example_resource_owner_id = SecureRandom.uuid
+        self.example_resource_owner_given_name = 'Example Person'
+        self.example_resource_owner_family_name = 'From Artanis'
+        self.example_resource_owner_gender_type = 'male'
+        self.example_resource_owner_custom_gender = nil
+      end
+    
+      def example_resource_owner_full_name
+        [example_resource_owner_given_name, example_resource_owner_family_name]
+          .compact.join(' ').strip
+      end
+    
+      def store_oauth_flow_data(data)
+        oauth_flows << data
+      end
+    
+      # Taken from FakeStripe.stub_stripe at fake_stripe gem: 
+      def prepare
+        reset
+    
+        yield self if block_given?
+    
+        # Since the OAuth flow is performed by the browser, we'll need to boot
+        # the Sinatra app instead of just stubbing the app with WebMock...
+        boot_once
+    
+        oauth_host = "http://localhost:#{server_port}"
+
+        OmniAuth::Strategies::Icalia.instances.each do |options|
+          client_options = options.client_options
+          client_options.site = oauth_host
+          client_options.token_url = "#{oauth_host}/oauth/token"
+          client_options.authorize_url = "#{oauth_host}/oauth/authorize"
+        end
+      end
+
+      def teardown
+        default_client_options = OmniAuth::Strategies::Icalia
+          .default_options
+          .client_options
+
+        OmniAuth::Strategies::Icalia.instances.each do |options|
+          client_options = options.client_options
+          client_options.site = default_client_options.site
+          client_options.token_url = default_client_options.token_url
+          client_options.authorize_url = default_client_options.authorize_url
+        end
+      end
+
+      # Taken from FakeStripe::Utils at fake_stripe gem: =======================
+      def find_available_port
+        server = TCPServer.new(FIND_AVAILABLE_PORT)
+        server.addr[1]
+      ensure
+        server.close if server
+      end
+
+      # Taken from Bootable at fake_stripe gem: ================================
+      def boot(port = find_available_port)
+        instance = new
+        Capybara::Server.new(instance, port: port).tap(&:boot)
+      end
+  
+      def boot_once
+        @boot_once ||= boot(server_port)
+      end
+  
+      def server_port
+        @server_port ||= find_available_port
+      end
+    end
+  end
+end

data/lib/omniauth-icalia/service_stubs.rb

@@ -0,0 +1 @@
+require 'icalia/stubbed_sso_service'

data/lib/omniauth-icalia/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Icalia
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/omniauth/strategies/icalia.rb

@@ -12,6 +12,18 @@ module OmniAuth
         authorize_url: 'https://artanis.icalialabs.com/oauth/authorize'
       }
 
+      @@instances = []
+
+      def self.instances
+        class_variable_get('@@instances')
+      end
+
+      def initialize(*args)
+        instance = super(*args)
+        @@instances << instance
+        instance
+      end
+
       def request_phase
         super
       end

data/omniauth-icalia.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'icalia-sdk-event-core', '~> 0.3', '>= 0.3.5'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'capybara', '~> 3.0', '>= 3.0.0'
+  spec.add_development_dependency 'sinatra', '~> 2.0', '>= 2.0.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-icalia
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-16 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -78,20 +78,60 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -121,12 +161,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/icalia/stubbed_sso_service.rb
 - lib/omniauth-icalia.rb
+- lib/omniauth-icalia/service_stubs.rb
 - lib/omniauth-icalia/version.rb
 - lib/omniauth/strategies/icalia.rb
 - omniauth-icalia.gemspec
-- spec/omniauth/strategies/icalia_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/IcaliaLabs/omniauth-icalia
 licenses:
 - MIT
@@ -150,6 +190,4 @@ rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Official Omniauth Strategy for Icalia.
-test_files:
-- spec/omniauth/strategies/icalia_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/omniauth/strategies/icalia_spec.rb

@@ -1,109 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe OmniAuth::Strategies::Icalia do
-  let(:access_token) { instance_double('AccessToken', :options => {}, :[] => 'user') }
-  let(:parsed_response) { instance_double('ParsedResponse') }
-  let(:response) { instance_double('Response', :parsed => parsed_response) }
-
-  let(:example_overridden_site)          { 'https://example.com' }
-  let(:example_overridden_token_url)     { 'https://example.com/oauth/token' }
-  let(:example_overridden_authorize_url) { 'https://example.com/oauth/authorize' }
-  
-  let(:example_options) { {} }
-
-  subject do
-    OmniAuth::Strategies::Icalia.new 'ICALIA_CLIENT_KEY',
-                                     'ICALIA_CLIENT_SECRET',
-                                     example_options
-  end
-
-  before :each do
-    allow(subject).to receive(:access_token).and_return(access_token)
-  end
-
-  describe 'client options' do
-    context 'defaults' do
-      it 'site is artanis' do
-        expect(subject.options.client_options.site).to eq 'https://artanis.icalialabs.com'
-      end
-
-      it 'authorize url is artanis authorize url' do
-        expect(subject.options.client_options.authorize_url).to eq 'https://artanis.icalialabs.com/oauth/authorize'
-      end
-
-      it 'token url is artanis token url' do
-        expect(subject.options.client_options.token_url).to eq 'https://artanis.icalialabs.com/oauth/token'
-      end
-    end
-
-    context 'overrides' do
-      let :example_options do 
-        {
-          client_options: {
-            site: example_overridden_site,
-            token_url: example_overridden_token_url,
-            authorize_url: example_overridden_authorize_url,
-          }
-        }
-      end
-
-      it 'allows overriding the site' do
-        expect(subject.options.client_options.site)
-          .to eq example_overridden_site
-      end
-      
-      it 'allows overriding the authorize url' do
-        expect(subject.options.client_options.authorize_url)
-          .to eq example_overridden_authorize_url
-      end
-
-      it 'allows overriding the token url' do
-        expect(subject.options.client_options.token_url)
-          .to eq example_overridden_token_url
-      end
-    end
-  end
-
-  describe '#raw_info', skip: true do
-    it 'should use relative paths' do
-      expect(access_token).to receive(:get).with('/oauth/token/info?include=resource-owner.email-accounts').and_return(response)
-      expect(subject.raw_info).to eq(parsed_response)
-    end
-
-    it 'should use the header auth mode' do
-      expect(access_token).to receive(:get).with('user').and_return(response)
-      subject.raw_info
-      expect(access_token.options[:mode]).to eq(:header)
-    end
-  end
-
-  describe '#info.email', skip: true do
-    it 'should use any available email' do
-      allow(subject).to receive(:raw_info).and_return({})
-      allow(subject).to receive(:email).and_return('you@example.com')
-      expect(subject.info['email']).to eq('you@example.com')
-    end
-  end
-
-  context '#info.urls', skip: true do
-    it 'should use html_url from raw_info' do
-      allow(subject).to receive(:raw_info).and_return({ 'login' => 'me', 'html_url' => 'http://enterprise/me' })
-      expect(subject.info['urls']['icalia']).to eq('http://enterprise/me')
-    end
-  end
-
-  context '#extra.scope' do
-    it 'returns the scope on the returned access_token' do
-      expect(subject.scope).to eq('user')
-    end
-  end
-
-  describe '#callback_url' do
-    it 'is a combination of host, script name, and callback path' do
-      allow(subject).to receive(:full_host).and_return('https://example.com')
-      allow(subject).to receive(:script_name).and_return('/sub_uri')
-
-      expect(subject.callback_url).to eq('https://example.com/sub_uri/auth/icalia/callback')
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,14 +0,0 @@
-require 'bundler/setup'
-require 'omniauth-icalia'
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = 'examples.txt'
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end