edgar-stocks 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDMzODMwZGU3YTQxNDQ5MzIzZTRkYTg3YTEyNWVjOWViZTI0NGU4NQ==
+  data.tar.gz: !binary |-
+    MGEwODcyYTBkYjY1MTNkYTM4ZDllODk3NzhiZjBkZWNiNTJiN2ZlMw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTU5YmMzODE2OWVjZWI3N2YwYTE0ZjRkYWMwNzM5N2NjNzczMDdmOGQ5NzQz
+    MGQ4MmRjN2YyNDlkMjI1NmZhZDQzYjViMmY3YjYwYWI0MzM5ODRmMGJlMThl
+    NDI3NDIxZDNlODIxNzQyNmUzZDhjN2U4NWE1MDQ2OTVlMjA0Njc=
+  data.tar.gz: !binary |-
+    MDIxNDk0MjU3YjIzOGJlZGVkNTg0ZDQzYzI4OWNmNjUzOWUxYTI2NmM1YWRm
+    MDZkZjFmOWVhN2JhM2RlMzhjZTdiMWRmZmNjMDQ5NGQ3YTQwNmIxZWNmMTVh
+    NTM5ZDAwYjBiNTYzZDUxMjM1YWY1YTY3ZGM1NTBlNmZjYWYzNDA=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andy Schrage
+
+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,55 @@
+# Edgar-Stocks
+
+Edgar-Stocks is a Ruby gem that provides access to historical stock data in a simple, configurable way.
+
+Edgar provides the following info for a stock:
+- Opening price
+- Closing price
+- Daily high
+- Daily low
+- Adjusted close
+- Volume
+
+In addition to the above, Edgar can calculate the rolling average for a given date for a particular stock.
+
+Have more ideas how I can improve the gem?  Leave me a message!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'edgar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edgar
+
+## Usage
+
+Simply create a new Edgar object for each stock you care about:
+
+    stock = Edgar::Edgar.new('INTU')
+
+Then query it!
+
+    stock.closing_price # Returns today's closing price
+
+Or ask for a date in the past.
+
+    stock.closing_price(DateTime.yesterday)  # Obviously get yesterday's closing price
+
+You can even get running averages
+
+    stock.closing_price(DateTime.now, 5)  # Get the five day average closing price starting with today's closing.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/edgar.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'edgar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "edgar-stocks"
+  spec.version       = Edgar::VERSION
+  spec.authors       = ["Andy Schrage"]
+  spec.email         = ["ajschrag@mtu.edu"]
+  spec.description   = %q{Edgar-Stocks is a Ruby gem that provides access to historical stock data in a simple, configurable way.}
+  spec.summary       = %q{Stock data since the beginning of time!}
+  spec.homepage      = "https://github.com/Swimminschrage/edgar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/lib/edgar.rb

@@ -0,0 +1,116 @@
+require 'edgar/version'
+require 'net/http'
+require 'csv'
+require 'time'
+
+module Edgar
+
+  class Edgar
+    attr_reader :symbol
+
+    # Configuration defaults
+    @@config = {
+        :lookup_offset => -1,
+        :round_to => 2
+    }
+
+    @@valid_config_keys = @@config.keys
+
+    def self.configure(opts = {})
+      opts.each {|k,v| @@config[k.to_sym] = v if @@valid_config_keys.include? k.to_sym}
+    end
+
+    def self.config
+      @@config
+    end
+
+    def initialize(symbol)
+      @symbol = symbol
+
+      # Perform the actual lookup of historical data and parse it into arrays that
+      # are cached in memory
+      @data = CSV.parse(lookup)
+    end
+
+    def closing_price(date = DateTime.now, running = 1)
+      lookup_by_column(running, date, 4)
+    end
+
+    def opening_price(date = DateTime.now, running = 1)
+      lookup_by_column(running, date, 1)
+    end
+
+    def high_price(date = DateTime.now, running = 1)
+      lookup_by_column(running, date, 2)
+    end
+
+    def low_price(date = DateTime.now, running = 1)
+      lookup_by_column(running, date, 3)
+    end
+
+    def volume(date = DateTime.now, running = 1)
+      lookup_by_column(running, date, 5)
+    end
+
+    private
+
+    def lookup
+      @content ||= get_historical_data
+    end
+
+    def get_historical_data
+      uri = URI("http://ichart.finance.yahoo.com/table.csv?s=#{@symbol}")
+      response = Net::HTTP.get_response(uri)
+
+      raise InvalidSymbolError.new("Unable to lookup '#{symbol}'") unless response.code == "200"
+      response.body
+    end
+
+    def lookup_by_column(running, date, column)
+      return nil if date > DateTime.now()
+
+      running = 1 if running < 1
+
+      formatted_date = date.strftime('%Y-%m-%d')
+
+      @data[1..@data.size].each_index do |index|
+        row = @data[index+1]
+
+        return sum_and_average(index+1, running, column) if row[0] == formatted_date
+
+        if DateTime.parse(row[0]) < date
+          if Edgar.config[:lookup_offset] < 0
+            return sum_and_average(index+1, running, column)
+          else
+            return sum_and_average(index, running, column)
+          end
+        end
+
+      end
+      return nil
+    end
+
+    def sum_and_average(start, days, column)
+      total = @data[start, days].inject(0) do |sum, row|
+        sum + row[column.to_i].to_f
+      end
+
+      # Round off to at most two digits
+      round_to = Edgar.config[:round_to]
+      round_to = 2 if round_to < 0
+
+      denom = @data[start, days].size
+      (total / denom).round(round_to)
+    end
+  end
+
+  class InvalidSymbolError < ArgumentError
+    def initialize(message)
+      @message = message
+    end
+
+    def to_s
+      @message
+    end
+  end
+end

