nas-yahoo_stock 0.1.2 → 0.1.3

data/History.txt

@@ -7,3 +7,12 @@
 
 * 1 minor change:
   * changed method name YahooStock::Quote#get_data to get
+
+=== 0.1.3 2009-09-05
+
+* 1 addition:
+  * adds a new class called YahooStock::ScripSymbol that allows to 
+    find out the stock symbol for a company
+  * adds specs for previous and new code
+  * adds rdocs
+  

data/Manifest.txt

@@ -5,5 +5,7 @@ Rakefile
 lib/yahoo_stock.rb
 lib/yahoo_stock/quote.rb
 lib/yahoo_stock/interface.rb
+lib/yahoo_stock/scrip_symbol.rb
 spec/spec_helper.rb
 spec/yahoo_stock/quote_spec.rb
+spec/yahoo_stock/scrip_symbol_spec.rb

data/README.rdoc

@@ -6,7 +6,7 @@
 
 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, virtually that yahoo finance provides.
 
-You must know the stock symbol. For instance, YHOO for yahoo, GOOG for google, etc. 
+If you don't know the stock / scrip symbol of the company then you can find that out by using the YahooStock::ScripSymbol class. The methods are mentioned in the Usage section below. 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, example is given below in the USAGE section.
 
@@ -44,6 +44,13 @@ quote.remove_symbols('MSFT', 'AAPL')
 
 quote.get
 
+* To find out the stock symbol for a company
+  
+YahooStock::ScripSymbol.print_options('Yahoo', 'Company1', 'Company3')
+
+* To store the output in a file
+
+YahooStock::ScripSymbol.save_options_to_file('path/to/filename','Yahoo', 'Company1', 'Company3')
 
 == INSTALL:
 

data/lib/yahoo_stock/interface.rb

@@ -1,20 +1,19 @@
 =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
 
-=begin
-
-Class to generate the right url and interface with yahoo
-
-=end
-
 require 'net/http'
 module YahooStock
+   # ==DESCRIPTION:
+   # 
+   # Class to generate the right url and interface with yahoo
+   #
   class Interface
-    
+
     class InterfaceError < RuntimeError ; end
       
     PARAMETERS = {
@@ -103,6 +102,15 @@ module YahooStock
     
     attr_accessor :stock_symbols, :yahoo_url_parameters
     
+    # 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 InterfaceError, 'You must pass a hash of stock symbols and the data you would like to see' 
@@ -118,6 +126,7 @@ module YahooStock
       @base_url      = "http://download.finance.yahoo.com/d/quotes.csv"
     end
     
+    # Generate full url to be sent to yahoo
     def full_url
       all_stock_symbols = stock_symbols.join('+')
       params = yahoo_url_parameters-allowed_parameters
@@ -134,10 +143,15 @@ module YahooStock
       "#{@base_url}?s=#{all_stock_symbols}&f=#{parameter_values}"
     end
     
+    # Get the csv file and create an array of different stock symbols and values returned 
+    # for the parameters passed based on line break.
     def get_values
       Net::HTTP.get(URI.parse(full_url)).gsub(/\"/,'').split(/\r\n/)
     end
     
+    # 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 = {}
       get_values.each_with_index do |values, index|
@@ -150,6 +164,7 @@ module YahooStock
       stock
     end
     
+    # Add stock symbols to the url.
     def add_symbols(*symbols)
       symbols.each do |symbol|
         unless stock_symbols.include?(symbol)
@@ -158,6 +173,7 @@ module YahooStock
       end
     end
     
+    # Remove stock symbols from the url.
     def remove_symbols(*symbols)
       symbols.each do |symbol|
         unless stock_symbols.include?(symbol)
@@ -167,6 +183,7 @@ module YahooStock
       end
     end
     
+    # Add parameters to the url.
     def add_parameters(*parameters)
       parameters.each do |parameter|
         unless allowed_parameters.include?(parameter)
@@ -178,6 +195,7 @@ module YahooStock
       end
     end
     
+    # Remove parameters from the url.
     def remove_parameters(*parameters)
       parameters.each do |parameter|
         unless yahoo_url_parameters.include?(parameter)
@@ -187,6 +205,7 @@ module YahooStock
       end
     end
     
+    # Returns an array of parameters that can be passed to yahoo.
     def allowed_parameters
       parameters.keys
     end

data/lib/yahoo_stock/quote.rb

@@ -1,14 +1,55 @@
 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 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
-    
     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'
+    # 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]
-    # 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"
@@ -23,47 +64,64 @@ module YahooStock
       @interface = YahooStock::Interface.new(options)
     end
     
+    # 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 get
       @interface.results
     end
     
+    # Adds more stock symbols to the existing instance.
+    # One or more stock symbols can be passed as parameter.
     def add_symbols(*symbols)
       symbols.each { |symbol| @interface.add_symbols(symbol) }
     end
     
+    # Removes stock symbols from the existing instance.
+    # One of more stock symbols can be passed to remove.
     def remove_symbols(*symbols)
       symbols.each { |symbol| @interface.remove_symbols(symbol) }
     end
     
+    # Clear all existing stock symbols from the current instance.
     def clear_symbols
       @interface.stock_symbols.clear
     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)
       parameters.each { |parameter| @interface.add_parameters(parameter) }
     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)
       parameters.each { |parameter| @interface.remove_parameters(parameter) }
     end
     
