nas-yahoo_stock 1.0.1 → 1.0.2

data/lib/yahoo_stock/quote.rb

@@ -50,7 +50,7 @@ module YahooStock
   # 
   #     quote.remove_symbols('MSFT', 'AAPL')
   # 
-  class Quote
+  class Quote < Base
     class QuoteException < RuntimeError; end
     
     # The options parameter expects a hash with two key value pairs
@@ -73,14 +73,7 @@ module YahooStock
         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.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
+      @interface = YahooStock::Interface::Quote.new(options)
     end
     
     # Create methods:
@@ -92,27 +85,26 @@ module YahooStock
     #     - To get standard values for stocks
     %w{realtime extended standard}.each do |quote_type|
       self.send(:define_method, "#{quote_type}".to_sym) do
-        clear_parameters
         @interface.send("add_#{quote_type}_params".to_sym)
-        get
+        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)
-      symbols.each { |symbol| @interface.add_symbols(symbol) }
+      @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)
-      symbols.each { |symbol| @interface.remove_symbols(symbol) }
+      @interface.remove_symbols(*symbols)
     end
     
     # Clear all existing stock symbols from the current instance.
     def clear_symbols
-      @interface.stock_symbols.clear
+      @interface.clear_symbols
     end
     
     # Show all stock symbols in the current instance that will be used to get results.
@@ -123,20 +115,22 @@ module YahooStock
     # 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) }
+      @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)
-      parameters.each { |parameter| @interface.remove_parameters(parameter) }
+      @interface.remove_parameters(*parameters)
     end
     
     # Shows all parameters in the current instance that will be used to get results.
     def current_parameters
-      sort_symbols(@interface.yahoo_url_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)}
@@ -145,7 +139,8 @@ module YahooStock
     
     # Clear all existing parameters from the current instance.
     def clear_parameters
-      @interface.yahoo_url_parameters.clear
+      @interface.clear_parameters
+      current_parameters
     end
     
     # Returns an array of all allowed parameters that can be used.

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/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/scrip_symbol.rb

@@ -1,5 +1,3 @@
-require 'net/http'
-
 module YahooStock
   # == DESCRIPTION:
   # 
@@ -13,7 +11,9 @@ module YahooStock
   # 
   #     symbol = YahooStock::ScripSymbol.new('company name')
   # 
-  #     symbol.find
+  #     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
@@ -29,71 +29,33 @@ module YahooStock
   # 
   #     YahooStock::ScripSymbol.save_options_to_file('path/to/filename','company1', 'company2')
   # 
-  class ScripSymbol
+  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
-    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.empty?
-          row_data.reject!{|rd| rd.empty?}
-        end
-        data << row_data if row_data.length > 1 
-      end
-      data
-    end
+    attr_reader :company
     
-    # 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
+    def initialize(company_name)
+      @company = company_name
+      @interface = YahooStock::Interface::ScripSymbol.new(@company)
     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
+    def company=(company)
+      @company = @interface.company = company
     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
+    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/lib/yahoo_stock.rb

@@ -2,11 +2,18 @@ $:.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/base.rb'
 require 'yahoo_stock/interface.rb'
-require 'yahoo_stock/quote.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'
 
 module YahooStock
-  VERSION = '0.1.3'
+  VERSION = '1.0.2'
 end

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

@@ -14,177 +14,62 @@ describe YahooStock::History do
         }.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')
+    it "should inititalize the history interface" do
+      options = {}
+      YahooStock::Interface::History.should_receive(:new).with(options)
+      YahooStock::History.new({})
     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
+  describe "find" 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')
+      @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 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')
+    it "should find values using interface" do
+      @interface.should_receive(:values).and_return('data')
+      @history.find
     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') 
+    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
-    
-    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
+  
+  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 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')
+    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 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)
+    it "should return only header values if history values are present" do
+      @history.data_attributes.should eql(["Date","price","etc"])
     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
+  end
+  
+  describe "values_with_header" do
     
-    it "should set the interval" do
-      @history.interval = :daily
-      @history.interval.should eql(:daily)
+    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