ebay-ruby 0.2.0 → 0.3.4

data/lib/ebay/merchandising.rb

@@ -1,9 +1,96 @@
-require 'ebay/request'
+# frozen_string_literal: true
 
+require 'ebay/config'
+require 'ebay/requestable'
+
+# Ruby wrapper to the eBay APIs
 module Ebay
-  class Merchandising < Request
-    host 'svcs.ebay.com'
-    path '/MerchandisingService'
-    headers 'EBAY-SOA-CONSUMER-ID' => Config.app_id
+  # Returns a {Ebay::Merchandising#initialize Merchandising API} instance
+  def self.merchandising(**params)
+    Merchandising.new(**params)
+  end
+
+  # Retrieves information about products or item listings on eBay to help you
+  # sell more merchandise to eBay buyers
+  #
+  # @see https://developer.ebay.com/Devzone/merchandising/docs/Concepts/MerchandisingAPI_FormatOverview.html
+  # @see https://developer.ebay.com/Devzone/merchandising/docs/CallRef/index.html
+  class Merchandising
+    include Requestable
+
+    self.endpoint = 'https://svcs.ebay.com/MerchandisingService'
+
+    # @return [String]
+    attr_reader :consumer_id
+
+    # @return [String]
+    attr_reader :global_id
+
+    # @return [String]
+    attr_reader :response_data_format
+
+    # @return [String]
+    attr_reader :service_version
+
+    # Returns a Finding API request instance
+    #
+    # @param [String] consumer_id
+    # @param [String] global_id
+    # @param [String] response_data_format
+    # @param [String] service_version
+    def initialize(consumer_id: Config.app_id, global_id: nil,
+                   response_data_format: nil, service_version: nil)
+      @consumer_id = consumer_id
+      @global_id = global_id
+      @response_data_format = response_data_format
+      @service_version = service_version
+    end
+
+    # Retrieves data for items with the highest watch count
+    #
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_most_watched_items(payload = {})
+      request('getMostWatchedItems', payload)
+    end
+
+    # Retrieves recommended items from categories related to a specified
+    # category or item
+    #
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_related_category_items(payload = {})
+      request('getRelatedCategoryItems', payload)
+    end
+
+    # Retrieves items that are similar to the specified item
+    #
+    # @param [String] item_id
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_similar_items(item_id, payload = {})
+      payload = payload.merge('itemId' => item_id)
+      request('getSimilarItems', payload)
+    end
+
+    # Returns the current service version
+    #
+    # @return [HTTP::Response]
+    def get_version
+      request('getVersion')
+    end
+
+    private
+
+    def request(operation, payload = {})
+      params = { 'CONSUMER-ID' => consumer_id,
+                 'GLOBAL-ID' => global_id,
+                 'OPERATION-NAME' => operation,
+                 'REQUEST-DATA-FORMAT' => 'JSON',
+                 'RESPONSE-DATA-FORMAT' => response_data_format,
+                 'SERVICE-VERSION' => service_version }.compact
+
+      http.post(endpoint, params: params, body: JSON.dump(payload))
+    end
   end
 end

data/lib/ebay/oauth/client_credentials_grant.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'ebay/config'
+require 'ebay/requestable'
+
+module Ebay
+  module Oauth
+    # Mints an access token to use in API requests
+    #
+    # @see https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html
+    class ClientCredentialsGrant
+      include Requestable
+
+      self.endpoint = 'https://api.ebay.com/identity/v1/oauth2/token'
+
+      # @return [String]
+      attr_reader :app_id
+
+      # @return [String]
+      attr_reader :cert_id
+
+      # @param [String] app_id
+      # @param [String] cert_id
+      def initialize(app_id: Config.app_id, cert_id: Config.cert_id)
+        @app_id = app_id
+        @cert_id = cert_id
+      end
+
+      # Mints a new access token
+      #
+      # @return [String]
+      def mint_access_token
+        JSON.parse(request).fetch('access_token')
+      end
+
+      # Requests a client credentials grant
+      #
+      # @return [HTTP::Response]
+      def request
+        http.basic_auth(user: app_id, pass: cert_id)
+            .post(endpoint, form: payload)
+      end
+
+      private
+
+      def payload
+        { grant_type: 'client_credentials',
+          scope: 'https://api.ebay.com/oauth/api_scope' }
+      end
+    end
+  end
+end

