modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/wealth_and_employment_details.rb

@@ -0,0 +1,324 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class WealthAndEmploymentDetails < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute annual_income
+      #   The annual income of the individual.
+      #
+      #   @return [Integer, nil]
+      required :annual_income, Integer, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!attribute employer_country
+      #   The country in which the employer is located.
+      #
+      #   @return [String, nil]
+      required :employer_country, String, nil?: true
+
+      # @!attribute employer_name
+      #   The name of the employer.
+      #
+      #   @return [String, nil]
+      required :employer_name, String, nil?: true
+
+      # @!attribute employer_state
+      #   The state in which the employer is located.
+      #
+      #   @return [String, nil]
+      required :employer_state, String, nil?: true
+
+      # @!attribute employment_status
+      #   The employment status of the individual.
+      #
+      #   @return [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::EmploymentStatus, nil]
+      required :employment_status,
+               enum: -> { ModernTreasury::Models::WealthAndEmploymentDetails::EmploymentStatus },
+               nil?: true
+
+      # @!attribute income_country
+      #   The country in which the individual's income is earned.
+      #
+      #   @return [String, nil]
+      required :income_country, String, nil?: true
+
+      # @!attribute income_source
+      #   The source of the individual's income.
+      #
+      #   @return [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::IncomeSource, nil]
+      required :income_source,
+               enum: -> { ModernTreasury::Models::WealthAndEmploymentDetails::IncomeSource },
+               nil?: true
+
+      # @!attribute income_state
+      #   The state in which the individual's income is earned.
+      #
+      #   @return [String, nil]
+      required :income_state, String, nil?: true
+
+      # @!attribute industry
+      #   The industry of the individual.
+      #
+      #   @return [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::Industry, nil]
+      required :industry, enum: -> { ModernTreasury::Models::WealthAndEmploymentDetails::Industry }, nil?: true
+
+      # @!attribute live_mode
+      #   This field will be true if this object exists in the live environment or false
+      #     if it exists in the test environment.
+      #
+      #   @return [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute occupation
+      #   The occupation of the individual.
+      #
+      #   @return [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::Occupation, nil]
+      required :occupation,
+               enum: -> { ModernTreasury::Models::WealthAndEmploymentDetails::Occupation },
+               nil?: true
+
+      # @!attribute source_of_funds
+      #   The source of the individual's funds.
+      #
+      #   @return [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::SourceOfFunds, nil]
+      required :source_of_funds,
+               enum: -> { ModernTreasury::Models::WealthAndEmploymentDetails::SourceOfFunds },
+               nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute wealth_source
+      #   The source of the individual's wealth.
+      #
+      #   @return [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::WealthSource, nil]
+      required :wealth_source,
+               enum: -> { ModernTreasury::Models::WealthAndEmploymentDetails::WealthSource },
+               nil?: true
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param annual_income [Integer, nil]
+      #   # @param created_at [Time]
+      #   # @param discarded_at [Time, nil]
+      #   # @param employer_country [String, nil]
+      #   # @param employer_name [String, nil]
+      #   # @param employer_state [String, nil]
+      #   # @param employment_status [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::EmploymentStatus, nil]
+      #   # @param income_country [String, nil]
+      #   # @param income_source [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::IncomeSource, nil]
+      #   # @param income_state [String, nil]
+      #   # @param industry [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::Industry, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param occupation [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::Occupation, nil]
+      #   # @param source_of_funds [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::SourceOfFunds, nil]
+      #   # @param updated_at [Time]
+      #   # @param wealth_source [Symbol, ModernTreasury::Models::WealthAndEmploymentDetails::WealthSource, nil]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     annual_income:,
+      #     created_at:,
+      #     discarded_at:,
+      #     employer_country:,
+      #     employer_name:,
+      #     employer_state:,
+      #     employment_status:,
+      #     income_country:,
+      #     income_source:,
+      #     income_state:,
+      #     industry:,
+      #     live_mode:,
+      #     object:,
+      #     occupation:,
+      #     source_of_funds:,
+      #     updated_at:,
+      #     wealth_source:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # The employment status of the individual.
+      module EmploymentStatus
+        extend ModernTreasury::Enum
+
+        EMPLOYED = :employed
+        RETIRED = :retired
+        SELF_EMPLOYED = :self_employed
+        STUDENT = :student
+        UNEMPLOYED = :unemployed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The source of the individual's income.
+      module IncomeSource
+        extend ModernTreasury::Enum
+
+        FAMILY_SUPPORT = :family_support
+        GOVERNMENT_BENEFITS = :government_benefits
+        INHERITANCE = :inheritance
+        INVESTMENTS = :investments
+        RENTAL_INCOME = :rental_income
+        RETIREMENT = :retirement
+        SALARY = :salary
+        SELF_EMPLOYED = :self_employed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The industry of the individual.
+      module Industry
+        extend ModernTreasury::Enum
+
+        ACCOUNTING = :accounting
+        AGRICULTURE = :agriculture
+        AUTOMOTIVE = :automotive
+        CHEMICAL_MANUFACTURING = :chemical_manufacturing
+        CONSTRUCTION = :construction
+        EDUCATIONAL_MEDICAL = :educational_medical
+        FOOD_SERVICE = :food_service
+        FINANCE = :finance
+        GASOLINE = :gasoline
+        HEALTH_STORES = :health_stores
+        LAUNDRY = :laundry
+        MAINTENANCE = :maintenance
+        MANUFACTURING = :manufacturing
+        MERCHANT_WHOLESALE = :merchant_wholesale
+        MINING = :mining
+        PERFORMING_ARTS = :performing_arts
+        PROFESSIONAL_NON_LEGAL = :professional_non_legal
+        PUBLIC_ADMINISTRATION = :public_administration
+        PUBLISHING = :publishing
+        REAL_ESTATE = :real_estate
+        RECREATION_GAMBLING = :recreation_gambling
+        RELIGIOUS_CHARITY = :religious_charity
+        RENTAL_SERVICES = :rental_services
+        RETAIL_CLOTHING = :retail_clothing
+        RETAIL_ELECTRONICS = :retail_electronics
+        RETAIL_FOOD = :retail_food
+        RETAIL_FURNISHING = :retail_furnishing
+        RETAIL_HOME = :retail_home
+        RETAIL_NON_STORE = :retail_non_store
+        RETAIL_SPORTING = :retail_sporting
+        TRANSPORTATION = :transportation
+        TRAVEL = :travel
+        UTILITIES = :utilities
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The occupation of the individual.
+      module Occupation
+        extend ModernTreasury::Enum
+
+        CONSULTING = :consulting
+        EXECUTIVE = :executive
+        FINANCE_ACCOUNTING = :finance_accounting
+        FOOD_SERVICES = :food_services
+        GOVERNMENT = :government
+        HEALTHCARE = :healthcare
+        LEGAL_SERVICES = :legal_services
+        MANUFACTURING = :manufacturing
+        OTHER = :other
+        SALES = :sales
+        SCIENCE_ENGINEERING = :science_engineering
+        TECHNOLOGY = :technology
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The source of the individual's funds.
+      module SourceOfFunds
+        extend ModernTreasury::Enum
+
+        ALIMONY = :alimony
+        ANNUITY = :annuity
+        BUSINESS_OWNER = :business_owner
+        GENERAL_EMPLOYEE = :general_employee
+        GOVERNMENT_BENEFITS = :government_benefits
+        HOMEMAKER = :homemaker
+        INHERITANCE_GIFT = :inheritance_gift
+        INVESTMENT = :investment
+        LEGAL_SETTLEMENT = :legal_settlement
+        LOTTERY = :lottery
+        REAL_ESTATE = :real_estate
+        RETIRED = :retired
+        RETIREMENT = :retirement
+        SALARY = :salary
+        SELF_EMPLOYED = :self_employed
+        SENIOR_EXECUTIVE = :senior_executive
+        TRUST_INCOME = :trust_income
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The source of the individual's wealth.
+      module WealthSource
+        extend ModernTreasury::Enum
+
+        BUSINESS_SALE = :business_sale
+        FAMILY_SUPPORT = :family_support
+        GOVERNMENT_BENEFITS = :government_benefits
+        INHERITANCE = :inheritance
+        INVESTMENTS = :investments
+        OTHER = :other
+        RENTAL_INCOME = :rental_income
+        RETIREMENT = :retirement
+        SALARY = :salary
+        SELF_EMPLOYED = :self_employed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/page.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @example
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
+  #
+  # @example
+  #   page.auto_paging_each do |connection|
+  #     puts(connection)
+  #   end
+  #
+  # @example
+  #   connections =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
+  #
+  #   connections => Array
+  class Page < ::Array
+    include ModernTreasury::BasePage
+
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # @return [String]
+    attr_accessor :after_cursor
+
+    # @api private
+    #
+    # @param client [ModernTreasury::BaseClient]
+    # @param req [Hash{Symbol=>Object}]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param page_data [Hash{Symbol=>Object}]
+    def initialize(client:, req:, headers:, page_data:)
+      super
+      model = req.fetch(:model)
+
+      case page_data
+      in Array
+        replace(page_data.map { model.coerce(_1) })
+      else
+      end
+
+      @per_page = ModernTreasury::Util.coerce_integer(headers["X-Per-Page"])
+
+      @after_cursor = headers["X-After-Cursor"]&.to_s
+    end
+
+    # @return [Boolean]
+    def next_page?
+      !after_cursor.nil?
+    end
+
+    # @raise [ModernTreasury::HTTP::Error]
+    # @return [ModernTreasury::Page]
+    def next_page
+      unless next_page?
+        message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+        raise RuntimeError.new(message)
+      end
+
+      req = ModernTreasury::Util.deep_merge(@req, {query: {after_cursor: after_cursor}})
+      @client.request(req)
+    end
+
+    # @param blk [Proc]
+    def auto_paging_each(&blk)
+      unless block_given?
+        raise ArgumentError.new("A block must be given to ##{__method__}")
+      end
+      page = self
+      loop do
+        page.each { blk.call(_1) }
+        break unless page.next_page?
+        page = page.next_page
+      end
+    end
+
+    # @return [String]
+    def inspect
+      # rubocop:disable Layout/LineLength
+      "#<#{self.class}:0x#{object_id.to_s(16)} per_page=#{per_page.inspect} after_cursor=#{after_cursor.inspect}>"
+      # rubocop:enable Layout/LineLength
+    end
+  end
+end

