beyond_api 0.24.1.pre → 0.24.3.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d8675fa4225b9cbbab16aed477c2bc119be330cde5be9249e363263c292e7df
-  data.tar.gz: 4672536fd5daf3777a55cf253d699447c77c61d26905d65736fde17a4fa42b1e
+  metadata.gz: c9a08ccefc4acb0bfeacf32a46a5245957fecd2aa36e382417031a641638bb0c
+  data.tar.gz: 5841b98257b1233859ac6e4066172411017560aca64abf3e87ec134452949d4a
 SHA512:
-  metadata.gz: 4b194a0f1819933338bd3241807a65372e4f6a44c440dcd3b7b575a39d188bff7fd4e5af7b97556984f95c5ccce820e73ac0de23691458cadac51588874095af
-  data.tar.gz: d47dad7d298e7b9093a545e28083ea42d0ed3d717d65d7ad6e6bbb0f04c4dd694d66778cd376e4882be956a2eb4c3b7083c62025c7c4d13beb0a91650f39a82e
+  metadata.gz: d6a82f6ff8d9902d48541ca9a4e1d0458b42256cc3678c2960a7fad0e99cc6648fbd0ff3a93f795405ad22048bd4bf3c08d697175b2c8981b11f656b23b061ed
+  data.tar.gz: 1dab71c2c694618119f57aaad1fe46a5febf61a104ae5251e737e83418883d449a01cb1b2646f236011acef501877bf8f25bc62ba4ca3a3b51ce2fc78dbe747d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### v0.24.2.pre
+
+* features
+  * Add `ShippingZones#update_shipping_method`
+
 ### v0.24.1.pre
 
 * bug-fixes

data/Gemfile.lock

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

data/lib/beyond_api/connection.rb

@@ -9,15 +9,16 @@ module BeyondApi
 
     def self.default
       Faraday.new(ssl: { verify: true }) do |faraday|
+        faraday.adapter(:net_http)
         faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
         faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
-        faraday.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
-                                            bodies: BeyondApi.configuration.log_bodies }
         faraday.headers["Accept"] = "application/json"
         faraday.headers["Content-Type"] = "application/json"
         faraday.request(:multipart)
         faraday.request(:url_encoded)
-        faraday.adapter(:net_http)
+        faraday.request(:retry, BeyondApi.configuration.retry_options)
+        faraday.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
+                                            bodies: BeyondApi.configuration.log_bodies }
       end
     end
 

data/lib/beyond_api/error.rb

@@ -5,6 +5,8 @@ module BeyondApi
     attr_reader :error_id, :details, :trace_id, :full_message, :status_code, :error, :error_description
 
     def initialize(data, status_code = nil)
+      data ||= {}
+
       @error_id          = data["errorId"]
       @details           = data["details"]
       @trace_id          = data["traceId"]

data/lib/beyond_api/resources/shipping_zones.rb

@@ -108,7 +108,7 @@ module BeyondApi
     #       "amount" => "19.99"
     #     }
     #   }
-    #   @shipping_zone = session.shipping_zones.create_shipping_method("905e981c-1489-45af-9138-0a7dc1f0b085", body)
+    #   @shipping_method = session.shipping_zones.create_shipping_method("905e981c-1489-45af-9138-0a7dc1f0b085", body)
     #
     def create_shipping_method(shipping_zone_id, body)
       path = "/shipping-zones/#{shipping_zone_id}/shipping-methods"
@@ -360,5 +360,61 @@ module BeyondApi
 
       handle_response(response, status)
     end
