yfinrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae85dede3894ef988f67e2ad11cbade387915950c3387e4f593c34eb172e4d27
+  data.tar.gz: ff90bb244a371653b94696e1137cdeecc2a955f1acd0f355c54068073c439f06
+SHA512:
+  metadata.gz: a5be1264d728ab72e778062b430162a27e6bf40b970893495e2db61c1760434401440b6bda8ca982088c2e9254e9452a2585d5a6e9dd5ad6d3b8157da03d0000
+  data.tar.gz: f40d51d8164b62fb3edcd04f98011f9450c8523460e22abfe1e052cedaa11c7edc9c8a5ce94a44602acc421e8eec822dc50c763e4a04aa43a90c02c28422f941

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# Code of Conduct
+
+## Submitting a new issue
+
+* Search through existing Issues and Discussions, in case your issue already exists and a solution is being developed.
+* Ensure you read & follow the template form.
+* Consider you may be the best person to investigate and fix.
+
+## Contributing to an existing Issue
+
+* Read the entire thread.
+* Ensure your comment is contributing something new/useful. Remember you can simply react to other comments.
+* Be concise:
+  - use the formatting options
+  - if replying to a big comment, instead of quoting it, link to it

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yfinrb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,144 @@
+# Yfinrb
+
+# Download market data from Yahoo! Finance's API
+
+<table border=1 cellpadding=10><tr><td>
+
+#### \*\*\* IMPORTANT LEGAL DISCLAIMER \*\*\*
+
+---
+
+**Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of
+Yahoo, Inc.**
+
+yfinrb is **not** affiliated, endorsed, or vetted by Yahoo, Inc. It is
+an open-source tool that uses Yahoo's publicly available APIs, and is
+intended for research and educational purposes.
+
+**You should refer to Yahoo!'s terms of use**
+([here](https://policies.yahoo.com/us/en/yahoo/terms/product-atos/apiforydn/index.htm),
+[here](https://legal.yahoo.com/us/en/yahoo/terms/otos/index.html), and
+[here](https://policies.yahoo.com/us/en/yahoo/terms/index.htm)) **for
+details on your rights to use the actual data downloaded. Remember - the
+Yahoo! finance API is intended for personal use only.**
+
+</td></tr></table>
+
+---
+
+## Quick Start
+
+### The Ticker module
+
+The `Ticker` class, which allows you to access ticker data:
+
+```ruby
+
+msft = Yfinrb::Ticker("MSFT")
+
+# get all stock info
+msft.info
+
+# get historical market data
+hist = msft.history(period: "1mo")
+hist2 = msft.history(start: '2020-01-01', fin: '2021-12-31')
+
+# show meta information about the history (requires history() to be called first)
+msft.history_metadata
+
+# show actions (dividends, splits, capital gains)
+msft.actions
+msft.dividends
+msft.splits
+msft.capital_gains  # only for mutual funds & etfs
+
+# show share count
+msft.shares_full(start: "2022-01-01", fin: nil)
+
+# show financials:
+# - income statement
+msft.income_stmt
+msft.quarterly_income_stmt
+# - balance sheet
+msft.balance_sheet
+msft.quarterly_balance_sheet
+# - cash flow statement
+msft.cashflow
+msft.quarterly_cashflow
+
+# show holders
+msft.major_holders
+msft.institutional_holders
+msft.mutualfund_holders
+msft.insider_transactions
+msft.insider_purchases
+msft.insider_roster_holders
+
+# show recommendations
+msft.recommendations
+msft.recommendations_summary
+msft.upgrades_downgrades
+
+# Show future and historic earnings dates, returns at most next 4 quarters and last 8 quarters by default.
+msft.earnings_dates
+
+# show ISIN code
+# ISIN = International Securities Identification Number
+msft.isin
+
+# show options expirations
+msft.options
+
+# show news
+msft.news
+
+# get option chain for specific expiration
+opt = msft.option_chain('2026-12-18')
+# data available via: opt.calls, opt.puts
+```
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yfinrb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yfinrb
+
+---
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bmck/yfinrb.
+
+---
+
+### Legal Stuff
+
+The **yfinrb** gem is available as open source under the **MIT Software License** (https://opensource.org/licenses/MIT). See
+the [LICENSE.txt](./LICENSE.txt) file in the release for details.
+
+
+AGAIN - yfinrb is **not** affiliated, endorsed, or vetted by Yahoo, Inc. It's
+an open-source tool that uses Yahoo's publicly available APIs, and is
+intended for research and educational purposes. You should refer to Yahoo!'s terms of use
+([here](https://policies.yahoo.com/us/en/yahoo/terms/product-atos/apiforydn/index.htm),
+[here](https://legal.yahoo.com/us/en/yahoo/terms/otos/index.html), and
+[here](https://policies.yahoo.com/us/en/yahoo/terms/index.htm)) for
+details on your rights to use the actual data downloaded.
+
+---

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/yfinrb/analysis.rb

@@ -0,0 +1,68 @@
+class Yfin
+  module Analysis
+    extend ActiveSupport::Concern
+
+    # attr_accessor :ticker
+
+    def self.included(base) # built-in Ruby hook for modules
+      base.class_eval do
+        original_method = instance_method(:initialize)
+        define_method(:initialize) do |*args, &block|
+          original_method.bind(self).call(*args, &block)
+          initialize_analysis # (your module code here)
+        end
+      end
+    end
+
+    def initialize_analysis
+      @earnings_trend = nil
+      @analyst_trend_details = nil
+      @analyst_price_target = nil
+      @ev_est = nil
+      @ps_est = nil
+    end
+
+
+    def earnings_trend #(self)
+      raise YFNotImplementedError.new('earnings_trend') if @earnings_trend.nil?
+      return earnings_trend
+    end
+
+    def analyst_trend_details #(self)
+      raise YFNotImplementedError.new('analyst_trend_details') if @analyst_trend_details.nil?
+      return analyst_trend_details
+    end
+
+    alias_method :trend_details, :analyst_trend_details
+
+    def analyst_price_target #(self)
+      raise YFNotImplementedError.new('analyst_price_target') if @analyst_price_target.nil?
+      return analyst_price_target
+    end
+
+    alias_method :price_targets, :analyst_price_target
+
+    def rev_est #(self)
+      raise YFNotImplementedError.new('rev_est') if @rev_est.nil?
+      return rev_est
+    end
+
+    alias_method :rev_forecast, :rev_est
+
+    def eps_est #(self)
+      raise YFNotImplementedError.new('eps_est') if @eps_est.nil?
+      return eps_est
+    end
+
+    alias_method :earnings_forecast, :eps_est
+
+    # analysis_methods = [:earnings_trend, :analyst_trend_details, :trend_details, \
+    #                     :price_targets, :analyst_price_target, :rev_est, \
+    #                     :rev_forecast, :eps_est, :earnings_forecast ]
+    # analysis_methods.each do |meth|
+    #   #   delegate meth, to: :analysis
+    #   alias_method "get_#{meth}".to_sym, meth
+    # end
+
+  end
+end

data/lib/yfinrb/financials.rb

@@ -0,0 +1,302 @@
+class Yfin
+  module Financials
+    include ActiveSupport::Inflector
+
+    def self.included(base) # built-in Ruby hook for modules
+      base.class_eval do
+        original_method = instance_method(:initialize)
+        define_method(:initialize) do |*args, &block|
+          original_method.bind(self).call(*args, &block)
+          initialize_financials # (your module code here)
+        end
+      end
+    end
+
+    def initialize_financials
+      @income_time_series = {}
+      @balance_sheet_time_series = {}
+      @cash_flow_time_series = {}
+    end
+
+    def income_stmt; _get_income_stmt(pretty: true); end
+    def quarterly_income_stmt; _get_income_stmt(pretty: true, freq: 'quarterly'); end
+    alias_method :quarterly_incomestmt, :quarterly_income_stmt
+    alias_method :quarterly_financials, :quarterly_income_stmt
+    alias_method :annual_incomestmt, :income_stmt
+    alias_method :annual_income_stmt, :income_stmt
+    alias_method :annual_financials, :income_stmt
+
+    def balance_sheet; _get_balance_sheet(pretty: true); end
+    def quarterly_balance_sheet; _get_balance_sheet(pretty: true, freq: 'quarterly'); end
+    alias_method :quarterly_balancesheet, :quarterly_balance_sheet
+    alias_method :annual_balance_sheet, :balance_sheet
+    alias_method :annual_balancesheet, :balance_sheet
+
+    def cash_flow; _get_cash_flow(pretty: true, freq: 'yearly'); end
+    alias_method :cashflow, :cash_flow
+    def quarterly_cash_flow; _get_cash_flow(pretty: true, freq: 'quarterly'); end
+    alias_method :quarterly_cashflow, :quarterly_cash_flow
+    alias_method :annual_cashflow, :cash_flow
+    alias_method :annual_cash_flow, :cash_flow
+
+
+
+
+
+
+
+
+
+    private
+
+    def _get_cash_flow(as_dict: false, pretty: false, freq: "yearly")
+      data = _get_cash_flow_time_series(freq)
+
+      if pretty
+        #   data = data.dup
+        #   data.index = Utils.camel2title(data.index, sep: ' ', acronyms: ["PPE"])
+      end
+
+      as_dict ? data.to_h : data
+    end
+
+    def _get_income_stmt(as_dict: false, pretty: false, freq: "yearly")
+      data = _get_income_time_series(freq)
+
+      if pretty
+        #   data = data.dup
+        #   data.index = Utils.camel2title(data.index, sep: ' ', acronyms: ["EBIT", "EBITDA", "EPS", "NI"])
+      end
+
+      as_dict ? data.to_h : data
+    end
+
+
+    def _get_balance_sheet(as_dict: false, pretty: false, freq: "yearly")
+      data = _get_balance_sheet_time_series(freq)
+
+      if pretty
+        #   data = data.dup
+        #   data.index = Utils.camel2title(data.index, sep: ' ', acronyms: ["PPE"])
+      end
+
+      as_dict ? data.to_h : data
+    end
+
+    def _get_income_time_series(freq = "yearly")
+      res = @income_time_series
+      res[freq] ||= _fetch_time_series("income", freq)
+      res[freq]
+    end
+
+    def _get_balance_sheet_time_series(freq = "yearly")
+      res = @balance_sheet_time_series
+      res[freq] ||= _fetch_time_series("balancesheet", freq)
+      res[freq]
+    end
+
+    def _get_cash_flow_time_series(freq = "yearly")
+      res = @cash_flow_time_series
+      res[freq] ||= _fetch_time_series("cashflow", freq)
+      res[freq]
+    end
+
+    def _get_financials_time_series(timescale, ts_keys)
+      Polars::Config.set_tbl_rows(-1)
+      timescale_translation = { "yearly" => "annual", "quarterly" => "quarterly" }
+      timescale = timescale_translation[timescale]
+
+      ts_url_base = "https://query2.finance.yahoo.com/ws/fundamentals-timeseries/v1/finance/timeseries/#{symbol}?symbol=#{symbol}"
+      url = ts_url_base + "&type=" + ts_keys.map { |k| "#{timescale}#{k}" }.join(",")
+      start_dt = DateTime.new(2016, 12, 31)
+      end_dt = DateTime.now.tomorrow.midnight
+      url += "&period1=#{start_dt.to_i}&period2=#{end_dt.to_i}"
+
+      json_str = get(url).parsed_response
+      data_raw = json_str["timeseries"]["result"]
+      data_raw.each { |d| d.delete("meta") }
+
+      timestamps = data_raw.map{|d| d['timestamp']}.flatten.uniq.compact.uniq.sort.reverse
+
+      cols = [ :metric ] + timestamps.map{|ts| Time.at(ts).utc.to_date.to_s }
+      df = {}; cols.each {|c| df[c] = [] }
+      ts_keys.each { |k| df[:metric] <<  k.gsub(/([A-Z]+)/,' \1').strip }
+
+      timestamps.each do |ts|
+        ts_date = Time.at(ts).utc.to_date.to_s
+
+        ts_keys.each_with_index do |k, ndex|
+          l = "#{timescale}#{k}"
+          d = data_raw.detect{|dd| dd.key?(l) }
+          if d.nil?
+            df[ts_date] << ''
+            next
+          end
+          tv = d[l].detect{|dd| dd['asOfDate'] == ts_date }
+          df[ts_date] << (tv.nil? ? '' : tv['reportedValue']['raw'].to_s)
+        end
+
+      end
+
+      df = Polars::DataFrame.new(df)
+      timestamps.map{|ts| Time.at(ts).utc.to_date.to_s }.each do |t|
+        puts t
+        df.replace(t, Polars::Series.new(df[t].cast(Polars::String)))
+      end
+      df
+    end
+
+    def _fetch_time_series(nam, timescale)
+      # Rails.logger.info { "#{__FILE__}:#{__LINE__}"}
+      allowed_names = FUNDAMENTALS_KEYS.keys + [:income]
+      allowed_timescales = ["yearly", "quarterly"]
+
+      raise ArgumentError, "Illegal argument: name (#{nam}) must be one of: #{allowed_names}" unless allowed_names.include?(nam.to_sym)
+      raise ArgumentError, "Illegal argument: timescale (#{timescale}) must be one of: #{allowed_timescales}" unless allowed_timescales.include?(timescale)
+
+      begin
+        statement = _create_financials_table(nam, timescale)
+        return statement unless statement.nil?
+      rescue Yfin::YfinDataException => e
+        Rails.logger.error {"#{@symbol}: Failed to create #{nam} financials table for reason: #{e}"}
+      end
+      Polars::DataFrame.new()
+    end
+
+    def _create_financials_table(nam, timescale)
+      nam = "financials" if nam == "income"
+
+      keys = FUNDAMENTALS_KEYS[nam.to_sym]
+      begin
+        _get_financials_time_series(timescale, keys)
+      rescue StandardError
+        nil
+      end
+    end
+
+
+
+    FUNDAMENTALS_KEYS = {
+      financials: [
+        "TaxEffectOfUnusualItems", "TaxRateForCalcs", "NormalizedEBITDA", "NormalizedDilutedEPS",
+        "NormalizedBasicEPS", "TotalUnusualItems", "TotalUnusualItemsExcludingGoodwill",
+        "NetIncomeFromContinuingOperationNetMinorityInterest", "ReconciledDepreciation",
+        "ReconciledCostOfRevenue", "EBITDA", "EBIT", "NetInterestIncome", "InterestExpense",
+        "InterestIncome", "ContinuingAndDiscontinuedDilutedEPS", "ContinuingAndDiscontinuedBasicEPS",
+        "NormalizedIncome", "NetIncomeFromContinuingAndDiscontinuedOperation", "TotalExpenses",
+        "RentExpenseSupplemental", "ReportedNormalizedDilutedEPS", "ReportedNormalizedBasicEPS",
+        "TotalOperatingIncomeAsReported", "DividendPerShare", "DilutedAverageShares", "BasicAverageShares",
+        "DilutedEPS", "DilutedEPSOtherGainsLosses", "TaxLossCarryforwardDilutedEPS",
+        "DilutedAccountingChange", "DilutedExtraordinary", "DilutedDiscontinuousOperations",
+        "DilutedContinuousOperations", "BasicEPS", "BasicEPSOtherGainsLosses", "TaxLossCarryforwardBasicEPS",
+        "BasicAccountingChange", "BasicExtraordinary", "BasicDiscontinuousOperations",
+        "BasicContinuousOperations", "DilutedNIAvailtoComStockholders", "AverageDilutionEarnings",
+        "NetIncomeCommonStockholders", "OtherunderPreferredStockDividend", "PreferredStockDividends",
+        "NetIncome", "MinorityInterests", "NetIncomeIncludingNoncontrollingInterests",
+        "NetIncomeFromTaxLossCarryforward", "NetIncomeExtraordinary", "NetIncomeDiscontinuousOperations",
+        "NetIncomeContinuousOperations", "EarningsFromEquityInterestNetOfTax", "TaxProvision",
+        "PretaxIncome", "OtherIncomeExpense", "OtherNonOperatingIncomeExpenses", "SpecialIncomeCharges",
+        "GainOnSaleOfPPE", "GainOnSaleOfBusiness", "OtherSpecialCharges", "WriteOff",
+        "ImpairmentOfCapitalAssets", "RestructuringAndMergernAcquisition", "SecuritiesAmortization",
+        "EarningsFromEquityInterest", "GainOnSaleOfSecurity", "NetNonOperatingInterestIncomeExpense",
+        "TotalOtherFinanceCost", "InterestExpenseNonOperating", "InterestIncomeNonOperating",
+        "OperatingIncome", "OperatingExpense", "OtherOperatingExpenses", "OtherTaxes",
+        "ProvisionForDoubtfulAccounts", "DepreciationAmortizationDepletionIncomeStatement",
+        "DepletionIncomeStatement", "DepreciationAndAmortizationInIncomeStatement", "Amortization",
+        "AmortizationOfIntangiblesIncomeStatement", "DepreciationIncomeStatement", "ResearchAndDevelopment",
+        "SellingGeneralAndAdministration", "SellingAndMarketingExpense", "GeneralAndAdministrativeExpense",
+        "OtherGandA", "InsuranceAndClaims", "RentAndLandingFees", "SalariesAndWages", "GrossProfit",
+        "CostOfRevenue", "TotalRevenue", "ExciseTaxes", "OperatingRevenue"
+      ],
+      balancesheet: [
+        "TreasurySharesNumber", "PreferredSharesNumber", "OrdinarySharesNumber", "ShareIssued", "NetDebt",
+        "TotalDebt", "TangibleBookValue", "InvestedCapital", "WorkingCapital", "NetTangibleAssets",
+        "CapitalLeaseObligations", "CommonStockEquity", "PreferredStockEquity", "TotalCapitalization",
+        "TotalEquityGrossMinorityInterest", "MinorityInterest", "StockholdersEquity",
+        "OtherEquityInterest", "GainsLossesNotAffectingRetainedEarnings", "OtherEquityAdjustments",
+        "FixedAssetsRevaluationReserve", "ForeignCurrencyTranslationAdjustments",
+        "MinimumPensionLiabilities", "UnrealizedGainLoss", "TreasuryStock", "RetainedEarnings",
+        "AdditionalPaidInCapital", "CapitalStock", "OtherCapitalStock", "CommonStock", "PreferredStock",
+        "TotalPartnershipCapital", "GeneralPartnershipCapital", "LimitedPartnershipCapital",
+        "TotalLiabilitiesNetMinorityInterest", "TotalNonCurrentLiabilitiesNetMinorityInterest",
+        "OtherNonCurrentLiabilities", "LiabilitiesHeldforSaleNonCurrent", "RestrictedCommonStock",
+        "PreferredSecuritiesOutsideStockEquity", "DerivativeProductLiabilities", "EmployeeBenefits",
+        "NonCurrentPensionAndOtherPostretirementBenefitPlans", "NonCurrentAccruedExpenses",
+        "DuetoRelatedPartiesNonCurrent", "TradeandOtherPayablesNonCurrent",
+        "NonCurrentDeferredLiabilities", "NonCurrentDeferredRevenue",
+        "NonCurrentDeferredTaxesLiabilities", "LongTermDebtAndCapitalLeaseObligation",
+        "LongTermCapitalLeaseObligation", "LongTermDebt", "LongTermProvisions", "CurrentLiabilities",
+        "OtherCurrentLiabilities", "CurrentDeferredLiabilities", "CurrentDeferredRevenue",
+        "CurrentDeferredTaxesLiabilities", "CurrentDebtAndCapitalLeaseObligation",
+        "CurrentCapitalLeaseObligation", "CurrentDebt", "OtherCurrentBorrowings", "LineOfCredit",
+        "CommercialPaper", "CurrentNotesPayable", "PensionandOtherPostRetirementBenefitPlansCurrent",
+        "CurrentProvisions", "PayablesAndAccruedExpenses", "CurrentAccruedExpenses", "InterestPayable",
+        "Payables", "OtherPayable", "DuetoRelatedPartiesCurrent", "DividendsPayable", "TotalTaxPayable",
+        "IncomeTaxPayable", "AccountsPayable", "TotalAssets", "TotalNonCurrentAssets",
+        "OtherNonCurrentAssets", "DefinedPensionBenefit", "NonCurrentPrepaidAssets",
+        "NonCurrentDeferredAssets", "NonCurrentDeferredTaxesAssets", "DuefromRelatedPartiesNonCurrent",
+        "NonCurrentNoteReceivables", "NonCurrentAccountsReceivable", "FinancialAssets",
+        "InvestmentsAndAdvances", "OtherInvestments", "InvestmentinFinancialAssets",
+        "HeldToMaturitySecurities", "AvailableForSaleSecurities",
+        "FinancialAssetsDesignatedasFairValueThroughProfitorLossTotal", "TradingSecurities",
+        "LongTermEquityInvestment", "InvestmentsinJointVenturesatCost",
+        "InvestmentsInOtherVenturesUnderEquityMethod", "InvestmentsinAssociatesatCost",
+        "InvestmentsinSubsidiariesatCost", "InvestmentProperties", "GoodwillAndOtherIntangibleAssets",
+        "OtherIntangibleAssets", "Goodwill", "NetPPE", "AccumulatedDepreciation", "GrossPPE", "Leases",
+        "ConstructionInProgress", "OtherProperties", "MachineryFurnitureEquipment",
+        "BuildingsAndImprovements", "LandAndImprovements", "Properties", "CurrentAssets",
+        "OtherCurrentAssets", "HedgingAssetsCurrent", "AssetsHeldForSaleCurrent", "CurrentDeferredAssets",
+        "CurrentDeferredTaxesAssets", "RestrictedCash", "PrepaidAssets", "Inventory",
+        "InventoriesAdjustmentsAllowances", "OtherInventories", "FinishedGoods", "WorkInProcess",
+        "RawMaterials", "Receivables", "ReceivablesAdjustmentsAllowances", "OtherReceivables",
+        "DuefromRelatedPartiesCurrent", "TaxesReceivable", "AccruedInterestReceivable", "NotesReceivable",
+        "LoansReceivable", "AccountsReceivable", "AllowanceForDoubtfulAccountsReceivable",
+        "GrossAccountsReceivable", "CashCashEquivalentsAndShortTermInvestments",
+        "OtherShortTermInvestments", "CashAndCashEquivalents", "CashEquivalents", "CashFinancial"
+      ],
+      cashflow: [
+        "ForeignSales", "DomesticSales", "AdjustedGeographySegmentData", "FreeCashFlow",
+        "RepurchaseOfCapitalStock", "RepaymentOfDebt", "IssuanceOfDebt", "IssuanceOfCapitalStock",
+        "CapitalExpenditure", "InterestPaidSupplementalData", "IncomeTaxPaidSupplementalData",
+        "EndCashPosition", "OtherCashAdjustmentOutsideChangeinCash", "BeginningCashPosition",
+        "EffectOfExchangeRateChanges", "ChangesInCash", "OtherCashAdjustmentInsideChangeinCash",
+        "CashFlowFromDiscontinuedOperation", "FinancingCashFlow", "CashFromDiscontinuedFinancingActivities",
+        "CashFlowFromContinuingFinancingActivities", "NetOtherFinancingCharges", "InterestPaidCFF",
+        "ProceedsFromStockOptionExercised", "CashDividendsPaid", "PreferredStockDividendPaid",
+        "CommonStockDividendPaid", "NetPreferredStockIssuance", "PreferredStockPayments",
+        "PreferredStockIssuance", "NetCommonStockIssuance", "CommonStockPayments", "CommonStockIssuance",
+        "NetIssuancePaymentsOfDebt", "NetShortTermDebtIssuance", "ShortTermDebtPayments",
+        "ShortTermDebtIssuance", "NetLongTermDebtIssuance", "LongTermDebtPayments", "LongTermDebtIssuance",
+        "InvestingCashFlow", "CashFromDiscontinuedInvestingActivities",
+        "CashFlowFromContinuingInvestingActivities", "NetOtherInvestingChanges", "InterestReceivedCFI",
+        "DividendsReceivedCFI", "NetInvestmentPurchaseAndSale", "SaleOfInvestment", "PurchaseOfInvestment",
+        "NetInvestmentPropertiesPurchaseAndSale", "SaleOfInvestmentProperties",
+        "PurchaseOfInvestmentProperties", "NetBusinessPurchaseAndSale", "SaleOfBusiness",
+        "PurchaseOfBusiness", "NetIntangiblesPurchaseAndSale", "SaleOfIntangibles", "PurchaseOfIntangibles",
+        "NetPPEPurchaseAndSale", "SaleOfPPE", "PurchaseOfPPE", "CapitalExpenditureReported",
+        "OperatingCashFlow", "CashFromDiscontinuedOperatingActivities",
+        "CashFlowFromContinuingOperatingActivities", "TaxesRefundPaid", "InterestReceivedCFO",
+        "InterestPaidCFO", "DividendReceivedCFO", "DividendPaidCFO", "ChangeInWorkingCapital",
+        "ChangeInOtherWorkingCapital", "ChangeInOtherCurrentLiabilities", "ChangeInOtherCurrentAssets",
+        "ChangeInPayablesAndAccruedExpense", "ChangeInAccruedExpense", "ChangeInInterestPayable",
+        "ChangeInPayable", "ChangeInDividendPayable", "ChangeInAccountPayable", "ChangeInTaxPayable",
+        "ChangeInIncomeTaxPayable", "ChangeInPrepaidAssets", "ChangeInInventory", "ChangeInReceivables",
+        "ChangesInAccountReceivables", "OtherNonCashItems", "ExcessTaxBenefitFromStockBasedCompensation",
+        "StockBasedCompensation", "UnrealizedGainLossOnInvestmentSecurities", "ProvisionandWriteOffofAssets",
+        "AssetImpairmentCharge", "AmortizationOfSecurities", "DeferredTax", "DeferredIncomeTax",
+        "DepreciationAmortizationDepletion", "Depletion", "DepreciationAndAmortization",
+        "AmortizationCashFlow", "AmortizationOfIntangibles", "Depreciation", "OperatingGainsLosses",
+        "PensionAndEmployeeBenefitExpense", "EarningsLossesFromEquityInvestments",
+        "GainLossOnInvestmentSecurities", "NetForeignCurrencyExchangeGainLoss", "GainLossOnSaleOfPPE",
+        "GainLossOnSaleOfBusiness", "NetIncomeFromContinuingOperations",
+        "CashFlowsfromusedinOperatingActivitiesDirect", "TaxesRefundPaidDirect", "InterestReceivedDirect",
+        "InterestPaidDirect", "DividendsReceivedDirect", "DividendsPaidDirect", "ClassesofCashPayments",
+        "OtherCashPaymentsfromOperatingActivities", "PaymentsonBehalfofEmployees",
+        "PaymentstoSuppliersforGoodsandServices", "ClassesofCashReceiptsfromOperatingActivities",
+        "OtherCashReceiptsfromOperatingActivities", "ReceiptsfromGovernmentGrants", "ReceiptsfromCustomers"
+      ]
+    }
+
+
+  end
+end

data/lib/yfinrb/fundamentals.rb

@@ -0,0 +1,54 @@
+
+class Yfin
+  module Fundamentals
+    extend ActiveSupport::Concern
+
+    def self.included(base) # built-in Ruby hook for modules
+      base.class_eval do
+        attr_reader :financials, :earnings, :shares, :ticker
+
+        original_method = instance_method(:initialize)
+        define_method(:initialize) do |*args, &block|
+          original_method.bind(self).call(*args, &block)
+          initialize_fundamentals # (your module code here)
+        end
+      end
+    end
+
+    def initialize_fundamentals
+      @earnings = nil
+      @financials = nil
+      @shares = nil
+
+      @financials_data = nil
+      @fin_data_quote = nil
+      @basics_already_scraped = false
+    end
+
+    # delegate :proxy, :tz, to: :ticker
+
+    def earnings
+      raise YFNotImplementedError.new('earnings') if @earnings.nil?
+      @earnings
+    end
+
+    def shares
+      raise YFNotImplementedError.new('shares') if @shares.nil?
+      @shares
+    end
+
+    # financials_methods = [:income_stmt, :incomestmt, :financials, :balance_sheet, :balancesheet, :cash_flow, :cashflow]
+    # financials_methods.each do |meth|
+    #   delegate "get_#{meth}".to_sym, meth, to: :financials
+    # end
+
+    # fundamentals_methods = [:earnings, :shares]
+    # fundamentals_methods.each do |meth|
+    #   alias_method  "get_#{meth}".to_sym, meth
+    # end    
+
+    # def quarterly_earnings
+    #   earnings(freq: 'quarterly')
+    # end
+  end
+end