nas-yahoo_stock 1.0.5 → 1.0.6

data/History.txt

@@ -36,7 +36,7 @@
 === 1.0.1 2009-09-10
 
 * 1 addition:
-  * adds feature to retreive historical stock data
+  * adds feature to retrieve historical stock data
 
 === 1.0.2 2009-10-04
 Major changes in the public API. Check the README.rdoc file and individual classes for more information
@@ -78,4 +78,13 @@ Major changes in the public API. Check the README.rdoc file and individual class
 === 1.0.5 2010-05-07
 
 * 1 change:
-  * made the case statement in YahooStock::Interface::History on line 86 ruby 1.9.1 compatible
+  * made the case statement in YahooStock::Interface::History on line 86 ruby 1.9.1 compatible
+
+=== 1.0.6 2010-11-13
+
+* 2 addition:
+  * adds dividend query option by Ryan Sandridge
+  * adds cucumber rake task
+
+* 1 changes:
+  * Make sure all tests are run with rspec 2.1.0

data/README.rdoc

@@ -6,8 +6,8 @@
 
 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 any thing that yahoo finance provides.
 
-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 to be passed can be found after initializing the 
+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 to be passed can be found after initializing the
 YahooStock::Quote object and passing valid_parameters message to the quote object, example is given below in the USAGE section.
 
 For details : http://nasir.wordpress.com/2009/10/28/ruby-gem-for-finance-data
@@ -22,108 +22,82 @@ For details : http://nasir.wordpress.com/2009/10/28/ruby-gem-for-finance-data
 
 == USAGE:
 
-require 'rubygems'
+	require 'rubygems'
+	require 'yahoo_stock'
 
-require 'yahoo_stock'
+* Initialize quote object:
 
-* Initialize quote object
+	quote = YahooStock::Quote.new(:stock_symbols => ['YHOO', 'GOOG'])
 
-quote = YahooStock::Quote.new(:stock_symbols => ['YHOO', 'GOOG'])
+* To view the valid parameters that can be passed:
 
-* To view the valid parameters that can be passed
+	quote.valid_parameters
 
-quote.valid_parameters
+* To view the current parameters used:
 
-* To view the current parameters used
+	quote.current_parameters
 
-quote.current_parameters
+* To view the current stock symbols used:
 
-* To view the current stock symbols used
+	quote.current_symbols
 
-quote.current_symbols
+* To add more stocks to the list:
 
-* To add more stocks to the list
+	quote.add_symbols('MSFT', 'AAPL')
 
-quote.add_symbols('MSFT', 'AAPL')
+* To remove stocks from list:
 
-* To remove stocks from list
+	quote.remove_symbols('MSFT', 'AAPL')
 
-quote.remove_symbols('MSFT', 'AAPL')
+* To find data for all stocks, this will give a string containing all values:
 
-* To find data for all stocks, this will give a string containing all values
+	quote.results.output
 
-quote.results
-
-	to return an array instead of a string use:
+* To return an array instead of a string use:
 
 	quote.results(:to_array).output
-	
-	to return a hash, use:
-	
+
+* To return a hash, use:
+
 	quote.results(:to_hash).output
-	
-	to return xml, use:
-	
+
+* To return xml, use:
+
 	quote.results(:to_xml).output
-	
-	to store results in a file, use:
-	
+
+* to store results in a file, use:
+
 	quote.results.store('filename')
 
-* To find out the stock symbol for a company
-  
-symbol = YahooStock::ScripSymbol.new('Yahoo')
+* To find out the stock symbol for a company:
 
-* To find all symbols for that company, this will give a string containing all values
+	symbol = YahooStock::ScripSymbol.new('Yahoo')
 
-symbol.results
+* To find all symbols for that company, this will give a string containing all values:
 
-	to return an array instead of a string use:
+	symbol.results.output
+
+* Similarly to YahooStock::Quote, results can be converted to an array, a hash, xml, or stored in a file:
 
 	symbol.results(:to_array).output
-	
-	to return a hash, use:
-	
 	symbol.results(:to_hash).output
-	
-	to return xml, use:
-	
-	quote.results(:to_xml).output
-	
-	to store results in a file, use:
-	
+	symbol.results(:to_xml).output
 	symbol.results.store('filename')
 
-* To find symbols for multiple companies
+* To find symbols for multiple companies:
 
-symbols = YahooStock::ScripSymbol.results('Yahoo', 'Company1', 'Company3')
+	symbols = YahooStock::ScripSymbol.results('Yahoo', 'Company1', 'Company3')
 
-* to get the result in a string
+* To find historical data for a stock:
 
-symbols.output
+	history = YahooStock::History.new(:stock_symbol => 'yhoo', :start_date => Date.today-20, :end_date => Date.today -2)
 
-* to store output in a file
-
-symbols.store('filename')
-
-* To find historical data for a stock
-
-  history = YahooStock::History.new(:stock_symbols => 'yhoo', :start_date => Date.today-20, end_date => Date.today -2)
-  
-  	to return an array instead of a string use:
+* As with regular quotes and symbol lookups, the results can be returned in various formats:
 
+	history.results.output
 	history.results(:to_array).output
-	
-	to return a hash, use:
-	
-	to return xml, use:
-	
-	quote.results(:to_xml).output
-	
 	history.results(:to_hash).output
-	
-	to store results in a file, use:
-	
+	history.results(:to_xml).output
 	history.results.store('filename')
 
 ==Docs
@@ -132,9 +106,16 @@ http://rdoc.info/projects/nas/yahoo_stock
 
 == TESTS:
 
-Tests are written using Rspec 1.2.2
+To run all tests 'rspec spec' from the root directory. It requires rspec >= 2.1.0
+
+To run cucumber features "rake cucumber". It requires cucumber >= 0.9.4
+
+Cucumber Test html output is logged in log/features.html
+
+==Thanks
+
+* Thanks to {Ryan Sandridge}[http://github.com/dissolved] for adding the dividend query option.
 
-To run all tests 'rake spec' from the root directory
 
 == LICENSE:
 

data/Rakefile

@@ -1,22 +1,12 @@
 require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/yahoo_stock'
 
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
+require 'cucumber'
+require 'cucumber/rake/task'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'yahoo_stock' do
-  self.developer 'Nasir Jamal', 'nas35_in@yahoo.com'
+desc 'Run Cucumber features and generate an HTML summary'
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = ["--no-color",
+                     "--format html -o log/features.html",
+                     "--format progress"]
 end
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]

data/lib/yahoo_stock/interface/history.rb

@@ -28,7 +28,7 @@ module YahooStock
     # :stock_symbol => 'goog', :start_date => Date.today-30,
     # :end_date => Date.today-10, :interval => :weekly
     #
-    # The interval option accepts :daily, :monthly and :weekly values
+    # The interval option accepts :daily, :monthly, :weekly and :dividend values
     #
     # The interval key is optional, if not used then by default uses :daily
     #
@@ -83,9 +83,10 @@ module YahooStock
     # 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 :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),
@@ -109,7 +110,7 @@ module YahooStock
     private
     
     def validate_interval_values(interval_value=interval)
-      valid_values = [:daily, :weekly, :monthly]
+      valid_values = [:daily, :weekly, :monthly, :dividend]
       unless valid_values.include?(interval_value)
         raise HistoryError, "Allowed values for interval are #{valid_values.join(', ')}"
       end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 $: << File.join(File.dirname(__FILE__), "/../lib") 
-require 'spec' 
+
+require 'rspec'
 require 'yahoo_stock'

data/spec/yahoo_stock/interface/history_spec.rb

@@ -97,12 +97,12 @@ describe YahooStock::Interface::History do
                                                   :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
     
-    it "should raise error when interval is neither :daily, :weekly or :monthly" do
+    it "should raise error when interval 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")
+                                        }.should raise_error(YahooStock::Interface::History::HistoryError, "Allowed values for interval are daily, weekly, monthly, dividend")
       
     end
     

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nas-yahoo_stock
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 1
   - 0
-  - 5
-  version: 1.0.5
+  - 6
+  version: 1.0.6
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 +01:00
+date: 2010-11-13 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 1
@@ -57,6 +60,25 @@ files:
 - lib/yahoo_stock/result/hash_format.rb
 - lib/yahoo_stock/result/xml_format.rb
 - lib/yahoo_stock/scrip_symbol.rb
+- spec/spec_helper.rb
+- spec/yahoo_stock/base_spec.rb
+- spec/yahoo_stock/history_spec.rb
+- spec/yahoo_stock/interface_spec.rb
+- spec/yahoo_stock/interface/history_spec.rb
+- spec/yahoo_stock/interface/quote_spec.rb
+- spec/yahoo_stock/interface/scrip_symbol_spec.rb
+- spec/yahoo_stock/quote_spec.rb
+- spec/yahoo_stock/result_spec.rb
+- spec/yahoo_stock/result/array_format_spec.rb
+- spec/yahoo_stock/result/hash_format_spec.rb
+- spec/yahoo_stock/result/xml_format_spec.rb
+- spec/yahoo_stock/scrip_symbol_spec.rb
+- features/history.feature
+- features/quotes.feature
+- features/script_symbol.feature
+- features/step_definitions/history_steps.rb
+- features/step_definitions/quotes_steps.rb
+- features/step_definitions/script_symbol_steps.rb
 has_rdoc: true
 homepage: http://github.com/nas/yahoo_stock
 licenses: []
@@ -67,24 +89,28 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 31
       segments: 
       - 1
       - 8
       version: "1.8"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: Yahoo Stock is a Ruby library for extracting information about stocks from yahoo finance.