beyond_api 0.17.0.pre → 0.20.0.pre

data/lib/beyond_api/resources/shops/legals.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ShopLegals
-
     #
     # A +GET+ request is used to retrieve a specific part of the legal content information.
     #
@@ -20,7 +19,8 @@ module BeyondApi
     #   @legal_content = session.shop.legal_content("right-of-withdrawal")
     #
     def legal_content(legal_content_type)
-      response, status = BeyondApi::Request.get(@session, "/legal-content/#{legal_content_type}")
+      response, status = BeyondApi::Request.get(@session,
+                                                "/legal-content/#{legal_content_type}")
 
       handle_response(response, status)
     end
@@ -41,7 +41,9 @@ module BeyondApi
     #   @legal_content = session.shop.legal_contents(size: 5, page: 1)
     #
     def legal_contents(params = {})
-      response, status = BeyondApi::Request.get(@session, "/legal-content", params)
+      response, status = BeyondApi::Request.get(@session,
+                                                "/legal-content",
+                                                params)
 
       handle_response(response, status)
     end
@@ -60,12 +62,13 @@ module BeyondApi
     #   @legal_details = session.shop.legal_details
     #
     def legal_details
-      response, status = BeyondApi::Request.get(@session, "/shop/legal")
+      response, status = BeyondApi::Request.get(@session,
+                                                "/shop/legal")
 
       handle_response(response, status)
     end
 
-#
+    #
     # A +PUT+ request is used to update the content of a specific part of the legal content information. Changes on the properties type and mandatory will be ignored.
     #
     #   $ curl 'https://api-shop.beyondshop.cloud/api/legal-content/legal-notice' -i -X PUT \
@@ -86,7 +89,9 @@ module BeyondApi
     #   session.shop.update_legal_content(body)
     #
     def update_legal_content(body)
-      response, status = BeyondApi::Request.put(@session, "/legal-content/legal-notice")
+      response, status = BeyondApi::Request.put(@session,
+                                                "/legal-content/legal-notice",
+                                                body)
 
       handle_response(response, status)
     end
@@ -116,7 +121,9 @@ module BeyondApi
     #   session.shop.update_legal_details(body)
     #
     def update_legal_details(body)
-      response, status = BeyondApi::Request.patch(@session, "/shop/legal")
+      response, status = BeyondApi::Request.patch(@session,
+                                                  "/shop/legal",
+                                                  body)
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/shops/locations.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ShopLocations
-
     #
     # A +GET+ request is used to retrieve a list of all locations for the current shop.
     #

data/lib/beyond_api/resources/signers.rb

@@ -19,7 +19,10 @@ module BeyondApi
     #   @signers = session.signers.all
     #
     def all
-      response, status = BeyondApi::Request.get(@session, "/signers")
+      path = "/signers"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -37,7 +40,10 @@ module BeyondApi
     #   @signer = session.signers.create
     #
     def create
-      response, status = BeyondApi::Request.post(@session, "/signers")
+      path = "/signers"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status)
     end
@@ -55,7 +61,10 @@ module BeyondApi
     #   session.signers.delete("6bb72afd-340e-439a-9990-eef2e0883e1e")
     #
     def delete(signer_id)
-      response, status = BeyondApi::Request.delete(@session, "/signers/#{signer_id}")
+      path = "/signers/#{signer_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end

data/lib/beyond_api/resources/token.rb

@@ -13,35 +13,37 @@ module BeyondApi
     def initialize(session)
       @session = session
 
-      raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondApi::Session
-      raise InvalidSessionError.new("Session api_url cannot be nil") if session.api_url.nil?
+      raise InvalidSessionError, "Invalid session" unless session.is_a? BeyondApi::Session
+      raise InvalidSessionError, "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
-      response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
-                                                  grant_type: "client_credentials")
-
-      handle_response(response, status)
+      handle_token_call("client_credentials")
     end
 
+    alias refresh refresh_token
+    alias create authorization_code
+
     private
 
+    def handle_token_call(grant_type, params = {})
+      path = "#{@session.api_url}/oauth/token"
+      params.merge!(grant_type: grant_type)
+
+      response, status = BeyondApi::Request.token(path,
+                                                  params)
+
+      handle_response(response, status)
+    end
+
     def handle_response(response, status)
       if status.between?(200, 299)
         @session.access_token = response["access_token"]

