yfin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d3a87369df7029e00883ae4b594e640166f835a
+  data.tar.gz: 0d6c21445a8c6897004e1a5292811140a21eec74
+SHA512:
+  metadata.gz: c056b546d9de0a080e81b57df8b790a683a014d42fa587bb50ee62860ac330326b6fb071d6c49b3fcd9aa636626ca14ff0f97c7b35f40c4c59328fc3d0cbaf61
+  data.tar.gz: da00a1970241835023ea50666987affe81f5a0cebd379a69085dad309287e1b422844cb7a41bd0002442a3267ad127e93cf2be4336e76b6b45d03f50c29f8ade

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/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christopher Moeller
+
+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,48 @@
+# Yfin
+
+Yfin provides a ruby interface to some parts of Yahoo! Finance. Currently, it
+only retrieves historical data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yfin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yfin
+
+## Usage
+
+Create a new Yfin::History object:
+
+    Yfin::History.new('aapl')
+
+Available options are :start\_date, :end\_date and :type. :start\_date and
+:end\_date are both Dates while :type is a symbol. All Dates must be in the
+past to be valid. :start\_date defaults to 30 days ago and :end\_date defaults
+to Date.today. Valid values for :type are :daily (default), :weekly, :monthly
+and :dividend.
+
+Here is an example using all of the options:
+
+    Yfin::History.new('aapl', start_date: Date.new(1983, 7, 25), end_date: Date.today, type: :monthly)
+
+After creating a Yfin::History instance, you can call `to_csv` to get a
+CSV::Table of the data.
+
+    history = Yfin::History.new('aapl')
+    history.to_csv   #=> #<CSV::Table mode:col_or_row row_count:22>
+
+## 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,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << ['lib/yfin', 'test']
+  t.test_files = FileList['test/**/*_spec.rb']
+  t.verbose = true
+end
+
+task default: :test

data/lib/yfin.rb

@@ -0,0 +1,5 @@
+require 'net/http'
+require 'date'
+require 'csv'
+require 'yfin/history'
+require 'yfin/version'

data/lib/yfin/history.rb

@@ -0,0 +1,86 @@
+module Yfin
+  class History
+    attr_reader :symbol, :start_date, :end_date, :type
+
+    def initialize(symbol, options={})
+      validate_options(options)
+      @symbol     = symbol
+      @start_date = options[:start_date] || Date.today - 30
+      @end_date   = options[:end_date] || Date.today
+      @type       = options[:type] || :daily
+    end
+
+    def to_csv
+      CSV.parse(data_from_yahoo, headers: :first_line, header_converters: :symbol, converters: [:date, :numeric])
+    end
+
+  private
+
+    def data_from_yahoo
+      tries ||= 3
+      Net::HTTP.get(uri)
+    rescue Errno::ECONNRESET => e
+      retry unless (tries -= 1).zero?
+    end
+
+    def uri
+      URI.parse("#{uri_base}#{uri_params}")
+    end
+
+    def uri_base
+      "http://ichart.finance.yahoo.com/table.csv"
+    end
+
+    def uri_params
+      params_array = ['?']
+      params.each { |k, v| params_array << "#{k}=#{v}" }
+      params_array.join('&')
+    end
+
+    def params
+      {
+        s: @symbol,
+        a: sprintf("%02d", @start_date.month-1),
+        b: @start_date.day,
+        c: @start_date.year,
+        d: sprintf("%02d", @end_date.month-1),
+        e: @end_date.day,
+        f: @end_date.year,
+        g: type_param,
+        ignore: '.csv'
+      }
+    end
+
+    def type_param
+      case @type
+        when :daily    then 'd'
+        when :weekly   then 'w'
+        when :monthly  then 'm'
+        when :dividend then 'v'
+      end
+    end
+
+    VALID_KEYS  = [:start_date, :end_date, :type]
+    VALID_TYPES = [:daily, :weekly, :monthly, :dividend]
+
+    def validate_options(options)
+      validate_keys(options.keys)
+      validate_types(options)
+    end
+
+    def validate_keys(*keys)
+      keys.flatten!
+      keys.each { |k| raise ArgumentError.new("Unknown key: #{k}") if !VALID_KEYS.include?(k) }
+    end
+
+    def validate_types(options)
+      options.each do |o|
+        if o[0] == :type
+          raise(ArgumentError, "#{o[0]} must be a Symbol") if !o[1].is_a?(Symbol)
+        else
+          raise(ArgumentError, "#{o[0]} must be a Date") if !o[1].is_a?(Date)
+        end
+      end
+    end
+  end
+end

