Merge pull request #5 from koshilife/feature/#4_make_code_coverage_100

refs #4 add tests

Author: koshilife

.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/SuppressedException:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 2
+
+Layout/LineLength:
+ AllowURI: true
+ Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+
+Metrics/ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    map:      'collect'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/Lambda:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

lib/omniauth-zoom/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Omniauth
+module OmniAuth
   module Zoom
     VERSION = '0.1.0'
   end

lib/omniauth/strategies/zoom.rb

@@ -6,51 +6,44 @@
 
 module OmniAuth
   module Strategies
+    # OmniAuth strategy for zoom.us
     class Zoom < OmniAuth::Strategies::OAuth2
       option :name, 'zoom'
-      option :client_options, site: 'https://zoom.us'
+      option :client_options, :site => 'https://zoom.us'
 
-      uid { raw_info[:id] }
+      uid { raw_info['id'] }
+      extra { {:raw_info => raw_info} }
 
-      extra do
-        { raw_info: raw_info }
-      end
-
-      protected
+    protected
 
       def build_access_token
         params = {
-          grant_type: 'authorization_code',
-          code: request.params['code'],
-          redirect_uri: callback_url
+          :grant_type => 'authorization_code',
+          :code => request.params['code'],
+          :redirect_uri => callback_url
         }
-        path = "#{client.options[:token_url]}?#{params.to_query}"
-        token = Base64.strict_encode64("#{client.id}:#{client.secret}")
-        opts = { headers: { Authorization: "Basic #{token}" } }
-
-        response = client.request(:post, path, opts)
-        access_token_opts = response.parsed.merge(deep_symbolize(options.auth_token_params))
-        ::OAuth2::AccessToken.from_hash(client, access_token_opts).tap do |access_token|
-          if access_token.respond_to?(:response=)
-            access_token.response = response
-          end
-        end
-      end
+        path = "#{client.options[:token_url]}?#{URI.encode_www_form(params)}"
+        headers_secret = Base64.strict_encode64("#{client.id}:#{client.secret}")
+        opts = {:headers => {:Authorization => "Basic #{headers_secret}"}}
 
-      def callback_url
-        full_host + script_name + callback_path
+        res = client.request(:post, path, opts)
+        ::OAuth2::AccessToken.from_hash(client, res.parsed)
       end
 
+    private
+
       def raw_info
-        return @raw_info unless @raw_info.nil?
+        return @raw_info if defined?(@raw_info)
 
-        res = access_token.get('/v2/users/me')
-        @raw_info = JSON.parse(res.body, symbolize_names: true)
+        @raw_info = access_token.get('/v2/users/me').parsed || {}
       rescue StandardError => e
-        logger = OmniAuth.config.logger
-        logger&.debug("#{self.class}.#{__method__} #{e.class} occured. message:#{e.message}")
+        log(:error, "#{e.class} occured. message:#{e.message}")
         @raw_info = {}
       end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
     end
   end
 end

omniauth-zoom.gemspec

@@ -4,7 +4,7 @@ require_relative 'lib/omniauth-zoom/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'omniauth-zoom'
-  spec.version       = Omniauth::Zoom::VERSION
+  spec.version       = OmniAuth::Zoom::VERSION
   spec.authors       = ['Kenji Koshikawa']
   spec.email         = ['koshikawa2009@gmail.com']
 
@@ -35,6 +35,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codecov', '~> 0.1.17'
   spec.add_development_dependency 'minitest', '~> 5.14.1'
   spec.add_development_dependency 'minitest-reporters', '~> 1.4.2'
+  spec.add_development_dependency 'omniauth', '~> 1.9.1'
+  spec.add_development_dependency 'rack-test', '~> 1.1.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'webmock', '~> 3.7.6'
 end

test/omniauth/zoom_test.rb

@@ -2,8 +2,59 @@
 
 require 'test_helper'
 
-class Omniauth::ZoomTest < Minitest::Test
-  def test_that_it_has_a_version_number
-    refute_nil ::Omniauth::Zoom::VERSION
+class StrategyZoomTest < StrategyTest
+  def test_it_has_a_version_number
+    refute_nil ::OmniAuth::Zoom::VERSION
+  end
+
+  def test_it_has_a_client_options
+    args = [@client_id, @client_secret, @options]
+    strat = OmniAuth::Strategies::Zoom.new(nil, *args)
+    assert_equal(@client_id, strat.options[:client_id])
+    assert_equal(@client_secret, strat.options[:client_secret])
+    assert_equal(@scope, strat.options[:scope])
+    assert_equal('https://zoom.us', strat.options[:client_options][:site])
+  end
+
+  def test_it_returns_auth_hash_in_callback_phase
+    add_mock_exchange_token
+    add_mock_user_info
+    post '/auth/zoom/callback', :code => @authorization_code, :state => 'state123'
+
+    actual_auth = auth_hash.to_hash
+    assert(!actual_auth['credentials'].delete('expires_at').nil?)
+    expected_auth = {
+      'provider' => 'zoom',
+      'uid' => dummy_user_info_response[:id],
+      'info' => {'name' => nil},
+      'credentials' => {'token' => 'DUMMY_TOKEN', 'refresh_token' => 'DUMMY_REFRESH_TOKEN', 'expires' => true},
+      'extra' => {
+        'raw_info' => JSON.parse(dummy_user_info_response.to_json)
+      }
+    }
+    assert_equal(expected_auth, actual_auth)
+  end
+
+  def test_it_returns_auth_hash_in_case_of_failure_of_get_user_info_in_callbach_phase
+    add_mock_exchange_token
+    add_mock_user_info_then_fail
+    post '/auth/zoom/callback', :code => @authorization_code, :state => 'state123'
+
+    actual_auth = auth_hash.to_hash
+    assert(!actual_auth['credentials'].delete('expires_at').nil?)
+    expected_auth = {
+      'provider' => 'zoom',
+      'uid' => nil,
+      'info' => {'name' => nil},
+      'credentials' => {'token' => 'DUMMY_TOKEN', 'refresh_token' => 'DUMMY_REFRESH_TOKEN', 'expires' => true},
+      'extra' => {'raw_info' => {}}
+    }
+    assert_equal(expected_auth, actual_auth)
+  end
+
+private
+
+  def auth_hash
+    last_request.env['omniauth.auth']
   end
 end