data/lib/beyond_api/resources/users.rb

@@ -25,7 +25,11 @@ module BeyondApi
     #   session.users.add_roles(user_id, body)
     #
     def add_roles(user_id, body)
-      response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/roles", body)
+      path = "/users/#{user_id}/roles"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -50,7 +54,9 @@ module BeyondApi
     #   @users = session.users.all(size: 100, page: 0)
     #
     def all(params = {})
-      handle_all_request("/users", :users, params)
+      path = "/users"
+
+      handle_all_request(path, :users, params)
     end
 
     #
@@ -77,7 +83,12 @@ module BeyondApi
     #   session.users.change_password(user_id, current_password, new_password)
     #
     def change_password(user_id, current_password, new_password)
-      response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/change-password", current_password: current_password, new_password: new_password)
+      path = "/users/#{user_id}/change-password"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 current_password: current_password,
+                                                 new_password: new_password)
 
       handle_response(response, status)
     end
@@ -104,7 +115,12 @@ module BeyondApi
     #   session.users.change_username(user_id, new_username, current_password)
     #
     def change_username(user_id, new_username, current_password)
-      response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/change-username", new_username: new_username, current_password: current_password)
+      path = "/users/#{user_id}/change-username"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 new_username: new_username,
+                                                 current_password: current_password)
 
       handle_response(response, status)
     end
@@ -137,7 +153,11 @@ module BeyondApi
     #   @user = session.users.create(body)
     #
     def create(body)
-      response, status = BeyondApi::Request.post(@session, "/users", body)
+      path = "/users"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
 
       handle_response(response, status)
     end
@@ -158,7 +178,10 @@ module BeyondApi
     #   session.users.enable_support_access
     #
     def enable_support_access
-      response, status = BeyondApi::Request.post(@session, "/users/support")
+      path = "/users/support"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -179,7 +202,10 @@ module BeyondApi
     #   session.users.disable_support_access
     #
     def disable_support_access
-      response, status = BeyondApi::Request.delete(@session, "/users/support")
+      path = "/users/support"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -202,7 +228,10 @@ module BeyondApi
     #   @user = session.users.find("e4b528ce-bb9e-4cc5-95e1-7dadfa4cf0f3")
     #
     def find(user_id)
-      response, status = BeyondApi::Request.get(@session, "/users/#{user_id}")
+      path = "/users/#{user_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -223,7 +252,10 @@ module BeyondApi
     #   @roles = session.users.roles("0d4bd0a5-94dc-498e-b6a6-305c619bb20d")
     #
     def roles(user_id)
-      response, status = BeyondApi::Request.get(@session, "/users/#{user_id}/roles")
+      path = "/users/#{user_id}/roles"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -245,7 +277,11 @@ module BeyondApi
     #   @user = session.users.search_by_username(username)
     #
     def search_by_username(username)
-      response, status = BeyondApi::Request.get(@session, "/users/search/find-by-username", username: username)
+      path = "/users/search/find-by-username"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path,
+                                                username: username)
 
       handle_response(response, status)
     end
@@ -275,7 +311,12 @@ module BeyondApi
     #   session.users.send_email_address_change(user_id, new_email, current_password, locale)
     #
     def send_email_address_change(user_id, new_email, current_password, locale)
-      response, status = BeyondApi::Request.post(@session, "/users/#{user_id}/change-email-request", { new_email: new_email, current_password: current_password }, { locale: locale })
+      path = "/users/#{user_id}/change-email-request"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 { new_email: new_email, current_password: current_password },
+                                                 { locale: locale })
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -301,7 +342,12 @@ module BeyondApi
     #   session.users.send_reset_password_email(email, locale)
     #
     def send_reset_password_email(email, locale)
-      response, status = BeyondApi::Request.post(@session, "/users/reset-password-request", { email: email }, { locale: locale })
+      path = "/users/reset-password-request"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 { email: email },
+                                                 { locale: locale })
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -325,7 +371,11 @@ module BeyondApi
     #   session.users.set_roles(user_id, body)
     #
     def set_roles(user_id, body)
-      response, status = BeyondApi::Request.put(@session, "/users/#{user_id}/roles", body)
+      path = "/users/#{user_id}/roles"
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path,
+                                                body)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -345,7 +395,10 @@ module BeyondApi
     #   session.users.support_access
     #
     def support_access
