nas-yahoo_stock 1.0.6 → 1.0.7

data/History.txt

@@ -87,4 +87,8 @@ Major changes in the public API. Check the README.rdoc file and individual class
   * adds cucumber rake task
 
 * 1 changes:
-  * Make sure all tests are run with rspec 2.1.0
+  * Make sure all tests are run with rspec 2.1.0
+
+=== 1.0.7 2010-11-14
+
+* Some refactoring after the addition of dividend option to the history

data/README.rdoc

@@ -90,7 +90,7 @@ For details : http://nasir.wordpress.com/2009/10/28/ruby-gem-for-finance-data
 
 * To find historical data for a stock:
 
-	history = YahooStock::History.new(:stock_symbol => 'yhoo', :start_date => Date.today-20, :end_date => Date.today -2)
+	history = YahooStock::History.new(:stock_symbol => 'yhoo', :start_date => Date.today-20, :end_date => Date.today-2)
 
 * As with regular quotes and symbol lookups, the results can be returned in various formats:
 

data/lib/yahoo_stock/interface/history.rb

@@ -21,16 +21,16 @@ module YahooStock
 
     class HistoryError < RuntimeError ; end
     
-    attr_reader :stock_symbol, :start_date, :end_date, :interval
+    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, :interval => :weekly
+    # :end_date => Date.today-10, :type => :weekly
     #
-    # The interval option accepts :daily, :monthly, :weekly and :dividend values
+    # The type option accepts :daily, :monthly, :weekly and :dividend values
     #
-    # The interval key is optional, if not used then by default uses :daily
+    # The type key is optional, if not used then by default uses :daily
     #
     # and provides daily history for the specified date range
     #
@@ -41,9 +41,9 @@ module YahooStock
       @stock_symbol = options[:stock_symbol]
       @start_date   = options[:start_date]
       @end_date     = options[:end_date]
-      @interval     = options[:interval].nil? ? :daily : options[:interval].to_sym
+      @type     = options[:type].nil? ? :daily : options[:type].to_sym
       
-      validate_interval_values(options[:interval]) if options[:interval]
+      validate_type_values(options[:type]) if options[:type]
       validate_stock_symbol(options)
       validate_start_date(options)
       validate_end_date(options)
@@ -74,24 +74,24 @@ module YahooStock
       @end_date = end_date
     end
     
-    # Set interval to specify whether daily, weekly or monthly histroy required
-    def interval=(interval)
-      validate_interval_values(interval)
-      @interval = interval
+    # 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
-      frequency = case interval
-                    when :daily     then 'd'
-                    when :weekly    then 'w'
-                    when :monthly   then 'm'
-                    when :dividend  then 'v'
-                  end
+      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 => frequency, :ignore => '.csv'}
+                         :g => history_type, :ignore => '.csv'}
       super()  
     end
 
@@ -109,10 +109,10 @@ module YahooStock
     
     private
     
-    def validate_interval_values(interval_value=interval)
+    def validate_type_values(type_value=type)
       valid_values = [:daily, :weekly, :monthly, :dividend]
-      unless valid_values.include?(interval_value)
-        raise HistoryError, "Allowed values for interval are #{valid_values.join(', ')}"
+      unless valid_values.include?(type_value)
+        raise HistoryError, "Allowed values for type are #{valid_values.join(', ')}"
       end
     end
     
@@ -174,7 +174,7 @@ module YahooStock
     end
     
     def validate_keys(options)
-      valid_keys   = [:stock_symbol, :start_date, :end_date, :interval]
+      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?

data/spec/yahoo_stock/interface/history_spec.rb

@@ -84,33 +84,33 @@ describe YahooStock::Interface::History do
       
     end
     
-    it "should by default set interval to daily if no value provided for it" do
+    it "should by default set type to daily if no value provided for it" do
       @history = YahooStock::Interface::History.new(:stock_symbol => 'd', 
                                                     :start_date => Date.today-7, 
                                                     :end_date => Date.today-1)
-      @history.interval.should eql(:daily)
+      @history.type.should eql(:daily)
     end
     
     it "should raise invalid keys error when an invalid key is passed in the parameter" do
       lambda { YahooStock::Interface::History.new(:stock_symbol => 'd', 
                                                   :start_date => Date.today-7, 
-                                                  :end_date => Date.today-1, :boom => 1) }.should raise_error(YahooStock::Interface::History::HistoryError, "An invalid key 'boom' is passed in the parameters. Allowed keys are stock_symbol, start_date, end_date, interval")
+                                                  :end_date => Date.today-1, :boom => 1) }.should raise_error(YahooStock::Interface::History::HistoryError, "An invalid key 'boom' is passed in the parameters. Allowed keys are stock_symbol, start_date, end_date, type")
     end
     
-    it "should raise error when interval is neither :daily, :weekly, :monthly or :dividend" do
+    it "should raise error when type is neither :daily, :weekly, :monthly or :dividend" do
       lambda { YahooStock::Interface::History.new(:stock_symbol => 'd', 
                                                   :start_date => Date.today-7, 
                                                   :end_date => Date.today-1,
-                                                  :interval => :yearly)
-                                        }.should raise_error(YahooStock::Interface::History::HistoryError, "Allowed values for interval are daily, weekly, monthly, dividend")
+                                                  :type => :yearly)
+                                        }.should raise_error(YahooStock::Interface::History::HistoryError, "Allowed values for type are daily, weekly, monthly, dividend")
       
     end
     
-    it "should not raise error when interval is :daily" do
+    it "should not raise error when type is :daily" do
       lambda { YahooStock::Interface::History.new(:stock_symbol => 'd', 
                                                   :start_date => Date.today-7, 
                                                   :end_date => Date.today-1,
-                                                  :interval => :daily)
+                                                  :type => :daily)
                                         }.should_not raise_error
       
     end
@@ -170,17 +170,17 @@ describe YahooStock::Interface::History do
       @history.end_date.should eql(e_date)
     end
     
-    it "should raise error when settin interval other than :daily, :monthly or :weekly" do
-      lambda { @history.interval = :yearly }.should raise_error(YahooStock::Interface::History::HistoryError)
+    it "should raise error when settin type other than :daily, :monthly or :weekly" do
+      lambda { @history.type = :yearly }.should raise_error(YahooStock::Interface::History::HistoryError)
     end
     
-    it "should set the interval" do
-      @history.interval = :daily
-      @history.interval.should eql(:daily)
+    it "should set the type" do
+      @history.type = :daily
+      @history.type.should eql(:daily)
     end
     
-    it "should set the interval default to daily if not set" do
-      @history.interval.should eql(:daily)
+    it "should set the type default to daily if not set" do
+      @history.type.should eql(:daily)
     end
   end
   
@@ -191,8 +191,8 @@ describe YahooStock::Interface::History do
                                                     :end_date => Date.today-1)
     end
     
-    it "should get the interval to generate url" do
-      @history.should_receive(:interval)
+    it "should get the type to generate url" do
+      @history.should_receive(:type)
       @history.uri
     end
     
@@ -251,7 +251,7 @@ describe YahooStock::Interface::History do
       @history.uri.should =~ /c=#{@history.end_date.year}/
     end
     
-    it "should have parameter 'g' with interval" do
+    it "should have parameter 'g' with type" do
       @history.uri.should =~ /g=d/
     end
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nas-yahoo_stock
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 +00:00
+date: 2010-11-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency