they-yahoo_stock 1.0.8

data/features/step_definitions/script_symbol_steps.rb

@@ -0,0 +1,40 @@
+Given /^I know the name of the company "([^\"]*)"$/ do |company_name|
+  @company_name = company_name
+end
+
+When /^I try to find the scrip symbols for "([^\"]*)"$/ do |company_name|
+  @symbol = YahooStock::ScripSymbol.new(company_name)
+end
+
+Then /^I should be able to get scrip symbol results as a comma separated values in a string$/ do
+  @symbol.results.output.should =~ /.*,.*/
+end
+
+Given /^I have the scrip symbol results for the symbol "([^\"]*)"$/ do |company|
+  @symbol_format = YahooStock::ScripSymbol.new(company)
+  @results = @symbol_format.results
+end
+
+When /^I want to get the scrip symbol results in array format$/ do
+  @array_output = @symbol_format.results(:to_array).output
+end
+
+Then /^I should get an array of values for scrip symbol$/ do
+  @array_output.should_not be_empty
+end
+
+When /^I want to get the scrip symbol results in hash format$/ do
+  @hash_output = @symbol_format.results(:to_hash).output
+end
+
+Then /^I should get an array of hash key values for scrip symbol$/ do
+   @hash_output.first.keys.should_not be_nil
+end
+
+When /^I want to get the scrip symbol results in xml format$/ do
+  @xml_output = @symbol_format.results(:to_xml).output
+end
+
+Then /^I should be able to get scrip symbol result as xml$/ do
+  @xml_output.should =~ /^\<xml*/
+end

data/lib/yahoo_stock.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'date'
+require 'csv'
+require 'yahoo_stock/base.rb'
+require 'yahoo_stock/interface.rb'
+require 'yahoo_stock/history.rb'
+require 'yahoo_stock/scrip_symbol.rb'
+require 'yahoo_stock/quote.rb' 
+require 'yahoo_stock/interface/quote.rb'
+require 'yahoo_stock/interface/history.rb'
+require 'yahoo_stock/interface/scrip_symbol.rb'
+require 'yahoo_stock/result.rb'
+require 'yahoo_stock/result/array_format.rb'
+require 'yahoo_stock/result/hash_format.rb'
+require 'yahoo_stock/result/xml_format.rb'
+
+module YahooStock
+  VERSION = '1.0.3'
+end

data/lib/yahoo_stock/base.rb

@@ -0,0 +1,37 @@
+# YahooStock::Base class to find and output results.
+module YahooStock
+  
+  class Base
+    
+    def initialize(interface)
+      @interface = interface
+    end
+    
+    # Uses the values method of the interface used to show results .
+    def find
+      @interface.values
+    end
+    
+    # Method takes one parameter type or a block
+    # type uses the existing format classes namespaced in Result::ClassName.output
+    # e.g. * results :to_array
+    #      * results {YourSpecialFormat.method_name}
+    # to store
+    def results(type=nil, &block)
+      if block_given?
+        yield
+      else
+        return YahooStock::Result.new(find) if !type || type.to_s.empty?
+        format_type = type.to_s.sub(/^to_/,'').strip
+        return YahooStock::Result.const_get("#{format_type.capitalize}Format").new(find){data_attributes}
+      end
+    end
+    
+    # Abstract method
+    def data_attributes
+      raise 'Abstract method called. Use the subclass data_attributes method'
+    end
+    
+  end
+  
+end

data/lib/yahoo_stock/history.rb

@@ -0,0 +1,32 @@
+module YahooStock
+  class History < Base
+    
+    class HistoryError < RuntimeError; end
+    
+    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
+      @interface = YahooStock::Interface::History.new(options)
+    end
+    
+    def find
+      @find_values = super()
+      @find_values.sub(/Date.*\s/,'') if @find_values
+    end
+    
+    def values_with_header
+      @interface.values
+    end
+    
+    def data_attributes
+      return unless values_with_header
+      data_attributes = /Date.*\s/.match(values_with_header)
+      unless data_attributes.nil?
+        @data_attributes = data_attributes[0].sub(/\s*$/,'').split(',')
+        @data_attributes.map &:strip
+      end
+    end
+    
+  end
+end

