yahoo_quote 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.rvmrc
+Gemfile.lock
+extras/
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yahoo_quote.gemspec
+gemspec

data/README

@@ -0,0 +1 @@
+Gem to interact with Yahoo Finance API

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/old_yahoo_quote.rb

@@ -0,0 +1,141 @@
+require 'csv'
+require 'open-uri'
+require 'nokogiri'
+
+# Gets company name, quote and stock graph
+# See http://cliffngan.net/a/13
+#
+class YahooQuote
+  attr_accessor :name, :data, :csv, :command
+
+  def initialize(symbol)
+    @symbol = symbol.gsub(".", '') # yahoo csv expects no periods
+    parse_csv
+  end
+
+  def parse_csv
+    # abort if symbol has a weird character
+    if @symbol =~ /\W/
+      return
+    end
+    keys = "snl1j1s1wvre7e8r6r7"
+    @command = %Q|curl -sL "http://finance.yahoo.com/d/quotes.csv?s=#@symbol&f=#{keys}" |
+    @csv ||= %x[ #{@command} ]
+    @data = CSV.parse_line @csv
+    @symbol, @name = *@data
+  end
+
+  def valid?
+    return false unless @data
+    @data[3] != "N/A"
+  end
+
+  def company_name_orig
+    valid? ? name : nil
+  end
+
+  def company_name
+    return unless valid?
+    return @company_name if @company_name
+    res = `curl -Ls "http://query.yahooapis.com/v1/public/yql?q=select%20CompanyName%20from%20yahoo.finance.stocks%20where%20symbol%3D%22#{@symbol}%22&format=xml&env=store%3A%2F%2Fdatatables.org%2Falltableswithkeys"`
+    @company_name = Nokogiri::XML.parse(res).at("//CompanyName").inner_text
+  rescue
+    "No company name found"
+  end
+
+  def day_graph_url
+    return nil unless valid?
+    "http://ichart.finance.yahoo.com/t?s=#@symbol"
+  end
+
+  # the year graph
+  def graph_url 
+    return nil unless valid?
+    "http://chart.finance.yahoo.com/z?s=#{@symbol}&t=1y&q=&l=&z=l&p=s&a=v&p=s&lang=en-US&region=US"
+  end
+
+  def graph_header
+    return nil unless valid?
+    url = "http://ichart.finance.yahoo.com/t?s=#@symbol"
+    url + "\n" +  `curl -sI "#{url}"`
+  end
+end
+
+if __FILE__ == $0
+  puts ARGV.first
+  y = YahooQuote.new ARGV.first
+  puts y.name
+  puts y.company_name
+  puts y.csv.inspect
+  puts y.data.inspect
+
+end
+
+
+__END__
+
+
+Usage
+
+y = YahooQuote.new("AMZN")
+puts y.name
+puts y.data.inspect
+puts y.valid?
+
+exit
+
+# try a nonexisting symbol
+
+y = YahooQuote.new("Alwkjlkwadj")
+puts y.name
+puts y.data.inspect
+puts y.valid?
+
+
+
+
+
+
+url = "http://finance.yahoo.com/d/quotes.csv?s=AMZN&f=snd1l1yr"
+puts `curl -sL '#{url}'`
+
+url = "http://finance.yahoo.com/d/quotes.csv?s=AMZN&f=snd1l1yr"
+puts `curl -sL '#{url}'`
+
+url = "http://ichart.finance.yahoo.com/t?s=%5AMZN"
+#puts `curl -sL '#{url}'` # => outputs a png file
+
+
+
+"XOM","Exxon Mobil Corpo","7/8/2011",82.42,2.17,11.73
+"BBD-B.TO","BOMBARDIER INC., ","7/8/2011",6.76,1.12,15.60
+"JNJ","Johnson & Johnson","7/8/2011",67.57,3.22,15.40
+"MSFT","Microsoft Corpora","7/8/2011",26.92,2.28,10.64
+
+
+2nd query:
+
+"<img border=0  width=512 height=288
+src="http://chart.yahoo.com/c/AMZN/a/amzn.gif" alt="Chart"><br><table><tr><td width=512 align=center><font face=arial size=-1></font></td></tr></table>"
+
+
+
+"AMZN","Amazon.com, Inc.","7/8/2011",218.28,N/A,93.87
+"MSFT","Microsoft Corpora","7/8/2011",26.92,2.28,10.64
+"&nbsp;======&nbsp;"
+
+
+"AMZN","Amazon.com, Inc.","7/8/2011",218.28,N/A,93.87
+"MSFT","Microsoft Corpora","7/8/2011",26.92,2.28,10.64
+
+"AMZN","Amazon.com, Inc.","7/8/2011",218.28,N/A,93.87
+"MSFT","Microsoft Corpora","7/8/2011",26.92,2.28,10.64
+"<img border=0  width=512 height=288
+src="http://chart.yahoo.com/c//m/msft.gif" alt="Chart"><br><table><tr><td width=512 align=center><font face=arial size=-1></font></td></tr></table>","MSFT"
+
+http://ichart.finance.yahoo.com/t?s=%5EHSI
+
+"AMZN","Amazon.com, Inc.","7/8/2011",218.28,N/A,93.87
+"MSFT","Microsoft Corpora","7/8/2011",26.92,2.28,10.64
+
+

data/lib/yahoo_quote/configuration.rb

@@ -0,0 +1,16 @@
+module YahooQuote
+  class Configuration
+
+    def self.cache_dir=(path)
+      dir = path.to_s
+      Dir.mkdir(dir) unless File.directory?(dir)
+      @@cache_dir = dir
+    end
+
+    def self.cache_dir
+      @@cache_dir
+    end
+
+    @@cache_dir = nil
+  end
+end

data/lib/yahoo_quote/version.rb

@@ -0,0 +1,3 @@
+module YahooQuote
+  VERSION = "0.0.1"
+end

data/lib/yahoo_quote.rb

@@ -0,0 +1,176 @@
+require "yahoo_quote/version"
+require "yahoo_quote/configuration"
+
+require 'open-uri'
+require 'csv'
+
+class Hash
+  def self.csv_load( meta, headers, fields )
+    self[*headers.zip(fields).flatten.map { |e| eval(e) }]
+  end
+
+  def csv_headers
+    keys.map { |key| key.inspect }
+  end
+
+  def csv_dump( headers )
+    headers.map { |header| fetch(eval(header)).inspect }
+  end
+end
+
+module YahooQuote
+  class Quote
+    def initialize(symbol, fields)
+      @symbol = symbol.gsub(".", '') # yahoo csv expects no periods
+      @fields = fields
+    end
+
+    def field_mappings
+      {
+        "1 yr Target Price" => "t8",
+        "200-day Moving Average" => "m4",
+        "50-day Moving Average" => "m3",
+        "52-week High" => "k",
+        "52-week Low" => "j",
+        "52-week Range" => "w",
+        "After Hours Change (Real-time)" => "c8",
+        "Annualized Gain" => "g3",
+        "Ask (Real-time)" => "b2",
+        "Ask Size" => "a5",
+        "Ask" => "a",
+        "Average Daily Volume" => "a2",
+        "Bid (Real-time)" => "b3",
+        "Bid Size" => "b6",
+        "Bid" => "b",
+        "Book Value" => "b4",
+        "Change & Percent Change" => "c",
+        "Change (Real-time)" => "c6",
+        "Change From 200-day Moving Average" => "m5",
+        "Change From 50-day Moving Average" => "m7",
+        "Change From 52-week High" => "k4",
+        "Change From 52-week Low" => "j5",
+        "Change Percent (Real-time)" => "k2",
+        "Change in Percent" => "p2",
+        "Change" => "c1",
+        "Commission" => "c3",
+        "Day's High" => "h",
+        "Day's Low" => "g",
+        "Day's Range (Real-time)" => "m2",
+        "Day's Range" => "m",
+        "Day's Value Change (Real-time)" => "w4",
+        "Day's Value Change" => "w1",
+        "Dividend Pay Date" => "r1",
+        "Dividend Yield" => "y",
+        "Dividend/Share" => "d",
+        "EBITDA" => "j4",
+        "EPS Estimate Current Year" => "e7",
+        "EPS Estimate Next Quarter" => "e9",
+        "EPS Estimate Next Year" => "e8",
+        "Earnings/Share" => "e",
+        "Error Indication (returned for symbol changed / invalid)" => "e1",
+        "Ex-Dividend Date" => "q",
+        "Float Shares" => "f6",
+        "High Limit" => "l2",
+        "Holdings Gain (Real-time)" => "g6",
+        "Holdings Gain Percent (Real-time)" => "g5",
+        "Holdings Gain Percent" => "g1",
+        "Holdings Gain" => "g4",
+        "Holdings Value (Real-time)" => "v7",
+        "Holdings Value" => "v1",
+        "Last Trade (Price Only)" => "l1",
+        "Last Trade (Real-time) With Time" => "k1",
+        "Last Trade (With Time)" => "l",
+        "Last Trade Date" => "d1",
+        "Last Trade Size" => "k3",
+        "Last Trade Time" => "t1",
+        "Low Limit" => "l3",
+        "Market Cap (Real-time)" => "j3",
+        "Market Capitalization" => "j1",
+        "More Info" => "i",
+        "Name" => "n",
+        "Notes" => "n4",
+        "Open" => "o",
+        "Order Book (Real-time)" => "i5",
+        "P/E Ratio (Real-time)" => "r2",
+        "P/E Ratio" => "r",
+        "PEG Ratio" => "r5",
+        "Percebt Change From 52-week High" => "k5",
+        "Percent Change From 200-day Moving Average" => "m6",
+        "Percent Change From 50-day Moving Average" => "m8",
+        "Percent Change From 52-week Low" => "j6",
+        "Previous Close" => "p",
+        "Price Paid" => "p1",
+        "Price/Book" => "p6",
+        "Price/EPS Estimate Current Year" => "r6",
+        "Price/EPS Estimate Next Year" => "r7",
+        "Price/Sales" => "p5",
+        "Shares Owned" => "s1",
+        "Short Ratio" => "s7",
+        "Stock Exchange" => "x",
+        "Symbol" => "s",
+        "Ticker Trend" => "t7",
+        "Trade Date" => "d2",
+        "Trade Links" => "t6",
+        "Volume" => "v",
+      }
+    end
+
+    def parse_csv(csv)
+      values = CSV.parse_line(csv)
+      # TODO check result.size == fields.size
+      response = {}
+      values.each_with_index {|value, i| response[@fields[i]] = value}
+      response
+    end
+
+    def validate(response)
+      # Yahoo returns company name even if ticker symbol is invalid, other
+      # fields are also populated.
+      response["Market Capitalization"] == 'N/A' ? {} : response
+    end
+
+#    def company_name_url
+#      "http://query.yahooapis.com/v1/public/yql?q=select%20CompanyName%20from%20yahoo.finance.stocks%20where%20symbol%3D%22#{@symbol}%22&format=xml&env=store%3A%2F%2Fdatatables.org%2Falltableswithkeys"
+#    end
+
+    def quote_url
+      tags = @fields.map{|x| field_mappings[x]}.join
+      "http://download.finance.yahoo.com/d/quotes.csv?s=#{@symbol}&f=#{tags}"
+    end
+
+    def graph_url
+      return nil unless valid?
+      "http://chart.finance.yahoo.com/z?s=#{@symbol}&t=1y&q=&l=&z=l&p=s&a=v&p=s&lang=en-US&region=US"
+    end
+
+    def data
+      return @data if @data
+
+      io = URI.parse(quote_url)
+      begin
+        csv = io.read
+      rescue
+        csv = ''
+      end
+      @data = validate(parse_csv(csv))
+      if cache_response? && valid?
+        File.open(filename_quote, 'w') {|f| CSV.dump([@data], f) }
+      elsif cache_response? && File.file?(filename_quote)
+        @data = (File.open(filename_quote, 'r') {|f| CSV.load(f)}).first
+      end
+      @data
+    end
+
+    def filename_quote
+      YahooQuote::Configuration.cache_dir + "/#{@symbol}.csv"
+    end
+
+    def valid?
+      @data && @data.size > 0
+    end
+
+    def cache_response?
+      YahooQuote::Configuration.cache_dir
+    end
+  end
+end

data/test/fakeweb/aapl.csv

@@ -0,0 +1,9 @@
+HTTP/1.1 200 OK
+Date: Mon, 06 Feb 2012 22:33:15 GMT
+P3P: policyref="http://p3p.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE GOV"
+Cache-Control: private
+Connection: close
+Transfer-Encoding: chunked
+Content-Type: application/octet-stream
+
+"AAPL","Apple Inc.",463.97,432.6B

data/test/fakeweb/aapl_bad.csv

@@ -0,0 +1,9 @@
+HTTP/1.1 200 OK
+Date: Mon, 06 Feb 2012 20:40:18 GMT
+P3P: policyref="http://p3p.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE GOV"
+Cache-Control: private
+Connection: close
+Transfer-Encoding: chunked
+Content-Type: application/octet-stream
+
+

data/test/yahoo_quote_test.rb

@@ -0,0 +1,58 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '../lib')
+
+require 'yahoo_quote'
+require 'minitest/autorun'
+require 'fakeweb'
+
+# test error:    YahooQuote::Configuration.cache_dir = "/etc/kk"
+#
+class TestYahooQuote < MiniTest::Unit::TestCase
+  def setup
+    # TODO make gem method to clear the cache
+    `rm -f /tmp/*csv`
+  end
+
+  def test_live_quote
+    quote = YahooQuote::Quote.new('CSCO', ['Symbol', 'Name'])
+    assert_equal "CSCO",              quote.data["Symbol"]
+    assert_equal "Cisco Systems, In", quote.data["Name"]
+  end
+
+  def test_invalid_ticker_symbol
+    quote = YahooQuote::Quote.new('ECOMMERCE', ['Symbol', 'Name', 'Market Capitalization'])
+    assert_nil quote.data["Name"]
+    assert_equal false, quote.valid?
+    # TODO check no cached
+  end
+
+  def test_get_quote
+    quote = YahooQuote::Quote.new('AAPL', ['Symbol', 'Name', 'Last Trade (Price Only)', 'Market Capitalization'])
+    FakeWeb.register_uri(:get, quote.quote_url, :response => File.read('test/fakeweb/aapl.csv'))
+    assert_equal "Apple Inc.", quote.data["Name"]
+    assert_equal 463.97,       quote.data["Last Trade (Price Only)"].to_f
+    assert_equal '432.6B',     quote.data["Market Capitalization"]
+  end
+
+  def test_graph_url
+    quote = YahooQuote::Quote.new('AAPL', ['Symbol', 'Name', 'Last Trade (Price Only)', 'Market Capitalization'])
+    FakeWeb.register_uri(:get, quote.quote_url, :response => File.read('test/fakeweb/aapl.csv'))
+    # TODO this should not be necessary
+    assert_equal "Apple Inc.", quote.data["Name"]
+    assert_match %r(^http://chart.finance.yahoo.com/z\?s=AAPL), quote.graph_url
+  end
+
+  def test_get_quote_from_cache
+    YahooQuote::Configuration.cache_dir = "/tmp"
+    quote = YahooQuote::Quote.new('AAPL', ['Symbol', 'Name', 'Last Trade (Price Only)'])
+    FakeWeb.register_uri(:get, quote.quote_url, :response => File.read('test/fakeweb/aapl.csv'))
+    assert_equal "Apple Inc.", quote.data["Name"]
+    assert_equal 463.97,       quote.data["Last Trade (Price Only)"].to_f
+    # the quote should be cached now
+    quote2 = YahooQuote::Quote.new('AAPL', ['Symbol', 'Name', 'Last Trade (Price Only)'])
+    response = File.read('test/fakeweb/aapl_bad.csv')
+    refute_match /Apple/i, response
+    FakeWeb.register_uri(:get, quote2.quote_url, :response => response)
+    assert_equal "Apple Inc.", quote2.data["Name"]
+    assert_equal 463.97,       quote2.data["Last Trade (Price Only)"].to_f
+  end
+end

data/yahoo_quote.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yahoo_quote/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yahoo_quote"
+  s.version     = YahooQuote::VERSION
+  s.authors     = ["Braulio Carreno"]
+  s.email       = ["bcarreno@yahoo.com"]
+  s.homepage    = "https://github.com/bcarreno/yahoo_quote"
+  s.summary     = %q{Yahoo Finance stock quotes}
+  s.description = %q{Facilitates querying Yahoo Finance stock API}
+
+  s.add_development_dependency "fakeweb"
+
+  s.rubyforge_project = "yahoo_quote"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: yahoo_quote
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Braulio Carreno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2157063640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157063640
+description: Facilitates querying Yahoo Finance stock API
+email:
+- bcarreno@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- lib/old_yahoo_quote.rb
+- lib/yahoo_quote.rb
+- lib/yahoo_quote/configuration.rb
+- lib/yahoo_quote/version.rb
+- test/fakeweb/aapl.csv
+- test/fakeweb/aapl_bad.csv
+- test/yahoo_quote_test.rb
+- yahoo_quote.gemspec
+homepage: https://github.com/bcarreno/yahoo_quote
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: yahoo_quote
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Yahoo Finance stock quotes
+test_files:
+- test/fakeweb/aapl.csv
+- test/fakeweb/aapl_bad.csv
+- test/yahoo_quote_test.rb