iex-ruby-client 1.2.0 → 1.5.0

data/lib/iex/api.rb

@@ -1,10 +1,16 @@
+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/fx'
+require_relative 'endpoints/historial_prices'
 require_relative 'endpoints/income'
 require_relative 'endpoints/largest_trades'
 require_relative 'endpoints/logo'
+require_relative 'endpoints/key_stat'
 require_relative 'endpoints/key_stats'
 require_relative 'endpoints/news'
 require_relative 'endpoints/ohlc'
@@ -15,5 +21,6 @@ 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,12 +1,21 @@
 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::FX
+      include Endpoints::HistoricalPrices
       include Endpoints::Income
+      include Endpoints::KeyStat
       include Endpoints::KeyStats
       include Endpoints::LargestTrades
       include Endpoints::Logo
@@ -21,12 +30,16 @@ module IEX
       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

@@ -15,6 +15,7 @@ module IEX
           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
 
@@ -29,7 +30,7 @@ module IEX
             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.response(:logger, logger.instance, logger.options, &logger.proc) if logger.instance
             connection.adapter ::Faraday.default_adapter
           end
         end

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/fx.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module FX
+      def fx_latest(symbols, options = {})
+        symbols = Array(symbols)
+        response = get('fx/latest', { token: publishable_token, symbols: symbols.join(',') }.merge(options))
+        response.map { |row| IEX::Resources::CurrencyRate.new(row) }
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::InvalidSymbolsList.new(symbols, 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/key_stat.rb

@@ -0,0 +1,14 @@
+module IEX
+  module Endpoints
+    module KeyStat
+      def key_stat(symbol, stat, options = {})
+        result = get("stock/#{symbol}/stats/#{stat}", { token: publishable_token }.merge(options))
+        raise IEX::Errors::StatNotFoundError.new(stat, result) if result.is_a?(Hash)
+
+        result
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/ref_data.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module RefData
       def ref_data_isin(isins, options = {})
-        response = get('ref-data/isin', { token: publishable_token, isin: isins.join(',') }.merge(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|
@@ -17,6 +17,11 @@ module IEX
         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/errors.rb

@@ -1,3 +1,5 @@
-require_relative 'errors/symbol_not_found_error'
 require_relative 'errors/client_error'
+require_relative 'errors/invalid_symbols_list'
 require_relative 'errors/permission_denied_error'
+require_relative 'errors/stat_not_found_error'
+require_relative 'errors/symbol_not_found_error'

data/lib/iex/errors/invalid_symbols_list.rb

@@ -0,0 +1,14 @@
+module IEX
+  module Errors
+    class InvalidSymbolsList < StandardError
+      attr_reader :symbols
+      attr_reader :response
+
+      def initialize(symbols, response)
+        @response = response
+        @symbols = symbols
+        super "Invalid symbol list: #{symbols.join(',')}"
+      end
+    end
+  end
+end

data/lib/iex/errors/stat_not_found_error.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Errors
+    class StatNotFoundError < StandardError
+      attr_reader :response, :stat
+
+      def initialize(stat, response)
+        @response = response
+        @stat = stat
+        super "Stat #{stat} Not Found"
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -1,9 +1,14 @@
 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/currency_rate'
 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'

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

data/lib/iex/resources/balance_sheet.rb

@@ -0,0 +1,60 @@
+module IEX
+  module Resources
+    class BalanceSheet < Resource
+      property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
+      property 'current_cash', from: 'currentCash'
+      property 'current_cash_dollar', from: 'currentCash', with: ->(v) { to_dollar(amount: v) }
+      property 'short_term_investments', from: 'shortTermInvestments'
+      property 'short_term_investments_dollar', from: 'shortTermInvestments', with: ->(v) { to_dollar(amount: v) }
+      property 'receivables'
+      property 'receivables_dollar', from: 'receivables', with: ->(v) { to_dollar(amount: v) }
+      property 'inventory'
+      property 'inventory_dollar', from: 'inventory', with: ->(v) { to_dollar(amount: v) }
+      property 'other_current_assets', from: 'otherCurrentAssets'
+      property 'other_current_assets_dollar', from: 'otherCurrentAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'current_assets', from: 'currentAssets'
+      property 'current_assets_dollar', from: 'currentAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'long_term_investments', from: 'longTermInvestments'
+      property 'long_term_investments_dollar', from: 'longTermInvestments', with: ->(v) { to_dollar(amount: v) }
+      property 'property_plant_equipment', from: 'propertyPlantEquipment'
+      property 'property_plant_equipment_dollar', from: 'propertyPlantEquipment', with: ->(v) { to_dollar(amount: v) }
+      property 'goodwill'
+      property 'goodwill_dollar', from: 'goodwill', with: ->(v) { to_dollar(amount: v) }
+      property 'intangible_assets', from: 'intangibleAssets'
+      property 'intangible_assets_dollar', from: 'intangibleAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'other_assets', from: 'otherAssets'
+      property 'other_assets_dollar', from: 'otherAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'total_assets', from: 'totalAssets'
+      property 'total_assets_dollar', from: 'totalAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'accounts_payable', from: 'accountsPayable'
+      property 'accounts_payable_dollar', from: 'accountsPayable', with: ->(v) { to_dollar(amount: v) }
+      property 'current_long_term_debt', from: 'currentLongTermDebt'
+      property 'current_long_term_debt_dollar', from: 'currentLongTermDebt', with: ->(v) { to_dollar(amount: v) }
+      property 'other_current_liabilities', from: 'otherCurrentLiabilities'
+      property 'other_current_liabilities_dollar', from: 'otherCurrentLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'total_current_liabilities', from: 'totalCurrentLiabilities'
+      property 'total_current_liabilities_dollar', from: 'totalCurrentLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'long_term_debt', from: 'longTermDebt'
+      property 'long_term_debt_dollar', from: 'longTermDebt', with: ->(v) { to_dollar(amount: v) }
+      property 'other_liabilities', from: 'otherLiabilities'
+      property 'other_liabilities_dollar', from: 'otherLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'minority_interest', from: 'minorityInterest'
+      property 'minority_interest_dollar', from: 'minorityInterest', with: ->(v) { to_dollar(amount: v) }
+      property 'total_liabilities', from: 'totalLiabilities'
+      property 'total_liabilities_dollar', from: 'totalLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'common_stock', from: 'commonStock'
+      property 'retained_earnings', from: 'retainedEarnings'
+      property 'retained_earnings_dollar', from: 'retainedEarnings', with: ->(v) { to_dollar(amount: v) }
+      property 'treasury_stock', from: 'treasuryStock'
+      property 'treasury_stock_dollar', from: 'treasuryStock', with: ->(v) { to_dollar(amount: v) }
+      property 'capital_surplus', from: 'capitalSurplus'
+      property 'capital_surplus_dollar', from: 'capitalSurplus', with: ->(v) { to_dollar(amount: v) }
+      property 'shareholder_equity', from: 'shareholderEquity'
+      property 'shareholder_equity_dollar', from: 'shareholderEquity', with: ->(v) { to_dollar(amount: v) }
+      property 'net_tangible_assets', from: 'netTangibleAssets'
+      property 'net_tangible_assets_dollar', from: 'netTangibleAssets', with: ->(v) { to_dollar(amount: v) }
+    end
+  end
+end