checkout_sdk 0.3.2 → 1.0.0.beta.0

data/lib/checkout_sdk/json_serializer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  class JsonSerializer
+    KEYS_TRANSFORMATIONS = { three_ds: '3ds',
+                             account_holder_type: 'account-holder-type',
+                             payment_network: 'payment-network',
+                             from_: 'from' }.freeze
+
+    def self.to_custom_hash(object)
+      hash = {}
+      object.instance_variables.each do |v|
+        value = object.instance_variable_get(v)
+        value = serialize_by_type(value)
+        hash[keys_transformation(v)] = value
+      end
+      hash
+    end
+
+    def self.keys_transformation(key_name)
+      key = key_name.to_s.delete('@')
+      return KEYS_TRANSFORMATIONS[key.to_sym] if KEYS_TRANSFORMATIONS.key?(key.to_sym)
+
+      key
+    end
+
+    # @param [Array] input_array
+    def self.serialize_array(input_array)
+      aux_array = []
+      input_array.map do |value|
+        value = serialize_by_type(value)
+        aux_array.append(value)
+      end
+      aux_array
+    end
+
+    # @param [Hash] input_hash
+    def self.serialize_hash(input_hash)
+      aux_hash = {}
+      input_hash.map do |key, value|
+        value = serialize_by_type(value)
+        aux_hash[key] = value
+      end
+      aux_hash
+    end
+
+    def self.serialize_by_type(value)
+      value = serialize_array(value) if value.is_a?(Array)
+      value = serialize_hash(value) if value.is_a?(Hash)
+      value = to_custom_hash(value) if value.class.name.start_with? CheckoutSdk.name
+      value
+    end
+  end
+end

data/lib/checkout_sdk/oauth_access_token.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  # @!attribute token
+  #   @return [String]
+  # @!attribute expiration_date
+  #   @return [Time]
+  class OAuthAccessToken
+    attr_accessor :token,
+                  :expiration_date
+
+    # @param [String] token
+    # @param [Time] expiration_date
+    # @return [OAuthAccessToken]
+    def initialize(token, expiration_date)
+      @token = token
+      @expiration_date = expiration_date
+    end
+
+    # @return [TrueClass, FalseClass]
+    def valid?
+      return false if @token.nil?
+
+      @expiration_date > Time.now
+    end
+  end
+end

data/lib/checkout_sdk/oauth_scopes.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module OAuthScopes
+    VAULT = 'vault'
+    VAULT_INSTRUMENTS = 'vault:instruments'
+    VAULT_TOKENIZATION = 'vault:tokenization'
+    GATEWAY = 'gateway'
+    GATEWAY_PAYMENT = 'gateway:payment'
+    GATEWAY_PAYMENT_DETAILS = 'gateway:payment-details'
+    GATEWAY_PAYMENT_AUTHORIZATION = 'gateway:payment-authorizations'
+    GATEWAY_PAYMENT_VOIDS = 'gateway:payment-voids'
+    GATEWAY_PAYMENT_CAPTURES = 'gateway:payment-captures'
+    GATEWAY_PAYMENT_REFUNDS = 'gateway:payment-refunds'
+    FX = 'fx'
+    PAYOUTS_BANK_DETAILS = 'payouts:bank-details'
+    SESSIONS_APP = 'sessions:app'
+    SESSIONS_BROWSER = 'sessions:browser'
+    DISPUTES = 'disputes'
+    DISPUTES_VIEW = 'disputes:view'
+    DISPUTES_PROVIDE_EVIDENCE = 'disputes:provide-evidence'
+    DISPUTES_ACCEPT = 'disputes:accept'
+    MARKETPLACE = 'marketplace'
+    ACCOUNTS = 'accounts'
+    FLOW = 'flow'
+    FLOW_WORKFLOWS = 'flow:workflows'
+    FLOW_EVENTS = 'flow:events'
+    FILES = 'files'
+    FILES_RETRIEVE = 'files:retrieve'
+    FILES_UPLOAD = 'files:upload'
+    FILES_DOWNLOAD = 'files:download'
+    TRANSFERS = 'transfers'
+    TRANSFERS_CREATE = 'transfers:create'
+    TRANSFERS_VIEW = 'transfers:view'
+    BALANCES = 'balances'
+    BALANCES_VIEW = 'balances:view'
+    MIDDLEWARE = 'middleware'
+    MIDDLEWARE_MERCHANTS_SECRET = 'middleware:merchants-secret'
+    MIDDLEWARE_MERCHANTS_PUBLIC = 'middleware:merchants-public'
+  end
+end

