iex-ruby-client 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71bec851d78d50e5e8625f18e94212bd3d5825a1bf90a3809258e6ef88dcae34
-  data.tar.gz: b3f668404aada9eb2bcfa7f56767ce51083222c9f40a2fa95f15d005be9ee7ed
+  metadata.gz: b8a4a5e3e694cd4af9310002178f918ed6b6802711860e29780e2bde8f494805
+  data.tar.gz: 415aa05993daba620a4aea9a32aa52d73a8e0b3bdc39fd96296fb655703b2921
 SHA512:
-  metadata.gz: bf29091889a722d957ea6abceb5dc60d761fde868abc4212829c48723fc668870dbad46a75815823224bf324bd466fc917669792b320c85b0a907979b37008cc
-  data.tar.gz: 1222b56a8c47e79cd36b92b124128fa0162f8acbd9aa466f212cd0bc3bbe94036c2cc0c79243e348cf3b65ebb527ba47d46b91850dc8059cd081cab247568971
+  metadata.gz: 43680c128f3354b4f64f485c51ddfed0f94c9a3f25b6be1c16f93a7a3a97534a0e1fa990a85394d92c1aca220410ceea1a9e9f0d061abce8c7e697ef91a022e3
+  data.tar.gz: 3f497b0bdcc8b295b1f370d3185e6768fea91cbafdde5acdf637d8a16b918d0e5fc229eb5bb702eca8d5848388b5803e797cf8c21feb156c895f3c8e1d5d2dd8

data/.env.sample

@@ -0,0 +1,2 @@
+IEX_API_PUBLISHABLE_TOKEN=test-iex-api-publishable-token
+IEX_API_SECRET_TOKEN=test-iex-api-secret-token

data/.rubocop_todo.yml

@@ -11,11 +11,3 @@
 Style/AsciiComments:
   Exclude:
     - 'lib/iex/resources/quote.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, Autocorrect.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
