omniauth-ebay-oauth 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76629a38f44a3dca39c9b623f58fec1e984c3d92cf395cbfaa06f6f4a145789c
-  data.tar.gz: f013e52aa87b50efb83d4db7c4c5c896f230809f1482bf035fd32f0acc7a5beb
+  metadata.gz: 4fb141a515171c5891e73fa328ffe959abbea166644a927f43f546143b9384ad
+  data.tar.gz: fcdba1511fd15fd35f0dbc21b52ef5ebc37c319b744dd344de550410bcfb5dd4
 SHA512:
-  metadata.gz: d2f3ca9e26bd5533b3f0abcb59a34b3a1ce7fdd2271c8cb911fd8fd491da19519d354dba3152cdc0fd9c752bba2fe592a6c6458cf21f8a81c153d9f385dcf534
-  data.tar.gz: af48978d15b1750b595da5c65d67e448ec1b96631efaab0711d3780445452c15f97c53bf2053dd66cc20657fe2ae458d8d6752b0bd28cbcba8021550c5039146
+  metadata.gz: 1035eaf825e69b8e9de0a6eefcd5054228b7366c10ccfd81ce5370f6998e7d03650c40c65e70709ea635a43bc70ce596064b941f3a52a69c9f109fda3f45988f
+  data.tar.gz: b173b770f3d439d956cd4c287201b4eb523392a3bda50b10e4bc3fe93d0002ef4a45cd63884765ae48cf7756cf86b8c67ee4ed615c212ee61494e66227309457

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2018-03-23
+
+### Added
+
+ - Handling of suspended users login. @Envek
+
+   Fail authentication with specific code so application can handle it.
+
 ## [0.2.0] - 2018-03-16
 
 ### Changed

data/lib/omniauth/ebay-oauth/errors.rb

@@ -2,8 +2,10 @@
 
 module OmniAuth
   module EbayOauth
-    class FailureResponseCode < StandardError; end
-    class FailureResponseResult < StandardError; end
-    class UnsupportedSchemaError < StandardError; end
+    class Error < RuntimeError; end
+    class FailureResponseCode < Error; end
+    class FailureResponseResult < Error; end
+    class UnsupportedSchemaError < Error; end
+    class UserSuspended < Error; end
   end
 end

data/lib/omniauth/ebay-oauth/user_info_request.rb

@@ -19,6 +19,10 @@ module OmniAuth
         'X-EBAY-API-CALL-NAME' => 'GetUser'
       }.freeze
 
+      ERRORS = {
+        '841' => UserSuspended
+      }.freeze
+
       def initialize(access_token, request: USER_REQUEST,
                      user_info_endpoint:, read_timeout:, **_args)
         @access_token = access_token
@@ -45,7 +49,13 @@ module OmniAuth
 
       def ensure_success_result(body)
         return if body.dig(*STATUS_PATH) == SUCCESS_CODE
-        raise FailureResponseResult, body
+
+        error_code = body.dig('GetUserResponse', 'Errors', 'ErrorCode')
+        raise(FailureResponseResult, body) unless ERRORS.key?(error_code)
+
+        err_class = ERRORS[error_code]
+        err_message = body.dig('GetUserResponse', 'Errors', 'LongMessage')
+        raise err_class, err_message
       end
 
       def http

data/lib/omniauth/ebay-oauth/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module EbayOauth
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/omniauth/strategies/ebay_oauth.rb

@@ -33,6 +33,12 @@ module OmniAuth
         super
       end
 
+      def callback_phase
+        super
+      rescue ::OmniAuth::EbayOauth::UserSuspended => e
+        fail!(:user_suspended, e)
+      end
+
       def callback_url
         options.callback_url
       end

data/omniauth-ebay-oauth.gemspec

@@ -7,8 +7,8 @@ require 'omniauth/ebay-oauth/version'
 Gem::Specification.new do |spec|
   spec.name          = 'omniauth-ebay-oauth'
   spec.version       = OmniAuth::EbayOauth::VERSION
-  spec.authors       = ['Ignat Zakrevsky']
-  spec.email         = ['iezakrevsky@gmail.com']
+  spec.authors       = ['Ignat Zakrevsky', 'Andrey Novikov']
+  spec.email         = ['iezakrevsky@gmail.com', 'envek@envek.name']
   spec.summary       = 'OmniAuth strategy for new eBay OAuth API'
   spec.homepage      = 'https://github.com/evilmartians/omniauth-ebay-oauth'
   spec.license       = 'MIT'