data/lib/yfin/version.rb

@@ -0,0 +1,3 @@
+module Yfin
+  VERSION = '0.0.1'
+end

data/test/lib/yfin/history_spec.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+describe Yfin::History do
+  let(:symbol)     { 'aapl' }
+  let(:start_date) { Date.today - 180 }
+  let(:end_date)   { Date.today - 1 }
+  let(:type)       { :weekly }
+
+  describe '#new' do
+    describe 'without options' do
+      subject { Yfin::History.new(symbol) }
+
+      specify { subject.must_be_kind_of(Yfin::History) }
+      specify { subject.symbol.must_equal(symbol) }
+      specify { subject.start_date.must_equal(Date.today - 30) }
+      specify { subject.end_date.must_equal(Date.today) }
+      specify { subject.type.must_equal(:daily) }
+    end
+
+    describe 'with' do
+      describe ':start_date' do
+        subject { Yfin::History.new(symbol, start_date: start_date) }
+
+        specify { subject.must_be_kind_of(Yfin::History) }
+        specify { subject.symbol.must_equal(symbol) }
+        specify { subject.start_date.must_equal(start_date) }
+        specify { subject.end_date.must_equal(Date.today) }
+        specify { subject.type.must_equal(:daily) }
+      end
+
+      describe ':start_date, :end_date' do
+        subject { Yfin::History.new(symbol, start_date: start_date, end_date: end_date) }
+
+        specify { subject.must_be_kind_of(Yfin::History) }
+        specify { subject.symbol.must_equal(symbol) }
+        specify { subject.start_date.must_equal(start_date) }
+        specify { subject.end_date.must_equal(end_date) }
+        specify { subject.type.must_equal(:daily) }
+      end
+
+      describe ':start_date, :end_date, :type' do
+        subject { Yfin::History.new(symbol, start_date: start_date, end_date: end_date, type: type) }
+
+        specify { subject.must_be_kind_of(Yfin::History) }
+        specify { subject.symbol.must_equal(symbol) }
+        specify { subject.start_date.must_equal(start_date) }
+        specify { subject.end_date.must_equal(end_date) }
+        specify { subject.type.must_equal(type) }
+      end
+    end
+
+    describe 'invalid calls' do
+      specify { proc{ Yfin::History.new }.must_raise(ArgumentError) }
+      specify { proc{ Yfin::History.new(symbol, unknown_key: 'Unknown') }.must_raise(ArgumentError) }
+
+      describe 'data types' do
+        specify { proc{ Yfin::History.new(symbol, start_date: Object.new) }.must_raise(ArgumentError) }
+        specify { proc{ Yfin::History.new(symbol, end_date: Object.new) }.must_raise(ArgumentError) }
+        specify { proc{ Yfin::History.new(symbol, type: Object.new) }.must_raise(ArgumentError) }
+      end
+    end
+  end
+
+  describe '#to_csv' do
+    subject { Yfin::History.new(symbol) }
+    specify { subject.must_respond_to(:to_csv) }
+    specify { subject.to_csv.must_be_kind_of(CSV::Table) }
+
+    describe 'row' do
+      subject { Yfin::History.new(symbol).to_csv.first }
+
+      [:date, :open, :high, :low, :close, :volume, :adj_close].each { |e|
+        specify { subject.must_include(e) }
+      }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/yfin.rb', __FILE__)

data/yfin.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yfin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yfin"
+  spec.version       = Yfin::VERSION
+  spec.authors       = ["Christopher Moeller"]
+  spec.email         = ["cmoel@me.com"]
+  spec.description   = %q{Retrieves data from Yahoo! Finance}
+  spec.summary       = %q{Retrieves data from Yahoo! Finance}
+  spec.homepage      = "https://github.com/cmoel/yfin"
+  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", "~> 10.0.3"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: yfin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Moeller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-26 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: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: Retrieves data from Yahoo! Finance
+email:
+- cmoel@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yfin.rb
+- lib/yfin/history.rb
+- lib/yfin/version.rb
+- test/lib/yfin/history_spec.rb
+- test/test_helper.rb
+- yfin.gemspec
+homepage: https://github.com/cmoel/yfin
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Retrieves data from Yahoo! Finance
+test_files:
+- test/lib/yfin/history_spec.rb
+- test/test_helper.rb