+    # Shows all parameters in the current instance that will be used to get results.
     def current_parameters
       sort_symbols(@interface.yahoo_url_parameters)
     end
     
+    # 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.yahoo_url_parameters.clear
     end
     
+    # Returns an array of all allowed parameters that can be used.
     def valid_parameters
       sort_symbols(@interface.allowed_parameters)
     end

data/lib/yahoo_stock/scrip_symbol.rb

@@ -0,0 +1,99 @@
+require 'net/http'
+
+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 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
+    # Initialize with the name of the company as parameter for which stock symbol is needed
+    # 
+    #     symbol = YahooStock::ScripSymbol.new('company name')
+    # 
+    #     symbol.find
+    def initialize(company)
+      company = company.gsub(/\s/,'+')
+      @base_url = "http://finance.yahoo.com/lookup/all?s=#{company}"
+      @before_element = 'yfi_sym_results'
+      @after_element = 'yfi_fp_left_bottom'
+    end
+    
+    # Returns 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.
+    def find
+      data = []
+      rows = get_results.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(/\<.*\>/,'')
+          row_data << datum if !datum.nil? || !datum.any?
+          row_data.reject!{|rd| !rd.any?}
+        end
+        data << row_data if row_data.length > 1 
+      end
+      data
+    end
+    
+    # This is just a convenience method to print all results on your console screen 
+    # and to return nil at the end. It uses find method to print symbols on the screen.
+    def self.print_options(*companies)
+      companies.each do |name|
+        scrip_symbol = self.new(name)
+        scrip_symbol.find.each {|scrip| p scrip}
+      end
+      nil
+    end
+    
+    # Another convenience method to store all returned results into a file
+    def self.save_options_to_file(file_name, *companies)
+      File.open(file_name, 'a') do |f|
+        companies.each do |name|
+          scrip_symbol = self.new(name)
+          scrip_symbol.find.each do |scrip| 
+            f.write(scrip.join(', '))
+            f.puts('')
+          end
+        end
+      end
+    end
+    
+    private
+    
+    # Makes an http request to the given url and returns only the text among two points
+    def get_results
+      @body ||= Net::HTTP.get(URI.parse(@base_url)).gsub!(/\s*/,'')
+      pattern = /#{@before_element}.*#{@after_element}/
+      results = pattern.match(@body)
+      if results
+        return results[0]
+      end
+    end
+    
+  end
+end

data/lib/yahoo_stock.rb

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

