beyond_api 0.22.2.pre → 0.24.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a1046cb7637b192f79fca4be07b902cf3045963b3f978062a8fd84944284e0
-  data.tar.gz: c8aacd61559f7fe51597e4e63b0172aaddf84bed4fb01f5831961fb602f4c7e0
+  metadata.gz: 6da6567d2a64ac33b9c160fccaf6c8cd694b752450517b20ac60a9040c8227b6
+  data.tar.gz: c88ebfdc202da7b8b17d14031bd1502b319a5754c3f575e96ba258b1641932dc
 SHA512:
-  metadata.gz: b7e4d641196968088a2954559271e4cf12c15b1afe3938a54a9f57e9612ec8ba59b4f842fc8abd74b7e356c24b4ee4255c8878b856ab0afafc2c86c4f8c0bd46
-  data.tar.gz: 6cb10e858271f8f87bb6a77e370cf3ff096aee683f57817acb653228c86b132a3db2d3eebf7633dcf5f0bb18c8d0230e84d196a19b8fe6d9dbc3ba607ad9a248
+  metadata.gz: f954f6572aed87a243514cf798da0550e12013f26b1c0668379662318c959b0697ae74ab26795711298f3b05636cc7293622e6e9e7ef97cf51ad59463fcc4d98
+  data.tar.gz: f48e8d78fa746d5166faca83e9713456f172626f49c5f2e2af3e6a999a30bdc480d9e48eadeff49ba60cfe0a8f4a1f5120f8b01b215e7ab1ae537a1805fccfb3

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### v0.24.0.pre
+
+* features
+  * Add category preview method
+    * `CategoriesView#preview`
+
+### v0.23.0.pre
+
+* feature
+  * Add optional `paginated: false` parameter to `session.categories_view.products(paginated: false)`
+
 ### v0.22.1.pre
 
 * enhancements
@@ -15,6 +26,7 @@
 
 * features
   * Add  `Variations#sort_images` method
+
 ### v0.20.0.pre
 
 * features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.22.2.pre)
+    beyond_api (0.24.0.pre)
       faraday (~> 1.9.0)
 
 GEM

data/lib/beyond_api/resources/categories_view.rb

@@ -48,6 +48,64 @@ module BeyondApi
       handle_response(response, status)
     end
 
+    #
+    # A +POST+ request is read-only and cannot create data. It is used to find products that match the filter criteria.
+    # Thus, it can be used to preview all products that are included in a category that shares the respective filter criteria.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/preview?page=0&size=10&sortBy=NEWEST_FIRST' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Content-Type: application/json' \
+    #       -d '{
+    #     "filters" : [ {
+    #       "key" : "manufacturer",
+    #       "values" : [ "Grape Vineyard" ]
+    #     }, {
+    #       "key" : "all_tags",
+    #       "values" : [ "Power Bar", "Bestseller", "High Protein" ]
+    #     }, {
+    #       "key" : "price_range",
+    #       "min" : 3.7,
+    #       "max" : 13.7
+    #     } ]
+    #   }'
+    #
+    # @param body [Hash] the request body
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    # @option params [String] :sort_by the sorting applied to the list of products
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     filters => [ 
+    #       {
+    #         key => "manufacturer",
+    #         values => [ "Grape Vineyard" ]
+    #       },
+    #       {
+    #         key => "all_tags",
+    #         values => [ "Power Bar", "Bestseller", "High Protein" ]
+    #       },
+    #       {
+    #         key => "price_range",
+    #         min => 3.7,
+    #         max => 13.7
+    #       } 
+    #     ]
+    #   }
+    #
+    #   @products = session.categories_view.preview(body, { size: 100, page: 0, sort_by: "NEWEST_FIRST" })
+    #
+    def preview(body, params = {})
+      response, status = BeyondApi::Request.post(@session,
+                                                 "/product-view/categories/preview",
+                                                 body,
+                                                 params)
+
+      handle_response(response, status)
+    end
+
     #
     # A +GET+ request is used to list all products of a category.
     #
@@ -65,11 +123,9 @@ module BeyondApi
     #   @products = session.categories_view.products("681beef2-cd3e-4ce3-8034-4d07c1184447", { size: 100, page: 0 })
     #
     def products(category_id, params = {})
-      response, status = BeyondApi::Request.get(@session,
-                                                "/product-view/categories/#{category_id}/products",
-                                                params)
+      path = "/product-view/categories/#{category_id}/products"
 
-      handle_response(response, status)
+      handle_all_request(path, :products, params)
     end
 
     #

data/lib/beyond_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BeyondApi
-  VERSION = "0.22.2.pre"
+  VERSION = "0.24.0.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.22.2.pre
+  version: 0.24.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Ruby client to access the Beyond API