stock_quote 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80504aa14b14bf1c7832caad563a19dbe37889a5
+  data.tar.gz: 745f0d4376c8637a7815c32e5accb56f3441d510
+SHA512:
+  metadata.gz: 9d9916c18f79ef4408e8a0d21d5dc7d149d5b582327e8ff74726a1674b09aa99b01c927f46c4a7caf97d81c2f9928709af2b722e2a2a7027e4234fd62352c6da
+  data.tar.gz: 107a5b882967bdce511131bbaa15b2283850dd672791871bd0abba964862293c2a4fdb6561fd266eb89024e61587f6e37005cb287017fa9c206e8991afd8f37d

data/.gitignore

@@ -0,0 +1,7 @@
+.idea/
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/support/vcr_cassettes/*.yml
+.DS_Store

data/.ruby-gemset

@@ -0,0 +1 @@
+StockQuote

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+bundler_args: ''
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.4
+  - 2.3.7
+install:
+  - gem install bundler --version '~> 2.0.1'
+  - bundle install
+script: "rake"

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Ty Rauber
+
+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,141 @@
+# stock_quote
+
+Real-time, stock data and historical pricing. Data provided by [IEXCLOUD.IO](https://iexcloud.io/). An [API KEY](https://iexcloud.io/cloud-login#/register/) is now required.
+
+# Update
+
+On June 1, 2019, IEX Group removed all non-IEX data from the IEX Trading API, and migrated all relevant endpoints to IEX Cloud. A free plan is available with a valid API Key. The only change in StockQuote usage is initialization with an API KEY is now required (`StockQuote::Stock.new(api_key: 'YOUR_API_KEY'`).
+
+## Installation
+
+To install the 'stock_quote' ruby gem:
+
+`gem install stock_quote`
+
+## Gem Configuration
+
+To use the gem in your Rails Application, include it in your Gemfile:
+
+`gem "stock_quote"`, '~> 3.0.0'
+
+
+## Initialization
+
+To globally initialize StockQuote with a valid API_KEY:
+
+`StockQuote::Stock.new(api_key: YOUR_API_KEY)`
+
+You can also supply api_key as an attribute in any StockQuote::Stock method.
+
+### StockQuote::Stock.quote(symbol)
+
+Quote is the primary method, returning a StockQuote::Stock instance, including the following attributes (new in v2.0.0).
+
+`symbol, company_name, primary_exchange, sector, calculation_price, open, open_time, close, close_time, high, low, latest_price, latest_source, latest_time, latest_update, latest_volume, iex_realtime_price, iex_realtime_size, iex_last_updated, delayed_price, delayed_price_time, previous_close, change, change_percent, iex_market_percent, iex_volume, avg_total_volume, iex_bid_price, iex_bid_size, iex_ask_price, iex_ask_size, market_cap, pe_ratio, week52_high, week52_low, ytd_change, chart`
+
+You can get a current quote with the following syntax:
+
+`stock = StockQuote::Stock.quote("symbol")`
+
+Where symbol equals the company stock symbol you want a quote for. For example, "aapl" for Apple, Inc.
+
+You may search for multiple stocks by separating symbols with a comma (or array). For example:
+
+`stocks = StockQuote::Stock.quote("aapl,tsla")`
+
+These queries will return a Stock object or an array of Stock objects which you may iterate through. 
+
+Note: You can receive a raw json hash response with the following syntax:
+
+`stocks = StockQuote::Stock.raw_quote("aapl,tsla")`
+
+The raw_ method is available on all supported methods.
+
+### Other Methods
+
+The IEX API is quite extensive and well documented.
+
+V3.0.0 of stock_quote mirrors the IEXCLOUD.IO API:
+
+* [book](https://iexcloud.io/docs/api/#book)
+* [chart](https://iexcloud.io/docs/api/#historical-prices)
+* [company](https://iexcloud.io/docs/api/#company)
+* [delayed_quote](https://iexcloud.io/docs/api/#delayed-quote)
+* [dividends](https://iexcloud.io/docs/api/#dividends)
+* [earnings](https://iexcloud.io/docs/api/#earnings)
+* [financials](https://iexcloud.io/docs/api/#financials)
+* [stats](https://iexcloud.io/docs/api/#key-stats)
+* [logo](https://iexcloud.io/docs/api/#logo)
+* [news](https://iexcloud.io/docs/api/#news)
+* [ohlc](https://iexcloud.io/docs/api/#ohlc)
+* [peers](https://iexcloud.io/docs/api/#peers)
+* [previous](https://iexcloud.io/docs/api/#previous)
+* [price](https://iexcloud.io/docs/api/#price)
+* [quote](https://iexcloud.io/docs/api/#quote)
+* [relevant](https://iexcloud.io/docs/api/#relevant)
+* [splits](https://iexcloud.io/docs/api/#splits)
+* [volume_by_venue](https://iexcloud.io/docs/api/#volume-by-venue)
+
+All these methods are available on StockQuote::Stock.
+
+For example:
+
+```StockQuote::Stock.company('aapl')```
+
+Retrieves company information.
+
+For example:
+
+```StockQuote::Stock.dividends('aapl')```
+
+Retrieves dividend information.
+
+Raw json hash responses are available for any of the methods by pre-fixing the method name with "raw__".
+
+For example:
+
+```StockQuote::Stock.raw_dividends('aapl')```
+
+Retrieves raw dividend information.
+
+### [batch](https://iextrading.com/developer/docs/#batch-requests)
+
+Batch allows you to batch requests.  All methods in stock_quote use batch under-the-hood.
+
+Batch follows the syntax:
+
+```StockQuote::Stock.batch(type, symbol, range)```
+
+Where type can be multiple of the above methods and symbol can be an array of company symbols.
+
+Range can be:
+
+`5y, 2y, 1y, ytd, 6m, 3m, 1m, 1d`
+
+And are applied to chart method.
+
+## Special thanks to
+
+IEX for making this api publicly available.
+
+## License
+
+Copyright (c) 2019 Ty Rauber
+
+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/Rakefile

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

data/lib/stock_quote/stock.rb

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'rest-client'
+require 'json'
+require 'csv'
+
+module StockQuote
+
+  # => StockQuote::Stock
+  # Queries IEX for current and historical pricing.
+
+  class Stock
+
+    VERSION = "v1"
+    URL =  "https://cloud.iexapis.com/#{VERSION}/stock/"
+    ATTRIBUTION = "Data provided for free by IEX (https://iexcloud.io)."
+    RANGES = ['5y','2y','1y','ytd','6m','3m','1m','1d']
+    TYPES = ['book', 'chart', 'company', 'delayed_quote', 'dividends', 'earnings', 'financials', 'splits', 'stats','logo', 'news', 'ohlc', 'peers', 'previous', 'quote', 'relevant', 'volume_by_venue']
+  
+    class << self
+      attr_accessor :api_key
+      def create_method(name)
+        self.class.instance_eval do
+          define_method(name) {|symbol, range=nil| batch(name, symbol, range) }
+          define_method("raw_#{name}") {|symbol, range=nil| batch(name, symbol, range, 'json') }
+        end
+      end
+    end
+
+    attr_accessor :response_code, :attribution
+
+    protected
+
+    TYPES.each do |k|
+      create_method(k)
+    end
+
+    def initialize(data={})
+      self.class.api_key = data.delete(:api_key) if !!(data[:api_key])
+      data.each {|k,v|
+        self.class.__send__(:attr_accessor, Util.underscore(k).to_sym)
+        self.instance_variable_set("@#{Util.underscore(k)}".to_sym, v)
+      }
+      @attribution = ATTRIBUTION
+      @response_code = !!([{}, nil, ''].include?(data)) ? 500 :  200
+    end
+
+    def self.batch_url(types, symbols, range)
+      symbols = symbols.is_a?(Array) ? symbols : symbols.split(",")
+      types = types.is_a?(Array) ? types : types.split(",")
+      if !(['dividends', 'splits'] & types).empty?
+        raise "#{types.join(",")} requires a Range: #{RANGES.join(", ")}" unless RANGES.include?(range)
+        range = RANGES.include?(range) ? range : nil
+      end
+      arr = [['token', self.api_key],['symbols', symbols.join(',')], ['types', types.map{|t| t.gsub("_", "-")}.join(',')]]
+      arr.push(['range', range]) if !!(range)
+      return "#{URL}market/batch?#{URI.encode_www_form(arr)}"
+    end
+
+    def self.batch(type, symbol, range=nil,fmt=false)
+      raise "Type and symbol required" unless type && symbol
+      url =  batch_url(type, symbol, range)
+      return request(url, fmt)
+    end
+    
+    def self.request(url, fmt, results=[])
+      RestClient::Request.execute(:url =>  url, :method => :get, :verify_ssl => false) do |response|
+        raise response.body unless response.code == 200
+        json = JSON.parse(response)
+        return json if fmt=='json'
+        results = json.map do |symbol, types|
+          result = {}
+          types.map do |type, res|
+            if res.is_a?(Array)
+              result[type.gsub("-", "_")] = res
+            else
+              res.map{|k,v| result[k] = v }
+            end
+            result['symbol'] ||= symbol
+          end
+          Stock.new(result)
+        end
+      end
+      return results.length > 1 ? results : results.shift
+    end
+  end
+
+  class Util
+    def self.underscore(str)
+      str.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/stock_quote/version.rb

@@ -0,0 +1,4 @@
+# => StockQuote::VERSION
+module StockQuote
+  VERSION = '3.0.0'
+end

data/lib/stock_quote.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'stock_quote/version'
+require 'stock_quote/stock'

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'stock_quote'
+require 'rubygems'
+require 'bundler/setup'
+require 'support/vcr'
+
+RSpec.configure do |config|
+end

data/spec/stock_quote_spec.rb

@@ -0,0 +1,112 @@
+require 'stock_quote'
+require 'spec_helper'
+
+describe StockQuote::Stock do
+
+  before(:all) do
+    StockQuote::Stock.new(api_key: ENV['API_KEY'])
+  end
+
+  StockQuote::Stock::TYPES.each do |key|
+    describe key, vcr: { cassette_name: key} do
+      let(:range){
+        ['dividends', 'splits'].include?(key) ? StockQuote::Stock::RANGES.shuffle.shift : nil
+      }
+      it "should be instance of Stock" do
+        @stock = StockQuote::Stock.send(key, 'aapl', range)
+        expectation(@stock)
+      end
+
+      it "should be raw json hash" do
+        @stock = StockQuote::Stock.send("raw_#{key}", 'aapl', range)
+        expectation(@stock, 'json')
+      end
+    end
+  end
+
+  describe '#query' do
+    describe 'single action' do
+      describe 'single symbol string', vcr: { cassette_name: "aapl"} do
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch('quote','aapl')
+          expectation(@stock)
+        end
+
+        it "should be json" do
+          @stock = StockQuote::Stock.batch('quote','aapl',nil, 'json')
+          expectation(@stock, 'json')
+        end
+      end
+
+      describe 'multiple symbol array', vcr: { cassette_name: "aapl,tsla"} do
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch('quote',['aapl', 'tsla'])
+          expectation(@stock)
+        end
+
+        it "should be json" do
+          @stock = StockQuote::Stock.batch('quote',['aapl', 'tsla'], nil, 'json')
+          expectation(@stock, 'json')
+        end
+      end
+
+      describe 'multiple symbol string', vcr: { cassette_name: "aapl,tsla"} do
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch('quote','aapl,tsla')
+          expectation(@stock)
+        end
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch('quote','aapl,tsla', nil, 'json')
+          expectation(@stock, 'json')
+        end
+      end
+    end
+    describe 'multiple action' do
+      describe 'multiple symbol array', vcr: { cassette_name: "aapl,tsla"} do
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch(['quote','chart'],['aapl', 'tsla'])
+          expectation(@stock)
+        end
+
+        it "should be json" do
+          @stock = StockQuote::Stock.batch(['quote','chart'],['aapl', 'tsla'], nil, 'json')
+          expectation(@stock, 'json')
+        end
+      end
+
+      describe 'multiple symbol string', vcr: { cassette_name: "aapl,tsla"} do
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch('quote,chart','aapl,tsla')
+          expectation(@stock)
+        end
+
+        it "should be instance of Stock" do
+          @stock = StockQuote::Stock.batch('quote,chart','aapl,tsla', nil, 'json')
+          expectation(@stock, 'json')
+        end
+      end
+    end
+  end
+
+  protected
+  
+  def expectation(stock, fmt=nil)
+    if stock.is_a?(Array)
+      stock.each{|s| expectation(s, fmt) }
+    elsif fmt=='json'
+      expect(stock).to be_an_instance_of(Hash)
+    else
+      expect(stock).to be_an_instance_of(StockQuote::Stock)
+      expect(stock).to respond_to(:symbol)
+      expect(stock).to respond_to(:response_code)
+      expect(stock).to respond_to(:attribution)
+      expect(stock.attribution).to be(StockQuote::Stock::ATTRIBUTION)
+    end
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/vcr_cassettes'
+  c.hook_into :webmock
+  c.ignore_localhost = true
+  c.default_cassette_options = { record: :new_episodes }
+  c.configure_rspec_metadata!
+end

data/stock_quote.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'stock_quote/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'stock_quote'
+  s.version     = StockQuote::VERSION
+  s.authors     = ['Ty Rauber']
+  s.email       = ['tyrauber@mac.com']
+  s.homepage    = 'https://github.com/tyrauber/stock_quote'
+  s.summary     = 'A ruby gem that retrieves real-time stock quotes from IEX.'
+  s.description = 'Retrieve book, chart, company, delayed quote, dividends, earnings, effective spread, financials, stats, lists, logo, news, OHLC, open/close, peers, previous, price, quote, relevant, splits, timeseries, volume by venue and batch requests through IEX (iextrading.com/developer)'
+  s.rubyforge_project = 'stock_quote'
+  s.license = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+
+  s.add_development_dependency 'bundler', '~> 2.0.1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+  s.add_development_dependency 'vcr', '~> 4.0.0'
+  s.add_development_dependency 'webmock', '~> 3.4.2'
+  s.add_runtime_dependency 'rest-client', '~> 2.0.2'
+  s.add_runtime_dependency 'json'
+
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: stock_quote
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Ty Rauber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retrieve book, chart, company, delayed quote, dividends, earnings, effective
+  spread, financials, stats, lists, logo, news, OHLC, open/close, peers, previous,
+  price, quote, relevant, splits, timeseries, volume by venue and batch requests through
+  IEX (iextrading.com/developer)
+email:
+- tyrauber@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/stock_quote.rb
+- lib/stock_quote/stock.rb
+- lib/stock_quote/version.rb
+- spec/spec_helper.rb
+- spec/stock_quote_spec.rb
+- spec/support/vcr.rb
+- stock_quote.gemspec
+homepage: https://github.com/tyrauber/stock_quote
+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: stock_quote
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A ruby gem that retrieves real-time stock quotes from IEX.
+test_files:
+- spec/spec_helper.rb
+- spec/stock_quote_spec.rb
+- spec/support/vcr.rb