securities 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby
+  - rbx
+script: "bundle exec rake"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in securities.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nedomas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Securities
+
+[![Build Status](https://secure.travis-ci.org/Nedomas/securities.png)](http://travis-ci.org/Nedomas/securities)
+
+Financial information scraper gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'securities'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install securities
+
+## Usage
+
+You can get stock information with commands:
+
+	my_stocks = Securities::Stock.new('aapl', 'yhoo').history(:start_date => '2012-01-01', :end_date => '2012-02-01', :periods => :weekly)
+	Optional parameter :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"]
+
+Results are returned in a hash:
+
+	{"aapl"=>[{:date=>"2012-01-04", :open=>"410.00", :high=>"414.68", :low=>"409.28", :close=>"413.44", :volume=>"9286500", :adj_close=>"411.67"}, {:date=>"2012-01-03", :open=>"409.40", :high=>"412.50", :low=>"409.00", :close=>"411.23", :volume=>"10793600", :adj_close=>"409.47"}], 
+	"yhoo"=>[{:date=>"2012-01-04", :open=>"16.12", :high=>"16.16", :low=>"15.74", :close=>"15.78", :volume=>"35655300", :adj_close=>"15.78"}, {:date=>"2012-01-03", :open=>"16.27", :high=>"16.39", :low=>"16.20", :close=>"16.29", :volume=>"19708600", :adj_close=>"16.29"}]}
+
+## 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
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/lib/securities/scraper.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext'
+require 'uri'
+require 'net/http'
+require 'csv'
+
+module Securities
+  #
+  # Main class to communicate with Yahoo! Finance
+  #
+	class Scraper
+
+    attr_reader :results
+    # Error handling
+    class ScraperException < StandardError
+    end
+
+    def initialize type, parameters
+      @results = Hash.new
+
+      # Manage different type requests.
+      case type
+        when :history then @results = scrape_history(parameters)
+        else raise ScraperException, 'Cannot determine request type.'
+      end
+    end
+
+    def scrape_history parameters
+      parameters.each do |symbol, url|
+
+        uri = URI.parse(url)
+
+        # Check connection
+        begin
+          get = Net::HTTP.get(uri)
+        rescue => error
+          raise ScraperException, "Connection error: #{error.message}"
+        end
+
+        # Skip first line because it contains headers with Date,Open,High,Low,Close,Volume,Adj Close
+        csv = CSV.parse(get, :headers => true)
+
+        data = Array.new
+        csv.each_with_index {|row, index|
+          data[index] = {:date => row[0], :open => row[1], :high => row[2], :low => row[3], :close => row[4], :volume => row[5], :adj_close => row[6]}
+        }
+        @results[symbol] = data 
+      end
+      return @results
+    end
+
+	end
+end

data/lib/securities/stock.rb

@@ -0,0 +1,147 @@
+module Securities
+
+	# Usage: my_stocks = Securities::Stock.new('aapl', 'yhoo').history(:start_date => '2012-01-01', :end_date => '2012-02-01', :periods => :weekly)
+	# :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"]
+
+	class Stock
+
+		attr_reader :symbols
+		# 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, :montly, :dividends]
+
+		# Error handling
+		class StockException < StandardError
+		end
+
+		def initialize *parameters
+			validate_symbols(parameters)
+		end
+
+		def history parameters
+			type = :history
+			parameters[:symbols] = @symbols
+			validate_history(parameters)
+			urls = generate_history_url(parameters)
+			Securities::Scraper.new(type, urls)
+		end
+
+		private
+
+		# History URL generator
+		#
+		# Generating URL for various types of requests within stocks.
+		#
+		# Using Yahoo Finance
+		# http://ichart.finance.yahoo.com/table.csv?s=%s&a=%s&b=%s&c=%s&d=%s&e=%s&f=%s&g=%s&ignore=.csv
+		# 
+		# s = ticker symbol.
+		#
+		# Start date
+		# a = start_month
+		# b = start_day
+		# c = start_year
+		#
+		# End date
+		# d = end_month
+		# e = end_day
+		# f = end_year
+		#
+		# g = :periods 
+		# Possible values are 'd' for daily (the default), 'w' for weekly, 'm' for monthly and 'v' for dividends.
+
+		def generate_history_url parameters
+
+			start_date = parameters[:start_date].to_date
+			end_date = parameters[:end_date].to_date
+
+			periods = case parameters[:periods]
+									when :daily 		then 'd'
+									when :weekly 		then 'w'
+									when :monthly 	then 'm'
+									when :dividends then 'v'
+								 end
+
+			results = Hash.new
+			@symbols.each do |symbol|
+				url = 'http://ichart.finance.yahoo.com/table.csv?s=%s&a=%s&b=%s&c=%s&d=%s&e=%s&f=%s&g=%s&ignore=.csv' % [
+					symbol,
+					start_date.month - 1,
+					start_date.day,
+					start_date.year,
+					end_date.month - 1,
+					end_date.day,
+					end_date.year,
+					periods
+				]
+				results[symbol] = url
+			end
+
+			# Returns a hash {'symbol' => 'url'}
+			return results
+		end
+
+		#
+		# Input parameters validation
+		#
+		def validate_symbols parameters
+			# Reject empty symbol hashes.
+			@symbols = parameters.reject(&:empty?)
+
+			unless !@symbols.empty?
+				raise StockException, 'You must specify stock symbols.'
+			end
+
+			unless @symbols.uniq.length == @symbols.length
+				raise StockException, 'Duplicate symbols given.'
+			end
+		end
+
+		def validate_history parameters
+			unless parameters.is_a?(Hash)
+				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.'
+			end
+ 
+			unless DATE_REGEX.match(parameters[:start_date])
+				raise StockException, 'Invalid :start_date specified. Format YYYY-MM-DD.'
+			end
+
+			unless DATE_REGEX.match(parameters[:end_date])
+				raise StockException, 'Invalid :end_date specified. Format YYYY-MM-DD.'
+			end
+
+			unless parameters[:start_date].to_date < parameters[:end_date].to_date
+				raise StockException, ':end_date must be greater than the :start_date.'
+			end
+
+			unless parameters[:start_date].to_date < Date.today
+				raise StockException, ':start_date must not be in the future.'
+			end
+
+			# Set to default :periods if key isn't specified.
+			parameters[:periods] = :daily if !parameters.has_key?(:periods)
+
+			unless PERIODS_ARRAY.include?(parameters[:periods])
+				raise StockException, 'Invalid :periods value specified.'
+			end
+		end
+
+	end
+end
+
+#
+# The missing hash function
+# Returns true if all keys are present in hash.
+#
+class Hash
+	def has_keys?(*_keys)
+  	(_keys - self.keys).empty?
+	end
+end

data/lib/securities/version.rb

@@ -0,0 +1,3 @@
+module Securities
+  VERSION = "0.0.1"
+end

data/lib/securities.rb

@@ -0,0 +1,6 @@
+require "securities/version"
+require "securities/scraper"
+require "securities/stock"
+
+module Securities
+end

data/securities.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/securities/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nedomas"]
+  gem.email         = ["domas.bitvinskas@me.com"]
+  gem.description   = %q{Financial information scraper and a technical analysis tool.}
+  gem.summary       = %q{Financial information scraper and a technical analysis tool.}
+  gem.homepage      = "https://github.com/Nedomas/securities"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "securities"
+  gem.require_paths = ["lib"]
+  gem.version       = Securities::VERSION
+
+  gem.add_dependency 'rails'
+  gem.add_development_dependency 'rspec'
+end

data/spec/securities_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'securities'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: securities
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nedomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Financial information scraper and a technical analysis tool.
+email:
+- domas.bitvinskas@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/securities.rb
+- lib/securities/scraper.rb
+- lib/securities/stock.rb
+- lib/securities/version.rb
+- securities.gemspec
+- spec/securities_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Nedomas/securities
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -407219618759612130
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -407219618759612130
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Financial information scraper and a technical analysis tool.
+test_files:
+- spec/securities_spec.rb
+- spec/spec_helper.rb