data/lib/yahoo_stock/interface.rb

@@ -0,0 +1,71 @@
+=begin
+  Main class to interface with Yahoo
+=end
+
+require 'net/http'
+require 'observer'
+module YahooStock
+   # ==DESCRIPTION:
+   # 
+   # Class to generate the right url and interface with yahoo
+   #
+  class Interface
+    include Observable
+    class InterfaceError < RuntimeError ; end
+
+    BASE_URLS = {
+      :quote        => "http://download.finance.yahoo.com/d/quotes.csv",
+      :history      => "http://ichart.finance.yahoo.com/table.csv",
+      :scrip_symbol => "http://finance.yahoo.com/lookup/all"
+    } unless defined?(BASE_URLS)
+    
+    attr_accessor :base_url, :uri_parameters
+    
+    # Send request to the uri and get results
+    def get
+      begin
+        response = Net::HTTP.get_response(URI.parse(uri))
+      rescue => e
+        raise InterfaceError, "#{e.message}\n\n#{e.backtrace}"
+      end
+      response.code == '200' ? response.body : response_error(response)
+    end
+    
+    # Generates full url to connect to yahoo
+    def uri
+      raise InterfaceError, 'Base url is require to generate full uri.' unless @base_url
+      return @base_url if @uri_parameters.nil? || @uri_parameters.empty?
+      params_with_values = []
+      @uri_parameters.each {|k,v| params_with_values << "#{k}=#{v}"}
+      URI.encode(@base_url+'?'+params_with_values.join('&'))
+    end
+    
+    # Get result string
+    def values
+      @values ||= get
+    end
+    
+    def update
+      @values = nil
+    end
+    
+    private 
+    
+    # Generate error for debugging when something goes wrong while sending
+    # request to yahoo
+    def response_error(response)
+      trace = "Response \n\nbody : #{response.body}\n\ncode: #{response.code}\n\nmessage: #{response.message}"
+      case @base_url
+        when BASE_URLS[:quote]
+          raise InterfaceError, "Error :: Could not get stock data \n\n#{trace}"
+        when BASE_URLS[:history]
+          raise InterfaceError, "Error :: Could not get historical data \n\n#{trace}"
+        when BASE_URLS[:scrip_symbol]
+          raise InterfaceError, "Error :: Could not get stock symbol \n\n#{trace}"
+        else
+          raise InterfaceError, "Error connecting to #{@base_url} \n\n#{trace}"
+      end
+    end
+    
+  end
+end

data/lib/yahoo_stock/interface/history.rb

