modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/wealth_and_employment_details.rb

@@ -0,0 +1,436 @@
+# 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
+
+      # @abstract
+      #
+      # The employment status of the individual.
+      #
+      # @example
+      # ```ruby
+      # case employment_status
+      # in :employed
+      #   # ...
+      # in :retired
+      #   # ...
+      # in :self_employed
+      #   # ...
+      # in :student
+      #   # ...
+      # in :unemployed
+      #   # ...
+      # end
+      # ```
+      class EmploymentStatus < ModernTreasury::Enum
+        EMPLOYED = :employed
+        RETIRED = :retired
+        SELF_EMPLOYED = :self_employed
+        STUDENT = :student
+        UNEMPLOYED = :unemployed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # The source of the individual's income.
+      #
+      # @example
+      # ```ruby
+      # case income_source
+      # in :family_support
+      #   # ...
+      # in :government_benefits
+      #   # ...
+      # in :inheritance
+      #   # ...
+      # in :investments
+      #   # ...
+      # in :rental_income
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class IncomeSource < 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
+
+      # @abstract
+      #
+      # The industry of the individual.
+      #
+      # @example
+      # ```ruby
+      # case industry
+      # in :accounting
+      #   # ...
+      # in :agriculture
+      #   # ...
+      # in :automotive
+      #   # ...
+      # in :chemical_manufacturing
+      #   # ...
+      # in :construction
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class Industry < 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
+
+      # @abstract
+      #
+      # The occupation of the individual.
+      #
+      # @example
+      # ```ruby
+      # case occupation
+      # in :consulting
+      #   # ...
+      # in :executive
+      #   # ...
+      # in :finance_accounting
+      #   # ...
+      # in :food_services
+      #   # ...
+      # in :government
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class Occupation < 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
+
+      # @abstract
+      #
+      # The source of the individual's funds.
+      #
+      # @example
+      # ```ruby
+      # case source_of_funds
+      # in :alimony
+      #   # ...
+      # in :annuity
+      #   # ...
+      # in :business_owner
+      #   # ...
+      # in :general_employee
+      #   # ...
+      # in :government_benefits
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class SourceOfFunds < 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
+
+      # @abstract
+      #
+      # The source of the individual's wealth.
+      #
+      # @example
+      # ```ruby
+      # case wealth_source
+      # in :business_sale
+      #   # ...
+      # in :family_support
+      #   # ...
+      # in :government_benefits
+      #   # ...
+      # in :inheritance
+      #   # ...
+      # in :investments
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class WealthSource < 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,94 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @example
+  # ```ruby
+  # if page.has_next?
+  #   page = page.next_page
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # page.auto_paging_each do |item|
+  # #   item ...
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # items = page.to_enum.take(2)
+  #
+  # items => Array
+  # ```
+  class Page < ::Array
+    include ModernTreasury::BasePage
+
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # @return [String]
+    attr_accessor :after_cursor
+
+    # @private
+    #
+    # @param client [ModernTreasury::BaseClient]
+    # @param req [Hash{Symbol=>Object}]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param unwrapped [Hash{Symbol=>Object}]
+    #
+    def initialize(client:, req:, headers:, unwrapped:)
+      @client = client
+      @req = req
+      model = req.fetch(:model)
+
+      case unwrapped
+      in Array
+        super(unwrapped&.map { model.coerce(_1) })
+      else
+        super([])
+      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?
+        raise RuntimeError.new("No more pages available; please check #next_page? before calling #next_page")
+      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 #auto_paging_each")
+      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
+      "#<#{self.class}:0x#{object_id.to_s(16)} per_page=#{per_page.inspect} after_cursor=#{after_cursor.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/pooled_net_requester.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @private
+  #
+  class PooledNetRequester
+    class << self
+      # @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
+
+      # @private
+      #
+      # @param conn [Net::HTTP]
+      # @param deadline [Float]
+      #
+      private def calibrate_socket_timeout(conn, deadline)
+        timeout = deadline - ModernTreasury::Util.monotonic_secs
+        conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
+      end
+
+      # @private
+      #
+      # @param conn [Net::HTTP]
+      # @param req [Net::HTTPGenericRequest]
+      # @param deadline [Float]
+      # @param blk [Proc]
+      #
+      def transport(conn, req, deadline, &blk)
+        unless conn.started?
+          conn.open_timeout = deadline - ModernTreasury::Util.monotonic_secs
+          conn.start
+        end
+
+        calibrate_socket_timeout(conn, deadline)
+        conn.request(req) do |rsp|
+          blk.call(rsp)
+          rsp.read_body do |bytes|
+            blk.call(bytes)
+            calibrate_socket_timeout(conn, deadline)
+          end
+        end
+      end
+    end
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param streaming [Boolean]
+    # @param blk [Proc]
+    #
+    private def with_pool(url, streaming:, &blk)
+      origin = ModernTreasury::Util.uri_origin(url)
+      th = Thread.current
+      key = :"#{object_id}-#{self.class.name}-connection_in_use_for_#{origin}"
+
+      if th[key] || streaming
+        return Enumerator.new do |y|
+          conn = self.class.connect(url)
+          blk.call(conn, y)
+        end
+      end
+
+      pool =
+        @mutex.synchronize do
+          @pools[origin] ||= ConnectionPool.new(size: Etc.nprocessors) do
+            self.class.connect(url)
+          end
+        end
+
+      Enumerator.new do |y|
+        pool.with do |conn|
+          th[key] = true
+
+          blk.call(conn, y)
+          # rubocop:disable Lint/RescueException
+        rescue Exception => e
+          # rubocop:enable Lint/RescueException
+          # should close connection on all errors to ensure no invalid state persists
+          conn.finish if conn.started?
+          raise e
+        ensure
+          th[key] = nil
+        end
+      end
+    end
+
+    # @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 [Boolean] :streaming
+    #
+    #   @option request [Integer] :max_retries
+    #
+    #   @option request [Float] :deadline
+    #
+    # @return [Array(Net::HTTPResponse, Enumerable)]
+    #
+    def execute(request)
+      method, url, headers, body, deadline = request.fetch_values(:method, :url, :headers, :body, :deadline)
+      streaming = request.fetch(:streaming)
+
+      req = Net::HTTPGenericRequest.new(
+        method.to_s.upcase,
+        !body.nil?,
+        method != :head,
+        url.to_s
+      )
+
+      headers.each { req[_1] = _2 }
+      case body
+      in nil
+      in String
+        req.body = body
+      in IO | StringIO
+        body.rewind
+        req.body_stream = body
+      end
+
+      enum =
+        with_pool(url, streaming: streaming) do |conn, y|
+          self.class.transport(conn, req, deadline, &y)
+        end
+
+      enum = streaming ? enum.lazy : enum.to_a
+      response = enum.take(1).first
+      [response, (response.body = enum.drop(1))]
+    end
+
+    def initialize
+      @mutex = Mutex.new
+      @pools = {}
+    end
+  end
+end