beyond_api 0.15.0.pre → 0.18.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438360193bc7064cbd6591e9dc088aeb81f162aac26bff0ac1f891f45b5b9993
-  data.tar.gz: 57f358035cc7aa0ee5ee0795eecb3f887b5f534d470342348d70c6e6c6f1ac48
+  metadata.gz: e9b48b71a8bbe959b3250221b561ea742a3d82e0d80a0f0b9f4638cc2f57b5ed
+  data.tar.gz: 4c9353fd93cef022310c1b7ae1b147776d1e1bc6da94a751adc68f14852efb2a
 SHA512:
-  metadata.gz: 284505c3dc6af706bd3851fe62c885ce2aec79c76a997b2c07f20a23d5745c3a7d16c337177de9579b25c0fe9440b2b9e04f5cfdd2ec377362effb2a98df7b0b
-  data.tar.gz: eb9168f92793a47673646fcb8ac36bd6c5103596620a1003a143242a938ceba156429fe3760f41672c705a23f367ad2be40d6607c0f112ecdf16be1ead96a0b1
+  metadata.gz: e7cbc7f1f943fc00701e2f548756dfa0cc2808cc51096bf0c6a6be5bbf9b7edfcfd16b80ae351251feb3d26f9be0cba23df3fbf093ff4a69b5ff169b0087a297
+  data.tar.gz: 946ce5ce94a725e55ee7e1c172b4094b6146836c5e4f8cb28b4823c0426db1923044c4b4cc22f9f470ff55101a5698be694e82876a05f296510a07d91b465b02

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### v0.18.0.pre
+
+* features
+  * Add new token retrieval/refresh methods
+    * `Token#authorization_code`
+    * `Token#refresh_token`
+    * `Token#client_credentials`
+  * Add alias methods for avoiding deprecation
+    * `refresh` -> `refresh_token`
+    * `create`  -> `authorization_code`
+
+### v0.17.0.pre
+
+* enhancements
+  * Add customizable pagination size when sending `paginated: false` parameter to `#all` requests.
+
+### v0.16.1.pre
+
+* bug-fixes
+  * Fix method to retrieve resources without pagination
+
+### v0.16.0.pre
+
+* features
+  * Add pickup options methods
+    * `PickupOptions#delete`
+    * `PickupOptions#find`
+    * `PickupOptions#sort`
+    * `PickupOptions#update`
+
 ### v0.15.0.pre
 
 * features
@@ -12,7 +42,7 @@
 
 * features
   * Add `Products#assign_variation_attribute_as_differentiator`
-  
+
 ### v0.13.0.pre
 
 * features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.15.0.pre)
+    beyond_api (0.18.0.pre)
       faraday (~> 0.15)
 
 GEM
@@ -52,4 +52,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.2.26

data/beyond_api.gemspec

@@ -6,7 +6,7 @@ require "beyond_api/version"
 Gem::Specification.new do |spec|
   spec.name          = "beyond_api"
   spec.version       = BeyondApi::VERSION
-  spec.authors       = ["Unai Abrisketa", "Kathia Salazar", "German San Emeterio"]
+  spec.authors       = ["Unai Abrisketa", "Kathia Salazar", "German San Emeterio", "Kenneth Gallego"]
 
   spec.summary       = "Ruby client to access the Beyond API"
   spec.homepage      = "https://github.com/ePages-de/beyond_api-ruby_client"

data/lib/beyond_api.rb

@@ -27,7 +27,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
+                  :log_headers, :log_bodies, :log_level, :all_pagination_size
 
     def initialize
       @client_id = nil
@@ -42,6 +42,8 @@ module BeyondApi
       @log_level = :info
       @log_headers = false
       @log_bodies = false
+
+      @all_pagination_size = 200
     end
   end
 end

data/lib/beyond_api/resources/pickup_options.rb

@@ -68,9 +68,9 @@ module BeyondApi
     #       tax_model: "GROSS",
     #       currency: "EUR",
     #       amount: 1
