omniauth-ebay-oauth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a3ee3f09f7e2fd936ac49fa1512e29e6e4ed1df
+  data.tar.gz: 6d0ce4be65417086d284dd903e6b098aed7cc41e
+SHA512:
+  metadata.gz: 33576de1081fb33087a2ea9793e98f25ae29e4ed292ed99c55eba7d92979daca8cfdce4cb25c07947eda3f52f4dcb73847a2660f49f75f0a4df8146b124869b1
+  data.tar.gz: a2829309ed789bee85d16296c0641d1229881750ccc5b04324ccf5d2b0d5261fe62a7942208b2fefc56d3b166463780ceaceceb74fb9134edf8c583750a27823

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/*.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Andrey Novikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# omniauth-ebay-oauth
+
+OmniAuth Strategy for eBay Apps (for using with eBay REST APIs)
+
+<a href="https://evilmartians.com/?utm_source=omniauth-ebay-oauth&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+## Preface
+
+> Why do I need it? There are a couple of other gems with OmniAuth strategies for eBay?
+
+eBay has two different authorization methods: Auth'n'auth and OAuth. Technically, they are both uses OAuth2 protocol (just to embrace a little confusion).
+
+This gem implements authorization with OAuth method while currently available gems (like [ebay_request](https://github.com/gzigzigzeo/ebay_request) or [omniauth-ebay](https://github.com/TheGiftsProject/omniauth-ebay)) implements Auth'n'auth.
+
+__What is the difference? Access tokens!__
+
+With Auth'n'auth you will get a single token which you can use to access old eBay XML APIs (Trading API, etc.)
+
+With OAuth, you will get a pair of access and refresh tokens which can be used to access new eBay REST APIs (Buy API, Sell API, etc.)
+
+However, you can use new OAuth tokens to access old APIs by providing an access token in (not yet) documented HTTP header `X-EBAY-API-IAF-TOKEN` (like this gem uses it to obtain information about an authenticated user from Trading API).
+
+If you plan to use only old APIs, you can look at [ebay_request](https://github.com/gzigzigzeo/ebay_request) gem.
+
+If you plan to use new APIs, you are welcome to use this gem either standalone or together with [ebay_api](https://github.com/nepalez/ebay_api) client get for REST APIs.
+
+Now you can read the eBay docs about [REST APIs](https://developer.ebay.com/api-docs/static/ebay-rest-landing.html) and [OAuth](https://developer.ebay.com/api-docs/static/oauth-quick-ref-user-tokens.html) and then proceed to…
+
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'omniauth-ebay-oauth'
+```
+
+Then execute:
+
+```sh
+bundle install
+```
+
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :ebay, CLIENT_ID, CLIENT_SECRET, callback_url: RU_NAME,
+    sandbox: false, scope: 'https://api.ebay.com/oauth/api_scope' # redefining additional default options
+end
+```
+
+Required options:
+  - __CLIENT_ID__, __CLIENT_SECRET__ - Your application's [OAuth credentials](<https://developer.ebay.com/api-docs/static/oauth-credentials.html>) for the environment you're targeting.
+  - __callback_url__  - Your application's [RuName](<https://developer.ebay.com/api-docs/static/oauth-runame.html>) for the environment you're targeting.
+
+Additional options:
+  - __sandbox__ - Are you running your application in [sandbox mode](<https://developer.ebay.com/api-docs/static/sandbox-landing.html>), default __`true`__.
+  - __scope__ - A list of [OAuth scopes](<https://developer.ebay.com/api-docs/static/oauth-details.html#scopes>) that provide access to the interfaces you call, default: __`[]`__. If you want change scopes you could pass it as string or as array of scopes like so: `['https://api.ebay.com/oauth/api_scope/sell.marketing.readonly', 'https://api.ebay.com/oauth/api_scope/sell.account.readonly']`
+  - __read_timeout__ - Number of seconds to wait for one block to be read for Auth'n'auth eBay API requests, default is 60.
+  - \+ all [OmniAuth](<https://github.com/omniauth/omniauth>) supported options, like: `callback_path`, `provider_ignores_state` and so on.
+
+Additional usage information could be found on [OmniAuth README page](<https://github.com/omniauth/omniauth#integrating-omniauth-into-your-application>).
+
+
+## Minimal working Sinatra application:
+
+```ruby
+require 'sinatra'
+require 'omniauth-ebay-oauth'
+
+use Rack::Session::Cookie
+use OmniAuth::Builder do
+  provider :ebay, ENV['EBAY_CLIENT_ID'], ENV['EBAY_CLIENT_SECRET'],
+    callback_url: ENV['EBAY_RU_NAME']
+end
+
+get '/' do
+  redirect '/auth/ebay'
+end
+
+get '/auth/ebay/callback' do
+  "Hello, #{request.env['omniauth.auth'].dig('info', 'name')}"
+end
+```
+
+
+## Development
+
+To pass your code through the all checks you simply need to run:
+
+```
+bundle exec rake
+```
+
+Please, keep in mind [OmniAuth Strategy Contribution Guide](<https://github.com/omniauth/omniauth/wiki/Strategy-Contribution-Guide>) and [eBay developers program](<https://developer.ebay.com/api-docs/static/oauth-tokens.html>).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evilmartians/omniauth-ebay-oauth.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new do |task|
+  task.options = %w[--auto-correct]
+end
+
+task default: %i[rubocop spec]

data/lib/omniauth-ebay-oauth.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+require 'omniauth/ebay-oauth/version'
+
+require 'omniauth/ebay-oauth/errors'
+require 'omniauth/ebay-oauth/user_info'
+require 'omniauth/ebay-oauth/user_info_request'
+require 'omniauth/strategies/ebay'

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module EbayOauth
+    class FailureResponseCode < StandardError; end
+    class FailureResponseResult < StandardError; end
+    class UnsupportedSchemaError < StandardError; end
+  end
+end

data/lib/omniauth/ebay-oauth/get_user.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents">
+  <ErrorLanguage>en_US</ErrorLanguage>
+  <WarningLevel>High</WarningLevel>
+  <DetailLevel>ReturnAll</DetailLevel>
+</GetUserRequest>

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module EbayOauth
+    # Maps user information from Auth'n'auth eBay API to OmniAuth Auth Hash
+    # Schema version 1.0
+    # https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema
+    class UserInfo
+      MAPPING = {
+        uid: %w[GetUserResponse User EIASToken],
+        name: %w[GetUserResponse User RegistrationAddress Name],
+        nickname: %w[GetUserResponse User UserID],
+        email: %w[GetUserResponse User Email]
+      }.freeze
+
+      def initialize(body)
+        @body = body
+      end
+
+      def uid
+        field(:uid, required: true)
+      end
+
+      def info
+        {
+          name: field(:name, required: true),
+          email: field(:email),
+          nickname: field(:nickname),
+          first_name: field(:name).split.first,
+          last_name: field(:name).split.last
+        }
+      end
+
+      def extra
+        { raw_info: @body.dig('GetUserResponse', 'User') }
+      end
+
+      private
+
+      def field(name, required: false)
+        @body.dig(*MAPPING.fetch(name)).tap do |value|
+          if value.nil? && required
+            raise UnsupportedSchemaError, "Can't find field #{name}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module EbayOauth
+    # Receives user information from Auth'n'auth eBay API
+    # https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetUser.html
+    class UserInfoRequest
+      STATUS_PATH  = %w[GetUserResponse Ack].freeze
+      SUCCESS_CODE = 'Success'
+      USER_REQUEST = File.read(
+        File.join(File.dirname(__FILE__), 'get_user.xml')
+      )
+
+      TOKEN_HEADER  = 'X-EBAY-API-IAF-TOKEN'
+      BASIC_HEADERS = {
+        'Content-Type' => 'text/xml',
+        'X-EBAY-API-COMPATIBILITY-LEVEL' => 967,
+        'X-EBAY-API-SITEID' => 0,
+        'X-EBAY-API-CALL-NAME' => 'GetUser'
+      }.freeze
+
+      def initialize(access_token, request: USER_REQUEST,
+                     user_info_endpoint:, read_timeout:, **_args)
+        @access_token = access_token
+        @url = URI(user_info_endpoint)
+        @read_timeout = read_timeout
+        @request = request
+      end
+
+      def call
+        MultiXml.parse(
+          http
+            .request(ebay_request)
+            .tap(&method(:ensure_success_code))
+            .read_body
+        ).tap(&method(:ensure_success_result))
+      end
+
+      private
+
+      def ensure_success_code(response)
+        return if (200..299).cover?(response.code.to_i)
+        raise FailureResponseCode, response
+      end
+
+      def ensure_success_result(body)
+        return if body.dig(*STATUS_PATH) == SUCCESS_CODE
+        raise FailureResponseResult, body
+      end
+
+      def http
+        Net::HTTP.new(@url.host, @url.port).tap do |http|
+          http.read_timeout = @read_timeout
+          http.use_ssl = true
+        end
+      end
+
+      def ebay_request
+        Net::HTTP::Post.new(@url).tap do |request|
+          BASIC_HEADERS.merge(TOKEN_HEADER => @access_token)
+                       .each { |header, value| request[header] = value }
+          request.body = @request
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module EbayOauth
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/ebay.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Strategies
+    # OmniAuth strategy for eBay
+    class Ebay < OmniAuth::Strategies::OAuth2
+      option :production_client_options,
+             user_info_endpoint: 'https://api.ebay.com/ws/api.dll',
+             token_url: 'https://api.ebay.com/identity/v1/oauth2/token',
+             authorize_url: 'https://signin.ebay.com/authorize'
+      option :sandbox_client_options,
+             user_info_endpoint: 'https://api.sandbox.ebay.com/ws/api.dll',
+             token_url: 'https://api.sandbox.ebay.com/identity/v1/oauth2/token',
+             authorize_url: 'https://signin.sandbox.ebay.com/authorize'
+
+      option :name, :ebay
+      option :sandbox, true
+      option :callback_url
+
+      option :authorize_options, %i[scope]
+      option :client_options, auth_scheme: :basic_auth, read_timeout: 60
+
+      uid          { user_info.uid }
+      info         { user_info.info }
+      extra        { user_info.extra }
+      credentials  { user_credentials }
+
+      def setup_phase
+        options.scope = preprocessed_scopes
+        options.client_options.merge!(environment_urls)
+        super
+      end
+
+      def callback_url
+        options.callback_url
+      end
+
+      private
+
+      def user_credentials
+        self.class.superclass.credentials_stack(self).first.merge(
+          'refresh_token_expires_at' =>
+            access_token['refresh_token_expires_in'].to_i + Time.now.to_i
+        )
+      end
+
+      def preprocessed_scopes
+        Array(options.scope).join(' ')
+      end
+
+      def environment_urls
+        if options.sandbox
+          options.sandbox_client_options
+        else
+          options.production_client_options
+        end
+      end
+
+      def user_info
+        @user_info ||=
+          OmniAuth::EbayOauth::UserInfo.new(OmniAuth::EbayOauth::UserInfoRequest
+          .new(access_token.token, client.options).call)
+      end
+    end
+  end
+end

data/omniauth-ebay-oauth.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = 'OmniAuth strategy for new eBay OAuth API'
+  spec.homepage      = 'https://github.com/evilmartians/omniauth-ebay-oauth'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'omniauth', '~> 1.5'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '>= 10'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.42'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

data/spec/fixtures/request_headers.yml

@@ -0,0 +1,10 @@
+---
+Accept: "*/*"
+Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+Content-Type: text/xml
+Host: api.com
+User-Agent: Ruby
+X-Ebay-Api-Call-Name: GetUser
+X-Ebay-Api-Compatibility-Level: '967'
+X-Ebay-Api-Iaf-Token: token
+X-Ebay-Api-Siteid: '0'

