nas-yahoo_stock 0.1.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.1 2009-08-31
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/yahoo_stock.rb
+lib/yahoo_stock/quote.rb
+lib/yahoo_stock/interface.rb
+spec/spec_helper.rb
+spec/yahoo_stock/quote_spec.rb

data/README.rdoc

@@ -0,0 +1,79 @@
+= yahoo_stock
+
+* http://github.com/nas/yahoo_stock
+
+== DESCRIPTION:
+
+Provides an interface to yahoo finance to get stock related data. For instance, latest trade related data, volume, 50 day moving average, market cap, etc.
+
+You must know the stock symbol. For instance, YHOO for yahoo, GOOG for google, etc. 
+The kind of parameters can be passed can be found after initializing the 
+YahooStock::Quote object and passing valid_parameters message.
+
+== SYNOPSIS:
+
+* Initialize quote object
+
+quote = YahooStock::Quote.new(:stock_symbols => ['YHOO', 'GOOG'])
+
+* To view the valid parameters that can be passed
+
+quote.valid_parameters
+
+* To view the current parameters used
+
+quote.current_parameters
+
+* To view the current stock symbols used
+
+quote.current_symbols
+
+* To add more stocks to the list
+
+quote.add_symbols('MSFT', 'AAPL')
+
+* To remove stocks from list
+
+quote.remove_symbols('MSFT', 'AAPL')
+
+* To get data for all stocks
+
+quote.get_data
+
+
+== INSTALL:
+
+gem sources -a http://gems.github.com
+
+sudo gem install yahoo_stock
+
+== TESTS:
+
+Tests are written using Rspec 1.2.2
+
+To run all tests 'rake spec' from the root directory
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nasir Jamal
+
+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/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/yahoo_stock'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'yahoo_stock' do
+  self.developer 'Nasir Jamal', 'nas35_in@yahoo.com'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/yahoo_stock.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'yahoo_stock/interface.rb'
+require 'yahoo_stock/quote.rb' 
+
+module YahooStock
+  VERSION = '0.0.1'
+end

data/lib/yahoo_stock/interface.rb