-    #      },
-    #      phone_number_required: true,
-    #      location_id: "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #     },
+    #     phone_number_required: true,
+    #     location_id: "cb554eb6-2768-4491-afd2-6bcd0aec0937"
     #   }
     #
     #   @pickup_option = session.pickup_options.create(body)
@@ -80,5 +80,137 @@ module BeyondApi
 
       handle_response(response, status)
     end
+
+    #
+    # A +DELETE+ request is used to delete a pickup option.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options/d253a31b-3892-4196-ae16-c5d8d6b05791' -i -X DELETE
+    #
+    # @beyond_api.scopes +shpz:d+
+    #
+    # @param pickup_option_id [String] the pickup option UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.pickup_options.delete("d253a31b-3892-4196-ae16-c5d8d6b05791")
+    #
+    def delete(pickup_option_id)
+      response, status = BeyondApi::Request.delete(@session, "/pickup-options/#{pickup_option_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of a pickup option.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options/76302c10-761f-43c1-9d18-52ad16bd52e8' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +shpz:r+
+    #
+    # @param pickup_option_id [String] the pickup option UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @pickup_option = session.pickup_options.find("76302c10-761f-43c1-9d18-52ad16bd52e8")
+    #
+    def find(pickup_option_id)
+      response, status = BeyondApi::Request.get(@session, "/pickup-options/#{pickup_option_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to sort the pickup options. This is done by passing the self-links of the pickup options in the desired order. The request must contain URIs for all pickup options of the given page.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X PUT \
+    #       -H 'Content-Type: text/uri-list' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d 'https://api-shop.beyondshop.cloud/api/pickup-options/bff3673f-91c1-4e09-a8ab-562a3a553fac
+    #           https://api-shop.beyondshop.cloud/api/pickup-options/7b4d36fc-ac0f-44a3-8655-f2bd05c2a42d
+    #           https://api-shop.beyondshop.cloud/api/pickup-options/630b63ee-c7d8-4953-9b7c-c874fd795154'
+    #
+    # @beyond_api.scopes +shpz:u+
+    #
+    # @param pickup_option_ids [Array] the pickup option UUIDs
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   pickup_option_ids = [
+    #     "bff3673f-91c1-4e09-a8ab-562a3a553fac",
+    #     "7b4d36fc-ac0f-44a3-8655-f2bd05c2a42d",
+    #     "630b63ee-c7d8-4953-9b7c-c874fd795154"
+    #   ]
+    #
+    #   session.pickup_options.sort(pickup_option_ids)
+    #
+    def sort(pickup_option_ids)
+      body = pickup_option_ids.map { |id| "#{@session.api_url}/pickup-options/#{id}" }
+      response, status = BeyondApi::Request.put(@session, "/pickup-options", body)
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +PUT+ request is used to update a pickup option.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options/5765b837-db5b-49a9-a659-68d00376e42a' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "New name",
+    #       "description" : "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.",
+    #       "taxClass" : "REGULAR",
+    #       "freePickupValue" : {
+    #         "currency" : "EUR",
+    #         "amount" : 50
+    #       },
+    #       "fixedPrice" : {
+    #         "taxModel" : "GROSS",
+    #         "currency" : "EUR",
+    #         "amount" : 1
+    #       },
+    #       "phoneNumberRequired" : true,
+    #       "locationId" : "c9179393-abcc-450a-8cf4-875b39647ab6"
+    #   }'
+    #
+    # @beyond_api.scopes +shpz:u+
+    #
+    # @param pickup_option_id [String] the pickup option UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     name: "New name",
+    #     description: "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.",
+    #     tax_class: "REGULAR",
+    #     free_pickup_value: {
+    #       currency: "EUR",
+    #       amount: 50
+    #     },
+    #     fixed_price: {
+    #       tax_model: "GROSS",
+    #       currency: "EUR",
+    #       amount: 1
+    #     },
+    #     phone_number_required: true,
+    #     location_id: "c9179393-abcc-450a-8cf4-875b39647ab6"
+    #   }
+    #
+    #   @pickup_option = session.pickup_options.update("5765b837-db5b-49a9-a659-68d00376e42a", body)
+    #
+    def update(pickup_option_id, body)
+      response, status = BeyondApi::Request.put(@session, "/pickup-options/#{pickup_option_id}", body)
+
+      handle_response(response, status)
+    end
   end
 end

data/lib/beyond_api/resources/products.rb

@@ -98,8 +98,8 @@ module BeyondApi
     #       }
     #     },
     #     "shippingPeriod" : {
-    #       "minDays" : 2,
-    #       "maxDays" : 4,
+    #       "min" : 2,
+    #       "max" : 4,
     #       "displayUnit" : "WEEKS"
     #     }
     #   }'
@@ -157,8 +157,8 @@ module BeyondApi
     #      }
     #    },
     #    "shippingPeriod": {
-    #      "minDays": 2,
-    #      "maxDays": 4,
+    #      "min": 2,
+    #      "max": 4,
     #      "displayUnit": "WEEKS"
     #    }
     #   }

data/lib/beyond_api/resources/token.rb

@@ -17,31 +17,32 @@ module BeyondApi
       raise InvalidSessionError.new("Session api_url cannot be nil") if session.api_url.nil?
     end
 
-    def create(code)
-      response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "authorization_code",
-                                                  code: code)
-
-      handle_response(response, status)
+    def authorization_code(code)
+      handle_token_call("authorization_code", code: code)
     end
 
-    def refresh
-      response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "refresh_token",
-                                                  refresh_token: @session.refresh_token)
-
-      handle_response(response, status)
+    def refresh_token
+      handle_token_call("refresh_token", refresh_token: @session.refresh_token)
     end
 
     def client_credentials
+      handle_token_call("client_credentials")
+    end
+
+    alias_method :refresh, :refresh_token
+    alias_method :create, :authorization_code
+
+    private
+
+    def handle_token_call(grant_type, params = {})
+      params.merge!(grant_type: grant_type)
+
       response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "client_credentials")
