yahoo_quote 0.0.1 → 0.0.2

data/.gitignore

@@ -4,3 +4,4 @@
 Gemfile.lock
 extras/
 pkg/*
+test/cache/

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Braulio Carreno
+
+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.markdown

@@ -0,0 +1,43 @@
+# yahoo_quote
+
+Easy interaction with Yahoo Finance API
+
+## Installation
+
+    gem install yahoo_quote
+
+## Usage
+
+```ruby
+require 'yahoo_quote'
+quote = YahooQuote::Quote.new('AAPL', ['Name', 'Last Trade (Price Only)', 'P/E Ratio'])
+quote.valid?
+# => true
+quote.data['Name']
+# => "Apple Inc."
+quote.data['Last Trade (Price Only)']
+# => 502.12
+quote.data['P/E Ratio']
+# => 14.29
+quote = YahooQuote::Quote.new('ECOMMERCE', ['Name', 'Last Trade (Price Only)', 'P/E Ratio'])
+quote.valid?
+# => false
+```
+
+To get list of supported fields:
+
+```ruby
+puts quote.field_mappings.keys
+````
+
+## Configuration
+
+Use /tmp to keep a simple cache:
+
+```ruby
+YahooQuote::Configuration.cache_dir = "/tmp"
+```
+
+## Copyright
+
+Copyright (c) 2012 Braulio Carreno. See LICENSE for details.

data/lib/yahoo_quote.rb

@@ -23,9 +23,45 @@ module YahooQuote
     def initialize(symbol, fields)
       @symbol = symbol.gsub(".", '') # yahoo csv expects no periods
       @fields = fields
+      # used by validate method
+      @fields << "Market Capitalization" unless @fields.include? "Market Capitalization"
+      pull_data
     end
 
+    def valid?
+      return false unless @data
+      @data.size > 0
+    end
+
+    def data
+      @data.nil? ? {} : @data
+    end
+
+    def cache_response?
+      YahooQuote::Configuration.cache_dir
+    end
+
+    def filename_quote
+      YahooQuote::Configuration.cache_dir + "/#{@symbol}.csv"
+    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
+
+#    Not working any longer
+#    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 field_mappings
+      # From http://cliffngan.net/a/13
       {
         "1 yr Target Price" => "t8",
         "200-day Moving Average" => "m4",
@@ -115,36 +151,11 @@ module YahooQuote
       }
     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
+    private
 
-    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
+    def pull_data
+      # abort if symbol has a weird character
+      return if @symbol.empty? || @symbol =~ /\W/
 
       io = URI.parse(quote_url)
       begin
@@ -153,24 +164,27 @@ module YahooQuote
         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
+      if cache_response?
+        if valid?
+          File.open(filename_quote, 'w') {|f| CSV.dump([@data], f) }
+        elsif File.file?(filename_quote)
+          @data = (File.open(filename_quote, 'r') {|f| CSV.load(f)}).first
+        end
       end
-      @data
-    end
-
-    def filename_quote
-      YahooQuote::Configuration.cache_dir + "/#{@symbol}.csv"
     end
 
-    def valid?
-      @data && @data.size > 0
+    def parse_csv(csv)
+      values = CSV.parse_line(csv, :converters => :numeric)
+      # TODO check result.size == fields.size
+      response = {}
+      values.each_with_index {|value, i| response[@fields[i]] = value}
+      response
     end
 
-    def cache_response?
-      YahooQuote::Configuration.cache_dir
+    def validate(response)
+      # Yahoo csv returns values even if ticker symbol is invalid,
+      # use this condition to make sure the response is ok.
+      response["Market Capitalization"] == 'N/A' ? {} : response
     end
   end
 end

data/lib/yahoo_quote/configuration.rb

@@ -3,7 +3,7 @@ module YahooQuote
 
     def self.cache_dir=(path)
       dir = path.to_s
-      Dir.mkdir(dir) unless File.directory?(dir)
+      Dir.mkdir(dir) unless dir.empty? || File.directory?(dir)
       @@cache_dir = dir
     end
 

data/lib/yahoo_quote/version.rb

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

data/test/fakeweb/{aapl.csv → aapl_good.csv}

@@ -1,9 +1,9 @@
 HTTP/1.1 200 OK
-Date: Mon, 06 Feb 2012 22:33:15 GMT
+Date: Thu, 16 Feb 2012 20:40:05 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
+"Apple Inc.",503.65,14.16,469.6B

data/test/fakeweb/ecommerce.csv

@@ -0,0 +1,9 @@
+HTTP/1.1 200 OK
+Date: Thu, 16 Feb 2012 20:51:23 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
+
+"ECOMMERCE","ECOMMERCE",N/A

data/test/yahoo_quote_test.rb

@@ -4,55 +4,65 @@ require 'yahoo_quote'
 require 'minitest/autorun'
 require 'fakeweb'
 
-# test error:    YahooQuote::Configuration.cache_dir = "/etc/kk"
-#
+# TODO test 2 things: make intermediate dirs for cache and permissions
+
 class TestYahooQuote < MiniTest::Unit::TestCase
   def setup
+    @url_regexp = %r(http://download\.finance\.yahoo\.com/d/quotes\.csv\?)
+    FakeWeb.allow_net_connect = false
+    FakeWeb.register_uri(:get, @url_regexp, :response => File.read("test/fakeweb/aapl_good.csv"))
+
     # 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"]
+  def test_empty_arguments
+    quote = YahooQuote::Quote.new('', [])
+    assert_equal false, quote.valid?
+    assert_nil quote.data["Symbol"]
+    assert_nil quote.data["Name"]
   end
 
-  def test_invalid_ticker_symbol
-    quote = YahooQuote::Quote.new('ECOMMERCE', ['Symbol', 'Name', 'Market Capitalization'])
+  def test_bad_symbol
+    quote = YahooQuote::Quote.new('C A', ['Symbol', 'Name'])
+    assert_equal false, quote.valid?
+    assert_nil quote.data["Symbol"]
     assert_nil quote.data["Name"]
+  end
+
+  def test_non_existing_company
+    FakeWeb.register_uri(:get, @url_regexp, :response => File.read("test/fakeweb/ecommerce.csv"))
+    quote = YahooQuote::Quote.new('ECOMMERCE', ['Symbol', 'Name'])
     assert_equal false, quote.valid?
-    # TODO check no cached
+    assert_nil quote.data["Symbol"]
+    assert_nil quote.data["Name"]
   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'))
+  def test_good_quote
+    quote = YahooQuote::Quote.new('AAPL', ['Name', 'Last Trade (Price Only)', 'P/E Ratio'])
     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"]
+    assert_equal 503.65,       quote.data["Last Trade (Price Only)"]
+    assert_equal 14.16,        quote.data["P/E Ratio"]
   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"]
+    quote = YahooQuote::Quote.new('AAPL', [])
+    assert quote.valid?
     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'))
+    YahooQuote::Configuration.cache_dir = "test/cache"
+    quote = YahooQuote::Quote.new('AAPL', ['Name', 'Last Trade (Price Only)', 'P/E Ratio'])
+    assert File.file? "test/cache/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
+    assert_equal 503.65,       quote.data["Last Trade (Price Only)"]
+    bad_response = File.read('test/fakeweb/aapl_bad.csv')
+    refute_match /Apple/i, bad_response
+    FakeWeb.register_uri(:get, @url_regexp, :response => bad_response)
+    cached_quote = YahooQuote::Quote.new('AAPL', ['Name', 'Last Trade (Price Only)', 'P/E Ratio'])
+    assert_equal "Apple Inc.", cached_quote.data["Name"]
+    assert_equal 503.65,       cached_quote.data["Last Trade (Price Only)"]
+    YahooQuote::Configuration.cache_dir = nil
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_quote
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000Z
+date: 2012-02-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2157063640 !ruby/object:Gem::Requirement
+  requirement: &2153635380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157063640
+  version_requirements: *2153635380
 description: Facilitates querying Yahoo Finance stock API
 email:
 - bcarreno@yahoo.com
@@ -31,14 +31,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
+- LICENSE.txt
+- README.markdown
 - 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/fakeweb/aapl_good.csv
+- test/fakeweb/ecommerce.csv
 - test/yahoo_quote_test.rb
 - yahoo_quote.gemspec
 homepage: https://github.com/bcarreno/yahoo_quote
@@ -66,6 +67,7 @@ signing_key:
 specification_version: 3
 summary: Yahoo Finance stock quotes
 test_files:
-- test/fakeweb/aapl.csv
 - test/fakeweb/aapl_bad.csv
+- test/fakeweb/aapl_good.csv
+- test/fakeweb/ecommerce.csv
 - test/yahoo_quote_test.rb

data/README

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

data/lib/old_yahoo_quote.rb

@@ -1,141 +0,0 @@
-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
-
-