@@ -0,0 +1,197 @@
+=begin
+
+http://www.gummy-stuff.org/Yahoo-data.htm
+http://finance.yahoo.com/d/quotes.csv?s=XOM+BBDb.TO+JNJ+MSFT&f=snd1l1yr
+
+=end
+
+=begin
+
+Class to generate the right url and interface with yahoo
+
+=end
+
+require 'net/http'
+module YahooStock
+  class Interface
+    
+    class InterfaceError < RuntimeError ; end
+      
+    PARAMETERS = {
+      :ask => 'a',
+      :average_daily_volume => 'a2',
+      :ask_size => 'a5',
+      :bid => 'b',
+      :ask_real_time => 'b2',
+      :bid_real_time => 'b3',
+      :book_value => 'b4',
+      :bid_size => 'b4',
+      :change_with_percent_change => 'c',
+      :change => 'c1',
+      :commission => '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_indication => 'e1',
+      :eps_estimate_current_year => 'e7',
+      :eps_estimate_next_year => 'e8',
+      :eps_estimate_next_quarter => 'e9',
+      :day_low => 'g',
+      :day_high => 'h',
+      :fifty_two_week_low => 'j',
+      :fifty_two_week_high => 'k',
+      :holdings_gain_percent => 'g1',
+      :annualized_gain => 'g3',
+      :holdings_gain => 'g4',
+      :holdings_gain_percent_real_time => 'g5',
+      :holdings_gain_real_time => 'g6',
+      :more_info => 'i',
+      :order_book_real_time => 'i5',
+      :market_capitalization => 'j1',
+      :market_cap_real_time => 'j3',
+      :ebitda => 'j4',
+      :change_from_52_week_low => 'j5',
+      :percent_change_from_52_week_low => 'j6',
+      :last_trade_real_time_with_time => 'k1',
+      :change_percent_real_time => 'k2',
+      :change_from_52_week_high => 'k4',
+      :percent_change_from_52_week_high => 'k5',
+      :last_trade_with_time => 'l',
+      :last_trade_price_only => 'l1',
+      :high_limit => 'l2',
+      :low_limit => 'l3',
+      :day_range => 'm',
+      :day_range_real_time => 'm2',
+      :fifty_day_moving_average => 'm3',
+      :two_hundred_day_moving_average => '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',
+      :ex_dividend_date => 'q',
+      :p_e_ratio => 'r',
+      :dividend_pay_date => 'r1',
+      :p_e_ratio_real_time => 'r2',
+      :peg_ratio => 'r5',
+      :price_eps_estimate_current_year => 'r6',
+      :price_eps_estimate_next_year => 'r7',
+      :symbol => 's',
+      :shares_owned => 's1',
+      :short_ratio => 's7',
+      :last_trade_time => 't1',
+      :trade_links => 't6',
+      :ticker_trend => 't7',
+      :one_yr_target_price => 't8',
+      :volume => 'v',
+      :holdings_value => 'v1',
+      :holdings_value_real_time => 'v7',
+      :fifty_two_week_range => 'w',
+      :day_value_change => 'w1',
+      :day_value_change_real_time => 'w4',
+      :stock_exchange => 'x',
+      :dividend_yield => 'y',
+    }
+    
+    attr_accessor :stock_symbols, :yahoo_url_parameters
+    
+    def initialize(stock_params_hash)
+      unless stock_params_hash
+        raise InterfaceError, 'You must pass a hash of stock symbols and the data you would like to see' 
+      end
+      if !stock_params_hash[:stock_symbols]  || stock_params_hash[:stock_symbols].length.zero?
+        raise(InterfaceError, 'No stocks passed')
+      end
+      if !stock_params_hash[:read_parameters] || stock_params_hash[:read_parameters].length.zero?
+        raise InterfaceError, 'Dont know what data to get'
+      end
+      @stock_symbols = stock_params_hash[:stock_symbols]
+      @yahoo_url_parameters    = stock_params_hash[:read_parameters]
+      @base_url      = "http://download.finance.yahoo.com/d/quotes.csv"
+    end
+    
+    def full_url
+      all_stock_symbols = stock_symbols.join('+')
+      parameter_values  = yahoo_url_parameters.collect {|v| parameters[v]}.join('')
+      if !all_stock_symbols.any?  
+        raise InterfaceError, "You must add atleast one stock symbol to get stock data" 
+      end
+      if !parameter_values.any?
+        raise InterfaceError, "You must add atleast one parameter to get stock data" 
+      end
+      "#{@base_url}?s=#{all_stock_symbols}&f=#{parameter_values}"
+    end
+    
+    def get_values
+      Net::HTTP.get(URI.parse(full_url)).gsub(/\"/,'').split(/\r\n/)
+    end
+    
+    def results
+      stock = {}
+      get_values.each_with_index do |values, index|
+        parsed_values = values.split(',')
+        stock[stock_symbols[index]] ||= {}
+        parsed_values.each_with_index do |value, i|
+          stock[stock_symbols[index]][yahoo_url_parameters[i]] = value
+        end
+      end
+      stock
+    end
+    
+    def add_symbols(*symbols)
+      symbols.each do |symbol|
+        unless stock_symbols.include?(symbol)
+          stock_symbols << symbol
+        end
+      end
+    end
+    
+    def remove_symbols(*symbols)
+      symbols.each do |symbol|
+        unless stock_symbols.include?(symbol)
+          raise InterfaceError, "Cannot remove stock symbol #{symbol} as it is currently not present."
+        end
+        stock_symbols.reject!{|stock_sym| stock_sym == symbol}
+      end
+    end
+    
+    def add_parameters(*parameters)
+      parameters.each do |parameter|
+        unless allowed_parameters.include?(parameter)
+          raise InterfaceError, "Interface parameter #{parameter} is not a valid parameter."
+        end
+        unless yahoo_url_parameters.include?(parameter)
+          yahoo_url_parameters << parameter
+        end
+      end
+    end
+    
+    def remove_parameters(*parameters)
+      parameters.each do |parameter|
+        unless yahoo_url_parameters.include?(parameter)
+          raise InterfaceError, "Parameter #{parameter} is not present in current list"
+        end
+        yahoo_url_parameters.reject!{|parameter_key| parameter_key == parameter}
+      end
+    end
+    
+    def allowed_parameters
+      parameters.keys
+    end
+    
+    private
+    
+    def parameters
+      PARAMETERS
+    end
+    
+  end
+end

data/lib/yahoo_stock/quote.rb

@@ -0,0 +1,78 @@
+module YahooStock
+  class Quote
+    
+    class QuoteException < RuntimeError; end
+    
+    # options expects a hash with two key value pairs
+    # :stock_symbols => 'Array of stock symbols'
+    # e.g. :stock_symbols => [:MSFT,:YHOO]
+    # another :read_parameters => 'array of values'
+    # e.g. :read_parameters => [:last_trade_price_only, :last_trade_date]
+    # usage YahooStock::Quote.new(:stock_symbols => ['MSFT','YHOO'], :read_parameters => [:last_trade_price_only, :last_trade_date])
+    def initialize(options)
+      if options.nil? || !options[:stock_symbols]
+        raise QuoteException, "You must provide a hash of stock symbols to fetch data"
+      end
+      unless options[:stock_symbols].any?
+        raise QuoteException, "You must provide atleast one stock symbol to fetch data"
+      end
+      if !(options[:read_parameters] && options[:read_parameters].any?)
+        options[:read_parameters] = [:last_trade_price_only, :last_trade_date]
+      end
+      options[:stock_symbols] = options[:stock_symbols].to_a unless options[:stock_symbols].kind_of?(Array)
+      @interface = YahooStock::Interface.new(options)
+    end
+    
+    def get_data
+      @interface.results
+    end
+    
+    def add_symbols(*symbols)
+      symbols.each { |symbol| @interface.add_symbols(symbol) }
+    end
+    
+    def remove_symbols(*symbols)
+      symbols.each { |symbol| @interface.remove_symbols(symbol) }
+    end
+    
+    def clear_symbols
+      @interface.stock_symbols.clear
+    end
+    
+    def current_symbols
+      @interface.stock_symbols
+    end
+    
+    def add_parameters(*parameters)
+      parameters.each { |parameter| @interface.add_parameters(parameter) }
+    end
+    
+    def remove_parameters(*parameters)
+      parameters.each { |parameter| @interface.remove_parameters(parameter) }
+    end
+    
+    def current_parameters
+      sort_symbols(@interface.yahoo_url_parameters)
+    end
+    
+    def use_all_parameters
+      params = valid_parameters.each {|parameter| add_parameters(parameter)}
+      sort_symbols(params)
+    end
+    
+    def clear_parameters
+      @interface.yahoo_url_parameters.clear
+    end
+    
+    def valid_parameters
+      sort_symbols(@interface.allowed_parameters)
+    end
+    
+    private
+    
+    def sort_symbols(array_of_symbols)
+      array_of_symbols.map(&:id2name).sort.map(&:to_sym)
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__), "/../lib") 
+require 'spec' 
+require 'yahoo_stock'