data/lib/checkout_sdk/oauth_sdk_credentials.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  # @!attribute access_token
+  #   @return [CheckoutSdk::OAuthAccessToken]
+  # @!attribute client_id
+  #   @return [String]
+  # @!attribute client_secret
+  #   @return [String]
+  # @!attribute scopes
+  #   @return [Array(CheckoutSdk::OAuthScopes)]
+  # @!attribute http_client
+  #   @return [Object]
+  # @!attribute environment
+  #   @return [CheckoutSdk::Environment]
+  # @!attribute authorization_uri
+  #   @return [String]
+  class OAuthSdkCredentials < SdkCredentials
+    attr_accessor :access_token,
+                  :client_id,
+                  :client_secret,
+                  :scopes,
+                  :http_client,
+                  :environment,
+                  :authorization_uri
+
+    # @param [String] client_id
+    # @param [String] client_secret
+    # @param [Array(CheckoutSdk::OAuthScopes)] scopes
+    # @param [Faraday] http_client
+    # @param [CheckoutSdk::Environment] environment
+    # @param [String, nil] auth_uri
+    def initialize(client_id, client_secret, scopes, http_client, environment, auth_uri = nil)
+      validate_arguments client_id, client_secret, environment, auth_uri
+      @client_id = client_id
+      @client_secret = client_secret
+      @scopes = scopes
+      @authorization_uri = auth_uri.nil? ? environment.authorization_uri : auth_uri
+      @http_client = http_client.nil? ? build_default_client(authorization_uri) : http_client
+      build_access_token
+    end
+
+    # @param [String] authorization_type
+    # @return [CheckoutSdk::SdkAuthorization]
+    def get_authorization(authorization_type)
+      case authorization_type
+      when AuthorizationType::SECRET_KEY_OR_OAUTH, AuthorizationType::PUBLIC_KEY_OR_OAUTH, AuthorizationType::OAUTH
+        SdkAuthorization.new(PlatformType::DEFAULT, build_access_token.token)
+      else
+        raise CheckoutAuthorizationException.invalid_authorization authorization_type
+      end
+    end
+
+    # @return [CheckoutSdk::OAuthAccessToken]
+    def build_access_token
+      return @access_token unless @access_token.nil? || @access_token.token.nil? || !@access_token.valid?
+
+      data = {
+        client_id: @client_id,
+        client_secret: @client_secret,
+        grant_type: 'client_credentials',
+        scope: @scopes.join(' ')
+      }
+
+      headers = { 'Content-Type': 'application/x-www-form-urlencoded' }
+      body = URI.encode_www_form data
+
+      begin
+        response = @http_client.run_request(:post, @authorization_uri, body, headers)
+      rescue Faraday::ClientError => e
+        raise CheckoutAuthorizationException, e.response
+      rescue Faraday::ConnectionFailed => e
+        raise CheckoutArgumentException, e.wrapped_exception
+      end
+
+      if !response.body.nil? && response.body != ''
+        oauth_response = JSON.parse(response.body, object_class: OpenStruct)
+
+        @access_token = OAuthAccessToken.new(oauth_response.access_token,
+                                             Time.now + oauth_response.expires_in)
+      end
+
+      @access_token
+    end
+
+    private
+
+    # TODO: refactor this into a utils method
+    # @param [String] authorization_uri
+    # @return [Faraday::Connection]
+    def build_default_client(authorization_uri)
+      Faraday.new(authorization_uri) do |f|
+        f.response(:raise_error)
+      end
+    end
+
+    # @param [String] client_id
+    # @param [String] client_secret
+    # @param [Environment] environment
+    # @param [String] authorization_uri
+    def validate_arguments(client_id, client_secret, environment, authorization_uri)
+      if client_id.nil? || client_secret.nil?
+        raise CheckoutArgumentException, 'Invalid OAuth "client_id" or "client_secret"'
+      end
+
+      return unless environment.nil? && authorization_uri.nil?
+
+      raise CheckoutArgumentException,
+            'Invalid configuration. Please specify an "environment" or a specific OAuth "authorization_uri"'
+    end
+  end
+end

