checkout_sdk 1.0.0.beta.1 → 1.0.0.beta.2

data/lib/checkout_sdk/accounts/representative.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute id
+    #   @return [String]
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute identification
+    #   @return [Identification]
+    # @!attribute phone
+    #   @return [Phone]
+    # @!attribute date_of_birth
+    #   @return [DateOfBirth]
+    # @!attribute place_of_birth
+    #   @return [PlaceOfBirth]
+    # @!attribute roles
+    #   @return [Array(String)]
+    class Representative
+      attr_accessor :id,
+                    :first_name,
+                    :last_name,
+                    :address,
+                    :identification,
+                    :phone,
+                    :date_of_birth,
+                    :place_of_birth,
+                    :roles
+    end
+  end
+end

data/lib/checkout_sdk/accounts/schedule_frequency_daily.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    class ScheduleFrequencyDaily < ScheduleRequest
+      def initialize
+        super ScheduleFrequencyType::DAILY
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/schedule_frequency_monthly.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute by_month_day
+    #   @return [Array(Integer)]
+    class ScheduleFrequencyMonthly < ScheduleRequest
+      attr_accessor :by_month_day
+
+      def initialize
+        super ScheduleFrequencyType::MONTHLY
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/schedule_frequency_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ScheduleFrequencyType
+      WEEKLY = 'Weekly'
+      DAILY = 'Daily'
+      MONTHLY = 'Monthly'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/schedule_frequency_weekly.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute by_day
+    #   @return [Array(String)]
+    class ScheduleFrequencyWeekly < ScheduleRequest
+      attr_accessor :by_day
+
+      def initialize
+        super ScheduleFrequencyType::WEEKLY
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/schedule_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute frequency
+    #   @return [String] {ScheduleFrequencyType}
+    class ScheduleRequest
+      attr_reader :frequency
+
+      protected
+
+      # @abstract
+      # @param [String] frequency {ScheduleFrequencyType}
+      def initialize(frequency)
+        @frequency = frequency
+      end
+    end
+  end
+end

data/lib/checkout_sdk/accounts/update_schedule.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute enabled
+    #   @return [TrueClass, FalseClass]
+    # @!attribute threshold
+    #   @return [TrueClass, FalseClass]
+    # @!attribute recurrence
+    #   @return [ScheduleRequest]
+    class UpdateSchedule
+      attr_accessor :enabled,
+                    :threshold,
+                    :recurrence
+    end
+  end
+end

data/lib/checkout_sdk/api_client.rb

@@ -2,12 +2,15 @@
 
 module CheckoutSdk
   class ApiClient
-    # @param [CheckoutConfiguration] _configuration
+    attr_accessor :client, :multipart_client
+
+    # @param [CheckoutConfiguration] configuration
     # @param [String] uri
-    def initialize(_configuration, uri)
-      # TODO: expect given http client
-      @client = build_default_client(uri)
-      @multipart_client = build_multipart_client(uri)
+    def initialize(configuration, uri)
+      @client = configuration.http_client.clone
+      @client.url_prefix = uri
+      @multipart_client = configuration.multipart_http_client.clone
+      @multipart_client.url_prefix = uri
     end
 
     # @param [String] path
@@ -51,19 +54,6 @@ module CheckoutSdk
 
     private
 
-    def build_multipart_client(uri)
-      Faraday.new(uri) do |f|
-        f.request :multipart
-        f.response :raise_error
-      end
-    end
-
-    def build_default_client(uri)
-      Faraday.new(uri) do |f|
-        f.response :raise_error
-      end
-    end
-
     def invoke(method, path, authorization, body = nil, idempotency_key = nil, params: nil)
       path = append_params(path, params) unless params.nil?
 
@@ -91,14 +81,13 @@ module CheckoutSdk
     end
 
     def append_params(path, input_params)
-      # TODO: refactor this into a utils method
       hash = CheckoutSdk::JsonSerializer.to_custom_hash(input_params)
       params = URI.encode_www_form(hash)
       "#{path}?#{params}"
     end
 
     def build_multipart_request(file_request, file)