data/spec/yahoo_stock/quote_spec.rb

@@ -0,0 +1,235 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper") 
+
+module YahooStock
+  describe Quote do 
+    
+    describe "initialize" do
+      
+      it "should raise error when no parameter is passed" do
+        lambda { YahooStock::Quote.new }.should raise_error
+      end
+    
+      it "should raise QuoteException error when parameter passed is nil" do
+        lambda { YahooStock::Quote.new(nil)}.should raise_error Quote::QuoteException
+      end
+    
+      it "should raise QuoteException when a hash of stock_symbols are not passed" do
+        lambda { YahooStock::Quote.new(:misspelled => 'YHOO')}.should raise_error(Quote::QuoteException, 'You must provide a hash of stock symbols to fetch data')
+      end
+    
+      it "should raise QuoteException when stock symbols hash key value is an emtpy array" do
+        lambda { YahooStock::Quote.new(:stock_symbols => [])}.should raise_error(Quote::QuoteException, 'You must provide atleast one stock symbol to fetch data')
+      end
+    
+      it "should raise QuoteException when stock symbols hash key value is an emtpy string" do
+        lambda { YahooStock::Quote.new(:stock_symbols => '')}.should raise_error(Quote::QuoteException, 'You must provide atleast one stock symbol to fetch data')
+      end
+    
+      it "should create 2 read parameter when no parameters are passed" do
+        quote = YahooStock::Quote.new(:stock_symbols => 'test')
+        quote.current_parameters.length.should eql(2)
+      end
+      
+      it "should have last_trade_price_only key in the read parameters when no keys are passed" do
+        quote = YahooStock::Quote.new(:stock_symbols => 'test')
+        quote.current_parameters.should include(:last_trade_price_only)
+      end
+      
+      it "should have last_trade_date key in the read parameters when no keys are passed" do
+        quote = YahooStock::Quote.new(:stock_symbols => 'test')
+        quote.current_parameters.should include(:last_trade_date)
+      end
+      
+      it "should convert the symbols passed to an array when passed as a single string" do
+        quote = YahooStock::Quote.new(:stock_symbols => 'test')
+        quote.current_symbols.should eql(['test'])
+      end
+      
+      it "should not keep stock symbols as a string" do
+        quote = YahooStock::Quote.new(:stock_symbols => 'test')
+        quote.current_symbols.should_not eql('test')
+      end
+      
+      it "should create a new instance of the Stock Interface class" do
+        YahooStock::Interface.should_receive(:new)
+        YahooStock::Quote.new(:stock_symbols => 'test')
+      end
+      
+    end
+    
+    describe "subject" do
+      
+      before(:each) do
+        @interface = mock(YahooStock::Interface)
+        YahooStock::Interface.stub!(:new).and_return(@interface)
+        @quote = YahooStock::Quote.new(:stock_symbols => 'MSFT')
+      end
+  
+      describe "get_data" do
+      
+        it "should get the results from the interface" do
+          @interface.should_receive(:results)
+          @quote.get_data
+        end
+      end
+      
+      describe "add_symbols" do
+        
+        it "should add the symbol to existing symbols by calling add symbols on interface" do
+          @interface.should_receive(:add_symbols)
+          @quote.add_symbols('new_symbol')
+        end
+        
+        it "should add the symbol to existing symbols by calling add symbols on interface for each sybmol" do
+          @interface.should_receive(:add_symbols).exactly(2).times
+          @quote.add_symbols('new_symbol', 'another_symbol')
+        end
+        
+      end
+      
+      describe "remove_symbols" do
+        
+        it "should remove the symbol from existing symbols by calling remove symbols on interface" do
+          @interface.should_receive(:remove_symbols)
+          @quote.remove_symbols('remove_symbol')
+        end
+        
+        it "should remove the symbol from existing symbols by calling remove symbols on interface for each symbol" do
+          @interface.should_receive(:remove_symbols).exactly(2).times
+          @quote.remove_symbols('new_symbol', 'another_symbol')
+        end
+        
+      end
+      
+      describe "clear_symbols" do
+        
+        it "should get all stock symbols from the interface" do
+          @interface.should_receive(:stock_symbols).and_return([])
+          @quote.clear_symbols
+        end
+        
+        it "should remove the symbol from existing symbols by calling remove symbols on interface for each symbol" do
+          symbols = ['symbol1', 'symbol2']
+          @interface.stub!(:stock_symbols).and_return(symbols)
+          symbols.should_receive(:clear)
+          @quote.clear_symbols
+        end
+        
+      end
+      
+      describe "current_symbols" do
+        
+        it "should get all stock symbols from the interface" do
+          @interface.should_receive(:stock_symbols)
+          @quote.current_symbols
+        end
+        
+      end
+      
+      describe "add_parameters" do
+        
+        it "should add the parameter to existing parameter by calling add parameters on interface" do
+          @interface.should_receive(:add_parameters)
+          @quote.add_parameters('param1')
+        end
+        
+        it "should add the parameter to existing parameters by calling add parameters on interface for each parameter" do
+          @interface.should_receive(:add_parameters).exactly(2).times
+          @quote.add_parameters('param1', 'param2')
+        end
+        
+      end
+      
+      describe "remove_parameters" do
+        
+        it "should remove the parameter from existing parameters by calling remove parameters on interface" do
+          @interface.should_receive(:remove_parameters)
+          @quote.remove_parameters('remove_parameter')
+        end
+        
+        it "should remove the parameter from existing parameters by calling remove parameters on interface for each parameter" do
+          @interface.should_receive(:remove_parameters).exactly(2).times
+          @quote.remove_parameters('param1', 'param2')
+        end
+        
+      end
+      
+      describe "valid_parameters" do
+        
+        it "should get the valid parameters by sending allowed parameters message to the yahoo interface" do
+          @quote.stub!(:sort_symbols)
+          @interface.should_receive(:allowed_parameters)
+          @quote.valid_parameters
+        end
+        
+        it "sort the parameters after fetching them" do
+          @interface.stub!(:allowed_parameters)
+          @quote.should_receive(:sort_symbols)
+          @quote.valid_parameters
+        end
+
+      end
+      
+      describe "current_parameters" do
+        
+        it "should get all current parameters from the interface" do
+          @quote.stub!(:sort_symbols)
+          @interface.should_receive(:yahoo_url_parameters)
+          @quote.current_parameters
+        end
+        
+        it "should sort all received current parameters" do
+          @interface.stub!(:yahoo_url_parameters)
+          @quote.should_receive(:sort_symbols)
+          @quote.current_parameters
+        end
+        
+      end
+      
+      describe "use_all_parameters" do
+        
+        before(:each) do
+          @quote.stub!(:sort_symbols)
+          @interface.stub!(:allowed_parameters)
+        end
+        
+        it "should get all valid parameters" do
+          @quote.should_receive(:valid_parameters).and_return([])
+          @quote.use_all_parameters
+        end
+        
+        it "should sort all received current parameters" do
+          @quote.stub!(:valid_parameters).and_return([])
+          @quote.should_receive(:sort_symbols) 
+          @quote.use_all_parameters
+        end
+        
+        it "should add each parameter" do
+          @quote.stub!(:valid_parameters).and_return([:param1, :param2])
+          @quote.should_receive(:add_parameters).exactly(2).times
+          @quote.use_all_parameters
+        end
+        
+      end
+      
+      describe "clear_parameters" do
+        
+        it "should get all values for parameters from the interface" do
+          @interface.should_receive(:yahoo_url_parameters).and_return([])
+          @quote.clear_parameters
+        end
+        
+        it "should remove the parameter from existing parameters by calling remove parameters on interface for each parameter" do
+          params = ['param1', 'param2']
+          @interface.stub!(:yahoo_url_parameters).and_return(params)
+          params.should_receive(:clear)
+          @quote.clear_parameters
+        end
+        
+      end
+  
+    end
+  end 
+  
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: nas-yahoo_stock
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nasir Jamal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: Yahoo Stock is a Ruby library for extracting information about stocks from yahoo finance
+email: nas35_in@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- README.rdoc
+- Manifest.txt
+- Rakefile
+- lib/yahoo_stock.rb
+- lib/yahoo_stock/quote.rb
+- lib/yahoo_stock/interface.rb
+- spec/spec_helper.rb
+- spec/yahoo_stock/quote_spec.rb
+has_rdoc: true
+homepage: http://github.com/nas/yahoo_stock
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.8"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Yahoo Stock is a Ruby library for extracting information about stocks from yahoo finance.
+test_files: []
+