nas-yahoo_stock 0.1.5 → 0.1.6

data/History.txt

@@ -26,3 +26,9 @@
 
 * 1 changes related with ruby 1.9:
   * modifies ScripSymbol class to be compatible with ruby 1.9
+
+=== 0.1.6 2009-09-07
+
+* 1 addition:
+  * adds convenience methods Quote#realtime, standard and extended to 
+    fetch relevant stock values

data/lib/yahoo_stock/interface.rb

@@ -15,89 +15,97 @@ module YahooStock
   class Interface
 
     class InterfaceError < RuntimeError ; end
-      
-    PARAMETERS = {
+    
+    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',
-      :ask_size => 'a5',
       :bid => 'b',
-      :ask_real_time => 'b2',
-      :bid_real_time => 'b3',
-      :book_value => 'b4',
-      :bid_size => 'b4',
-      :change_with_percent_change => 'c',
-      :change => 'c1',
-      :commission => 'c3',
-      :change_real_time => 'c6',
-      :after_hours_change_real_time => 'c8',
-      :dividend_per_share => 'd',
-      :last_trade_date => 'd1',
-      :trade_date => 'd2',
+      :bid_size => 'b4'
+    }
+
+    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',
-      :error_indication => 'e1',
+      :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',
-      :day_low => 'g',
-      :day_high => 'h',
-      :fifty_two_week_low => 'j',
-      :fifty_two_week_high => 'k',
+      :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',
+    }
+
+    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',
-      :more_info => 'i',
       :order_book_real_time => 'i5',
-      :market_capitalization => 'j1',
       :market_cap_real_time => 'j3',
-      :ebitda => 'j4',
-      :change_from_52_week_low => 'j5',
-      :percent_change_from_52_week_low => 'j6',
       :last_trade_real_time_with_time => 'k1',
       :change_percent_real_time => 'k2',
-      :change_from_52_week_high => 'k4',
-      :percent_change_from_52_week_high => 'k5',
-      :last_trade_with_time => 'l',
-      :last_trade_price_only => 'l1',
-      :high_limit => 'l2',
-      :low_limit => 'l3',
-      :day_range => 'm',
       :day_range_real_time => 'm2',
-      :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',
-      :name => 'n',
-      :notes => 'n4',
-      :open => 'o',
-      :previous_close => 'p',
-      :price_paid => 'p1',
-      :change_in_percent => 'p2',
-      :ex_dividend_date => 'q',
-      :p_e_ratio => 'r',
-      :dividend_pay_date => 'r1',
       :p_e_ratio_real_time => 'r2',
-      :peg_ratio => 'r5',
-      :price_eps_estimate_current_year => 'r6',
-      :price_eps_estimate_next_year => 'r7',
-      :symbol => 's',
-      :shares_owned => 's1',
-      :short_ratio => 's7',
-      :last_trade_time => 't1',
-      :trade_links => 't6',
-      :ticker_trend => 't7',
-      :one_yr_target_price => 't8',
-      :volume => 'v',
-      :holdings_value => 'v1',
       :holdings_value_real_time => 'v7',
-      :fifty_two_week_range => 'w',
-      :day_value_change => 'w1',
       :day_value_change_real_time => 'w4',
-      :stock_exchange => 'x',
-      :dividend_yield => 'y',
     }
     
     attr_accessor :stock_symbols, :yahoo_url_parameters
@@ -210,10 +218,25 @@ module YahooStock
       parameters.keys
     end
     
+    # Add standard parameters
+    def add_standard_params
+      STD_PARAMETERS.keys.each { |parameter| add_parameters(parameter) }
+    end
+    
+    # Add extended parameters
+    def add_extended_params
+      EXTENDED_PARAMETERS.keys.each { |parameter| add_parameters(parameter) }
+    end
+    
+    # Add realtime parameters
+    def add_realtime_params
+      REALTIME_PARAMETERS.keys.each { |parameter| add_parameters(parameter) }
+    end
+    
     private
     
     def parameters
-      PARAMETERS
+      STD_PARAMETERS.merge!(EXTENDED_PARAMETERS).merge!(REALTIME_PARAMETERS)
     end
     
   end

data/lib/yahoo_stock/quote.rb

@@ -18,6 +18,18 @@ module YahooStock
   # 
   #     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
@@ -51,7 +63,7 @@ module YahooStock
     # 
     # e.g. :read_parameters => [:last_trade_price_only, :last_trade_date]
     def initialize(options)
-      if options.nil? || !options[:stock_symbols]
+      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?
@@ -60,7 +72,7 @@ module YahooStock
       if !(options[:read_parameters] && options[:read_parameters].any?)
         options[:read_parameters] = [:last_trade_price_only, :last_trade_date]
       end
-      options[:stock_symbols] = options[:stock_symbols].to_a unless options[:stock_symbols].kind_of?(Array)
+      options[:stock_symbols] = Array.new << options[:stock_symbols] unless options[:stock_symbols].is_a?(Array)
       @interface = YahooStock::Interface.new(options)
     end
     
@@ -71,6 +83,21 @@ module YahooStock
       @interface.results
     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
+        clear_parameters
+        @interface.send("add_#{quote_type}_params".to_sym)
+        get
+      end
+    end
+    
     # Adds more stock symbols to the existing instance.
     # One or more stock symbols can be passed as parameter.
     def add_symbols(*symbols)

