ebay-ruby 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbadae6120cf8748d6f33d847c9746199717facc4734db1d81719a37393886bc
-  data.tar.gz: d457466d75675c9fb698d9fa8feac2bb773d4a89be43f698ab22598bada96839
+  metadata.gz: d6e9d59b1d0ba42b7c825f8a29aac4e7f88765c6095c686739e03688d3e5e831
+  data.tar.gz: 2b7d7471e20d57190db24d2e3c192c61ee2acc0918a75e594575050008380608
 SHA512:
-  metadata.gz: 98aea0105ee22960dece81289809e60048afbc5a68bd17bbf3ef2d54c6f0c139b5551b0f0e04293d49d471a2bd7d244d285f8fcc76a8f8b35eb5eaef05b6900c
-  data.tar.gz: 769e216aa765b9850aa3192e82668bc9a79bc69e47b34e54799ecb897b4bbbb38a3750d237a841ce3f3abc2556b9b0f77017801ea97229bb3521053f52354d7e
+  metadata.gz: ab9807c80c509e6d276f881c026d9d0a4430e6f57a57ff259250cc5bf30d4fe2e33b08a48c8da356fc37db90d7bc1c3109a6c42d72b584f0a2af8a9be827cb35
+  data.tar.gz: 5829d5b8fd4c8aa189d0979be0c030c2109976217e88434afce15b26e123b557bcbb21764a7fbdb2e170984420e0bfeef69c7ff2fe8638ccf5a398243a64db02

data/README.md

@@ -47,7 +47,7 @@ You can override the default format of an API when instantiating the request.
 ```ruby
 require 'json'
 
-# the Finding API returns XML by default
+### the Finding API returns XML by default
 request = Ebay.finding(response_data_format: 'JSON')
 response = request.find_items_by_keywords('iphone')
 
@@ -55,10 +55,11 @@ JSON.parse(response)
 ```
 
 ## Usage
-
 ### [Browse 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 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).
+
+**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/browse'
@@ -66,7 +67,7 @@ require 'ebay/oauth/client_credentials_grant'
 
 access_token = Oauth::ClientCredentialsGrant.new.mint_access_token
 request = Ebay.browse(campaign_id: '123', country: 'US', zip: '19406',
-                      access_token: access_token)
+                      access_token: access_token, market_id: 'EBAY_US')
 response = request.search(q: 'iphone')
 ```
 
@@ -103,6 +104,11 @@ 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:

data/lib/ebay/browse.rb

@@ -33,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
@@ -43,12 +46,13 @@ 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
@@ -147,6 +151,7 @@ module Ebay
 
     def build_headers
       { 'AUTHORIZATION' => "Bearer #{access_token}",
+        'X-EBAY-C-MARKETPLACE-ID' => market_id,
         'X-EBAY-C-ENDUSERCTX' => build_ebay_enduser_context }
     end
 

data/lib/ebay/finding.rb

@@ -143,7 +143,7 @@ module Ebay
                  'SECURITY-APPNAME' => security_appname,
                  'SERVICE-VERSION' => service_version }.update(payload).compact
 
-      http.get(endpoint, params: params)
+      http.headers(headers).get(endpoint, params: params)
     end
   end
 end

data/lib/ebay/merchandising.rb

@@ -90,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/requestable.rb

@@ -18,6 +18,18 @@ module Ebay
     # @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
@@ -59,7 +71,7 @@ module Ebay
     #   @param [Array] proxy
     #   @raise [HTTP::Request::Error] if HTTP proxy is invalid
     #   @return [self]
-    %i[timeout via through headers use].each do |method_name|
+    %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

data/lib/ebay/shopping.rb

@@ -163,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.4'
+  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.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http