yahoo-finance 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4d05824e6ec9455f7431eb7450405a4f187502c
-  data.tar.gz: 53b32872affff1bd7a1ba6153b73f62aac280852
+  metadata.gz: 9c9c50a4db7239780947f98ccac1239b206f6d3f
+  data.tar.gz: dcaa2a3413b9047165882ac7b485a7d6ba10b6f4
 SHA512:
-  metadata.gz: 69bbfa32a532c46ee3360b58a48492b74638e4816513359d7b7c212c6909fc317d92e9100cd63d1302aaa52ac94dc759ee740215fc4cff1af349afbdaf215c7b
-  data.tar.gz: 5dfa9bbe070a5bcce32df9ffedb1257d9e2880c8dcbc052bef866a47a4d557aae49f1d97a3fefa36c042873c69d2bdbce287c04509514c86ee68f3c0dd759918
+  metadata.gz: 975822b34c359f5dd724dc1672d336d49017256316ee215364bfd5d88909a47f7c272f5b8ab37a356543ab886ee723fc1ea9bf2dd57024f5cc615df8725adbfb
+  data.tar.gz: 345fe8dd44e08e1acfd7c57f1bfd26a1ddb913e4cfaa4a6b120a47c3b48d01bd804a8061faed913819ad49d820e6cee659cabeb7cc068ecfab24f55422da4509

data/HISTORY

@@ -1,3 +1,9 @@
+1.2.0 - Feb 04, 2017
+====================
+* Fixed support for { raw: false }
+* Symbols that are not found will now not return (instead of returning a struct with an empty :symbol field and a bunch of "N/A"s)
+* The returned quotes now will always include the :symbol name 
+
 0.3.0 - Aug 16, 2015
 ====================
 * Refactorings & support for US companies data (via NASDAQ's Apis) - by Eric D. Santos Sosa
@@ -20,4 +26,4 @@
 
 0.0.1 - Aug 04, 2007
 ===============================
-* Initial implementation - no bells, no whristles :)
+* Initial implementation - no bells, no whistles :)

data/README.md

@@ -30,7 +30,21 @@ Passing `raw: false` will return numerical values
 ```ruby
 yahoo_client = YahooFinance::Client.new
 data = yahoo_client.quotes(["BVSP", "NATU3.SA", "USDJPY=X"], [:ask, :bid, :last_trade_date], { raw: false } )
-data[0].ask # This is now a float
+data[0].ask # This is now a BigDecimal
+```
+
+Passing `na_as_nil: true` will convert "N/A" responses to `nil`
+
+```ruby
+yahoo_client = YahooFinance::Client.new
+
+data = yahoo_client.quotes(["BVSP"], [:ask] )
+data[0].ask
+> "N/A"
+
+data = yahoo_client.quotes(["BVSP"], [:ask], { na_as_nil: true } )
+data[0].ask
+> nil
 ```
 
 The full list of fields follows:

data/lib/yahoo-finance.rb

@@ -4,6 +4,7 @@ require "json"
 require "yahoo-finance/version"
 require "yahoo-finance/finance-utils"
 require "csv"
+require 'bigdecimal'
 
 module YahooFinance
   # Client for Yahoo Finance Queries
