checkout_sdk 0.3.2 → 1.0.0.beta.0

data/lib/checkout_sdk/sessions/completion/non_hosted_completion_info.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute callback_url
+    #   @return [String]
+    class NonHostedCompletionInfo < CompletionInfo
+      attr_accessor :callback_url
+
+      def initialize
+        super CompletionInfoType::NON_HOSTED
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/delivery_timeframe.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module DeliveryTimeframe
+      ELECTRONIC_DELIVERY = 'electronic_delivery'
+      SAME_DAY = 'same_day'
+      OVERNIGHT = 'overnight'
+      TWO_DAY_OR_MORE = 'two_day_or_more'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/installment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute number_of_payments
+    #   @return [Integer]
+    # @!attribute days_between_payments
+    #   @return [Integer]
+    # @!attribute expiry
+    #   @return [String]
+    class Installment
+      attr_accessor :number_of_payments,
+                    :days_between_payments,
+                    :expiry
+    end
+  end
+end

data/lib/checkout_sdk/sessions/merchant_risk_info.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute delivery_email
+    #   @return [String]
+    # @!attribute delivery_timeframe
+    #   @return [String] {DeliveryTimeframe}
+    # @!attribute is_preorder
+    #   @return [TrueClass, FalseClass]
+    # @!attribute is_reorder
+    #   @return [TrueClass, FalseClass]
+    # @!attribute shipping_indicator
+    #   @return [String] {ShippingIndicator}
+    class MerchantRiskInfo
+      attr_accessor :delivery_email,
+                    :delivery_timeframe,
+                    :is_preorder,
+                    :is_reorder,
+                    :shipping_indicator
+    end
+  end
+end