data/lib/modern_treasury/pooled_net_requester.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @api private
+  class PooledNetRequester
+    # from the golang stdlib
+    #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+    KEEP_ALIVE_TIMEOUT = 30
+
+    class << self
+      # @api private
+      #
+      # @param url [URI::Generic]
+      #
+      # @return [Net::HTTP]
+      def connect(url)
+        port =
+          case [url.port, url.scheme]
+          in [Integer, _]
+            url.port
+          in [nil, "http" | "ws"]
+            Net::HTTP.http_default_port
+          in [nil, "https" | "wss"]
+            Net::HTTP.https_default_port
+          end
+
+        Net::HTTP.new(url.host, port).tap do
+          _1.use_ssl = %w[https wss].include?(url.scheme)
+          _1.max_retries = 0
+        end
+      end
+
+      # @api private
+      #
+      # @param conn [Net::HTTP]
+      # @param deadline [Float]
+      def calibrate_socket_timeout(conn, deadline)
+        timeout = deadline - ModernTreasury::Util.monotonic_secs
+        conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
+      end
+
+      # @api private
+      #
+      # @param request [Hash{Symbol=>Object}] .
+      #
+      #   @option request [Symbol] :method
+      #
+      #   @option request [URI::Generic] :url
+      #
+      #   @option request [Hash{String=>String}] :headers
+      #
+      # @param blk [Proc]
+      #
+      # @yieldparam [String]
+      # @return [Net::HTTPGenericRequest]
+      def build_request(request, &)
+        method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
+        req = Net::HTTPGenericRequest.new(
+          method.to_s.upcase,
+          !body.nil?,
+          method != :head,
+          url.to_s
+        )
+
+        headers.each { req[_1] = _2 }
+
+        case body
+        in nil
+          nil
+        in String
+          req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
+          req.body_stream = ModernTreasury::Util::ReadIOAdapter.new(body, &)
+        in StringIO
+          req["content-length"] ||= body.size.to_s unless req["transfer-encoding"]
+          req.body_stream = ModernTreasury::Util::ReadIOAdapter.new(body, &)
+        in IO | Enumerator
+          req["transfer-encoding"] ||= "chunked" unless req["content-length"]
+          req.body_stream = ModernTreasury::Util::ReadIOAdapter.new(body, &)
+        end
+
+        req
+      end
+    end
+
+    # @api private
+    #
+    # @param url [URI::Generic]
+    # @param deadline [Float]
+    # @param blk [Proc]
+    #
+    # @raise [Timeout::Error]
+    # @yieldparam [Net::HTTP]
+    private def with_pool(url, deadline:, &blk)
+      origin = ModernTreasury::Util.uri_origin(url)
+      timeout = deadline - ModernTreasury::Util.monotonic_secs
+      pool =
+        @mutex.synchronize do
+          @pools[origin] ||= ConnectionPool.new(size: @size) do
+            self.class.connect(url)
+          end
+        end
+
+      pool.with(timeout: timeout, &blk)
+    end
+
+    # @api private
+    #
+    # @param request [Hash{Symbol=>Object}] .
+    #
+    #   @option request [Symbol] :method
+    #
+    #   @option request [URI::Generic] :url
+    #
+    #   @option request [Hash{String=>String}] :headers
+    #
+    #   @option request [Object] :body
+    #
+    #   @option request [Float] :deadline
+    #
+    # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
+    def execute(request)
+      url, deadline = request.fetch_values(:url, :deadline)
+
+      eof = false
+      finished = false
+      enum = Enumerator.new do |y|
+        with_pool(url, deadline: deadline) do |conn|
+          next if finished
+
+          req = self.class.build_request(request) do
+            self.class.calibrate_socket_timeout(conn, deadline)
+          end
+
+          self.class.calibrate_socket_timeout(conn, deadline)
+          unless conn.started?
+            conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+            conn.start
+          end
+
+          self.class.calibrate_socket_timeout(conn, deadline)
+          conn.request(req) do |rsp|
+            y << [conn, req, rsp]
+            break if finished
+
+            rsp.read_body do |bytes|
+              y << bytes
+              break if finished
+
+              self.class.calibrate_socket_timeout(conn, deadline)
+            end
+            eof = true
+          end
+        end
+      rescue Timeout::Error
+        raise ModernTreasury::APITimeoutError
+      end
+
+      conn, _, response = enum.next
+      body = ModernTreasury::Util.fused_enum(enum, external: true) do
+        finished = true
+        tap do
+          enum.next
+        rescue StopIteration
+          nil
+        end
+        conn.finish if !eof && conn&.started?
+      end
+      [Integer(response.code), response, (response.body = body)]
+    end
+
+    # @api private
+    #
+    # @param size [Integer]
+    def initialize(size: Etc.nprocessors)
+      @mutex = Mutex.new
+      @size = size
+      @pools = {}
+    end
+  end
+end