@@ -11,92 +12,93 @@ module YahooFinance
     include YahooFinance::FinanceUtils
 
     COLUMNS = {
-      ask: "a", 
-      average_daily_volume: "a2", 
-      ask_size: "a5", 
-      bid: "b",
-      ask_real_time: "b2", 
-      bid_real_time: "b3", 
-      book_value: "b4",
-      bid_size: "b6", 
-      change_and_percent_change: "c", 
-      change: "c1",
-      comission: "c3", 
-      change_real_time: "c6",
-      after_hours_change_real_time: "c8", 
-      dividend_per_share: "d",
-      last_trade_date: "d1", 
-      trade_date: "d2", 
-      earnings_per_share: "e",
-      error_indicator: "e1", 
-      eps_estimate_current_year: "e7",
-      eps_estimate_next_year: "e8", 
-      eps_estimate_next_quarter: "e9",
-      float_shares: "f6", 
-      low: "g", high: "h", 
-      low_52_weeks: "j",
-      high_52_weeks: "k", 
-      holdings_gain_percent: "g1", 
-      annualized_gain: "g3",
-      holdings_gain: "g4", 
-      holdings_gain_percent_realtime: "g5",
-      holdings_gain_realtime: "g6", 
-      more_info: "i", 
-      order_book: "i5",
-      market_capitalization: "j1", 
-      shares_outstanding: "j2",
-      market_cap_realtime: "j3", 
-      ebitda: "j4",
-      change_From_52_week_low: "j5", 
-      percent_change_from_52_week_low: "j6",
-      last_trade_realtime_withtime: "k1", 
-      change_percent_realtime: "k2",
-      last_trade_size: "k3", 
-      change_from_52_week_high: "k4",
-      percent_change_from_52_week_high: "k5", 
-      last_trade_with_time: "l",
-      last_trade_price: "l1", 
-      close: "l1", 
-      high_limit: "l2", 
-      low_limit: "l3",
-      days_range: "m", 
-      days_range_realtime: "m2", 
-      moving_average_50_day: "m3",
-      moving_average_200_day: "m4", 
-      change_from_200_day_moving_average: "m5",
-      percent_change_from_200_day_moving_average: "m6",
-      change_from_50_day_moving_average: "m7",
-      percent_change_from_50_day_moving_average: "m8", 
-      name: "n", 
-      notes: "n4",
-      open: "o", previous_close: "p", 
-      price_paid: "p1", 
-      change_in_percent: "p2",
-      price_per_sales: "p5", 
-      price_per_book: "p6", 
-      ex_dividend_date: "q",
-      pe_ratio: "r", 
-      dividend_pay_date: "r1", 
-      pe_ratio_realtime: "r2",
-      peg_ratio: "r5", 
-      price_eps_estimate_current_year: "r6",
-      price_eps_Estimate_next_year: "r7", 
-      symbol: "s", 
-      shares_owned: "s1",
-      revenue: "s6",
-      short_ratio: "s7", last_trade_time: "t1", 
-      trade_links: "t6",
-      ticker_trend: "t7", 
-      one_year_target_price: "t8", volume: "v",
-      holdings_value: "v1", 
-      holdings_value_realtime: "v7", 
-      weeks_range_52: "w",
-      day_value_change: "w1", 
-      day_value_change_realtime: "w4",
-      stock_exchange: "x", 
-      dividend_yield: "y", 
-      adjusted_close: nil
-      # only in historical quotes ^
+      :ask => ["a", BigDecimal],
+      :average_daily_volume => ["a2", BigDecimal],
+      :ask_size => ["a5", BigDecimal],
+      :bid => ["b", BigDecimal],
+      :ask_real_time => ["b2", Time],
+      :bid_real_time => ["b3", BigDecimal],
+      :book_value => ["b4", BigDecimal],
+      :bid_size => ["b6", BigDecimal],
+      :chance_and_percent_change => ["c", String],
+      :change => ["c1", BigDecimal],
+      :comission => ["c3", String],
+      :change_real_time => ["c6", BigDecimal],
+      :after_hours_change_real_time => ["c8", String],
+      :dividend_per_share => ["d", BigDecimal],
+      :last_trade_date => ["d1", DateTime],
+      :trade_date => ["d2", String],
+      :earnings_per_share => ["e", BigDecimal],
+      :error_indicator => ["e1", String],
+      :eps_estimate_current_year => ["e7", BigDecimal],
+      :eps_estimate_next_year => ["e8", BigDecimal],
+      :eps_estimate_next_quarter => ["e9", BigDecimal],
+      :float_shares => ["f6", BigDecimal],
+      :low => ["g", BigDecimal],
+      :high => ["h", BigDecimal],
+      :low_52_weeks => ["j", BigDecimal],
+      :high_52_weeks => ["k", BigDecimal],
+      :holdings_gain_percent => ["g1", BigDecimal],
+      :annualized_gain => ["g3", BigDecimal],
+      :holdings_gain => ["g4", BigDecimal],
+      :holdings_gain_percent_realtime => ["g5", BigDecimal],
+      :holdings_gain_realtime => ["g6", BigDecimal],
+      :more_info => ["i", String],
+      :order_book => ["i5", BigDecimal],
+      :market_capitalization => ["j1", BigDecimal],
+      :market_cap_realtime => ["j3", BigDecimal],
+      :ebitda => ["j4", BigDecimal],
+      :change_From_52_week_low => ["j5", BigDecimal],
+      :percent_change_from_52_week_low => ["j6", BigDecimal],
+      :last_trade_realtime_withtime => ["k1", String],
+      :change_percent_realtime => ["k2", String],
+      :last_trade_size => ["k3", BigDecimal],
+      :change_from_52_week_high => ["k4", BigDecimal],
+      :percent_change_from_52_week_high => ["k5", BigDecimal],
+      :last_trade_with_time => ["l", String],
+      :last_trade_price => ["l1", BigDecimal],
+      :close => ["l1", BigDecimal], # same as :last_trade_price
+      :high_limit => ["l2", BigDecimal],
+      :low_limit => ["l3", BigDecimal],
+      :days_range => ["m", BigDecimal],
+      :days_range_realtime => ["m2", BigDecimal],
+      :moving_average_50_day => ["m3", BigDecimal],
+      :moving_average_200_day => ["m4", BigDecimal],
+      :change_from_200_day_moving_average => ["m5", BigDecimal],
+      :percent_change_from_200_day_moving_average => ["m6", BigDecimal],
+      :change_from_50_day_moving_average => ["m7", BigDecimal],
+      :percent_change_from_50_day_moving_average => ["m8", BigDecimal],
+      :name => ["n", String],
+      :notes => ["n4", String],
+      :open => ["o", BigDecimal],
+      :previous_close => ["p", BigDecimal],
+      :price_paid => ["p1", BigDecimal],
+      :change_in_percent => ["p2", BigDecimal],
+      :price_per_sales => ["p5", BigDecimal],
+      :price_per_book => ["p6", BigDecimal],
+      :ex_dividend_date => ["q", DateTime],
+      :pe_ratio => ["p5", BigDecimal],
+      :dividend_pay_date => ["r1", String],
+      :pe_ratio_realtime => ["r2", BigDecimal],
+      :peg_ratio => ["r5", BigDecimal],
+      :price_eps_estimate_current_year => ["r6", BigDecimal],
+      :price_eps_Estimate_next_year => ["r7", BigDecimal],
+      :symbol => ["s", String],
+      :shares_owned => ["s1", BigDecimal],
+      :short_ratio => ["s7", BigDecimal],
+      :last_trade_time => ["t1", Time],
+      :trade_links => ["t6", String],
+      :ticker_trend => ["t7", String],
+      :one_year_target_price => ["t8", BigDecimal],
+      :volume => ["v", BigDecimal],
+      :holdings_value => ["v1", String],
+      :holdings_value_realtime => ["v7", String],
+      :weeks_range_52 => ["w", BigDecimal],
+      :day_value_change => ["w1", BigDecimal],
+      :day_value_change_realtime => ["w4", String],
+      :stock_exchange => ["x", String],
+      :dividend_yield => ["y", BigDecimal],
+      :adjusted_close => [nil, BigDecimal] # this one only comes in historical quotes      
     }
 
     HISTORICAL_MODES = {
@@ -111,27 +113,31 @@ module YahooFinance
     # retrieve the quote data (an OpenStruct per quote)
     # the options param can be used to specify the following attributes:
     # :raw - if true, each column will be converted (to numbers, dates, etc)
-    def quotes(symbols_array, columns_array = [
-      :symbol, :last_trade_price, :last_trade_date,
-      :change, :previous_close], options = {})
+    def quotes(symbols_array, columns_array = [:symbol, :last_trade_price, :last_trade_date, :change, :previous_close], options = {})
+      # remove invalid keys
+      columns_array.reject! { |c| !COLUMNS.key?(c) }
+      columns_array << :symbol if columns_array.index(:symbol).nil?
+
+      # "N/A" is never present if { raw = false }
+      options[:na_as_nil] = true if options[:raw] == false
 
-      options[:raw] ||= true
       ret = []
       symbols_array.each_slice(SYMBOLS_PER_REQUEST) do |symbols|
         read_quotes(symbols.join("+"), columns_array).map do |row|
+          data = row.to_hash
           if options[:na_as_nil]
-            row.each{ |key, value| row[key] = nil if value == 'N/A' }
+            data.each { |key, value| data[key] = nil if value == 'N/A' }
           end
-          ret << OpenStruct.new(row.to_hash)
+          if options[:raw] == false
+            data.each { |key, value| data[key] = format(value, COLUMNS[key][1]) }
+          end
+          ret << OpenStruct.new(data)
         end
       end
       ret
     end
 
-    def quote(symbol, columns_array = [
-      :symbol, :last_trade_price, :last_trade_date,
-      :change, :previous_close], options = {})
-
+    def quote(symbol, columns_array = [:symbol, :last_trade_price, :last_trade_date, :change, :previous_close], options = {})
       options[:raw] ||= true
       quotes([symbol], columns_array, options).first
     end
@@ -154,27 +160,36 @@ module YahooFinance
 
     def splits(symbol, options = {})
       rows = read_splits(symbol, options).select { |row| row[0] == "SPLIT" }
-      rows.map do |row|
-        type, date, value = row
+      rows.map do |type, date, value|
         after, before = value.split(":")
-        OpenStruct.new(
-          symbol: symbol, date: Date.strptime(date.strip, "%Y%m%d"),
-          before: before.to_i, after: after.to_i)
+        OpenStruct.new(symbol: symbol, date: Date.strptime(date.strip, "%Y%m%d"), before: before.to_i, after: after.to_i)
+      end
+    end
+
+    def format(str, type)
+      if str.nil?
+        str
+      elsif type == BigDecimal
+        BigDecimal.new(str)
+      elsif type == DateTime
+        DateTime.parse(str)
+      elsif type == Time
+        Time.parse(str)
+      else
+        str
       end
     end
 
     private
 
     def read_quotes(symb_str, cols)
-      columns = "#{cols.map { |col| COLUMNS[col] }.join("")}"
+      columns = "#{cols.map { |col| COLUMNS[col][0] }.join("")}"
       conn = open("https://download.finance.yahoo.com/d/quotes.csv?s=#{URI.escape(symb_str)}&f=#{columns}")
       CSV.parse(conn.read, headers: cols)
     end
 
     def read_historical(symbol, options)
-      params = {
-        s: URI.escape(symbol), g: HISTORICAL_MODES[options[:period]],
-        ignore: ".csv" }
+      params = { s: URI.escape(symbol), g: HISTORICAL_MODES[options[:period]], ignore: ".csv" }
       if options[:start_date]
         params[:a] = options[:start_date].month-1
         params[:b] = options[:start_date].day
@@ -191,8 +206,7 @@ module YahooFinance
      cols = if options[:period] == :dividends_only
               [:dividend_pay_date, :dividend_yield]
             else
-              [:trade_date, :open, :high, :low,
-               :close, :volume, :adjusted_close]
+              [:trade_date, :open, :high, :low, :close, :volume, :adjusted_close]
             end
      result = CSV.parse(conn.read, headers: cols)
      #:first_row, :header_converters => :symbol)
@@ -201,8 +215,7 @@ module YahooFinance
     end
 
     def read_splits(symbol, options)
-      params = {
-        s: URI.escape(symbol), g: "v" }
+      params = { s: URI.escape(symbol), g: "v" }
       if options[:start_date]
         params[:a] = options[:start_date].month-1
         params[:b] = options[:start_date].day

data/lib/yahoo-finance/version.rb

@@ -1,4 +1,4 @@
 # Version Variable for Yahoo Finance Gem
 module YahooFinance
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yahoo-finance
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Herval Freire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement