beyond_api 0.18.2.pre → 0.19.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a98b8f593cfbaa19ab6632cf4abac105bc8b897ebf7b2b34bdbd821dc7eab98e
-  data.tar.gz: 9f4148cc7bb416d661090223d2073a9cffb760f94a153465bb09ea3a1bf3350e
+  metadata.gz: e2d0989b9c2efdb165c8411d97aac823941fc1eae61e2dac30352746191fa146
+  data.tar.gz: 449c75efb650ec8b65f9686c5993b2d6ab643002f1732e9fb8c28c24ce574a38
 SHA512:
-  metadata.gz: 40964af10851bc145293f58da2fd8fc30b3924a0900584e469137bb8b251ca5e452bfd2d2fc6c9998b17084a8f7990f6d40a60cc333c5555824fe5ed7455a43b
-  data.tar.gz: 96ee1ee2b444d309027c87b0a886b2f80d3f8a71c9446bfbc5bbf0d91869dce8a2120ffe6a3424929bc20342bc43148bf553c02b8d0fdf84cc6516745d603c1f
+  metadata.gz: 5e3aabaf8efe9424ecca4a4df173d8ecb370ff73e60144c2bdf1306f889b1dc3bb62ffe0f12307b8c12ce9c52b8f74e86d43362d69f4f405274ede477bf9fd69
+  data.tar.gz: beea89efdd34dd846ded24f57f0e64f8ec0202146efcdd239f7b06b2ff99b2cd2a0a30fb7ef250afd3509cf3e538a990fedc9ae7250852c0dc4411bc1b805cc4

data/.env.template

@@ -0,0 +1,3 @@
+CLIENT_ID=""
+CLIENT_SECRET=""
+SHOP_URL=""

data/.rubocop.yml

@@ -3,6 +3,8 @@ require:
   - rubocop-rspec
 
 AllCops:
+  Exclude:
+    - spec/**/*.rb
   NewCops: enable
 
 Style/StringLiterals:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### v0.19.0.pre
+
+* features
+  * Upload multiple images for products and variations
+
 ### v0.18.2.pre
 
 * bug-fixes

data/Gemfile

@@ -6,3 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "pry"
+
+group :test do
+  gem "factory_bot"
+end

data/Gemfile.lock