-      key = file_request.is_a?(CheckoutSdk::Common::FileRequest) ? :file : :path
+      key = file_request.class.name.start_with?(CheckoutSdk::Common::FileRequest.name) ? :file : :path
       {
         key => Faraday::Multipart::FilePart.new(
           file,
@@ -128,6 +117,8 @@ module CheckoutSdk
     end
 
     def parse_response(response)
+      raise CheckoutApiException, response if response.status < 200 || response.status >= 300
+
       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?

data/lib/checkout_sdk/checkout_api.rb

@@ -7,25 +7,40 @@ module CheckoutSdk
   #   @return [CheckoutSdk::Disputes::DisputesClient]
   # @!attribute forex
   #   @return [CheckoutSdk::Forex::ForexClient]
+  # @!attribute hosted
+  #   @return [CheckoutSdk::Payments::HostedPaymentsClient]
   # @!attribute instruments
   #   @return [CheckoutSdk::Instruments::InstrumentsClient]
+  # @!attribute links
+  #   @return [CheckoutSdk::Payments::PaymentsLinksClient]
   # @!attribute payments
   #   @return [CheckoutSdk::Payments::PaymentsClient]
+  # @!attribute reports
+  #   @return [CheckoutSdk::Reports::ReportsClient]
   # @!attribute sessions
   #   @return [CheckoutSdk::Sessions::SessionsClient]
   # @!attribute tokens
   #   @return [CheckoutSdk::Tokens::TokensClient]
   # @!attribute ideal
   #   @return [CheckoutSdk::Apm::IdealClient]
+  # @!attribute accounts
+  #   @return [CheckoutSdk::Accounts::AccountsClient]
+  # @!attribute workflows
+  #   @return [CheckoutSdk::Workflows::WorkflowsClient]
   class CheckoutApi
     attr_reader :customers,
                 :disputes,
                 :forex,
+                :hosted,
                 :instruments,
+                :links,
                 :payments,
+                :reports,
                 :sessions,
                 :tokens,
-                :ideal
+                :ideal,
+                :accounts,
+                :workflows
 
     # @param [CheckoutConfiguration] configuration
     def initialize(configuration)
@@ -33,11 +48,16 @@ module CheckoutSdk
       @customers = CheckoutSdk::Customers::CustomersClient.new api_client, configuration
       @disputes = CheckoutSdk::Disputes::DisputesClient.new api_client, configuration
       @forex = CheckoutSdk::Forex::ForexClient.new api_client, configuration
+      @hosted = CheckoutSdk::Payments::HostedPaymentsClient.new api_client, configuration
       @instruments = CheckoutSdk::Instruments::InstrumentsClient.new api_client, configuration
+      @links = CheckoutSdk::Payments::PaymentsLinksClient.new api_client, configuration
       @payments = CheckoutSdk::Payments::PaymentsClient.new api_client, configuration
+      @reports = CheckoutSdk::Reports::ReportsClient.new api_client, configuration
       @sessions = CheckoutSdk::Sessions::SessionsClient.new api_client, configuration
       @tokens = CheckoutSdk::Tokens::TokensClient.new api_client, configuration
       @ideal = CheckoutSdk::Apm::IdealClient.new api_client, configuration
+      @workflows = CheckoutSdk::Workflows::WorkflowsClient.new api_client, configuration
+      @accounts = CheckoutSdk::Accounts::AccountsClient.new(api_client, files_client(configuration), configuration)
     end
 
     private
@@ -45,7 +65,13 @@ module CheckoutSdk
     # @param [CheckoutConfiguration] configuration
     # @return [ApiClient]
     def base_api_client(configuration)
-      CheckoutSdk::ApiClient.new configuration, configuration.environment.base_uri
+      ApiClient.new(configuration, configuration.environment.base_uri)
+    end
+
+    # @param [CheckoutConfiguration] configuration
+    # @return [ApiClient]
+    def files_client(configuration)
+      ApiClient.new(configuration, configuration.environment.files_uri)
     end
   end
 end

data/lib/checkout_sdk/checkout_configuration.rb

@@ -6,17 +6,19 @@ module CheckoutSdk
   # @!attribute environment
   #   @return [Environment]
   # @!attribute http_client
-  #   @return [Object]
+  #   @return [Faraday::Connection]
   class CheckoutConfiguration
-    attr_accessor :credentials, :environment, :http_client
+    attr_accessor :credentials, :environment, :http_client, :multipart_http_client
 
     # @param [SdkCredentials] credentials
     # @param [Environment] environment
-    # @param [Object] http_client
-    def initialize(credentials, environment, http_client)
+    # @param [Faraday::Connection] http_client
+    # @param [Faraday::Connection] multipart_http_client
+    def initialize(credentials, environment, http_client, multipart_http_client)
       @credentials = credentials
       @environment = environment
       @http_client = http_client
+      @multipart_http_client = multipart_http_client
     end
   end
 end

data/lib/checkout_sdk/checkout_oauth_sdk_builder.rb

@@ -40,11 +40,13 @@ module CheckoutSdk
 
     # @return [CheckoutSdk::CheckoutApi]
     def build
+      super
       CheckoutSdk::CheckoutApi.new(
         CheckoutConfiguration.new(
           OAuthSdkCredentials.new(client_id, client_secret, scopes, http_client, environment, authorization_uri),
           environment,
-          http_client
+          http_client,
+          multipart_http_client
         )
       )
     end

data/lib/checkout_sdk/checkout_static_keys_sdk_builder.rb

@@ -15,7 +15,8 @@ module CheckoutSdk
         CheckoutConfiguration.new(
           StaticKeysSdkCredentials.new(secret_key, public_key),
           environment,
-          http_client
+          http_client,
+          multipart_http_client
         )
       )
     end

data/lib/checkout_sdk/checkout_utils.rb

@@ -20,5 +20,20 @@ module CheckoutSdk
       end
       metadata
     end
+
+    # @return [Faraday::Connection]
+    def self.build_multipart_client
+      Faraday.new do |f|
+        f.request :multipart
+        f.response :raise_error
+      end
+    end
+
+    # @return [Faraday::Connection]
+    def self.build_default_client
+      Faraday.new do |f|
+        f.response :raise_error
+      end
+    end
   end
 end

data/lib/checkout_sdk/common/common.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'checkout_sdk/common/abstract_file_request'
 require 'checkout_sdk/common/account_type'
 require 'checkout_sdk/common/customer_request'
 require 'checkout_sdk/common/amount_allocations'
@@ -22,3 +21,4 @@ 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'
+require 'checkout_sdk/common/product'

data/lib/checkout_sdk/common/file_request.rb

@@ -4,8 +4,11 @@ module CheckoutSdk
   module Common
     # @!attribute purpose
     #   @return [FilePurpose]
-    class FileRequest < AbstractFileRequest
-      attr_accessor :purpose
+    # @!attribute file
+    #   @return [String]
+    class FileRequest
+      attr_accessor :purpose,
+                    :file
     end
   end
 end

data/lib/checkout_sdk/common/product.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    # @!attribute name
+    #   @return [String]
+    # @!attribute quantity
+    #   @return [Integer]
+    # @!attribute price
+    #   @return [Integer]
+    class Product
+      attr_accessor :name,
+                    :quantity,
+                    :price
+    end
+  end
+end

data/lib/checkout_sdk/instruments/create/instrument.rb

@@ -7,6 +7,8 @@ module CheckoutSdk
     class Instrument
       attr_reader :type
 
+      protected
+
       # @abstract
       # @param [String]  {CheckoutSdk::Common::InstrumentType}
       def initialize(type)

data/lib/checkout_sdk/instruments/update/update_instrument.rb

@@ -7,6 +7,8 @@ module CheckoutSdk
     class UpdateInstrument
       attr_reader :type
 
+      protected
+
       # @abstract
       # @param [String]  {CheckoutSdk::Common::InstrumentType}
       def initialize(type)

data/lib/checkout_sdk/oauth_scopes.rb

@@ -37,5 +37,7 @@ module CheckoutSdk
     MIDDLEWARE = 'middleware'
     MIDDLEWARE_MERCHANTS_SECRET = 'middleware:merchants-secret'
     MIDDLEWARE_MERCHANTS_PUBLIC = 'middleware:merchants-public'
+    REPORTING = 'reporting'
+    REPORTING_VIEW = 'reporting:view'
   end
 end

data/lib/checkout_sdk/oauth_sdk_credentials.rb

@@ -27,7 +27,7 @@ module CheckoutSdk
     # @param [String] client_id
     # @param [String] client_secret
     # @param [Array(CheckoutSdk::OAuthScopes)] scopes
-    # @param [Faraday] http_client
+    # @param [Faraday::Connection] http_client
     # @param [CheckoutSdk::Environment] environment
     # @param [String, nil] auth_uri
     def initialize(client_id, client_secret, scopes, http_client, environment, auth_uri = nil)
@@ -36,7 +36,8 @@ module CheckoutSdk
       @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
+      @oauth_http_client = http_client.clone
+      @oauth_http_client.url_prefix = @authorization_uri
       build_access_token
     end
 
@@ -66,7 +67,7 @@ module CheckoutSdk
       body = URI.encode_www_form data
 
       begin
-        response = @http_client.run_request(:post, @authorization_uri, body, headers)
+        response = @oauth_http_client.run_request(:post, @authorization_uri, body, headers)
       rescue Faraday::ClientError => e
         raise CheckoutAuthorizationException, e.response
       rescue Faraday::ConnectionFailed => e
@@ -85,19 +86,10 @@ module CheckoutSdk
 
     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
+    # @param [String, nil] 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"'

data/lib/checkout_sdk/payments/base_payments_client.rb

@@ -5,6 +5,11 @@ module CheckoutSdk
     class BasePaymentsClient < Client
       PAYMENTS_PATH = 'payments'
 
+      # @param [PaymentsQueryFilter] query_filter
+      def get_payments_list(query_filter)
+        api_client.invoke_get(PAYMENTS_PATH, sdk_authorization, query_filter)
+      end
+
       # @param [String] payment_id
       def get_payment_details(payment_id)
         api_client.invoke_get(build_path(PAYMENTS_PATH, payment_id),

data/lib/checkout_sdk/payments/billing_information.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute address
+    #   @return [CheckoutSdk::Common::Address]
+    # @!attribute phone
+    #   @return [CheckoutSdk::Common::Phone]
+    class BillingInformation
+      attr_accessor :address,
+                    :phone
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payments_client.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class HostedPaymentsClient < Client
+      HOSTED_PAYMENTS = 'hosted-payments'
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+      end
+
+      # @param [HostedPaymentsSession] hosted_payments_session
+      def create_hosted_payments_page_session(hosted_payments_session)
+        api_client.invoke_post(HOSTED_PAYMENTS, sdk_authorization, hosted_payments_session)
+      end
+
+      # @param [String] hosted_payment_id
+      def get_hosted_payments_page_details(hosted_payment_id)
+        api_client.invoke_get(build_path(HOSTED_PAYMENTS, hosted_payment_id), sdk_authorization)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payments_session.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute payment_type
+    #   @return [String] {PaymentType}
+    # @!attribute payment_ip
+    #   @return [String]
+    # @!attribute billing_descriptor
+    #   @return [BillingDescriptor]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute description
+    #   @return [String]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    # @!attribute shipping
+    #   @return [ShippingDetails]
+    # @!attribute billing
+    #   @return [BillingInformation]
+    # @!attribute recipient
+    #   @return [PaymentRecipient]
+    # @!attribute processing
+    #   @return [ProcessingSettings]
+    # @!attribute allow_payment_methods
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    # @!attribute products
+    #   @return [Array(CheckoutSdk::Common::Product)]
+    # @!attribute risk
+    #   @return [RiskRequest]
+    # @!attribute success_url
+    #   @return [String]
+    # @!attribute cancel_url
+    #   @return [String]
+    # @!attribute failure_url
+    #   @return [String]
+    # @!attribute metadata
+    #   @return [Hash(String=>Object)]
+    # @!attribute locale
+    #   @return [String]
+    # @!attribute three_ds
+    #   @return [ThreeDSRequest]
+    # @!attribute capture
+    #   @return [TrueClass, FalseClass]
+    # @!attribute capture_on
+    #   @return [Time]
+    # @!attribute processing_channel_id
+    #   @return [String] - Not available on Previous.
+    # @!attribute marketplace
+    #   @deprecated Please use {#amount_allocations} instead
+    #   @return [CheckoutSdk::Common::MarketplaceData] - Not available on Previous.
+    # @!attribute amount_allocations
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] - Not available on Previous.
+    class HostedPaymentsSession
+      attr_accessor :amount,
+                    :currency,
+                    :payment_type,
+                    :payment_ip,
+                    :billing_descriptor,
+                    :reference,
+                    :description,
+                    :customer,
+                    :shipping,
+                    :billing,
+                    :recipient,
+                    :processing,
+                    :allow_payment_methods,
+                    :products,
+                    :risk,
+                    :success_url,
+                    :cancel_url,
+                    :failure_url,
+                    :metadata,
+                    :locale,
+                    :three_ds,
+                    :capture,
+                    :capture_on,
+                    :processing_channel_id,
+                    :marketplace,
+                    :amount_allocations
+    end
+  end
+end