nas-yahoo_stock 0.1.6 → 1.0.1

data/History.txt

@@ -32,3 +32,8 @@
 * 1 addition:
   * adds convenience methods Quote#realtime, standard and extended to 
     fetch relevant stock values
+
+=== 1.0.1 2009-09-10
+
+* 1 addition:
+  * adds feature to retreive historical stock data

data/Manifest.txt

@@ -6,6 +6,8 @@ lib/yahoo_stock.rb
 lib/yahoo_stock/quote.rb
 lib/yahoo_stock/interface.rb
 lib/yahoo_stock/scrip_symbol.rb
+lib/yahoo_stock/history.rb
 spec/spec_helper.rb
 spec/yahoo_stock/quote_spec.rb
 spec/yahoo_stock/scrip_symbol_spec.rb
+spec/yahoo_stock/history_spec.rb

data/lib/yahoo_stock/history.rb

@@ -0,0 +1,186 @@
+=begin
+
+base url = http://ichart.finance.yahoo.com/table.csv
+
+params:
+ s=stock symbol
+ a=month-1
+ b=date
+ c=year
+ d=month-1
+ e=date
+ f=year
+ g=d or w or m
+ ignore=.csv
+
+=end
+require 'net/http'
+module YahooStock
+  class History
+    
+    class HistoryError < RuntimeError; end
+    
+    attr_reader :stock_symbol, :start_date, :end_date, :interval
+    
+    def initialize(options)
+      unless options.is_a?(Hash)
+        raise HistoryError, 'A hash of start_date, end_date and stock_symbol is expected as parameters'
+      end
+      validate_keys(options)
+      
+      @stock_symbol = options[:stock_symbol]
+      @start_date   = options[:start_date]
+      @end_date     = options[:end_date]
+      @interval     = options[:interval].nil? ? :daily : options[:interval].to_sym
+      
+      validate_interval_values(options[:interval]) if options[:interval]
+      validate_stock_symbol(options)
+      validate_start_date(options)
+      validate_end_date(options)
+      validate_history_range
+      @base_url = "http://ichart.finance.yahoo.com/table.csv"
+    end
+    
+    def stock_symbol=(stock_symbol)
+      validate_stock_symbol_attribute(stock_symbol)
+      @stock_symbol = stock_symbol
+    end
+    
+    def start_date=(start_date)
+      validate_start_date_type(start_date)
+      validate_history_range(start_date)
+      @start_date = start_date
+    end
+    
+    def end_date=(end_date)
+      validate_end_date_type(end_date)
+      validate_history_range(start_date, end_date)
+      @end_date = end_date
+    end
+    
+    def interval=(interval)
+      validate_interval_values(interval)
+      @interval = interval
+    end
+    
+    def send_request
+      if stock_symbol.nil? || start_date.nil? || end_date.nil?
+        raise HistoryError, 'Cannot send request unless all parameters, ie stock_symbol, start and end date are present'
+      end
+      if !(start_date.is_a?(Date) || end_date.is_a?(Date))
+        raise HistoryError, 'Start and end date should be of type Date'
+      end
+      response = Net::HTTP.get_response(URI.parse(uri))
+      if response.code == '200'
+        return response.body
+      else
+        raise "No historical data found for the stock symbol: #{stock_symbol}"
+      end
+    end
+    
+    # Return an array of hashes with latest date first
+    # Each array element contains a hash of date, volume traded, opening, closing, high and low prices
+    def results
+      values = send_request.split(/\n/)
+      headers, daily_data = values.partition{|h| h==values[0]}
+      headings = headers.first.split(',')
+      data = []
+      daily_data.each do |datum|
+        daily_values = {}
+        datum.split(',').each_with_index do |item, i|
+          daily_values[headings[i]] = item
+        end
+        data << daily_values
+      end
+      data
+    end
+    
+    private
+    
+    def uri
+      frequency = case interval
+                    when :daily   : 'd'
+                    when :weekly  : 'w'
+                    when :monthly : 'm'
+                  end
+      start_date_param = "a=#{sprintf("%02d", start_date.month-1)}&b=#{start_date.day}&c=#{start_date.year}"
+      end_date_param = "d=#{sprintf("%02d", end_date.month-1)}&e=#{end_date.day}&f=#{end_date.year}"
+      params="s=#{stock_symbol}&#{start_date_param}&#{end_date_param}&g=#{frequency}&ignore=.csv"
+      "#{@base_url}?#{params}"
+    end
+    
+    def validate_interval_values(interval_value=interval)
+      valid_values = [:daily, :weekly, :monthly]
+      unless valid_values.include?(interval_value)
+        raise HistoryError, "Allowed values for interval are #{valid_values.join(', ')}"
+      end
+    end
+    
+    def validate_stock_symbol(options)
+      unless options.keys.include?(:stock_symbol)
+        raise HistoryError, ':stock_symbol key is not present in the parameter hash'
+      end
+      validate_stock_symbol_attribute
+    end
+    
+    def validate_stock_symbol_attribute(symbol=stock_symbol)
+      if symbol.nil? || symbol.empty?
+        raise HistoryError, ':stock_symbol value cannot be nil or blank'
+      end
+    end
+    
+    def validate_start_date(options)
+      validate_date_options(:start_date, options)
+      validate_start_date_type
+    end
+    
+    def validate_end_date(options)
+      validate_date_options(:end_date, options)
+      validate_end_date_type
+    end
+    
+    def validate_history_range(s_date = start_date, e_date = end_date)
+      if s_date >= Date.today
+        raise HistoryError, "Start date must be in the past"
+      end
+      if e_date >= Date.today
+        raise HistoryError, "End date must be in the past"
+      end
+      if e_date < s_date
+        raise HistoryError, "End date must be greater than the start date"
+      end
+    end
+    
+    def validate_end_date_type(e_date=end_date)
+      unless e_date.is_a?(Date)
+        raise HistoryError, "End date must be of type Date"
+      end
+    end
+    
+    def validate_start_date_type(s_date=start_date)
+      unless s_date.is_a?(Date)
+        raise HistoryError, "Start date must be of type Date"
+      end
+    end
+    
+    def validate_date_options(date_type, options)
+      unless options.keys.include?(date_type)
+        raise HistoryError, ":#{date_type} key is not present in the parameter hash"
+      end
+      
+      if options[date_type].nil? || options[date_type].to_s.empty?
+        raise HistoryError, ":#{date_type} value cannot be blank"
+      end
+    end
+    
+    def validate_keys(options)
+      valid_keys   = [:stock_symbol, :start_date, :end_date, :interval]
+      invalid_keys = []
+      options.keys.each{|key| invalid_keys << key unless valid_keys.include?(key) }
+      unless invalid_keys.length.zero?
+        raise HistoryError, "An invalid key '#{invalid_keys.join(',')}' is passed in the parameters. Allowed keys are #{valid_keys.join(', ')}"
+      end
+    end
+    
+  end
+end

