tcg-player-sdk 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444973875234b87717e9ece0dd3c0373d707d2a13bac732330f7ab8d6a740f72
-  data.tar.gz: cc526ef5f4bc6cadb4404096dfdf9b5a414b5a438d99c4ddf58171b2b6beb214
+  metadata.gz: 30c00bca03558c4b683d20e3ffec48dc5e843fdd5c7170c3410014ad3e2da619
+  data.tar.gz: f5a805adc5ea41c1d09d1d0c9e62c72ad6fa5c8bd147e2cb1a24d2eeca1084f4
 SHA512:
-  metadata.gz: cdede9b22fe30a6f4106af572ca2f0523e6989ec426de0d307fdc37252cfee511ed6275bae255d954eb9cd386465042d650ac78a6096e522d2810cbe26d1d6bb
-  data.tar.gz: e4649464a2dd938a07b9ee991cd1b9635248d36685f4f301feb31a5dcded44c43446f32e6a5172cf688938d2e36725c4277b1ef2e2e4e716f0aef7d75445b91a
+  metadata.gz: 6b24bdcb6d5a30ba9e1ec9bb682af8456331b0d74e418d734237699fbce048ffee172b2d15511f85c34b791fde8435b9ff84b37c5a11a2d6dea279f7a57e8ed1
+  data.tar.gz: d77e338ace8d2605deb9c3c170e75078afea999cdf04f16c7548963d92ef63316b3060089b2540a33fb37c9875f3a991d51a886b6bcd121295993842cb44efe8

data/lib/tcg-player-sdk/bearer_token.rb

@@ -17,4 +17,14 @@ class TCGPlayerSDK::BearerToken
   def to_s
     ap self, indent: -2
   end
+
+  def to_json
+    h = {
+      access_token: token,
+      token_type: 'bearer',
+      expires_in: expires_in,
+      '.issued' => issued.to_s,
+      '.expires' => expiration.to_s,
+    }.to_json
+  end
 end

data/lib/tcg-player-sdk/manifest.rb

@@ -0,0 +1,38 @@
+# Add some shortcuts and helpers to parse the manifest
+class TCGPlayerSDK::Manifest < TCGPlayerSDK::ResponseStruct
+
+  def initialize(hash = nil)
+    super
+  end
+
+  ##
+  # Pick out the sorting struct from the response
+  #
+  # @return [Array<TCGPlayerSDK::ResponseStruct>]
+  def sorting
+    if(self.results && self.results.is_a?(Array))
+      @sorting ||= self.results.first.sorting
+    end
+
+    return @sorting
+  end
+
+  ##
+  # @return [Array<String>] The actual values that are legitimate inputs to search query's sort field
+  def sort_values
+    _sorting = sorting || []
+    @sort_values ||= _sorting.map(&:value)
+  end
+
+  ##
+  # Pick out the filters struct from the response
+  #
+  # @return [Array<TCGPlayerSDK::ResponseStruct>]
+  def filters
+    if(self.results && self.results.is_a?(Array))
+      @filters ||= self.results.first.filters
+    end
+
+    return @filters
+  end
+end

data/lib/tcg-player-sdk/pokemon.rb

@@ -25,6 +25,13 @@ class TCGPlayerSDK::Pokemon
     @set_filter ||= @manifest.results.first.filters.select{|f| f.name == 'SetName'}.first
   end
 
+  ##
+  # @return [Array<TCGPlayerSDK::ResponseStruct>] Response struct with keys :value and :text, which correspond to
+  # the available ways to sort search data.  Set :sort in your search parameters to one of the returned :value
+  def sorting
+    @sorting ||= @manifest.results.first.sorting
+  end
+
   ##
   # Returns the TCGPlayerSDK filter item corresponding to the input set
   #

data/lib/tcg-player-sdk/product_price_list.rb

@@ -1,16 +1,15 @@
-class TCGPlayerSDK::ProductPriceList
-  attr_accessor :response
+class TCGPlayerSDK::ProductPriceList < TCGPlayerSDK::ResponseStruct
 
   ##
   # Group prices by product ID.  This will set
   # prices to an empty hash if there was an error.  Check response.errors for details about any errors.
   #
   # @param _response[TCGPlayerSDK::ResponseStruct] the result of calling TCGPlayerAPI#product_pricing
-  def initialize(_response)
-    @response = _response
+  def initialize(hash = {})
+    super
 