data/lib/checkout_sdk/sessions/recurring.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute days_between_payments
+    #   @return [Integer]
+    # @!attribute expiry
+    #   @return [String]
+    class Recurring
+      attr_accessor :days_between_payments,
+                    :expiry
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_address.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute address_line3
+    #   @return [String]
+    class SessionAddress < CheckoutSdk::Common::Address
+      attr_accessor :address_line3
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_marketplace_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute sub_entity_id
+    #   @return [String]
+    class SessionMarketplaceData
+      attr_accessor :sub_entity_id
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute source
+    #   @return [SessionSource]
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute processing_channel_id
+    #   @return [String]
+    # @!attribute marketplace
+    #   @return [SessionMarketplaceData]
+    # @!attribute authentication_type
+    #   @return [String] {AuthenticationType}
+    # @!attribute authentication_category
+    #   @return [String] {Category}
+    # @!attribute account_info
+    #   @return [CardHolderAccountInfo]
+    # @!attribute challenge_indicator
+    #   @return [String] {CheckoutSdk::Common::ChallengeIndicator}
+    # @!attribute billing_descriptor
+    #   @return [SessionsBillingDescriptor]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute merchant_risk_info
+    #   @return [MerchantRiskInfo]
+    # @!attribute prior_transaction_reference
+    #   @return [String]
+    # @!attribute transaction_type
+    #   @return [String] {TransactionType}
+    # @!attribute shipping_address
+    #   @return [SessionAddress]
+    # @!attribute shipping_address_matches_billing
+    #   @return [TrueClass, FalseClass]
+    # @!attribute completion
+    #   @return [CompletionInfo]
+    # @!attribute channel_data
+    #   @return [ChannelData]
+    # @!attribute recurring
+    #   @return [Recurring]
+    # @!attribute installment
+    #   @return [Installment]
+    class SessionRequest
+      attr_accessor :source,
+                    :amount,
+                    :currency,
+                    :processing_channel_id,
+                    :marketplace,
+                    :authentication_type,
+                    :authentication_category,
+                    :account_info,
+                    :challenge_indicator,
+                    :billing_descriptor,
+                    :reference,
+                    :merchant_risk_info,
+                    :prior_transaction_reference,
+                    :transaction_type,
+                    :shipping_address,
+                    :shipping_address_matches_billing,
+                    :completion,
+                    :channel_data,
+                    :recurring,
+                    :installment
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_secret_credentials.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute session_secret
+    #   @return [String]
+    class SessionSecretCredentials < SdkCredentials
+      attr_accessor :session_secret
+
+      # @param [String] session_secret
+      # @return [SessionSecretCredentials]
+      def initialize(session_secret)
+        @session_secret = session_secret
+      end
+
+      # @param [String] authorization_type
+      # @return [CheckoutSdk::SdkAuthorization]
+      def get_authorization(authorization_type)
+        if authorization_type != AuthorizationType::CUSTOM
+          raise CheckoutAuthorizationException.invalid_authorization AuthorizationType::CUSTOM
+        end
+        raise CheckoutAuthorizationException.invalid_key AuthorizationType::CUSTOM if @session_secret.nil?
+
+        SdkAuthorization.new PlatformType::CUSTOM, @session_secret
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_source_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module SessionSourceType
+      CARD = 'card'
+      ID = 'id'
+      TOKEN = 'token'
+      NETWORK_TOKEN = 'network_token'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/sessions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/sessions/authentication_method'
+require 'checkout_sdk/sessions/authentication_type'
+require 'checkout_sdk/sessions/card_holder_account_info'
+require 'checkout_sdk/sessions/category'
+require 'checkout_sdk/sessions/delivery_timeframe'
+require 'checkout_sdk/sessions/installment'
+require 'checkout_sdk/sessions/merchant_risk_info'
+require 'checkout_sdk/sessions/recurring'
+require 'checkout_sdk/sessions/session_address'
+require 'checkout_sdk/sessions/session_marketplace_data'
+require 'checkout_sdk/sessions/session_request'
+require 'checkout_sdk/sessions/session_source_type'
+require 'checkout_sdk/sessions/sessions_billing_descriptor'
+require 'checkout_sdk/sessions/shipping_indicator'
+require 'checkout_sdk/sessions/transaction_type'
+require 'checkout_sdk/sessions/three_ds_method_completion_request'
+
+# channel
+require 'checkout_sdk/sessions/channel/channel_data'
+require 'checkout_sdk/sessions/channel/channel_data_type'
+require 'checkout_sdk/sessions/channel/sdk_ephemeral_public_key'
+require 'checkout_sdk/sessions/channel/sdk_interface_type'
+require 'checkout_sdk/sessions/channel/three_ds_method_completion'
+require 'checkout_sdk/sessions/channel/uie_elements'
+require 'checkout_sdk/sessions/channel/app_session'
+require 'checkout_sdk/sessions/channel/browser_session'
+
+# completion
+require 'checkout_sdk/sessions/completion/completion_info'
+require 'checkout_sdk/sessions/completion/completion_info_type'
+require 'checkout_sdk/sessions/completion/hosted_completion_info'
+require 'checkout_sdk/sessions/completion/non_hosted_completion_info'
+
+# sources
+require 'checkout_sdk/sessions/source/session_scheme'
+require 'checkout_sdk/sessions/source/session_source'
+require 'checkout_sdk/sessions/source/card_source'
+require 'checkout_sdk/sessions/source/id_source'
+require 'checkout_sdk/sessions/source/network_token_source'
+require 'checkout_sdk/sessions/source/token_source'
+
+# credentials
+require 'checkout_sdk/sessions/session_secret_credentials'
+
+require 'checkout_sdk/sessions/sessions_client'

data/lib/checkout_sdk/sessions/sessions_billing_descriptor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute name
+    #   @return [String]
+    class SessionsBillingDescriptor
+      attr_accessor :name
+    end
+  end
+end

