beyond_api 0.14.0.pre → 0.17.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3232a181c9e98adb48dde14f44f3fbf5cbd148716a4aebfaedd8395f67f1c1
-  data.tar.gz: 3165b0482c207a611d5b1c1cfe0631a730c7d23774f0551c34c6e29bfb571134
+  metadata.gz: 121cdb5fc26eaefb6eb20ccad546c70508ed15517e159227b973ab95333ec30f
+  data.tar.gz: 42bc3c28f1696e588c2ed9cd405e32ddee90b2d716299d9354773f70b18613dd
 SHA512:
-  metadata.gz: ba4db6852f6ea76b6b27a5def080dd54b1e2a9767a050cbddfb463eb538deac413b22923f065a1b4da37f828866142acc7173a0242a30ebf80b5e530d0606acf
-  data.tar.gz: 3f48e09d7f4a934218fefeff168c67a5aaa097dd502fb8080969748dc8ac612ec7f4444596e3b6f73cfc234b37741063103beace5cfa59375eb6b4a689b5e130
+  metadata.gz: fbd457331b5d3939a81590f983eb27e2c0ef754f8d4f5cb75c25299d4fd0db0f0c206766463f3918542ef74c3db652a7f5a2b61c677addb63071091c0ed8a397
+  data.tar.gz: 659cc4f40f38f5f36c4c0ab476720cb1a1fc7ef1a6d518b7f0d5f71d8ad3219983e8304c07c5ad8c28d20d0baa2d0225ffe0c6b8324f575f43b0f14fbc3bffb0

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+### 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
+  * Add pickup options methods
+    * `PickupOptions#all`
+    * `PickupOptions#create`
+
 ### v0.14.0.pre
 
 * deprecations
@@ -5,7 +31,7 @@
 
 * features
   * Add `Products#assign_variation_attribute_as_differentiator`
-  
+
 ### v0.13.0.pre
 
 * features

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.14.0.pre)
+    beyond_api (0.17.0.pre)
       faraday (~> 0.15)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faker (2.17.0)
+    faker (2.18.0)
       i18n (>= 1.6, < 2)
     faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
@@ -19,7 +19,7 @@ GEM
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (10.5.0)

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

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class PickupOptions < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to list all pickup options of the shop in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @option params [Boolean] :paginated
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @pickup_options = session.pickup_options.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      handle_all_request("/pickup-options", :pickup_options, params)
+    end
+
+    #
+    # A +POST+ request is used to create a pickup option.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "My little Cornershop - St.Ives",
+    #       "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" : "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #   }'
+    #
+    # @beyond_api.scopes +shpz:c+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     name: "My little Cornershop - St.Ives",
+    #     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: "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #   }
+    #
+    #   @pickup_option = session.pickup_options.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/pickup-options", body)
+
+      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/session.rb

@@ -11,6 +11,7 @@ module BeyondApi
   autoload :OrderSettings,               "beyond_api/resources/order_settings"
   autoload :Orders,                      "beyond_api/resources/orders"
   autoload :PaymentMethodDefinitions,    "beyond_api/resources/payment_method_definitions"
+  autoload :PickupOptions,               "beyond_api/resources/pickup_options"
   autoload :PaymentMethods,              "beyond_api/resources/payment_methods"
   autoload :ProductAttributeDefinitions, "beyond_api/resources/product_attribute_definitions"
   autoload :ProductsView,                "beyond_api/resources/products_view"
@@ -74,6 +75,10 @@ module BeyondApi
       BeyondApi::PaymentMethods.new(self)
     end
 
+    def pickup_options
+      BeyondApi::PickupOptions.new(self)
+    end
+
     def product_attribute_definitions
       BeyondApi::ProductAttributeDefinitions.new(self)
     end

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.14.0.pre".freeze
+  VERSION = "0.17.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.14.0.pre
+  version: 0.17.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
 - Kathia Salazar
 - German San Emeterio
-autorequire: 
+- Kenneth Gallego
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-08-12 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: []
@@ -148,6 +149,7 @@ files:
 - lib/beyond_api/resources/orders.rb
 - lib/beyond_api/resources/payment_method_definitions.rb
 - lib/beyond_api/resources/payment_methods.rb
+- lib/beyond_api/resources/pickup_options.rb
 - lib/beyond_api/resources/product_attribute_definitions.rb
 - lib/beyond_api/resources/products.rb
 - lib/beyond_api/resources/products/attachments.rb
@@ -182,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
@@ -197,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.1.2
+signing_key:
 specification_version: 4
 summary: Ruby client to access the Beyond API
 test_files: []