eodhd.rb 0.18.1 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ab9dcc933d673f6d350ed5566a496ca798feec8c4ed8e7b28461957090cbdd0
-  data.tar.gz: 55ee2522e79c294c47b1305fc59c7971c8fe2af31d307cae76246736eaea5b36
+  metadata.gz: 5a140246535718662c35b910ddc1fb1bdb601687fdaf714549c73851e4069600
+  data.tar.gz: c8d5dc8e3c0f5fa66baed1b3112b00edf957f80199e05e54246f0d710cf63949
 SHA512:
-  metadata.gz: f6baa626d45145cf812286efdba98fffe0df2e627ace13e2d63b5237d0131f088031ca34055543b96c3a05a944e5a2cd3ee8ee1c2dad4e5c647079b8213c3e8e
-  data.tar.gz: 943d415c6809d4cbb2c1438fb6491c72c4b0cb84b3a418bb06055f7e80b788348d2d2a1484887430269f631fe16c00c1cba1be1950885fc754fbdfc226620cf2
+  metadata.gz: 2b42a918bb3337b66fe75a8c2f9eb837f059892b23f8348d768cf85dd9543eeeff72ead4a3c9e6dd7d1655aa5308a8bdbe49abacba4c4c80523eaad05eb9badf
+  data.tar.gz: ae7b65fb37e8945e06b8b4aee42acd002e1b5574e9e6385582f9eafd4438f75ac0274c0e0fd86a659d15de9d66141790170c2a41ea9c382d55cc4d35e14b5e1c

data/CHANGELOG

@@ -1,5 +1,34 @@
 # eodhd.rb/CHANGELOG
 
+## [0.19.1] - 2026-07-19, blank lines before the code fences in the README
+- ~ README.md: + a blank line before each code fence, without which the highlighting does not render.
+- ~ Eodhd/VERSION: /0.19.0/0.19.1/
+
+## [0.19.0] - 2026-07-19, complete the fundamentals model wrapping
+- + Eodhd::Fundamentals::Financials::BalanceSheet::Entry: Typed entry for a balance sheet period (64 fields).
+- + Eodhd::Fundamentals::Financials::IncomeStatement::Entry: Typed entry for an income statement period (34 fields).
+- + Eodhd::Fundamentals::Financials::CashFlow::Entry: Typed entry for a cash flow period (32 fields).
+- + Eodhd::Fundamentals::Earnings::AnnualEntry
+- + Eodhd::Fundamentals::Earnings::HistoryEntry
+- + Eodhd::Fundamentals::Earnings::TrendEntry
+- + Eodhd::Fundamentals::Holders::Institution: Typed entry for an institutional holder.
+- + Eodhd::Fundamentals::Holders::Fund: Typed entry for a fund holder.
+- + Eodhd::Fundamentals::InsiderTransaction: Typed entry for an insider transaction.
+- + Eodhd::Fundamentals::OutstandingShares::Entry: Typed entry for an outstanding shares data point.
+- + Eodhd::Fundamentals::OutstandingShares: Wraps annual and quarterly OutstandingShares::Entry arrays.
+- + Eodhd::Fundamentals::Financials::BalanceSheet
+- + Eodhd::Fundamentals::Financials::IncomeStatement
+- + Eodhd::Fundamentals::Financials::CashFlow
+- ~ Eodhd::Fundamentals::Financials: Build BalanceSheet/IncomeStatement/CashFlow instead of the shared Statement.
+- ~ Eodhd::Fundamentals::Financials::BalanceSheet#yearly, #quarterly: Now sorted arrays of typed entries, was raw hashes.
+- ~ Eodhd::Fundamentals::Earnings#annual, #history, #trend: Now sorted arrays of typed entries, was raw hashes.
+- ~ Eodhd::Fundamentals::Holders#institutions, #funds: Now arrays of typed entries, was raw hashes.
+- ~ Eodhd::Fundamentals#insider_transactions: Now a sorted array of InsiderTransaction, was a raw hash.
+- ~ Eodhd::Fundamentals#outstanding_shares: Now an OutstandingShares object, was a raw hash.
+- + test/Eodhd/Fundamentals_test.rb: Cover the newly wrapped entry types and collections.
+- - Eodhd::Fundamentals::Financials::Statement: Replaced by the three per-statement classes.
+- ~ Eodhd/VERSION: /0.18.1/0.19.0/
+
 ## [0.18.1] - 2026-07-19, urlencode helper naming consistency
 - /Thoran::String::UrlEncode#url_encode/Thoran::String::Urlencode#urlencode/ (url_encode kept as an alias).
 - /Thoran::Hash::XWwwFormUrlEncode#x_www_form_url_encode/Thoran::Hash::XWwwFormUrlencode#x_www_form_urlencode/ (x_www_form_url_encode kept as an alias).

data/README.md

@@ -7,14 +7,19 @@ Access the eodhd.com API with Ruby.
 ## Installation
 
 Add this line to your application's Gemfile:
+
 ```ruby
   gem 'eodhd.rb'
 ```
+
 And then execute:
+
 ```bash
   $ bundle
 ```
+
 Or install it yourself as:
+
 ```bash
   $ gem install eodhd.rb
 ```
@@ -22,17 +27,20 @@ Or install it yourself as:
 ## Usage
 
 ### Setup
+
 ```ruby
 api_token = 'api_token'
 eodhd = Eodhd.new(api_token: api_token)
 ```
 
 ### List of Exchanges
+
 ```ruby
 eodhd.exchanges
 ```
 
 ### List of Exchange Symbols
+
 ```ruby
 exchange = eodhd.exchanges.first
 
@@ -42,6 +50,7 @@ eodhd.exchange_symbols(exchange_code: exchange.code)
 ```
 
 ### Retrieve EOD Data For One Symbol
+
 ```ruby
 exchange = eodhd.exchanges.first
 exchange_symbol = eodhd.exchange_symbols(exchange: exchange).first
@@ -56,6 +65,7 @@ eodhd.eod_data(exchange_code: exchange.code, symbol: exchange_symbol.code)
 ```
 
 ### Retrieve EOD Data For Multiple Symbols For One Date
+
 ```ruby
 exchange = eodhd.exchanges.first
 
@@ -65,6 +75,7 @@ eodhd.eod_bulk_last_day(exchange_code: exchange.code, date: Date.today)
 ```
 
 ### Retrieve Intraday Data
+
 ```ruby
 eodhd.intraday(symbol: 'AAPL', exchange_code: 'US', interval: '5m')
 # OR with date range (from and to are Unix timestamps)
@@ -72,6 +83,7 @@ eodhd.intraday(symbol: 'AAPL', exchange_code: 'US', interval: '1h', from: 169611
 ```
 
 ### Retrieve Fundamental Data
+
 ```ruby
 fd = eodhd.fundamentals(exchange_code: 'US', symbol: 'AAPL')
 
@@ -109,6 +121,7 @@ fd.earnings.annual
 ```
 
 #### Use the filter parameter to request only specific sections
+
 ```ruby
 eodhd.fundamentals(exchange_code: 'US', symbol: 'AAPL', filter: 'General')
 eodhd.fundamentals(exchange_code: 'US', symbol: 'AAPL', filter: 'Financials::Income_Statement::quarterly')
@@ -117,6 +130,7 @@ eodhd.fundamentals(exchange_code: 'US', symbol: 'AAPL', filter: 'Financials::Inc
 ### WebSockets
 
 #### Streaming requires a callable consumer (a proc, lambda, or any object responding to `call`) to handle incoming data frames
+
 ```ruby
 consumer = ->(data){puts data}
 eodhd = Eodhd.new(api_token: api_token, consumer: consumer)
