iex-ruby-client 0.4.4 → 1.0.0

data/lib/iex/endpoints/logo.rb

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

data/lib/iex/endpoints/news.rb

@@ -0,0 +1,19 @@
+module IEX
+  module Endpoints
+    module News
+      def news(symbol, range = nil, options = {})
+        get([
+          'stock',
+          symbol,
+          'news',
+          range ? 'last' : nil,
+          range
+        ].compact.join('/'), options).map do |data|
+          IEX::Resources::News.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/ohlc.rb

@@ -0,0 +1,17 @@
+module IEX
+  module Endpoints
+    module Ohlc
+      def ohlc(symbol, options = {})
+        IEX::Resources::OHLC.new(get("stock/#{symbol}/ohlc", 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|
+          [k, IEX::Resources::OHLC.new(v)]
+        end]
+      end
+    end
+  end
+end

data/lib/iex/endpoints/price.rb

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

data/lib/iex/endpoints/quote.rb

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

data/lib/iex/endpoints/sectors.rb

@@ -0,0 +1,17 @@
+module IEX
+  module Endpoints
+    module Sectors
+      def sectors(symbol, options = {})
+        get([
+          'stock',
+          symbol,
+          'sector-performance'
+        ].compact.join('/'), options).map do |data|
+          IEX::Resources::Sectors.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/errors.rb

@@ -1,2 +1,3 @@
 require_relative 'errors/symbol_not_found_error'
 require_relative 'errors/client_error'
+require_relative 'errors/permission_denied_error'

data/lib/iex/errors/client_error.rb

@@ -5,7 +5,19 @@ module IEX
 
       def initialize(response)
         @response = response
-        super JSON.parse(response[:body])['error']
+        super error
+      end
+
+      def error
+        if body.is_a?(Hash) && body.key?('error')
+          body['error']
+        else
+          body
+        end
+      end
+
+      def body
+        response[:body]
       end
     end
   end

data/lib/iex/errors/permission_denied_error.rb

@@ -0,0 +1,5 @@
+module IEX
+  module Errors
+    class PermissionDeniedError < ClientError; end
+  end
+end

data/lib/iex/logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module IEX
+  class Logger < ::Logger
+    def self.logger
+      @logger ||= begin
+        logger = new STDOUT
+        logger.level = Logger::WARN
+        logger
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -9,7 +9,6 @@ require_relative 'resources/largest_trades'
 require_relative 'resources/logo'
 require_relative 'resources/news'
 require_relative 'resources/ohlc'
-require_relative 'resources/price'
 require_relative 'resources/quote'
 require_relative 'resources/sectors'
 require_relative 'resources/crypto'

data/lib/iex/resources/chart.rb

@@ -1,27 +1,44 @@
-require_relative 'base'
-require_relative 'chart/base'
-require_relative 'chart/one_day'
-require_relative 'chart/default'
-
 module IEX
   module Resources
     module Chart
-      def self.get(stock_symbol, range = nil, options = {})
-        IEX::Resources::Base.symbol(stock_symbol) do
-          response = IEX::Api::Chart.get(stock_symbol, range, options)
-          if range && range.to_s == 'dynamic'
-            range = response['range']
-            response = response['data']
-          end
-          response.map do |data|
-            case range
-            when '1d', Date, DateTime
-              Chart::OneDay.new data
-            else
-              Chart::Default.new data
-            end
-          end
-        end
+      class Base < Resource
+        property 'high'
+        property 'low'
+        property 'volume'
+        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 'change'
+        property 'change_percent', from: 'changePercent'
+        property 'change_percent_s', from: 'changePercent', with: lambda { |v|
+          [
+            v > 0 ? '+' : '',
+            format('%.2f', v),
+            '%'
+          ].join
+        } # change in percent as a String with a leading + or - sign
+        property 'vwap'
+      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

@@ -1,5 +1,3 @@
-require_relative 'base'
-
 module IEX
   module Resources
     class Company < Resource
@@ -10,14 +8,10 @@ module IEX
       property 'website'
       property 'description'
       property 'ceo', from: 'CEO'
+      property 'security_name', from: 'securityName'
       property 'issue_type', from: 'issueType' # common issue type of the stock
       property 'sector'
-
-      def self.get(stock_symbol)
-        Base.symbol(stock_symbol) do
-          new IEX::Api::Company.get(stock_symbol)
-        end
-      end
+      property 'employees'
     end
   end
 end

data/lib/iex/resources/crypto.rb

@@ -1,5 +1,3 @@
-require_relative 'base'
-
 module IEX
   module Resources
     class Crypto < Resource
@@ -9,22 +7,22 @@ module IEX
       property 'sector'
       property 'calculation_price', from: 'calculationPrice'
       property 'open'
-      property 'open_dollar', from: 'open', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'open_dollar', from: 'open', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'open_time', from: 'openTime'
       property 'close'
-      property 'close_dollar', from: 'close', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'close_dollar', from: 'close', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'close_time', from: 'closeTime'
       property 'high'
-      property 'high_dollar', from: 'high', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'high_dollar', from: 'high', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'low'
-      property 'low_dollar', from: 'low', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'low_dollar', from: 'low', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'latest_price', from: 'latestPrice'
-      property 'latest_price_dollar', from: 'latestPrice', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'latest_price_dollar', from: 'latestPrice', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'latest_source', from: 'latestSource'
       property 'latest_time', from: 'latestTime'
       property 'latest_update', from: 'latestUpdate'
       property 'latest_volume', from: 'latestVolume'
-      property 'latest_volume_dollar', from: 'latestVolume', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'latest_volume_dollar', from: 'latestVolume', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'iex_realtime_price', from: 'iexRealtimePrice'
       property 'iex_realtime_size', from: 'iexRealtimeSize'
       property 'iex_last_updated', from: 'iexLastUpdated'
@@ -35,10 +33,10 @@ module IEX
       property 'extended_change_percent', from: 'extendedChangePercent'
       property 'extended_price_time', from: 'extendedPriceTime'
       property 'previous_close', from: 'previousClose'
-      property 'previous_close_dollar', from: 'previousClose', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'previous_close_dollar', from: 'previousClose', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'change'
       property 'change_percent', from: 'changePercent'
-      property 'change_percent_s', from: 'changePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'change_percent_s', from: 'changePercent', with: ->(v) { float_to_percentage(v) }
       property 'iex_market_percent', from: 'iexMarketPercent'
       property 'iex_volume', from: 'iexVolume'
       property 'avg_total_volume', from: 'avgTotalVolume'
@@ -49,20 +47,14 @@ module IEX
       property 'market_cap', from: 'marketCap'
       property 'pe_ratio', from: 'peRatio'
       property 'week52_high', from: 'week52High'
-      property 'week52_high_dollar', from: 'week52High', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'week52_high_dollar', from: 'week52High', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'week52_low', from: 'week52low'
-      property 'week52_low_dollar', from: 'week52low', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'week52_low_dollar', from: 'week52low', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'ytd_change', from: 'ytdChange'
       property 'bid_price', from: 'bidPrice'
       property 'bid_size', from: 'bidSize'
       property 'ask_price', from: 'askPrice'
       property 'ask_size', from: 'askSize'
-
-      def self.get
-        IEX::Api::Crypto.get.map do |data|
-          new data
-        end
-      end
     end
   end
 end

data/lib/iex/resources/dividends.rb

@@ -1,30 +1,20 @@
-require_relative 'base'
-
 module IEX
   module Resources
     class Dividends < Resource
+      property 'ex_date', from: 'exDate'
       property 'payment_date', from: 'paymentDate'
       property 'record_date', from: 'recordDate'
       property 'declared_date', from: 'declaredDate'
       property 'amount'
       property 'amount_dollar'
-      property 'flag'
-      property 'type'
-      property 'qualified'
-      property 'indicated'
+      property 'currency'
+      property 'description'
+      property 'frequency'
 
       def initialize(data)
         super
         # TODO: require Hashie >= 2.5.8, see https://github.com/intridea/hashie/pull/457
-        self['amount_dollar'] = Base.to_dollar(amount: amount, ignore_cents: false)
-      end
-
-      def self.get(stock_symbol, range = nil)
-        Base.symbol(stock_symbol) do
-          IEX::Api::Dividends.get(stock_symbol, range).map do |data|
-            new data
-          end
-        end
+        self['amount_dollar'] = Resource.to_dollar(amount: amount, ignore_cents: false)
       end
     end
   end

data/lib/iex/resources/earnings.rb

@@ -1,11 +1,8 @@
-require_relative 'base'
-
 module IEX
   module Resources
     class Earnings < Resource
       property 'actual_eps', from: 'actualEPS'
       property 'consensus_eps', from: 'consensusEPS'
-      property 'estimated_eps', from: 'estimatedEPS'
       property 'announce_time', from: 'announceTime'
       property 'number_of_estimates', from: 'numberOfEstimates'
       property 'eps_surprise_dollar', from: 'EPSSurpriseDollar'
@@ -14,18 +11,7 @@ module IEX
       property 'fiscal_end_date', from: 'fiscalEndDate'
       property 'year_ago', from: 'yearAgo'
       property 'year_ago_change_percent', from: 'yearAgoChangePercent'
-      property 'year_ago_change_percent_s', from: 'yearAgoChangePercent', with: ->(v) { Base.float_to_percentage(v) }
-      property 'estimated_change_percent', from: 'estimatedChangePercent'
-      property 'estimated_change_percent_s', from: 'estimatedChangePercent', with: ->(v) { Base.float_to_percentage(v) }
-      property 'symbol_id', from: 'symbolId'
-
-      def self.get(stock_symbol)
-        Base.symbol(stock_symbol) do
-          IEX::Api::Earnings.get(stock_symbol)['earnings'].map do |data|
-            new data
-          end
-        end
-      end
+      property 'year_ago_change_percent_s', from: 'yearAgoChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
     end
   end
 end

data/lib/iex/resources/key_stats.rb

@@ -3,84 +3,38 @@ module IEX
     class KeyStats < Resource
       property 'company_name', from: 'companyName'
       property 'market_cap', from: 'marketcap'
-      property 'market_cap_dollars', from: 'marketcap', with: ->(v) { Base.to_dollar(amount: v) }
-      property 'beta'
+      property 'market_cap_dollars', from: 'marketcap', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'week_52_high', from: 'week52high'
-      property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
+      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) { Base.to_dollar(amount: v, ignore_cents: false) }
+      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_dollar', from: 'week52change', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
-      property 'short_interest', from: 'shortInterest'
-      property 'short_date', from: 'shortDate'
-      property 'dividend_rate', from: 'dividendRate'
+      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 'latest_eps', from: 'latestEPS'
-      property 'latest_eps_date', from: 'latestEPSDate'
       property 'shares_outstanding', from: 'sharesOutstanding'
       property 'float'
