beyond_api 0.18.0.pre → 0.18.2.pre

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

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ProductImages
-
     #
     # A +POST+ request is used to create an image and add it to a product.
     #
@@ -187,16 +186,20 @@ module BeyondApi
     #
     def upload_image(product_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
+                     when ".png"
+                       "image/png"
+                     when ".jpg", ".jpeg"
+                       "image/jpeg"
+                     when ".gif"
+                       "image/gif"
+                     end
       image_binary = File.binread(image_path)
 
-      response, status = BeyondApi::Request.upload(@session, "/products/#{product_id}/images", image_binary, content_type, { file_name: image_name })
+      response, status = BeyondApi::Request.upload(@session,
+                                                   "/products/#{product_id}/images",
+                                                   image_binary,
+                                                   content_type,
+                                                   { file_name: image_name })
 
       handle_response(response, status, respond_with_true: true)
     end

data/lib/beyond_api/resources/products/searches.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ProductSearches
-
     #
     # A +GET+ request is used to search for a product by SKU.
     #
@@ -44,7 +43,8 @@ module BeyondApi
     #   @tags = session.product.search_tags_starting_by("aw")
     #
     def search_tags_starting_by(starts_with, params = {})
-      response, status = BeyondApi::Request.get(@session, "/products/search/tags", params.merge(starts_with: starts_with))
+      response, status = BeyondApi::Request.get(@session, "/products/search/tags",
+                                                params.merge(starts_with: starts_with))
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/products/variation_properties.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ProductVariationProperties
-
     #
     # A +PATCH+ request is used to update the variation properties of a variation product.
     #

data/lib/beyond_api/resources/products/videos.rb

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ProductVideos
-
     #
     # A +POST+ request is used to create a video and add it to a product.
     #
@@ -137,8 +136,10 @@ module BeyondApi
     # @example
     #   @videos = session.products.videos("04c6ad65-465d-405e-a428-f73349104b65", size: 100, page: 0)
     #
-    def videos(product_id, params =  {})
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/videos", params)
+    def videos(product_id, params = {})
+      response, status = BeyondApi::Request.get(@session,
+                                                "/products/#{product_id}/videos",
+                                                params)
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/products.rb

@@ -43,7 +43,9 @@ module BeyondApi
     #   @products = session.products.all(size: 100, page: 0)
     #
     def all(params = {})
-      handle_all_request("/products", :products, params)
+      path = "/products"
+
+      handle_all_request(path, :products, params)
     end
 
     #
@@ -166,7 +168,11 @@ module BeyondApi
     #   @product = session.products.create(body)
     #
     def create(body)
-      response, status = BeyondApi::Request.post(@session, "/products", body)
+      path = "/products"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
 
       handle_response(response, status)
     end
@@ -188,7 +194,10 @@ module BeyondApi
     #   session.products.delete("c06c61af-f99a-4698-90fa-8c3199ca732f")
     #
     def delete(product_id)
-      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}")
+      path = "/products/#{product_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -211,7 +220,10 @@ module BeyondApi
     #   @product = session.products.find("75ebcb57-aefb-4963-8225-060c528e070d")
     #
     def find(product_id)
-      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}")
+      path = "/products/#{product_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -247,7 +259,11 @@ module BeyondApi
     #   @product = session.products.update("b69e3f47-03b8-40d2-843c-ae89a3d9bcdd", body)
     #
     def update(product_id, body)
-      response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}", body)
+      path = "/products/#{product_id}"
+
+      response, status = BeyondApi::Request.patch(@session,
+                                                  path,
+                                                  body)
 
       handle_response(response, status)
     end
@@ -271,13 +287,16 @@ module BeyondApi
     #   session.products.assign_variation_images_differentiator("f205294b-17dc-4f75-8b5e-5df72abb96df", "491fedf4-37a9-4bcf-98b8-cff2f82879b7")
     #
     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")
+      path = "/products/#{product_id}/variation-attributes/#{variation_attribute_id}/make-differentiator"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status, respond_with_true: true)
     end
 
-    alias_method :create_variation, :create
-    alias_method :find_variation,   :find
-    alias_method :update_variation, :update
+    alias create_variation create
+    alias find_variation find
+    alias update_variation update
   end
 end

data/lib/beyond_api/resources/products_view.rb

@@ -23,7 +23,9 @@ module BeyondApi
     #   @products = session.products_view.all(page: 0, size: 100)
     #
     def all(params = {})
-      handle_all_request("/product-view/products", :products, params)
+      path = "/product-view/products"
+
+      handle_all_request(path, :products, params)
     end
 
     #
@@ -39,7 +41,10 @@ module BeyondApi
     #   @tags = session.products_view.available_tags
     #
     def available_tags
-      response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-available-tags")
+      path = "/product-view/products/search/find-available-tags"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -60,7 +65,10 @@ module BeyondApi
     #   @product = session.products_view.find("f75f8fb2-5a48-4d94-aad6-3d3692c06472")
     #
     def find(product_id)