data/spec/fixtures/result_failure.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents">
+  <Timestamp>2017-11-03T15:10:16.972Z</Timestamp>
+  <Ack>Failure</Ack>
+  <Errors>
+    <ShortMessage>Expired IAF token.</ShortMessage>
+    <LongMessage>IAF token supplied is expired. </LongMessage>
+    <ErrorCode>21917053</ErrorCode>
+    <SeverityCode>Error</SeverityCode>
+    <ErrorClassification>RequestError</ErrorClassification>
+  </Errors>
+  <Version>1031</Version>
+  <Build>E1031_CORE_APISIGNIN_18531943_R1</Build>
+</GetUserResponse>

data/spec/fixtures/result_success.xml

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents">
+  <Timestamp>2017-11-03T15:31:05.024Z</Timestamp>
+  <Ack>Success</Ack>
+  <Version>1031</Version>
+  <Build>E1031_CORE_APISIGNIN_18531943_R1</Build>
+  <User>
+    <AboutMePage>false</AboutMePage>
+    <EIASToken>nY+sHZ2PrKoij6wVnY+sEZ2PrA2dj6ACmYChC5WDoQydj6x9nY+seQ==</EIASToken>
+    <Email>olegpetrov@mail.com</Email>
+    <FeedbackScore>0</FeedbackScore>
+    <UniqueNegativeFeedbackCount>0</UniqueNegativeFeedbackCount>
+    <UniquePositiveFeedbackCount>0</UniquePositiveFeedbackCount>
+    <PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
+    <FeedbackPrivate>false</FeedbackPrivate>
+    <FeedbackRatingStar>None</FeedbackRatingStar>
+    <IDVerified>false</IDVerified>
+    <eBayGoodStanding>true</eBayGoodStanding>
+    <NewUser>true</NewUser>
+    <RegistrationAddress>
+      <Name>Oleg Petrov</Name>
+      <Street>Ap #867-859 Sit Rd.</Street>
+      <Street1>Sit Rd</Street1>
+      <Street2>#867-859</Street2>
+      <CityName>Azusa</CityName>
+      <Country>US</Country>
+      <CountryName>United States</CountryName>
+      <Phone>7931516230</Phone>
+      <PostalCode>91702</PostalCode>
+    </RegistrationAddress>
+    <RegistrationDate>2017-11-01T20:21:09.000Z</RegistrationDate>
+    <Site>US</Site>
+    <Status>Confirmed</Status>
+    <UserID>olegpetrov</UserID>
+    <UserIDChanged>false</UserIDChanged>
+    <VATStatus>NoVATTax</VATStatus>
+    <SellerInfo>
+      <AllowPaymentEdit>true</AllowPaymentEdit>
+      <CheckoutEnabled>true</CheckoutEnabled>
+      <CIPBankAccountStored>false</CIPBankAccountStored>
+      <GoodStanding>true</GoodStanding>
+      <LiveAuctionAuthorized>false</LiveAuctionAuthorized>
+      <MerchandizingPref>OptIn</MerchandizingPref>
+      <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
+      <SellerGuaranteeLevel>NotEligible</SellerGuaranteeLevel>
+      <SchedulingInfo>
+        <MaxScheduledMinutes>30240</MaxScheduledMinutes>
+        <MinScheduledMinutes>0</MinScheduledMinutes>
+        <MaxScheduledItems>3000</MaxScheduledItems>
+      </SchedulingInfo>
+      <StoreOwner>false</StoreOwner>
+      <SellerBusinessType>Private</SellerBusinessType>
+      <PaymentMethod>NothingOnFile</PaymentMethod>
+      <CharityRegistered>false</CharityRegistered>
+      <SafePaymentExempt>false</SafePaymentExempt>
+      <TransactionPercent>0.0</TransactionPercent>
+      <RecoupmentPolicyConsent />
+      <DomesticRateTable>false</DomesticRateTable>
+      <InternationalRateTable>false</InternationalRateTable>
+    </SellerInfo>
+    <BusinessRole>FullMarketPlaceParticipant</BusinessRole>
+    <eBayWikiReadOnly>false</eBayWikiReadOnly>
+    <MotorsDealer>false</MotorsDealer>
+    <UniqueNeutralFeedbackCount>0</UniqueNeutralFeedbackCount>
+    <EnterpriseSeller>false</EnterpriseSeller>
+  </User>
+</GetUserResponse>

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe OmniAuth::EbayOauth::UserInfoRequest do
+  subject do
+    described_class.new(token, user_info_endpoint: endpoint, read_timeout: 20,
+                               request: body)
+  end
+
+  let(:endpoint) { 'https://api.com/endpoint' }
+  let(:token)    { 'token' }
+  let(:body)     { '<>' }
+
+  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') }
+
+  it 'raises error if eBay API request returned non-successful code' do
+    stub_request(:post, endpoint)
+      .with(body: body, headers: request_headers)
+      .to_return(status: 400, body: '', headers: {})
+    expect { subject.call }
+      .to raise_error(OmniAuth::EbayOauth::FailureResponseCode)
+  end
+
+  it 'raises error if eBay API returned non-successful result' do
+    stub_request(:post, endpoint)
+      .with(body: body, headers: request_headers)
+      .to_return(status: 200, body: failure_result, headers: {})
+    expect { subject.call }
+      .to raise_error(OmniAuth::EbayOauth::FailureResponseResult)
+  end
+
+  it 'returns parsed result from eBay in case of all is correct' do
+    stub_request(:post, endpoint)
+      .with(body: body, headers: request_headers)
+      .to_return(status: 200, body: success_result, headers: {})
+    expect(subject.call.fetch('GetUserResponse').keys)
+      .to eql %w[xmlns Timestamp Ack Version Build User]
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe OmniAuth::EbayOauth::UserInfo do
+  subject { described_class.new(parsed_body) }
+
+  let(:xml_body) { File.read('spec/fixtures/result_success.xml') }
+  let(:parsed_body) { MultiXml.parse(xml_body) }
+
+  context 'when passed invalid schema' do
+    let(:parsed_body) { {} }
+
+    it "raises error if can't find required uid" do
+      expect { subject.uid }
+        .to raise_error(OmniAuth::EbayOauth::UnsupportedSchemaError)
+    end
+
+    it "raises error if can't find required name" do
+      expect { subject.info }
+        .to raise_error(OmniAuth::EbayOauth::UnsupportedSchemaError)
+    end
+  end
+
+  describe '#uid' do
+    let(:uid) { 'nY+sHZ2PrKoij6wVnY+sEZ2PrA2dj6ACmYChC5WDoQydj6x9nY+seQ==' }
+
+    it 'returns user unique identification' do
+      expect(subject.uid).to eql uid
+    end
+  end
+
+  describe '#info' do
+    it 'returns user info corresponding to auth schema', :aggregate_failures do
+      {
+        name: 'Oleg Petrov',
+        email: 'olegpetrov@mail.com',
+        nickname: 'olegpetrov',
+        first_name: 'Oleg',
+        last_name: 'Petrov'
+      }.each do |key, value|
+        expect(subject.info.fetch(key)).to eql(value)
+      end
+    end
+  end
+
+  describe '#extra' do
+    it 'returns user additional information', :aggregate_failures do
+      expect(subject.extra.keys).to eql %i[raw_info]
+      expect(subject.extra[:raw_info].keys)
+        .to eql %w[AboutMePage EIASToken Email FeedbackScore
+                   UniqueNegativeFeedbackCount UniquePositiveFeedbackCount
+                   PositiveFeedbackPercent FeedbackPrivate FeedbackRatingStar
+                   IDVerified eBayGoodStanding NewUser RegistrationAddress
+                   RegistrationDate Site Status UserID UserIDChanged VATStatus
+                   SellerInfo BusinessRole eBayWikiReadOnly MotorsDealer
+                   UniqueNeutralFeedbackCount EnterpriseSeller]
+    end
+  end
+end