-      property 'return_on_equity', from: 'returnOnEquity'
-      property 'consensus_eps', from: 'consensusEPS'
-      property 'number_of_estimates', from: 'numberOfEstimates'
-      property 'symbol'
-      property 'ebitda', from: 'EBITDA'
-      property 'revenue'
-      property 'revenue_dollar'
-      property 'gross_profit', from: 'grossProfit'
-      property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { Base.to_dollar(amount: v) }
-      property 'cash'
-      property 'cash_dollar', from: 'cash', with: ->(v) { Base.to_dollar(amount: v) }
-      property 'dept'
-      property 'dept_dollar', from: 'dept', with: ->(v) { Base.to_dollar(amount: v) }
       property 'ttm_eps', from: 'ttmEPS'
-      property 'revenue_per_share', from: 'revenuePerShare'
-      property 'revenue_per_employee', from: 'revenuePerEmployee'
-      property 'pe_ratio_high', from: 'peRatioHigh'
-      property 'pe_ratio_low', from: 'peRatioLow'
-      property 'eps_surprise_dollar', from: 'EPSSurpriseDollar'
-      property 'eps_surprise_percent', from: 'EPSSurprisePercent'
-      property 'eps_surprise_percent_s', from: 'EPSSurprisePercent', with: ->(v) { Base.float_to_percentage(v) }
-      property 'return_on_assets', from: 'returnOnAssets'
-      property 'return_on_capital', from: 'returnOnCapital'
-      property 'profit_margin', from: 'profitMargin'
-      property 'price_to_sales', from: 'priceToSales'
-      property 'price_to_book', from: 'priceToBook'
-      property 'price_to_sales_dollar', from: 'priceToSales', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
-      property 'price_to_book_dollar', from: 'priceToBook', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
       property 'day_200_moving_avg', from: 'day200MovingAvg'
       property 'day_50_moving_avg', from: 'day50MovingAvg'