data/lib/edgar/version.rb

@@ -0,0 +1,3 @@
+module Edgar
+  VERSION = "1.0.0"
+end

data/spec/edgar_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require_relative '../lib/edgar'
+
+describe 'Edgar' do
+  let(:stock) {Edgar::Edgar.new('INTU')}
+  let(:firstday) {DateTime.new(2013,10,1)}
+  let(:weekend_day) {DateTime.new(2013,9,21)}
+  let(:future_day) {DateTime.new(2020,1,1)}
+  subject {stock}
+
+  it 'should have a reference to the symbol' do
+    expect(stock.symbol).to eq('INTU')
+  end
+
+  it 'should be able to lookup valid stock symbols' do
+    expect{Edgar::Edgar.new('INTU')}.to_not raise_error Edgar::InvalidSymbolError
+  end
+
+  it 'should not be able to lookup invalid stock symbols' do
+    expect{Edgar::Edgar.new('LALALALALA')}.to raise_error(Edgar::InvalidSymbolError)
+  end
+
+  it 'can get closing price for October 1, 2013' do
+    expect(stock.closing_price(firstday)).to eq(66.45)
+  end
+
+  it 'can get the opening price for October 1, 2013' do
+    expect(stock.opening_price(firstday)).to eq(66.53)
+  end
+
+  it 'can get the high price for October 1, 2013' do
+    expect(stock.high_price(firstday)).to eq(67.09)
+  end
+
+  it 'can get the low price for a stock' do
+    expect(stock.low_price(firstday)).to eq(66.19)
+  end
+
+  it 'can get the volume traded for a stock' do
+    expect(stock.volume(firstday)).to eq(2095700)
+  end
+
+  describe 'when configured to look to the next day' do
+    before (:all) do
+      Edgar::Edgar.configure({:lookup_offset => 1})
+    end
+
+    it 'should go to monday when a weekend date is specified' do
+      expect(stock.opening_price(weekend_day)).to eq(66.59)
+    end
+  end
+
+  describe 'when configured to look to the prev day' do
+    before (:all) do
+      Edgar::Edgar.configure({:lookup_offset => -1})
+    end
+
+    it 'should go to friday when a weekend date is specified' do
+      expect(stock.opening_price(weekend_day)).to eq(66.64)
+    end
+  end
+
+  describe 'when a future date is provided' do
+    let(:future_day) {DateTime.new(2020,1,1)}
+    it 'should return nil' do
+      expect(stock.opening_price(future_day)).to be_nil
+    end
+  end
+
+  describe 'when an old date is provided' do
+    let(:past_day) {DateTime.new(1919,1,1)}
+    it 'should return nil' do
+      expect(stock.opening_price(past_day)).to be_nil
+    end
+
+    it 'should return the average using any valid dates when all are valid' do
+      expect(stock.opening_price(DateTime.new(1993, 3, 23), 2)).to eq(29.50)
+    end
+
+    it 'should return the average using any valid dates when some are invalid' do
+      expect(stock.opening_price(DateTime.new(1993, 3, 23), 6)).to eq(29.50)
+    end
+  end
+
+  describe 'when providing a range' do
+    let(:firstday) {DateTime.new(2013, 9, 27)}
+    it 'should return the running avg for opening price' do
+      expect(stock.opening_price(firstday, 10)).to eq(66.28)
+    end
+
+    describe 'and rounding to 4 decimal points' do
+      it 'should return the running avg to 4 decimal points' do
+        Edgar::Edgar.configure({:round_to => 4})
+        expect(stock.opening_price(firstday, 10)).to eq(66.278)
+      end
+
+      it 'should return the running avg to 0 decimal points' do
+        Edgar::Edgar.configure({:round_to => 0})
+        expect(stock.opening_price(firstday, 10)).to eq(66)
+      end
+
+      it 'should return the running avg to 3 decimal points' do
+        Edgar::Edgar.configure({:round_to => 3})
+        expect(stock.opening_price(firstday, 10)).to eq(66.278)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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
+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: edgar-stocks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Schrage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Edgar-Stocks is a Ruby gem that provides access to historical stock data
+  in a simple, configurable way.
+email:
+- ajschrag@mtu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- edgar.gemspec
+- lib/edgar.rb
+- lib/edgar/version.rb
+- spec/edgar_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Swimminschrage/edgar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.8
+signing_key: 
+specification_version: 4
+summary: Stock data since the beginning of time!
+test_files:
+- spec/edgar_spec.rb
+- spec/spec_helper.rb