they-yahoo_stock 1.0.8

data/lib/yahoo_stock/interface/scrip_symbol.rb

@@ -0,0 +1,74 @@
+module YahooStock
+   # ==DESCRIPTION:
+   # 
+   # Class to generate the right url and interface with yahoo to get Scrip / Stock Symbols
+   #
+  class Interface::ScripSymbol < Interface
+
+    class ScripSymbolError < RuntimeError ; end
+    
+    attr_reader :company
+    # Scrapes the resulting page and gets data in between two points
+    def initialize(company)
+      @base_url = BASE_URLS[:scrip_symbol]
+      @company = remove_any_space(company)
+      @before_element = 'yfi_sym_results'
+      @after_element = 'yfi_fp_left_bottom'
+      add_observer(self)
+    end
+    
+    # Generate full uri with the help of uri method of the superclass
+    def uri
+      @uri_parameters = {:s => @company}
+      super()  
+    end
+
+    # Get uri content with the help of get method of the super class
+    def get
+      uri
+      super()
+    end
+    
+    def values
+      @values ||= get_values
+    end
+    
+    def company=(company)
+      old_company = @company
+      @company = remove_any_space(company)
+      old_company != @company ? changed : changed(false)
+      notify_observers
+    end
+    
+    private
+    
+    def remove_any_space(words)
+      words.gsub(/\s/,'+')
+    end
+    # returns only the text among two points
+    def text_range
+      body = get.gsub!(/\s*/,'')
+      pattern = /#{@before_element}.*#{@after_element}/
+      results = pattern.match(body)
+      return results[0] if results
+    end
+    
+    # Returns all possible values in a single string
+    def get_values
+      data = []
+      rows = text_range.to_s.split(/\<\/tr>/)
+      rows.each_with_index do |row, row_i|
+        cells = row.split(/\<\/td>/)
+        row_data = []
+        cells.each_with_index do |cell, cell_i|
+          datum = cell.sub('</a>','').gsub(/\<.*\>/,'').strip
+          row_data << datum if !datum.nil? || datum.empty?
+        end
+        data << row_data.join(',') if row_data.length > 1 
+      end
+      data.join("\r\n")
+    end
+    
+  end
+  
+end

data/lib/yahoo_stock/quote.rb

@@ -0,0 +1,158 @@
+module YahooStock
+  # == DESCRIPTION:
+  # 
+  # Provides the stock related current data.
+  # 
+  # Uses YahooStock::Interface to connect to yahoo and get relevant data.
+  # 
+  # == USAGE:
+  # 
+  # * Initialize quote object
+  # 
+  #     quote = YahooStock::Quote.new(:stock_symbols => ['YHOO', 'GOOG'], 
+  #                                   :read_parameters => [:last_trade_price_only, :last_trade_date])
+  # 
+  # If read_parameters are not provided then by default the above two parameters are used.
+  # 
+  # * To get data for all stocks
+  # 
+  #     quote.get
+  # 
+  # * To get data with real time values
+  # 
+  #     quote.realtime
+  # 
+  # * To get data with standard values
+  # 
+  #     quote.standard
+  # 
+  # * To get data with extra parameter values
+  # 
+  #     quote.extended
+  # 
+  # * 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')
+  # 
+  class Quote < Base
+    class QuoteException < RuntimeError; end
+    
+    # The options parameter expects a hash with two key value pairs
+    # 
+    # :stock_symbols => 'Array of stock symbols' or a single symbol
+    # 
+    # e.g. :stock_symbols => ['MSFT','YHOO'] or :stock_symbols => 'YHOO'
+    # 
+    # another hash :read_parameters => 'array of values'
+    # 
+    # e.g. :read_parameters => [:last_trade_price_only, :last_trade_date]
+    def initialize(options)
+      if options.nil? || !options.is_a?(Hash)
+        raise QuoteException, "You must provide a hash of stock symbols to fetch data"
+      end
+      if options[:stock_symbols].nil? || options[:stock_symbols].empty?
+        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] = Array.new << options[:stock_symbols] unless options[:stock_symbols].is_a?(Array)
+      @interface = YahooStock::Interface::Quote.new(options)
+    end
+    
+    # Create methods:
+    #   def realtime 
+    #     - To get realtime stock values
+    #   def extended
+    #     - To get values for extra parameters
+    #   def standard
+    #     - To get standard values for stocks
+    %w{realtime extended standard}.each do |quote_type|
+      self.send(:define_method, "#{quote_type}".to_sym) do
+        @interface.send("add_#{quote_type}_params".to_sym)
+        return self
+      end
+    end
+    
+    # Adds more stock symbols to the existing instance.
+    # One or more stock symbols can be passed as parameter.
+    def add_symbols(*symbols)
+      @interface.add_symbols(*symbols)
+    end
+    
+    # Removes stock symbols from the existing instance.
+    # One of more stock symbols can be passed to remove.
+    def remove_symbols(*symbols)
+      @interface.remove_symbols(*symbols)
+    end
+    
+    # Clear all existing stock symbols from the current instance.
+    def clear_symbols
+      @interface.clear_symbols
+    end
+    
+    # Show all stock symbols in the current instance that will be used to get results.
+    def current_symbols
+      @interface.stock_symbols
+    end
+    
+    # Adds more parameters for the stock symbols to the existing instance for getting data.
+    # One or more parameters can be passed as argument.
+    def add_parameters(*parameters)
+      @interface.add_parameters(*parameters)
+    end
+    
+    # Removes parameters for the stock symbols to get values for from the existing instance.
+    # One of more parameters can be passed to remove.
+    def remove_parameters(*parameters)
+      @interface.remove_parameters(*parameters)
+    end
+    
+    # Shows all parameters in the current instance that will be used to get results.
+    def current_parameters
+      @interface.yahoo_url_parameters
+    end
+    
+    alias :data_attributes :current_parameters
+    
+    # Set current instance to use all parameters to fetch values for current symbols.
+    def use_all_parameters
+      params = valid_parameters.each {|parameter| add_parameters(parameter)}
+      sort_symbols(params)
+    end
+    
+    # Clear all existing parameters from the current instance.
+    def clear_parameters
+      @interface.clear_parameters
+      current_parameters
+    end
+    
+    # Returns an array of all allowed parameters that can be used.
+    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/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,23 @@
+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
+        CSV.parse @data
+      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/result/xml_format.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'builder'
+
+module YahooStock
+  # == DESCRIPTION:
+  # Convert results to xml
+  # 
+  # == USAGE
+  # YahooStock::Result::XmlFormat.new("data as string"){[:keys => :values]}.output
+  #
+  # Mostly will be used as a separate strategy for formatting results  to xml
+  
+  class Result::XmlFormat < Result
+    def initialize(data, &block)
+      @hash_format = YahooStock::Result::HashFormat.new(data){yield}
+      @data = @hash_format.output
+      super(self)
+    end
+    
+    def output
+      builder = Builder::XmlMarkup.new(:indent=>2)
+      builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      builder.items do |items|
+        @data.each do |data|
+          builder.item do |b|
+            data.each_pair do |key, value|
+              next if key.nil?
+              eval("b.#{key}(value)")
+            end
+          end
+        end
+      end
+      builder
+    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,4 @@
+$: << File.join(File.dirname(__FILE__), "/../lib") 
+
+require 'rspec'
+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