data/lib/yahoo_stock/interface.rb

@@ -129,9 +129,9 @@ module YahooStock
       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"
+      @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
     
     # Generate full url to be sent to yahoo

data/lib/yahoo_stock.rb

@@ -1,9 +1,11 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'date'
 require 'yahoo_stock/scrip_symbol.rb'
 require 'yahoo_stock/interface.rb'
 require 'yahoo_stock/quote.rb' 
+require 'yahoo_stock/history.rb'
 
 module YahooStock
   VERSION = '0.1.3'

data/spec/yahoo_stock/history_spec.rb

@@ -0,0 +1,190 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YahooStock::History do
+  
+  describe ".new" do
+    
+    it "should raise error when no parameter is passed during object initialization" do
+      lambda { YahooStock::History.new 
+        }.should raise_error(ArgumentError)
+    end
+    
+    it "should raise error when the parameter is not a hash" do
+      lambda { YahooStock::History.new(nil) 
+        }.should raise_error(YahooStock::History::HistoryError, 'A hash of start_date, end_date and stock_symbol is expected as parameters')
+    end
+    
+    it "should raise an error if stock symbol key is not present in parameter hash" do
+      lambda { YahooStock::History.new(:start_date => Date.today-7) 
+        }.should raise_error(YahooStock::History::HistoryError, ':stock_symbol key is not present in the parameter hash')
+    end
+    
+    it "should raise error when stock_symbol value in hash is nil" do
+      lambda { YahooStock::History.new(:stock_symbol => nil)
+         }.should raise_error(YahooStock::History::HistoryError, ':stock_symbol value cannot be nil or blank')
+    end
+    
+    it "should raise error when stock_symbol value in hash is blank" do
+      lambda { YahooStock::History.new(:stock_symbol => '')
+         }.should raise_error(YahooStock::History::HistoryError, ':stock_symbol value cannot be nil or blank')
+    end
+    
+    it "should raise error when start date key is not present in parameter hash" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd') }.should raise_error(YahooStock::History::HistoryError, ':start_date key is not present in the parameter hash')
+    end
+    
+    it "should raise error when start_date value is nil" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', :start_date => nil) }.should raise_error(YahooStock::History::HistoryError, ':start_date value cannot be blank')
+    end
+    
+    it "should raise error when start_date value is blank" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', :start_date => '') }.should raise_error(YahooStock::History::HistoryError, ':start_date value cannot be blank')
+    end
+    
+    it "should raise error when start date value is not of type date" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', :start_date => '23/3/2009') }.should raise_error(YahooStock::History::HistoryError, 'Start date must be of type Date')
+    end
+    
+    it "should raise error when end date key is not present in parameter hash" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', :start_date => Date.today-1) }.should raise_error(YahooStock::History::HistoryError, ':end_date key is not present in the parameter hash')
+    end
+    
+    it "should raise error when end_date value is nil" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-1, 
+                                       :end_date => nil) }.should raise_error(YahooStock::History::HistoryError, ':end_date value cannot be blank')
+    end
+    
+    it "should raise error when end_date value is blank" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-1, 
+                                       :end_date => '') }.should raise_error(YahooStock::History::HistoryError, ':end_date value cannot be blank')
+    end
+    
+    it "should raise error when end date value is not of type date" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-1, 
+                                       :end_date => 'sds') }.should raise_error(YahooStock::History::HistoryError, 'End date must be of type Date')
+    end
+    
+    it "should raise error when start date is not less than today" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today, 
+                                       :end_date => Date.today) 
+        }.should raise_error(YahooStock::History::HistoryError, 'Start date must be in the past')
+    end
+    
+    it "should raise error when start date is greater than end date" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-7, 
+                                       :end_date => Date.today-8) 
+        }.should raise_error(YahooStock::History::HistoryError, 'End date must be greater than the start date')
+    end
+    
+    it "should not raise error when start date is in the past, end date is greater than start date and all relevant keys are present with right type" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-7, 
+                                       :end_date => Date.today-1) 
+        }.should_not raise_error
+      
+    end
+    
+    it "should by default set interval to daily if no value provided for it" do
+      @history = YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-7, 
+                                       :end_date => Date.today-1)
+      @history.interval.should eql(:daily)
+    end
+    
+    it "should raise invalid keys error when an invalid key is passed in the parameter" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-7, 
+                                       :end_date => Date.today-1, :boom => 1) }.should raise_error(YahooStock::History::HistoryError, "An invalid key 'boom' is passed in the parameters. Allowed keys are stock_symbol, start_date, end_date, interval")
+    end
+    
+    it "should raise error when interval is neither :daily, :weekly or :monthly" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-7, 
+                                       :end_date => Date.today-1,
+                                       :interval => :yearly)
+                                        }.should raise_error(YahooStock::History::HistoryError, "Allowed values for interval are daily, weekly, monthly")
+      
+    end
+    
+    it "should not raise error when interval is :daily" do
+      lambda { YahooStock::History.new(:stock_symbol => 'd', 
+                                       :start_date => Date.today-7, 
+                                       :end_date => Date.today-1,
+                                       :interval => :daily)
+                                        }.should_not raise_error
+      
+    end
+  end
+  
+  describe "setters" do
+    before(:each) do
+      @history = YahooStock::History.new(:stock_symbol => 'd', 
+                                         :start_date => Date.today-7, 
+                                         :end_date => Date.today-1)
+    end
+    
+    it "should raise error when stock symbol is being set to nil" do
+      lambda { @history.stock_symbol = nil 
+        }.should raise_error(YahooStock::History::HistoryError, ':stock_symbol value cannot be nil or blank')
+    end
+    
+    it "should raise error when stock symbol is being set to an empty string" do
+      lambda { @history.stock_symbol = '' 
+        }.should raise_error(YahooStock::History::HistoryError, ':stock_symbol value cannot be nil or blank')
+    end
+    
+    it "should set the new stock symbol value when it is valid" do
+      @history.stock_symbol = 'new_val'
+      @history.stock_symbol.should eql('new_val') 
+    end
+    
+    it "should raise error when start date type is not a date" do
+      lambda { @history.start_date = '21/3/2009' 
+        }.should raise_error(YahooStock::History::HistoryError, 'Start date must be of type Date')
+    end
+    
+    it "should raise error when start date is not in the past" do
+      lambda { @history.start_date = Date.today
+        }.should raise_error(YahooStock::History::HistoryError, 'Start date must be in the past')
+    end
+    
+    it "should set the start date when start date is valid" do
+      s_date = Date.today-1
+      @history.start_date = s_date
+      @history.start_date.should eql(s_date)
+    end
+    
+    it "should raise error when end date type is not a date" do
+      lambda { @history.end_date = '21/3/2009' 
+        }.should raise_error(YahooStock::History::HistoryError, 'End date must be of type Date')
+    end
+    
+    it "should raise error when end date type is not in the past" do
+      lambda { @history.end_date = Date.today
+        }.should raise_error(YahooStock::History::HistoryError, 'End date must be in the past')
+    end
+    
+    it "should raise error when end date type is not in the past" do
+      e_date = Date.today-1
+      @history.end_date = e_date
+      @history.end_date.should eql(e_date)
+    end
+    
+    it "should raise error when settin interval other than :daily, :monthly or :weekly" do
+      lambda { @history.interval = :yearly }.should raise_error(YahooStock::History::HistoryError)
+    end
+    
+    it "should set the interval" do
+      @history.interval = :daily
+      @history.interval.should eql(:daily)
+    end
+    
+  end
+  
+  
+end

data/spec/yahoo_stock/interface_spec.rb

@@ -6,7 +6,7 @@ describe YahooStock::Interface do
     @interface = YahooStock::Interface.new(:stock_symbols => ['MSFT'], :read_parameters => [:last_trade_price_only])
   end
   
-  describe "initialize" do
+  describe ".new" do
     
     it "should raise InterfaceError when stock params hash is nil" do
       lambda { YahooStock::Interface.new(nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nas-yahoo_stock
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 1.0.1
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-07 00:00:00 -07:00
+date: 2009-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,12 +49,15 @@ files:
 - lib/yahoo_stock/quote.rb
 - lib/yahoo_stock/interface.rb
 - lib/yahoo_stock/scrip_symbol.rb
+- lib/yahoo_stock/history.rb
 - spec/spec_helper.rb
 - spec/yahoo_stock/quote_spec.rb
 - spec/yahoo_stock/interface_spec.rb
 - spec/yahoo_stock/scrip_symbol_spec.rb
+- spec/yahoo_stock/history_spec.rb
 has_rdoc: true
 homepage: http://github.com/nas/yahoo_stock
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -76,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Yahoo Stock is a Ruby library for extracting information about stocks from yahoo finance.