data/lib/checkout_sdk/payments/airline_data.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute ticket
+    #   @return [Ticket]
+    # @!attribute passenger
+    #   @return [Passenger]
+    # @!attribute flight_leg_details
+    #   @return [Array(FlightLegDetails)]
+    class AirlineData
+      attr_accessor :ticket,
+                    :passenger,
+                    :flight_leg_details
+    end
+  end
+end

data/lib/checkout_sdk/payments/authorization_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    class AuthorizationRequest
+      attr_accessor :amount,
+                    :reference,
+                    :metadata
+    end
+  end
+end

data/lib/checkout_sdk/payments/authorization_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class AuthorizationType
+      FINAL = 'Final'
+      ESTIMATED = 'Estimated'
+      INCREMENTAL = 'Incremental'
+    end
+  end
+end

data/lib/checkout_sdk/payments/billing_descriptor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute name
+    #   @return [String]
+    # @!attribute city
+    #   @return [String]
+    # @!attribute reference
+    #   @return [String]
+    class BillingDescriptor
+      attr_accessor :name,
+                    :city,
+                    :reference
+    end
+  end
+end

data/lib/checkout_sdk/payments/capture_request.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute capture_type
+    #   @return [String] {CaptureType}
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    # @!attribute description
+    #   @return [String]
+    # @!attribute billing_descriptor
+    #   @return [BillingDescriptor]
+    # @!attribute shipping
+    #   @return [ShippingDetails]
+    # @!attribute items
+    #   @return [Array(Product)]
+    # @!attribute amount_allocations
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    # @!attribute processing
+    #   @return [ProcessingSettings]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    class CaptureRequest
+      attr_accessor :amount,
+                    :capture_type,
+                    :reference,
+                    :customer,
+                    :description,
+                    :billing_descriptor,
+                    :shipping,
+                    :items,
+                    :amount_allocations,
+                    :processing,
+                    :metadata
+    end
+  end
+end

data/lib/checkout_sdk/payments/capture_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module CaptureType
+      NON_FINAL = 'NonFinal'
+      FINAL = 'Final'
+    end
+  end
+end

data/lib/checkout_sdk/payments/charge_bearer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module ChargeBearer
+      OUR = 'OUR'
+      SHA = 'SHA'
+    end
+  end
+end

data/lib/checkout_sdk/payments/d_local_installments.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute count
+    #   @return [String]
+    class DLocalInstallments
+      attr_accessor :count
+    end
+  end
+end

data/lib/checkout_sdk/payments/d_local_processing_settings.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute payer
+    #   @return [Payer]
+    # @!attribute installments
+    #   @return [DLocalInstallments]
+    class DLocalProcessingSettings
+      attr_accessor :country,
+                    :payer,
+                    :installments
+    end
+  end
+end

data/lib/checkout_sdk/payments/destination/bank_account_destination.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_type
+    #   @return [String] {CheckoutSdk::Common::AccountType}
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute bank_code
+    #   @return [String]
+    # @!attribute branch_code
+    #   @return [String]
+    # @!attribute iban
+    #   @return [String]
+    # @!attribute bban
+    #   @return [String]
+    # @!attribute swift_bic
+    #   @return [String]
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute bank
+    #   @return [CheckoutSdk::Common::BankDetails]
+    class BankAccountDestination < Destination
+      attr_accessor :account_type,
+                    :account_number,
+                    :bank_code,
+                    :branch_code,
+                    :iban,
+                    :bban,
+                    :swift_bic,
+                    :country,
+                    :account_holder,
+                    :bank
+
+      def initialize
+        super CheckoutSdk::Payments::DestinationType::BANK_ACCOUNT
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/destination/card_destination.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute number
+    #   @return [String]
+    # @!attribute expiry_month
+    #   @return [Integer]
+    # @!attribute expiry_year
+    #   @return [Integer]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class CardDestination < Destination
+      attr_accessor :number,
+                    :expiry_month,
+                    :expiry_year,
+                    :account_holder
+
+      def initialize
+        super CheckoutSdk::Payments::DestinationType::CARD
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/destination/destination.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute type
+    #   @return [String] {DestinationType}
+    class Destination
+      attr_accessor :type
+
+      protected
+
+      # @abstract
+      # @param [String] type {DestinationType}
+      def initialize(type)
+        @type = type
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/destination/destination_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module DestinationType
+      CARD = 'card'
+      ID = 'id'
+      TOKEN = 'token'
+      BANK_ACCOUNT = 'bank_account'
+    end
+  end
+end