@@ -0,0 +1,187 @@
+=begin
+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
+
+module YahooStock
+   # ==DESCRIPTION:
+   # 
+   # Class to generate the right url and interface with yahoo to get history of a stock
+   #
+  class Interface::History < Interface
+
+    class HistoryError < RuntimeError ; end
+    
+    attr_reader :stock_symbol, :start_date, :end_date, :type
+    
+    # The options parameter expects a hash with 4 key value pairs
+    #
+    # :stock_symbol => 'goog', :start_date => Date.today-30,
+    # :end_date => Date.today-10, :type => :weekly
+    #
+    # The type option accepts :daily, :monthly, :weekly and :dividend values
+    #
+    # The type key is optional, if not used then by default uses :daily
+    #
+    # and provides daily history for the specified date range
+    #
+    def initialize(options)
+      @base_url = BASE_URLS[:history]
+      validate_keys(options)
+      
+      @stock_symbol = options[:stock_symbol]
+      @start_date   = options[:start_date]
+      @end_date     = options[:end_date]
+      @type     = options[:type].nil? ? :daily : options[:type].to_sym
+      
+      validate_type_values(options[:type]) if options[:type]
+      validate_stock_symbol(options)
+      validate_start_date(options)
+      validate_end_date(options)
+      validate_history_range
+    end
+    
+    # Make sure that stock symbol is not nil or an empty string before setting it
+    def stock_symbol=(stock_symbol)
+      validate_stock_symbol_attribute(stock_symbol)
+      @stock_symbol = stock_symbol
+    end
+    
+    # Before setting start date
+    #   - Make sure that it is of type date
+    #   - Make sure that it is before the end date
+    def start_date=(start_date)
+      validate_start_date_type(start_date)
+      validate_history_range(start_date)
+      @start_date = start_date
+    end
+    
+    # Before setting end date
+    #   - Make sure that it is of type date
+    #   - Make sure that it is after the start date
+    def end_date=(end_date)
+      validate_end_date_type(end_date)
+      validate_history_range(start_date, end_date)
+      @end_date = end_date
+    end
+    
+    # Set type to specify whether daily, weekly, monthly or dividend history required
+    def type=(type)
+      validate_type_values(type)
+      @type = type
+    end
+    
+    # Generate full uri with the help of uri method of the superclass
+    def uri
+      history_type = case type
+                       when :daily     then 'd'
+                       when :weekly    then 'w'
+                       when :monthly   then 'm'
+                       when :dividend  then 'v'
+                     end
+      @uri_parameters = {:a => sprintf("%02d", start_date.month-1), :b => start_date.day, 
+                         :c => start_date.year, :d => sprintf("%02d", end_date.month-1),
+                         :e => end_date.day, :f => end_date.year, :s => stock_symbol,
+                         :g => history_type, :ignore => '.csv'}
+      super()  
+    end
+
+    # Get uri content with the help of get method of the super class
+    def get
+      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
+      uri
+      super()
+    end
+    
+    private
+    
+    def validate_type_values(type_value=type)
+      valid_values = [:daily, :weekly, :monthly, :dividend]
+      unless valid_values.include?(type_value)
+        raise HistoryError, "Allowed values for type 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, :type]
+      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/quote.rb