data/spec/fixtures/user_suspended.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents">
+  <Timestamp>2018-03-21T09:22:11.985Z</Timestamp>
+  <Ack>Failure</Ack>
+  <Errors>
+    <ShortMessage>Requested user is suspended.</ShortMessage>
+    <LongMessage>The account for user ID \"evilenvek\" specified in this request is suspended. Sorry, you can only request information for current users.</LongMessage>
+    <ErrorCode>841</ErrorCode>
+    <SeverityCode>Error</SeverityCode>
+    <ErrorClassification>RequestError</ErrorClassification>
+    <ErrorParameters>
+      <ParamID>0</ParamID>
+      <Value>evilenvek</Value>
+    </ErrorParameters>
+  </Errors>
+  <Version>1045</Version>
+  <Build>E1045_CORE_APISIGNIN_18614794_R</Build>
+</GetUserResponse>

data/spec/omniauth/ebay-oauth/user_info_request_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe OmniAuth::EbayOauth::UserInfoRequest do
   let(:request_headers) { YAML.load_file('spec/fixtures/request_headers.yml') }
   let(:failure_result)  { File.read('spec/fixtures/result_failure.xml') }
   let(:success_result)  { File.read('spec/fixtures/result_success.xml') }
+  let(:user_suspended_result)  { File.read('spec/fixtures/user_suspended.xml') }
 
   it 'raises error if eBay API request returned non-successful code' do
     stub_request(:post, endpoint)
@@ -39,4 +40,12 @@ RSpec.describe OmniAuth::EbayOauth::UserInfoRequest do
     expect(subject.call.fetch('GetUserResponse').keys)
       .to eql %w[xmlns Timestamp Ack Version Build User]
   end
+
+  it 'raises error if eBay user is suspended' do
+    stub_request(:post, endpoint)
+      .with(body: body, headers: request_headers)
+      .to_return(status: 200, body: user_suspended_result, headers: {})
+    expect { subject.call }
+      .to raise_error(OmniAuth::EbayOauth::UserSuspended)
+  end
 end

data/spec/omniauth/strategies/ebay_oauth_spec.rb

@@ -3,6 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe OmniAuth::Strategies::EbayOauth do
+  let(:options) { {} }
+
   subject { described_class.new(nil, options) }
 
   describe '#callback_url' do
@@ -14,8 +16,6 @@ RSpec.describe OmniAuth::Strategies::EbayOauth do
   end
 
   describe '#options' do
-    let(:options) { {} }
-
     before { subject.setup_phase }
 
     it 'default mode is sandbox' do
@@ -33,8 +33,6 @@ RSpec.describe OmniAuth::Strategies::EbayOauth do
     end
 
     context "when scopes aren't passed" do
-      let(:options) { {} }
-
       it 'uses empty string as scope' do
         expect(subject.options.scope).to eql ''
       end
@@ -99,7 +97,6 @@ RSpec.describe OmniAuth::Strategies::EbayOauth do
 
   describe '#user_info' do
     let(:access_token) { instance_double(OAuth2::AccessToken, token: :token) }
-    let(:options) { {} }
     let(:user_info) { instance_double(OmniAuth::EbayOauth::UserInfo) }
     let(:request) do
       instance_double(OmniAuth::EbayOauth::UserInfoRequest, call: {})
@@ -120,8 +117,6 @@ RSpec.describe OmniAuth::Strategies::EbayOauth do
 
   describe '#credentials' do
     let(:access_token) { OAuth2::AccessToken.new(client, token, opts) }
-    let(:options) { {} }
-
     let(:client) { instance_double(OAuth2::Client) }
     let(:token)  { 'v^1.1#i^1#f^0#I^3#r^0#p^3#t^H4sIAAAAAAAAAOlongstringtoken' }
     let(:opts) do
@@ -144,4 +139,20 @@ RSpec.describe OmniAuth::Strategies::EbayOauth do
         .to be_between(current_time, current_time + expiration_time)
     end
   end
+
+  describe '#callback_phase' do
+    context 'when user is suspended' do
+      before do
+        allow(subject).to receive(:request) do
+          raise OmniAuth::EbayOauth::UserSuspended
+        end
+        allow(subject).to receive(:fail!)
+      end
+
+      it 'fails with user_suspended message' do
+        subject.callback_phase
+        expect(subject).to have_received(:fail!).with(:user_suspended, anything)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-ebay-oauth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ignat Zakrevsky
+- Andrey Novikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -125,6 +126,7 @@ dependencies:
 description: 
 email:
 - iezakrevsky@gmail.com
+- envek@envek.name
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -150,6 +152,7 @@ files:
 - spec/fixtures/request_headers.yml
 - spec/fixtures/result_failure.xml
 - spec/fixtures/result_success.xml
+- spec/fixtures/user_suspended.xml
 - spec/omniauth/ebay-oauth/user_info_request_spec.rb
 - spec/omniauth/ebay-oauth/user_info_spec.rb
 - spec/omniauth/strategies/ebay_oauth_spec.rb