-      property 'institution_percent', from: 'institutionPercent'
-      property 'institution_percent_s', from: 'institutionPercent', with: ->(v) { Base.float_to_percentage(v) }
-      property 'insider_percent', from: 'insiderPercent'
-      property 'insider_percent_s', from: 'insiderPercent', with: ->(v) { Base.float_to_percentage(v) }
-      property 'short_ratio', from: 'shortRatio'
       property 'year_5_change_percent', from: 'year5ChangePercent'
-      property 'year_5_change_percent_s', from: 'year5ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      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) { Base.float_to_percentage(v) }
+      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) { Base.float_to_percentage(v) }
+      property 'year_1_change_percent_s', from: 'year1ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
       property 'ytd_change_percent', from: 'ytdChangePercent'
       property 'month_6_change_percent', from: 'month6ChangePercent'
-      property 'month_6_change_percent_s', from: 'month6ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      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) { Base.float_to_percentage(v) }
+      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) { Base.float_to_percentage(v) }
+      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) { Base.float_to_percentage(v) }
+      property 'day_5_change_percent_s', from: 'day5ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
 
       def initialize(data = {})
         super
-        # TODO: require Hashie >= 2.5.8, see https://github.com/intridea/hashie/pull/457
-        self['revenue_dollar'] = Base.to_dollar(amount: revenue)
-      end
-
-      def self.get(symbol)
-        new IEX::Api::KeyStats.get(symbol)
-      rescue Faraday::ResourceNotFound => e
-        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end
     end
   end