+
+    #
+    # A +PUT+ request is used to update a shipping method in a shipping zone.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/c4137d8b-3dd1-4b73-91f0-32f1433c8195/shipping-methods/25df7018-a7a2-4903-85fa-6a3a73ae40b2' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "Express",
+    #       "description" : "Shipping overnight. Delivery on the next day.",
+    #       "taxClass" : "REGULAR",
+    #       "freeShippingValue" : {
+    #         "currency" : "EUR",
+    #         "amount" : 200
+    #       },
+    #       "fixedPrice" : {
+    #         "taxModel" : "GROSS",
+    #         "currency" : "EUR",
+    #         "amount" : 25
+    #       }
+    #     }'
+    #
+    # @beyond_api.scopes +shpz:u+
+    #
+    # @param shipping_zone_id [String] the shipping zone UUID
+    # @param shipping_method_id [String] the shipping method UUID
+    # @param body [String] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "name" : "Express",
+    #     "description" : "Shipping overnight. Delivery on the next day.",
+    #     "taxClass" : "REGULAR",
+    #     "freeShippingValue" : {
+    #       "currency" : "EUR",
+    #       "amount" : 200
+    #     },
+    #     "fixedPrice" : {
+    #       "taxModel" : "GROSS",
+    #       "currency" : "EUR",
+    #       "amount" : 25
+    #     }
+    #   }
+    #   @shipping_method = session.shipping_zones.update_shipping_method("c4137d8b-3dd1-4b73-91f0-32f1433c8195", "25df7018-a7a2-4903-85fa-6a3a73ae40b2", body)
+    #
+    def update_shipping_method(shipping_zone_id, shipping_method_id, body)
+      path = "/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}"
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path,
+                                                body)
+
+      handle_response(response, status)
+    end
   end
 end

data/lib/beyond_api/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ostruct"
+
 module BeyondApi
   module Utils
     extend self
@@ -22,7 +24,11 @@ module BeyondApi
         result = all_paginated(url, params.merge(page: 0, size: paginated_size))
 
         (1..result[:page][:total_pages] - 1).each do |page|
-          result[:embedded][resource].concat(all_paginated(url, params.merge(page: page, size: paginated_size))[:embedded][resource])
+          result[:embedded][resource].concat(
+            all_paginated(url,
+                          params.merge(page: page,
+                                       size: paginated_size))[:embedded][resource]
+          )
         end
 
         result[:page][:size] = result[:page][:total_elements]

data/lib/beyond_api/version.rb

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

data/lib/beyond_api.rb

@@ -29,7 +29,7 @@ module BeyondApi
   class Configuration
     attr_accessor :client_id, :client_secret, :open_timeout, :timeout, :remove_response_links,
                   :remove_response_key_underscores, :object_struct_responses, :raise_error_requests,
-                  :log_headers, :log_bodies, :log_level, :all_pagination_size
+                  :log_headers, :log_bodies, :log_level, :all_pagination_size, :retry_options
 
     def initialize
       @client_id = nil
@@ -46,6 +46,15 @@ module BeyondApi
       @log_bodies = false
 
       @all_pagination_size = 200
+
+      @retry_options = {
+        max: 5,
+        interval: 0.05,
+        interval_randomness: 0.5,
+        backoff_factor: 2,
+        retry_statuses: [409],
+        exceptions: [Faraday::TimeoutError, Faraday::ConnectionFailed]
+      }
     end
   end
 end

data/lib/generators/templates/beyond_api_initializer.rb

@@ -50,4 +50,18 @@ BeyondApi.setup do |config|
   # BeyondApi::Error object with detailed information of the error.
   # Default is false.
   # config.raise_error_requests = false
+
+  # ==> Retry configuration
+  # Configure the retry options for requests. Default is:
+  # config.retry_options = {
+  #   max: 5,
+  #   interval: 0.05,
+  #   interval_randomness: 0.5,
+  #   backoff_factor: 2,
+  #   retry_statuses: [409],
+  #   exceptions: [Faraday::TimeoutError, Faraday::ConnectionFailed]
+  # }
+  # Or you can set single retry options like this:
+  # config.retry_options[:max] = 5
+  # config.retry_options[:interval] = 1
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.24.1.pre
+  version: 0.24.3.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler