beyond_api 0.20.0.pre → 0.21.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084d3533192827ae43bcbbdcef706d5e6a3fd9ab7c518492c87dcf57e2ff8233'
-  data.tar.gz: e28b3a3526b2a97eb511137acf723345512dadcaa9fd7532990245ef0846d572
+  metadata.gz: 40f831d05843ba3350e2aa8a390715004c1bc99f82836a9f40b60e7f0888ef25
+  data.tar.gz: 4ae22902b0eb2b17941d3e1c59c039eba3d374cb6c0836091ed96906e2f2eae3
 SHA512:
-  metadata.gz: 25f33bb7cefa616071fb0b29bbf1c9a104eeb963407e58049a61ee80d9fa93e920859350129c6c398160e357b2de0fb3c9bbf2da4aac63c61cfeccf5f2154e5c
-  data.tar.gz: ca5922134ab627f9fa3482e4a4b367bd0b1252df4a15f6536045b5390518876c597dbedeca3738c51c16402d7dafdf67bc314c3e995398d421d1d7dca0bde74d
+  metadata.gz: 555e694512db5677f89330f54586fc377461e7d5ea17d8a4d8fb4c65851c01ab2f443ee182b1ebe50f725e57eceada098d4eb11e7e2d538f2a5b8bffd69fafd1
+  data.tar.gz: 41752eb106202b23d7c1a449e30d6e4defe811d00bddb1280403829fe71d59683a08ae0b7797c615ff88a583ddcbcd05aa60c72dcc1b6b47ce0b610732c8ac6f

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v0.21.0.pre
+
+* bug-fixes
+  * Fix  `Products#sort_images` method
+
+* features
+  * Add  `Variations#sort_images` method
 ### v0.20.0.pre
 
 * features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.20.0.pre)
+    beyond_api (0.21.0.pre)
       faraday (~> 1.8.0)
 
 GEM
@@ -112,4 +112,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.31
+   2.3.0

data/lib/beyond_api/request.rb

@@ -20,12 +20,14 @@ module BeyondApi
       end
 
       [:post, :put, :patch].each do |method|
-        define_method(method) do |session, path, body = {}, params = {}|
+        define_method(method) do |session, path, body = {}, params = {}, content_type = 'application/json'|
           response = BeyondApi::Connection.default.send(method) do |request|
             request.url(session.api_url + path)
             request.headers["Authorization"] = "Bearer #{session.access_token}" unless session.access_token.nil?
+            request.headers["Content-Type"] = content_type
             request.params = params.to_h.camelize_keys
-            request.body = body.camelize_keys.to_json
+
+            request.body = body.respond_to?(:camelize_keys) ? body.camelize_keys.to_json : body
           end
 
           [response.body.blank? ? nil : JSON.parse(response.body), response.status]

data/lib/beyond_api/resources/products/images.rb

@@ -162,7 +162,7 @@ module BeyondApi
     #
     def sort_images(product_id, image_ids)
       body = image_ids.map { |image_id| "#{@session.api_url}/products/#{product_id}/images/#{image_id}" }
-      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/images", body)
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/images", body.join("\n"), {}, 'text/uri-list')
 
       handle_response(response, status, respond_with_true: true)
     end

data/lib/beyond_api/resources/variations/images.rb

@@ -129,6 +129,38 @@ module BeyondApi
       handle_response(response, status)
     end
 
+    # A +PUT+ request is used to sort the variation images. This is done by passing the self-links of the images to the desired variation. The request must contain URIs for all images of the given page.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/8a8a7002-f864-4011-9991-d6ffb1bd1085/variations/60c2c2a5-ece0-4d04-b90d-f38ee710961c/images' -i -X PUT \
+    #     -H 'Content-Type: text/uri-list' \
+    #     -H 'Authorization: Bearer <Access token>' \
+    #     -d 'https://api-shop.beyondshop.cloud/api/products/8a8a7002-f864-4011-9991-d6ffb1bd1085/variations/60c2c2a5-ece0-4d04-b90d-f38ee710961c/images/a12cae49-3efb-4874-989e-37df6981a4db
+    #         https://api-shop.beyondshop.cloud/api/products/8a8a7002-f864-4011-9991-d6ffb1bd1085/variations/60c2c2a5-ece0-4d04-b90d-f38ee710961c/images/4f562165-968c-42fd-a245-1dcc045f8151
+    #         https://api-shop.beyondshop.cloud/api/products/8a8a7002-f864-4011-9991-d6ffb1bd1085/variations/60c2c2a5-ece0-4d04-b90d-f38ee710961c/images/93cd0802-15db-4772-b524-e1c4c6c27b77'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @param images [Array] the image UUIDS
+    #
+    # @return true
+    #
+    # @example
+    #   body = [
+    #     "c9082802-a0d0-416e-9039-02fa465a027e",
+    #     "78e9993d-8db3-45d8-8f76-6b8f2aea9c45",
+    #     "9233ee97-5dbb-4c00-a7b2-e1512c69a938"
+    #   ]
+    #   session.variations.sort_images("3f4b2b56-c22d-4d80-b4ed-d5b33ed161eb", body)
+    #
+    def sort_images(product_id, variation_id, image_ids)
+      body = image_ids.map { |image_id| "#{@session.api_url}/products/#{product_id}/variations/#{variation_id}/images/#{image_id}" }
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/variations/#{variation_id}/images", body.join("\n"), {}, 'text/uri-list')
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
     #
     # A +POST+ request is used to upload an image to the image storage and assign the URL of the image to the variation. The body of the request must contain the content of the image.
     #

data/lib/beyond_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.20.0.pre
+  version: 0.21.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2022-01-18 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.0.3
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API