Support catalog product search

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} Tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake spec

.gitignore

@@ -9,4 +9,4 @@
 /tmp/
 *.gem
 .rspec_status
-*.yml
+.idea/

.rubocop.yml

@@ -3,7 +3,8 @@ AllCops:
   DisplayCopNames:    true
   DisplayStyleGuide:  true
   StyleGuideCopsOnly: true
-  TargetRubyVersion:  2.3
+  TargetRubyVersion:  2.6
+  NewCops: enable
 
 Metrics/LineLength:
   AllowHeredoc: true
@@ -12,6 +13,9 @@ Metrics/LineLength:
     - http
     - https
 
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
 Style/CaseEquality:
   Enabled: false
 
@@ -36,8 +40,12 @@ Style/PercentLiteralDelimiters:
 Style/RaiseArgs:
   Enabled: false
 
-Style/SpaceInLambdaLiteral:
-  Enabled: false
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/**/*

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.0.3]
+
+### Added
+
+ - Method to retrieve Application token
+ - [getPublicKey](https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey) request.
+
 ## [0.0.1] - To be released
 
 This is a first public release.

README.md

@@ -1,4 +1,5 @@
 # [WIP] EbayAPI
+[![Build Status](https://github.com/main24/ebay_api/actions/workflows/test.yml/badge.svg?branch=support-catalog-product-search)](https://github.com/main24/ebay_api/actions/workflows/test.yml)
 
 Ruby client to eBay RESTful JSON API
 

config/dictionary.yml

@@ -1016,6 +1016,9 @@
   - NONE
   - PRE_CHECKOUT
   - DURING_CHECKOUT
+:program_type: # https://developer.ebay.com/api-docs/sell/account/types/api:ProgramTypeEnum
+  - OUT_OF_STOCK_CONTROL
+  - SELLING_POLICY_MANAGEMENT
 :refund_status: # https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:RefundStatusEnum
   - code:       FAILED
     requested:  true

config/locales/en.yml

@@ -24,7 +24,7 @@ en:
           unsupported_marketplace: You can't use Promoted Listings at %{site}
         ebay_api/funding_strategy:
           bid_wrong_format: Promoted listing ad fee can only contain 1 fractional digit, you provided %(value)
-          bid_out_of_range: Promoted listing ad fee must be from 1% to 20%, you provided %(value)
+          bid_out_of_range: Promoted listing ad fee must be from 1% to 100%, you provided %(value)
           unsupported_funding_model: You can't use %(model) funding model, only COST_PER_SALE is allowed
       sites:
         'EBAY-AT':        'Austrian'

config/sites.yml

@@ -43,7 +43,7 @@
   :country: BE
   :currencies: [EUR]
   :host: www.ebay.be
-  :key: EBAY_BE_FR
+  :key: EBAY_BE
   :languages: [fr-BE]
 - :id: 71
   :code: EBAY-FR
@@ -78,7 +78,7 @@
   :country: BE
   :currencies: [EUR]
   :host: www.ebay.be
-  :key: EBAY_BE_NL
+  :key: EBAY_BE
   :languages: [nl-BE]
 - :id: 146
   :code: EBAY-NL
@@ -148,7 +148,7 @@
   :country: CA
   :currencies: [USD, CAD]
   :host: www.cafr.ebay.ca
-  :key: EBAY_CA_FR
+  :key: EBAY_CA
   :languages: [fr-CA]
 - :id: 211
   :code: EBAY-PH
@@ -165,7 +165,7 @@
   :key: EBAY_PL
   :languages: [pl-PL]
 - :id: 215
-  :code: EBAY-US
+  :code: EBAY-RU
   :country: RU
   :currencies: [RUB]
   :host: ebay.com/sch/Russia

config/versions.yml

@@ -6,11 +6,15 @@ buy:
   marketing: "1_beta.0.0"
   order: "1_beta.7.0"
 commerce:
-  taxonomy: "1_beta.0.0"
+  taxonomy: "1.0.0"
+  notifications: "1.0.0"
+  catalog: "1_beta.1.0"
 sell:
   account: "1.1.0"
   analytics: "1.0.0"
   fullfillemt: "1.2.0"
   inventory: "1.1.0"
-  marketing: "1.3.0"
+  marketing: "1.4.0"
   metadata: "1.1.0"
+developer:
+  analytics: "1_beta.0.0"

ebay_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "ebay_api"
-  gem.version  = "0.0.1"
+  gem.version  = "0.0.6"
   gem.author   = "Andrew Kozin (nepalez)"
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/nepalez/sms_aero"
@@ -11,16 +11,16 @@ Gem::Specification.new do |gem|
   gem.test_files       = gem.files.grep(/^spec/)
   gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
 
-  gem.required_ruby_version = ">= 2.2"
+  gem.required_ruby_version = ">= 3.0"
 
-  gem.add_runtime_dependency "evil-client", "~> 3.0", ">= 3.0.1"
+  gem.add_runtime_dependency "evil-client", "~> 3.2", ">= 3.2.0"
   gem.add_runtime_dependency "dry-equalizer"
 
   gem.add_development_dependency "rake", ">= 10"
   gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency "rspec-its", "~> 1.2"
-  gem.add_development_dependency "rubocop", "~> 0.42"
+  gem.add_development_dependency "rubocop", "~> 0.49"
   gem.add_development_dependency "timecop", "~> 0.9"
-  gem.add_development_dependency "webmock", "~> 2.1"
+  gem.add_development_dependency "webmock", "~> 3.14"
   gem.add_development_dependency "httplog"
 end

lib/ebay_api.rb

@@ -27,6 +27,12 @@ class EbayAPI < Evil::Client
   require_relative "ebay_api/middlewares"
   require_relative "ebay_api/exceptions"
 
+  I18n.load_path += Dir[File.join(GEM_ROOT, *%w[config locales ** *.{yml,yaml}])]
+
+  class << self
+    attr_accessor :logger
+  end
+
   option :token
   option :site,       Site,            optional: true
   option :language,   Language,        optional: true
@@ -41,10 +47,10 @@ class EbayAPI < Evil::Client
     errors.add :wrong_language, language: language, site: site
   end
 
-  format   "json"
-  path     { "https://api#{".sandbox" if sandbox}.ebay.com/" }
+  format "json"
+  path   { "https://api#{".sandbox" if sandbox}.ebay.com/" }
 
-  middleware JSONResponse
+  middleware { [LogRequest, JSONResponse] }
 
   security do
     token_value = token.respond_to?(:call) ? token.call : token
@@ -61,28 +67,36 @@ class EbayAPI < Evil::Client
     }.compact
   end
 
-  response(200) { |_, _, (data, *)| data }
+  response(200, 201) { |_, _, (data, *)| data }
+
+  response(204) { true }
 
   # https://developer.ebay.com/api-docs/static/handling-error-messages.html
   response(400, 401, 409) do |_, _, (data, *)|
-    case (code = data.dig("errors", 0, "errorId"))
+    data = data.to_h
+    error = data.dig("errors", 0) || {}
+    code = error["errorId"]
+    message = error["longMessage"] || error["message"]
+
+    case code
     when 1001
-      message = data.dig("errors", 0, "longMessage")
       raise InvalidAccessToken.new(code: code), message
     else
-      raise Error.new(code: code), data.dig("errors", 0, "message")
+      raise Error.new(code: code, data: data), message
     end
   end
 
   # https://go.developer.ebay.com/api-call-limits
   response(429) do |_, _, (data, *)|
+    data = data.to_h
     error = data.dig("errors", 0) || {}
     code = error["errorId"]
     message = error["longMessage"] || error["message"]
     raise RequestLimitExceeded.new(code: code), message
   end
 
   response(500) do |_, _, (data, *)|
+    data = data.to_h
     code = data.dig("errors", 0, "errorId")
     message =
         data.dig("errors", 0, "longMessage") || data.dig("errors", 0, "message")

lib/ebay_api/exceptions.rb

@@ -1,10 +1,11 @@
 class EbayAPI
   class Error < RuntimeError
-    attr_reader :code
+    attr_reader :code, :data
 
-    def initialize(*args, code: nil, **)
+    def initialize(*args, code: nil, data: nil, **)
       super(*args)
       @code = code
+      @data = data
     end
   end
 

lib/ebay_api/middlewares.rb

@@ -1,2 +1,4 @@
 require_relative "middlewares/json_response"
+require_relative "middlewares/save_to_file_response"
 require_relative "middlewares/paginated_collection"
+require_relative "middlewares/log_request"

lib/ebay_api/middlewares/json_response.rb

@@ -7,7 +7,17 @@ def initialize(app)
 
     def call(env)
       status, headers, body = @app.call(env)
-      [status, headers, body.map { |b| JSON.parse(b) unless b&.empty? }]
+
+      [status, headers, body.map { |b| parse(b) }]
+    end
+
+    private
+
+    def parse(body)
+      return unless body
+      return if body.empty?
+
+      JSON.parse(body)
     end
   end
 end

lib/ebay_api/middlewares/log_request.rb

@@ -0,0 +1,40 @@
+class EbayAPI
+  class LogRequest
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      log_request(env)
+      @app.call(env).tap { |output| log_response(output) }
+    end
+
+    private
+
+    def logger
+      @logger ||= EbayAPI.logger
+    end
+
+    def log_info(key, data = nil)
+      logger.info "[EbayAPI] | #{format('%9s', key)} | #{data}"
+    end
+
+    def log_request(env)
+      return unless logger
+      log_info "REQUEST:"
+      log_info "Url",     env["PATH_INFO"]
+      log_info "Method",  env["REQUEST_METHOD"]
+      log_info "Headers", env["HTTP_Variables"]
+      log_info "Body",    env["rack.input"]
+    end
+
+    def log_response(output)
+      return unless logger
+      status, headers, body = output
+      log_info "RESPONSE:"
+      log_info "Status",  status
+      log_info "Headers", headers
+      log_info "Body",    body
+    end
+  end
+end

lib/ebay_api/middlewares/save_to_file_response.rb

@@ -0,0 +1,29 @@
+require "securerandom"
+
+# Parses gzipped response
+class EbayAPI
+  class SaveToFileResponse
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      [status, headers, body.map { |b| save(b) }]
+    end
+
+    private
+
+    def save(body)
+      return unless body
+      return if body.empty?
+
+      file = File.new("/tmp/ebay-api-response-#{SecureRandom.hex}", "w+b")
+      file.write(body)
+      file.flush
+      file.close
+      { "filename" => file.path }.to_json
+    end
+  end
+end

lib/ebay_api/models.rb

@@ -10,3 +10,4 @@
 require_relative "models/campaign"
 require_relative "models/create_campaign_request"
 require_relative "models/funding_strategy"
+require_relative "models/program_type"

lib/ebay_api/models/amount.rb

@@ -6,7 +6,7 @@ class Amount < Evil::Client::Model
     option :value,    ->(v) { v.to_f.round(2) }
     option :currency, Currency
 
-    validate { errors.add :negative_value, to_h if value.negative? }
+    validate { errors.add :negative_value, **to_h if value.negative? }
 
     def to_h
       { value: value.to_s, currency: currency.code }