yahoo_finance_lib 0.7.9.9 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc13efc43548f4fc12c51b5f7d1c9b36a8c6debe
-  data.tar.gz: b29a48bdee49e5dc63f45d697bcd3b1a98b83405
+  metadata.gz: 9df975c007b68670d21053d4074c84827e3d2c36
+  data.tar.gz: ac8125aa849e61edaaddac5f2eda9509612bf1fa
 SHA512:
-  metadata.gz: d660f814fc921d549150357e6ab2de3a07f0cc76a2e6908d1d51c89ea26888f0aedc9a4ba814bc60bdb06a826e5944584d05a84e9981e37b30bdf7d2a99c38c6
-  data.tar.gz: ed11f2b3faff77da3e4658182603826ab0b333beefd1179b6d7f6493c2a8cb0fc9dc3e1274fc097b29167e5f776d4ad2201753e3ef4308bcd70a7a746eabe580
+  metadata.gz: ab98ed7b73c1d7f070be411ee302c1376ea5b78bbf24431c98fed7081d65bf3603d98503f614154b28307f56a0d3c2b54a6e12adb2b72470161ea4b4301ef65e
+  data.tar.gz: ae1a07e599704f1f3c22232161f2f0c82255b641892a94f4905042348dd25266f3fb86dd37157cdac2fd7251a4e91fdb81ef7f55f1fc5ec82d11d9de5776941a

data/README.md

@@ -1,6 +1,6 @@
 # YahooFinance library
 
-YahooFinance lib is a gem that fetches stock quotes, key statistics, company profile, company events, and analyst opinion from Yahoo (TM) API and financial HTML pages. Additionally, it has interfaces for historical data, and financial statements. The loading of stock quotes uses the excellent nas/yahoo_stock gem. This gem provides a 'unified' attribute based interface, and abstracts the source of the information, i.e. the user only needs to specify an attribute without the need to specify the page source of the attribute. This gem leverages to the highest extend possible the YahooStock (yahoo_stock_nas) gem for all the attributes provided by that gem, and fails over to HTML scraping when the data is unavailable there. Naturally, this has an implication on performance; YahooStock queries bundle 50 stocks in each query, whereas HTML scraping happens one page per stock at a time.
+YahooFinance lib is a gem that fetches stock quotes, key statistics, company profile, company events, analyst opinion, and analyst estimates from Yahoo (TM) API and financial HTML pages. Additionally, it has interfaces for historical data, and financial statements. The loading of stock quotes uses the excellent nas/yahoo_stock gem. This gem provides a 'unified' attribute based interface, and abstracts the source of the information, i.e. the user only needs to specify an attribute without the need to specify the page source of the attribute. This gem leverages to the highest extend possible the YahooStock (yahoo_stock_nas) gem for all the attributes provided by that gem, and fails over to HTML scraping when the data is unavailable there. Naturally, this has an implication on performance; YahooStock queries bundle 50 stocks in each query, whereas HTML scraping happens one page per stock at a time.
 
 #####This gem is currently still in development. HTML scraping now supports many attributes from Key Statistics, supports earnings announcements from the Company Events page, and most attributes from Analyst Opinion -- additional pages will be added as I find time.
 
@@ -28,7 +28,7 @@ Web pages get occasionally updated -- updates could break any or all of the clas
 ```
 	rspec -c -f d
 ```
-
+Beware that because the tests are based on actually fetching the data from yahoo, when the data structures fail, some tests that used to work may not work anymore. To be certain, you will need to investiage errors and subsequently investigate the yahoo page -- only then can you determine if the test works properly.
 ## Usage
 
  
@@ -77,7 +77,23 @@ A simple interface to scrape financial statements - Income Statement, Balance Sh
 ```
 
 The classes for the  financial statement are: QuarterlyIncomeStatementPage, AnnualIncomeStatementPage, AnnualBalanceSheetPage, QuarterlyBalanceSheetPage, QuarterlyCashFlowStatementPage, AnnualCashFlowStatementPage
+
+Release 1.0 brings a number of bug fixes from using the gem for almost a year now, as well as the addition of scraping the Analyst Estimates page. Each table in the analyst page is returned as a separate "field", namely :earnings_est, :revenue_est, :earnings_history, :EPS_trends, :EPS_revisions, and :growth_est.  Fields are returned as hashes, with two keys: :columns and :values. The latter - :values - is another hash with keys the name of the row, and the value being that of an array of values (one for each column). For example:
+
+```ruby
+	irb
+	require 'yahoo_finance'
 	