data/lib/checkout_sdk/sessions/sessions_client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    class SessionsClient < Client
+      SESSIONS = 'sessions'
+      COLLECT_DATA = 'collect-data'
+      COMPLETE = 'complete'
+      ISSUER_FINGERPRINT = 'issuer-fingerprint'
+      private_constant :SESSIONS, :COLLECT_DATA, :COMPLETE, :ISSUER_FINGERPRINT
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH
+      end
+
+      # @param [SessionRequest] session_request
+      def request_session(session_request)
+        api_client.invoke_post(SESSIONS, sdk_authorization, session_request)
+      end
+
+      # @param [String] session_id
+      # @param [String, nil] session_secret
+      def get_session_details(session_id, session_secret = nil)
+        api_client.invoke_get(build_path(SESSIONS, session_id), custom_sdk_authorization(session_secret))
+      end
+
+      # @param [String] session_id
+      # @param [ChannelData] channel_data
+      # @param [String, nil] session_secret
+      def update_session(session_id, channel_data, session_secret = nil)
+        api_client.invoke_put(build_path(SESSIONS, session_id, COLLECT_DATA),
+                              custom_sdk_authorization(session_secret),
+                              channel_data)
+      end
+
+      # @param [String] session_id
+      # @param [String, nil] session_secret
+      def complete_session(session_id, session_secret = nil)
+        api_client.invoke_post(build_path(SESSIONS, session_id, COMPLETE), custom_sdk_authorization(session_secret))
+      end
+
+      # @param [String] session_id
+      # @param [ThreeDsMethodCompletionRequest] three_ds_method_completion_request
+      # @param [String, nil] session_secret
+      def update_3ds_method_completion(session_id, three_ds_method_completion_request, session_secret = nil)
+        api_client.invoke_put(build_path(SESSIONS, session_id, ISSUER_FINGERPRINT),
+                              custom_sdk_authorization(session_secret),
+                              three_ds_method_completion_request)
+      end
+
+      # @param [String, nil] session_secret
+      def custom_sdk_authorization(session_secret = nil)
+        if session_secret.nil?
+          sdk_authorization
+        else
+          SessionSecretCredentials.new(session_secret) \
+                                  .get_authorization(AuthorizationType::CUSTOM)
+        end
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/shipping_indicator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module ShippingIndicator
+      VISA = 'visa'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/source/card_source.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute number
+    #   @return [String]
+    # @!attribute expiry_month
+    #   @return [Integer]
+    # @!attribute expiry_year
+    #   @return [Integer]
+    # @!attribute name
+    #   @return [String]
+    # @!attribute stored
+    #   @return [TrueClass, FalseClass]
+    # @!attribute store_for_future_use
+    #   @return [TrueClass, FalseClass]
+    class CardSource < SessionSource
+      attr_accessor :number,
+                    :expiry_month,
+                    :expiry_year,
+                    :name,
+                    :stored,
+                    :store_for_future_use
+
+      def initialize
+        super SessionSourceType::CARD
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/source/id_source.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute id
+    #   @return [String]
+    class IdSource < SessionSource
+      attr_accessor :id
+
+      def initialize
+        super SessionSourceType::ID
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/source/network_token_source.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute token
+    #   @return [String]
+    # @!attribute expiry_month
+    #   @return [Integer]
+    # @!attribute expiry_year
+    #   @return [Integer]
+    # @!attribute name
+    #   @return [String]
+    # @!attribute stored
+    #   @return [TrueClass, FalseClass]
+    class NetworkTokenSource < SessionSource
+      attr_accessor :token,
+                    :expiry_month,
+                    :expiry_year,
+                    :name,
+                    :stored
+
+      def initialize
+        super SessionSourceType::NETWORK_TOKEN
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/source/session_scheme.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module SessionScheme
+      VISA = 'visa'
+      MASTERCARD = 'mastercard'
+      JCB = 'jcb'
+      AMEX = 'amex'
+      DINERS = 'diners'
+      CARTES_BANCAIRES = 'cartes_bancaires'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/source/session_source.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute type
+    #   @return [String] {SessionSourceType}
+    # @!attribute scheme
+    #   @return [String] {SessionScheme}
+    # @!attribute billing_address
+    #   @return [SessionAddress]
+    # @!attribute home_phone
+    #   @return [CheckoutSdk::Common::Phone]
+    # @!attribute mobile_phone
+    #   @return [CheckoutSdk::Common::Phone]
+    # @!attribute work_phone
+    #   @return [CheckoutSdk::Common::Phone]
+    # @!attribute email
+    #   @return [String]
+    class SessionSource
+      attr_reader :type
+      attr_accessor :scheme,
+                    :billing_address,
+                    :home_phone,
+                    :mobile_phone,
+                    :work_phone,
+                    :email
+
+      protected
+
+      # @abstract
+      # @param [String] type {SessionSourceType}
+      def initialize(type)
+        @type = type
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/source/token_source.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute token
+    #   @return [String]
+    # @!attribute store_for_future_use
+    #   @return [TrueClass, FalseClass]
+    class TokenSource < SessionSource
+      attr_accessor :token,
+                    :store_for_future_use
+
+      def initialize
+        super SessionSourceType::TOKEN
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/three_ds_method_completion_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute three_ds_method_completion
+    #   @return [String] {ThreeDsMethodCompletion}
+    class ThreeDsMethodCompletionRequest
+      attr_accessor :three_ds_method_completion
+    end
+  end
+end