data/lib/checkout_sdk/payments/destination/id_destination.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute id
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class IdDestination < Destination
+      attr_accessor :id,
+                    :account_holder
+
+      def initialize
+        super CheckoutSdk::Payments::DestinationType::ID
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/destination/token_destination.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute token
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class TokenDestination < Destination
+      attr_accessor :token,
+                    :account_holder
+
+      def initialize
+        super CheckoutSdk::Payments::DestinationType::TOKEN
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/exemption.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module Exemption
+      LOW_VALUE = 'low_value'
+      SECURE_CORPORATE_PAYMENT = 'secure_corporate_payment'
+      TRUSTED_LISTING = 'trusted_listing'
+      TRANSACTION_RISK_ASSESSMENT = 'transaction_risk_assessment'
+      THREE_DS_OUTAGE = '3ds_outage'
+      SCA_DELEGATION = 'sca_delegation'
+      OUT_OF_SCA_SCOPE = 'out_of_sca_scope'
+      OTHER = 'other'
+      LOW_RISK_PROGRAM = 'low_risk_program'
+    end
+  end
+end

data/lib/checkout_sdk/payments/flight_leg_details.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute flight_number
+    #   @return [Integer]
+    # @!attribute carrier_code
+    #   @return [String]
+    # @!attribute service_class
+    #   @return [String]
+    # @!attribute departure_date
+    #   @return [String]
+    # @!attribute departure_time
+    #   @return [String]
+    # @!attribute departure_airport
+    #   @return [String]
+    # @!attribute arrival_airport
+    #   @return [String]
+    # @!attribute stopover_code
+    #   @return [String]
+    # @!attribute fare_basis_code
+    #   @return [String]
+    class FlightLegDetails
+      attr_accessor :flight_number,
+                    :carrier_code,
+                    :service_class,
+                    :departure_date,
+                    :departure_time,
+                    :departure_airport,
+                    :arrival_airport,
+                    :stopover_code,
+                    :fare_basis_code
+    end
+  end
+end

data/lib/checkout_sdk/payments/instruction_scheme.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class InstructionScheme
+      SWIFT = 'swift'
+      LOCAL = 'local'
+      INSTANT = 'instant'
+    end
+  end
+end

data/lib/checkout_sdk/payments/merchant_initiated_reason.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module MerchantInitiatedReason
+      DELAYED_CHARGE = 'Delayed_charge'
+      RESUBMISSION = 'Resubmission'
+      NO_SHOW = 'No_show'
+      REAUTHORIZATION = 'Reauthorization'
+    end
+  end
+end

data/lib/checkout_sdk/payments/network_token_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class NetworkTokenType
+      VTS = 'vts'
+      MDES = 'mdes'
+      APPLEPAY = 'applepay'
+      GOOGLEPAY = 'googlepay'
+    end
+  end
+end

data/lib/checkout_sdk/payments/os_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module OsType
+      ANDROID = 'ANDROID'
+      IOS = 'IOS'
+    end
+  end
+end

data/lib/checkout_sdk/payments/passenger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute name
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [String]
+    # @!attribute country_code
+    #   @return [String] {CheckoutSdk::Common::Country}
+    class Passenger
+      attr_accessor :name,
+                    :date_of_birth,
+                    :country_code
+    end
+  end
+end

data/lib/checkout_sdk/payments/passenger_name.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute full_name
+    #   @return [String]
+    class PassengerName
+      attr_accessor :full_name
+    end
+  end
+end