beyond_api 0.13.0.pre → 0.16.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be322cd30437303093e481de07cd8e3b8809c381d835b778ca03eccf66f7326f
-  data.tar.gz: 432767a471613ab986f3ca19c5c8c002673711bea0c71ec0c8048fbf4f8cc50e
+  metadata.gz: e21d3e55d80fdab110e763b80945554aaa37db10d9cd1d6420e1048992990442
+  data.tar.gz: abfb64188b9e2b04a223b7cbc839eec16b2f6307ecccf0a8c6b484ab55259231
 SHA512:
-  metadata.gz: f8a52e79a30aa30c85388b0d0d034fd49e35ce4896eef7ae0b51316aa7a3c1081ef3b9b564b1ec798be8af4af44d04b6bcefc226579b44138a98d1b463e23a65
-  data.tar.gz: 98be15b4608be4c35f0e9511cde6f824a2dfd97a292c92e62a24f2980750464a62952e4d84852c367df3258a7bc8036434162252e40993b089fa8fa72ca11dec
+  metadata.gz: 9a51c07ca44a5f137e8c2cea3e3249e607323ec9a58a661895d4541ccd573d234c72fae261632341e8e44077a8eca1f34e0748cad693961e4195e0c6b881089a
+  data.tar.gz: 64b13f1fa84d4292c6f414071dd64beed61acddcefff7c8aa952cc089e53bf519d8823e7ad9ebf98cfb779fb60855411c603c435b07a5c74caa07a9a243a3ac3

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+### 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
+  * Remove `Products#assign_variation_images_differentiator`
+
+* features
+  * Add `Products#assign_variation_attribute_as_differentiator`
+  
 ### v0.13.0.pre
 
 * features

data/Gemfile.lock

@@ -1,42 +1,42 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.13.0.pre)
+    beyond_api (0.16.1.pre)
       faraday (~> 0.15)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    dotenv (2.7.5)
-    faker (2.4.0)
-      i18n (~> 1.6.0)
-    faraday (0.17.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    faker (2.18.0)
+      i18n (>= 1.6, < 2)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
-    i18n (1.6.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
+    method_source (1.0.0)
     multipart-post (2.1.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    yard (0.9.20)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    yard (0.9.26)
 
 PLATFORMS
   ruby

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/resources/products.rb

@@ -253,28 +253,25 @@ module BeyondApi
     end
 
     #
-    # A +PUT+ request is used to assign a variation images differentiator for a variation product. The differentiator can be one of the variation attributes defined by the merchant, e.g. name, size, or color.
+    # A +POST+ request is used to assign a variation attribute as the variation images differentiator for a variation product.
     #
     # @beyond_api.scopes +prod:u+
     #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/30839efc-47f7-4d55-aa13-aac7532982b6/variation-images-differentiator' -i -X PUT \
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/f205294b-17dc-4f75-8b5e-5df72abb96df/variation-attributes/491fedf4-37a9-4bcf-98b8-cff2f82879b7/make-differentiator' -i -X POST \
     #       -H 'Content-Type: application/hal+json' \
     #       -H 'Accept: application/hal+json' \
-    #       -H 'Authorization: Bearer <Access token>' \
-    #       -d '{
-    #       "differentiator" : "size"
-    #   }'
+    #       -H 'Authorization: Bearer <Access token>'
     #
     # @param product_id [String] the product UUID
-    # @param differentiator [String] the differentiator
+    # @param variation_attribute_id [String] the variation attribute UUID
     #
     # @return [true]
     #
     # @example
-    #   session.products.assign_variation_images_differentiator("30839efc-47f7-4d55-aa13-aac7532982b6", "size")
+    #   session.products.assign_variation_images_differentiator("f205294b-17dc-4f75-8b5e-5df72abb96df", "491fedf4-37a9-4bcf-98b8-cff2f82879b7")
     #
-    def assign_variation_images_differentiator(product_id, differentiator)
-      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/variation-images-differentiator", differentiator: differentiator)
+    def assign_variation_attribute_as_differentiator(product_id, variation_attribute_id)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variation-attributes/#{variation_attribute_id}/make-differentiator")
 
       handle_response(response, status, respond_with_true: true)
     end

data/lib/beyond_api/resources/variations.rb

@@ -3,8 +3,8 @@
 require "beyond_api/utils"
 
 module BeyondApi
-  autoload :Images,       "beyond_api/resources/variations/images"
-  autoload :Availability, "beyond_api/resources/variations/availability"
+  autoload :VariationImages,       "beyond_api/resources/variations/images"
+  autoload :VariationAvailability, "beyond_api/resources/variations/availability"
 
   class Variations < Base
     include BeyondApi::VariationImages

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,17 @@ module BeyondApi
     end
 
     def handle_all_request(url, resource, params = {})
+
       if params[:paginated] == false
-        result = all_paginated(url, { page: 0, size: 1000 })
+        result = all_paginated(url, params.merge(page: 0, size: 1000))
 
         (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: 1000))[: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.13.0.pre".freeze
+  VERSION = "0.16.1.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.13.0.pre
+  version: 0.16.1.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,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
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API