beyond_api 0.24.2.pre → 0.24.4.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d639c8a6307238a7dbc87d0d3a66b0e69c693db6d124cea7f7d89cfa5cc7488
-  data.tar.gz: eb19fa1766b92049d2900829a730ccc0fdd78dd18465f8b5ae9d28df384e799b
+  metadata.gz: a8afb7efc6603d13612c778fc5434ffb10d0681219e19fe492e6f97edf72ca16
+  data.tar.gz: c8b32ac06053d8df1a5cf5966b98354eb4693636fe5390183dd1ee7a2f903eab
 SHA512:
-  metadata.gz: 7ac1cc1a3e0b046b5add6a53001a2c602741ca62d3acfee1d6db1a59469af38907693918f821688a5d4c31cde5e27048b56ddd9468ed91d14890d49454dffc7c
-  data.tar.gz: 5c7468464f88a6513832236edf49939f534d9482edf27668a55b1ef659c5aec03795c40d1775acf3630f37958f17ce356c856e53bbde2ce19e20514389e1347e
+  metadata.gz: ac544f672b62235e98090b1554d252345763122eb742e085b330ccec4654dceaa4aae58d5c1cd941a25e2cf4a5d15faab9ea67328f5b89be737133f0999c4f9c
+  data.tar.gz: 3037052be3fd2a48ed80b64ce7672e3108499791d5eded18969f88c21418f90402adc8620db9997fe0a8ce25090bdd764cacaff5a643750a14cc9f40e5749054

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.24.2.pre)
+    beyond_api (0.24.4.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/customer_groups.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class CustomerGroups < Base
+    include BeyondApi::Utils
+    #
+    # A +GET+ request is used to list all customer groups of a shop in a paged way. Each item in the response represents a summary of the customer group data.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/customer-groups' -i -X POST \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +cugr:r+
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @customer_groups = session.customer_groups.all
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/customer-groups", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to add a customer to a provided list of groups.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/customers/fb5f14ac-f274-4673-ad40-6712dfeea1ba/customer-groups' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #       -d '["5d94fa06-f58c-4379-9714-5dc57877c186"]'
+    #
+    # @beyond_api.scopes +cugr:r+
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @customer_groups = session.add_customer("fb5f14ac-f274-4673-ad40-6712dfeea1ba", ["5d94fa06-f58c-4379-9714-5dc57877c186"])
+    #
+    def add_customer(customer_id, customer_group_ids)
+      response, status = BeyondApi::Request.post(@session,
+                                                 "/customers/#{customer_id}/customer-groups",
+                                                 customer_group_ids)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/session.rb

@@ -7,6 +7,7 @@ module BeyondApi
   autoload :Categories,                  "beyond_api/resources/categories"
   autoload :CheckoutSettings,            "beyond_api/resources/checkout_settings"
   autoload :Customers,                   "beyond_api/resources/customers"
+  autoload :CustomerGroups,               "beyond_api/resources/customer_groups"
   autoload :NewsletterTarget,            "beyond_api/resources/newsletter_target"
   autoload :OrderSettings,               "beyond_api/resources/order_settings"
   autoload :Orders,                      "beyond_api/resources/orders"
@@ -57,6 +58,10 @@ module BeyondApi
       BeyondApi::CheckoutSettings.new(self)
     end
 
+    def customer_groups
+      BeyondApi::CustomerGroups.new(self)
+    end
+
     def customers
       BeyondApi::Customers.new(self)
     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.2.pre"
+  VERSION = "0.24.4.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.2.pre
+  version: 0.24.4.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2025-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,6 +187,7 @@ files:
 - lib/beyond_api/resources/categories.rb
 - lib/beyond_api/resources/categories_view.rb
 - lib/beyond_api/resources/checkout_settings.rb
+- lib/beyond_api/resources/customer_groups.rb
 - lib/beyond_api/resources/customers.rb
 - lib/beyond_api/resources/newsletter_target.rb
 - lib/beyond_api/resources/order_settings.rb