iex-ruby-client 1.2.0 → 1.5.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,110 @@
+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'
+      expect(subject.put_call_ratio).to eq 0.36251766583920975
+    end
+
+    it 'retrieves a keyStats' do
+      expect(subject.company_name).to eq 'Microsoft Corp.'
+      expect(subject.market_cap).to eq 1_621_141_983_000
+      expect(subject.market_cap_dollar).to eq '$1,621,141,983,000'
+      expect(subject.employees).to eq 163_000
+    end
+
+    it 'weekly stats' do
+      expect(subject.week_52_high).to eq 232.86
+      expect(subject.week_52_high_dollar).to eq '$232.86'
+      expect(subject.week_52_low).to eq 132.52
+      expect(subject.week_52_low_dollar).to eq '$132.52'
+      expect(subject.week_52_change).to eq 0.533539
+      expect(subject.week_52_change_dollar).to eq '$0.53'
+    end
+
+    it 'general stats' do
+      expect(subject.ttm_dividend_rate).to eq 2.04
+      expect(subject.dividend_yield).to eq 0.009522920362244423
+      expect(subject.ex_dividend_date).to eq '2020-08-19'
+      expect(subject.shares_outstanding).to eq 7_567_650_000
+      expect(subject.float).to eq 7_454_581_741
+      expect(subject.ttm_eps).to eq 5.8207
+      expect(subject.next_dividend_date).to eq '2020-11-18'
+      expect(subject.next_earnings_date).to eq '2020-10-27'
+      expect(subject.pe_ratio).to eq 36.88
+      expect(subject.beta).to eq 1.1472751624864646
+      expect(subject.day_200_moving_avg).to eq 187.72
+      expect(subject.day_50_moving_avg).to eq 212.09
+    end
+
+    it 'changes stats' do
+      expect(subject.avg_10_volume).to be 26_989_991
+      expect(subject.avg_30_volume).to be 31_404_571.1
+      expect(subject.max_change_percent).to eq 7.1248
+      expect(subject.year_5_change_percent).to be 3.3093
+      expect(subject.year_5_change_percent_s).to eq '+330.93%'
+      expect(subject.year_2_change_percent).to eq 1.0108
+      expect(subject.year_2_change_percent_s).to eq '+101.08%'
+      expect(subject.year_1_change_percent).to eq 0.572482
+      expect(subject.year_1_change_percent_s).to eq '+57.25%'
+      expect(subject.ytd_change_percent).to eq 0.367576
+      expect(subject.ytd_change_percent_s).to eq '+36.76%'
+      expect(subject.month_6_change_percent).to eq 0.229899
+      expect(subject.month_6_change_percent_s).to eq '+22.99%'
+      expect(subject.month_3_change_percent).to eq 0.082709
+      expect(subject.month_3_change_percent_s).to eq '+8.27%'
+      expect(subject.month_1_change_percent).to eq 0.082549
+      expect(subject.month_1_change_percent_s).to eq '+8.25%'
+      expect(subject.day_5_change_percent).to eq(-0.007859)
+      expect(subject.day_5_change_percent_s).to eq '-0.79%'
+      expect(subject.day_30_change_percent).to eq 0.025251
+      expect(subject.day_30_change_percent_s).to eq '+2.53%'
+    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/balance_sheet_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe IEX::Resources::BalanceSheet do
+  include_context 'client'
+
+  context 'general information', vcr: { cassette_name: 'balance_sheet/msft' } do
+    subject do
+      client.balance_sheet('MSFT')
+    end
+    let(:balance_sheet) { subject.first }
+
+    it 'fetches balance sheet' do
+      expect(subject.size).to eq 1
+      expect(balance_sheet.report_date).to eq '2020-09-30'
+      expect(balance_sheet.fiscal_date).to eq '2020-09-30'
+      expect(balance_sheet.currency).to eq 'USD'
+      expect(balance_sheet.current_cash).to eq 17_205_000_000
+      expect(balance_sheet.current_cash_dollar).to eq '$17,205,000,000'
+      expect(balance_sheet.short_term_investments).to eq 120_772_000_000
+      expect(balance_sheet.short_term_investments_dollar).to eq '$120,772,000,000'
+      expect(balance_sheet.receivables).to eq 22_851_000_000
+      expect(balance_sheet.receivables_dollar).to eq '$22,851,000,000'
+      expect(balance_sheet.inventory).to eq 2_705_000_000
+      expect(balance_sheet.inventory_dollar).to eq '$2,705,000,000'
+      expect(balance_sheet.other_current_assets).to eq 13_544_000_000
+      expect(balance_sheet.other_current_assets_dollar).to eq '$13,544,000,000'
+      expect(balance_sheet.current_assets).to eq 177_077_000_000
+      expect(balance_sheet.current_assets_dollar).to eq '$177,077,000,000'
+      expect(balance_sheet.long_term_investments).to eq 3_196_000_000
+      expect(balance_sheet.long_term_investments_dollar).to eq '$3,196,000,000'
+      expect(balance_sheet.property_plant_equipment).to eq 56_974_000_000
+      expect(balance_sheet.property_plant_equipment_dollar).to eq '$56,974,000,000'
+      expect(balance_sheet.goodwill).to eq 43_890_000_000
+      expect(balance_sheet.goodwill_dollar).to eq '$43,890,000,000'
+      expect(balance_sheet.intangible_assets).to eq 6_923_000_000
+      expect(balance_sheet.intangible_assets_dollar).to eq '$6,923,000,000'
+      expect(balance_sheet.other_assets).to eq 12_941_000_000
+      expect(balance_sheet.other_assets_dollar).to eq '$12,941,000,000'
+      expect(balance_sheet.total_assets).to eq 301_001_000_000
+      expect(balance_sheet.total_assets_dollar).to eq '$301,001,000,000'
+      expect(balance_sheet.accounts_payable).to eq 12_509_000_000
+      expect(balance_sheet.accounts_payable_dollar).to eq '$12,509,000,000'
+      expect(balance_sheet.current_long_term_debt).to eq 7_093_000_000
+      expect(balance_sheet.current_long_term_debt_dollar).to eq '$7,093,000,000'
+      expect(balance_sheet.other_current_liabilities).to eq 46_326_000_000
+      expect(balance_sheet.other_current_liabilities_dollar).to eq '$46,326,000,000'
+      expect(balance_sheet.total_current_liabilities).to eq 70_056_000_000
+      expect(balance_sheet.total_current_liabilities_dollar).to eq '$70,056,000,000'
+      expect(balance_sheet.long_term_debt).to eq 74_379_000_000
+      expect(balance_sheet.long_term_debt_dollar).to eq '$74,379,000,000'
+      expect(balance_sheet.other_liabilities).to eq 32_987_000_000
+      expect(balance_sheet.other_liabilities_dollar).to eq '$32,987,000,000'
+      expect(balance_sheet.minority_interest).to eq 0
+      expect(balance_sheet.minority_interest_dollar).to eq '$0'
+      expect(balance_sheet.total_liabilities).to eq 177_609_000_000
+      expect(balance_sheet.total_liabilities_dollar).to eq '$177,609,000,000'
+      expect(balance_sheet.common_stock).to eq 7_564_000_000
+      expect(balance_sheet.retained_earnings).to eq 39_193_000_000
+      expect(balance_sheet.retained_earnings_dollar).to eq '$39,193,000,000'
+      expect(balance_sheet.treasury_stock).to eq nil
+      expect(balance_sheet.treasury_stock_dollar).to eq nil
+      expect(balance_sheet.capital_surplus).to eq nil
+      expect(balance_sheet.capital_surplus_dollar).to eq nil
+      expect(balance_sheet.shareholder_equity).to eq 123_392_000_000
+      expect(balance_sheet.shareholder_equity_dollar).to eq '$123,392,000,000'
+      expect(balance_sheet.net_tangible_assets).to eq 17_585_000_000
+      expect(balance_sheet.net_tangible_assets_dollar).to eq '$17,585,000,000'
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'balance_sheet/invalid' } do
+    subject do
+      client.balance_sheet('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/cash_flow_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe IEX::Resources::CashFlow do
+  include_context 'client'
+
+  context 'general information', vcr: { cassette_name: 'cash_flow/msft' } do
+    subject do
+      client.cash_flow('MSFT')
+    end
+    let(:cash_flow) { subject.first }
+
+    it 'fetches cash flow statement' do
+      expect(subject.size).to eq 1
+      expect(cash_flow.report_date).to eq '2020-09-30'
+      expect(cash_flow.fiscal_date).to eq '2020-09-30'
+      expect(cash_flow.currency).to eq 'USD'
+      expect(cash_flow.net_income).to eq 13_893_000_000
+      expect(cash_flow.net_income_dollar).to eq '$13,893,000,000'
+      expect(cash_flow.depreciation).to eq 2_645_000_000
+      expect(cash_flow.depreciation_dollar).to eq '$2,645,000,000'
+      expect(cash_flow.changes_in_receivables).to eq 9_160_000_000
+      expect(cash_flow.changes_in_receivables_dollar).to eq '$9,160,000,000'
+      expect(cash_flow.changes_in_inventories).to eq(-808_000_000)
+      expect(cash_flow.changes_in_inventories_dollar).to eq '$-808,000,000'
+      expect(cash_flow.cash_change).to eq 3_629_000_000
+      expect(cash_flow.cash_change_dollar).to eq '$3,629,000,000'
+      expect(cash_flow.cash_flow).to eq 19_335_000_000
+      expect(cash_flow.cash_flow_dollar).to eq '$19,335,000,000'
+      expect(cash_flow.capital_expenditures).to eq(-4_907_000_000)
+      expect(cash_flow.capital_expenditures_dollar).to eq '$-4,907,000,000'
+      expect(cash_flow.investments).to eq 2_100_000_000
+      expect(cash_flow.investments_dollar).to eq '$2,100,000,000'
+      expect(cash_flow.investing_activity_other).to eq(-2_083_000_000)
+      expect(cash_flow.investing_activity_other_dollar).to eq '$-2,083,000,000'
+      expect(cash_flow.total_investing_cash_flows).to eq(-5_371_000_000)
+      expect(cash_flow.total_investing_cash_flows_dollar).to eq '$-5,371,000,000'
+      expect(cash_flow.dividends_paid).to eq(-3_856_000_000)
+      expect(cash_flow.dividends_paid_dollar).to eq '$-3,856,000,000'
+      expect(cash_flow.net_borrowings).to eq nil
+      expect(cash_flow.net_borrowings_dollar).to eq nil
+      expect(cash_flow.other_financing_cash_flows).to eq(-235_000_000)
+      expect(cash_flow.other_financing_cash_flows_dollar).to eq '$-235,000,000'
+      expect(cash_flow.cash_flow_financing).to eq(-10_289_000_000)
+      expect(cash_flow.cash_flow_financing_dollar).to eq '$-10,289,000,000'
+      expect(cash_flow.exchange_rate_effect).to eq(-46_000_000)
+      expect(cash_flow.exchange_rate_effect_dollar).to eq '$-46,000,000'
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'cash_flow/invalid' } do
+    subject do
+      client.cash_flow('INVALID')
+    end
+
+    it 'fails with SymbolNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
+    end
+  end
+end