iex-ruby-client 1.1.0 → 1.4.0

data/RELEASING.md

@@ -16,10 +16,10 @@ Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/
 Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
 
 ```
-### 0.2.2 (7/10/2015)
+### 0.2.2 (2015/10/07)
 ```
 
-Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
 
 Commit your changes.
 

data/iex-ruby-client.gemspec

@@ -9,13 +9,14 @@ Gem::Specification.new do |s|
   s.email = 'dblock@dblock.org'
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version = '>= 2.3.0'
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
   s.homepage = 'http://github.com/dblock/iex-ruby-client'
   s.licenses = ['MIT']
   s.summary = 'IEX Finance API Ruby client with support for retrieving stock quotes.'
-  s.add_dependency 'faraday', '>= 0.9'
+  s.add_dependency 'faraday', '>= 0.17'
   s.add_dependency 'faraday_middleware'
   s.add_dependency 'hashie'
   s.add_dependency 'money_helper'

data/lib/iex/api.rb

@@ -1,7 +1,11 @@
+require_relative 'endpoints/advanced_stats'
+require_relative 'endpoints/balance_sheet'
+require_relative 'endpoints/cash_flow'
 require_relative 'endpoints/chart'
 require_relative 'endpoints/company'
 require_relative 'endpoints/dividends'
 require_relative 'endpoints/earnings'
+require_relative 'endpoints/historial_prices'
 require_relative 'endpoints/income'
 require_relative 'endpoints/largest_trades'
 require_relative 'endpoints/logo'
@@ -12,6 +16,9 @@ require_relative 'endpoints/price'
 require_relative 'endpoints/quote'
 require_relative 'endpoints/sectors'
 require_relative 'endpoints/crypto'
+require_relative 'endpoints/ref_data'
+require_relative 'endpoints/stock_market'
 
-require_relative 'api/config'
+require_relative 'api/config/logger'
+require_relative 'api/config/client'
 require_relative 'api/client'

data/lib/iex/api/client.rb

@@ -1,11 +1,18 @@
 module IEX
   module Api
+    extend Config::Client::Accessor
+    extend Config::Logger::Accessor
+
     class Client
+      include Endpoints::AdvancedStats
+      include Endpoints::BalanceSheet
+      include Endpoints::CashFlow
       include Endpoints::Chart
       include Endpoints::Company
       include Endpoints::Crypto
       include Endpoints::Dividends
       include Endpoints::Earnings
+      include Endpoints::HistoricalPrices
       include Endpoints::Income
       include Endpoints::KeyStats
       include Endpoints::LargestTrades
@@ -15,16 +22,22 @@ module IEX
       include Endpoints::Price
       include Endpoints::Quote
       include Endpoints::Sectors
+      include Endpoints::RefData
+      include Endpoints::StockMarket
 
       include Cloud::Connection
       include Cloud::Request
 
-      include Config
+      attr_accessor(*Config::Client::ATTRIBUTES)
+
+      attr_reader :logger
 
       def initialize(options = {})
-        Config::ATTRIBUTES.each do |key|
+        Config::Client::ATTRIBUTES.each do |key|
           send("#{key}=", options[key] || IEX::Api.config.send(key))
         end
+        @logger = Config::Logger.dup
+        @logger.instance = options[:logger] if options.key?(:logger)
       end
     end
   end

data/lib/iex/api/config/client.rb

@@ -0,0 +1,52 @@
+module IEX
+  module Api
+    module Config
+      module Client
+        ATTRIBUTES = %i[
+          ca_file
+          ca_path
+          endpoint
+          open_timeout
+          proxy
+          publishable_token
+          referer
+          secret_token
+          timeout
+          user_agent
+        ].freeze
+
+        class << self
+          include Config::Logger::Accessor
+
+          attr_accessor(*ATTRIBUTES)
+
+          def reset!
+            self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
+            self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
+            self.endpoint = 'https://cloud.iexapis.com/v1'
+            self.publishable_token = ENV['IEX_API_PUBLISHABLE_TOKEN']
+            self.secret_token = ENV['IEX_API_SECRET_TOKEN']
+            self.user_agent = "IEX Ruby Client/#{IEX::VERSION}"
+
+            self.open_timeout = nil
+            self.proxy = nil
+            self.referer = nil
+            self.timeout = nil
+          end
+        end
+
+        module Accessor
+          def configure
+            block_given? ? yield(Config::Client) : Config::Client
+          end
+
+          def config
+            Config::Client
+          end
+        end
+      end
+    end
+  end
+end
+
+IEX::Api::Config::Client.reset!

data/lib/iex/api/config/logger.rb

