beyond_api 0.11.0.pre → 0.14.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c3366e77c86e546074cbbc049e2161b231511deede234a92f96d315575ba45
-  data.tar.gz: f8e08acff7d5f80be7ffd249c83d6116abd86ddfb216e5c25e955deaffe439be
+  metadata.gz: 7a3232a181c9e98adb48dde14f44f3fbf5cbd148716a4aebfaedd8395f67f1c1
+  data.tar.gz: 3165b0482c207a611d5b1c1cfe0631a730c7d23774f0551c34c6e29bfb571134
 SHA512:
-  metadata.gz: f4f0be05bb0c55da87c1c650b86f112993ce8346f6178f3cf27d865d8415377924263d0b2ec648b8a1d8026c6a5a4250221a8dc68ba39bd154bfb43c0913649c
-  data.tar.gz: 8400df3f3b61240c0516fc4d86e386eea7e67f88ca56324e68989f731d415e77ab9907817b092dc59c87f79794d96d1e7a76960e4785ebf0237b384ca6ed64e7
+  metadata.gz: ba4db6852f6ea76b6b27a5def080dd54b1e2a9767a050cbddfb463eb538deac413b22923f065a1b4da37f828866142acc7173a0242a30ebf80b5e530d0606acf
+  data.tar.gz: 3f48e09d7f4a934218fefeff168c67a5aaa097dd502fb8080969748dc8ac612ec7f4444596e3b6f73cfc234b37741063103beace5cfa59375eb6b4a689b5e130

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+### v0.14.0.pre
+
+* deprecations
+  * Remove `Products#assign_variation_images_differentiator`
+
+* features
+  * Add `Products#assign_variation_attribute_as_differentiator`
+  
+### v0.13.0.pre
+
+* features
+  * Add payment method definitions methods
+    * `PaymentMethodDefinitions#all`
+    * `PaymentMethodDefinitions#create`
+    * `PaymentMethodDefinitions#delete`
+    * `PaymentMethodDefinitions#find`
+    * `PaymentMethodDefinitions#update`
+  * Add possibility to log request `headers` and `bodies`
+
+### v0.12.1.pre
+
+* bug-fixes
+  * Fix camelize function for hashes containing arrays
+
+### v0.12.0.pre
+
+* features
+  * Add locations methods
+    * `Locations#all`
+    * `Locations#create`
+    * `Locations#delete`
+    * `Locations#find`
+    * `Locations#update`
+
+* enhancements
+  * Use `autoload` instead of `require`
+
+### v0.11.1.pre
+
+* bug-fixes
+  * Use `BeyondApi::Error` for authentication errors
+
 ### v0.11.0.pre
 
 * enhancements

data/Gemfile.lock

@@ -1,42 +1,42 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.11.0.pre)
+    beyond_api (0.14.0.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.8)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    faker (2.17.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.0)
+      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.rb

@@ -1,23 +1,18 @@
 require "beyond_api/version"
 
-require "beyond_api/connection"
-require "beyond_api/request"
-require "beyond_api/session"
-require "beyond_api/error"
+require "logger"
 
 require "beyond_api/ext"
 require "beyond_api/utils"
 
-require "logger"
-
 module BeyondApi
-  def self.logger
-    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-  end
+  autoload :Connection, "beyond_api/connection"
+  autoload :Error,      "beyond_api/error"
+  autoload :Logger,     "beyond_api/logger"
+  autoload :Request,    "beyond_api/request"
+  autoload :Session,    "beyond_api/session"
 
-  def self.logger=(logger)
-    @@logger = logger
-  end
+  extend BeyondApi::Logger
 
   class << self
     attr_accessor :configuration
@@ -31,7 +26,8 @@ module BeyondApi
 
   class Configuration
     attr_accessor :client_id, :client_secret, :open_timeout, :timeout,  :remove_response_links,
-                  :remove_response_key_underscores, :object_struct_responses, :raise_error_requests
+                  :remove_response_key_underscores, :object_struct_responses, :raise_error_requests,
+                  :log_headers, :log_bodies, :log_level
 
     def initialize
       @client_id = nil
@@ -42,6 +38,10 @@ module BeyondApi
       @remove_response_key_underscores = false
       @object_struct_responses = false
       @raise_error_requests = false
+
+      @log_level = :info
+      @log_headers = false
+      @log_bodies = false
     end
   end
 end

data/lib/beyond_api/connection.rb

@@ -4,10 +4,15 @@ require 'faraday'
 
 module BeyondApi
   class Connection