data/lib/modern_treasury/request_options.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @api private
+  module RequestParameters
+    # @!parse
+    #   # Options to specify HTTP behaviour for this request.
+    #   # @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    #   attr_accessor :request_options
+
+    # @param mod [Module]
+    def self.included(mod)
+      return unless mod <= ModernTreasury::BaseModel
+
+      mod.extend(ModernTreasury::RequestParameters::Converter)
+      mod.optional(:request_options, ModernTreasury::RequestOptions)
+    end
+
+    # @api private
+    module Converter
+      # @api private
+      #
+      # @param params [Object]
+      #
+      # @return [Array(Object, Hash{Symbol=>Object})]
+      def dump_request(params)
+        case (dumped = dump(params))
+        in Hash
+          [dumped.except(:request_options), dumped[:request_options]]
+        else
+          [dumped, nil]
+        end
+      end
+    end
+  end
+
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  #   or override those provided at the client level.
+  #
+  #   When making a request, you can pass an actual {RequestOptions} instance, or
+  #   simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ModernTreasury::BaseModel
+    # @api private
+    #
+    # @param opts [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in ModernTreasury::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #     sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #     `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, ModernTreasury::HashOf[ModernTreasury::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #     `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, ModernTreasury::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #     generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, ModernTreasury::HashOf[ModernTreasury::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!parse
+    #   # Returns a new instance of RequestOptions.
+    #   #
+    #   # @param values [Hash{Symbol=>Object}]
+    #   #
+    #   def initialize(values = {}) = super
+  end
+end