y_fi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a1743769b54ef3fe88f6e697ed8f6fd13b86197
+  data.tar.gz: 15efa974fffa26653de3a8b9173bcd7bfbd94b98
+SHA512:
+  metadata.gz: 0d65e50fb52c51bbe8deeea4441489128e56ab30534a756534f2e298d11cb10d38a488ba0d45134950da7588267c1ed8d4d86c98642ba1f839e60c7b96c4ffe7
+  data.tar.gz: e3a92ddde289e1c45e77395d3e3ed71c3da4d5d2bebccf1cb0a99b3edf2744fa729ebd7e6675eaadb5220cd841ea2b92ee4303066108556acf6a66253f7b65c7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jeff Ramer
+
+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,47 @@
+# YFi
+This is a Ruby implementation for fetching stock/fund prices from the Yahoo Finance API with YQL: https://developer.yahoo.com/yql/faq/
+
+## Usage
+To get a collection of quotes (Enumerable object):
+```
+YFi::QuoteCollection.new(['vbtlx', 'vigrx'])
+```
+
+To get an individual quote:
+```
+quote = YFi::Quote.find('aapl')
+puts quote.price
+puts quote.updated_at
+puts quote.issuer_name
+puts quote.ticker
+```
+
+## Installation
+```gem install y_fi```
+
+```ruby
+gem 'y_fi'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install y_fi
+```
+
+Set up the logger:
+```
+YFi.configure do |config|
+  config.logger = ::Logger.new("#{Rails.root}/log/yahoo_finance.log")
+end
+```
+
+## Contributing
+Feel free to create a pull request on a feature branch.
+
+## 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,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'YFi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/y_fi/quote.rb

@@ -0,0 +1,22 @@
+module YFi
+  class Quote
+    attr_accessor :price, 
+      :updated_at,
+      :issuer_name,
+      :ticker
+
+    def initialize(args)
+      args.each do |key, val|
+        self.public_send("#{key}=", val)
+      end
+      self.ticker = self.ticker.to_s.upcase
+    end
+
+    # @param ticker [String]
+    # @example Api::ExternalFund.find_by_ticker('AAPL')
+    # @return [Api::ExternalFund]
+    def self.find_by_ticker(ticker)
+      QuoteCollection.new([ticker]).first
+    end
+  end
+end

data/lib/y_fi/quote_collection.rb

@@ -0,0 +1,98 @@
+# Uses YAHOO's API service for fetching fund prices.
+# Example: 
+#   YFi::QuoteCollection.new(['vbtlx', 'vigrx'])
+# Will call the following URL:
+#   http://finance.yahoo.com/webservice/v1/symbols/VBTLX,VIGRX/quote?format=json&view=detail
+require "httparty"
+
+module YFi
+  class QuoteCollection
+    include Enumerable
+    include HTTParty
+    attr_accessor :tickers, :raw_quotes
+
+    base_uri 'http://query.yahooapis.com/v1/public/yql'
+
+    logger begin
+      YFi.configuration.logger
+    end
+    debug_output YFi.configuration.logger
+
+    # @param [Array<String>] - An array of tickers, such as ['AAPL']
+    # @return [YFi::Quote, #to_a, #find, #each] - an array of Api::ExteralFunds
+    def initialize(tickers)
+      validate_ticker_format(tickers)
+      self.tickers = tickers
+      self.raw_quotes = self.class.get("", url_query_options)
+    end
+
+    # @return [Array] - an array of YFi::Quote
+    def to_a
+      response_array.each_with_object([]) do |raw_quote, arr|
+        next unless valid_quote?(raw_quote)
+        arr << Quote.new(
+          ticker: raw_quote.fetch("symbol"),
+          price: raw_quote["LastTradePriceOnly"].to_f,
+          updated_at: parse_updated_at(raw_quote.fetch("LastTradeDate")),
+          issuer_name: raw_quote.fetch("Name")
+        )
+      end
+    end
+
+    # @return [YFi::Quote]
+    def find(ticker)
+      to_a.find{|ef| ef.ticker == ticker.to_s.upcase}
+    end
+    
+    def each(&block)
+      to_a.each(&block)
+    end
+
+    private
+    def yql_query_string
+      funds = self.tickers.map{|f| "\"#{f}\""}.join(',')
+      "select * from yahoo.finance.quotes where symbol in(#{funds})"
+    end
+
+    def response_array
+      arr = raw_quotes.fetch("query", {}).fetch("results", {}).fetch("quote", {})
+      arr = [arr] unless arr.is_a?(Array)
+      arr
+    end
+
+    def parse_updated_at(updated_at)
+      Date.strptime(updated_at, '%m/%d/%Y')
+    rescue
+      YFi.configuration.logger("Unable to parse date: #{updated_at}")
+      Date.new(1976,1,1)
+    end
+
+    def validate_ticker_format(tickers)
+      unless tickers.is_a?(Array) && tickers.all?{|f| f.is_a?(String)} && tickers.size
+        raise(ArgumentError, "Please provide an array of tickers") 
+      end
+    end
+
+    def url_query_options
+      { 
+        query: {
+          format: 'json', 
+          q: yql_query_string, 
+          env: "store://datatables.org/alltableswithkeys"
+        }
+      }
+    end
+
+    def valid_quote?(raw_quote)
+      unless raw_quote.is_a?(Hash)
+        YFi.configuration.logger.error("Expected a hash but got: #{raw_quote}")
+        return false
+      end
+      unless raw_quote["LastTradePriceOnly"]
+        YFi.configuration.logger.error("Unable to fetch a price from #{raw_quote}")
+        return false
+      end
+      true
+    end
+  end
+end

data/lib/y_fi/version.rb

@@ -0,0 +1,3 @@
+module YFi
+  VERSION = '0.1.0'
+end

data/lib/y_fi.rb

@@ -0,0 +1,30 @@
+require "logger"
+
+module YFi
+  class Configuration
+    attr_accessor :logger
+
+    def initialize
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+require 'y_fi/quote.rb'
+require 'y_fi/quote_collection.rb'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: y_fi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Ramer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: https://developer.yahoo.com/yql/faq/
+email:
+- jeffery.ramer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/y_fi.rb
+- lib/y_fi/quote.rb
+- lib/y_fi/quote_collection.rb
+- lib/y_fi/version.rb
+homepage: 
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Gem for fetching quotes from the Yahoo Finance API
+test_files: []