+    LOGGER = ::BeyondApi.logger
+    LOGGER.level = Kernel.const_get("::Logger::#{BeyondApi.configuration.log_level.to_s.upcase}")
+
     def self.default
       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.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
+                                            bodies: BeyondApi.configuration.log_bodies }
         faraday.headers['Accept'] = 'application/json'
         faraday.headers['Content-Type'] = 'application/json'
         faraday.request(:multipart)
@@ -20,6 +25,8 @@ module BeyondApi
       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.response :logger, LOGGER, { headers: BeyondApi.configuration.log_headers,
+                                            bodies: BeyondApi.configuration.log_bodies }
         faraday.headers['Accept'] = 'application/json'
         faraday.adapter(:net_http)
         faraday.basic_auth(BeyondApi.configuration.client_id,

data/lib/beyond_api/error.rb

@@ -2,16 +2,18 @@
 
 module BeyondApi
   class Error < StandardError
-    attr_reader :error_id, :details, :trace_id, :full_message, :status_code
+    attr_reader :error_id, :details, :trace_id, :full_message, :status_code, :error, :error_description
 
     def initialize(data, status_code = nil)
-      @error_id     = data['errorId']
-      @details      = data['details']
-      @trace_id     = data['traceId']
-      @full_message = data
-      @status_code  = status_code
+      @error_id          = data['errorId']
+      @details           = data['details']
+      @trace_id          = data['traceId']
+      @error             = data['error']
+      @error_description = data['error_description']
+      @full_message      = data
+      @status_code       = status_code
 
-      super(data['message'])
+      super(data['message'] || data['error_description'])
     end
   end
 end

data/lib/beyond_api/ext.rb

@@ -4,7 +4,14 @@ class Hash
   def deep_transform_keys(&block)
     result = {}
     each do |key, value|
-      result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
+      result[yield(key)] = case value
+      when Hash
+        value.deep_transform_keys(&block)
+      when Array
+        value.camelize_keys
+      else
+        value
+      end
     end
     result
   end

data/lib/beyond_api/logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BeyondApi
+  module Logger
+    def logger
+      @@logger ||= defined?(Rails) ? ::Rails.logger : ::Logger.new($stdout)
+    end
+
+    def logger=(logger)
+      @@logger = logger
+    end
+  end
+end

data/lib/beyond_api/resources/payment_method_definitions.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class PaymentMethodDefinitions < Base
+    include BeyondApi::Utils
+
+    #
+    # A +POST+ request is used to create a payment method definition on system level.
+    #
+    #   $ curl 'https://system.beyondshop.cloud/api/payment-method-definitions' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #           "name": "credit-card",
+    #           "referralUriTemplate": "https://example.com/merchants",
+    #           "statusUriTemplate": "https://example.com/merchants/{shopId}/status",
+    #           "disconnectUriTemplate": "https://example.com/merchants/{shopId}/disconnect",
+    #           "createPaymentUriTemplate": "https://example.com/payments",
+    #           "capturePaymentUriTemplate": "https://example.com/payments/{paymentId}/capture",
+    #           "refundPaymentUriTemplate": "https://example.com/payments/{paymentId}/refund",
+    #           "sandbox": "true",
+    #             "workflow": "PAYMENT_ON_BUY",
+    #             "captureWorkflow": "CAPTURE_ON_ORDER",
+    #             "refund": "NO_REFUND",
+    #             "logos": [{
+    #               "setName" : "official",
+    #               "variant" : "STOREFRONT",
+    #               "uri" : "https://example.com/static/storefront.png"
+    #             }],
+    #           "officialName": {"de-DE" : "Ermögliche deinen Kunden, mit Kreditkarte zu bezahlen.",
+    #           "en-US" : "Allow your customers to pay by credit card."
+    #           },
+    #             "officialDescription": {
+    #               "de-DE" : "Ermögliche deinen Kunden, mit Kreditkarte zu bezahlen.",
+    #               "en-US" : "Allow your customers to pay by credit card."
+    #             },
+    #             "defaultName": {
+    #               "de-DE" : "Kreditkarte",
+    #               "en-US" : "Credit card"
+    #             },
+    #             "defaultDescription": {"de-DE" : "Bezahlen Sie mit Kreditkarte.","en-US" : "Pay by credit card."}}'
+    #
+    # @beyond_api.scopes +paym:m+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_method_definitions = session.payment_method_definitions.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/payment-method-definitions", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all payment method definitions on system level.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-method-definitions' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +paym:m+
+    #
+    # @option params [Boolean] :paginated
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_method_definitions = session.payment_method_definitions.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      handle_all_request("/payment-method-definitions", :payment_method_definitions, params)
+    end
+
+    #
+    # A +GET+ request is used to deactivate a payment method.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-method-definitions/credit-card' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +pymt:u+
+    #
+    # @param payment_method_definition_id [String] the payment method definition UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_method_definition = session.payment_methods.find("credit-card")
+    #
+    def find(payment_method_definition_id)
+      response, status = BeyondApi::Request.get(@session, "/payment-method-definitions/#{payment_method_definition_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to update a payment method definition on system level.
+    #
+    #   $ curl 'https://system.beyondshop.cloud/api/payment-method-definitions/credit-card' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #           "name": "credit-card-updated",
+    #           "referralUriTemplate": "https://example.com/merchants",
+    #           "statusUriTemplate": "https://example.com/merchants/{shopId}/status",
+    #           "disconnectUriTemplate": "https://example.com/merchants/{shopId}/disconnect",
+    #           "createPaymentUriTemplate": "https://example.com/payments",
+    #           "capturePaymentUriTemplate": "https://example.com/payments/{paymentId}/capture",
+    #           "refundPaymentUriTemplate": "https://example.com/payments/{paymentId}/refund",
+    #           "workflow": "PAYMENT_ON_SELECTION",
+    #           "captureWorkflow": "CAPTURE_ON_DEMAND",
+    #           "refund": "NO_REFUND",
+    #           "logos": [{
+    #             "setName" : "official",
+    #             "variant" : "STOREFRONT",
+    #             "uri" : "https://example.com/static/storefront.png"
+    #           }],
+    #           "officialName": {"de-DE" : "Ermögliche deinen Kunden, mit Kreditkarte zu bezahlen.",
+    #           "en-US" : "Allow your customers to pay by credit card."
+    #           },
+    #           "officialDescription": {
+    #             "de-DE" : "Ermögliche deinen Kunden, mit Kreditkarte zu bezahlen.",
+    #             "en-US" : "Allow your customers to pay by credit card."
+    #           },
+    #           "defaultName": {
+    #             "de-DE" : "Kreditkarte",
+    #             "en-US" : "Credit card"
+    #           },
+    #           "defaultDescription": {"de-DE" : "Bezahlen Sie mit Kreditkarte.","en-US" : "Pay by credit card."}}'
+    #
+    # @beyond_api.scopes +paym:m+
+    #
+    # @param payment_method_definition_id [String] the payment method definition UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @payment_method_definition = session.payment_method_definitions.update("credit_card", body)
+    #
+    def update(payment_method_definition_id, body)
+      response, status = BeyondApi::Request.put(@session, "/payment-method-definitions/#{payment_method_definition_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a payment method definition on system level.
+    #
+    #   $ curl 'https://system.beyondshop.cloud/api/payment-method-definitions/credit-card' -i -X DELETE \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @return true
+    #
+    # @example
+    #   session.payment_method_definitions.delete("credit-card")
+    #
+    def delete(payment_method_definition_id)
+      response, status = BeyondApi::Request.delete(@session, "/payment-method-definitions/#{payment_method_definition_id}", body)
+
+      handle_response(response, status, respond_with_true: true)
+    end
+  end
+end

data/lib/beyond_api/resources/products.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 require "beyond_api/utils"
-require "beyond_api/resources/products/attachments"
-require "beyond_api/resources/products/availability"
-require "beyond_api/resources/products/cross_sells"
-require "beyond_api/resources/products/custom_attributes"
-require "beyond_api/resources/products/images"
-require "beyond_api/resources/products/searches"
-require "beyond_api/resources/products/variation_properties"
-require "beyond_api/resources/products/videos"
 
 module BeyondApi
+  autoload :ProductAttachments,         "beyond_api/resources/products/attachments"
+  autoload :ProductAvailability,        "beyond_api/resources/products/availability"
+  autoload :ProductCrossSells,          "beyond_api/resources/products/cross_sells"
+  autoload :ProductCustomAttributes,    "beyond_api/resources/products/custom_attributes"
+  autoload :ProductImages,              "beyond_api/resources/products/images"
+  autoload :ProductSearches,            "beyond_api/resources/products/searches"
+  autoload :ProductVariationProperties, "beyond_api/resources/products/variation_properties"
+  autoload :ProductVideos,              "beyond_api/resources/products/videos"
+
   class Products < Base
     include BeyondApi::ProductAttachments
     include BeyondApi::ProductAvailability
@@ -252,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