data/lib/ebay/requestable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'http'
+
+module Ebay
+  # Adds an HTTP client and ability to switch to the eBay Sandbox environment
+  module Requestable
+    class << self
+      private
+
+      def included(base)
+        class << base
+          attr_accessor :endpoint
+        end
+      end
+    end
+
+    # @return [HTTP::Client]
+    attr_writer :http
+
+    # @!attribute [r] http
+    # @return [HTTP::Client]
+    def http
+      @http ||= HTTP::Client.new
+    end
+
+    # @!attribute [r] endpoint
+    # @return [String]
+    def endpoint
+      @endpoint ||= self.class.endpoint
+    end
+
+    # Switches to the eBay Sandbox environment
+    #
+    # @return [self]
+    def sandbox
+      @endpoint = endpoint.sub('ebay', 'sandbox.ebay')
+      self
+    end
+
+    # Flags request as persistent
+    #
+    # @param [Integer] timeout
+    # @return [self]
+    def persistent(timeout: 5)
+      self.http = http.persistent(endpoint, timeout: timeout)
+      self
+    end
+
+    # @!method use(*features)
+    #   Turns on {https://github.com/httprb/http HTTP} features
+    #
+    #   @param features
+    #   @return [self]
+    #
+    # @!method via(*proxy)
+    #   Makes a request through an HTTP proxy
+    #
+    #   @param [Array] proxy
+    #   @raise [HTTP::Request::Error] if HTTP proxy is invalid
+    #   @return [self]
+    %i[timeout via through headers use].each do |method_name|
+      define_method(method_name) do |*args, &block|
+        self.http = http.send(method_name, *args, &block)
+        self
+      end
+    end
+  end
+end

data/lib/ebay/shopping.rb

@@ -1,10 +1,169 @@
-require 'ebay/request'
+# frozen_string_literal: true
 
+require 'ebay/config'
+require 'ebay/requestable'
+
+# Ruby wrapper to the eBay APIs
 module Ebay
-  class Shopping < Request
-    host 'open.api.ebay.com'
-    path '/shopping'
-    headers 'X-EBAY-API-APP-ID' => Config.app_id,
-            'X-EBAY-API-VERSION' => 799
+  # Returns a {Ebay::Shopping#initialize Shopping API} instance
+  def self.shopping(**params)
+    Shopping.new(**params)
+  end
+
+  # The eBay Shopping API makes it easy to search for things on eBay.
+  #
+  # @see https://developer.ebay.com/Devzone/shopping/docs/Concepts/ShoppingAPI_FormatOverview.html
+  # @see https://developer.ebay.com/Devzone/shopping/docs/CallRef/index.html
+  class Shopping
+    include Requestable
+
+    self.endpoint = 'https://open.api.ebay.com/shopping'
+
+    # @return [String]
+    attr_reader :app_id
+
+    # @return [String]
+    attr_reader :response_encoding
+
+    # @return [String]
+    attr_reader :site_id
+
+    # @return [String]
+    attr_reader :version
+
+    # @return [String]
+    attr_reader :version_handling
+
+    # @return [String]
+    attr_reader :tracking_id
+
+    # @return [String]
+    attr_reader :tracking_partner_code
+
+    # @return [String]
+    attr_reader :affiliate_user_id
+
+    # Returns a Finding API request instance
+    #
+    # @param [String] app_id
+    # @param [String] response_encoding
+    # @param [String] site_id
+    # @param [String] version
+    # @param [String] version_handling
+    # @param [String] tracking_id
+    # @param [String] tracking_partner_code
+    # @param [String] affiliate_user_id
+    def initialize(app_id: Config.app_id, response_encoding: nil,
+                   site_id: nil, version: '1119',
+                   version_handling: nil, tracking_id: nil,
+                   tracking_partner_code: nil, affiliate_user_id: nil)
+      @app_id = app_id
+      @response_encoding = response_encoding
+      @site_id = site_id
+      @version = version
+      @version_handling = version_handling
+      @tracking_id = tracking_id
+      @tracking_partner_code = tracking_partner_code
+      @affiliate_user_id = affiliate_user_id
+    end
+
+    # Returns one or more eBay catalog products based on a query string or
+    # product ID value
+    #
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def find_products(payload = {})
+      request('FindProducts', payload)
+    end
+
+    # Retrieves high-level data for a specified eBay category
+    #
+    # @param [String] category_id
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_category_info(category_id, payload = {})
+      payload = payload.merge('CategoryID' => category_id)
+      request('GetCategoryInfo', payload)
+    end
+
+    # Gets the official eBay system time in GMT
+    #
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_ebay_time(payload = {})
+      request('GeteBayTime', payload)
+    end
+
+    # Retrieves the current status of up to 20 eBay listings
+    #
+    # @overload get_item_status(*item_ids, payload = {})
+    #   @param [String] item_ids
+    #   @param [Hash] payload
+    #   @return [HTTP::Response]
+    def get_item_status(*item_ids)
+      payload = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
+      payload = payload.merge('ItemID' => item_ids.map(&:to_s))
+      request('GetItemStatus', payload)
+    end
+
+    # Retrieves publicly available data for one or more listings
+    #
+    # @overload get_multiple_items(*item_ids, payload = {})
+    #   @param [String] item_ids
+    #   @param [Hash] payload
+    #   @return [HTTP::Response]
+    def get_multiple_items(*item_ids)
+      payload = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
+      payload = payload.merge('ItemID' => item_ids.map(&:to_s))
+
+      request('GetMultipleItems', payload)
+    end
+
+    # Gets shipping costs for a listing
+    #
+    # @param [String] item_id
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_shipping_costs(item_id, payload = {})
+      payload = payload.merge('ItemID' => item_id)
+      request('GetShippingCosts', payload)
+    end
+
+    # Gets publicly visible details about one listing
+    #
+    # @param [String] item_id
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_single_item(item_id, payload = {})
+      payload = payload.merge('ItemID' => item_id)
+      request('GetSingleItem', payload)
+    end
+
+    # Retrieves user information
+    #
+    # @param [String] user_id
+    # @param [Hash] payload
+    # @return [HTTP::Response]
+    def get_user_profile(user_id, payload = {})
+      payload = payload.merge('UserID' => user_id)
+      request('GetUserProfile', payload)
+    end
+
+    private
+
+    def request(operation, payload = {})
+      params = { 'appid' => app_id,
+                 'callname' => operation,
+                 'requestencoding' => 'JSON',
+                 'responseencoding' => response_encoding,
+                 'siteid' => site_id,
+                 'version' => version,
+                 'versionhandling' => version_handling,
+                 'affiliateuserid' => affiliate_user_id,
+                 'trackingid' => tracking_id,
+                 'trackingpartnercode' => tracking_partner_code }.compact
+
+      http.post(endpoint, params: params, body: JSON.dump(payload))
+    end
   end
 end

data/lib/ebay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ebay
-  VERSION = '0.2.0'
+  VERSION = '0.3.4'
 end

metadata

@@ -1,125 +1,179 @@
 --- !ruby/object:Gem::Specification
 name: ebay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Hakan Ensari
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: multi_xml
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
-description: 
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - me@hakanensari.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
+- LICENSE
 - README.md
-- Rakefile
-- ebay-ruby.gemspec
 - lib/ebay-ruby.rb
 - lib/ebay.rb
+- lib/ebay/browse.rb
 - lib/ebay/config.rb
 - lib/ebay/finding.rb
 - lib/ebay/merchandising.rb
-- lib/ebay/parser.rb
-- lib/ebay/product.rb
-- lib/ebay/product_metadata.rb
-- lib/ebay/request.rb
+- lib/ebay/oauth/client_credentials_grant.rb
+- lib/ebay/requestable.rb
 - lib/ebay/shopping.rb
 - lib/ebay/version.rb
-- test/cassettes/finding.yml
-- test/cassettes/merchandising.yml
-- test/cassettes/product.yml
-- test/cassettes/product_metadata.yml
-- test/cassettes/shopping.yml
-- test/helper.rb
-- test/test_finding.rb
-- test/test_merchandising.rb
-- test/test_parser.rb
-- test/test_product.rb
-- test/test_product_metadata.rb
-- test/test_shopping.rb
 homepage: https://github.com/hakanensari/ebay-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,27 +181,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: A Ruby wrapper to the eBay Web Services API
-test_files:
-- test/cassettes/finding.yml
-- test/cassettes/merchandising.yml
-- test/cassettes/product.yml
-- test/cassettes/product_metadata.yml
-- test/cassettes/shopping.yml
-- test/helper.rb
-- test/test_finding.rb
-- test/test_merchandising.rb
-- test/test_parser.rb
-- test/test_product.rb
-- test/test_product_metadata.rb
-- test/test_shopping.rb
+summary: Ruby wrapper to the eBay APIs
+test_files: []