-    if(response.success && response.results)
-      @prices = response.results.map{|r| TCGPlayerSDK::ProductPrice.new(r)}.group_by{|r| r.productId}
+    if(self.success && self.results)
+      @prices = self.results.map{|r| TCGPlayerSDK::ProductPrice.new(r)}.group_by{|r| r.productId}
     else
       @prices = {}
     end

data/lib/tcg-player-sdk/tcg_player_sdk.rb

@@ -115,28 +115,68 @@ class TCGPlayerSDK
   #
   # @return [TCGPlayerSDK::ResponseStruct]
   def category_search_manifest(id)
-    query("#{CATEGORIES_URL}/#{id}/search/manifest")
+    Manifest.new(query("#{CATEGORIES_URL}/#{id}/search/manifest"))
   end
 
   # https://docs.tcgplayer.com/reference/catalog_searchcategory
   #
+  # @param id[String] The category ID to search through
+  # @param params[Hash] Put your additional search terms here:
+  #   - sort: One of the available sort filters see manifest.results.first.sorting
+  #   - limit: Cap the number of results to this limit
+  #   - offset: Used with :limit to return a limited number of results in an arbitrary location.  i.e. for pagination
+  #   - filters[Array<Hash>] An array of filters as described by manifest.results.first.filters.  Use the following format for Hash in the filters array
+  #     - name[String]: Name of one of the filters from the manifest
+  #     - values[Array<String>]: Specify which values to filter on
+  #
+  #   params = {
+  #     sort: 'ProductName ASC',
+  #     limit: 10,
+  #     offset: 0,
+  #     filters: [ {
+  #       name: 'ProductName',
+  #       values: ['Alakazam']
+  #     }]
+  #   }
+  #
+  #   results = tcg.category_search_products(3, params)
+  #   results.results #=> [42444, 42346, 83496, 106996, 83501, 83499, 83497, 83500, 83498, 180715]
+  #
+  #   # Do something with each product ID... will automatically fetch new results
+  #   all_ids = results.map{|r| r} #=> [42444, 42346, 83496, 106996, 83501, 83499, 83497, 83500, 83498, 180715, 83503, 83504, 117512, 117889, 117896, 117863, 83502, 226606, 228981, 228980, 228979, 251560, 84559, 84560, 118332, 117515, 117890, 88866]
+  #
   # @return [TCGPlayerSDK::ResponseStruct]
   def category_search_products(id, params = {})
     search_params = {post: true}.merge(params)
     query("#{CATEGORIES_URL}/#{id}/search", search_params)
   end
 
-  #def product_details(pids, params = {})
-  #  query("#{CATEGORIES_URL}/#{id}/search", search_params)
-  #end
+  ##
+  # https://docs.tcgplayer.com/reference/catalog_getproduct-1
+  #
+  def product_details(_ids, params = {})
+    ids = id_list(_ids)
+    query("#{CATALOG_URL}/products/#{ids}", params)
+  end
 
   ##
   # Accessor to https://docs.tcgplayer.com/reference/pricing_getproductprices-1
   #
-  # @param ids An array of product IDs to query
+  # @param _ids An array of product IDs to query
   # @return [TCGPlayerSDK::ProductPriceList]
   def product_pricing(_ids)
-    ids = _ids.is_a?(Array) ? _ids.join(',') : _ids
+    ids = id_list(_ids)
     TCGPlayerSDK::ProductPriceList.new(query("#{PRICING_URL}/product/#{ids}"))
   end
+
+  private
+
+  ##
+  # Sanitize an array or string of ids to be compatible with the comma-separated values that the API expects
+  #
+  # @param value Accepts either an Array or String to convert to the API-friendly formatting
+  # @return [String] ids separated by comma
+  def id_list(value)
+    value.is_a?(Array) ? value.join(',') : value
+  end
 end

data/lib/tcg-player-sdk.rb

@@ -8,4 +8,5 @@ require 'tcg-player-sdk/bearer_token'
 require 'tcg-player-sdk/response_struct'
 require 'tcg-player-sdk/product_price_list'
 require 'tcg-player-sdk/pokemon'
+require 'tcg-player-sdk/manifest'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcg-player-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Carl Svensson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - lib/tcg-player-sdk.rb
 - lib/tcg-player-sdk/bearer_token.rb
+- lib/tcg-player-sdk/manifest.rb
 - lib/tcg-player-sdk/pokemon.rb
 - lib/tcg-player-sdk/product_price_list.rb
 - lib/tcg-player-sdk/response_struct.rb