-  Exclude:
-    - 'lib/iex/api/config.rb'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 1.3.0 (2020/10/31)
+
+* [#82](https://github.com/dblock/iex-ruby-client/pull/82): Added `config.referer` to set HTTP `Referer` header. This enables IEX's "Manage domains" domain locking for tokens - [@agrberg](https://github.com/agrberg).
+* [#70](https://github.com/dblock/iex-ruby-client/pull/70): Added support for `ref_data_isin` taking a single `String` parameter - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* [#84](https://github.com/dblock/iex-ruby-client/pull/84): Added support for Advanced Stats API - [@FanaHOVA](https://github.com/fanahova).
+* [#86](https://github.com/dblock/iex-ruby-client/issues/86): Added advanced logger configuration to `config.logger`. Now a hash with keys `:instance, :options, and :proc` can be passed and used directly with Faraday - [@agrberg](https://github.com/agrberg).
+* [#88](https://github.com/dblock/iex-ruby-client/pull/88): Updated logger configuration to work like `Config` class and allow attribute and block based configuration - [@agrberg](https://github.com/agrberg).
+* [#89](https://github.com/dblock/iex-ruby-client/pull/89): Backfill breaking `Config#logger` setting change from [#88](https://github.com/dblock/iex-ruby-client/pull/88) - [@agrberg](https://github.com/agrberg).
+
 ### 1.2.0 (2020/09/01)
 
 * [#78](https://github.com/dblock/iex-ruby-client/pull/78): Added `Quote#extended_change_percent` and `Quote#extended_change_percent_s` properties to Quote - [@reddavis](https://github.com/reddavis).

data/Gemfile

@@ -5,5 +5,6 @@ gemspec
 group :test do
   gem 'danger-changelog', '~> 0.6.0'
   gem 'danger-toc', '~> 0.2.0'
+  gem 'dotenv'
   gem 'pry'
 end

data/README.md

@@ -31,6 +31,7 @@ A Ruby client for the [The IEX Cloud API](https://iexcloud.io/docs/api/).
   - [Get List](#get-list)
   - [Other Requests](#other-requests)
 - [Configuration](#configuration)
+  - [Logging](#logging)
 - [Sandbox Environment](#sandbox-environment)
 - [Errors](#errors)
   - [SymbolNotFound](#symbolnotfound)
@@ -378,10 +379,10 @@ See [#crypto](https://iexcloud.io/docs/api/#crypto) for detailed documentation o
 
 ### ISIN Mapping
 
-Converts ISIN to IEX Cloud symbols.
+Convert ISIN to IEX Cloud symbols.
 
 ```ruby
-symbols = client.ref_data_isin(['US0378331005'])
+symbols = client.ref_data_isin('US0378331005')
 
 symbols.first.exchange # NAS
 symbols.first.iex_id # IEX_4D48333344362D52
@@ -389,6 +390,13 @@ symbols.first.region # US
 symbols.first.symbol # AAPL
 ```
 
+The API also lets you convert multiple ISINs to IEX Cloud symbols.
+
+```ruby
+symbols = client.ref_data_isin(['US0378331005', 'US0378331006'])
+```
+
+
 You can use `mapped: true` option to receive symbols grouped by their ISINs.
 
 ```ruby
@@ -437,7 +445,7 @@ client.post('ref-data/isin', isin: ['US0378331005'], token: 'secret_token') # [{
 You can configure client options globally or directly with a `IEX::Api::Client` instance.
 
 ```ruby
-IEX::Api::Client.configure do |config|
+IEX::Api.configure do |config|
   config.publishable_token = ENV['IEX_API_PUBLISHABLE_TOKEN']
   config.endpoint = 'https://sandbox.iexapis.com/v1' # use sandbox environment
 end
@@ -458,17 +466,42 @@ user_agent          | User-agent, defaults to _IEX Ruby Client/version_.
 proxy               | Optional HTTP proxy.
 ca_path             | Optional SSL certificates path.
 ca_file             | Optional SSL certificates file.
-logger              | Optional `Logger` instance that logs HTTP requests.
+logger              | Optional `Logger` instance or logger configuration to log HTTP requests.
 timeout             | Optional open/read timeout in seconds.
 open_timeout        | Optional connection open timeout in seconds.
 publishable_token   | IEX Cloud API publishable token.
 endpoint            | Defaults to `https://cloud.iexapis.com/v1`.
+referer             | Optional string for HTTP `Referer` header, enables token domain management.
+
+### Logging
+
+Faraday will not log HTTP requests by default. In order to do this you can either provide a `logger` instance or configuration attributes to `IEX::Api::Client`. Configuration allows you to supply the `instance`, `options`, and `proc` to [Faraday](https://lostisland.github.io/faraday/middleware/logger#include-and-exclude-headersbodies).
+
+```ruby
+logger_instance = Logger.new(STDOUT)
+
+IEX::Api.configure do |config|
+  config.logger.instance = logger_instance
+  config.logger.options = { bodies: true }
+  config.logger.proc = proc { |logger| logger.filter(/T?[sp]k_\w+/i, '[REMOVED]') }
+end
+# or
+IEX::Api.logger do |logger|
+  logger.instance = logger_instance
+  logger.options = …
+  logger.proc = …
+end
+# or
+IEX::Api.logger = logger_instance
+# or
+IEX::Api::Client.new(logger: logger_instance)
+```
 
 ## Sandbox Environment
 
 IEX recommends you use a sandbox token and endpoint for testing.
 
-However, please note that data in the IEX sandbox environment is scrambled. Therefore elements such as company and people names, descriptions, tags, and website URLs don't render any coherent data.
+However, please note that data in the IEX sandbox environment is scrambled. Therefore elements such as company and people names, descriptions, tags, and website URLs don't render any coherent data. In addition, results, such as closing market prices and dividend yield, are not accurate and vary on every call.
 
 See [IEX sandbox environment](https://intercom.help/iexcloud/en/articles/2915433-testing-with-the-iex-cloud-sandbox) for more information.
 

data/lib/iex/api.rb

@@ -1,3 +1,4 @@
+require_relative 'endpoints/advanced_stats'
 require_relative 'endpoints/chart'
 require_relative 'endpoints/company'
 require_relative 'endpoints/dividends'
@@ -15,5 +16,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,6 +1,10 @@
 module IEX
   module Api
+    extend Config::Client::Accessor
+    extend Config::Logger::Accessor
+
     class Client
+      include Endpoints::AdvancedStats
       include Endpoints::Chart
       include Endpoints::Company
       include Endpoints::Crypto
@@ -21,12 +25,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/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|

data/lib/iex/resources.rb

@@ -1,5 +1,6 @@
 require_relative 'resources/resource'
 
+require_relative 'resources/advanced_stats'
 require_relative 'resources/chart'
 require_relative 'resources/company'
 require_relative 'resources/dividends'

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

@@ -1,3 +1,3 @@
 module IEX
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/spec/fixtures/iex/advanced_stats/invalid.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/INVALID/advanced-stats?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.2.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 20 Oct 2020 23:57:05 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=aa7b4e3cbfee43e0a6d8075ad7d24f32; Max-Age=43200; Path=/; Expires=Wed,
+        21 Oct 2020 11:57:05 GMT
+      Strict-Transport-Security:
+      - max-age=15768000
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Headers:
+      - Origin, X-Requested-With, Content-Type, Accept, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: Unknown symbol
+  recorded_at: Tue, 20 Oct 2020 23:57:05 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/iex/advanced_stats/msft.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/MSFT/advanced-stats?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.2.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 20 Oct 2020 23:57:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=767762d0898c40be8baf5aaf659ee42b; Max-Age=43200; Path=/; Expires=Wed,
+        21 Oct 2020 11:57:04 GMT
+      Iexcloud-Messages-Used:
+      - '3005'
+      Iexcloud-Premium-Messages-Used:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=15768000
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Headers:
+      - Origin, X-Requested-With, Content-Type, Accept, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: '{"week52change":0.533539,"week52high":232.86,"week52low":132.52,"marketcap":1621141983000,"employees":163000,"day200MovingAvg":187.72,"day50MovingAvg":212.09,"float":7454581741,"avg10Volume":26989991,"avg30Volume":31404571.1,"ttmEPS":5.8207,"ttmDividendRate":2.04,"companyName":"Microsoft
+        Corp.","sharesOutstanding":7567650000,"maxChangePercent":7.1248,"year5ChangePercent":3.3093,"year2ChangePercent":1.0108,"year1ChangePercent":0.572482,"ytdChangePercent":0.367576,"month6ChangePercent":0.229899,"month3ChangePercent":0.082709,"month1ChangePercent":0.082549,"day30ChangePercent":0.025251,"day5ChangePercent":-0.007859,"nextDividendDate":"2020-11-18","dividendYield":0.009522920362244423,"nextEarningsDate":"2020-10-27","exDividendDate":"2020-08-19","peRatio":36.88,"beta":1.1472751624864646,"totalCash":136527000000,"currentDebt":5905000000,"revenue":143015000000,"grossProfit":96937000000,"totalRevenue":143015000000,"EBITDA":65259000000,"revenuePerShare":18.9,"revenuePerEmployee":877392.64,"debtToEquity":0.69,"profitMargin":0.3096248645247002,"enterpriseValue":1607892999000,"enterpriseValueToRevenue":11.24,"priceToSales":11.62,"priceToBook":13.703188252299162,"forwardPERatio":null,"pegRatio":5.6,"peHigh":40.49739130434783,"peLow":23.046956521739133,"week52highDate":"2020-09-02","week52lowDate":"2020-03-23","putCallRatio":0.36251766583920975}'
+  recorded_at: Tue, 20 Oct 2020 23:57:04 GMT
+recorded_with: VCR 6.0.0

data/spec/iex/client_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe IEX::Api::Client do
   before do
     IEX::Api.config.reset!
+    IEX::Api.logger.reset!
   end
   context 'with defaults' do
     let(:client) { described_class.new }
@@ -14,7 +15,7 @@ describe IEX::Api::Client do
         expect(client.user_agent).to eq "IEX Ruby Client/#{IEX::VERSION}"
       end
       it 'sets user-agent' do
-        expect(client.user_agent).to eq IEX::Api::Config.user_agent
+        expect(client.user_agent).to eq IEX::Api::Config::Client.user_agent
         expect(client.user_agent).to include IEX::VERSION
       end
       it 'caches the Faraday connection to allow persistent adapters' do
@@ -22,20 +23,24 @@ describe IEX::Api::Client do
         second = client.send(:connection)
         expect(first).to equal second
       end
-      (IEX::Api::Config::ATTRIBUTES - [:logger]).each do |key|
+      it 'sets a nil logger' do
+        expect(client.logger.instance).to be_nil
+        expect(client.send(:connection).builder.handlers).not_to include(::Faraday::Response::Logger)
+      end
+      IEX::Api::Config::Client::ATTRIBUTES.each do |key|
         it "sets #{key}" do
-          expect(client.send(key)).to eq IEX::Api::Config.send(key)
+          expect(client.send(key)).to eq IEX::Api::Config::Client.send(key)
         end
       end
     end
   end
   context 'with custom settings' do
     context '#initialize' do
-      IEX::Api::Config::ATTRIBUTES.each do |key|
+      IEX::Api::Config::Client::ATTRIBUTES.each do |key|
         context key.to_s do
           let(:client) { described_class.new(key => 'custom') }
           it "sets #{key}" do
-            expect(client.send(key)).to_not eq IEX::Api::Config.send(key)
+            expect(client.send(key)).to_not eq IEX::Api::Config::Client.send(key)
             expect(client.send(key)).to eq 'custom'
           end
         end
@@ -96,22 +101,74 @@ describe IEX::Api::Client do
         end
       end
     end
+
     context 'logger option' do
       let(:logger) { Logger.new(STDOUT) }
-      before do
-        IEX::Api.configure do |config|
-          config.logger = logger
+
+      after { IEX::Api.logger.reset! }
+
+      context 'when assigning an instance' do
+        context '#initialize' do
+          context 'when directly assigning `logger`' do
+            before { IEX::Api.logger = logger }
+
+            it 'sets logger' do
+              expect(client.logger.instance).to eq(logger)
+            end
+
+            it 'creates a connection with a logger' do
+              expect(client.send(:connection).builder.handlers).to include ::Faraday::Response::Logger
+            end
+          end
+
+          context 'when assigning through `configure.logger`' do
+            it 'sets the logger' do
+              IEX::Api.configure.logger = logger
+              expect(client.logger.instance).to eq(logger)
+            end
+          end
+
+          context 'when passing in at initialization' do
+            it 'sets the logger' do
+              client = described_class.new(logger: logger)
+              expect(client.logger.instance).to eq(logger)
+            end
+
+            it 'can overwrite a set logger' do
+              IEX::Api.logger = logger
+              client = described_class.new(logger: nil)
+              expect(client.logger.instance).to be_nil
+            end
+          end
         end
       end
-      context '#initialize' do
-        it 'sets logger' do
-          expect(client.logger).to eq logger
+
+      context 'when assigning a configuration' do
+        let(:opts) { { bodies: true } }
+        let(:proc_arg) { proc {} }
+
+        before do
+          IEX::Api.logger do |log_config|
+            log_config.instance = logger
+            log_config.options = opts
+            log_config.proc = proc_arg
+          end
         end
-        it 'creates a connection with a logger' do
-          expect(client.send(:connection).builder.handlers).to include ::Faraday::Response::Logger
+
+        context '#initialize' do
+          it 'sets logger' do
+            expect(client.logger.instance).to eq logger
+            expect(client.logger.options).to eq opts
+            expect(client.logger.proc).to eq proc_arg
+          end
+
+          it 'creates a connection with a logger' do
+            expect(client.send(:connection).builder.handlers).to include ::Faraday::Response::Logger
+          end
         end
       end
     end
+
     context 'timeout options' do
       before do
         IEX::Api.configure do |config|
@@ -131,6 +188,27 @@ describe IEX::Api::Client do
         end
       end
     end
+
+    context 'when resetting/changing configuration' do
+      before do
+        IEX::Api.configure { |config| config.user_agent = 'custom/user-agent' }
+      end
+
+      it 'does not reset the client' do
+        expect { IEX::Api.config.reset! }.not_to change(client, :user_agent).from('custom/user-agent')
+      end
+
+      it 'effects the next client' do
+        pre_config_client = described_class.new
+        IEX::Api.configure { |config| config.user_agent = 'custom/user-agent-2' }
+        expect(described_class.new.user_agent).not_to eq(pre_config_client.user_agent)
+      end
+
+      it 'should not allow the client to reset' do
+        expect { client.reset! }.to raise_error(NoMethodError)
+      end
+    end
+
     context 'without a token' do
       let(:client) { described_class.new }
       it 'results in an API key error', vcr: { cassette_name: 'client/access_denied' } do

data/spec/iex/config/client_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe IEX::Api::Config::Client do
+  before do
+    IEX::Api.config.reset!
+  end
+  describe '#defaults' do
+    it 'sets endpoint' do
+      expect(IEX::Api.config.endpoint).to eq 'https://cloud.iexapis.com/v1'
+    end
+  end
+  describe '#configure' do
+    before do
+      IEX::Api.configure do |config|
+        config.endpoint = 'updated'
+      end
+    end
+    it 'sets endpoint' do
+      expect(IEX::Api.config.endpoint).to eq 'updated'
+    end
+  end
+
+  context 'when configuring the logger' do
+    after { IEX::Api.configure.logger.reset! }
+
+    let(:logger) { Logger.new(STDOUT) }
+
+    describe '#logger=' do
+      it 'updates IEX::Api.config correctly' do
+        expect do
+          IEX::Api.configure { |config| config.logger = logger }
+        end.to change(IEX::Api.config.logger, :instance).from(nil).to(logger)
+      end
+
+      it 'updates IEX::Api.logger correctly' do
+        expect do
+          IEX::Api.configure { |config| config.logger = logger }
+        end.to change(IEX::Api.logger, :instance).from(nil).to(logger)
+      end
+    end
+
+    describe '#logger' do
+      it 'accesses the current logger' do
+        expect { IEX::Api.logger = logger }
+          .to change(IEX::Api.config.logger, :instance).from(nil).to(logger)
+      end
+    end
+  end
+end

data/spec/iex/config/logger_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe IEX::Api::Config::Logger do
+  after { IEX::Api.logger.reset! }
+
+  describe '#defaults' do
+    it 'sets the default values' do
+      expect(IEX::Api.logger.instance).to be_nil
+      expect(IEX::Api.logger.options).to eq({})
+      expect(IEX::Api.logger.proc).to be_nil
+    end
+  end
+
+  describe '#logger' do
+    let(:logger_instance) { Logger.new(STDOUT) }
+    let(:opts) { { bodies: true } }
+    let(:proc_arg) { proc {} }
+
+    it 'allows setting the instance directly' do
+      expect { IEX::Api.logger = logger_instance }
+        .to change(IEX::Api::Config::Logger, :instance).to(logger_instance)
+    end
+
+    context 'when configuing' do
+      after do
+        expect(IEX::Api.logger.instance).to eq(logger_instance)
+        expect(IEX::Api.logger.options).to eq(opts)
+        expect(IEX::Api.logger.proc).to eq(proc_arg)
+      end
+
+      it 'sets via assignment' do
+        IEX::Api.logger.instance = logger_instance
+        IEX::Api.logger.options = opts
+        IEX::Api.logger.proc = proc_arg
+      end
+
+      it 'sets via block' do
+        IEX::Api.logger do |logger|
+          logger.instance = logger_instance
+          logger.options = opts
+          logger.proc = proc_arg
+        end
+      end
+    end
+  end
+end

data/spec/iex/endpoints/advanced_stats_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe IEX::Resources::AdvancedStats do
+  include_context 'client'
+
+  context 'general information', vcr: { cassette_name: 'advanced_stats/msft' } do
+    subject do
+      client.advanced_stats('MSFT')
+    end
+
+    it 'fetches advanced stats' do
+      expect(subject.total_cash).to eq 136_527_000_000
+      expect(subject.total_cash_dollars).to eq '$136,527,000,000'
+      expect(subject.current_debt).to eq 5_905_000_000
+      expect(subject.current_debt_dollars).to eq '$5,905,000,000'
+      expect(subject.revenue).to eq 143_015_000_000
+      expect(subject.revenue_dollars).to eq '$143,015,000,000'
+      expect(subject.gross_profit).to eq 96_937_000_000
+      expect(subject.gross_profit_dollar).to eq '$96,937,000,000'
+      expect(subject.total_revenue).to eq 143_015_000_000
+      expect(subject.total_revenue_dollar).to eq '$143,015,000,000'
+      expect(subject.ebitda).to eq 65_259_000_000
+      expect(subject.ebitda_dollar).to eq '$65,259,000,000'
+      expect(subject.revenue_per_share).to eq 18.9
+      expect(subject.revenue_per_share_dollars).to eq '$18'
+      expect(subject.revenue_per_employee).to eq 877_392.64
+      expect(subject.revenue_per_employee_dollar).to eq '$877,392'
+      expect(subject.debt_to_equity).to eq 0.69
+      expect(subject.profit_margin).to eq 0.3096248645247002
+      expect(subject.enterprise_value).to eq 1_607_892_999_000
+      expect(subject.enterprise_value_dollar).to eq '$1,607,892,999,000'
+      expect(subject.enterprise_value_to_revenue).to eq 11.24
+      expect(subject.price_to_sales).to eq 11.62
+      expect(subject.price_to_sales_dollar).to eq '$11'
+      expect(subject.price_to_book).to eq 13.703188252299162
+      expect(subject.forward_pe_ratio).to eq nil
+      expect(subject.peg_ratio).to eq 5.6
+      expect(subject.pe_high).to eq 40.49739130434783
+      expect(subject.week_52_high_date).to eq '2020-09-02'
+      expect(subject.pe_low).to eq 23.046956521739133
+      expect(subject.week_52_low_date).to eq '2020-03-23'
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'advanced_stats/invalid' } do
+    subject do
+      client.advanced_stats('INVALID')
+    end
+
+    it 'fails with SymbolNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
+    end
+  end
+end

data/spec/iex/endpoints/ref_data_spec.rb

@@ -14,6 +14,16 @@ describe IEX::Api::Client do
       end
     end
 
+    context 'graciously handle parameter as string', vcr: { cassette_name: 'ref-data/isin' } do
+      subject { client.ref_data_isin('US0378331005') }
+
+      it 'converts ISIN to IEX Cloud symbols' do
+        expect(subject.count).to eq(2)
+        expect(subject.first).to eq('exchange' => 'NAS', 'iex_id' => 'IEX_4D48333344362D52', 'region' => 'US', 'symbol' => 'AAPL')
+        expect(subject.last).to eq('exchange' => 'ETR', 'iex_id' => 'IEX_464D46474C312D52', 'region' => 'DE', 'symbol' => 'APC-GY')
+      end
+    end
+
     context 'with mapped option', vcr: { cassette_name: 'ref-data/isin_mapped' } do
       subject { client.ref_data_isin(%w[US0378331005 US5949181045], mapped: true) }
 
@@ -27,13 +37,13 @@ describe IEX::Api::Client do
         expect(subject['US5949181045'][1]).to eq('exchange' => 'ETR', 'iex_id' => 'IEX_4C42583859482D52', 'region' => 'DE', 'symbol' => 'MSF-GY')
         expect(subject['US5949181045'][2]).to eq('exchange' => 'BRU', 'iex_id' => 'IEX_5833345950432D52', 'region' => 'BE', 'symbol' => 'MSF-BB')
       end
+    end
 
-      context 'with wrong ISIN', vcr: { cassette_name: 'ref-data/wrong_isin_mapped' } do
-        subject { client.ref_data_isin(%w[WRONG12345], mapped: true) }
+    context 'with wrong ISIN', vcr: { cassette_name: 'ref-data/wrong_isin_mapped' } do
+      subject { client.ref_data_isin(%w[WRONG12345], mapped: true) }
 
-        it 'returns nil value for given ISIN' do
-          expect(subject).to eq('WRONG12345' => nil)
-        end
+      it 'returns nil value for given ISIN' do
+        expect(subject).to eq('WRONG12345' => nil)
       end
     end
   end

data/spec/spec_helper.rb

@@ -2,12 +2,12 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 
 require 'rubygems'
 require 'rspec'
+require 'dotenv'
 
 require 'iex-ruby-client'
 
-Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].each do |file|
+Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].sort.each do |file|
   require file
 end
 
-ENV['IEX_API_PUBLISHABLE_TOKEN'] ||= 'test-iex-api-publishable-token'
-ENV['IEX_API_SECRET_TOKEN'] ||= 'test-iex-api-secret-token'
+Dotenv.load('.env', '.env.sample')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iex-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -142,6 +142,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
@@ -161,11 +162,13 @@ files:
 - lib/iex-ruby-client.rb
 - lib/iex/api.rb
 - lib/iex/api/client.rb
-- lib/iex/api/config.rb
+- lib/iex/api/config/client.rb
+- lib/iex/api/config/logger.rb
 - lib/iex/cloud.rb
 - lib/iex/cloud/connection.rb
 - lib/iex/cloud/request.rb
 - lib/iex/cloud/response.rb
+- lib/iex/endpoints/advanced_stats.rb
 - lib/iex/endpoints/chart.rb
 - lib/iex/endpoints/company.rb
 - lib/iex/endpoints/crypto.rb
@@ -188,6 +191,7 @@ files:
 - lib/iex/errors/symbol_not_found_error.rb
 - lib/iex/logger.rb
 - lib/iex/resources.rb
+- lib/iex/resources/advanced_stats.rb
 - lib/iex/resources/chart.rb
 - lib/iex/resources/company.rb
 - lib/iex/resources/crypto.rb
@@ -205,6 +209,8 @@ files:
 - lib/iex/resources/symbol.rb
 - lib/iex/resources/symbols.rb
 - lib/iex/version.rb
+- spec/fixtures/iex/advanced_stats/invalid.yml
+- spec/fixtures/iex/advanced_stats/msft.yml
 - spec/fixtures/iex/chart/1d.yml
 - spec/fixtures/iex/chart/20190306.yml
 - spec/fixtures/iex/chart/bad_option.yml
@@ -248,7 +254,9 @@ files:
 - spec/fixtures/iex/sectors/sectors-performance.yml
 - spec/fixtures/iex/stock_market/list_mostactive.yml
 - spec/iex/client_spec.rb
-- spec/iex/config_spec.rb
+- spec/iex/config/client_spec.rb
+- spec/iex/config/logger_spec.rb
+- spec/iex/endpoints/advanced_stats_spec.rb
 - spec/iex/endpoints/chart_spec.rb
 - spec/iex/endpoints/company_spec.rb
 - spec/iex/endpoints/crypto_spec.rb
@@ -289,11 +297,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: IEX Finance API Ruby client with support for retrieving stock quotes.
 test_files:
+- spec/fixtures/iex/advanced_stats/invalid.yml
+- spec/fixtures/iex/advanced_stats/msft.yml
 - spec/fixtures/iex/chart/1d.yml
 - spec/fixtures/iex/chart/20190306.yml
 - spec/fixtures/iex/chart/bad_option.yml
@@ -337,7 +347,9 @@ test_files:
 - spec/fixtures/iex/sectors/sectors-performance.yml
 - spec/fixtures/iex/stock_market/list_mostactive.yml
 - spec/iex/client_spec.rb
-- spec/iex/config_spec.rb
+- spec/iex/config/client_spec.rb
+- spec/iex/config/logger_spec.rb
+- spec/iex/endpoints/advanced_stats_spec.rb
 - spec/iex/endpoints/chart_spec.rb
 - spec/iex/endpoints/company_spec.rb
 - spec/iex/endpoints/crypto_spec.rb

data/lib/iex/api/config.rb

@@ -1,47 +0,0 @@
-module IEX
-  module Api
-    module Config
-      extend self
-
-      ATTRIBUTES = %i[
-        proxy
-        user_agent
-        ca_path
-        ca_file
-        logger
-        timeout
-        open_timeout
-        endpoint
-        publishable_token
-        secret_token
-      ].freeze
-
-      attr_accessor(*Config::ATTRIBUTES)
-
-      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
-        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/spec/iex/config_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-
-describe IEX::Api::Config do
-  before do
-    IEX::Api.config.reset!
-  end
-  describe '#defaults' do
-    it 'sets endpoint' do
-      expect(IEX::Api.config.endpoint).to eq 'https://cloud.iexapis.com/v1'
-    end
-  end
-  describe '#configure' do
-    before do
-      IEX::Api.configure do |config|
-        config.endpoint = 'updated'
-      end
-    end
-    it 'sets endpoint' do
-      expect(IEX::Api.config.endpoint).to eq 'updated'
-    end
-  end
-end