data/lib/checkout_sdk/sessions/transaction_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module TransactionType
+      GOODS_SERVICE = 'goods_service'
+      CHECK_ACCEPTANCE = 'check_acceptance'
+      ACCOUNT_FUNDING = 'account_funding'
+      QUASHI_CARD_TRANSACTION = 'quashi_card_transaction'
+      PREPAID_ACTIVATION_AND_LOAD = 'prepaid_activation_and_load'
+    end
+  end
+end

data/lib/checkout_sdk/static_keys_builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  class StaticKeysBuilder < AbstractCheckoutSdkBuilder
+    attr_accessor :secret_key, :public_key
+
+    # @param [String] secret_key
+    def with_secret_key(secret_key)
+      @secret_key = secret_key
+      self
+    end
+
+    # @param [String] public_key
+    def with_public_key(public_key)
+      @public_key = public_key
+      self
+    end
+
+    protected
+
+    def build
+      super
+      validate_secret_key(@secret_key_pattern)
+      validate_public_key(@public_key_pattern)
+    end
+
+    def validate_public_key(pattern)
+      raise CheckoutArgumentException, 'Invalid public key' if !public_key.nil? && !public_key.match(pattern)
+    end
+
+    def validate_secret_key(pattern)
+      raise CheckoutArgumentException, 'Invalid secret key' if secret_key.nil? || !secret_key.match(pattern)
+    end
+  end
+end

data/lib/checkout_sdk/static_keys_sdk_credentials.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  # @!attribute secret_key
+  #   @return [String]
+  # @!attribute public_key
+  #   @return [String]
+  class StaticKeysSdkCredentials < SdkCredentials
+    attr_reader :secret_key, :public_key
+
+    # @param [String] secret_key
+    # @param [String] public_key
+    def initialize(secret_key, public_key)
+      @secret_key = secret_key
+      @public_key = public_key
+    end
+
+    # @param [String] authorization_type
+    # @return [CheckoutSdk::SdkAuthorization]
+    def get_authorization(authorization_type)
+      case authorization_type
+      when AuthorizationType::SECRET_KEY, AuthorizationType::SECRET_KEY_OR_OAUTH
+        raise CheckoutAuthorizationException.invalid_key AuthorizationType::SECRET_KEY if secret_key.nil?
+
+        SdkAuthorization.new(PlatformType::DEFAULT, @secret_key)
+      when AuthorizationType::PUBLIC_KEY, AuthorizationType::PUBLIC_KEY_OR_OAUTH
+        raise CheckoutAuthorizationException.invalid_key AuthorizationType::PUBLIC_KEY if public_key.nil?
+
+        SdkAuthorization.new(PlatformType::DEFAULT, @public_key)
+      else
+        raise CheckoutAuthorizationException.invalid_authorization authorization_type
+      end
+    end
+  end
+end

data/lib/checkout_sdk/tokens/apple_pay_token_data.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Tokens
+    # @!attribute version
+    #   @return [String]
+    # @!attribute data
+    #   @return [String]
+    # @!attribute signature
+    #   @return [String]
+    # @!attribute header
+    #   @return [Hash{String => Object]
+    class ApplePayTokenData
+      attr_accessor :version,
+                    :data,
+                    :signature,
+                    :header
+    end
+  end
+end

data/lib/checkout_sdk/tokens/apple_pay_token_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Tokens
+    # @!attribute token_data
+    #   @return [ApplePayTokenData]
+    class ApplePayTokenRequest < WalletTokenRequest
+      attr_accessor :token_data
+
+      def initialize
+        super CheckoutSdk::Tokens::TokenType::APPLE_PAY
+      end
+    end
+  end
+end