@@ -0,0 +1,287 @@
+=begin
+
+Parameter source:
+http://www.gummy-stuff.org/Yahoo-data.htm
+http://finance.yahoo.com/d/quotes.csv?s=XOM+BBDb.TO+JNJ+MSFT&f=snd1l1yr
+
+=end
+
+module YahooStock
+   # ==DESCRIPTION:
+   # 
+   # Class to generate the right url and interface with yahoo to get daily stock data
+   #
+  class Interface::Quote < Interface
+
+    class QuoteError < RuntimeError ; end
+    
+    STD_PARAMETERS = {
+      :symbol => 's',
+      :name => 'n',
+      :last_trade_price_only => 'l1',
+      :last_trade_date => 'd1',
+      :last_trade_time => 't1',
+      :change_with_percent_change => 'c',
+      :change => 'c1',
+      :previous_close => 'p',
+      :change_in_percent => 'p2',
+      :open => 'o',
+      :day_low => 'g',
+      :day_high => 'h',
+      :volume => 'v',
+      :last_trade_with_time => 'l',
+      :day_range => 'm',
+      :ticker_trend => 't7',
+      :ask => 'a',
+      :average_daily_volume => 'a2',
+      :bid => 'b',
+      :bid_size => 'b4'
+    } unless defined?(STD_PARAMETERS)
+
+    EXTENDED_PARAMETERS = {
+      :symbol => 's',
+      :name => 'n',
+      :fifty_two_week_range => 'w',
+      :change_from_52_week_low => 'j5',
+      :percent_change_from_52_week_low => 'j6',
+      :change_from_52_week_high => 'k4',
+      :percent_change_from_52_week_high => 'k5',
+      :earnings_per_share => 'e',
+      :short_ratio => 's7',
+      :p_e_ratio => 'r',
+      :dividend_pay_date => 'r1',
+      :ex_dividend_date => 'q',
+      :dividend_per_share => 'd',
+      :dividend_yield => 'y',  
+      :one_yr_target_price => 't8',
+      :market_capitalization => 'j1',  
+      :eps_estimate_current_year => 'e7',
+      :eps_estimate_next_year => 'e8',
+      :eps_estimate_next_quarter => 'e9',
+      :peg_ratio => 'r5',
+      :price_eps_estimate_current_year => 'r6',
+      :price_eps_estimate_next_year => 'r7',
+      :book_value => 'b4',
+      :ebitda => 'j4',
+      :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',
+      :shares_owned => 's1',
+      :price_paid => 'p1',
+      :commission => 'c3',
+      :holdings_value => 'v1',
+      :day_value_change => 'w1',
+      :trade_date => 'd2',
+      :holdings_gain_percent => 'g1',
+      :annualized_gain => 'g3',
+      :holdings_gain => 'g4',
+      :stock_exchange => 'x',
+      :high_limit => 'l2',
+      :low_limit => 'l3',
+      :notes => 'n4',
+      :fifty_two_week_low => 'j',
+      :fifty_two_week_high => 'k',
+      :more_info => 'i',
+    } unless defined?(EXTENDED_PARAMETERS)
+
+    REALTIME_PARAMETERS = {
+      :symbol => 's',
+      :name => 'n',
+      :ask_real_time => 'b2',
+      :bid_real_time => 'b3',
+      :change => 'c1',
+      :change_real_time => 'c6',
+      :after_hours_change_real_time => 'c8',
+      :holdings_gain_percent_real_time => 'g5',
+      :holdings_gain_real_time => 'g6',
+      :order_book_real_time => 'i5',
+      :market_cap_real_time => 'j3',
+      :last_trade_real_time_with_time => 'k1',
+      :change_percent_real_time => 'k2',
+      :day_range_real_time => 'm2',
+      :p_e_ratio_real_time => 'r2',
+      :holdings_value_real_time => 'v7',
+      :day_value_change_real_time => 'w4',
+    } unless defined?(REALTIME_PARAMETERS)
+    
+    attr_reader :stock_symbols
+    
+    # The stock_params_hash parameter expects a hash with two key value pairs
+    # 
+    # :stock_symbols => 'Array of stock symbols'
+    # 
+    # e.g. :stock_symbols => ['YHOO']
+    # 
+    # another hash :read_parameters => ['array of values']
+    # 
+    # e.g. :read_parameters => [:last_trade_price_only, :last_trade_date]
+    def initialize(stock_params_hash)
+      unless stock_params_hash
+        raise QuoteError, '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(QuoteError, 'No stocks passed')
+      end
+      if !stock_params_hash[:read_parameters] || stock_params_hash[:read_parameters].length.zero?
+        raise QuoteError, 'Read parameters are not provided'
+      end
+      @stock_symbols        = stock_params_hash[:stock_symbols]
+      @yahoo_url_parameters = stock_params_hash[:read_parameters]
+      @base_url             = BASE_URLS[:quote]
+      add_observer(self)
+    end
+    
+    def stock_symbols=(stock_symbol)
+      symbols_on_read = @stock_symbols.dup
+      @stock_symbols ||= []
+      @stock_symbols << stock_symbol unless @stock_symbols.include?(stock_symbol)
+      run_observers if symbols_on_read != @stock_symbols
+    end
+    
+    def yahoo_url_parameters
+      return [] if !@yahoo_url_parameters || @yahoo_url_parameters.empty?
+      @yahoo_url_parameters.map(&:id2name).sort.map(&:to_sym)
+    end
+    
+    def yahoo_url_parameters=(yahoo_url_parameter)
+      params_on_read = @yahoo_url_parameters.dup
+      unless allowed_parameters.include?(yahoo_url_parameter)
+        raise QuoteError, "Interface parameter #{yahoo_url_parameter} is not a valid parameter."
+      end
+      @yahoo_url_parameters ||= []
+      @yahoo_url_parameters << yahoo_url_parameter unless @yahoo_url_parameters.include?(yahoo_url_parameter)
+      run_observers if params_on_read != @yahoo_url_parameters
+    end
+    
+    # Generate full url to be sent to yahoo
+    def uri
+      @all_stock_symbols = stock_symbols.join('+')
+      invalid_params = yahoo_url_parameters-allowed_parameters
+      unless invalid_params.length.zero?
+        raise QuoteError, "The parameters '#{invalid_params.join(', ')}' are not valid. Please check using YahooStock::Interface::Quote#allowed_parameters or YahooStock::Quote#valid_parameters" 
+      end
+      @parameter_values  = yahoo_url_parameters.collect {|v| parameters[v]}.join('')
+      if @all_stock_symbols.empty?
+        raise QuoteError, "You must add atleast one stock symbol to get stock data" 
+      end
+      if @parameter_values.empty?
+        raise QuoteError, "You must add atleast one parameter to get stock data" 
+      end
+      @uri_parameters = {:s => @all_stock_symbols, :f => @parameter_values}
+      super()
+    end
+    
+    # Read the result using get method in super class
+    def get
+      uri
+      super()
+    end
+    
+    # TODO MOVE TO THE HASH CLASS
+    # Returns results for the stock symbols as a hash.
+    # The hash keys are the stock symbols and the values are a hash of the keys and 
+    # values asked for that stock.
+    def results
+      stock = {}
+      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
+    
+    # Add stock symbols to the url.
+    def add_symbols(*symbols)
+      symbols.each {|symbol| self.stock_symbols = symbol }
+    end
+    
+    # Remove stock symbols from the url.
+    def remove_symbols(*symbols)
+      symbols.each do |symbol|
+        unless stock_symbols.include?(symbol)
+          raise QuoteError, "Cannot remove stock symbol #{symbol} as it is currently not present."
+        end
+        if stock_symbols.length == 1
+          raise QuoteError, "Symbol #{symbol} is the last symbol. Please add another symbol before removing this."
+        end
+        stock_symbols.reject!{|stock_sym| stock_sym == symbol}
+        run_observers
+      end
+    end
+    
+    # Add parameters to the url.
+    def add_parameters(*parameters)
+      parameters.each {|parameter| self.yahoo_url_parameters = parameter }
+    end
+    
+    # Remove parameters from the url.
+    def remove_parameters(*parameters)
+      parameters.each do |parameter|
+        unless yahoo_url_parameters.include?(parameter)
+          raise QuoteError, "Parameter #{parameter} is not present in current list"
+        end
+        if yahoo_url_parameters.length == 1
+          raise QuoteError, "Parameter #{parameter} is the last parameter. Please add another parameter before removing this."     
+        end
+        @yahoo_url_parameters.reject!{|parameter_key| parameter_key == parameter}
+        run_observers
+      end
+    end
+    
+    # Returns an array of parameters that can be passed to yahoo.
+    def allowed_parameters
+      parameters.keys
+    end
+    
+    # Add standard parameters
+    def add_standard_params
+      add_grouped_parameters(STD_PARAMETERS.keys)
+    end
+    
+    # Add extended parameters
+    def add_extended_params
+      add_grouped_parameters(EXTENDED_PARAMETERS.keys)
+    end
+    
+    # Add realtime parameters
+    def add_realtime_params
+      add_grouped_parameters(REALTIME_PARAMETERS.keys)
+    end
+    
+    # Clear all existing parameters from the current instance.
+    def clear_parameters
+      @yahoo_url_parameters.clear
+      run_observers
+    end
+    
+    # Clear all existing symbols from the current instance.
+    def clear_symbols
+      stock_symbols.clear
+      run_observers
+    end
+    
+    private
+    
+    def add_grouped_parameters(parameter_group)
+      return if (parameter_group - yahoo_url_parameters).empty?
+      clear_parameters
+      parameter_group.each { |parameter| add_parameters(parameter) }
+    end
+    
+    def run_observers
+      changed
+      notify_observers
+    end
+    
+    def parameters
+      STD_PARAMETERS.merge(EXTENDED_PARAMETERS).merge(REALTIME_PARAMETERS)
+    end
+    
+  end
+end