ebay-ruby 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18523b3ec4ff1f6d4bac8c6dbeb4d2570ece325e963ed4540aded51bcbef8be9
-  data.tar.gz: 4db3fedd2023ff5c49d0a6e1369188325d1e61b798dc77b63c1cd51ee9b3baa6
+  metadata.gz: d6e9d59b1d0ba42b7c825f8a29aac4e7f88765c6095c686739e03688d3e5e831
+  data.tar.gz: 2b7d7471e20d57190db24d2e3c192c61ee2acc0918a75e594575050008380608
 SHA512:
-  metadata.gz: 5e6cf632c7006f51393878a5af01057e9cec95678ddc7e7565e528f4c015ec2a19a70e55b1ddd8f67e4a5f5e40e00e8e2c858811178faf214084f65f934bdcf3
-  data.tar.gz: 138a8d6fa3f982ed664cc4340ea9d47802fb4a4c8b3cc9dd5fcbfee050198c4916bda43521947831e78422bee8fd06f7db979e8934b998e7bfd153fb16151995
+  metadata.gz: ab9807c80c509e6d276f881c026d9d0a4430e6f57a57ff259250cc5bf30d4fe2e33b08a48c8da356fc37db90d7bc1c3109a6c42d72b584f0a2af8a9be827cb35
+  data.tar.gz: 5829d5b8fd4c8aa189d0979be0c030c2109976217e88434afce15b26e123b557bcbb21764a7fbdb2e170984420e0bfeef69c7ff2fe8638ccf5a398243a64db02

data/README.md

