beyond_api 0.5.1.pre → 0.6.0.pre

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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+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.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/a08ca814-52e9-4e00-82a2-3e9b012e5f9d/variations/4b58cdb7-4d3d-419a-ae27-8469f8b04276/images' -i -X POST \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "dataUri" : "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998",
+    #       "width" : 100,
+    #       "height" : 200
+    #   }'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "data_uri" => "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998",
+    #     "width" => 100,
+    #     "height" => 200
+    #   }
+    #   @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)
+  
+      handle_response(response, status)
+    end
+
+
+    #
+    # A +DELETE+ request is used to delete a variation image
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/8f5736f8-0a5f-4c08-bbac-3c524e2a6294/variations/86f3047c-ff29-4906-83c1-93e24ef88f3e/images/193d2ba4-3cf0-4326-a655-ef46e8a97c6a' -i -X DELETE \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @param image_id [String] the image UUID
+    #
+    # @return [true]
+    #
+    # @example
+    #   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}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve a single image of a variation.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/8665fc36-003e-4120-8a74-a9d6449644ae/variations/9163db42-92e7-418c-a3d8-651e7aaca569/images/86fc2691-5dfb-47e1-aae7-4bc2f658a80b' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @param image_id [String] the image UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @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}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the images of a variation.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/b4948e53-05af-4e0b-8877-28bc8811f73e/variations/50c5bf45-5dd6-4bae-babf-813c7cdca488/images' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param variation_id [String] the variation UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @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)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to upload an image to the image storage and assign the URL of the image to the variation. The body of the request must contain the content of the image.
+    #
+    #   $ curl --data-binary '@/home/epages/file.png' 'https://api-shop.beyondshop.cloud/api/products/4125b993-49fc-47c8-b9b3-76d8871e4e06/variations/d7fecf94-2e57-4122-8c94-a0acd840c111/images?fileName=file.png' -X POST \
+    #       -H 'Content-Type: image/png' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @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
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "type" => "VIMEO",
+    #     "source" => "https://vimeo.com/7265982"
+    #   }
+    #
+    #   session.variation.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
+      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 })
+
+      handle_response(response, status, respond_with_true: true)
+    end
+  end
+end

data/lib/beyond_api/resources/variations.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require "beyond_api/utils"
+require "beyond_api/resources/variations/images"
 require "beyond_api/resources/variations/availability"
 
 module BeyondApi
   class Variations < Base
+    include BeyondApi::VariationImages
     include BeyondApi::VariationAvailability
     include BeyondApi::Utils
 