test/test_helper.rb

@@ -11,5 +11,99 @@
 require 'minitest/autorun'
 require 'minitest/reporters'
 Minitest::Reporters.use!
+require 'webmock/minitest'
 
 require 'omniauth-zoom'
+require 'omniauth'
+require 'rack/test'
+
+class StrategyTest < Minitest::Test
+  include OmniAuth::Test::StrategyTestCase
+  include Rack::Test::Methods
+
+  def setup
+    ENV['OAUTH_DEBUG'] = 'true'
+    @logger = Logger.new STDOUT
+    OmniAuth.config.logger = @logger
+
+    @client_id = 'DUMMY_CLIENT_ID'
+    @client_secret = 'DUMMY_CLIENT_SECRET'
+    @scope = 'user_profile'
+    @options = {:scope => @scope, :provider_ignores_state => true}
+    @authorization_code = 'DUMMY_AUTH_CODE'
+    @access_token = 'DUMMY_TOKEN'
+  end
+
+protected
+
+  def strategy
+    [OmniAuth::Strategies::Zoom, @client_id, @client_secret, @options]
+  end
+
+  def add_mock_exchange_token
+    WebMock.enable!
+    url = "https://zoom.us/oauth/token?code=#{@authorization_code}&grant_type=authorization_code&redirect_uri=http://example.org/auth/zoom/callback"
+    secret = Base64.strict_encode64("#{@client_id}:#{@client_secret}")
+    headers = {'Authorization' => "Basic #{secret}"}
+    res_headers = {'Content-Type' => 'application/json'}
+    stub_request(:post, url).with(:headers => headers).to_return(:status => 200, :body => dummy_token_response.to_json, :headers => res_headers)
+  end
+
+  def dummy_token_response
+    {
+      :access_token => @access_token,
+      :token_type => 'bearer',
+      :refresh_token => 'DUMMY_REFRESH_TOKEN',
+      :expires_in => 3600,
+      :scope => 'user_profile'
+    }
+  end
+
+  def add_mock_user_info
+    WebMock.enable!
+    url = 'https://zoom.us/v2/users/me'
+    headers = {'Authorization' => "Bearer #{@access_token}"}
+    res_headers = {'Content-Type' => 'application/json'}
+    stub_request(:get, url).with(:headers => headers).to_return(:status => 200, :body => dummy_user_info_response.to_json, :headers => res_headers)
+  end
+
+  def add_mock_user_info_then_fail
+    WebMock.enable!
+    url = 'https://zoom.us/v2/users/me'
+    response = {:code => 124, :message => 'Invalid access token.'}
+    headers = {'Authorization' => "Bearer #{@access_token}"}
+    res_headers = {'Content-Type' => 'application/json'}
+    stub_request(:get, url).with(:headers => headers).to_return(:status => 400, :body => response.to_json, :headers => res_headers)
+  end
+
+  def dummy_user_info_response
+    {
+      :id => 'KdYKjnimT4KPd8FFgQt9FQ',
+      :first_name => 'Jane',
+      :last_name => 'Dev',
+      :email => 'jane.dev@email.com',
+      :type => 2,
+      :role_name => 'Owner',
+      :pmi => 1_234_567_890,
+      :use_pmi => false,
+      :vanity_url => 'https://janedevinc.zoom.us/my/janedev',
+      :personal_meeting_url => 'https://janedevinc.zoom.us/j/1234567890',
+      :timezone => 'America/Denver',
+      :verified => 1,
+      :dept => '',
+      :created_at => '2019-04-05T15:24:32Z',
+      :last_login_time => '2019-12-16T18:02:48Z',
+      :last_client_version => '4.6.12611.1124(mac)',
+      :pic_url => 'https://janedev.zoom.us/p/KdYKjnimFR5Td8KKdQt9FQ/19f6430f-ca72-4154-8998-ede6be4542c7-837',
+      :host_key => '533895',
+      :jid => 'kdykjnimt4kpd8kkdqt9fq@xmpp.zoom.us',
+      :group_ids => [],
+      :im_group_ids => ['3NXCD9VFTCOUH8LD-QciGw'],
+      :account_id => 'gVcjZnYYRLDbb_MfgHuaxg',
+      :language => 'en-US',
+      :phone_country => 'US',
+      :phone_number => '+1 1234567891',
+      :status => 'active'
+    }
+  end
+end