beyond_api 0.11.1.pre → 0.15.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e68b42556a0a1c1038d1c234fba9910fc847c0250ed3c2426091996ffe5c703
-  data.tar.gz: d2507537ae0cfee8e216322dc5a74d66f73b31c7a4279f4b043e8f67ff43e04e
+  metadata.gz: 438360193bc7064cbd6591e9dc088aeb81f162aac26bff0ac1f891f45b5b9993
+  data.tar.gz: 57f358035cc7aa0ee5ee0795eecb3f887b5f534d470342348d70c6e6c6f1ac48
 SHA512:
-  metadata.gz: bebea8aaf4fb068465618d308c0fb7439272853f49b6e964acc8e5c685057541a182d13619da7f431c1fbc9a3aac5f5310ff0f279633ea51cbd07df80dc2aebf
-  data.tar.gz: 5a237fd7ffdde5902f8a198dd80f60a3e668ca80440d5929981ecd7f2154ca397cd11f3017e6572d56ef65394157e6df591bfc9794ba311376455c37e1af780c
+  metadata.gz: 284505c3dc6af706bd3851fe62c885ce2aec79c76a997b2c07f20a23d5745c3a7d16c337177de9579b25c0fe9440b2b9e04f5cfdd2ec377362effb2a98df7b0b
+  data.tar.gz: eb9168f92793a47673646fcb8ac36bd6c5103596620a1003a143242a938ceba156429fe3760f41672c705a23f367ad2be40d6607c0f112ecdf16be1ead96a0b1

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+### v0.15.0.pre
+
+* features
+  * Add pickup options methods
+    * `PickupOptions#all`
+    * `PickupOptions#create`
+
+### 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

data/Gemfile.lock

@@ -1,42 +1,42 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.11.1.pre)
+    beyond_api (0.15.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.9)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    faker (2.18.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.1)
+      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/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/pickup_options.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class PickupOptions < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to list all pickup options of the shop in a paged way.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @option params [Boolean] :paginated
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @pickup_options = session.pickup_options.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      handle_all_request("/pickup-options", :pickup_options, params)
+    end
+
+    #
+    # A +POST+ request is used to create a pickup option.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/pickup-options' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "My little Cornershop - St.Ives",
+    #       "description" : "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.",
+    #       "taxClass" : "REGULAR",
+    #       "freePickupValue" : {
+    #         "currency" : "EUR",
+    #         "amount" : 50
+    #       },
+    #       "fixedPrice" : {
+    #         "taxModel" : "GROSS",
+    #         "currency" : "EUR",
+    #         "amount" : 1
+    #       },
+    #       "phoneNumberRequired" : true,
+    #       "locationId" : "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #   }'
+    #
+    # @beyond_api.scopes +shpz:c+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     name: "My little Cornershop - St.Ives",
+    #     description: "We will send you an email when your items are ready for pickup. Please bring a copy of your order confirmation.",
+    #     tax_class: "REGULAR",
+    #     free_pickup_value: {
+    #       currency: "EUR",
+    #       amount: 50
+    #     },
+    #     fixed_price: {
+    #       tax_model: "GROSS",
+    #       currency: "EUR",
+    #       amount: 1
+    #      },
+    #      phone_number_required: true,
+    #      location_id: "cb554eb6-2768-4491-afd2-6bcd0aec0937"
+    #   }
+    #
+    #   @pickup_option = session.pickup_options.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/pickup-options", body)
+
+      handle_response(response, status)
+    end
+  end
+end