-      response, status = BeyondApi::Request.get(@session, "/users/support")
+      path = "/users/support"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -370,7 +423,12 @@ module BeyondApi
     #   session.users.verify_password(password)
     #
     def verify_password(password, user_role)
-      response, status = BeyondApi::Request.post(@session, "/users/verify-password", password: password, user_role: user_role)
+      path = "/users/verify-password"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 password: password,
+                                                 user_role: user_role)
 
       handle_response(response, status, respond_with_true: true)
     end

data/lib/beyond_api/resources/variations/availability.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module VariationAvailability
-
     #
     # A +POST+ request is used to adjust the available stock of a variation.
     #
@@ -26,7 +25,11 @@ module BeyondApi
     #   @availability = session.variations.adjust_stock_level(product_id, variation_id, { relativeAmount => -1 })
     #
     def adjust_stock_level(product_id, variation_id, relative_amount)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/adjust-available-stock", relative_amount: relative_amount)
+      path = "/products/#{product_id}/variations/#{variation_id}/availability/adjust-available-stock"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 relative_amount: relative_amount)
 
       handle_response(response, status)
     end
@@ -50,7 +53,10 @@ module BeyondApi
     #   @availability = session.variations.availability("fb22d408-00dc-47e3-ae58-e35769bdb428", "13b28149-975a-4f47-ad54-bdc4ca4a07ec")
     #
     def availability(product_id, variation_id)
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}/availability")
+      path = "/products/#{product_id}/variations/#{variation_id}/availability"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -74,7 +80,10 @@ module BeyondApi
     #   @availability = session.variations.enable_purchaability("1e3a92b-6f3b-4415-bd8f-c9c8921a5a73", "13b28149-975a-4f47-ad54-bdc4ca4a07ec")
     #
     def enable_purchasability(product_id, variation_id)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/enable-purchasability")
+      path = "/products/#{product_id}/variations/#{variation_id}/availability/enable-purchasability"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status)
     end
@@ -97,7 +106,10 @@ module BeyondApi
     #   @availability = session.variations.disable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73", "13b28149-975a-4f47-ad54-bdc4ca4a07ec")
     #
     def disable_purchasability(product_id, variation_id)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/disable-purchasability")
+      path = "/products/#{product_id}/variations/#{variation_id}/availability/disable-purchasability"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/variations/images.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module VariationImages
-
     #
     # A +POST+ request is used to create an image and add it to a variation. The URL of the image will be assigned to the variation. The image URL has to be provided in body of the request.
     #
@@ -35,12 +34,15 @@ module BeyondApi
     #   @image = session.variations.add_image("a08ca814-52e9-4e00-82a2-3e9b012e5f9d", "4b58cdb7-4d3d-419a-ae27-8469f8b04276", body)
     #
     def add_image(product_id, variation_id, body)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/images", body)
-  
+      path = "/products/#{product_id}/variations/#{variation_id}/images"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
+
       handle_response(response, status)
     end
 
-
     #
     # A +DELETE+ request is used to delete a variation image
     #
@@ -61,7 +63,10 @@ module BeyondApi
     #   session.variations.delete_image("8f5736f8-0a5f-4c08-bbac-3c524e2a6294", "86f3047c-ff29-4906-83c1-93e24ef88f3e", "193d2ba4-3cf0-4326-a655-ef46e8a97c6a")
     #
     def delete_image(product_id, variation_id, image_id)
-      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/variations/#{variation_id}/images/#{image_id}")
+      path = "/products/#{product_id}/variations/#{variation_id}/images/#{image_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -86,7 +91,10 @@ module BeyondApi
     #   @image = session.variations.image("8665fc36-003e-4120-8a74-a9d6449644ae", "a9163db42-92e7-418c-a3d8-651e7aaca569", "86fc2691-5dfb-47e1-aae7-4bc2f658a80b")
     #
     def image(product_id, image_id)
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}/images/#{image_id}")
+      path = "/products/#{product_id}/variations/#{variation_id}/images/#{image_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -112,7 +120,11 @@ module BeyondApi
     #   @images = session.variations.images("b4948e53-05af-4e0b-8877-28bc8811f73e", "50c5bf45-5dd6-4bae-babf-813c7cdca488", size: 100, page: 0)
     #
     def images(product_id, variation_id, params = {})
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}/images", params)
+      path = "/products/#{product_id}/variations/#{variation_id}/images"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path,
+                                                params)
 
       handle_response(response, status)
     end
