beyond_api 0.12.1.pre → 0.13.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49750d84cced44e6e76b41d1202138d51410cb51afc3df6ba47bbaf599afd34f
-  data.tar.gz: c6ccb9edbc9d0042f0c8e220b66afa8f2d559cc3c1a6e0208989da6281e0900c
+  metadata.gz: be322cd30437303093e481de07cd8e3b8809c381d835b778ca03eccf66f7326f
+  data.tar.gz: 432767a471613ab986f3ca19c5c8c002673711bea0c71ec0c8048fbf4f8cc50e
 SHA512:
-  metadata.gz: d4cfcc2e6e8e0aa7e400fe6190eda04a23810896339cc2a8dbde720f32996c1f49d3d7d24fa54ebb0cb012ce07a60e6802b44af6e214e9d086a046f64e84f53b
-  data.tar.gz: 41b39da7d2ccfef54b4802b56f419d09620c9c18d4f26a81268db15a94ec8a60daae280cc933a4c475799b3e574eda73eea69fae9d675f6112dcc168868db379
+  metadata.gz: f8a52e79a30aa30c85388b0d0d034fd49e35ce4896eef7ae0b51316aa7a3c1081ef3b9b564b1ec798be8af4af44d04b6bcefc226579b44138a98d1b463e23a65
+  data.tar.gz: 98be15b4608be4c35f0e9511cde6f824a2dfd97a292c92e62a24f2980750464a62952e4d84852c367df3258a7bc8036434162252e40993b089fa8fa72ca11dec

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 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
@@ -14,7 +25,7 @@
     * `Locations#update`
 
 * enhancements
-  * Use `autoload` instead of `require` 
+  * Use `autoload` instead of `require`
 
 ### v0.11.1.pre
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.12.1.pre)
+    beyond_api (0.13.0.pre)
       faraday (~> 0.15)
 
 GEM

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/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/session.rb

@@ -10,6 +10,7 @@ module BeyondApi
   autoload :NewsletterTarget,            "beyond_api/resources/newsletter_target"
   autoload :OrderSettings,               "beyond_api/resources/order_settings"
   autoload :Orders,                      "beyond_api/resources/orders"
+  autoload :PaymentMethodDefinitions,    "beyond_api/resources/payment_method_definitions"
   autoload :PaymentMethods,              "beyond_api/resources/payment_methods"
   autoload :ProductAttributeDefinitions, "beyond_api/resources/product_attribute_definitions"
   autoload :ProductsView,                "beyond_api/resources/products_view"
@@ -65,6 +66,10 @@ module BeyondApi
       BeyondApi::Orders.new(self)
     end
 
+    def payment_method_definitions
+      BeyondApi::PaymentMethodDefinitions.new(self)
+    end
+
     def payment_methods
       BeyondApi::PaymentMethods.new(self)
     end

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.12.1.pre".freeze
+  VERSION = "0.13.0.pre".freeze
 end

data/lib/generators/templates/beyond_api_initializer.rb

@@ -12,6 +12,21 @@ BeyondApi.setup do |config|
   # Configure the request timeout in seconds. Default is 5 seconds.
   # config.timeout = 5.seconds
 
+  # ==> Log configuration
+
+  # Configure the log level. Must be one of :debug, :info, :warn, :error,
+  # :fatal or :unknown. Default is :info.
+  #
+  # config.log_level = :info
+
+  # Configure is response headers should be logged. Default is false.
+  #
+  # config.log_headers = false
+
+  # Configure is response bodies should be logged. Default is false.
+  #
+  # config.log_bodies = false
+
   # ==> Response configuration
   # Configure if :_links should be removed from response. Default is false and
   # :_links are gonna be part of the response.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.12.1.pre
+  version: 0.13.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - lib/beyond_api/connection.rb
 - lib/beyond_api/error.rb
 - lib/beyond_api/ext.rb
+- lib/beyond_api/logger.rb
 - lib/beyond_api/request.rb
 - lib/beyond_api/resources/base.rb
 - lib/beyond_api/resources/carts.rb
@@ -145,6 +146,7 @@ files:
 - 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_method_definitions.rb
 - lib/beyond_api/resources/payment_methods.rb
 - lib/beyond_api/resources/product_attribute_definitions.rb
 - lib/beyond_api/resources/products.rb
@@ -195,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API