ebay-ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18523b3ec4ff1f6d4bac8c6dbeb4d2570ece325e963ed4540aded51bcbef8be9
-  data.tar.gz: 4db3fedd2023ff5c49d0a6e1369188325d1e61b798dc77b63c1cd51ee9b3baa6
+  metadata.gz: d9fbfdf33fe78c10cfdeee697936f0f9eb31a8541a3f0b993d37058539227ac3
+  data.tar.gz: 1fee63caeec5e67ec429050c970bb4717089d5a6f3c150342e7babb9c735a787
 SHA512:
-  metadata.gz: 5e6cf632c7006f51393878a5af01057e9cec95678ddc7e7565e528f4c015ec2a19a70e55b1ddd8f67e4a5f5e40e00e8e2c858811178faf214084f65f934bdcf3
-  data.tar.gz: 138a8d6fa3f982ed664cc4340ea9d47802fb4a4c8b3cc9dd5fcbfee050198c4916bda43521947831e78422bee8fd06f7db979e8934b998e7bfd153fb16151995
+  metadata.gz: cbea01c20e390702353ef7970d08c43fc067efb26a760f89e0884f91b29310795c7bc3bdcd2495e0638d588332a5ed4b927863a2394cac8fe8fa75d287960dcb
+  data.tar.gz: d759fdf30c035ab2d9934ececd8228d05d2ad9a7eadbfb2128c287af4b5db10b063e4d1b8f8f6198b39a68bda2fb370271ea6bb657ba13722f1a0f5a9bbe74b7

data/lib/ebay/browse.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'http'
+require 'base64'
 
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
 module Ebay
   # Using the Browse API, you can create a rich selection of items for your
@@ -13,10 +13,9 @@ module Ebay
   #
   # @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
@@ -56,20 +55,21 @@ module Ebay
     # @return [HTTP::Response]
     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)
       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
@@ -81,7 +81,7 @@ module Ebay
       url = build_url('item', item_id)
       params.update(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
@@ -93,7 +93,7 @@ module Ebay
       url = build_url('item', 'get_item_by_legacy_id')
       params.update(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 +104,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
@@ -119,7 +119,7 @@ module Ebay
                      '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,7 +141,6 @@ module Ebay
     private
 
     def build_url(*resources, operation)
-      endpoint = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
       [endpoint, *resources, operation].join('/')
     end
 

data/lib/ebay/finding.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
 module Ebay
   # The Finding API lets you search for and browse items listed on eBay and
@@ -12,10 +10,9 @@ module Ebay
   # @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]
     attr_reader :global_id
@@ -133,7 +130,6 @@ 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,
@@ -142,7 +138,7 @@ module Ebay
                  'SECURITY-APPNAME' => security_appname,
                  'SERVICE-VERSION' => service_version }.compact
 
-      HTTP.post(url, params: params, body: JSON.dump(payload))
+      http.post(endpoint, params: params, body: JSON.dump(payload))
     end
   end
 end

data/lib/ebay/merchandising.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
 module Ebay
   # Retrieves information about products or item listings on eBay to help you
@@ -12,10 +10,9 @@ module Ebay
   # @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
@@ -80,7 +77,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 +84,7 @@ module Ebay
                  'RESPONSE-DATA-FORMAT' => response_data_format,
                  'SERVICE-VERSION' => service_version }.compact
 
-      HTTP.post(endpoint, params: params, body: JSON.dump(payload))
+      http.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
@@ -41,15 +38,11 @@ module Ebay
       # @return [HTTP::Response]
       def request
         HTTP.basic_auth(user: app_id, pass: cert_id)
-            .post(url, form: payload)
+            .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,41 @@
+# 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
+  end
+end

data/lib/ebay/shopping.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'http'
-
 require 'ebay/config'
-require 'ebay/sandboxable'
+require 'ebay/requestable'
 
 module Ebay
   # The eBay Shopping API makes it easy to search for things on eBay.
@@ -11,10 +9,9 @@ module 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
@@ -149,7 +146,6 @@ module Ebay
     private
 
     def request(operation, payload = {})
-      endpoint = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
       params = { 'appid' => app_id,
                  'callname' => operation,
                  'requestencoding' => 'JSON',
@@ -161,7 +157,7 @@ module Ebay
                  'trackingid' => tracking_id,
                  'trackingpartnercode' => tracking_partner_code }.compact
 
-      HTTP.post(endpoint, params: params, body: JSON.dump(payload))
+      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.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Hakan Ensari
@@ -138,7 +138,7 @@ 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

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