data/spec/yahoo_stock/scrip_symbol_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YahooStock::ScripSymbol do
+  
+  describe "find" do
+    before(:each) do
+      @script_symbol = YahooStock::ScripSymbol.new('company1')
+    end
+    
+    it "should get results" do
+      @script_symbol.should_receive(:get_results)
+      @script_symbol.find
+    end
+    
+    it "should convert the results to string and split them on the basis of tr tags" do
+      res = 'Some results returned'
+      @script_symbol.stub!(:get_results).and_return(res)
+      res.should_receive(:split).with(/\<\/tr>/).and_return([])
+      @script_symbol.find
+    end
+    
+    it "should return an array of options" do
+      @script_symbol.stub!(:get_results).and_return('ss')
+      @script_symbol.find.class.should eql(Array)
+    end
+  end
+  
+  describe ".print_options" do
+    before(:each) do
+      @symbol = stub(YahooStock::ScripSymbol)
+      @script_symbol = YahooStock::ScripSymbol.stub!(:new).and_return(@symbol)
+    end
+    
+    it "should find scrip symbol for one company" do
+      @symbol.should_receive(:find).once.and_return([])
+      YahooStock::ScripSymbol.print_options('company1')
+    end
+    
+    it "should find scrip symbols for two companies" do
+      @symbol.should_receive(:find).twice.and_return([])
+      YahooStock::ScripSymbol.print_options('company1', 'company2')
+    end
+    
+    it "should return nil" do
+      @symbol.should_receive(:find).and_return([])
+      YahooStock::ScripSymbol.print_options('company1').should eql(nil)
+    end
+    
+    it "should print the results for each scrip or company, i.e twice" do
+      scrip = ['name','stock']
+      @symbol.stub!(:find).and_return([scrip])
+      YahooStock::ScripSymbol.should_receive(:p).with(scrip).twice
+      YahooStock::ScripSymbol.print_options('company1','company2')
+    end
+    
+    it "should print the results for each scrip or company, 4times" do
+      scrip = ['name','stock']
+      @symbol.stub!(:find).and_return([scrip,scrip])
+      YahooStock::ScripSymbol.should_receive(:p).with(scrip).exactly(4)
+      YahooStock::ScripSymbol.print_options('company1','company2')
+    end
+  end
+  
+  describe ".save_options_to_file" do
+    before(:each) do
+      @symbol = stub(YahooStock::ScripSymbol)
+      @script_symbol = YahooStock::ScripSymbol.stub!(:new).and_return(@symbol)
+      @file = stub(File)
+      @file_name = 'file_name'
+    end
+    
+    it "should create or open a file with file name parameter and appends to it" do
+      File.should_receive(:open).with(@file_name, 'a')
+      YahooStock::ScripSymbol.save_options_to_file('file_name', 'company1')
+    end
+    
+    it "should find scrip symbol for one company" do
+      @symbol.should_receive(:find).once.and_return([])
+      YahooStock::ScripSymbol.save_options_to_file(@file_name,'company1')
+    end
+
+    it "should find scrip symbols for two companies" do
+      @symbol.should_receive(:find).twice.and_return([])
+      YahooStock::ScripSymbol.save_options_to_file(@file_name, 'company1','company2')
+    end
+    
+    it "should have one option for each company in the file" do
+      scrip = ['name','stock']
+      @symbol.stub!(:find).and_return([scrip])
+      YahooStock::ScripSymbol.save_options_to_file(@file_name, 'company1','company2')
+      file_data.should eql(["name, stock\n", "name, stock\n"])
+    end
+    
+    it "should have two option for each company in the file" do
+      scrip = ['name','stock']
+      @symbol.stub!(:find).and_return([scrip, scrip])
+      YahooStock::ScripSymbol.save_options_to_file(@file_name, 'company1','company2')
+      file_data.should eql(["name, stock\n", "name, stock\n", "name, stock\n", "name, stock\n"])
+    end
+    
+    def file_data
+      File.open(@file_name, 'r') { |f| return f.readlines }
+    end
+    
+    after(:each) do
+      File.delete(@file_name) if File.exists? @file_name
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nas-yahoo_stock
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -48,12 +48,13 @@ files:
 - lib/yahoo_stock.rb
 - lib/yahoo_stock/quote.rb
 - lib/yahoo_stock/interface.rb
+- lib/yahoo_stock/scrip_symbol.rb
 - spec/spec_helper.rb
 - spec/yahoo_stock/quote_spec.rb
 - spec/yahoo_stock/interface_spec.rb
+- spec/yahoo_stock/scrip_symbol_spec.rb
 has_rdoc: true
 homepage: http://github.com/nas/yahoo_stock
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+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.