ebay-ruby 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f75e5710d5dc86f3f0a83ec943b90ec3b5aa318be568163accba7ce326adb2a2
-  data.tar.gz: 223f627ad8321defd29a21fce8e1083eecb3b8447b5962d448ad51152d9b0dc1
+  metadata.gz: bbadae6120cf8748d6f33d847c9746199717facc4734db1d81719a37393886bc
+  data.tar.gz: d457466d75675c9fb698d9fa8feac2bb773d4a89be43f698ab22598bada96839
 SHA512:
-  metadata.gz: 197bc765789a721d8f678dbe0f5ed931c01743cff6699957d02a122ce6c61d73bab3046c6a15c5eb4c8ff4ebde04bd3690183fd41be8c512264393583121423b
-  data.tar.gz: 29bb107067f9802f8988eb4c08f991715c7de01b699694e3b38f762f61d65a562ca8c88fe9083c63e8668e6ab960e81de1b880427f582102fa3df2ca5174f3eb
+  metadata.gz: 98aea0105ee22960dece81289809e60048afbc5a68bd17bbf3ef2d54c6f0c139b5551b0f0e04293d49d471a2bd7d244d285f8fcc76a8f8b35eb5eaef05b6900c
+  data.tar.gz: 769e216aa765b9850aa3192e82668bc9a79bc69e47b34e54799ecb897b4bbbb38a3750d237a841ce3f3abc2556b9b0f77017801ea97229bb3521053f52354d7e

data/README.md

@@ -2,81 +2,120 @@
 
 [![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(response_data_format: 'JSON')
+# 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
 
-#### [Shopping API]
+### [Browse API]
 
-The eBay Shopping API makes it easy to search for things on eBay.
+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.
 
 ```ruby
-require 'ebay/shopping'
+require 'ebay/browse'
+require 'ebay/oauth/client_credentials_grant'
 
-request = Ebay::Shopping.new(response_encoding: 'JSON')
-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)
+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::Merchandising.new(response_data_format: 'JSON')
+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')
+```
+
+## 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

@@ -5,11 +5,15 @@ require 'base64'
 require 'ebay/config'
 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
@@ -39,8 +43,7 @@ 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)
       @campaign_id = campaign_id
       @reference_id = reference_id
       @country = country
@@ -48,8 +51,7 @@ module Ebay
       @access_token = access_token
     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]
@@ -115,8 +117,7 @@ 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)
@@ -152,14 +153,11 @@ module Ebay
     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

@@ -3,8 +3,14 @@
 require 'ebay/config'
 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

data/lib/ebay/merchandising.rb

@@ -3,7 +3,13 @@
 require 'ebay/config'
 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
   #

data/lib/ebay/requestable.rb

@@ -37,5 +37,33 @@ module Ebay
       @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

@@ -3,7 +3,13 @@
 require 'ebay/config'
 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
@@ -96,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 = payload.merge('ItemID' => item_ids.join(','))
+      payload = payload.merge('ItemID' => item_ids.map(&:to_s))
       request('GetItemStatus', payload)
     end
 
@@ -108,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 = payload.merge('ItemID' => item_ids.join(','))
+      payload = payload.merge('ItemID' => item_ids.map(&:to_s))
 
       request('GetMultipleItems', payload)
     end

data/lib/ebay/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Hakan Ensari
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2021-02-22 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: []
@@ -145,7 +173,7 @@ 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: []