checkout_sdk 1.0.0.beta.0 → 1.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f69890364a27b8824317c2604c3dcc1182ceab269ba237589c7db3529d16a1
-  data.tar.gz: fd4d4cdbf183476ae79c4fbf58f517102eb23d3795af8a8d2be5e1e76a44ab2c
+  metadata.gz: a0d976eb888dbeda40a8ece1c8701d3ba7c1cec555699c5953b425c092a3d9b9
+  data.tar.gz: 44ae834bdb42d042f082030b87137261be0a48188d33f8b6c1864e96ea215787
 SHA512:
-  metadata.gz: 627d42ca4a6d47e0336bfbf0df46dca6c703898c17923fbb0356974e0833c3a099e7701ffab5caee7eae83966469849931ca3183b14f52f1afcca0cd1e46047c
-  data.tar.gz: ad0c24f31adf78f719a4af8f5e6e889274b08987d038e8b470aa8c1881114242b21462bd1b237f217f79f5c30d4020d94cdb6470037aad1354d5e19035346d8c
+  metadata.gz: f6a38b94c47462ec0837b57be1ac13c4c916acf8eb2360126f9ef4b3a93667fe281ceb0945209ff51d6d72edde1ca1e4596166a75044cdeb3f5a6c5808d48042
+  data.tar.gz: 270e249ce92268f2346f4da01b3a79e83148ff871a8584844db05fdf60ef786fc6051c22f58d94d3d314e800760d5207d7a43b223b307c261638cb3f20bd28af

data/.rubocop.yml

@@ -19,6 +19,9 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 10
 
+Metrics/ClassLength:
+  Max: 110
+
 Style/Documentation:
   Enabled: false
 

data/lib/checkout_sdk/api_client.rb

@@ -128,8 +128,12 @@ module CheckoutSdk
     end
 
     def parse_response(response)
-      # TODO: include http metadata response
-      JSON.parse(response.body, object_class: OpenStruct) if !response.body.nil? && response.body != ''
+      metadata = CheckoutUtils.map_to_http_metadata(response)
+      body = (JSON.parse(response.body, object_class: OpenStruct) if !response.body.nil? && response.body != '')
+      body = OpenStruct.new if body.nil?
+      body = OpenStruct.new(items: body) if body.is_a? Array
+      body.metadata = metadata if body.is_a? OpenStruct
+      body
     end
   end
 end

data/lib/checkout_sdk/apm/apm.rb

@@ -4,7 +4,6 @@
 require 'checkout_sdk/apm/previous/klarna/credit_session_request'
 require 'checkout_sdk/apm/previous/klarna/klarna'
 require 'checkout_sdk/apm/previous/klarna/klarna_product'
-require 'checkout_sdk/apm/previous/klarna/klarna_shipping_info'
 require 'checkout_sdk/apm/previous/klarna/order_capture_request'
 
 require 'checkout_sdk/apm/previous/klarna/klarna_client'

data/lib/checkout_sdk/apm/previous/klarna/credit_session_request.rb

@@ -3,27 +3,25 @@
 module CheckoutSdk
   module Previous
     module Apm
-      module Klarna
-        # @!attribute purchase_country
-        #   @return [String] {CheckoutSdk::Common::Country}
-        # @!attribute currency
-        #   @return [String] {CheckoutSdk::Common::Currency}
-        # @!attribute locale
-        #   @return [String]
-        # @!attribute amount
-        #   @return [Integer]
-        # @!attribute tax_amount
-        #   @return [Integer]
-        # @!attribute products
-        #   @return [Array(KlarnaProduct)]
-        class CreditSessionRequest
-          attr_accessor :purchase_country,
-                        :currency,
-                        :locale,
-                        :amount,
-                        :tax_amount,
-                        :products
-        end
+      # @!attribute purchase_country
+      #   @return [String] {CheckoutSdk::Common::Country}
+      # @!attribute currency
+      #   @return [String] {CheckoutSdk::Common::Currency}
+      # @!attribute locale
+      #   @return [String]
+      # @!attribute amount
+      #   @return [Integer]
+      # @!attribute tax_amount
+      #   @return [Integer]
+      # @!attribute products
+      #   @return [Array(KlarnaProduct)]
+      class CreditSessionRequest
+        attr_accessor :purchase_country,
+                      :currency,
+                      :locale,
+                      :amount,
+                      :tax_amount,
+                      :products
       end
     end
   end

data/lib/checkout_sdk/apm/previous/klarna/klarna.rb

@@ -3,21 +3,19 @@
 module CheckoutSdk
   module Previous
     module Apm
-      module Klarna
-        # @!attribute description
-        #   @return [String]
-        # @!attribute products
-        #   @return [Array(KlarnaProduct)]
-        # @!attribute shipping_info
-        #   @return [KlarnaShippingInfo]
-        # @!attribute shipping_delay
-        #   @return [Integer]
-        class Klarna
-          attr_accessor :description,
-                        :products,
-                        :shipping_info,
-                        :shipping_delay
-        end
+      # @!attribute description
+      #   @return [String]
+      # @!attribute products
+      #   @return [Array(KlarnaProduct)]
+      # @!attribute shipping_info
+      #   @return [CheckoutSdk::Common::ShippingInfo]
+      # @!attribute shipping_delay
+      #   @return [Integer]
+      class Klarna
+        attr_accessor :description,
+                      :products,
+                      :shipping_info,
+                      :shipping_delay
       end
     end
   end

data/lib/checkout_sdk/apm/previous/klarna/klarna_client.rb

@@ -3,51 +3,49 @@
 module CheckoutSdk
   module Previous
     module Apm
-      module Klarna
-        class KlarnaClient < Client
-          CREDIT_SESSIONS = 'credit-sessions'
-          ORDERS = 'orders'
-          CAPTURES = 'captures'
-          VOIDS = 'voids'
-          private_constant :CREDIT_SESSIONS, :ORDERS, :CAPTURES, :VOIDS
-
-          # @param [ApiClient] api_client
-          # @param [CheckoutConfiguration] configuration
-          def initialize(api_client, configuration)
-            super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
-          end
-
-          # @param credit_session_request [CreditSessionRequest]
-          def create_credit_session(credit_session_request)
-            api_client.invoke_post(build_path(base_url, CREDIT_SESSIONS), sdk_authorization, credit_session_request)
-          end
-
-          # @param session_id [String]
-          def get_credit_session(session_id)
-            api_client.invoke_get(build_path(base_url, CREDIT_SESSIONS, session_id), sdk_authorization)
-          end
-
-          # @param payment_id [String]
-          # @param order_capture_request [OrderCaptureRequest]
-          def capture_payment(payment_id, order_capture_request)
-            api_client.invoke_post(build_path(base_url, ORDERS, payment_id, CAPTURES),
-                                   sdk_authorization,
-                                   order_capture_request)
-          end
-
-          # @param payment_id [String]
-          # @param void_request [CheckoutSdk::Payments::VoidRequest]
-          def void_payment(payment_id, void_request)
-            api_client.invoke_post(build_path(base_url, ORDERS, payment_id, VOIDS),
-                                   sdk_authorization,
-                                   void_request)
-          end
-
-          private
-
-          def base_url
-            sandbox? ? 'klarna-external' : 'klarna'
-          end
+      class KlarnaClient < Client
+        CREDIT_SESSIONS = 'credit-sessions'
+        ORDERS = 'orders'
+        CAPTURES = 'captures'
+        VOIDS = 'voids'
+        private_constant :CREDIT_SESSIONS, :ORDERS, :CAPTURES, :VOIDS
+
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+        end
+
+        # @param credit_session_request [CreditSessionRequest]
+        def create_credit_session(credit_session_request)
+          api_client.invoke_post(build_path(base_url, CREDIT_SESSIONS), sdk_authorization, credit_session_request)
+        end
+
+        # @param session_id [String]
+        def get_credit_session(session_id)
+          api_client.invoke_get(build_path(base_url, CREDIT_SESSIONS, session_id), sdk_authorization)
+        end
+
+        # @param payment_id [String]
+        # @param order_capture_request [OrderCaptureRequest]
+        def capture_payment(payment_id, order_capture_request)
+          api_client.invoke_post(build_path(base_url, ORDERS, payment_id, CAPTURES),
+                                 sdk_authorization,
+                                 order_capture_request)
+        end
+
+        # @param payment_id [String]
+        # @param void_request [CheckoutSdk::Payments::VoidRequest]
+        def void_payment(payment_id, void_request)
+          api_client.invoke_post(build_path(base_url, ORDERS, payment_id, VOIDS),
+                                 sdk_authorization,
+                                 void_request)
+        end
+
+        private
+
+        def base_url
+          sandbox? ? 'klarna-external' : 'klarna'
         end
       end
     end

data/lib/checkout_sdk/apm/previous/klarna/klarna_product.rb

@@ -3,27 +3,25 @@
 module CheckoutSdk
   module Previous
     module Apm