+	st = YahooFinance::Stock.new(['AAPL'])
+	st.add_field(:earnings_est)
+	result = st.fetch
+	## result => {"AAPL"=>{:earnings_est=>{:columns=>["Current Qtr.Dec 15", "Next Qtr.Mar 16", "Current YearSep 16", "Next YearSep 17"], :values=>{"Avg. Estimate"=>[3.25, 2.38, 9.75, 10.7], "No. of Analysts"=>[40.0, 38.0, 49.0, 40.0], "Low Estimate"=>[2.96, 2.12, 8.92, 9.48], "High Estimate"=>[3.38, 2.84, 10.65, 12.26], "Year Ago EPS"=>[3.06, 2.33, 9.22, 9.75]}}}}
+	result['AAPL'][:earnings_est][:values]["Year Ago EPS"]
+	## prints: [3.06, 2.33, 9.22, 9.75]
+	result['AAPL'][:earnings_est][:columns]
+	## prints: ["Current Qtr.Dec 15", "Next Qtr.Mar 16", "Current YearSep 16", "Next YearSep 17"]
+```
+
 !-- ## Contributing
 
 1. Fork it

data/lib/yahoo_finance.rb

@@ -5,6 +5,7 @@ require 'yahoo_finance/stock'
 require 'yahoo_finance/key_statistics'
 require 'yahoo_finance/company_events'
 require 'yahoo_finance/analyst_opinion'
+require 'yahoo_finance/analyst_estimates'
 require 'yahoo_finance/company_profile'
 require 'yahoo_finance/financial_statement'
 

data/lib/yahoo_finance/analyst_estimates.rb

@@ -0,0 +1,82 @@
+require 'open-uri'
+require 'nokogiri'
+
+module YahooFinance
+  module AnalystEstimates
+    AVL_KEY_STATS = {
+      :earnings_est => ['Earnings Est', "Earnings estimate table"],
+      :revenue_est => ['Revenue Est', "Revenue Estimate table"],
+      :earnings_history => ['Earnings History', 'Earnings History table'],
+      :EPS_trends => ['EPS Trends', 'EPS Trends table'],
+      :EPS_revisions => ['EPS Revisions', 'EPS Revisions table'],
+      :growth_est => ['Growth Estimate', 'Growth Estimate table']
+    }
+    def AnalystEstimates.key_events_available 
+      return AVL_KEY_STATS.keys;
+    end
+
+    class AnalystEstimatesPage
+      attr_accessor :symbol
+    
+      def initialize symbol=nil
+        @symbol = symbol
+      end
+      
+      def fetch
+        url = "http://finance.yahoo.com/q/ae?s=#{@symbol}"
+        open(url) do |stream|
+          @doc = Nokogiri::HTML(stream)
+          # This page uses empty tables for spacing; they are all part of one cell. so table exist at positions 0,2,4,6,8,10
+          @tables = @doc.xpath("//table[@id = 'yfncsumtab']/tr[2]/td/table")
+        end
+      end
+       
+      def value_for key_stat
+        begin
+          return nil if !AVL_KEY_STATS.keys.include?(key_stat)
+          
+          ret = {}
+          # here we have to find the subtable that contains the data for key_stat
+          found = false
+          table_idx = nil
+          0.upto(@tables.length) do |idx|
+            if @tables[idx].css("th").text.start_with?(AVL_KEY_STATS[key_stat][0])
+              found = true
+              table_idx = idx
+              break
+            end
+          end
+          return nil if !found
+          
+          col_hdrs = @tables[table_idx].css("th")
+          # col_hdrs[0] is really the name of the  table
+          return nil if col_hdrs[0].text != AVL_KEY_STATS[key_stat][0]    # double check
+          hdrs = col_hdrs[1..(col_hdrs.length-1)].collect { |x| x.text }
+          ret[:columns] = hdrs
+          ret[:values] = {}
+          
+          rows = @tables[table_idx].css("tr tr")
+          # rows[0] is the header
+          rows[1..(rows.length-1)].each do |row|
+            cells = row.css("td")
+            row_array = []
+            row_header = cells[0].text
+            cells[1..(cells.length-1)].each do |cell|
+              value = cell.text
+              begin
+                row_array << ((value == "N/A") ? "N/A" : YahooFinance.parse_yahoo_field(value))
+              rescue
+                puts "AnalystEstimatesPage: Could not parse yahoo field expected to be numeric"
+              end
+            end
+            ret[:values][row_header] = row_array
+          end
+          
+          return ret
+        rescue
+        end
+        return nil
+      end  
+    end
+  end
+end

data/lib/yahoo_finance/company_events.rb

@@ -4,7 +4,8 @@ require 'nokogiri'
 module YahooFinance
   module CompanyEvents
     COMPANY_EVENTS_STATS = {
-      :next_earnings_announcement_date => ['Earnings announcement', "Next earnings call date"]
+      :next_earnings_announcement_date => ['Earnings announcement', "Next earnings call date"],
+      :last_earnings_announcement_date => ['Earnings announcement', "Last earnings announcement date"]
     }
     def CompanyEvents.key_events_available 
       return YahooFinance::CompanyEvents::COMPANY_EVENTS_STATS.keys;
@@ -30,6 +31,8 @@ module YahooFinance
             if @doc.css('table#yfncsumtab//table.yfnc_datamodoutline1//table//td.yfnc_tabledata1')[1].text == "Earnings announcement"
               return YahooFinance.parse_yahoo_field(@doc.css('table#yfncsumtab//table.yfnc_datamodoutline1//table//td.yfnc_tabledata1')[0].text)
             end
+          else
+            # these are previous events, and I need to look into a different table
           end
         rescue
         end

data/lib/yahoo_finance/financial_statement.rb

@@ -42,7 +42,7 @@ module YahooFinance
       :long_term_investments => ['Long Term Investments', 'Long Term Investments'],
       :property_plant_and_equipment => ['Property Plant and Equipment', 'Property Plant and Equipment'],
       :goodwill => ['Goodwill', 'Goodwill'],
-      :intagible_assets => ['Intangible Assets', 'Intangible Assets'],
+      :intangible_assets => ['Intangible Assets', 'Intangible Assets'],
       :accumulated_amortization => ['Accumulated Amortization', 'Accumulated Amortization'],
       :other_assets => ['Other Assets', 'Other Assets'],
       :deferred_long_term_asset_charges => ['Deferred Long Term Asset Charges', 'Deferred Long Term Asset Charges'],
@@ -118,7 +118,22 @@ module YahooFinance
         return @field_defs.keys;
       end
       
+      # we use this to retry one more time; once in a while, it returns a valid page, but the page contains garbage
       def fetch
+        tries = 0
+        begin
+          return _fetch
+        rescue
+          tries += 1
+          if tries <= 1
+            puts "Exception: #{$!.inspect}  -- Retrying symbol #{@symbol} (appears to be the problem of server error returning server error page)"
+            sleep(2)
+            retry
+          end 
+        end
+      end
+      
+      def _fetch
         url = "http://finance.yahoo.com/q/#{@type}?s=#{@symbol}&#{@term.to_s}"
         doc = nil
         tries = 0

data/lib/yahoo_finance/key_statistics.rb

@@ -7,6 +7,8 @@ module YahooFinance
       # String_to_parse, Description, Source Value format factor (some values are in % but dont't show %)
       :market_cap => ['Market Cap ', "Market Cap, intraday"],
       :enterprise_value => ['Enterprise Value ', "Enterprise Value"],
+      :enterprise_value_to_ebitda => ['Enterprise Value\/EBITDA \(ttm\)', "Enterprise Value/EBITDA"],
+      :ebitda => ['EBITDA \(ttm\)', 'Earnings before Income/Taxes/Depreciation'],
       :trailing_pe => ['Trailing P\/E \(ttm\, intraday\)\:', "Trailing PE, trailing twelve months, intraday (based on price)"],
       :forward_pe => ['Forward P\/E ', "Forward P/E"],
       :peg_ratio => ['PEG Ratio ', "PEG Ratio (5 year expected (forward looking))"],
@@ -14,7 +16,6 @@ module YahooFinance
       :price_to_book_mrq => ['Price\/Book \(mrq\):', "Price/Book, most recent quarter"],
       :roa_ttm => ['Return on Assets \(ttm\)\:', "Return on Assets, trailing twelve months"],
       :roe_ttm => ['Return on Equity \(ttm\)\:', "Return on Equity, trailing twelve months"],
-      :book_value_per_share_mrq => ['Book Value Per Share \(mrq\):', "Book Value per share, most recent quarter"],
       # Income Statement
       :revenue_ttm => ['Revenue \(ttm\)\:', "Revenue, trailing twelve months"],
       :revenue_per_share_ttm => ['Revenue Per Share \(ttm\)\:', "Revenue per share, trailing twelve months"],

data/lib/yahoo_finance/stock.rb

@@ -3,6 +3,7 @@ require 'yahoo_stock'
 require 'yahoo_finance/key_statistics'
 require 'yahoo_finance/company_events'
 require 'yahoo_finance/analyst_opinion'
+require 'yahoo_finance/analyst_estimates'
 require 'yahoo_finance/company_profile'
 
 
@@ -12,12 +13,14 @@ module YahooFinance
     :KEY_STATISTICS => YahooFinance::KeyStatistics.key_stats_available,
     :COMPANY_EVENTS => YahooFinance::CompanyEvents.key_events_available,
     :ANALYST_OPINION => YahooFinance::AnalystOpinion.key_events_available,
+    :ANALYST_ESTIMATES => YahooFinance::AnalystEstimates.key_events_available,
     :COMPANY_PROFILE => YahooFinance::CompanyProfile.key_events_available
   }
   DRIVERS = {
     :KEY_STATISTICS => YahooFinance::KeyStatistics::StatsPage,
     :COMPANY_EVENTS => YahooFinance::CompanyEvents::CompanyEventsPage,
     :ANALYST_OPINION => YahooFinance::AnalystOpinion::AnalystOpinionPage,
+    :ANALYST_ESTIMATES => YahooFinance::AnalystEstimates::AnalystEstimatesPage,
     :COMPANY_PROFILE => YahooFinance::CompanyProfile::CompanyProfilePage
   }
   
@@ -121,7 +124,7 @@ module YahooFinance
   
   class Stock
     attr_reader :results_hash, :print_progress
-    @@available_fields = (AVL_FIELDS[:YAHOO_STOCK_FIELDS] + AVL_FIELDS[:KEY_STATISTICS] + AVL_FIELDS[:COMPANY_EVENTS] + AVL_FIELDS[:ANALYST_OPINION] + AVL_FIELDS[:COMPANY_PROFILE])
+    @@available_fields = (AVL_FIELDS[:YAHOO_STOCK_FIELDS] + AVL_FIELDS[:KEY_STATISTICS] + AVL_FIELDS[:COMPANY_EVENTS] + AVL_FIELDS[:ANALYST_OPINION] + AVL_FIELDS[:ANALYST_ESTIMATES] + AVL_FIELDS[:COMPANY_PROFILE])
     @@insert_variable_delays = false
     @@insert_variable_delay = 2
     @@retry_times = 3

data/lib/yahoo_finance/version.rb

@@ -1,3 +1,3 @@
 module YahooFinance
-  VERSION = "0.7.9.9"
+  VERSION = "1.0"
 end

data/spec/yahoo_analyst_estimates_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe YahooFinance::AnalystEstimates do
+  # before(:each) do
+  #   @tsymbols = ['AAPL', 'DDD']
+  #   @page = YahooFinance::Page.new(@tsymbols)
+  # end
+  
+  describe "Analyst Opinion" do
+    it "available stats should include things like :EPS_trends and :earnings_history" do
+      YahooFinance::AnalystEstimates.key_events_available.include?(:EPS_trends).should == true
+      YahooFinance::AnalystEstimates.key_events_available.include?(:earnings_history).should == true
+    end
+    it "should fetch a  stat like :earnings_est for AAPL and should not be zero" do
+      pg = YahooFinance::AnalystEstimates::AnalystEstimatesPage.new('AAPL')
+      pg.fetch
+      aapl_earning_estimates = pg.value_for :earnings_est
+      aapl_earning_estimates[:columns].length.should > 0
+      aapl_earning_estimates[:values]['Avg. Estimate'].length.should > 0
+    end
+  end
+end

data/spec/yahoo_financial_statement_spec.rb

@@ -13,8 +13,8 @@ describe YahooFinance::FinancialStatement do
     it "Income Statement should include things like :next_earnings_announcement_date" do
       YahooFinance::FinancialStatement::INCOME_STMT_FIELDS.include?(:operating_income_or_loss).should == true
     end
-    it "Balance Sheet should include things like :intagible_assets" do
-      YahooFinance::FinancialStatement::BALANCE_SHEET_FIELDS.include?(:intagible_assets).should == true
+    it "Balance Sheet should include things like :intangible_assets" do
+      YahooFinance::FinancialStatement::BALANCE_SHEET_FIELDS.include?(:intangible_assets).should == true
     end
     it "Cash Flow Statement should include things like :total_cash_flow_from_operating_activities" do
       YahooFinance::FinancialStatement::CASH_FLOW_STMT_FIELDS.include?(:total_cash_flow_from_operating_activities).should == true
@@ -91,18 +91,19 @@ describe YahooFinance::FinancialStatement do
         end
       end
     end
-    it "should fetch all fields for e.g. ACT (3 quarters only on 11/19/14) quarterly Cash Flow statement and all values should be float (except for :statement_periods)-- valid values" do
-      is = YahooFinance::FinancialStatement::QuarterlyCashFlowStatementPage.new 'ACT'
-      rs = is.fetch
-      YahooFinance::FinancialStatement::CASH_FLOW_STMT_FIELDS.keys.each do |attr|
-        fields = rs[attr]
-        fields.class.name.should == "Array"
-        fields.size.should == 3
-        fields.each do |field|
-          attr == :statement_periods ? field.class.name.should == "Date" : field.class.name.should == "Float"
-        end
-      end
-    end
+    # THE FOLLOWING NOW ACTUALLY FINDS FINANCIAL STATEMENTS, SO THE DATA PROBLEM IS FIXED
+    # it "should fetch all fields for e.g. ACT (3 quarters only on 11/19/14) quarterly Cash Flow statement and all values should be float (except for :statement_periods)-- valid values" do
+    #   is = YahooFinance::FinancialStatement::QuarterlyCashFlowStatementPage.new 'ACT'
+    #   rs = is.fetch
+    #   YahooFinance::FinancialStatement::CASH_FLOW_STMT_FIELDS.keys.each do |attr|
+    #     fields = rs[attr]
+    #     fields.class.name.should == "Array"
+    #     fields.size.should == 3
+    #     fields.each do |field|
+    #       attr == :statement_periods ? field.class.name.should == "Date" : field.class.name.should == "Float"
+    #     end
+    #   end
+    # end
     it "should return a nil hash if yahoo doesn't have the statement, e.g. for AMBR" do
       is = YahooFinance::FinancialStatement::QuarterlyCashFlowStatementPage.new 'AMBR'
       rs = is.fetch

data/yahoo_finance.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = YahooFinance::VERSION
   spec.authors       = ["Takis Mercouris"]
   spec.email         = ["tm@polymechanus.com"]
-  spec.description   = %q{Unified library to stock quotes and various pages in yahoo finance, including key statistics, company events, and analyst opinion}
+  spec.description   = %q{Unified library to stock quotes and various pages in yahoo finance, including key statistics, company events, analyst estimates, analyst opinion, and financial statements}
   spec.summary       = %q{Fetch stock information from yahoo finance API and HTML pages}
   spec.homepage      = "http://polymechanus.com/yahoo_finance-ruby-gem-tutorial/"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_finance_lib
 version: !ruby/object:Gem::Version
-  version: 0.7.9.9
+  version: '1.0'
 platform: ruby
 authors:
 - Takis Mercouris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nas-yahoo_stock
@@ -99,7 +99,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.14.1
 description: Unified library to stock quotes and various pages in yahoo finance, including
-  key statistics, company events, and analyst opinion
+  key statistics, company events, analyst estimates, analyst opinion, and financial
+  statements
 email:
 - tm@polymechanus.com
 executables: []
@@ -113,6 +114,7 @@ files:
 - README.md
 - Rakefile
 - lib/yahoo_finance.rb
+- lib/yahoo_finance/analyst_estimates.rb
 - lib/yahoo_finance/analyst_opinion.rb
 - lib/yahoo_finance/company_events.rb
 - lib/yahoo_finance/company_profile.rb
@@ -121,6 +123,7 @@ files:
 - lib/yahoo_finance/stock.rb
 - lib/yahoo_finance/version.rb
 - spec/spec_helper.rb
+- spec/yahoo_analyst_estimates_spec.rb
 - spec/yahoo_analyst_opinion_spec.rb
 - spec/yahoo_company_events_spec.rb
 - spec/yahoo_company_profile_spec.rb
@@ -148,12 +151,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Fetch stock information from yahoo finance API and HTML pages
 test_files:
 - spec/spec_helper.rb
+- spec/yahoo_analyst_estimates_spec.rb
 - spec/yahoo_analyst_opinion_spec.rb
 - spec/yahoo_company_events_spec.rb
 - spec/yahoo_company_profile_spec.rb