iex-ruby-client 0.4.4 → 1.0.0

data/UPGRADING.md

@@ -1,5 +1,58 @@
 Upgrading iex-ruby-client
-===========================
+=========================
+
+### Upgrading to >= 1.0.0
+
+On June 1, 2019, IEX API has been sunset for all non-IEX data. IEX Cloud, a non-Exchange platform, continues to provide access to third-party data sources and requires a token. When upgrading to 1.0.0, create an account and get a `publishable token` from [IEX Cloud Console](https://iexcloud.io).
+
+Set the environment variable `IEX_API_PUBLISHABLE_TOKEN` to the token value, or configure the client via `IEX::Api::Client.new` or `IEX::Api.configure`.
+
+Before:
+
+```ruby
+IEX::Resources::Price.get('MSFT')
+```
+
+After:
+
+```ruby
+client = IEX::Api::Client.new(publishable_token: 'token')
+
+client.price('MSFT')
+```
+
+See [#46](https://github.com/dblock/iex-ruby-client/pull/46) for more information.
+
+### API Changes
+
+The IEX Cloud API has come with a number of changes.
+
+#### Company
+
+* Added `security_name` `employees` properties.
+
+#### Dividends
+
+* Added `ex_date` `currency` `description` `frequency` properties.
+* Removed `flag` `type` `qualified` `indicated` properties.
+
+#### Earnings
+
+* Removed `estimated_eps` `estimated_change_percent` `estimated_change_percent_s` `symbol_id` properties.
+
+#### KeyStats
+
+* Removed `beta` `short_interest` `short_date` `dividend_rate` `latest_eps` `latest_eps_date` `return_on_equity` `consensus_eps` `number_of_estimates` `symbol` `ebitda` `revenue` `revenue_dollar` `gross_profit` `gross_profit_dollar` `cash` `cash_dollar` `dept` `dept_dollar` `revenue_per_share` `revenue_per_employee` `pe_ratio_high` `pe_ratio_low` `eps_surprise_dollar` `eps_surprise_percent` `eps_surprise_percent_s` `return_on_assets` `return_on_capital` `profit_margin` `price_to_sales` `price_to_book` `price_to_sales_dollar` `price_to_book_dollar` `institution_percent` `institution_percent_s` `insider_percent` `insider_percent_s` `short_ratio` properties.
+
+#### News
+
+* Removed market news.
+
+#### Crypto
+
+* Added `crypto` api to get a quote for crypto currency, eg. `client.crypto('BTCUSDT')`.
+
+See [#42](https://github.com/dblock/iex-ruby-client/pull/42) for more information.
 
 ### Upgrading to >= 0.4.0
 
@@ -15,7 +68,7 @@ IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, invalid_option: 'foo
 > Faraday::ClientError: the server responded with status 400
 ```
 
-After: 
+After:
 
 ```ruby
 IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, invalid_option: 'foo')
@@ -23,4 +76,3 @@ IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, invalid_option: 'foo
 ```
 
 See [#9](https://github.com/dblock/iex-ruby-client/pull/9) for more information.
-

data/iex-ruby-client.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'money_helper'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.51.0'
+  s.add_development_dependency 'rubocop', '0.67.2'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 end

data/lib/iex-ruby-client.rb

@@ -6,5 +6,7 @@ require 'money_helper'
 
 require_relative 'iex/version'
 require_relative 'iex/errors'
+require_relative 'iex/logger'
+require_relative 'iex/cloud'
 require_relative 'iex/api'
 require_relative 'iex/resources'

data/lib/iex/api.rb

@@ -1,32 +1,16 @@
-module IEX
-  module Api
-    ROOT_URI = 'https://api.iextrading.com/1.0/stock'.freeze
+require_relative 'endpoints/chart'
+require_relative 'endpoints/company'
+require_relative 'endpoints/dividends'
+require_relative 'endpoints/earnings'
+require_relative 'endpoints/largest_trades'
+require_relative 'endpoints/logo'
+require_relative 'endpoints/key_stats'
+require_relative 'endpoints/news'
+require_relative 'endpoints/ohlc'
+require_relative 'endpoints/price'
+require_relative 'endpoints/quote'
+require_relative 'endpoints/sectors'
+require_relative 'endpoints/crypto'
 
-    def self.default_connection(path)
-      Faraday.new(
-        url: "#{ROOT_URI}/#{path}",
-        request: {
-          params_encoder: Faraday::FlatParamsEncoder
-        }
-      ) do |c|
-        c.use ::FaradayMiddleware::ParseJson
-        c.use Faraday::Response::RaiseError
-        c.use Faraday::Adapter::NetHttp
-      end
-    end
-  end
-end
-
-require_relative 'api/chart'
-require_relative 'api/company'
-require_relative 'api/dividends'
-require_relative 'api/earnings'
-require_relative 'api/largest_trades'
-require_relative 'api/logo'
-require_relative 'api/key_stats'
-require_relative 'api/news'
-require_relative 'api/ohlc'
-require_relative 'api/price'
-require_relative 'api/quote'
-require_relative 'api/sectors'
-require_relative 'api/crypto'
+require_relative 'api/config'
+require_relative 'api/client'

data/lib/iex/api/client.rb

@@ -0,0 +1,30 @@
+module IEX
+  module Api
+    class Client
+      include Endpoints::Chart
+      include Endpoints::Company
+      include Endpoints::Crypto
+      include Endpoints::Dividends
+      include Endpoints::Earnings
+      include Endpoints::KeyStats
+      include Endpoints::LargestTrades
+      include Endpoints::Logo
+      include Endpoints::News
+      include Endpoints::Ohlc
+      include Endpoints::Price
+      include Endpoints::Quote
+      include Endpoints::Sectors
+
+      include Cloud::Connection
+      include Cloud::Request
+
+      include Config
+
+      def initialize(options = {})
+        Config::ATTRIBUTES.each do |key|
+          send("#{key}=", options[key] || IEX::Api.config.send(key))
+        end
+      end
+    end
+  end
+end

data/lib/iex/api/config.rb

@@ -0,0 +1,45 @@
+module IEX
+  module Api
+    module Config
+      extend self
+
+      ATTRIBUTES = %i[
+        proxy
+        user_agent
+        ca_path
+        ca_file
+        logger
+        timeout
+        open_timeout
+        endpoint
+        publishable_token
+      ].freeze
+
+      attr_accessor(*Config::ATTRIBUTES)
+
+      def reset!
+        self.endpoint = 'https://cloud.iexapis.com/v1'
+        self.publishable_token = ENV['IEX_API_PUBLISHABLE_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
+        self.proxy = nil
+        self.logger = nil
+        self.timeout = nil
+        self.open_timeout = nil
+      end
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+IEX::Api::Config.reset!

data/lib/iex/cloud.rb

@@ -0,0 +1,3 @@
+require_relative 'cloud/connection'
+require_relative 'cloud/request'
+require_relative 'cloud/response'

data/lib/iex/cloud/connection.rb

@@ -0,0 +1,37 @@
+module IEX
+  module Cloud
+    module Connection
+      private
+
+      def headers
+        {}
+      end
+
+      def connection
+        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
+
+        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
+        end
+      end
+    end
+  end
+end

data/lib/iex/cloud/request.rb

@@ -0,0 +1,38 @@
+module IEX
+  module Cloud
+    module Request
+      def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      def post(path, options = {})
+        request(:post, path, options)
+      end
+
+      def put(path, options = {})
+        request(:put, path, options)
+      end
+
+      def delete(path, options = {})
+        request(:delete, path, options)
+      end
+
+      private
+
+      def request(method, path, options)
+        path = [endpoint, path].join('/')
+        response = connection.send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+          end
+          request.options.merge!(options.delete(:request)) if options.key?(:request)
+        end
+        response.body
+      end
+    end
+  end
+end

data/lib/iex/cloud/response.rb

@@ -0,0 +1,20 @@
+module IEX
+  module Cloud
+    module Response
+      class RaiseError < ::Faraday::Response::RaiseError
+        def on_complete(env)
+          case env[:status]
+          when 404
+            raise Faraday::Error::ResourceNotFound, response_values(env)
+          when 403
+            raise IEX::Errors::PermissionDeniedError, response_values(env)
+          when ClientErrorStatuses
+            raise IEX::Errors::ClientError, response_values(env)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/iex/endpoints/chart.rb

@@ -0,0 +1,39 @@
+module IEX
+  module Endpoints
+    module Chart
+      def chart(symbol, range = nil, options = {})
+        url = [
+          'stock',
+          symbol,
+          'chart',
+          range && range.respond_to?(:strftime) ? "date/#{range.strftime('%Y%m%d')}" : range
+        ].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
+        end
+
+        response = get(url, params)
+
+        if range && range.to_s == 'dynamic'
+          range = response['range']
+          response = response['data']
+        end
+        response.map do |data|
+          case range
+          when '1d', Date, DateTime
+            IEX::Resources::Chart::OneDay.new data
+          else
+            IEX::Resources::Chart::Default.new data
+          end
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/company.rb

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

data/lib/iex/endpoints/crypto.rb

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

data/lib/iex/endpoints/dividends.rb

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

data/lib/iex/endpoints/earnings.rb

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

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

data/lib/iex/endpoints/largest_trades.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module LargestTrades
+      def largest_trades(symbol, options = {})
+        get("stock/#{symbol}/largest-trades", options).map do |data|
+          IEX::Resources::LargestTrades.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end