@@ -23,7 +25,7 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   @products = session.variations.all(size: 100, page: 0)
+    #   @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)
@@ -47,7 +49,7 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   @product = session.variations.find("f461fb56-1984-4ade-bd4e-007c273cc923", "f6e5bb16-af2e-440f-acd3-a883ad3c1922")
+    #   @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}")
@@ -63,36 +65,36 @@ module BeyondApi
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>' \
     #       -d '{
-    #     "salesPrice" : {
-    #       "taxModel" : "NET",
-    #       "amount" : 8.7,
-    #       "currency" : "EUR"
-    #     },
-    #     "listPrice" : {
-    #       "taxModel" : "NET",
-    #       "amount" : 10.95,
-    #       "currency" : "EUR"
-    #     },
-    #     "manufacturerPrice" : {
-    #       "taxModel" : "NET",
-    #       "amount" : 99.95,
-    #       "currency" : "EUR"
-    #     },
-    #     "refPrice" : {
-    #       "refQuantity" : 1,
-    #       "unit" : "LITER",
-    #       "quantity" : 0.75,
-    #       "price" : {
+    #       "salesPrice" : {
     #         "taxModel" : "NET",
-    #         "amount" : 11.6,
+    #         "amount" : 8.7,
     #         "currency" : "EUR"
-    #       }
-    #     },
-    #     "sku" : "my-new-sku",
-    #     "productIdentifiers" : [ {
-    #       "type" : "EAN",
-    #       "value" : "9780134308135"
-    #     } ]
+    #       },
+    #       "listPrice" : {
+    #         "taxModel" : "NET",
+    #         "amount" : 10.95,
+    #         "currency" : "EUR"
+    #       },
+    #       "manufacturerPrice" : {
+    #         "taxModel" : "NET",
+    #         "amount" : 99.95,
+    #         "currency" : "EUR"
+    #       },
+    #       "refPrice" : {
+    #         "refQuantity" : 1,
+    #         "unit" : "LITER",
+    #         "quantity" : 0.75,
+    #         "price" : {
+    #           "taxModel" : "NET",
+    #           "amount" : 11.6,
+    #           "currency" : "EUR"
+    #         }
+    #       },
+    #       "sku" : "my-new-sku",
+    #       "productIdentifiers" : [ {
+    #         "type" : "EAN",
+    #         "value" : "9780134308135"
+    #       } ]
     #   }'
     #
     # @beyond_api.scopes +prod:u+
@@ -105,22 +107,22 @@ module BeyondApi
     #
     # @example
     #   body = {
-    #     "salesPrice": {
+    #     "sales_price" => {
     #       "taxModel": "NET",
     #       "amount": 8.7,
     #       "currency": "EUR"
     #     },
-    #     "listPrice": {
+    #     "list_price" => {
     #       "taxModel": "NET",
     #       "amount": 10.95,
     #       "currency": "EUR"
     #     },
-    #     "manufacturerPrice": {
+    #     "manufacturer_price" => {
     #       "taxModel": "NET",
     #       "amount": 99.95,
     #       "currency": "EUR"
     #     },
-    #     "refPrice": {
+    #     "ref_price" => {
     #       "refQuantity": 1,
     #       "unit": "LITER",
     #       "quantity": 0.75,
@@ -130,13 +132,14 @@ module BeyondApi
     #         "currency": "EUR"
     #       }
     #     },
-    #     "sku": "my-new-sku",
-    #     "productIdentifiers": [{
+    #     "sku" => "my-new-sku",
+    #     "product_identifiers" => [{
     #       "type": "EAN",
     #       "value": "9780134308135"
     #     }]
     #   }
-    #   @product = session.variations.update("f461fb56-1984-4ade-bd4e-007c273cc923", "f6e5bb16-af2e-440f-acd3-a883ad3c1922", body)
+    #
+    #   @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)

data/lib/beyond_api/resources/webhook_subscriptions.rb

@@ -110,7 +110,7 @@ module BeyondApi
     # @return true
     #
     # @example
-    #   webhook_subscriptions = session.webhook_subscriptions.delete("c6076a5a-a8ad-443f-b20b-8a1b268b069e")
+    #   session.webhook_subscriptions.delete("c6076a5a-a8ad-443f-b20b-8a1b268b069e")
     #
     def delete(webhook_subscription_id)
       response, status = BeyondApi::Request.delete(@session, "/webhook-subscriptions/#{webhook_subscription_id}")

data/lib/beyond_api/session.rb

@@ -5,12 +5,12 @@ require "beyond_api/resources/carts"
 require "beyond_api/resources/categories_view"
 require "beyond_api/resources/categories"
 require "beyond_api/resources/checkout_settings"
+require "beyond_api/resources/customers"
 require "beyond_api/resources/newsletter_target"
 require "beyond_api/resources/order_settings"
 require "beyond_api/resources/orders"
 require "beyond_api/resources/payment_methods"
 require "beyond_api/resources/product_attribute_definitions"
-require "beyond_api/resources/product_settings"
 require "beyond_api/resources/products_view"
 require "beyond_api/resources/products"
 require "beyond_api/resources/scopes"
@@ -50,6 +50,10 @@ module BeyondApi
       BeyondApi::CheckoutSettings.new(self)
     end
 
+    def customers
+      BeyondApi::Customers.new(self)
+    end
+
     def newsletter_target
       BeyondApi::NewsletterTarget.new(self)
     end
@@ -70,10 +74,6 @@ module BeyondApi
       BeyondApi::ProductAttributeDefinitions.new(self)
     end
 
-    def product_settings
-      BeyondApi::ProductSettings.new(self)
-    end
-
     def products_view
       BeyondApi::ProductsView.new(self)
     end

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.5.1.pre".freeze
+  VERSION = "0.6.0.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1.pre
+  version: 0.6.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,19 +140,21 @@ files:
 - lib/beyond_api/resources/categories.rb
 - lib/beyond_api/resources/categories_view.rb
 - lib/beyond_api/resources/checkout_settings.rb
+- lib/beyond_api/resources/customers.rb
 - lib/beyond_api/resources/newsletter_target.rb
 - lib/beyond_api/resources/order_settings.rb
 - lib/beyond_api/resources/orders.rb
 - lib/beyond_api/resources/payment_methods.rb
 - lib/beyond_api/resources/product_attribute_definitions.rb
-- lib/beyond_api/resources/product_settings.rb
 - lib/beyond_api/resources/products.rb
 - lib/beyond_api/resources/products/attachments.rb
 - lib/beyond_api/resources/products/availability.rb
+- lib/beyond_api/resources/products/cross_sells.rb
 - lib/beyond_api/resources/products/custom_attributes.rb
 - lib/beyond_api/resources/products/images.rb
 - lib/beyond_api/resources/products/searches.rb
 - lib/beyond_api/resources/products/variation_properties.rb
+- lib/beyond_api/resources/products/videos.rb
 - lib/beyond_api/resources/products_view.rb
 - lib/beyond_api/resources/scopes.rb
 - lib/beyond_api/resources/script_tags.rb
@@ -163,6 +165,7 @@ files:
 - lib/beyond_api/resources/users.rb
 - lib/beyond_api/resources/variations.rb
 - lib/beyond_api/resources/variations/availability.rb
+- lib/beyond_api/resources/variations/images.rb
 - lib/beyond_api/resources/webhook_subscriptions.rb
 - lib/beyond_api/session.rb
 - lib/beyond_api/utils.rb
@@ -187,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API

data/lib/beyond_api/resources/product_settings.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require "beyond_api/utils"
-
-module BeyondApi
-  class ProductSettings < Base
-    include BeyondApi::Utils
-
-    #
-    # A +GET+ request is used to retrieve the product settings.
-    #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-settings' -i -X GET \
-    #       -H 'Authorization: Bearer <Access token>'
-    #
-    # @beyond_api.scopes +prst:r+
-    #
-    # @return [OpenStruct]
-    #
-    # @example
-    #   @product_settings = session.product_settings.all
-    #
-    def all
-      response, status = BeyondApi::Request.get(@session, "/product_settings")
-
-      handle_response(response, status)
-    end
-  end
-end