yahoo_stock 1.0.2

data/lib/yahoo_stock/result.rb

@@ -0,0 +1,21 @@
+module YahooStock
+  class Result
+
+    def initialize(context)
+      @context = context
+    end
+    
+    def output
+      return @context if @context.is_a?(String)
+      @context.output
+    end
+    
+    def store(filename)
+      File.open(filename, 'a') do |f|
+        f.write(output)
+        f.write("\n")
+      end
+    end
+
+  end
+end

data/lib/yahoo_stock/result/array_format.rb

@@ -0,0 +1,27 @@
+module YahooStock
+  
+  # == DESCRIPTION:
+  #   Parse results to show in an array form
+  # 
+  # == USAGE
+  #   YahooStock::Result::ArrayFormat.new("data as commma separated values").output
+  # 
+  # Mostly will be used as a separate strategy for formatting results
+    class Result::ArrayFormat < Result
+      
+      def initialize(data)
+        @data = data
+        super(self)
+      end
+      
+      def output
+        # Some inconsistency happens hence remove quotes
+        val = @data.gsub(/\"/,'').split(/\r\n|\n/)
+        new_val = []
+        val.each {|v| new_val << v.split(',')}
+        return new_val
+      end
+      
+    end
+  
+end

data/lib/yahoo_stock/result/hash_format.rb

@@ -0,0 +1,37 @@
+module YahooStock
+  # == DESCRIPTION:
+  # Convert results as an array of key value pairs
+  # 
+  # == USAGE
+  # YahooStock::Result::HashFormat.new("data as string"){['array', 'of', 'keys']}.output
+  # The number of keys in the block array must be equal to the values expected to be returned
+  #
+  # Mostly will be used as a separate strategy for formatting results
+  class Result::HashFormat < Result
+    
+    def initialize(data, &block)
+      @data = YahooStock::Result::ArrayFormat.new(data).output
+      @keys = yield
+      super(self)
+    end
+    
+    def output
+      data = []
+      @data.each do |datum|
+        row_values = {}
+        datum.each_with_index do |item, i|
+          row_values[keys[i]] = item
+        end
+        data << row_values
+      end
+      data
+    end
+    
+    def keys
+      @keys.collect{|key| key.to_s.gsub(/\s/,'_').downcase.to_sym}
+    end
+    
+  end
+
+  
+end

data/lib/yahoo_stock/scrip_symbol.rb

@@ -0,0 +1,61 @@
+module YahooStock
+  # == DESCRIPTION:
+  # 
+  # This class provides the ability to find out the stock /scrip symbols for a company used in stock exchanges.
+  # 
+  # It uses Yahoo http://finance.yahoo.com/lookup page to find, screen scrape / parse the returned results.
+  # 
+  # == USAGE:
+  #  
+  # * If you want to use the symbols in your existing code then:
+  # 
+  #     symbol = YahooStock::ScripSymbol.new('company name')
+  # 
+  #     symbol.find #will return a string
+  # 
+  #     symbol.results :to_array, #will return an array of values instead of a string
+  # 
+  # will give you an array of arrays where each outer array is the different option for the company name
+  # you provided and the inner array includes stock symbol, full company name, stock price, exchange symbol
+  # so that you can decide easily what symbol you can use.
+  # 
+  # * If you just want to print the results on your console screen
+  # 
+  #     YahooStock::ScripSymbol.print_options('company name')
+  # 
+  # * If you just want to store the results in file to use it later
+  # 
+  # You can pass in any number of companies in the parameter
+  # 
+  #     YahooStock::ScripSymbol.save_options_to_file('path/to/filename','company1', 'company2')
+  # 
+  class ScripSymbol < Base
+    # Initialize with the name of the company as parameter for which stock symbol is needed
+    # 
+    #     symbol = YahooStock::ScripSymbol.new('company name')
+    # 
+    #     symbol.find
+    
+    attr_reader :company
+    
+    def initialize(company_name)
+      @company = company_name
+      @interface = YahooStock::Interface::ScripSymbol.new(@company)
+    end
+    
+    def company=(company)
+      @company = @interface.company = company
+    end
+    
+    def data_attributes
+      ['Symbol', 'Name', 'Last Trade', 'Type', 'Industry Category', 'Exchange']
+    end
+    
+    # get stock symbols for multilple companies
+    def self.results(*companies)
+      res = companies.inject('') { |options, company| options + new(company).results.output + "\n" }
+      YahooStock::Result.new(res)
+    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/base_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YahooStock::Base do
+  before(:each) do
+    @interface = stub!('Base')
+    @base = YahooStock::Base.new(@interface)
+  end
+  
+  describe "find" do
+    
+    it "should get the values from interface" do
+      @interface.should_receive(:values)
+      @base.find
+    end
+  end
+  
+  describe "results" do
+    
+    it "should return the results using find" do
+      @base.should_receive(:find)
+      @base.results 
+    end
+    
+    it "should yield the block if a block is given" do
+      @base.results {"Block to pass, probably, a class with result output method"
+        }.should eql('Block to pass, probably, a class with result output method')
+    end
+    
+    it "should use the ArrayFormat class for results when :to_array is passed to the results  param" do
+      @base.stub!(:find)
+      YahooStock::Result::ArrayFormat.should_receive(:new)
+      @base.results(:to_array)
+    end
+    
+    it "should create the YahooStock::Result object when no formatting option is provided" do
+      find = stub('find')
+      @base.stub!(:find).and_return(find)
+      YahooStock::Result.should_receive(:new).with(find)
+      @base.results
+    end
+   
+  end
+  describe "data_attributes" do
+    it "should raise an error if the data_attributes is called as this is an abstract method" do
+      lambda { @base.data_attributes }.should raise_error(RuntimeError, 'Abstract method called. Use the subclass data_attributes method')
+    end
+  end
+end

data/spec/yahoo_stock/history_spec.rb

@@ -0,0 +1,75 @@
+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 inititalize the history interface" do
+      options = {}
+      YahooStock::Interface::History.should_receive(:new).with(options)
+      YahooStock::History.new({})
+    end
+    
+  end
+  
+  describe "find" do
+    before(:each) do
+      @interface = stub('YahooStock::Interface::History')
+      YahooStock::Interface::History.stub!(:new).and_return(@interface)
+      @interface.stub!(:values)
+      @history = YahooStock::History.new(:stock_symbol => 'a symbol', :start_date => Date.today-3, :end_date => Date.today-1)
+    end
+    
+    it "should find values using interface" do
+      @interface.should_receive(:values).and_return('data')
+      @history.find
+    end
+    
+    it "should remove the first line from the data as it is just the headings" do
+      data = 'data returned'
+      @interface.stub!(:values).and_return(data)
+      data.should_receive(:sub).with(/Date.*\s/,'')
+      @history.find
+    end
+  end
+  
+  describe "data_attributes" do
+    before(:each) do
+      @history = YahooStock::History.new(:stock_symbol => 'a symbol', :start_date => Date.today-3, :end_date => Date.today-1)
+      @data = "Date, price, etc \n23, 34, 44\n\n222,234,2"
+      @history.stub!(:values_with_header).and_return(@data)
+    end
+    
+    it "should return nil if history values are not present" do
+      @history.stub!(:values_with_header)
+      @history.data_attributes.should eql(nil)
+    end
+    
+    it "should return only header values if history values are present" do
+      @history.data_attributes.should eql(["Date","price","etc"])
+    end
+    
+  end
+  
+  describe "values_with_header" do
+    
+    it "should get values from the interface" do
+      @interface = stub('YahooStock::Interface::History')
+      YahooStock::Interface::History.stub!(:new).and_return(@interface)
+      @history = YahooStock::History.new(:stock_symbol => 'a symbol', :start_date => Date.today-3, :end_date => Date.today-1)
+      @interface.should_receive(:values)
+      @history.values_with_header
+    end
+  end
+  
+end

data/spec/yahoo_stock/interface/history_spec.rb

@@ -0,0 +1,317 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe YahooStock::Interface::History do
+  
+  describe ".new" do
+    
+    it "should raise error when no parameter is passed during object initialization" do
+      lambda { YahooStock::Interface::History.new 
+        }.should raise_error(ArgumentError)
+    end
+    
+    it "should raise an error if stock symbol key is not present in parameter hash" do
+      lambda { YahooStock::Interface::History.new(:start_date => Date.today-7) 
+        }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => nil)
+         }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => '')
+         }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd') }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', :start_date => nil) }.should raise_error(YahooStock::Interface::History::HistoryError, ':start_date value cannot be blank')
+    end
+    
+    it "should raise error when start_date value is blank" do
+      lambda { YahooStock::Interface::History.new(:stock_symbol => 'd', :start_date => '') }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', :start_date => '23/3/2009') }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', :start_date => Date.today-1) }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today-1, 
+                                                  :end_date => nil) }.should raise_error(YahooStock::Interface::History::HistoryError, ':end_date value cannot be blank')
+    end
+    
+    it "should raise error when end_date value is blank" do
+      lambda { YahooStock::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today-1, 
+                                                  :end_date => '') }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today-1, 
+                                                  :end_date => 'sds') }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today, 
+                                                  :end_date => Date.today) 
+        }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today-7, 
+                                                  :end_date => Date.today-8) 
+        }.should raise_error(YahooStock::Interface::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::Interface::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::Interface::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::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today-7, 
+                                                  :end_date => Date.today-1, :boom => 1) }.should raise_error(YahooStock::Interface::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::Interface::History.new(:stock_symbol => 'd', 
+                                                  :start_date => Date.today-7, 
+                                                  :end_date => Date.today-1,
+                                                  :interval => :yearly)
+                                        }.should raise_error(YahooStock::Interface::History::HistoryError, "Allowed values for interval are daily, weekly, monthly")
+      
+    end
+    
+    it "should not raise error when interval is :daily" do
+      lambda { YahooStock::Interface::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::Interface::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::Interface::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::Interface::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::Interface::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::Interface::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::Interface::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::Interface::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::Interface::History::HistoryError)
+    end
+    
+    it "should set the interval" do
+      @history.interval = :daily
+      @history.interval.should eql(:daily)
+    end
+    
+    it "should set the interval default to daily if not set" do
+      @history.interval.should eql(:daily)
+    end
+  end
+  
+  describe "uri" do
+    before(:each) do
+      @history = YahooStock::Interface::History.new(:stock_symbol => 'symbol', 
+                                                    :start_date => Date.today-7, 
+                                                    :end_date => Date.today-1)
+    end
+    
+    it "should get the interval to generate url" do
+      @history.should_receive(:interval)
+      @history.uri
+    end
+    
+    it "should get the day of the start date" do
+      @history.start_date.should_receive(:day)
+      @history.uri
+    end
+    
+    it "should get the day of the end date" do
+      @history.end_date.should_receive(:day)
+      @history.uri
+    end
+    
+    it "should get the year of the start date" do
+      @history.start_date.should_receive(:year)
+      @history.uri
+    end
+    
+    it "should get the day of the end date" do
+      @history.start_date.should_receive(:year)
+      @history.uri
+    end
+    
+    it "should get the month of the start and end date" do
+      @history.should_receive(:sprintf).exactly(2)
+      @history.uri
+    end
+    
+    it "should have the base url" do
+      @history.uri.should =~ /http:\/\/ichart.finance.yahoo.com\/table.csv?/
+    end
+    
+    it "should have parameter 'a' with month -1 " do
+      month = sprintf("%02d", @history.start_date.month-1)
+      @history.uri.should =~ /a=#{month}/
+    end
+    
+    it "should have parameter 'b' with start date day " do
+      @history.uri.should =~ /b=#{@history.start_date.day}/
+    end
+    
+    it "should have parameter 'c' with start date year " do
+      @history.uri.should =~ /c=#{@history.start_date.year}/
+    end
+    
+    it "should have parameter 'd' with end date month -1 " do
+      month = sprintf("%02d", @history.end_date.month-1)
+      @history.uri.should =~ /d=#{month}/
+    end
+    
+    it "should have parameter 'e' with end date day " do
+      @history.uri.should =~ /e=#{@history.end_date.day}/
+    end
+    
+    it "should have parameter 'f' with end date year " do
+      @history.uri.should =~ /c=#{@history.end_date.year}/
+    end
+    
+    it "should have parameter 'g' with interval" do
+      @history.uri.should =~ /g=d/
+    end
+    
+    it "should have the parameter 's' with stock symbol" do
+      @history.uri.should =~ /s=symbol/
+    end
+    
+  end
+  
+  describe "get" do
+    before(:each) do
+      @history = YahooStock::Interface::History.new(:stock_symbol => 'd', 
+                                                    :start_date => Date.today-7, 
+                                                    :end_date => Date.today-1)
+      response = stub('HTTP')
+      Net::HTTP.stub!(:get_response).and_return(response)
+      response.stub!(:code).and_return('200')
+      response.stub!(:body)
+    end
+    
+    it "should check the stock symbol" do
+      @history.should_receive(:stock_symbol).times.at_least(2).and_return('symbol')
+      @history.get
+    end
+    
+    it "should check the end date" do
+      @history.should_receive(:end_date).times.at_least(1).and_return(Date.today-1)
+      @history.get
+    end
+    
+    it "should check the start date" do
+      @history.should_receive(:start_date).times.at_least(1).and_return(Date.today-7)
+      @history.get
+    end
+    
+    it "should raise error if start date is not present" do
+      @history.stub!(:start_date)
+      lambda { @history.get }.should raise_error('Cannot send request unless all parameters, ie stock_symbol, start and end date are present')
+    end
+    
+    it "should raise error if end date is not present" do
+      @history.stub!(:end_date)
+      lambda { @history.get }.should raise_error('Cannot send request unless all parameters, ie stock_symbol, start and end date are present')
+    end
+    
+    it "should raise error if stock symbol is not present" do
+      @history.stub!(:stock_symbol)
+      lambda { @history.get }.should raise_error('Cannot send request unless all parameters, ie stock_symbol, start and end date are present')
+    end
+    
+    it "should send the http request to yahoo" do
+      Net::HTTP.should_receive(:get_response)
+      @history.get
+    end
+    
+    it "should parse the url" do
+      URI.should_receive(:parse)
+      @history.get
+    end
+    
+  end
+  
+end