stock_history 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33f1883ebe03f8b4244524165005fc7ed9ed6dd3
+  data.tar.gz: 80d10469b2ff68994aeb066c1874b94ac484f387
+SHA512:
+  metadata.gz: fb009d779cd6af8c08802f0701a6798c887a3b54a5c61633765c366485756646874f6bd11536b1766bce749a8df84bb905432b5c1471eac384e669903cba23f0
+  data.tar.gz: d7633961a3df96182f7cd22583a29dffe0c574f0d6e36b7bd3fdcdac59d23ad6243594d31339e996c96816cac21a9c8f54ece709dfe54625e1dff8e5779b1c03

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at unieagle@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 uniEagle
+
+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,53 @@
+# StockHistory
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stock_history`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stock_history'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stock_history
+
+## Usage
+
+Daily history with splits:
+
+```ruby
+StockHistory.history('DRYS',  :start_date => '2017-01-20', :stop_date => '2017-01-25')
+# => [{:date=>"20170125", :date_parsed=>#<Date: 2017-01-25 ((2457779j,0s,0n),+0s,2299161j)>, :open=>4.48, :high=>4.74, :low=>3.98, :close=>4.0, :volume=>12492400.0, :adjusted_close=>4.0, :split=>nil, :merge=>nil, :dividend=>nil}, {:date=>"20170124", :date_parsed=>#<Date: 2017-01-24 ((2457778j,0s,0n),+0s,2299161j)>, :open=>5.56, :high=>5.6, :low=>4.42, :close=>4.48, :volume=>20733100.0, :adjusted_close=>4.48, :split=>nil, :merge=>nil, :dividend=>nil}, {:date=>"20170123", :date_parsed=>#<Date: 2017-01-23 ((2457777j,0s,0n),+0s,2299161j)>, :open=>7.5, :high=>7.65, :low=>5.25, :close=>5.4, :volume=>13820800.0, :adjusted_close=>5.4, :split=>1.0, :merge=>8.0, :dividend=>nil}, {:date=>"20170120", :date_parsed=>#<Date: 2017-01-20 ((2457774j,0s,0n),+0s,2299161j)>, :open=>1.04, :high=>1.13, :low=>0.99, :close=>1.01, :volume=>6841800.0, :adjusted_close=>8.08, :split=>nil, :merge=>nil, :dividend=>nil}] 
+```
+
+Daily history with dividend:
+
+```ruby
+StockHistory.history('GDXJ',  :start_date => '2016-12-18', :stop_date => '2016-12-21')
+# => [{:date=>"20161221", :date_parsed=>#<Date: 2016-12-21 ((2457744j,0s,0n),+0s,2299161j)>, :open=>28.62, :high=>28.75, :low=>28.13, :close=>28.18, :volume=>11546800.0, :adjusted_close=>28.18, :split=>nil, :merge=>nil, :dividend=>nil}, {:date=>"20161220", :date_parsed=>#<Date: 2016-12-20 ((2457743j,0s,0n),+0s,2299161j)>, :open=>27.71, :high=>28.63, :low=>27.37, :close=>28.51, :volume=>23996800.0, :adjusted_close=>28.51, :split=>nil, :merge=>nil, :dividend=>nil}, {:date=>"20161219", :date_parsed=>#<Date: 2016-12-19 ((2457742j,0s,0n),+0s,2299161j)>, :open=>28.89, :high=>28.92, :low=>28.12, :close=>28.43, :volume=>27938700.0, :adjusted_close=>28.43, :split=>nil, :merge=>nil, :dividend=>1.51}, {:date=>"20161216", :date_parsed=>#<Date: 2016-12-16 ((2457739j,0s,0n),+0s,2299161j)>, :open=>30.81, :high=>31.18, :low=>29.53, :close=>29.86, :volume=>23705400.0, :adjusted_close=>28.35, :split=>nil, :merge=>nil, :dividend=>nil}] 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stock_history. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stock_history"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/stock_history.rb