data/spec/omniauth/strategies/ebay_spec.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe OmniAuth::Strategies::Ebay do
+  subject { described_class.new(nil, options) }
+
+  describe '#callback_url' do
+    let(:callback_url) { 'https://api.com/callback' }
+    let(:options) { { callback_url: callback_url } }
+    it 'uses options callback_url' do
+      expect(subject.callback_url).to eql(callback_url)
+    end
+  end
+
+  describe '#options' do
+    let(:options) { {} }
+
+    before { subject.setup_phase }
+
+    it 'default mode is sandbox' do
+      expect(subject.options.client_options.user_info_endpoint)
+        .to eq('https://api.sandbox.ebay.com/ws/api.dll')
+    end
+
+    context 'when setup block passed' do
+      let(:block) { proc { |_env| (@result ||= 0) && @result += 1 } }
+      let(:options) { { setup: block } }
+
+      it 'runs the setup block if passed one' do
+        expect(block.call).to eql 2
+      end
+    end
+
+    context "when scopes aren't passed" do
+      let(:options) { {} }
+
+      it 'uses empty string as scope' do
+        expect(subject.options.scope).to eql ''
+      end
+    end
+
+    context 'when scopes passed' do
+      context 'as array' do
+        let(:options) { { scope: %w[array like scopes] } }
+
+        it 'concatenates passed scopes with space' do
+          expect(subject.options.scope).to eql 'array like scopes'
+        end
+      end
+
+      context 'as string' do
+        let(:options) { { scope: 'scope as string' } }
+
+        it 'keeps scopes the same' do
+          expect(subject.options.scope).to eql 'scope as string'
+        end
+      end
+    end
+
+    context 'sandbox mode' do
+      let(:options) { { sandbox: true } }
+
+      it 'has correct eBay sandbox user info endpoint' do
+        expect(subject.options.client_options.user_info_endpoint)
+          .to eq('https://api.sandbox.ebay.com/ws/api.dll')
+      end
+
+      it 'has correct eBay sandbox token url' do
+        expect(subject.options.client_options.token_url)
+          .to eq('https://api.sandbox.ebay.com/identity/v1/oauth2/token')
+      end
+
+      it 'has correct eBay sandbox authorize url' do
+        expect(subject.options.client_options.authorize_url)
+          .to eq('https://signin.sandbox.ebay.com/authorize')
+      end
+    end
+
+    context 'production mode' do
+      let(:options) { { sandbox: false } }
+
+      it 'has correct eBay production user info endpoint' do
+        expect(subject.options.client_options.user_info_endpoint)
+          .to eq('https://api.ebay.com/ws/api.dll')
+      end
+
+      it 'has correct eBay production token url' do
+        expect(subject.options.client_options.token_url)
+          .to eq('https://api.ebay.com/identity/v1/oauth2/token')
+      end
+
+      it 'has correct eBay production authorize url' do
+        expect(subject.options.client_options.authorize_url)
+          .to eq('https://signin.ebay.com/authorize')
+      end
+    end
+  end
+
+  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: {})
+    end
+
+    before do
+      expect(subject).to receive(:access_token).and_return(access_token)
+      expect(OmniAuth::EbayOauth::UserInfoRequest)
+        .to receive(:new).and_return(request)
+      expect(OmniAuth::EbayOauth::UserInfo)
+        .to receive(:new).with({}).and_return(user_info)
+    end
+
+    it 'returns wrapped user info request' do
+      expect(subject.send(:user_info)).to eql(user_info)
+    end
+  end
+
+  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
+      {
+        'expires_in' => 7200,
+        'refresh_token' => refresh_token,
+        'refresh_token_expires_in' => expiration_time,
+        'token_type' => 'User Access Token'
+      }
+    end
+
+    let(:refresh_token) { 'v^1.1#i^1#r^1#f^0#I^3#p^3#t^Urefreshtoken=' }
+    let(:expiration_time) { 47_304_000 }
+    let(:current_time) { Time.now.to_i }
+
+    before { allow(subject).to receive(:access_token).and_return(access_token) }
+
+    it 'adds refresh_token_expires_at for default OAuth2 credentials hash' do
+      expect(subject.credentials['refresh_token_expires_at'])
+        .to be_between(current_time, current_time + expiration_time)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter 'vendor/'
+end
+
+require 'omniauth-ebay-oauth'
+
+OmniAuth.config.logger = Logger.new('/dev/null')
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-ebay-oauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ignat Zakrevsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- iezakrevsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-ebay-oauth.rb
+- lib/omniauth/ebay-oauth/errors.rb
+- lib/omniauth/ebay-oauth/get_user.xml
+- lib/omniauth/ebay-oauth/user_info.rb
+- lib/omniauth/ebay-oauth/user_info_request.rb
+- lib/omniauth/ebay-oauth/version.rb
+- lib/omniauth/strategies/ebay.rb
+- omniauth-ebay-oauth.gemspec
+- spec/fixtures/request_headers.yml
+- spec/fixtures/result_failure.xml
+- spec/fixtures/result_success.xml
+- spec/omniauth/ebay-oauth/user_info_request_spec.rb
+- spec/omniauth/ebay-oauth/user_info_spec.rb
+- spec/omniauth/strategies/ebay_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/evilmartians/omniauth-ebay-oauth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for new eBay OAuth API
+test_files: []