-      response, status = BeyondApi::Request.get(@session, "/product-view/products/#{product_id}")
+      path = "/product-view/products/#{product_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -82,7 +90,11 @@ module BeyondApi
     #   @products = session.products_view.search_by_tag("number0", {page: 0, size: 100})
     #
     def search_by_tag(tag, params = {})
-      response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-by-tags", params.merge(tag: tag))
+      path = "/product-view/products/search/find-by-tags"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path,
+                                                params.merge(tag: tag))
 
       handle_response(response, status)
     end
@@ -104,7 +116,11 @@ module BeyondApi
     #   @products = session.products_view.search_by_term("search snippet", {page: 0, size: 100})
     #
     def search_by_term(term, params = {})
-      response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-by-term", params.merge(query: term))
+      path = "/product-view/products/search/find-by-term"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path,
+                                                params.merge(query: term))
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/script_tags.rb

@@ -22,7 +22,9 @@ module BeyondApi
     #   @script_tags = session.script_tags.all(size: 20, page: 0)
     #
     def all(params = {})
-      handle_all_request("/script-tags", :script_tags, params)
+      path = "/script-tags"
+
+      handle_all_request(path, :script_tags, params)
     end
 
     #
@@ -39,7 +41,10 @@ module BeyondApi
     #   @script_tag = session.script_tags.find("df170ab1-13ae-4955-8b51-2478246acf59")
     #
     def find(script_tag_id)
-      response, status = BeyondApi::Request.get(@session, "/script-tags/#{script_tag_id}")
+      path = "/script-tags/#{script_tag_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -65,7 +70,11 @@ module BeyondApi
     #   @script_tag = session.script_tags.create("https://example.org/js/fancy-script.js")
     #
     def create(script_tag_url)
-      response, status = BeyondApi::Request.post(@session, "/script-tags", { script_url: script_tag_url })
+      path = "/script-tags"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 { script_url: script_tag_url })
 
       handle_response(response, status)
     end
@@ -86,7 +95,10 @@ module BeyondApi
     #   session.script_tags.delete("4a9f7776-d74d-4311-8ddb-121bd5407520")
     #
     def delete(script_tag_id)
-      response, status = BeyondApi::Request.delete(@session, "/script-tags/#{script_tag_id}")
+      path = "/script-tags/#{script_tag_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -113,7 +125,11 @@ module BeyondApi
     #   @script_tag = session.script_tags.create("https://example.org/scripts/someOtherScript.js")
     #
     def update(script_tag_id, script_tag_url)
-      response, status = BeyondApi::Request.put(@session, "/script-tags/#{script_tag_id}", { script_url: script_tag_url })
+      path = "/script-tags/#{script_tag_id}"
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path,
+                                                { script_url: script_tag_url })
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/shipping_zones.rb

@@ -24,7 +24,9 @@ module BeyondApi
     #   @shipping_zones = session.shipping_zones.all(size: 20, page: 0)
     #
     def all(params = {})
-      handle_all_request("/shipping-zones", :shipping_zones, params)
+      path = "/shipping-zones"
+
+      handle_all_request(path, :shipping_zones, params)
     end
 
     #
@@ -52,7 +54,11 @@ module BeyondApi
     #   @shipping_zone = session.shipping_zones.create(body)
     #
     def create(body)
-      response, status = BeyondApi::Request.post(@session, "/shipping-zones", body)
+      path = "/shipping-zones"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
 
       handle_response(response, status)
     end
@@ -105,7 +111,11 @@ module BeyondApi
     #   @shipping_zone = session.shipping_zones.create_shipping_method("905e981c-1489-45af-9138-0a7dc1f0b085", body)
     #
     def create_shipping_method(shipping_zone_id, body)