data/spec/yahoo_stock/interface_spec.rb

@@ -213,4 +213,55 @@ describe YahooStock::Interface do
     
   end
   
+  describe "add_standard_params" do
+    
+    it "should get the keys for standard parameters" do
+      YahooStock::Interface::STD_PARAMETERS.should_receive(:keys).and_return([])
+      @interface.add_standard_params
+    end
+    
+    it "should add each parameter" do
+      keys = [:a_key, :b_key]
+      YahooStock::Interface::STD_PARAMETERS.stub!(:keys).and_return(keys)
+      @interface.should_receive(:add_parameters).with(:a_key)
+      @interface.should_receive(:add_parameters).with(:b_key)
+      @interface.add_standard_params
+    end
+   
+  end
+  
+  describe "add_extended_params" do
+    
+    it "should get the keys for extended parameters" do
+      YahooStock::Interface::EXTENDED_PARAMETERS.should_receive(:keys).and_return([])
+      @interface.add_extended_params
+    end
+    
+    it "should add each parameter" do
+      keys = [:a_key, :b_key]
+      YahooStock::Interface::EXTENDED_PARAMETERS.stub!(:keys).and_return(keys)
+      @interface.should_receive(:add_parameters).with(:a_key)
+      @interface.should_receive(:add_parameters).with(:b_key)
+      @interface.add_extended_params
+    end
+   
+  end
+  
+  describe "add_realtime_params" do
+    
+    it "should get the keys for realtime parameters" do
+      YahooStock::Interface::REALTIME_PARAMETERS.should_receive(:keys).and_return([])
+      @interface.add_realtime_params
+    end
+    
+    it "should add each parameter" do
+      keys = [:a_key, :b_key]
+      YahooStock::Interface::REALTIME_PARAMETERS.stub!(:keys).and_return(keys)
+      @interface.should_receive(:add_parameters).with(:a_key)
+      @interface.should_receive(:add_parameters).with(:b_key)
+      @interface.add_realtime_params
+    end
+   
+  end
+  
 end

data/spec/yahoo_stock/quote_spec.rb

@@ -10,11 +10,15 @@ module YahooStock
       end
     
       it "should raise QuoteException error when parameter passed is nil" do
-        lambda { YahooStock::Quote.new(nil)}.should raise_error Quote::QuoteException
+        lambda { YahooStock::Quote.new(nil)}.should raise_error(Quote::QuoteException, 'You must provide a hash of stock symbols to fetch data')
+      end
+      
+      it "should raise QuoteException error when parameter passed is not a hash" do
+        lambda { YahooStock::Quote.new('erred')}.should raise_error(Quote::QuoteException, 'You must provide a hash of stock symbols to fetch data')
       end
     
       it "should raise QuoteException when a hash of stock_symbols are not passed" do
-        lambda { YahooStock::Quote.new(:misspelled => 'YHOO')}.should raise_error(Quote::QuoteException, 'You must provide a hash of stock symbols to fetch data')
+        lambda { YahooStock::Quote.new(:misspelled => 'YHOO')}.should raise_error(Quote::QuoteException, 'You must provide atleast one stock symbol to fetch data')
       end
     
       it "should raise QuoteException when stock symbols hash key value is an emtpy array" do
@@ -227,6 +231,84 @@ module YahooStock
         end
         
       end
+      
+      describe "realtime" do
+        
+        before(:each) do
+          @quote.stub!(:get)
+          @interface.stub!(:add_realtime_params)
+        end
+        
+        it "should clear all existing parameters for the existing instance" do
+          @quote.should_receive(:clear_parameters)
+          @quote.realtime
+        end
+        
+        it "should add the realtime parameters" do
+          @quote.stub!(:clear_parameters)
+          @interface.should_receive(:add_realtime_params)
+          @quote.realtime
+        end
+        
+        it "should get the results" do
+          @quote.stub!(:clear_parameters)
+          @quote.should_receive(:get)
+          @quote.realtime
+        end
+
+      end
+      
+      describe "standard" do
+        
+        before(:each) do
+          @quote.stub!(:get)
+          @interface.stub!(:add_standard_params)
+        end
+        
+        it "should clear all existing parameters for the existing instance" do
+          @quote.should_receive(:clear_parameters)
+          @quote.standard
+        end
+        
+        it "should add the realtime parameters" do
+          @quote.stub!(:clear_parameters)
+          @interface.should_receive(:add_standard_params)
+          @quote.standard
+        end
+        
+        it "should get the results" do
+          @quote.stub!(:clear_parameters)
+          @quote.should_receive(:get)
+          @quote.standard
+        end
+
+      end
+      
+      describe "extended" do
+        
+        before(:each) do
+          @quote.stub!(:get)
+          @interface.stub!(:add_extended_params)
+        end
+        
+        it "should clear all existing parameters for the existing instance" do
+          @quote.should_receive(:clear_parameters)
+          @quote.extended
+        end
+        
+        it "should add the realtime parameters" do
+          @quote.stub!(:clear_parameters)
+          @interface.should_receive(:add_extended_params)
+          @quote.extended
+        end
+        
+        it "should get the results" do
+          @quote.stub!(:clear_parameters)
+          @quote.should_receive(:get)
+          @quote.extended
+        end
+
+      end
   
     end
   end 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nas-yahoo_stock
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-06 00:00:00 -07:00
+date: 2009-09-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency