securities 0.1.2 → 1.0.0

data/README.md

@@ -1,7 +1,7 @@
 # Securities
 
 Financial information scraper gem. 
-Uses Yahoo Finance API. Current functionality demo: http://strangemuseum.heroku.com
+Uses Yahoo Finance API. Current functionality demo of this gem, working in synergy with gem ta: http://strangemuseum.heroku.com
 
 [![Build Status](https://secure.travis-ci.org/Nedomas/securities.png)](http://travis-ci.org/Nedomas/securities)[![Build Status](https://gemnasium.com/Nedomas/securities.png)](https://gemnasium.com/Nedomas/securities)
 
@@ -35,11 +35,15 @@ You can get stock information with commands:
 	
 	Optional parameter :periods accepts :daily, :weekly, :monthly, :dividend. If not specified, it defaults to :daily.
 
+	:end_date defaults to Date.today if not specified.
+
 You can access hash for a single stock with:
 
-	my_data.results["yhoo"]
+	my_data["yhoo"]
+
+	or my_stocks.output["yhoo"]
 
-Results are returned in a hash:
+Output is returned in a hash:
 
 	{"aapl"=>
 		[{:date=>"2012-01-04",
@@ -72,18 +76,31 @@ Results are returned in a hash:
 		:volume=>"19708600", 
 		:adj_close=>"16.29"}]}
 
-## To do:
+# Version 1.0.0
+
+Results are returned in a reversed manner from 0.1.2. Array begins from the oldest data points.
+
+Only Stock class initializes an object so you can do:
 
-* Fix monthly+ and dividends+
-* Fix exception messages for friendlier displaying to end-user+ (and invalid symbol error=>"Illegal quoting in line 1.")+.
-* Rescue empty results error.+
-* BUG: Let it raise exception on one symbol, but continue on other and send the message. <= Now it just returns an empty array if the exception wasn't fatal.+
+	my_stocks = Securities::Stock.new(["aapl", "yhoo"]) 
+	my_stocks.history(:start_date => '2012-01-01', :end_date => '2012-02-01', :periods => :weekly) 
+	^ adds @ouput variable to the my_stocks object. ^
+
+	And get output with:
+	my_stocks.output or my_stocks.output["aapl"]
+
+	Given symbols, dates and periods with:
+	my_stocks.symbols
+	my_stocks.start_date
+	my_stocks.end_date
+	my_stocks.periods
+
+## To do:
 
 * Write specs.
 * Add quote info (P/E, P/S, etc.)
 * Add symbol from name lookup.
 * Add options support.
-* Add technical analysis module (or a seperate gem which works in synergy with this).
 
 ## Contributing
 

data/lib/securities/scraper.rb

@@ -9,22 +9,23 @@ module Securities
   #
 	class Scraper
 
-    attr_reader :results
     # Error handling
     class ScraperException < StandardError
     end
 
-    def initialize type, parameters
-      @results = Hash.new
+    def self.get type, parameters
 
       # Manage different type requests.
       case type
-        when :history then @results = scrape_history(parameters)
+        when :history then results = scrape_history(parameters)
         else raise ScraperException, 'Cannot determine request type.'
       end
+
+      return results
     end
 
-    def scrape_history parameters
+    def self.scrape_history parameters
+      results = Hash.new
       parameters.each do |symbol, url|
 
         uri = URI.parse(url)
@@ -42,11 +43,10 @@ module Securities
           csv = CSV.parse(get, :headers => true)
         rescue => error
           # PROBABLY an invalid symbol specified or there was some other way the parser couldn't read a CSV.
-          # FIXME: Let it raise exception on one symbol, but continue on other and send the message.
           # It will no longer raise exception because it causes a bug.
           # bug => if exception occurs in one symbol, it will not give any results for any other.
           # raise ScraperException, "Invalid symbol '#{symbol}' specified."
-          @results[symbol] = []
+          results[symbol] = []
           next
         end
 
@@ -60,16 +60,15 @@ module Securities
           end
         end
 
-        # FIXME: Let it raise exception on one symbol, but continue on other and send the message.
         # It will no longer raise exception if data is empty, because it causes a 
         # bug => if exception occurs in one symbol, it will not give any results for any other.
         # if data.empty?
         #     raise ScraperException, "There were no results for #{symbol}."
         # end
 
-        @results[symbol] = data 
+        results[symbol] = data.reverse
       end
-      return @results
+      return results
     end
 
 	end

data/lib/securities/stock.rb

@@ -4,11 +4,11 @@ module Securities
 	# :periods accepts :daily, :weekly, :monthly, :dividend. If not specified, it defaults to :daily.
 	#
 	# You can access hash for a single stock with:
-	# my_stocks.results["yhoo"]
+	# my_stocks["yhoo"]
 
 	class Stock
 
-		attr_reader :symbols
+		attr_accessor :symbols, :output, :start_date, :end_date, :periods
 		# REGEX for YYYY-MM-DD
 		DATE_REGEX = /^[0-9]{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])/
 		PERIODS_ARRAY = [:daily, :weekly, :monthly, :dividends]
@@ -26,11 +26,15 @@ module Securities
 			parameters[:symbols] = @symbols
 			validate_history(parameters)
 			urls = generate_history_url(parameters)
-			Securities::Scraper.new(type, urls)
+			@start_date = parameters[:start_date]
+			@end_date = parameters[:end_date]
+			@periods = parameters[:periods]
+			@output = Securities::Scraper.get(type, urls)
 		end
 
 		private
 
+		#
 		# History URL generator
 		#
 		# Generating URL for various types of requests within stocks.
@@ -92,7 +96,7 @@ module Securities
 			# Reject empty symbol hashes.
 			@symbols = parameters.reject(&:empty?)
 
-			unless !@symbols.empty?
+			if @symbols.nil?
 				raise StockException, 'You must specify at least one stock symbol.'
 			end
 
@@ -110,10 +114,14 @@ module Securities
 				raise StockException, 'Given parameters have to be a hash.'
 			end
 
-			unless parameters.has_keys?(:start_date, :end_date)
-				raise StockException, 'You must specify start date and end date.'
+			unless parameters.has_key?(:end_date)
+				parameters[:end_date] = Date.today.strftime("%Y-%m-%d")
+			end
+
+			unless parameters.has_key?(:start_date)
+				raise StockException, 'Start date must be specified.'
 			end
- 
+ 			
 			unless DATE_REGEX.match(parameters[:start_date])
 				raise StockException, 'Invalid start date specified. Format YYYY-MM-DD.'
 			end

data/lib/securities/version.rb

@@ -1,3 +1,3 @@
 module Securities
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

data/spec/stock_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Securities::Stock do
+	describe ".new" do
+    
+    it "should raise error when no parameter is passed" do
+      expect { Securities::Stock.new }.should raise_error
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: securities
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,8 +62,8 @@ files:
 - lib/securities/stock.rb
 - lib/securities/version.rb
 - securities.gemspec
-- spec/securities_spec.rb
 - spec/spec_helper.rb
+- spec/stock_spec.rb
 homepage: https://github.com/Nedomas/securities
 licenses: []
 post_install_message: 
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 254096546998731436
+      hash: -3860670281301913454
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 254096546998731436
+      hash: -3860670281301913454
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -95,5 +95,5 @@ signing_key:
 specification_version: 3
 summary: Financial information scraper gem. Uses Yahoo Finance API.
 test_files:
-- spec/securities_spec.rb
 - spec/spec_helper.rb
+- spec/stock_spec.rb

data/spec/securities_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe Securities do
-  it 'requires tests'
-end