@@ -2,81 +2,126 @@
 
 [![Build](https://github.com/hakanensari/ebay-ruby/workflows/build/badge.svg)](https://github.com/hakanensari/ebay-ruby/actions)
 
-A Ruby wrapper to the [eBay APIs]
+This library provides a wrapper to the [eBay APIs].
 
-## Usage
+## Getting started
+
+You can instantiate API requests using shorthand class methods defined on `Ebay`.
+
+```ruby
+Ebay.finding # returns a new Ebay::Finding instance
+```
 
-### Buy APIs
+### Keys
 
-Retrieve purchasable items, check out, then track orders without visiting the eBay site.
+eBay APIs require [developer keys].
 
-#### [Browse API]
+You can provide these globally with the environment variables `EBAY_APP_ID`, `EBAY_DEV_ID`, and `EBAY_CERT_ID`.
 
-Using the Browse API, you can create a rich selection of items for your buyers to browse with keyword and category searches. You can also provides the ability to eBay members to add items and change the quantity of an item in their eBay shopping cart as well as view the contents of their eBay cart.
+If you prefer not to use environment variables, you can provide your keys globally with:
 
 ```ruby
-require 'ebay/browse'
-require 'ebay/oauth/client_credentials_grant'
+Ebay.configure do |config|
+  config.app_id = 'YOUR APP ID'
+  config.dev_id = 'YOUR DEV ID'
+  config.cert_id = 'YOUR CERT ID'
+end
+```
 
-access_token = Oauth::ClientCredentialsGrant.new.mint_access_token
-request = Ebay::Browse.new(campaign_id: '123',
-                           country: 'US',
-                           zip: '19406',
-                           access_token: access_token)
-response = @request.search(q: 'iphone')
+Finally, you can provide your keys individually to the request when instantiating it. This is what you will want to do if you are using multiple sets of credentials.
 
-JSON.parse(response)
+Please note that each API names keys differently.
+
+```ruby
+request = Ebay.finding(security_appname: 'YOUR APP ID')
 ```
 
-### Traditional Searching APIs
+In the examples below, we will assume we are providing our keys with environment variables.
 
-Search eBay; build search and browse experiences.
+### Parsing a response
 
-#### [Finding API]
+The eBay APIs return responses in XML or JSON format.
 
-The Finding API provides programmatic access to the next generation search capabilities on the eBay platform. It lets you search and browse for items listed on eBay and provides useful metadata to refine searches and enhance the search experience.
+You can override the default format of an API when instantiating the request.
 
 ```ruby
-require 'ebay/finding'
+require 'json'
 
-request = Ebay::Finding.new
+### the Finding API returns XML by default
+request = Ebay.finding(response_data_format: 'JSON')
 response = request.find_items_by_keywords('iphone')
 
 JSON.parse(response)
 ```
 
-### Traditional Shopping/Buying APIs
-
-Retrieve public items and user data to create shopping and marketing applications.
+## Usage
+### [Browse API]
 
-#### [Shopping API]
+The Browse API allows your buyers to search eBay items by keyword and category. It also allows them to view and add items to their eBay shopping cart. The Browse API defaults to the eBay US marketplace but may be set during initialisation. The list of available marketplaces is [here](https://developer.ebay.com/api-docs/static/rest-request-components.html#marketpl).
 
-The eBay Shopping API makes it easy to search for things on eBay.
+**Note** The marketplace value needs to use an underscore between EBAY and the country code.  The Finding and Merchandising APIs use a hyphen.
 
 ```ruby
-require 'ebay/shopping'
+require 'ebay/browse'
+require 'ebay/oauth/client_credentials_grant'
 
-request = Ebay::Finding.new
-response = request.find_products('QueryKeywords' => 'tolkien')
+access_token = Oauth::ClientCredentialsGrant.new.mint_access_token
+request = Ebay.browse(campaign_id: '123', country: 'US', zip: '19406',
+                      access_token: access_token, market_id: 'EBAY_US')
+response = request.search(q: 'iphone')
+```
 
-JSON.parse(response)
+### [Finding API]
+
+The Finding API lets you search and browse for items listed on eBay and provides useful metadata to refine searches.
+
+```ruby
+require 'ebay/finding'
+
+request = Ebay.finding
+response = request.find_items_by_keywords('iphone')
 ```
 
-#### [Merchandising API]
+### [Merchandising API]
 
-The Merchandising API provides item and product recommendations that can be used to cross-sell and up-sell eBay items to buyers.
+The Merchandising API retrieves information about products or item listings on eBay to help you sell more merchandise to eBay buyers.
 
 ```ruby
 require 'ebay/merchandising'
 
-request = Ebay::Finding.new
+request = Ebay::Merchandising.new
 response = request.get_most_watched_items
+```
 
-JSON.parse(response)
+### [Shopping API]
+
+The eBay Shopping API makes it easy to search for things on eBay.
+
+```ruby
+require 'ebay/shopping'
+
+request = Ebay::Shopping.new
+response = request.find_products('QueryKeywords' => 'tolkien')
+```
+
+### Market Place
+eBay has country bsaed marketplaces ( listed [here](https://developer.ebay.com/api-docs/static/rest-request-components.html#marketpl) ).  By default, the eBay gem queries the US Marketplace.  To change the marketplace, set the marketplace on the request object.
+
+**Note** For the Browse API, the marketplace value needs to use an underscore between EBAY and the country code (EBAY_AU).  The Finding and Merchandising APIs require a hyphen between EBAY and the country code ( EBAY-AU )
+
+## Development
+
+To write requests and responses to a logger, use the logging feature:
+
+```ruby
+require 'logger'
+
+request = request.use(logging: {logger: Logger.new(STDOUT)})
 ```
 
 [eBay APIs]: https://developer.ebay.com/docs
+[developer keys]: https://developer.ebay.com/my/keys
 [Browse API]: https://developer.ebay.com/api-docs/buy/browse/static/overview.html
 [Finding API]: https://developer.ebay.com/Devzone/finding/Concepts/FindingAPIGuide.html
-[Shopping API]: https://developer.ebay.com/Devzone/shopping/docs/Concepts/ShoppingAPIGuide.html
 [Merchandising API]: https://developer.ebay.com/Devzone/merchandising/docs/Concepts/merchandisingAPIGuide.html
+[Shopping API]: https://developer.ebay.com/Devzone/shopping/docs/Concepts/ShoppingAPIGuide.html

data/lib/ebay/browse.rb

@@ -1,22 +1,25 @@
 # frozen_string_literal: true
 
-require 'http'
+require 'base64'
 
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
+# Ruby wrapper to the eBay APIs
 module Ebay
-  # Using the Browse API, you can create a rich selection of items for your
-  # buyers to browse with keyword and category searches. It also provides the
-  # ability to eBay members to add items and change the quantity of an item in
-  # their eBay shopping cart as well as view the contents of their eBay cart.
+  # Returns a {Ebay::Browse#initialize Browse API} instance
+  def self.browse(**params)
+    Browse.new(**params)
+  end
+
+  # The Browse API allows your buyers to search eBay items by keyword and category. It also allows them to view and add
+  # items to their eBay shopping cart.
   #
   # @see https://developer.ebay.com/api-docs/buy/browse/overview.html
   class Browse
-    include Sandboxable
+    include Requestable
 
-    SANDBOX_ENDPOINT = 'https://api.sandbox.ebay.com/buy/browse/v1'
-    PRODUCTION_ENDPOINT = 'https://api.ebay.com/buy/browse/v1'
+    self.endpoint = 'https://api.ebay.com/buy/browse/v1'
 
     # @return [String]
     attr_reader :campaign_id
@@ -30,6 +33,9 @@ module Ebay
     # @return [String,nil]
     attr_reader :zip
 
+    # @return [String,nil]
+    attr_reader :market_id
+
     # @return [String] the application access token
     def access_token
       @access_token ||= mint_access_token
@@ -40,36 +46,36 @@ module Ebay
     # @param [String] campaign_id
     # @param [String] reference_id
     # @param [String] access_token
-    def initialize(campaign_id:, reference_id: nil, country: nil, zip: nil,
-                   access_token: nil)
+    def initialize(campaign_id:, reference_id: nil, country: nil, zip: nil, access_token: nil, market_id: 'EBAY_US')
       @campaign_id = campaign_id
       @reference_id = reference_id
       @country = country
       @zip = zip
       @access_token = access_token
+      @market_id = market_id
     end
 
-    # Searches for eBay items by various query parameters and retrieves
-    # summaries of the item
+    # Searches for eBay items by various query parameters and retrieves summaries of the item
     #
     # @param [Hash] params
     # @return [HTTP::Response]
-    def search(**params)
+    def search(params = {})
       url = build_url('item_summary', 'search')
-      HTTP.headers(build_headers).get(url, params: params)
+      http.headers(build_headers).get(url, params: params)
     end
 
     # Searches for eBay items based on a image and retrieves their summaries
     #
-    # @param [String] image the Base64 string of the image
+    # @param [File] image
     # @param [Hash] params
     # @return [HTTP::Response]
-    def search_by_image(image, **params)
+    def search_by_image(image, params = {})
       url = build_url('item_summary', 'search_by_image')
       headers = build_headers.update('CONTENT-TYPE' => 'application/json')
-      body = JSON.dump(image: image)
+      encoded_string = Base64.encode64(image.read)
+      body = JSON.dump(image: encoded_string)
 
-      HTTP.headers(headers).post(url, params: params, body: body)
+      http.headers(headers).post(url, params: params, body: body)
     end
 
     # Retrieves the details of a specific item
@@ -77,11 +83,11 @@ module Ebay
     # @param [String] item_id
     # @param [Hash] params
     # @return [HTTP::Response]
-    def get_item(item_id, **params)
+    def get_item(item_id, params = {})
       url = build_url('item', item_id)
-      params.update(item_id: item_id)
+      params = params.merge(item_id: item_id)
 
-      HTTP.headers(build_headers).get(url, params: params)
+      http.headers(build_headers).get(url, params: params)
     end
 
     # Retrieves the details of a specific item using its legacy item ID
@@ -89,11 +95,11 @@ module Ebay
     # @param [String] legacy_item_id
     # @param [Hash] params
     # @return [HTTP::Response]
-    def get_item_by_legacy_id(legacy_item_id, **params)
+    def get_item_by_legacy_id(legacy_item_id, params = {})
       url = build_url('item', 'get_item_by_legacy_id')
-      params.update(legacy_item_id: legacy_item_id)
+      params = params.merge(legacy_item_id: legacy_item_id)
 
-      HTTP.headers(build_headers).get(url, params: params)
+      http.headers(build_headers).get(url, params: params)
     end
 
     # Retrieves the details of the individual items in an item group
@@ -104,7 +110,7 @@ module Ebay
       url = build_url('item', 'get_items_by_item_group')
       params = { item_group_id: item_group_id }
 
-      HTTP.headers(build_headers).get(url, params: params)
+      http.headers(build_headers).get(url, params: params)
     end
 
     # Retrieves the details of the individual items in an item group
@@ -115,11 +121,10 @@ module Ebay
     def check_compatibility(item_id, marketplace_id, compatibility_properties)
       url = build_url('item', item_id, 'check_compatibility')
       headers = build_headers
-      headers.update('X-EBAY-C-MARKETPLACE-ID' => marketplace_id,
-                     'CONTENT-TYPE' => 'application/json')
+      headers.update('X-EBAY-C-MARKETPLACE-ID' => marketplace_id, 'CONTENT-TYPE' => 'application/json')
       body = JSON.dump('compatibilityProperties' => compatibility_properties)
 
-      HTTP.headers(headers).post(url, body: body)
+      http.headers(headers).post(url, body: body)
     end
 
     def add_item
@@ -141,26 +146,23 @@ module Ebay
     private
 
     def build_url(*resources, operation)
-      endpoint = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
       [endpoint, *resources, operation].join('/')
     end
 
     def build_headers
       { 'AUTHORIZATION' => "Bearer #{access_token}",
+        'X-EBAY-C-MARKETPLACE-ID' => market_id,
         'X-EBAY-C-ENDUSERCTX' => build_ebay_enduser_context }
     end
 
     def build_ebay_enduser_context
       { 'affiliateCampaignId' => campaign_id,
         'affiliateReferenceId' => reference_id,
-        'contextualLocation' => build_contextual_location }
-        .compact.map { |kv| kv.join('=') }.join(',')
+        'contextualLocation' => build_contextual_location }.compact.map { |kv| kv.join('=') }.join(',')
     end
 
     def build_contextual_location
-      string = { 'country' => country, 'zip' => zip }
-               .compact.map { |kv| kv.join('=') }.join(',')
-
+      string = { 'country' => country, 'zip' => zip }.compact.map { |kv| kv.join('=') }.join(',')
       CGI.escape(string) if string
     end
   end

data/lib/ebay/config.rb

@@ -8,7 +8,7 @@ module Ebay
     yield Config
   end
 
-  # Stores credentials for accessing the eBay APIs
+  # Configures credentials for accessing the eBay APIs
   module Config
     class << self
       # @!attribute [rw] app_id

data/lib/ebay/finding.rb

@@ -1,35 +1,38 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
+# Ruby wrapper to the eBay APIs
 module Ebay
-  # The Finding API lets you search for and browse items listed on eBay and
+  # Returns a {Ebay::Finding#initialize Finding API} instance
+  def self.finding(**params)
+    Finding.new(**params)
+  end
+
+  # The Finding API lets you search and browse for items listed on eBay and
   # provides useful metadata to refine searches.
   #
   # @see https://developer.ebay.com/Devzone/finding/Concepts/MakingACall.html
   # @see https://developer.ebay.com/Devzone/finding/CallRef/index.html
   class Finding
-    include Sandboxable
+    include Requestable
 
-    SANDBOX_ENDPOINT = 'https://svcs.sandbox.ebay.com/services/search/FindingService/v1'
-    PRODUCTION_ENDPOINT = 'https://svcs.ebay.com/services/search/FindingService/v1'
+    self.endpoint = 'https://svcs.ebay.com/services/search/FindingService/v1'
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :global_id
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :message_encoding
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :response_data_format
 
     # @return [String]
     attr_reader :security_appname
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :service_version
 
     # Returns a Finding API request instance
@@ -41,7 +44,7 @@ module Ebay
     # @param [String] security_appname
     # @param [String] service_version
     def initialize(global_id: nil, message_encoding: nil,
-                   response_data_format: 'JSON',
+                   response_data_format: nil,
                    security_appname: Config.app_id, service_version: nil)
       @global_id = global_id
       @message_encoding = message_encoding
@@ -80,7 +83,7 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def find_items_by_keywords(keywords, payload = {})
-      payload.update('keywords' => keywords)
+      payload = payload.merge('keywords' => keywords)
       request('findItemsByKeywords', payload)
     end
 
@@ -91,8 +94,8 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def find_items_by_product(product_id, product_id_type, payload = {})
-      payload.update('productId' => product_id,
-                     'productId.@type' => product_id_type)
+      payload = payload.merge('productId' => product_id,
+                              'productId.@type' => product_id_type)
 
       request('findItemsByProduct', payload)
     end
@@ -133,16 +136,14 @@ module Ebay
     private
 
     def request(operation, payload = {})
-      url = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
       params = { 'GLOBAL-ID' => global_id,
                  'MESSAGE-ENCODING' => message_encoding,
                  'OPERATION-NAME' => operation,
-                 'REQUEST-DATA-FORMAT' => 'JSON',
                  'RESPONSE-DATA-FORMAT' => response_data_format,
                  'SECURITY-APPNAME' => security_appname,
-                 'SERVICE-VERSION' => service_version }.compact
+                 'SERVICE-VERSION' => service_version }.update(payload).compact
 
-      HTTP.post(url, params: params, body: JSON.dump(payload))
+      http.headers(headers).get(endpoint, params: params)
     end
   end
 end

data/lib/ebay/merchandising.rb

@@ -1,32 +1,35 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
+# Ruby wrapper to the eBay APIs
 module Ebay
+  # 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 Sandboxable
+    include Requestable
 
-    SANDBOX_ENDPOINT = 'https://svcs.sandbox.ebay.com/MerchandisingService'
-    PRODUCTION_ENDPOINT = 'https://svcs.ebay.com/MerchandisingService'
+    self.endpoint = 'https://svcs.ebay.com/MerchandisingService'
 
     # @return [String]
     attr_reader :consumer_id
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :global_id
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :response_data_format
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :service_version
 
     # Returns a Finding API request instance
@@ -36,7 +39,7 @@ module Ebay
     # @param [String] response_data_format
     # @param [String] service_version
     def initialize(consumer_id: Config.app_id, global_id: nil,
-                   response_data_format: 'JSON', service_version: nil)
+                   response_data_format: nil, service_version: nil)
       @consumer_id = consumer_id
       @global_id = global_id
       @response_data_format = response_data_format
@@ -66,7 +69,7 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def get_similar_items(item_id, payload = {})
-      payload.update('itemId' => item_id)
+      payload = payload.merge('itemId' => item_id)
       request('getSimilarItems', payload)
     end
 
@@ -80,7 +83,6 @@ module Ebay
     private
 
     def request(operation, payload = {})
-      endpoint = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
       params = { 'CONSUMER-ID' => consumer_id,
                  'GLOBAL-ID' => global_id,
                  'OPERATION-NAME' => operation,
@@ -88,7 +90,7 @@ module Ebay
                  'RESPONSE-DATA-FORMAT' => response_data_format,
                  'SERVICE-VERSION' => service_version }.compact
 
-      HTTP.post(endpoint, params: params, body: JSON.dump(payload))
+      http.headers(headers).post(endpoint, params: params, body: JSON.dump(payload))
     end
   end
 end

data/lib/ebay/oauth/client_credentials_grant.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
 module Ebay
   module Oauth
@@ -11,10 +9,9 @@ module Ebay
     #
     # @see https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html
     class ClientCredentialsGrant
-      include Sandboxable
+      include Requestable
 
-      SANDBOX_ENDPOINT = 'https://api.sandbox.ebay.com/identity/v1/oauth2/token'
-      PRODUCTION_ENDPOINT = 'https://api.ebay.com/identity/v1/oauth2/token'
+      self.endpoint = 'https://api.ebay.com/identity/v1/oauth2/token'
 
       # @return [String]
       attr_reader :app_id
@@ -40,16 +37,12 @@ module Ebay
       #
       # @return [HTTP::Response]
       def request
-        HTTP.basic_auth(user: app_id, pass: cert_id)
-            .post(url, form: payload)
+        http.basic_auth(user: app_id, pass: cert_id)
+            .post(endpoint, form: payload)
       end
 
       private
 
-      def url
-        sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
-      end
-
       def payload
         { grant_type: 'client_credentials',
           scope: 'https://api.ebay.com/oauth/api_scope' }

data/lib/ebay/requestable.rb

@@ -0,0 +1,81 @@
+# 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] headers
+    # @return [Hash]
+    attr_accessor :headers
+
+    # Sets the eBay Market
+    #
+    # @param [String]
+    def market_id=(market_id)
+      @headers ||= {}
+      @headers['X-EBAY-SOA-GLOBAL-ID'] = market_id
+    end
+
+    # @!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 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,43 +1,46 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
+# Ruby wrapper to the eBay APIs
 module Ebay
+  # 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 Sandboxable
+    include Requestable
 
-    SANDBOX_ENDPOINT = 'https://open.api.sandbox.ebay.com/shopping'
-    PRODUCTION_ENDPOINT = 'https://open.api.ebay.com/shopping'
+    self.endpoint = 'https://open.api.ebay.com/shopping'
 
     # @return [String]
     attr_reader :app_id
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :response_encoding
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :site_id
 
     # @return [String]
     attr_reader :version
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :version_handling
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :tracking_id
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :tracking_partner_code
 
-    # @return [String, nil]
+    # @return [String]
     attr_reader :affiliate_user_id
 
     # Returns a Finding API request instance
@@ -50,7 +53,7 @@ module Ebay
     # @param [String] tracking_id
     # @param [String] tracking_partner_code
     # @param [String] affiliate_user_id
-    def initialize(app_id: Config.app_id, response_encoding: 'JSON',
+    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)
@@ -79,7 +82,7 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def get_category_info(category_id, payload = {})
-      payload.update('CategoryID' => category_id)
+      payload = payload.merge('CategoryID' => category_id)
       request('GetCategoryInfo', payload)
     end
 
@@ -99,7 +102,7 @@ module Ebay
     #   @return [HTTP::Response]
     def get_item_status(*item_ids)
       payload = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-      payload.update('ItemID' => item_ids.join(','))
+      payload = payload.merge('ItemID' => item_ids.map(&:to_s))
       request('GetItemStatus', payload)
     end
 
@@ -111,7 +114,7 @@ module Ebay
     #   @return [HTTP::Response]
     def get_multiple_items(*item_ids)
       payload = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-      payload.update('ItemID' => item_ids.join(','))
+      payload = payload.merge('ItemID' => item_ids.map(&:to_s))
 
       request('GetMultipleItems', payload)
     end
@@ -122,7 +125,7 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def get_shipping_costs(item_id, payload = {})
-      payload.update('ItemID' => item_id)
+      payload = payload.merge('ItemID' => item_id)
       request('GetShippingCosts', payload)
     end
 
@@ -132,7 +135,7 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def get_single_item(item_id, payload = {})
-      payload.update('ItemID' => item_id)
+      payload = payload.merge('ItemID' => item_id)
       request('GetSingleItem', payload)
     end
 
@@ -142,14 +145,13 @@ module Ebay
     # @param [Hash] payload
     # @return [HTTP::Response]
     def get_user_profile(user_id, payload = {})
-      payload.update('UserID' => user_id)
+      payload = payload.merge('UserID' => user_id)
       request('GetUserProfile', payload)
     end
 
     private
 
     def request(operation, payload = {})
-      endpoint = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
       params = { 'appid' => app_id,
                  'callname' => operation,
                  'requestencoding' => 'JSON',
@@ -161,7 +163,7 @@ module Ebay
                  'trackingid' => tracking_id,
                  'trackingpartnercode' => tracking_partner_code }.compact
 
-      HTTP.post(endpoint, params: params, body: JSON.dump(payload))
+      http.headers(headers).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.3.0'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Hakan Ensari
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !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: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - me@hakanensari.com
 executables: []
@@ -138,14 +166,14 @@ files:
 - lib/ebay/finding.rb
 - lib/ebay/merchandising.rb
 - lib/ebay/oauth/client_credentials_grant.rb
-- lib/ebay/sandboxable.rb
+- lib/ebay/requestable.rb
 - lib/ebay/shopping.rb
 - lib/ebay/version.rb
 homepage: https://github.com/hakanensari/ebay-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,15 +181,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      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: Ruby wrapper to the eBay APIs
 test_files: []

data/lib/ebay/sandboxable.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'ebay/config'
-
-module Ebay
-  # Allows running requests in the eBay Sandbox
-  module Sandboxable
-    # Runs requests in the eBay Sandbox
-    #
-    # @return [self]
-    def sandbox
-      @sandbox = true
-      self
-    end
-
-    # @!attribute [r] sandbox?
-    # Returns whether requests run in the eBay Sandbox
-    #
-    # @return [Boolean]
-    def sandbox?
-      @sandbox ||= false
-    end
-  end
-end