@@ -128,6 +142,7 @@ eodhd.crypto_stream('BTC-USD')
 ```
 
 #### Or use the general interface
+
 ```ruby
 eodhd.stream(asset_class: 'us', symbols: 'AAPL,MSFT')
 ```

data/lib/Eodhd/Fundamentals/Earnings/AnnualEntry.rb

@@ -0,0 +1,21 @@
+# Eodhd/Fundamentals/Earnings/AnnualEntry.rb
+# Eodhd::Fundamentals::Earnings::AnnualEntry
+
+class Eodhd
+  class Fundamentals
+    class Earnings
+      class AnnualEntry
+        attr_reader\
+          :date,
+          :eps_actual
+
+        private
+
+        def initialize(data)
+          @date = data['date']
+          @eps_actual = data['epsActual']
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Earnings/HistoryEntry.rb

@@ -0,0 +1,33 @@
+# Eodhd/Fundamentals/Earnings/HistoryEntry.rb
+# Eodhd::Fundamentals::Earnings::HistoryEntry
+
+class Eodhd
+  class Fundamentals
+    class Earnings
+      class HistoryEntry
+        attr_reader\
+          :report_date,
+          :date,
+          :before_after_market,
+          :currency,
+          :eps_actual,
+          :eps_estimate,
+          :eps_difference,
+          :surprise_percent
+
+        private
+
+        def initialize(data)
+          @report_date = data['reportDate']
+          @date = data['date']
+          @before_after_market = data['beforeAfterMarket']
+          @currency = data['currency']
+          @eps_actual = data['epsActual']
+          @eps_estimate = data['epsEstimate']
+          @eps_difference = data['epsDifference']
+          @surprise_percent = data['surprisePercent']
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Earnings/TrendEntry.rb

@@ -0,0 +1,65 @@
+# Eodhd/Fundamentals/Earnings/TrendEntry.rb
+# Eodhd::Fundamentals::Earnings::TrendEntry
+
+class Eodhd
+  class Fundamentals
+    class Earnings
+      class TrendEntry
+        attr_reader\
+          :date,
+          :period,
+          :growth,
+          :earnings_estimate_avg,
+          :earnings_estimate_low,
+          :earnings_estimate_high,
+          :earnings_estimate_year_ago_eps,
+          :earnings_estimate_number_of_analysts,
+          :earnings_estimate_growth,
+          :revenue_estimate_avg,
+          :revenue_estimate_low,
+          :revenue_estimate_high,
+          :revenue_estimate_year_ago_eps,
+          :revenue_estimate_number_of_analysts,
+          :revenue_estimate_growth,
+          :eps_trend_current,
+          :eps_trend_7_days_ago,
+          :eps_trend_30_days_ago,
+          :eps_trend_60_days_ago,
+          :eps_trend_90_days_ago,
+          :eps_revisions_up_last_7_days,
+          :eps_revisions_up_last_30_days,
+          :eps_revisions_down_last_7_days,
+          :eps_revisions_down_last_30_days
+
+        private
+
+        def initialize(data)
+          @date = data['date']
+          @period = data['period']
+          @growth = data['growth']
+          @earnings_estimate_avg = data['earningsEstimateAvg']
+          @earnings_estimate_low = data['earningsEstimateLow']
+          @earnings_estimate_high = data['earningsEstimateHigh']
+          @earnings_estimate_year_ago_eps = data['earningsEstimateYearAgoEps']
+          @earnings_estimate_number_of_analysts = data['earningsEstimateNumberOfAnalysts']
+          @earnings_estimate_growth = data['earningsEstimateGrowth']
+          @revenue_estimate_avg = data['revenueEstimateAvg']
+          @revenue_estimate_low = data['revenueEstimateLow']
+          @revenue_estimate_high = data['revenueEstimateHigh']
+          @revenue_estimate_year_ago_eps = data['revenueEstimateYearAgoEps']
+          @revenue_estimate_number_of_analysts = data['revenueEstimateNumberOfAnalysts']
+          @revenue_estimate_growth = data['revenueEstimateGrowth']
+          @eps_trend_current = data['epsTrendCurrent']
+          @eps_trend_7_days_ago = data['epsTrend7daysAgo']
+          @eps_trend_30_days_ago = data['epsTrend30daysAgo']
+          @eps_trend_60_days_ago = data['epsTrend60daysAgo']
+          @eps_trend_90_days_ago = data['epsTrend90daysAgo']
+          @eps_revisions_up_last_7_days = data['epsRevisionsUpLast7days']
+          @eps_revisions_up_last_30_days = data['epsRevisionsUpLast30days']
+          @eps_revisions_down_last_7_days = data['epsRevisionsDownLast7days']
+          @eps_revisions_down_last_30_days = data['epsRevisionsDownLast30days']
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Earnings.rb

@@ -1,6 +1,10 @@
 # Eodhd/Fundamentals/Earnings.rb
 # Eodhd::Fundamentals::Earnings
 
+require_relative './Earnings/AnnualEntry'
+require_relative './Earnings/HistoryEntry'
+require_relative './Earnings/TrendEntry'
+
 class Eodhd
   class Fundamentals
     class Earnings
@@ -12,9 +16,14 @@ class Eodhd
       private
 
       def initialize(data)
-        @history = data['History']
-        @trend = data['Trend']
-        @annual = data['Annual']
+        @annual = wrap(data['Annual'], AnnualEntry)
+        @history = wrap(data['History'], HistoryEntry)
+        @trend = wrap(data['Trend'], TrendEntry)
+      end
+
+      def wrap(entries, entry_class)
+        return [] unless entries
+        entries.values.map{|entry| entry_class.new(entry)}.sort_by(&:date)
       end
     end
   end

data/lib/Eodhd/Fundamentals/Financials/BalanceSheet/Entry.rb

@@ -0,0 +1,147 @@
+# Eodhd/Fundamentals/Financials/BalanceSheet/Entry.rb
+# Eodhd::Fundamentals::Financials::BalanceSheet::Entry
+
+class Eodhd
+  class Fundamentals
+    class Financials
+      class BalanceSheet
+        class Entry
+          attr_reader\
+            :date,
+            :filing_date,
+            :currency_symbol,
+            :total_assets,
+            :intangible_assets,
+            :earning_assets,
+            :other_current_assets,
+            :total_liabilities,
+            :total_stockholder_equity,
+            :deferred_long_term_liabilities,
+            :other_current_liabilities,
+            :common_stock,
+            :capital_stock,
+            :retained_earnings,
+            :other_liabilities,
+            :goodwill,
+            :other_assets,
+            :cash,
+            :cash_and_equivalents,
+            :total_current_liabilities,
+            :current_deferred_revenue,
+            :net_debt,
+            :short_term_debt,
+            :short_long_term_debt,
+            :short_long_term_debt_total,
+            :other_stockholder_equity,
+            :property_plant_equipment,
+            :total_current_assets,
+            :long_term_investments,
+            :net_tangible_assets,
+            :short_term_investments,
+            :net_receivables,
+            :long_term_debt,
+            :inventory,
+            :accounts_payable,
+            :total_permanent_equity,
+            :noncontrolling_interest_in_consolidated_entity,
+            :temporary_equity_redeemable_noncontrolling_interests,
+            :accumulated_other_comprehensive_income,
+            :additional_paid_in_capital,
+            :common_stock_total_equity,
+            :preferred_stock_total_equity,
+            :retained_earnings_total_equity,
+            :treasury_stock,
+            :accumulated_amortization,
+            :non_current_assets_other,
+            :deferred_long_term_asset_charges,
+            :non_current_assets_total,
+            :capital_lease_obligations,
+            :long_term_debt_total,
+            :non_current_liabilities_other,
+            :non_current_liabilities_total,
+            :negative_goodwill,
+            :warrants,
+            :preferred_stock_redeemable,
+            :capital_surplus,
+            :liabilities_and_stockholders_equity,
+            :cash_and_short_term_investments,
+            :property_plant_and_equipment_gross,
+            :property_plant_and_equipment_net,
+            :accumulated_depreciation,
+            :net_working_capital,
+            :net_invested_capital,
+            :common_stock_shares_outstanding
+
+          private
+
+          def initialize(data)
+            @date = data['date']
+            @filing_date = data['filing_date']
+            @currency_symbol = data['currency_symbol']
+            @total_assets = data['totalAssets']
+            @intangible_assets = data['intangibleAssets']
+            @earning_assets = data['earningAssets']
+            @other_current_assets = data['otherCurrentAssets']
+            @total_liabilities = data['totalLiab']
+            @total_stockholder_equity = data['totalStockholderEquity']
+            @deferred_long_term_liabilities = data['deferredLongTermLiab']
+            @other_current_liabilities = data['otherCurrentLiab']
+            @common_stock = data['commonStock']
+            @capital_stock = data['capitalStock']
+            @retained_earnings = data['retainedEarnings']
+            @other_liabilities = data['otherLiab']
+            @goodwill = data['goodWill']
+            @other_assets = data['otherAssets']
+            @cash = data['cash']
+            @cash_and_equivalents = data['cashAndEquivalents']
+            @total_current_liabilities = data['totalCurrentLiabilities']
+            @current_deferred_revenue = data['currentDeferredRevenue']
+            @net_debt = data['netDebt']
+            @short_term_debt = data['shortTermDebt']
+            @short_long_term_debt = data['shortLongTermDebt']
+            @short_long_term_debt_total = data['shortLongTermDebtTotal']
+            @other_stockholder_equity = data['otherStockholderEquity']
+            @property_plant_equipment = data['propertyPlantEquipment']
+            @total_current_assets = data['totalCurrentAssets']
+            @long_term_investments = data['longTermInvestments']
+            @net_tangible_assets = data['netTangibleAssets']
+            @short_term_investments = data['shortTermInvestments']
+            @net_receivables = data['netReceivables']
+            @long_term_debt = data['longTermDebt']
+            @inventory = data['inventory']
+            @accounts_payable = data['accountsPayable']
+            @total_permanent_equity = data['totalPermanentEquity']
+            @noncontrolling_interest_in_consolidated_entity = data['noncontrollingInterestInConsolidatedEntity']
+            @temporary_equity_redeemable_noncontrolling_interests = data['temporaryEquityRedeemableNoncontrollingInterests']
+            @accumulated_other_comprehensive_income = data['accumulatedOtherComprehensiveIncome']
+            @additional_paid_in_capital = data['additionalPaidInCapital']
+            @common_stock_total_equity = data['commonStockTotalEquity']
+            @preferred_stock_total_equity = data['preferredStockTotalEquity']
+            @retained_earnings_total_equity = data['retainedEarningsTotalEquity']
+            @treasury_stock = data['treasuryStock']
+            @accumulated_amortization = data['accumulatedAmortization']
+            @non_current_assets_other = data['nonCurrrentAssetsOther']
+            @deferred_long_term_asset_charges = data['deferredLongTermAssetCharges']
+            @non_current_assets_total = data['nonCurrentAssetsTotal']
+            @capital_lease_obligations = data['capitalLeaseObligations']
+            @long_term_debt_total = data['longTermDebtTotal']
+            @non_current_liabilities_other = data['nonCurrentLiabilitiesOther']
+            @non_current_liabilities_total = data['nonCurrentLiabilitiesTotal']
+            @negative_goodwill = data['negativeGoodwill']
+            @warrants = data['warrants']
+            @preferred_stock_redeemable = data['preferredStockRedeemable']
+            @capital_surplus = data['capitalSurpluse']
+            @liabilities_and_stockholders_equity = data['liabilitiesAndStockholdersEquity']
+            @cash_and_short_term_investments = data['cashAndShortTermInvestments']
+            @property_plant_and_equipment_gross = data['propertyPlantAndEquipmentGross']
+            @property_plant_and_equipment_net = data['propertyPlantAndEquipmentNet']
+            @accumulated_depreciation = data['accumulatedDepreciation']
+            @net_working_capital = data['netWorkingCapital']
+            @net_invested_capital = data['netInvestedCapital']
+            @common_stock_shares_outstanding = data['commonStockSharesOutstanding']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Financials/BalanceSheet.rb

@@ -0,0 +1,28 @@
+# Eodhd/Fundamentals/Financials/BalanceSheet.rb
+# Eodhd::Fundamentals::Financials::BalanceSheet
+
+require_relative './BalanceSheet/Entry'
+
+class Eodhd
+  class Fundamentals
+    class Financials
+      class BalanceSheet
+        attr_reader\
+          :quarterly,
+          :yearly
+
+        private
+
+        def initialize(data)
+          @yearly = wrap(data['yearly'])
+          @quarterly = wrap(data['quarterly'])
+        end
+
+        def wrap(entries)
+          return [] unless entries
+          entries.values.map{|entry| Entry.new(entry)}.sort_by(&:date)
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Financials/CashFlow/Entry.rb

@@ -0,0 +1,83 @@
+# Eodhd/Fundamentals/Financials/CashFlow/Entry.rb
+# Eodhd::Fundamentals::Financials::CashFlow::Entry
+
+class Eodhd
+  class Fundamentals
+    class Financials
+      class CashFlow
+        class Entry
+          attr_reader\
+            :date,
+            :filing_date,
+            :currency_symbol,
+            :investments,
+            :change_to_liabilities,
+            :total_cashflows_from_investing_activities,
+            :net_borrowings,
+            :total_cash_from_financing_activities,
+            :change_to_operating_activities,
+            :net_income,
+            :change_in_cash,
+            :begin_period_cash_flow,
+            :end_period_cash_flow,
+            :total_cash_from_operating_activities,
+            :issuance_of_capital_stock,
+            :depreciation,
+            :other_cashflows_from_investing_activities,
+            :dividends_paid,
+            :change_to_inventory,
+            :change_to_account_receivables,
+            :sale_purchase_of_stock,
+            :other_cashflows_from_financing_activities,
+            :change_to_netincome,
+            :capital_expenditures,
+            :change_receivables,
+            :cash_flows_other_operating,
+            :exchange_rate_changes,
+            :cash_and_cash_equivalents_changes,
+            :change_in_working_capital,
+            :stock_based_compensation,
+            :other_non_cash_items,
+            :free_cash_flow
+
+          private
+
+          def initialize(data)
+            @date = data['date']
+            @filing_date = data['filing_date']
+            @currency_symbol = data['currency_symbol']
+            @investments = data['investments']
+            @change_to_liabilities = data['changeToLiabilities']
+            @total_cashflows_from_investing_activities = data['totalCashflowsFromInvestingActivities']
+            @net_borrowings = data['netBorrowings']
+            @total_cash_from_financing_activities = data['totalCashFromFinancingActivities']
+            @change_to_operating_activities = data['changeToOperatingActivities']
+            @net_income = data['netIncome']
+            @change_in_cash = data['changeInCash']
+            @begin_period_cash_flow = data['beginPeriodCashFlow']
+            @end_period_cash_flow = data['endPeriodCashFlow']
+            @total_cash_from_operating_activities = data['totalCashFromOperatingActivities']
+            @issuance_of_capital_stock = data['issuanceOfCapitalStock']
+            @depreciation = data['depreciation']
+            @other_cashflows_from_investing_activities = data['otherCashflowsFromInvestingActivities']
+            @dividends_paid = data['dividendsPaid']
+            @change_to_inventory = data['changeToInventory']
+            @change_to_account_receivables = data['changeToAccountReceivables']
+            @sale_purchase_of_stock = data['salePurchaseOfStock']
+            @other_cashflows_from_financing_activities = data['otherCashflowsFromFinancingActivities']
+            @change_to_netincome = data['changeToNetincome']
+            @capital_expenditures = data['capitalExpenditures']
+            @change_receivables = data['changeReceivables']
+            @cash_flows_other_operating = data['cashFlowsOtherOperating']
+            @exchange_rate_changes = data['exchangeRateChanges']
+            @cash_and_cash_equivalents_changes = data['cashAndCashEquivalentsChanges']
+            @change_in_working_capital = data['changeInWorkingCapital']
+            @stock_based_compensation = data['stockBasedCompensation']
+            @other_non_cash_items = data['otherNonCashItems']
+            @free_cash_flow = data['freeCashFlow']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Financials/CashFlow.rb

@@ -0,0 +1,28 @@
+# Eodhd/Fundamentals/Financials/CashFlow.rb
+# Eodhd::Fundamentals::Financials::CashFlow
+
+require_relative './CashFlow/Entry'
+
+class Eodhd
+  class Fundamentals
+    class Financials
+      class CashFlow
+        attr_reader\
+          :quarterly,
+          :yearly
+
+        private
+
+        def initialize(data)
+          @yearly = wrap(data['yearly'])
+          @quarterly = wrap(data['quarterly'])
+        end
+
+        def wrap(entries)
+          return [] unless entries
+          entries.values.map{|entry| Entry.new(entry)}.sort_by(&:date)
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Financials/IncomeStatement/Entry.rb

@@ -0,0 +1,87 @@
+# Eodhd/Fundamentals/Financials/IncomeStatement/Entry.rb
+# Eodhd::Fundamentals::Financials::IncomeStatement::Entry
+
+class Eodhd
+  class Fundamentals
+    class Financials
+      class IncomeStatement
+        class Entry
+          attr_reader\
+            :date,
+            :filing_date,
+            :currency_symbol,
+            :research_development,
+            :effect_of_accounting_charges,
+            :income_before_tax,
+            :minority_interest,
+            :net_income,
+            :selling_general_administrative,
+            :selling_and_marketing_expenses,
+            :gross_profit,
+            :reconciled_depreciation,
+            :ebit,
+            :ebitda,
+            :depreciation_and_amortization,
+            :non_operating_income_net_other,
+            :operating_income,
+            :other_operating_expenses,
+            :interest_expense,
+            :tax_provision,
+            :interest_income,
+            :net_interest_income,
+            :extraordinary_items,
+            :non_recurring,
+            :other_items,
+            :income_tax_expense,
+            :total_revenue,
+            :total_operating_expenses,
+            :cost_of_revenue,
+            :total_other_income_expense_net,
+            :discontinued_operations,
+            :net_income_from_continuing_operations,
+            :net_income_applicable_to_common_shares,
+            :preferred_stock_and_other_adjustments
+
+          private
+
+          def initialize(data)
+            @date = data['date']
+            @filing_date = data['filing_date']
+            @currency_symbol = data['currency_symbol']
+            @research_development = data['researchDevelopment']
+            @effect_of_accounting_charges = data['effectOfAccountingCharges']
+            @income_before_tax = data['incomeBeforeTax']
+            @minority_interest = data['minorityInterest']
+            @net_income = data['netIncome']
+            @selling_general_administrative = data['sellingGeneralAdministrative']
+            @selling_and_marketing_expenses = data['sellingAndMarketingExpenses']
+            @gross_profit = data['grossProfit']
+            @reconciled_depreciation = data['reconciledDepreciation']
+            @ebit = data['ebit']
+            @ebitda = data['ebitda']
+            @depreciation_and_amortization = data['depreciationAndAmortization']
+            @non_operating_income_net_other = data['nonOperatingIncomeNetOther']
+            @operating_income = data['operatingIncome']
+            @other_operating_expenses = data['otherOperatingExpenses']
+            @interest_expense = data['interestExpense']
+            @tax_provision = data['taxProvision']
+            @interest_income = data['interestIncome']
+            @net_interest_income = data['netInterestIncome']
+            @extraordinary_items = data['extraordinaryItems']
+            @non_recurring = data['nonRecurring']
+            @other_items = data['otherItems']
+            @income_tax_expense = data['incomeTaxExpense']
+            @total_revenue = data['totalRevenue']
+            @total_operating_expenses = data['totalOperatingExpenses']
+            @cost_of_revenue = data['costOfRevenue']
+            @total_other_income_expense_net = data['totalOtherIncomeExpenseNet']
+            @discontinued_operations = data['discontinuedOperations']
+            @net_income_from_continuing_operations = data['netIncomeFromContinuingOps']
+            @net_income_applicable_to_common_shares = data['netIncomeApplicableToCommonShares']
+            @preferred_stock_and_other_adjustments = data['preferredStockAndOtherAdjustments']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Financials/IncomeStatement.rb

@@ -0,0 +1,28 @@
+# Eodhd/Fundamentals/Financials/IncomeStatement.rb
+# Eodhd::Fundamentals::Financials::IncomeStatement
+
+require_relative './IncomeStatement/Entry'
+
+class Eodhd
+  class Fundamentals
+    class Financials
+      class IncomeStatement
+        attr_reader\
+          :quarterly,
+          :yearly
+
+        private
+
+        def initialize(data)
+          @yearly = wrap(data['yearly'])
+          @quarterly = wrap(data['quarterly'])
+        end
+
+        def wrap(entries)
+          return [] unless entries
+          entries.values.map{|entry| Entry.new(entry)}.sort_by(&:date)
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Financials.rb

@@ -1,7 +1,9 @@
 # Eodhd/Fundamentals/Financials.rb
 # Eodhd::Fundamentals::Financials
 
-require_relative './Financials/Statement'
+require_relative './Financials/BalanceSheet'
+require_relative './Financials/CashFlow'
+require_relative './Financials/IncomeStatement'
 
 class Eodhd
   class Fundamentals
@@ -14,9 +16,9 @@ class Eodhd
       private
 
       def initialize(data)
-        @income_statement = Statement.new(data['Income_Statement']) if data['Income_Statement']
-        @balance_sheet = Statement.new(data['Balance_Sheet']) if data['Balance_Sheet']
-        @cash_flow = Statement.new(data['Cash_Flow']) if data['Cash_Flow']
+        @income_statement = IncomeStatement.new(data['Income_Statement']) if data['Income_Statement']
+        @balance_sheet = BalanceSheet.new(data['Balance_Sheet']) if data['Balance_Sheet']
+        @cash_flow = CashFlow.new(data['Cash_Flow']) if data['Cash_Flow']
       end
     end
   end

data/lib/Eodhd/Fundamentals/Holders/Fund.rb

@@ -0,0 +1,31 @@
+# Eodhd/Fundamentals/Holders/Fund.rb
+# Eodhd::Fundamentals::Holders::Fund
+
+class Eodhd
+  class Fundamentals
+    class Holders
+      class Fund
+        attr_reader\
+          :name,
+          :date,
+          :total_shares,
+          :total_assets,
+          :current_shares,
+          :change,
+          :change_percent
+
+        private
+
+        def initialize(data)
+          @name = data['name']
+          @date = data['date']
+          @total_shares = data['totalShares']
+          @total_assets = data['totalAssets']
+          @current_shares = data['currentShares']
+          @change = data['change']
+          @change_percent = data['change_p']
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Holders/Institution.rb

@@ -0,0 +1,31 @@
+# Eodhd/Fundamentals/Holders/Institution.rb
+# Eodhd::Fundamentals::Holders::Institution
+
+class Eodhd
+  class Fundamentals
+    class Holders
+      class Institution
+        attr_reader\
+          :name,
+          :date,
+          :total_shares,
+          :total_assets,
+          :current_shares,
+          :change,
+          :change_percent
+
+        private
+
+        def initialize(data)
+          @name = data['name']
+          @date = data['date']
+          @total_shares = data['totalShares']
+          @total_assets = data['totalAssets']
+          @current_shares = data['currentShares']
+          @change = data['change']
+          @change_percent = data['change_p']
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/Holders.rb

@@ -1,6 +1,9 @@
 # Eodhd/Fundamentals/Holders.rb
 # Eodhd::Fundamentals::Holders
 
+require_relative './Holders/Institution'
+require_relative './Holders/Fund'
+
 class Eodhd
   class Fundamentals
     class Holders
@@ -11,8 +14,13 @@ class Eodhd
       private
 
       def initialize(data)
-        @institutions = data['Institutions']
-        @funds = data['Funds']
+        @institutions = wrap(data['Institutions'], Institution)
+        @funds = wrap(data['Funds'], Fund)
+      end
+
+      def wrap(entries, entry_class)
+        return [] unless entries
+        entries.values.map{|entry| entry_class.new(entry)}
       end
     end
   end

data/lib/Eodhd/Fundamentals/InsiderTransaction.rb

@@ -0,0 +1,35 @@
+# Eodhd/Fundamentals/InsiderTransaction.rb
+# Eodhd::Fundamentals::InsiderTransaction
+
+class Eodhd
+  class Fundamentals
+    class InsiderTransaction
+      attr_reader\
+        :date,
+        :owner_cik,
+        :owner_name,
+        :transaction_date,
+        :transaction_code,
+        :transaction_amount,
+        :transaction_price,
+        :transaction_acquired_disposed,
+        :post_transaction_amount,
+        :sec_link
+
+      private
+
+      def initialize(data)
+        @date = data['date']
+        @owner_cik = data['ownerCik']
+        @owner_name = data['ownerName']
+        @transaction_date = data['transactionDate']
+        @transaction_code = data['transactionCode']
+        @transaction_amount = data['transactionAmount']
+        @transaction_price = data['transactionPrice']
+        @transaction_acquired_disposed = data['transactionAcquiredDisposed']
+        @post_transaction_amount = data['postTransactionAmount']
+        @sec_link = data['secLink']
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/OutstandingShares/Entry.rb

@@ -0,0 +1,25 @@
+# Eodhd/Fundamentals/OutstandingShares/Entry.rb
+# Eodhd::Fundamentals::OutstandingShares::Entry
+
+class Eodhd
+  class Fundamentals
+    class OutstandingShares
+      class Entry
+        attr_reader\
+          :date,
+          :date_formatted,
+          :shares_mln,
+          :shares
+
+        private
+
+        def initialize(data)
+          @date = data['date']
+          @date_formatted = data['dateFormatted']
+          @shares_mln = data['sharesMln']
+          @shares = data['shares']
+        end
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals/OutstandingShares.rb

@@ -0,0 +1,26 @@
+# Eodhd/Fundamentals/OutstandingShares.rb
+# Eodhd::Fundamentals::OutstandingShares
+
+require_relative './OutstandingShares/Entry'
+
+class Eodhd
+  class Fundamentals
+    class OutstandingShares
+      attr_reader\
+        :annual,
+        :quarterly
+
+      private
+
+      def initialize(data)
+        @annual = wrap(data['annual'])
+        @quarterly = wrap(data['quarterly'])
+      end
+
+      def wrap(entries)
+        return [] unless entries
+        entries.values.map{|entry| Entry.new(entry)}.sort_by(&:date)
+      end
+    end
+  end
+end

data/lib/Eodhd/Fundamentals.rb

@@ -8,6 +8,8 @@ require_relative './Fundamentals/Financials'
 require_relative './Fundamentals/General'
 require_relative './Fundamentals/Highlights'
 require_relative './Fundamentals/Holders'
+require_relative './Fundamentals/InsiderTransaction'
+require_relative './Fundamentals/OutstandingShares'
 require_relative './Fundamentals/SharesStats'
 require_relative './Fundamentals/SplitsDividends'
 require_relative './Fundamentals/Technicals'
@@ -75,11 +77,16 @@ class Eodhd
       @splits_dividends = SplitsDividends.new(splits_dividends) if splits_dividends
       @analyst_ratings = AnalystRatings.new(analyst_ratings) if analyst_ratings
       @holders = Holders.new(holders) if holders
-      @insider_transactions = insider_transactions
+      @insider_transactions = wrap_insider_transactions(insider_transactions)
       @esg_scores = ESGScores.new(esg_scores) if esg_scores
-      @outstanding_shares = outstanding_shares
+      @outstanding_shares = OutstandingShares.new(outstanding_shares) if outstanding_shares
       @earnings = Earnings.new(earnings) if earnings
       @financials = Financials.new(financials) if financials
     end
+
+    def wrap_insider_transactions(entries)
+      return [] unless entries
+      entries.values.map{|entry| InsiderTransaction.new(entry)}.sort_by(&:date)
+    end
   end
 end

data/lib/Eodhd/VERSION.rb

@@ -1,3 +1,3 @@
 class Eodhd
-  VERSION = '0.18.1'
+  VERSION = '0.19.1'
 end

data/test/Eodhd/Fundamentals_test.rb

@@ -47,18 +47,40 @@ describe Eodhd::Fundamentals do
       end
     end
 
-    it "returns Financials with income_statement, balance_sheet, and cash_flow" do
+    it "returns Financials with typed income_statement, balance_sheet, and cash_flow" do
       VCR.use_cassette('fundamentals_aapl') do
-        _(fd.financials.income_statement).must_be_kind_of(Eodhd::Fundamentals::Financials::Statement)
-        _(fd.financials.balance_sheet).must_be_kind_of(Eodhd::Fundamentals::Financials::Statement)
-        _(fd.financials.cash_flow).must_be_kind_of(Eodhd::Fundamentals::Financials::Statement)
+        _(fd.financials.income_statement).must_be_kind_of(Eodhd::Fundamentals::Financials::IncomeStatement)
+        _(fd.financials.balance_sheet).must_be_kind_of(Eodhd::Fundamentals::Financials::BalanceSheet)
+        _(fd.financials.cash_flow).must_be_kind_of(Eodhd::Fundamentals::Financials::CashFlow)
       end
     end
 
-    it "returns quarterly and yearly data as hashes on financial statements" do
+    it "returns quarterly and yearly as sorted arrays of typed entries" do
       VCR.use_cassette('fundamentals_aapl') do
-        _(fd.financials.income_statement.quarterly).must_be_kind_of(Hash)
-        _(fd.financials.income_statement.yearly).must_be_kind_of(Hash)
+        yearly = fd.financials.balance_sheet.yearly
+        _(yearly).must_be_kind_of(Array)
+        _(yearly.first).must_be_kind_of(Eodhd::Fundamentals::Financials::BalanceSheet::Entry)
+        _(fd.financials.balance_sheet.quarterly).must_be_kind_of(Array)
+        dates = yearly.map(&:date)
+        _(dates).must_equal(dates.sort)
+        _(dates.first).must_equal('1985-09-30')
+      end
+    end
+
+    it "resolves interpreted and typo-corrected balance sheet accessors" do
+      VCR.use_cassette('fundamentals_aapl') do
+        latest = fd.financials.balance_sheet.yearly.last
+        _(latest.date).must_equal('2025-09-30')
+        _(latest.total_liabilities).must_equal('285508000000.00')       # totalLiab
+        _(latest.capital_surplus).must_equal('93567852270.00')          # capitalSurpluse (misspelling corrected)
+        _(latest.non_current_assets_other).must_equal('62950000000.00') # nonCurrrentAssetsOther (typo corrected)
+      end
+    end
+
+    it "expands abbreviated income statement accessors" do
+      VCR.use_cassette('fundamentals_aapl') do
+        latest = fd.financials.income_statement.yearly.last
+        _(latest.net_income_from_continuing_operations).must_equal('112010000000.00') # netIncomeFromContinuingOps
       end
     end
 
@@ -68,6 +90,44 @@ describe Eodhd::Fundamentals do
       end
     end
 
+    it "returns Earnings annual, history, and trend as arrays of typed entries" do
+      VCR.use_cassette('fundamentals_aapl') do
+        _(fd.earnings.annual.first).must_be_kind_of(Eodhd::Fundamentals::Earnings::AnnualEntry)
+        _(fd.earnings.history.first).must_be_kind_of(Eodhd::Fundamentals::Earnings::HistoryEntry)
+        _(fd.earnings.trend.first).must_be_kind_of(Eodhd::Fundamentals::Earnings::TrendEntry)
+        dates = fd.earnings.annual.map(&:date)
+        _(dates).must_equal(dates.sort)
+      end
+    end
+
+    it "returns Holders institutions and funds as arrays of typed entries" do
+      VCR.use_cassette('fundamentals_aapl') do
+        _(fd.holders.institutions).must_be_kind_of(Array)
+        _(fd.holders.funds).must_be_kind_of(Array)
+        institution = fd.holders.institutions.first
+        _(institution).must_be_kind_of(Eodhd::Fundamentals::Holders::Institution)
+        _(institution.name).must_equal('Vanguard Group Inc')
+        _(institution.change_percent).must_equal(1.9191) # change_p
+      end
+    end
+
+    it "returns insider_transactions as a sorted array of InsiderTransaction" do
+      VCR.use_cassette('fundamentals_aapl') do
+        _(fd.insider_transactions).must_be_kind_of(Array)
+        _(fd.insider_transactions.first).must_be_kind_of(Eodhd::Fundamentals::InsiderTransaction)
+        dates = fd.insider_transactions.map(&:date)
+        _(dates).must_equal(dates.sort)
+      end
+    end
+
+    it "returns outstanding_shares as OutstandingShares with typed annual and quarterly arrays" do
+      VCR.use_cassette('fundamentals_aapl') do
+        _(fd.outstanding_shares).must_be_kind_of(Eodhd::Fundamentals::OutstandingShares)
+        _(fd.outstanding_shares.annual.first).must_be_kind_of(Eodhd::Fundamentals::OutstandingShares::Entry)
+        _(fd.outstanding_shares.quarterly.first).must_be_kind_of(Eodhd::Fundamentals::OutstandingShares::Entry)
+      end
+    end
+
     it "returns SharesStats as an Eodhd::Fundamentals::SharesStats" do
       VCR.use_cassette('fundamentals_aapl') do
         _(fd.shares_stats).must_be_kind_of(Eodhd::Fundamentals::SharesStats)
@@ -75,4 +135,29 @@ describe Eodhd::Fundamentals do
       end
     end
   end
+
+  describe ".all with an ASX symbol" do
+    let(:fd){Eodhd::Fundamentals.all(api_token: api_token, exchange_code: 'AU', symbol: 'CBA')}
+
+    it "wraps a real AU fundamentals payload into the same typed objects" do
+      VCR.use_cassette('fundamentals_cba_au') do
+        _(fd).must_be_kind_of(Eodhd::Fundamentals)
+        _(fd.exchange_code).must_equal('AU')
+        _(fd.symbol).must_equal('CBA')
+        _(fd.general).must_be_kind_of(Eodhd::Fundamentals::General)
+
+        _(fd.financials.balance_sheet).must_be_kind_of(Eodhd::Fundamentals::Financials::BalanceSheet)
+        yearly = fd.financials.balance_sheet.yearly
+        _(yearly).must_be_kind_of(Array)
+        _(yearly).wont_be_empty
+        _(yearly.first).must_be_kind_of(Eodhd::Fundamentals::Financials::BalanceSheet::Entry)
+        dates = yearly.map(&:date)
+        _(dates).must_equal(dates.sort)
+
+        _(fd.holders.institutions).must_be_kind_of(Array)
+        _(fd.insider_transactions).must_be_kind_of(Array)
+        _(fd.outstanding_shares).must_be_kind_of(Eodhd::Fundamentals::OutstandingShares)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eodhd.rb
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.1
 platform: ruby
 authors:
 - thoran
@@ -157,11 +157,24 @@ files:
 - lib/Eodhd/Fundamentals/AnalystRatings.rb
 - lib/Eodhd/Fundamentals/ESGScores.rb
 - lib/Eodhd/Fundamentals/Earnings.rb
+- lib/Eodhd/Fundamentals/Earnings/AnnualEntry.rb
+- lib/Eodhd/Fundamentals/Earnings/HistoryEntry.rb
+- lib/Eodhd/Fundamentals/Earnings/TrendEntry.rb
 - lib/Eodhd/Fundamentals/Financials.rb
-- lib/Eodhd/Fundamentals/Financials/Statement.rb
+- lib/Eodhd/Fundamentals/Financials/BalanceSheet.rb
+- lib/Eodhd/Fundamentals/Financials/BalanceSheet/Entry.rb
+- lib/Eodhd/Fundamentals/Financials/CashFlow.rb
+- lib/Eodhd/Fundamentals/Financials/CashFlow/Entry.rb
+- lib/Eodhd/Fundamentals/Financials/IncomeStatement.rb
+- lib/Eodhd/Fundamentals/Financials/IncomeStatement/Entry.rb
 - lib/Eodhd/Fundamentals/General.rb
 - lib/Eodhd/Fundamentals/Highlights.rb
 - lib/Eodhd/Fundamentals/Holders.rb
+- lib/Eodhd/Fundamentals/Holders/Fund.rb
+- lib/Eodhd/Fundamentals/Holders/Institution.rb
+- lib/Eodhd/Fundamentals/InsiderTransaction.rb
+- lib/Eodhd/Fundamentals/OutstandingShares.rb
+- lib/Eodhd/Fundamentals/OutstandingShares/Entry.rb
 - lib/Eodhd/Fundamentals/SharesStats.rb
 - lib/Eodhd/Fundamentals/SplitsDividends.rb
 - lib/Eodhd/Fundamentals/Technicals.rb
@@ -198,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Access the eodhd.com API with Ruby.
 test_files: []

data/lib/Eodhd/Fundamentals/Financials/Statement.rb

@@ -1,21 +0,0 @@
-# Eodhd/Fundamentals/Financials/Statement.rb
-# Eodhd::Fundamentals::Financials::Statement
-
-class Eodhd
-  class Fundamentals
-    class Financials
-      class Statement
-        attr_reader\
-          :quarterly,
-          :yearly
-
-        private
-
-        def initialize(data)
-          @quarterly = data['quarterly']
-          @yearly = data['yearly']
-        end
-      end
-    end
-  end
-end