-      module Klarna
-        # @!attribute name
-        #   @return [String]
-        # @!attribute quantity
-        #   @return [Integer]
-        # @!attribute unit_price
-        #   @return [Integer]
-        # @!attribute tax_rate
-        #   @return [Integer]
-        # @!attribute total_amount
-        #   @return [Integer]
-        # @!attribute total_tax_amount
-        #   @return [Integer]
-        class KlarnaProduct
-          attr_accessor :name,
-                        :quantity,
-                        :unit_price,
-                        :tax_rate,
-                        :total_amount,
-                        :total_tax_amount
-        end
+      # @!attribute name
+      #   @return [String]
+      # @!attribute quantity
+      #   @return [Integer]
+      # @!attribute unit_price
+      #   @return [Integer]
+      # @!attribute tax_rate
+      #   @return [Integer]
+      # @!attribute total_amount
+      #   @return [Integer]
+      # @!attribute total_tax_amount
+      #   @return [Integer]
+      class KlarnaProduct
+        attr_accessor :name,
+                      :quantity,
+                      :unit_price,
+                      :tax_rate,
+                      :total_amount,
+                      :total_tax_amount
       end
     end
   end

data/lib/checkout_sdk/apm/previous/klarna/order_capture_request.rb

@@ -3,33 +3,31 @@
 module CheckoutSdk
   module Previous
     module Apm
-      module Klarna
-        # @!attribute type
-        #   @return [CheckoutSdk::Common::PaymentSourceType]
-        # @!attribute amount
-        #   @return [Integer]
-        # @!attribute reference
-        #   @return [String]
-        # @!attribute metadata
-        #   @return [Hash(String=>Object)]
-        # @!attribute klarna
-        #   @return [Klarna]
-        # @!attribute shipping_info
-        #   @return [KlarnaShippingInfo]
-        # @!attribute shipping_delay
-        #   @return [Integer]
-        class OrderCaptureRequest
-          attr_reader :type
-          attr_accessor :amount,
-                        :reference,
-                        :metadata,
-                        :klarna,
-                        :shipping_info,
-                        :shipping_delay
+      # @!attribute type
+      #   @return [CheckoutSdk::Common::PaymentSourceType]
+      # @!attribute amount
+      #   @return [Integer]
+      # @!attribute reference
+      #   @return [String]
+      # @!attribute metadata
+      #   @return [Hash(String=>Object)]
+      # @!attribute klarna
+      #   @return [Klarna]
+      # @!attribute shipping_info
+      #   @return [CheckoutSdk::Common::ShippingInfo]
+      # @!attribute shipping_delay
+      #   @return [Integer]
+      class OrderCaptureRequest
+        attr_reader :type
+        attr_accessor :amount,
+                      :reference,
+                      :metadata,
+                      :klarna,
+                      :shipping_info,
+                      :shipping_delay
 
-          def initialize
-            @type = CheckoutSdk::Common::PaymentSourceType::KLARNA
-          end
+        def initialize
+          @type = CheckoutSdk::Common::PaymentSourceType::KLARNA
         end
       end
     end

data/lib/checkout_sdk/apm/previous/sepa/sepa_client.rb

@@ -3,38 +3,36 @@
 module CheckoutSdk
   module Previous
     module Apm
-      module Sepa
-        class SepaClient < Client
-          SEPA_MANDATES = 'sepa/mandates'
-          PPRO = 'ppro'
-          CANCEL = 'cancel'
-          private_constant :SEPA_MANDATES, :PPRO, :CANCEL
+      class SepaClient < Client
+        SEPA_MANDATES = 'sepa/mandates'
+        PPRO = 'ppro'
+        CANCEL = 'cancel'
+        private_constant :SEPA_MANDATES, :PPRO, :CANCEL
 
-          # @param [ApiClient] api_client
-          # @param [CheckoutConfiguration] configuration
-          def initialize(api_client, configuration)
-            super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
-          end
+        # @param [ApiClient] api_client
+        # @param [CheckoutConfiguration] configuration
+        def initialize(api_client, configuration)
+          super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+        end
 
-          # @param mandate_id [String]
-          def get_mandate(mandate_id)
-            api_client.invoke_get(build_path(SEPA_MANDATES, mandate_id), sdk_authorization)
-          end
+        # @param mandate_id [String]
+        def get_mandate(mandate_id)
+          api_client.invoke_get(build_path(SEPA_MANDATES, mandate_id), sdk_authorization)
+        end
 
-          # @param mandate_id [String]
-          def cancel_mandate(mandate_id)
-            api_client.invoke_post(build_path(SEPA_MANDATES, mandate_id, CANCEL), sdk_authorization)
-          end
+        # @param mandate_id [String]
+        def cancel_mandate(mandate_id)
+          api_client.invoke_post(build_path(SEPA_MANDATES, mandate_id, CANCEL), sdk_authorization)
+        end
 