@@ -1,27 +1,53 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.18.2.pre)
-      faraday (~> 0.15)
+    beyond_api (0.19.0.pre)
+      faraday (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faker (2.18.0)
+    factory_bot (6.2.0)
+      activesupport (>= 5.0.0)
+    faker (2.19.0)
       i18n (>= 1.6, < 2)
-    faraday (0.17.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    i18n (1.8.10)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
+    minitest (5.14.4)
     multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.21.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -42,26 +68,31 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
     rubocop-ordered_methods (0.9)
       rubocop (>= 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
-    yard (0.9.26)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -70,6 +101,7 @@ DEPENDENCIES
   beyond_api!
   bundler (~> 2.0)
   dotenv (~> 2.7)
+  factory_bot
   faker (~> 2.2)
   pry
   rake (~> 10.0)
@@ -80,4 +112,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.26
+   2.2.31

data/beyond_api.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rspec",           "~> 2.4"
   spec.add_development_dependency "yard",                    "~> 0.9"
 
-  spec.add_dependency "faraday", "~> 0.15"
+  spec.add_dependency "faraday", "~> 1.8.0"
 end

data/lib/beyond_api/connection.rb

@@ -32,8 +32,16 @@ module BeyondApi
         end
         faraday.headers['Accept'] = 'application/json'
         faraday.adapter(:net_http)
-        faraday.basic_auth(BeyondApi.configuration.client_id,
-                           BeyondApi.configuration.client_secret)
+        faraday.request :basic_auth, BeyondApi.configuration.client_id, BeyondApi.configuration.client_secret
+      end
+    end
+
+    def self.multipart
+      Faraday.new(ssl: { verify: true }) do |faraday|
+        faraday.options[:open_timeout] = BeyondApi.configuration.open_timeout.to_i
+        faraday.options[:timeout] = BeyondApi.configuration.timeout.to_i
+        faraday.request :multipart, { flat_encode: true }
+        faraday.adapter Faraday.default_adapter
       end
     end
   end

data/lib/beyond_api/request.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "json"
+require "faraday"
+require "beyond_api/utils"
 
 module BeyondApi
   class Request
@@ -51,5 +53,20 @@ module BeyondApi
 
       [response.body.blank? ? nil : JSON.parse(response.body), response.status]
     end
+
+    def self.upload_by_form(session, path, files, params)
+      response = BeyondApi::Connection.multipart.post do |request|
+        request.url(session.api_url + path)
+        request.headers["Authorization"] = "Bearer #{session.access_token}" unless session.access_token.nil?
+        request.options[:params_encoder] = Faraday::FlatParamsEncoder
+        request.params = params.to_h.camelize_keys
+        files = files.split unless files.is_a? Array
+        upload_files = files.map{ |file| Faraday::FilePart.new(File.open(file),
+                                                               BeyondApi::Utils.file_content_type(file)) }
+        request.body = { image: upload_files }
+      end
+
+      [response.body.blank? ? nil : JSON.parse(response.body), response.status]
+    end
   end
 end

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

@@ -185,14 +185,7 @@ module BeyondApi
     #   session.products.upload_image("4125b993-49fc-47c8-b9b3-76d8871e4e06", "/home/epages/file.png", "file.png")
     #
     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
+      content_type = file_content_type(image_path)
       image_binary = File.binread(image_path)
 
       response, status = BeyondApi::Request.upload(@session,
@@ -203,5 +196,34 @@ module BeyondApi
 
       handle_response(response, status, respond_with_true: true)
     end
+
+    # A +POST+ request is used to upload up to 10 images and add them to a product. 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/images?fileName=file.png&fileName=file2.png' -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 images_path [Array] the images path
+    # @param images_name [Array] the images name
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.upload_multiple_images("4125b993-49fc-47c8-b9b3-76d8871e4e06",
+    #                                           ["/home/epages/file.png", "/home/epages/file2.png"], ["file.png", "file2.png"])
+    #
+    def upload_multiple_images(product_id, images_path, images_name)
+      response, status = BeyondApi::Request.upload_by_form(@session,
+                                                           "/products/#{product_id}/images",
+                                                           images_path,
+                                                           file_name: images_name)
+
+      handle_response(response, status)
+    end
   end
 end

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

@@ -140,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]
     #
@@ -154,15 +154,9 @@ 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 = file_content_type(image_path)
       path = "/products/#{product_id}/variations/#{variation_id}/images"
-      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,
@@ -173,5 +167,36 @@ module BeyondApi
 
       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/utils.rb

@@ -4,6 +4,17 @@ module BeyondApi
   module Utils
     extend self
 
+    def file_content_type(file_path)
+      case File.extname(file_path)
+      when ".png"
+        "image/png"
+      when ".jpg", ".jpeg"
+        "image/jpeg"
+      when ".gif"
+        "image/gif"
+      end
+    end
+
     def handle_all_request(url, resource, params = {})
       paginated_size = BeyondApi.configuration.all_pagination_size
 
@@ -58,11 +69,11 @@ module BeyondApi
 
     def to_object_struct(data)
       if data.is_a? Hash
-        return OpenStruct.new(data.map { |key, val| [key, to_object_struct(val)] }.to_h)
+        OpenStruct.new(data.map { |key, val| [key, to_object_struct(val)] }.to_h)
       elsif data.is_a? Array
-        return data.map { |o| to_object_struct(o) }
+        data.map { |o| to_object_struct(o) }
       else
-        return data
+        data
       end
     end
 
@@ -76,8 +87,8 @@ module BeyondApi
 
     def transform(thing)
       case thing
-      when Hash; sanitize_response(thing)
-      when Array; thing.map { |v| transform(v) }
+      when Hash then sanitize_response(thing)
+      when Array then thing.map { |v| transform(v) }
       else; thing
       end
     end

data/lib/beyond_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BeyondApi
-  VERSION = "0.18.2.pre"
+  VERSION = "0.19.0.pre"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.18.2.pre
+  version: 0.19.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
 - Kathia Salazar
 - German San Emeterio
 - Kenneth Gallego
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,20 +145,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
-description:
-email:
+        version: 1.8.0
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.template"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -227,7 +228,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
@@ -242,8 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.26
-signing_key:
+rubygems_version: 3.2.16
+signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API
 test_files: []