-      response, status = BeyondApi::Request.post(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods", body)
+      path = "/shipping-zones/#{shipping_zone_id}/shipping-methods"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
 
       handle_response(response, status)
     end
@@ -126,7 +136,10 @@ module BeyondApi
     #   session.shipping_zones.delete("c871b402-b6d9-4c6d-b76c-440f61175805")
     #
     def delete(shipping_zone_id)
-      response, status = BeyondApi::Request.delete(@session, "/shipping-zones/#{shipping_zone_id}")
+      path = "/shipping-zones/#{shipping_zone_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -148,7 +161,10 @@ module BeyondApi
     #   session.shipping_zones.delete_shipping_method("61c14c3c-ce26-4524-9713-f2ede7ff22fa", "d2eee203-a1c6-4035-8e7a-74bb77cfde47")
     #
     def delete_shipping_method(shipping_zone_id, shipping_method_id)
-      response, status = BeyondApi::Request.delete(@session, "/shipping-zones/#{shipping_zone_id}/shipping_methods/#{shipping_method_id}")
+      path = "/shipping-zones/#{shipping_zone_id}/shipping_methods/#{shipping_method_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -170,7 +186,10 @@ module BeyondApi
     #   @shipping_zone = session.shipping_zones.find("27914098-c1f6-46aa-9e78-c7ac873e25b3")
     #
     def find(shipping_zone_id)
-      response, status = BeyondApi::Request.get(@session, "/shipping-zones/#{shipping_zone_id}")
+      path = "/shipping-zones/#{shipping_zone_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -187,7 +206,10 @@ module BeyondApi
     #   @serviceable_countries = session.shipping_zones.find_serviceable_countries
     #
     def find_serviceable_countries
-      response, status = BeyondApi::Request.get(@session, "/shipping-zones/search/find-all-serviceable-countries")
+      path = "/shipping-zones/search/find-all-serviceable-countries"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -209,7 +231,10 @@ module BeyondApi
     #   @shipping_method = session.shipping_zones.shipping_method("61780dd6-0150-4fcf-953c-d10c52bab4ab", "13bd1fc9-706c-4774-923a-484a41aaab89")
     #
     def shipping_method(shipping_zone_id, shipping_method_id)
-      response, status = BeyondApi::Request.get(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}")
+      path = "/shipping-zones/#{shipping_zone_id}/shipping-methods/#{shipping_method_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -233,7 +258,11 @@ module BeyondApi
     #   @shipping_methods = session.shipping_zones.shipping_methods("8cc24465-3573-4eca-8323-b076bb724080", { size: 20, page: 0 })
     #
     def shipping_methods(shipping_zone_id, params = {})
-      response, status = BeyondApi::Request.get(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods", params)
+      path = "/shipping-zones/#{shipping_zone_id}/shipping-methods"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path,
+                                                params)
 
       handle_response(response, status)
     end
@@ -260,8 +289,13 @@ module BeyondApi
     #   session.shipping_zones.sort(shipping_zone_ids)
     #
     def sort(shipping_zone_ids)
+      path = "/shipping-zones"
+
       body = shipping_zone_ids.map { |id| "#{session.api_url}/shipping-zones/#{id}" }
-      response, status = BeyondApi::Request.put(@session, "/shipping-zones", body)
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path,
+                                                body)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -284,7 +318,10 @@ module BeyondApi
     #   session.shipping_zones.sort_shipping_methods(shipping_zone_id)
     #
     def sort_shipping_methods(shipping_zone_id)
-      response, status = BeyondApi::Request.put(@session, "/shipping-zones/#{shipping_zone_id}/shipping-methods")
+      path = "/shipping-zones/#{shipping_zone_id}/shipping-methods"
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -315,7 +352,11 @@ module BeyondApi
     #   @shipping_zone = session.shipping_zones.update("727b3cbf-01b1-442a-bd5c-94c51901f090", body)
     #
     def update(shipping_zone_id, body)
-      response, status = BeyondApi::Request.put(@session, "/shipping-zones/#{shipping_zone_id}", body)
+      path = "/shipping-zones/#{shipping_zone_id}"
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path,
+                                                body)
 
       handle_response(response, status)
     end

data/lib/beyond_api/resources/shop.rb

@@ -29,7 +29,10 @@ module BeyondApi
     #   session.shop.current
     #
     def current
-      response, status = BeyondApi::Request.get(@session, "/shop")
+      path = "/shop"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -81,7 +84,11 @@ module BeyondApi
     #   session.shop.update(body)
     #
     def update(body)
-      response, status = BeyondApi::Request.patch(@session, "/shop",  body)
+      path = "/shop"
+
+      response, status = BeyondApi::Request.patch(@session,
+                                                  path,
+                                                  body)
 
       handle_response(response, status)
     end

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

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ShopAddress
-
     #
     # A +GET+ request is used to retrieve the details of a shop’s address.
     #

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

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ShopAttributes
-
     #
     # A +GET+ request is used to retrieve a particular shop attribute by its name.
     #

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

@@ -4,7 +4,6 @@ require "beyond_api/utils"
 
 module BeyondApi
   module ShopImages
-
     #
     # A +POST+ request is used to create a shop image.
     #
@@ -138,16 +137,20 @@ module BeyondApi
     #
     def upload_image(image_path, image_name, label)
       content_type = case File.extname(image_path)
-        when ".png"
-          "image/png"
-        when ".jpg", ".jpeg"
-          "image/jpeg"
-        when ".gif"
-          "image/gif"
-        end
+                     when ".png"
+                       "image/png"
+                     when ".jpg", ".jpeg"
+                       "image/jpeg"
+                     when ".gif"
+                       "image/gif"
+                     end
       image_binary = File.binread(image_path)
 
-      response, status = BeyondApi::Request.upload(@session, "/shop/images", image_binary, content_type, { file_name: image_name, label: label })
+      response, status = BeyondApi::Request.upload(@session,
+                                                   "/shop/images",
+                                                   image_binary,
+                                                   content_type,
+                                                   { file_name: image_name, label: label })
 
       handle_response(response, status, respond_with_true: true)
     end

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,8 +13,8 @@ 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 authorization_code(code)
@@ -29,15 +29,16 @@ module BeyondApi
       handle_token_call("client_credentials")
     end
 
-    alias_method :refresh, :refresh_token
-    alias_method :create, :authorization_code
+    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(@session.api_url + "/oauth/token",
+      response, status = BeyondApi::Request.token(path,
                                                   params)
 
       handle_response(response, status)