iex-ruby-client 1.0.0 → 1.2.0

data/lib/iex/api/client.rb

@@ -6,6 +6,7 @@ module IEX
       include Endpoints::Crypto
       include Endpoints::Dividends
       include Endpoints::Earnings
+      include Endpoints::Income
       include Endpoints::KeyStats
       include Endpoints::LargestTrades
       include Endpoints::Logo
@@ -14,6 +15,8 @@ module IEX
       include Endpoints::Price
       include Endpoints::Quote
       include Endpoints::Sectors
+      include Endpoints::RefData
+      include Endpoints::StockMarket
 
       include Cloud::Connection
       include Cloud::Request

data/lib/iex/api/config.rb

@@ -13,6 +13,7 @@ module IEX
         open_timeout
         endpoint
         publishable_token
+        secret_token
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -20,6 +21,7 @@ module IEX
       def reset!
         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.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
         self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil

data/lib/iex/cloud/connection.rb

@@ -8,28 +8,30 @@ 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[: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 if logger
+            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/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: 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

@@ -4,6 +4,7 @@ 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 +13,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/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

data/lib/iex/resources/company.rb

@@ -12,6 +12,7 @@ module IEX
       property 'issue_type', from: 'issueType' # common issue type of the stock
       property 'sector'
       property 'employees'
+      property 'tags'
     end
   end
 end

data/lib/iex/resources/income.rb

@@ -0,0 +1,36 @@
+module IEX
+  module Resources
+    class Income < Resource
+      property 'report_date', from: 'reportDate'
+      property 'total_revenue', from: 'totalRevenue'
+      property 'total_revenue_dollar', from: 'totalRevenue', with: ->(v) { to_dollar(amount: v) }
+      property 'cost_of_revenue', from: 'costOfRevenue'
+      property 'cost_of_revenue_dollar', from: 'costOfRevenue', with: ->(v) { to_dollar(amount: v) }
+      property 'gross_profit', from: 'grossProfit'
+      property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { to_dollar(amount: v) }
+      property 'research_and_development', from: 'researchAndDevelopment'
+      property 'research_and_development_dollar', from: 'researchAndDevelopment', with: ->(v) { to_dollar(amount: v) }
+      property 'selling_general_and_admin', from: 'sellingGeneralAndAdmin'
+      property 'selling_general_and_admin_dollar', from: 'sellingGeneralAndAdmin', with: ->(v) { to_dollar(amount: v) }
+      property 'operating_expense', from: 'operatingExpense'
+      property 'operating_expense_dollar', from: 'operatingExpense', with: ->(v) { to_dollar(amount: v) }
+      property 'operating_income', from: 'operatingIncome'
+      property 'operating_income_dollar', from: 'operatingIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'other_income_expense_net', from: 'otherIncomeExpenseNet'
+      property 'other_income_expense_net_dollar', from: 'otherIncomeExpenseNet', with: ->(v) { to_dollar(amount: v) }
+      property 'ebit'
+      property 'ebit_dollar', from: 'ebit', with: ->(v) { to_dollar(amount: v) }
+      property 'interest_income', from: 'interestIncome'
+      property 'interest_income_dollar', from: 'interestIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'pretax_income', from: 'pretaxIncome'
+      property 'pretax_income_dollar', from: 'pretaxIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'income_tax', from: 'incomeTax'
+      property 'income_tax_dollar', from: 'incomeTax', with: ->(v) { to_dollar(amount: v) }
+      property 'minority_interest', from: 'minorityInterest'
+      property 'net_income', from: 'netIncome'
+      property 'net_income_dollar', from: 'netIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'net_income_basic', from: 'netIncomeBasic'
+      property 'net_income_basic_dollar', from: 'netIncomeBasic', with: ->(v) { to_dollar(amount: v) }
+    end
+  end
+end

data/lib/iex/resources/key_stats.rb

@@ -3,12 +3,12 @@ module IEX
     class KeyStats < Resource
       property 'company_name', from: 'companyName'
       property 'market_cap', from: 'marketcap'
-      property 'market_cap_dollars', from: 'marketcap', with: ->(v) { Resource.to_dollar(amount: v) }
+      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'
+      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'
@@ -24,6 +24,7 @@ module IEX
       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'
@@ -32,6 +33,17 @@ module IEX
       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'
+      property 'beta'
 
       def initialize(data = {})
         super