-          # @param mandate_id [String]
-          def get_mandate_via_ppro(mandate_id)
-            api_client.invoke_get(build_path(PPRO, SEPA_MANDATES, mandate_id), sdk_authorization)
-          end
+        # @param mandate_id [String]
+        def get_mandate_via_ppro(mandate_id)
+          api_client.invoke_get(build_path(PPRO, SEPA_MANDATES, mandate_id), sdk_authorization)
+        end
 
-          # @param mandate_id [String]
-          def cancel_mandate_via_ppro(mandate_id)
-            api_client.invoke_post(build_path(PPRO, SEPA_MANDATES, mandate_id, CANCEL), sdk_authorization)
-          end
+        # @param mandate_id [String]
+        def cancel_mandate_via_ppro(mandate_id)
+          api_client.invoke_post(build_path(PPRO, SEPA_MANDATES, mandate_id, CANCEL), sdk_authorization)
         end
       end
     end

data/lib/checkout_sdk/checkout_utils.rb

@@ -5,10 +5,19 @@ module CheckoutSdk
     # @return [CheckoutSdk::HttpMetadata]
     def self.map_to_http_metadata(response)
       metadata = CheckoutSdk::HttpMetadata.new
-      # TODO: convert to hash
-      metadata.headers = response[:headers]
-      metadata.status_code = response[:status]
-      metadata.body = response[:body]
+      return metadata if response.nil?
+
+      if response.is_a?(Hash)
+        metadata.headers = response[:headers]
+        metadata.status_code = response[:status]
+        metadata.body = response[:body]
+      end
+
+      if response.class.name.start_with? Faraday::Response.name
+        metadata.headers = response.headers
+        metadata.status_code = response.status
+        metadata.body = response.body
+      end
       metadata
     end
   end

data/lib/checkout_sdk/common/account_holder.rb

@@ -26,6 +26,8 @@ module CheckoutSdk
     #   @return [AccountHolderIdentification]
     # @!attribute email
     #   @return [String]
+    # @!attribute gender
+    #   @return [String]
     class AccountHolder
       attr_accessor :type,
                     :first_name,
@@ -38,7 +40,8 @@ module CheckoutSdk
                     :billing_address,
                     :phone,
                     :identification,
-                    :email
+                    :email,
+                    :gender
     end
   end
 end

data/lib/checkout_sdk/common/common.rb

@@ -20,3 +20,5 @@ require 'checkout_sdk/common/file_request'
 require 'checkout_sdk/common/file_purpose'
 require 'checkout_sdk/common/challenge_indicator'
 require 'checkout_sdk/common/update_customer_request'
+require 'checkout_sdk/common/marketplace_data'
+require 'checkout_sdk/common/shipping_info'

data/lib/checkout_sdk/common/marketplace_data.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    # @!attribute sub_entity_id
+    #   @return [String]
+    # @!attribute sub_entities
+    #   @return [Array(AmountAllocations)]
+    class MarketplaceData
+      attr_accessor :sub_entity_id,
+                    :sub_entities
+    end
+  end
+end

data/lib/checkout_sdk/common/payment_source_type.rb

@@ -47,6 +47,7 @@ module CheckoutSdk
       MBWAY = 'mbway'
       POSTFINANCE = 'postfinance'
       STCPAY = 'stcpay'
+      ALMA = 'alma'
     end
   end
 end

data/lib/checkout_sdk/common/shipping_info.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    # @!attribute shipping_company
+    #   @return [String]
+    # @!attribute shipping_method
+    #   @return [String]
+    # @!attribute tracking_number
+    #   @return [String]
+    # @!attribute tracking_uri
+    #   @return [String]
+    # @!attribute return_shipping_company
+    #   @return [String]
+    # @!attribute return_tracking_number
+    #   @return [String]
+    # @!attribute return_tracking_uri
+    #   @return [String]
+    class ShippingInfo
+      attr_accessor :shipping_company,
+                    :shipping_method,
+                    :tracking_number,
+                    :tracking_uri,
+                    :return_shipping_company,
+                    :return_tracking_number,
+                    :return_tracking_uri
+    end
+  end
+end

data/lib/checkout_sdk/customers/customer_request.rb

@@ -11,9 +11,9 @@ module CheckoutSdk
     # @!attribute metadata
     #   @return [Hash{String => Object}]
     # @!attribute default
-    #   @return [String]
+    #   @return [String] - Not available on previous
     # @!attribute instruments