+                                                  params)
 
       handle_response(response, status)
     end
 
-    private
-
     def handle_response(response, status)
       if status.between?(200, 299)
         @session.access_token = response["access_token"]

data/lib/beyond_api/utils.rb

@@ -45,14 +45,18 @@ module BeyondApi
     end
 
     def handle_all_request(url, resource, params = {})
+      paginated_size = BeyondApi.configuration.all_pagination_size
+
       if params[:paginated] == false
-        result = all_paginated(url, { page: 0, size: 1000 })
+        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, { page: page, size: 1000 })[:embedded][resource])
+          result[:embedded][resource].concat(all_paginated(url, params.merge(page: page, size: paginated_size))[:embedded][resource])
         end
 
-        result.is_a?(Hash) ? result.delete(:page) : result.delete_field(:page)
+        result[:page][:size] = result[:page][:total_elements]
+        result[:page][:total_pages] = 1
+        result[:page][:number] = 0
 
         result
       else

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.15.0.pre".freeze
+  VERSION = "0.18.0.pre".freeze
 end

data/lib/generators/templates/beyond_api_initializer.rb

@@ -12,6 +12,9 @@ BeyondApi.setup do |config|
   # Configure the request timeout in seconds. Default is 5 seconds.
   # config.timeout = 5.seconds
 
+  # Configure the pagination size when `paginated: false` is sent on `.all()` requests. Value must be between 1 and 1000.
+  # config.all_pagination_size = 200
+
   # ==> Log configuration
 
   # Configure the log level. Must be one of :debug, :info, :warn, :error,

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.15.0.pre
+  version: 0.18.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
 - Kathia Salazar
 - German San Emeterio
-autorequire: 
+- Kenneth Gallego
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,8 +111,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -183,7 +184,7 @@ files:
 homepage: https://github.com/ePages-de/beyond_api-ruby_client
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -198,8 +199,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: Ruby client to access the Beyond API
 test_files: []