iex-ruby-client 1.0.1 → 1.3.0

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

@@ -10,14 +10,13 @@ module IEX
         ].compact.join('/')
 
         params = {}
-        if options
-          options.each_pair do |k, v|
-            k = k.to_s.split('_').map(&:capitalize).join.sub(/^[A-Z]/, &:downcase)
-            params[k.to_sym] = v
-          end
+
+        options&.each_pair do |k, v|
+          k = k.to_s.split('_').map(&:capitalize).join.sub(/^[A-Z]/, &:downcase)
+          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/income.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module Income
+      def income(symbol, options = {})
+        (get("stock/#{symbol}/income", { token: publishable_token }.merge(options))['income'] || []).map do |data|
+          IEX::Resources::Income.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_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

data/lib/iex/endpoints/price.rb

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

data/lib/iex/endpoints/quote.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Quote
       def quote(symbol, options = {})
-        IEX::Resources::Quote.new(get("stock/#{symbol}/quote", options))
+        IEX::Resources::Quote.new(get("stock/#{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/ref_data.rb

@@ -0,0 +1,22 @@
+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
+    end
+  end
+end

data/lib/iex/endpoints/sectors.rb

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

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,11 @@
 require_relative 'resources/resource'
 
+require_relative 'resources/advanced_stats'
 require_relative 'resources/chart'
 require_relative 'resources/company'
 require_relative 'resources/dividends'
 require_relative 'resources/earnings'
+require_relative 'resources/income'
 require_relative 'resources/key_stats'
 require_relative 'resources/largest_trades'
 require_relative 'resources/logo'
@@ -12,3 +14,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,42 @@
+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 'avg_30_volume', from: 'avg30Volume'
+      property 'peg_ratio', from: 'pegRatio'
+      property 'week_52_high_date', from: 'week52highDate'
+      property 'week_52_low_date', from: 'week52lowDate'
+      property 'beta'
+
+      def initialize(data = {})
+        super
+      end
+    end
+  end
+end

data/lib/iex/resources/chart.rb

@@ -5,40 +5,35 @@ module IEX
         property 'high'
         property 'low'
         property 'volume'
+        property 'open'
+        property 'close'
         property 'label'
-        property 'change_over_time', from: 'changeOverTime'
         property 'date', transform_with: ->(v) { Date.parse(v) }
       end
 
       class Default < Base
-        property 'open'
-        property 'close'
-        property 'unadjusted_volume', from: 'unadjustedVolume'
+        property 'u_high', from: 'uHigh'
+        property 'u_low', from: 'uLow'
+        property 'u_volume', from: 'uVolume'
+        property 'u_open', from: 'uOpen'
+        property 'u_close', from: 'uClose'
         property 'change'
         property 'change_percent', from: 'changePercent'
         property 'change_percent_s', from: 'changePercent', with: lambda { |v|
           [
-            v > 0 ? '+' : '',
+            v.positive? ? '+' : '',
             format('%.2f', v),
             '%'
           ].join
         } # change in percent as a String with a leading + or - sign
-        property 'vwap'
+        property 'change_over_time', from: 'changeOverTime'
       end
 
       class OneDay < Base
         property 'minute'
-        property 'market_average', from: 'marketAverage'
-        property 'market_notional', from: 'marketNotional'
-        property 'market_number_of_trades', from: 'marketNumberOfTrades'
-        property 'market_high', from: 'marketHigh'
-        property 'market_low', from: 'marketLow'
-        property 'market_volume', from: 'marketVolume'
-        property 'market_change_over_time', from: 'marketChangeOverTime'
         property 'average'
         property 'notional'
         property 'number_of_trades', from: 'numberOfTrades'
-        property 'simplify_factor', from: 'simplifyFactor'
       end
     end
   end