-    #   @return [Array(String)]
+    #   @return [Array(String)] - Not available on previous
     class CustomerRequest
       attr_accessor :email,
                     :name,

data/lib/checkout_sdk/disputes/disputes_client.rb

@@ -50,6 +50,11 @@ module CheckoutSdk
       def upload_file(file_request)
         api_client.submit_file(FILES, sdk_authorization, file_request)
       end
+
+      # @param [String] file_id
+      def get_file_details(file_id)
+        api_client.invoke_get(build_path(FILES, file_id), sdk_authorization)
+      end
     end
   end
 end

data/lib/checkout_sdk/disputes/disputes_query_filter.rb

@@ -23,11 +23,11 @@ module CheckoutSdk
     # @!attribute this_channel_only
     #   @return [TrueClass, FalseClass]
     # @!attribute entity_ids
-    #   @return [String]
+    #   @return [String] - Not available on Previous.
     # @!attribute sub_entity_ids
-    #   @return [String]
+    #   @return [String] - Not available on Previous.
     # @!attribute payment_mcc
-    #   @return [String]
+    #   @return [String] - Not available on Previous.
     class DisputesQueryFilter
       attr_accessor :limit,
                     :skip,

data/lib/checkout_sdk/instruments/base_instruments_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    class BaseInstrumentsClient < Client
+      INSTRUMENTS = 'instruments'
+      private_constant :INSTRUMENTS
+
+      # @param [String] instrument_id
+      def get(instrument_id)
+        api_client.invoke_get(build_path(INSTRUMENTS, instrument_id), sdk_authorization)
+      end
+
+      # @param [String] instrument_id
+      def delete(instrument_id)
+        api_client.invoke_delete(build_path(INSTRUMENTS, instrument_id), sdk_authorization)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/create/{instrument_request.rb → instrument.rb}

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Instruments
     # @!attribute type
     #   @return [String] {CheckoutSdk::Common::InstrumentType}
-    class InstrumentRequest
+    class Instrument
       attr_reader :type
 
       # @abstract

data/lib/checkout_sdk/instruments/create/{instrument_bank_account_request.rb → instrument_bank_account.rb}

@@ -28,7 +28,7 @@ module CheckoutSdk
     #   @return [CheckoutSdk::Common::BankDetails]
     # @!attribute customer
     #   @return [CheckoutSdk::Common::CustomerRequest]
-    class InstrumentBankAccountRequest < InstrumentRequest
+    class InstrumentBankAccount < Instrument
       attr_accessor :account_type,
                     :account_number,
                     :bank_code,

data/lib/checkout_sdk/instruments/create/{instrument_token_request.rb → instrument_token.rb}

@@ -8,7 +8,7 @@ module CheckoutSdk
     #   @return [CheckoutSdk::Common::AccountHolder]
     # @!attribute customer
     #   @return [CheckoutSdk::Common::CustomerRequest]
-    class InstrumentTokenRequest < InstrumentRequest
+    class InstrumentToken < Instrument
       attr_accessor :token,
                     :account_holder,
                     :customer

data/lib/checkout_sdk/instruments/instruments.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
 # Update
-require 'checkout_sdk/instruments/update/update_instrument_request'
-require 'checkout_sdk/instruments/update/update_instrument_card_request'
-require 'checkout_sdk/instruments/update/update_instrument_bank_account_request'
-require 'checkout_sdk/instruments/update/update_instrument_token_request'
+require 'checkout_sdk/instruments/update/update_instrument'
+require 'checkout_sdk/instruments/update/update_instrument_card'
+require 'checkout_sdk/instruments/update/update_instrument_bank_account'
+require 'checkout_sdk/instruments/update/update_instrument_token'
 # Get
 require 'checkout_sdk/instruments/get/payment_network'
 require 'checkout_sdk/instruments/get/bank_account_field_query'
 # Create
-require 'checkout_sdk/instruments/create/instrument_request'
-require 'checkout_sdk/instruments/create/instrument_token_request'
-require 'checkout_sdk/instruments/create/instrument_bank_account_request'
+require 'checkout_sdk/instruments/create/instrument'
+require 'checkout_sdk/instruments/create/instrument_token'
+require 'checkout_sdk/instruments/create/instrument_bank_account'
+# Client
+require 'checkout_sdk/instruments/base_instruments_client'
 require 'checkout_sdk/instruments/instruments_client'
+
+# Previous
+require 'checkout_sdk/instruments/previous/create/instrument'
+require 'checkout_sdk/instruments/previous/update/update_instrument'
+require 'checkout_sdk/instruments/previous/instruments_client'