@@ -0,0 +1,35 @@
+module IEX
+  module Api
+    module Config
+      module Logger
+        ATTRIBUTES = %i[
+          instance
+          options
+          proc
+        ].freeze
+
+        class << self
+          attr_accessor(*ATTRIBUTES)
+
+          def reset!
+            self.instance = nil
+            self.options = {}
+            self.proc = nil
+          end
+        end
+
+        module Accessor
+          def logger
+            block_given? ? yield(Config::Logger) : Config::Logger
+          end
+
+          def logger=(instance)
+            logger.instance = instance
+          end
+        end
+      end
+    end
+  end
+end
+
+IEX::Api::Config::Logger.reset!

data/lib/iex/cloud/connection.rb

@@ -8,28 +8,31 @@ module IEX
       end
 
       def connection
-        options = {}
+        @connection ||= begin
+          options = {}
 
-        options[:headers] = {}
-        options[:headers]['Accept'] = 'application/json; charset=utf-8'
-        options[:headers]['User-Agent'] = user_agent if user_agent
-        options[:proxy] = proxy if proxy
-        options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
-        options[:params] = { token: publishable_token } if publishable_token
+          options[:headers] = {}
+          options[:headers]['Accept'] = 'application/json; charset=utf-8'
+          options[:headers]['Content-Type'] = 'application/json; charset=utf-8'
+          options[:headers]['User-Agent'] = user_agent if user_agent
+          options[:headers]['Referer'] = referer if referer
+          options[:proxy] = proxy if proxy
+          options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
 
-        request_options = {}
-        request_options[:timeout] = timeout if timeout
-        request_options[:open_timeout] = open_timeout if open_timeout
-        request_options[:params_encoder] = Faraday::FlatParamsEncoder
-        options[:request] = request_options if request_options.any?
+          request_options = {}
+          request_options[:timeout] = timeout if timeout
+          request_options[:open_timeout] = open_timeout if open_timeout
+          request_options[:params_encoder] = Faraday::FlatParamsEncoder
+          options[:request] = request_options if request_options.any?
 
-        ::Faraday::Connection.new(endpoint, options) do |connection|
-          connection.use ::Faraday::Request::Multipart
-          connection.use ::Faraday::Request::UrlEncoded
-          connection.use ::IEX::Cloud::Response::RaiseError
-          connection.use ::FaradayMiddleware::ParseJson, content_type: /\bjson$/
-          connection.response :logger, logger if logger
-          connection.adapter ::Faraday.default_adapter
+          ::Faraday::Connection.new(endpoint, options) do |connection|
+            connection.use ::Faraday::Request::Multipart
+            connection.use ::Faraday::Request::UrlEncoded
+            connection.use ::IEX::Cloud::Response::RaiseError
+            connection.use ::FaradayMiddleware::ParseJson, content_type: /\bjson$/
+            connection.response(:logger, logger.instance, logger.options, &logger.proc) if logger.instance
+            connection.adapter ::Faraday.default_adapter
+          end
         end
       end
     end

data/lib/iex/cloud/request.rb

@@ -27,7 +27,7 @@ module IEX
             request.url(path, options)
           when :post, :put
             request.path = path
-            request.body = options unless options.empty?
+            request.body = options.to_json unless options.empty?
           end
           request.options.merge!(options.delete(:request)) if options.key?(:request)
         end

data/lib/iex/cloud/response.rb

@@ -5,7 +5,7 @@ module IEX
         def on_complete(env)
           case env[:status]
           when 404
-            raise Faraday::Error::ResourceNotFound, response_values(env)
+            raise Faraday::ResourceNotFound, response_values(env)
           when 403
             raise IEX::Errors::PermissionDeniedError, response_values(env)
           when ClientErrorStatuses

data/lib/iex/endpoints/advanced_stats.rb

@@ -0,0 +1,11 @@
+module IEX
+  module Endpoints
+    module AdvancedStats
+      def advanced_stats(symbol, options = {})
+        IEX::Resources::AdvancedStats.new(get("stock/#{symbol}/advanced-stats", { token: publishable_token }.merge(options)))
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/balance_sheet.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module BalanceSheet
+      def balance_sheet(symbol, options = {})
+        (get("stock/#{symbol}/balance-sheet", { token: publishable_token }.merge(options))['balancesheet'] || []).map do |data|
+          IEX::Resources::BalanceSheet.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/cash_flow.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module CashFlow
+      def cash_flow(symbol, options = {})
+        (get("stock/#{symbol}/cash-flow", { token: publishable_token }.merge(options))['cashflow'] || []).map do |data|
+          IEX::Resources::CashFlow.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/chart.rb

@@ -16,7 +16,7 @@ module IEX
           params[k.to_sym] = v
         end
 
-        response = get(url, params)
+        response = get(url, { token: publishable_token }.merge(params))
 
         if range && range.to_s == 'dynamic'
           range = response['range']

data/lib/iex/endpoints/company.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Company
       def company(symbol, options = {})
