iex-ruby-client 1.1.1 → 1.4.1

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]['Content-Type'] = '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[: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/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/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/ref_data.rb

@@ -0,0 +1,27 @@
+module IEX
+  module Endpoints
+    module RefData
+      def ref_data_isin(isins, options = {})
+        response = get('ref-data/isin', { token: publishable_token, isin: Array(isins).join(',') }.merge(options))
+
+        if response.is_a?(Hash) # mapped option was set
+          response.transform_values do |rows|
+            rows&.map { |row| IEX::Resources::Symbol.new(row) }
+          end
+        else
+          response.map { |row| IEX::Resources::Symbol.new(row) }
+        end
+      end
+
+      def ref_data_symbols(options = {})
+        response = get('ref-data/symbols', { token: publishable_token }.merge(options))
+        response.map { |row| IEX::Resources::Symbols.new(row) }
+      end
+
+      def ref_data_symbols_for_exchange(exchange, options = {})
+        response = get("ref-data/exchange/#{exchange}/symbols", { token: publishable_token }.merge(options))
+        response.map { |row| IEX::Resources::Symbols.new(row) }
+      end
+    end
+  end
+end

data/lib/iex/endpoints/stock_market.rb

@@ -0,0 +1,11 @@
+module IEX
+  module Endpoints
+    module StockMarket
+      def stock_market_list(list_type, options = {})
+        get("stock/market/list/#{list_type}", { token: publishable_token }.merge(options)).map do |data|
+          IEX::Resources::Quote.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -1,9 +1,13 @@
 require_relative 'resources/resource'
 
+require_relative 'resources/advanced_stats'
+require_relative 'resources/balance_sheet'
+require_relative 'resources/cash_flow'
 require_relative 'resources/chart'
 require_relative 'resources/company'
 require_relative 'resources/dividends'
 require_relative 'resources/earnings'
+require_relative 'resources/historical_prices'
 require_relative 'resources/income'
 require_relative 'resources/key_stats'
 require_relative 'resources/largest_trades'
@@ -13,3 +17,5 @@ require_relative 'resources/ohlc'
 require_relative 'resources/quote'
 require_relative 'resources/sectors'
 require_relative 'resources/crypto'
+require_relative 'resources/symbol'
+require_relative 'resources/symbols'

data/lib/iex/resources/advanced_stats.rb

@@ -0,0 +1,84 @@
+module IEX
+  module Resources
+    class AdvancedStats < Resource
+      property 'total_cash', from: 'totalCash'
+      property 'total_cash_dollars', from: 'totalCash', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'current_debt', from: 'currentDebt'
+      property 'current_debt_dollars', from: 'currentDebt', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'revenue'
+      property 'revenue_dollars', from: 'revenue', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'gross_profit', from: 'grossProfit'
+      property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'total_revenue', from: 'totalRevenue'
+      property 'total_revenue_dollar', from: 'totalRevenue', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'ebitda', from: 'EBITDA'
+      property 'ebitda_dollar', from: 'EBITDA', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'revenue_per_share', from: 'revenuePerShare'
+      property 'revenue_per_share_dollars', from: 'revenuePerShare', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'revenue_per_employee', from: 'revenuePerEmployee'
+      property 'revenue_per_employee_dollar', from: 'revenuePerEmployee', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'debt_to_equity', from: 'debtToEquity'
+      property 'profit_margin', from: 'profitMargin'
+      property 'enterprise_value', from: 'enterpriseValue'
+      property 'enterprise_value_dollar', from: 'enterpriseValue', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'enterprise_value_to_revenue', from: 'enterpriseValueToRevenue'
+      property 'price_to_sales', from: 'priceToSales'
+      property 'price_to_sales_dollar', from: 'priceToSales', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'price_to_book', from: 'priceToBook'
+      property 'forward_pe_ratio', from: 'forwardPERatio'
+      property 'pe_high', from: 'peHigh'
+      property 'pe_low', from: 'peLow'
+      property 'peg_ratio', from: 'pegRatio'
+      property 'week_52_high_date', from: 'week52highDate'
+      property 'week_52_low_date', from: 'week52lowDate'
+      property 'beta'
+      property 'put_call_ratio', from: 'putCallRatio'
+      property 'company_name', from: 'companyName'
+      property 'market_cap', from: 'marketcap'
+      property 'market_cap_dollar', from: 'marketcap', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'week_52_high', from: 'week52high'
+      property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
+      property 'week_52_low', from: 'week52low'
+      property 'week_52_low_dollar', from: 'week52low', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
+      property 'week_52_change', from: 'week52change'
+      property 'week_52_change_dollar', from: 'week52change', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
+      property 'dividend_yield', from: 'dividendYield'
+      property 'ex_dividend_date', from: 'exDividendDate'
+      property 'shares_outstanding', from: 'sharesOutstanding'
+      property 'float'
+      property 'ttm_eps', from: 'ttmEPS'
+      property 'day_200_moving_avg', from: 'day200MovingAvg'
+      property 'day_50_moving_avg', from: 'day50MovingAvg'
+      property 'year_5_change_percent', from: 'year5ChangePercent'
+      property 'year_5_change_percent_s', from: 'year5ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'year_2_change_percent', from: 'year2ChangePercent'
+      property 'year_2_change_percent_s', from: 'year2ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'year_1_change_percent', from: 'year1ChangePercent'
+      property 'year_1_change_percent_s', from: 'year1ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'ytd_change_percent', from: 'ytdChangePercent'
+      property 'ytd_change_percent_s', from: 'ytdChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'month_6_change_percent', from: 'month6ChangePercent'
+      property 'month_6_change_percent_s', from: 'month6ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'month_3_change_percent', from: 'month3ChangePercent'
+      property 'month_3_change_percent_s', from: 'month3ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'month_1_change_percent', from: 'month1ChangePercent'
+      property 'month_1_change_percent_s', from: 'month1ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'day_5_change_percent', from: 'day5ChangePercent'
+      property 'day_5_change_percent_s', from: 'day5ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'employees'
+      property 'avg_10_volume', from: 'avg10Volume'
+      property 'avg_30_volume', from: 'avg30Volume'
+      property 'ttm_dividend_rate', from: 'ttmDividendRate'
+      property 'max_change_percent', from: 'maxChangePercent'
+      property 'day_30_change_percent', from: 'day30ChangePercent'
+      property 'day_30_change_percent_s', from: 'day30ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'next_dividend_date', from: 'nextDividendDate'
+      property 'next_earnings_date', from: 'nextEarningsDate'
+      property 'pe_ratio', from: 'peRatio'
+
+      def initialize(data = {})
+        super
+      end
+    end
+  end
+end