@@ -0,0 +1,138 @@
+require "stock_history/version"
+require 'net/http'
+require 'json'
+require 'date'
+require 'stock_history/utility.rb'
+require 'stock_history/exceptions.rb'
+include StockHistory::Utility
+
+module StockHistory
+
+  # Get daily history for a symbol
+  # Available params:
+  # :start_date => '2016-01-01'
+  # :end_date => Date.today.to_s
+  # :freq => 'd', 'w' or 'm'
+  def self.history(symbol, params={})
+    his_params = {}
+    his_params[:start_date] = to_date(params[:start_date])
+    his_params[:stop_date] = to_date(params[:stop_date])
+    his_params[:freq] = (%w(d w m).include?(params[:freq]) ? params[:freq] : 'd')
+
+    url = build_url(symbol, his_params)
+    uri = URI(url)
+    response = Net::HTTP.get(uri)
+    parse_response(response)
+  end
+
+  private
+  def self.parse_response(response)
+    results = []
+    lines = response.split("\n")
+
+    if lines.count <= 5
+      raise ParseException.new("Response format not correct")      
+    end
+
+    # Date,Open,High,Low,Close,Volume,Adj Close
+    if lines[0] != "Date,Open,High,Low,Close,Volume,Adj Close"
+      raise ParseException.new("Header not correct")
+    end
+
+    if lines[-1] != "STATUS, 0"
+      raise ParseException.new("Status not correct")
+    end
+
+    # TOTALSIZE, 24
+    total_size = 0
+    unless lines[-2].start_with?("TOTALSIZE")
+      raise ParseException.new("Size not parsed out")
+    else
+      total_size = lines[-2].split(',').last.to_i
+    end
+
+    # STARTDATE, 20161230
+    # ENDDATE, 20170203
+    start_date = nil
+    end_date = nil
+    unless lines[-3].start_with?("ENDDATE") or lines[-4].start_with?("STARTDATE")
+      raise ParseException.new("Dates not parsed out")
+    else
+      start_date = lines[-4].split(',').last.strip
+      end_date = lines[-3].split(',').last.strip
+    end
+
+    dividends = {}
+    splits = {}
+
+    lines[1..-5].each do |line|
+      # puts line
+
+      elements = line.split(",").map(&:strip)
+      if elements.first == 'SPLIT'
+        # this is reverse split (merge), and will apear above the daily history on that day
+        # SPLIT, 20170123,1:8
+        rates = elements.last.split(':').map(&:to_f)
+        splits[elements[1]] = {
+          :date => elements[1],
+          :split => rates[0] < rates[1] ? 1.0 : rates[0] / rates[1],
+          :merge => rates[0] < rates[1] ? rates[1] / rates[0] : 1.0
+        }
+      elsif elements.first == 'DIVIDEND'
+        # this will apear above the daily history on that day
+        # DIVIDEND, 20161219,1.507000
+        dividends[elements[1]] = {
+          :date => elements[1],
+          :dividend => elements[2].to_f.round(2)
+        }
+      else
+        # Date,Open,High,Low,Close,Volume,Adj Close
+        # 20161219,28.889999,28.92,28.120001,28.43,27938700,28.43
+        trading_date = to_date(elements.first)
+        if trading_date.nil?
+          raise ParseException.new("Format error on line: #{line}")
+        end
+        results << {
+          :date         => elements[0],
+          :date_parsed  => to_date(elements[0]),
+          :open         => elements[1].to_f.round(2),
+          :high         => elements[2].to_f.round(2),
+          :low          => elements[3].to_f.round(2),
+          :close        => elements[4].to_f.round(2),
+          :volume       => elements[5].to_f.round(2),
+          :adjusted_close => elements[6].to_f.round(2),
+          :split        => splits[elements[0]] == nil ? nil : splits[elements[0]][:split],
+          :merge        => splits[elements[0]] == nil ? nil : splits[elements[0]][:merge],
+          :dividend     => dividends[elements[0]] == nil ? nil : dividends[elements[0]][:dividend],
+        }
+      end
+    end
+
+    results
+  end
+
+  def self.build_url(symbol, params={})
+    params[:start_date] ||= Date.parse('2016-01-01')
+    params[:stop_date]  ||= Date.today
+    params[:freq]  ||= 'd'
+
+    url_params = {}
+    url_params['s'] = symbol.upcase
+    url_params['a'] = params[:start_date].month - 1
+    url_params['b'] = params[:start_date].day
+    url_params['c'] = params[:start_date].year
+    url_params['d'] = params[:stop_date].month - 1
+    url_params['e'] = params[:stop_date].day
+    url_params['f'] = params[:stop_date].year
+    url_params['g'] = params[:freq]        
+    url_params['y'] = '0'
+    url_params['z'] = '30000'
+
+    url = 'http://real-chart.finance.yahoo.com/x?'
+    url_params.keys.sort.each do |key|
+      url += "&#{key}=#{url_params[key]}"
+    end
+
+    url
+  end
+end

data/lib/stock_history/exceptions.rb

@@ -0,0 +1,4 @@
+module StockHistory
+  class ParseException < Exception
+  end
+end

data/lib/stock_history/utility.rb

@@ -0,0 +1,50 @@
+
+require 'date'
+module StockHistory
+  # => StockHistory Utility Methods
+  module Utility
+
+    def min_date(first, second)
+      first < second ? first : second
+    end
+
+    def to_format(string)
+      to_fs(to_date(string))
+    end
+
+    def to_underscore(string)
+      string = string.gsub(/::/, '/')
+      string.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      string.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      string.tr!('-', '_')
+      string.downcase!
+      string
+    end
+
+    def to_fs(string)
+      (!!Float(string) rescue false) ? Float(string) : string
+    end
+
+    def to_p(string)
+      if string.is_a?(String)
+        to_p(string.split(','))
+      elsif string.is_a?(Array)
+        "'#{string.join("','").gsub(" ", "").upcase}'"
+      else
+        string
+      end
+    end
+
+    def to_date(string)
+      if string.is_a?(String) && string.match(/\d{4}-\d{2}-\d{2}/)
+        Date.strptime(string, '%Y-%m-%d')
+      elsif string.is_a?(String) && string.match(/\d{2}\/\d{2}\/\d{4}/)
+        Date.strptime(string, '%m/%d/%Y')
+      elsif string.is_a?(String) && string.match(/\d{8}/)
+        Date.strptime(string, '%Y%m%d')
+      else
+        string
+      end
+    end
+  end
+end

data/lib/stock_history/version.rb

@@ -0,0 +1,3 @@
+module StockHistory
+  VERSION = "0.1.0"
+end

data/stock_history.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stock_history/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stock_history"
+  spec.version       = StockHistory::VERSION
+  spec.authors       = ["uniEagle"]
+  spec.email         = ["unieagle@gmail.com"]
+
+  spec.summary       = "Get stock history data from Yahoo, with split and dividend info"
+  spec.description   = "Get stock history data from Yahoo, with split and dividend info"
+  spec.homepage      = "https://github.com/unieagle/stock_history"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: stock_history
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- uniEagle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Get stock history data from Yahoo, with split and dividend info
+email:
+- unieagle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stock_history.rb
+- lib/stock_history/exceptions.rb
+- lib/stock_history/utility.rb
+- lib/stock_history/version.rb
+- stock_history.gemspec
+homepage: https://github.com/unieagle/stock_history
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Get stock history data from Yahoo, with split and dividend info
+test_files: []