@@ -128,8 +140,8 @@ module BeyondApi
     #
     # @param product_id [String] the product UUID
     # @param variation_id [String] the variation UUID
-    # @param image_path [String] the image path
-    # @param image_name [String] the image name
+    # @param images_path [Array] the images path
+    # @param images_name [Array] the images name
     #
     # @return [OpenStruct]
     #
@@ -142,19 +154,49 @@ module BeyondApi
     #   session.variations.upload_image("4125b993-49fc-47c8-b9b3-76d8871e4e06", "d7fecf94-2e57-4122-8c94-a0acd840c111", "/home/epages/file.png", "file.png")
     #
     def upload_image(product_id, variation_id, image_path, image_name)
-      content_type = case File.extname(image_path)
-        when ".png"
-          "image/png"
-        when ".jpg", ".jpeg"
-          "image/jpeg"
-        when ".gif"
-          "image/gif"
-        end
+      content_type = file_content_type(image_path)
+      path = "/products/#{product_id}/variations/#{variation_id}/images"
+
       image_binary = File.binread(image_path)
 
-      response, status = BeyondApi::Request.upload(@session, "/products/#{product_id}/variations/#{variation_id}/images", image_binary, content_type, { file_name: image_name })
+      response, status = BeyondApi::Request.upload(@session,
+                                                   path,
+                                                   image_binary,
+                                                   content_type,
+                                                   { file_name: image_name })
 
       handle_response(response, status, respond_with_true: true)
     end
+
+    #
+    # A +POST+ request is used to upload up to 10 images to the image storage and assign the URL of the images to up to 30 variations. The body of the request must contain the content of the images.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/4125b993-49fc-47c8-b9b3-76d8871e4e06/variations/images?fileName=file.png&fileName=file2.png&variation=ca53ae26-e7c6-44a4-8070-9fca08cc87ed&variation=ab63fa3a-c2ac-4074-aaa3-b547217b042d' -i -X POST \
+    #       -H 'Content-Type: multipart/form-data' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -F 'image=@/home/epages/file.png' \
+    #       -F 'image=@/home/epages/file2.png'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @param images_path [String] the image path
+    # @param images_name [String] the image name
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.variations.upload_multiple_images("4125b993-49fc-47c8-b9b3-76d8871e4e06", "d7fecf94-2e57-4122-8c94-a0acd840c111",
+    #                                             ["/home/epages/file.png", "/home/epages/file2.png"], ["file.png", "file2.png"])
+    #
+    def upload_multiple_images(product_id, variation_id, images_path, images_name)
+      response, status = BeyondApi::Request.upload_by_form(@session,
+                                                           "/products/#{product_id}/variations/#{variation_id}/images",
+                                                           images_path,
+                                                           file_name: images_name)
+
+      handle_response(response, status)
+    end
   end
 end

data/lib/beyond_api/resources/variations.rb

@@ -29,7 +29,11 @@ module BeyondApi
     #   @variations = session.variations.all("dc1b5caf-51ea-4fcd-b1ba-0c5128e91d17", { size: 100, page: 0 })
     #
     def all(product_id, params = {})
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations", params)
+      path = "/products/#{product_id}/variations"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path,
+                                                params)
 
       handle_response(response, status)
     end
@@ -53,7 +57,10 @@ module BeyondApi
     #   @variation = session.variations.find("5f6e426e-c8d9-48ba-9b37-9a8eb6381373", "f6e5bb16-af2e-440f-acd3-a883ad3c1922")
     #
     def find(product_id, variation_id)
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variations/#{variation_id}")
+      path = "/products/#{product_id}/variations/#{variation_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -143,7 +150,11 @@ module BeyondApi
     #   @variation = session.variations.update("7cf4b5b1-b141-4869-96d1-4eaee8bf7563", "9f93fdd0-2d21-4ea9-b9d7-e9a53edb091b", body)
     #
     def update(product_id, variation_id, body)
-      response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}/variations/#{variation_id}", body)
+      path = "/products/#{product_id}/variations/#{variation_id}"
+
+      response, status = BeyondApi::Request.patch(@session,
+                                                  path,
+                                                  body)
 
       handle_response(response, status)
     end