-        IEX::Resources::Company.new(get("stock/#{symbol}/company", options))
+        IEX::Resources::Company.new(get("stock/#{symbol}/company", { token: publishable_token }.merge(options)))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end

data/lib/iex/endpoints/crypto.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Crypto
       def crypto(symbol, options = {})
-        IEX::Resources::Crypto.new(get("crypto/#{symbol}/quote", options))
+        IEX::Resources::Crypto.new(get("crypto/#{symbol}/quote", { token: publishable_token }.merge(options)))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end

data/lib/iex/endpoints/dividends.rb

@@ -7,7 +7,7 @@ module IEX
           symbol,
           'dividends',
           range
-        ].compact.join('/'), options).map do |data|
+        ].compact.join('/'), { token: publishable_token }.merge(options)).map do |data|
           IEX::Resources::Dividends.new(data)
         end
       rescue Faraday::ResourceNotFound => e

data/lib/iex/endpoints/earnings.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Earnings
       def earnings(symbol, options = {})
-        get("stock/#{symbol}/earnings", options)['earnings'].map do |data|
+        get("stock/#{symbol}/earnings", { token: publishable_token }.merge(options))['earnings'].map do |data|
           IEX::Resources::Earnings.new(data)
         end
       rescue Faraday::ResourceNotFound => e

data/lib/iex/endpoints/historial_prices.rb

@@ -0,0 +1,30 @@
+module IEX
+  module Endpoints
+    module HistoricalPrices
+      def historical_prices(symbol, options = {})
+        if options[:range] == 'date'
+          raise ArgumentError unless options[:date].present?
+          raise ArgumentError unless options[:chartByDay].present?
+        end
+
+        options = options.dup
+        # Historical prices IEX endpoint expects dates passed in a specific format - YYYYMMDD
+        options[:date] = options[:date].strftime('%Y%m%d') if options[:date].is_a?(Date)
+
+        path = "stock/#{symbol}/chart"
+        path += "/#{options[:range]}" if options.key?(:range)
+        path += "/#{options[:date]}" if options[:range] == 'date'
+
+        # We only want options to include query params at this point, remove :range and :date
+        options.delete(:range)
+        options.delete(:date)
+
+        (get(path, { token: publishable_token }.merge(options)) || []).map do |data|
+          IEX::Resources::HistorialPrices.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/income.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Income
       def income(symbol, options = {})
-        get("stock/#{symbol}/income", options)['income'].map do |data|
+        (get("stock/#{symbol}/income", { token: publishable_token }.merge(options))['income'] || []).map do |data|
           IEX::Resources::Income.new(data)
         end
       rescue Faraday::ResourceNotFound => e

data/lib/iex/endpoints/key_stats.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module KeyStats
       def key_stats(symbol, options = {})
-        IEX::Resources::KeyStats.new(get("stock/#{symbol}/stats", options))
+        IEX::Resources::KeyStats.new(get("stock/#{symbol}/stats", { token: publishable_token }.merge(options)))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end

data/lib/iex/endpoints/largest_trades.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module LargestTrades
       def largest_trades(symbol, options = {})
-        get("stock/#{symbol}/largest-trades", options).map do |data|
+        get("stock/#{symbol}/largest-trades", { token: publishable_token }.merge(options)).map do |data|
           IEX::Resources::LargestTrades.new(data)
         end
       rescue Faraday::ResourceNotFound => e

data/lib/iex/endpoints/logo.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Logo
       def logo(symbol, options = {})
-        IEX::Resources::Logo.new(get("stock/#{symbol.downcase}/logo", options))
+        IEX::Resources::Logo.new(get("stock/#{symbol.downcase}/logo", { token: publishable_token }.merge(options)))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end

data/lib/iex/endpoints/news.rb

@@ -8,7 +8,7 @@ module IEX
           'news',
           range ? 'last' : nil,
           range
-        ].compact.join('/'), options).map do |data|
+        ].compact.join('/'), { token: publishable_token }.merge(options)).map do |data|
           IEX::Resources::News.new(data)
         end
       rescue Faraday::ResourceNotFound => e

data/lib/iex/endpoints/ohlc.rb

@@ -2,13 +2,13 @@ module IEX
   module Endpoints
     module Ohlc
       def ohlc(symbol, options = {})
-        IEX::Resources::OHLC.new(get("stock/#{symbol}/ohlc", options))
+        IEX::Resources::OHLC.new(get("stock/#{symbol}/ohlc", { token: publishable_token }.merge(options)))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end
 
       def market(options = {})
-        Hash[get('stock/market/ohlc', options).map do |k, v|
+        Hash[get('stock/market/ohlc', { token: publishable_token }.merge(options)).map do |k, v|
           [k, IEX::Resources::OHLC.new(v)]
         end]
       end