iex-ruby-client 1.1.0 → 1.4.0

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

data/spec/iex/endpoints/chart_spec.rb

@@ -12,11 +12,11 @@ describe IEX::Resources::Chart do
     it 'retrieves a default chart' do
       expect(subject.count).to eq 23
       expect(first).to be_a IEX::Resources::Chart::Default
-      expect(first.label).to eq 'Mar 6'
+      expect(first.label).to eq 'Jul 10'
       expect(first.change_percent_s).to eq '0.00%'
-      expect(first.close).to eq 111.75
-      expect(first.date).to eq Date.new(2019, 3, 6)
-      expect(last.label).to eq 'Apr 5'
+      expect(first.close).to eq 137.85
+      expect(first.date).to eq Date.new(2019, 7, 10)
+      expect(last.label).to eq 'Aug 9'
     end
   end
 
@@ -30,8 +30,8 @@ describe IEX::Resources::Chart do
       expect(subject.count).to eq 390
       expect(first).to be_a IEX::Resources::Chart::OneDay
       expect(first.label).to eq '09:30 AM'
-      expect(first.high).to eq 119.67
-      expect(first.low).to eq 119.43
+      expect(first.high).to eq 138.72
+      expect(first.low).to eq 138.5
       expect(first.minute).to eq '09:30'
     end
   end
@@ -67,7 +67,7 @@ describe IEX::Resources::Chart do
     it 'retrieves a 1m chart from' do
       expect(subject.count).to eq 23
       expect(first).to be_a IEX::Resources::Chart::Default
-      expect(first.date).to eq Date.new(2019, 3, 6)
+      expect(first.date).to eq Date.new(2019, 7, 10)
     end
   end
 

data/spec/iex/endpoints/historical_prices_spec.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe IEX::Resources::HistorialPrices do
+  include_context 'client'
+
+  context 'known symbol' do
+    context 'with valid params' do
+      context 'with defaults', vcr: { cassette_name: 'historical_prices/msft' } do
+        subject do
+          client.historical_prices('MSFT')
+        end
+        let(:historical_price) { subject.first }
+
+        it 'retrieves historical prices' do
+          expect(subject.size).to eq 23
+          expect(historical_price.date).to eq '2020-10-07'
+          expect(historical_price.open).to eq 207.06
+          expect(historical_price.open_dollar).to eq '$207.06'
+          expect(historical_price.close).to eq 209.83
+          expect(historical_price.close_dollar).to eq '$209.83'
+          expect(historical_price.high).to eq 210.11
+          expect(historical_price.high_dollar).to eq '$210.11'
+          expect(historical_price.low).to eq 206.72
+          expect(historical_price.low_dollar).to eq '$206.72'
+          expect(historical_price.volume).to eq 25_681_054
+          expect(historical_price.u_open).to eq 207.06
+          expect(historical_price.u_open_dollar).to eq '$207.06'
+          expect(historical_price.u_close).to eq 209.83
+          expect(historical_price.u_close_dollar).to eq '$209.83'
+          expect(historical_price.u_low).to eq 206.72
+          expect(historical_price.u_low_dollar).to eq '$206.72'
+          expect(historical_price.u_high).to eq 210.11
+          expect(historical_price.u_high_dollar).to eq '$210.11'
+          expect(historical_price.u_volume).to eq 25_681_054
+          expect(historical_price.change).to eq 0
+          expect(historical_price.change_percent).to eq 0
+          expect(historical_price.change_percent_s).to eq '+0.00%'
+          expect(historical_price.label).to eq 'Oct 7'
+          expect(historical_price.change_over_time).to eq 0
+          expect(historical_price.change_over_time_s).to eq '+0.00%'
+        end
+      end
+
+      context 'with a valid range provided', vcr: { cassette_name: 'historical_prices/msft_5d' } do
+        subject { client.historical_prices('MSFT', range: '5d') }
+        let(:historical_price) { subject.last }
+
+        it 'retrieves historical prices' do
+          expect(subject.size).to eq 5
+          expect(historical_price.date).to eq '2020-11-10'
+          expect(historical_price.open).to eq 214.50
+          expect(historical_price.open_dollar).to eq '$214.50'
+          expect(historical_price.close).to eq 211.01
+          expect(historical_price.close_dollar).to eq '$211.01'
+          expect(historical_price.high).to eq 216.50
+          expect(historical_price.high_dollar).to eq '$216.50'
+          expect(historical_price.low).to eq 209.72
+          expect(historical_price.low_dollar).to eq '$209.72'
+          expect(historical_price.volume).to eq 44_045_120
+          expect(historical_price.u_open).to eq 214.50
+          expect(historical_price.u_open_dollar).to eq '$214.50'
+          expect(historical_price.u_close).to eq 211.01
+          expect(historical_price.u_close_dollar).to eq '$211.01'
+          expect(historical_price.u_low).to eq 209.72
+          expect(historical_price.u_low_dollar).to eq '$209.72'
+          expect(historical_price.u_high).to eq 216.50
+          expect(historical_price.u_high_dollar).to eq '$216.50'
+          expect(historical_price.u_volume).to eq 44_045_120
+          expect(historical_price.change).to eq(-7.38)
+          expect(historical_price.change_percent).to eq(-3.3793)
+          expect(historical_price.change_percent_s).to eq '-3.38%'
+          expect(historical_price.label).to eq 'Nov 10'
+          expect(historical_price.change_over_time).to eq(-0.024863)
+          expect(historical_price.change_over_time_s).to eq '-0.02%'
+        end
+      end
+
+      context 'with a range provided for a specific date (passed as a Date object) and chartByDay param',
+              vcr: { cassette_name: 'historical_prices/msft_date_and_chart_by_day' } do
+        options = { range: 'date', date: Date.parse('2020-11-10'), chartByDay: 'true' }
+        subject { client.historical_prices('MSFT', options) }
+        let(:historical_price) { subject.first }
+
+        it 'retrieves historical prices' do
+          expect(subject.size).to eq 1
+          expect(historical_price.date).to eq '2020-11-10'
+          expect(historical_price.open).to eq 214.50
+          expect(historical_price.open_dollar).to eq '$214.50'
+          expect(historical_price.close).to eq 211.01
+          expect(historical_price.close_dollar).to eq '$211.01'
+          expect(historical_price.high).to eq 216.50
+          expect(historical_price.high_dollar).to eq '$216.50'
+          expect(historical_price.low).to eq 209.72
+          expect(historical_price.low_dollar).to eq '$209.72'
+          expect(historical_price.volume).to eq 44_045_120
+          expect(historical_price.u_open).to eq 214.50
+          expect(historical_price.u_open_dollar).to eq '$214.50'
+          expect(historical_price.u_close).to eq 211.01
+          expect(historical_price.u_close_dollar).to eq '$211.01'
+          expect(historical_price.u_low).to eq 209.72
+          expect(historical_price.u_low_dollar).to eq '$209.72'
+          expect(historical_price.u_high).to eq 216.50
+          expect(historical_price.u_high_dollar).to eq '$216.50'
+          expect(historical_price.u_volume).to eq 44_045_120
+          expect(historical_price.change).to eq(-7.38)
+          expect(historical_price.change_percent).to eq(-3.3793)
+          expect(historical_price.change_percent_s).to eq '-3.38%'
+          expect(historical_price.label).to eq 'Nov 10'
+          expect(historical_price.change_over_time).to eq(-0.033793)
+          expect(historical_price.change_over_time_s).to eq '-0.03%'
+        end
+      end
+
+      context 'with a range provided for a specific date (passed as a string) and chartByDay param',
+              vcr: { cassette_name: 'historical_prices/msft_date_and_chart_by_day' } do
+        options = { range: 'date', date: '20201110', chartByDay: 'true' }
+        subject { client.historical_prices('MSFT', options) }
+        let(:historical_price) { subject.first }
+
+        it 'retrieves historical prices' do
+          expect(subject.size).to eq 1
+          expect(historical_price.date).to eq '2020-11-10'
+          expect(historical_price.open).to eq 214.50
+          expect(historical_price.open_dollar).to eq '$214.50'
+          expect(historical_price.close).to eq 211.01
+          expect(historical_price.close_dollar).to eq '$211.01'
+          expect(historical_price.high).to eq 216.50
+          expect(historical_price.high_dollar).to eq '$216.50'
+          expect(historical_price.low).to eq 209.72
+          expect(historical_price.low_dollar).to eq '$209.72'
+          expect(historical_price.volume).to eq 44_045_120
+          expect(historical_price.u_open).to eq 214.50
+          expect(historical_price.u_open_dollar).to eq '$214.50'
+          expect(historical_price.u_close).to eq 211.01
+          expect(historical_price.u_close_dollar).to eq '$211.01'
+          expect(historical_price.u_low).to eq 209.72
+          expect(historical_price.u_low_dollar).to eq '$209.72'
+          expect(historical_price.u_high).to eq 216.50
+          expect(historical_price.u_high_dollar).to eq '$216.50'
+          expect(historical_price.u_volume).to eq 44_045_120
+          expect(historical_price.change).to eq(-7.38)
+          expect(historical_price.change_percent).to eq(-3.3793)
+          expect(historical_price.change_percent_s).to eq '-3.38%'
+          expect(historical_price.label).to eq 'Nov 10'
+          expect(historical_price.change_over_time).to eq(-0.033793)
+          expect(historical_price.change_over_time_s).to eq '-0.03%'
+        end
+      end
+    end
+
+    context 'with invalid params' do
+      context 'with an invalid range', vcr: { cassette_name: 'historical_prices/invalid_range' } do
+        subject { client.historical_prices('MSFT', range: 'invalid') }
+
+        it 'fails with ArgumentError' do
+          expect { subject }.to raise_error IEX::Errors::PermissionDeniedError
+        end
+      end
+
+      context "with a range as 'date' but without a date param" do
+        subject { client.historical_prices('MSFT', range: 'date') }
+
+        it 'fails with ArgumentError' do
+          expect { subject }.to raise_error ArgumentError
+        end
+      end
+
+      context "with a range as 'date' but without chartByDay query param" do
+        subject { client.historical_prices('MSFT', range: 'date', date: Date.parse('2020-11-10')) }
+
+        it 'fails with ArgumentError' do
+          expect { subject }.to raise_error ArgumentError
+        end
+      end
+
+      context "with a range as 'date' but without date as a Date object that is incorrectly formatted",
+              vcr: { cassette_name: 'historical_prices/invalid_date' } do
+        subject { client.historical_prices('MSFT', range: 'date', date: '2020-11-10', chartByDay: 'true') }
+
+        it 'fails with ArgumentError' do
+          expect { subject }.to raise_error IEX::Errors::ClientError
+        end
+      end
+    end
+  end
+
+  context 'no result', vcr: { cassette_name: 'historical_prices/abcd' } do
+    subject do
+      client.historical_prices('abcd')
+    end
+    it 'returns empty array' do
+      expect(subject).to eq []
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'historical_prices/invalid' } do
+    subject do
+      client.historical_prices('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/income_spec.rb

@@ -14,43 +14,54 @@ describe IEX::Resources::Income do
 
       it 'retrieves income statement' do
         expect(subject.size).to eq 1
-        expect(income.report_date).to eq '2019-03-31'
-        expect(income.total_revenue).to eq 30_505_000_000
-        expect(income.total_revenue_dollar).to eq '$30,505,000,000'
-        expect(income.cost_of_revenue).to eq 10_170_000_000
-        expect(income.cost_of_revenue_dollar).to eq '$10,170,000,000'
-        expect(income.gross_profit).to eq 20_335_000_000
-        expect(income.gross_profit_dollar).to eq '$20,335,000,000'
-        expect(income.research_and_development).to eq 4_316_000_000
-        expect(income.research_and_development_dollar).to eq '$4,316,000,000'
-        expect(income.selling_general_and_admin).to eq 5_744_000_000
-        expect(income.selling_general_and_admin_dollar).to eq '$5,744,000,000'
-        expect(income.operating_expense).to eq 20_230_000_000
-        expect(income.operating_expense_dollar).to eq '$20,230,000,000'
-        expect(income.operating_income).to eq 10_275_000_000
-        expect(income.operating_income_dollar).to eq '$10,275,000,000'
-        expect(income.other_income_expense_net).to eq 211_000_000
-        expect(income.other_income_expense_net_dollar).to eq '$211,000,000'
-        expect(income.ebit_dollar).to eq '$10,275,000,000'
-        expect(income.ebit).to eq 10_275_000_000
-        expect(income.interest_income).to eq 671_000_000
-        expect(income.interest_income_dollar).to eq '$671,000,000'
-        expect(income.pretax_income).to eq 10_486_000_000
-        expect(income.pretax_income_dollar).to eq '$10,486,000,000'
-        expect(income.income_tax).to eq 1_677_000_000
-        expect(income.income_tax_dollar).to eq '$1,677,000,000'
+        expect(income.report_date).to eq '2020-09-30'
+        expect(income.fiscal_date).to eq '2020-09-30'
+        expect(income.currency).to eq 'USD'
+        expect(income.total_revenue).to eq 37_154_000_000
+        expect(income.total_revenue_dollar).to eq '$37,154,000,000'
+        expect(income.cost_of_revenue).to eq 11_002_000_000
+        expect(income.cost_of_revenue_dollar).to eq '$11,002,000,000'
+        expect(income.gross_profit).to eq 26_152_000_000
+        expect(income.gross_profit_dollar).to eq '$26,152,000,000'
+        expect(income.research_and_development).to eq 4_926_000_000
+        expect(income.research_and_development_dollar).to eq '$4,926,000,000'
+        expect(income.selling_general_and_admin).to eq 5_350_000_000
+        expect(income.selling_general_and_admin_dollar).to eq '$5,350,000,000'
+        expect(income.operating_expense).to eq 21_278_000_000
+        expect(income.operating_expense_dollar).to eq '$21,278,000,000'
+        expect(income.operating_income).to eq 15_876_000_000
+        expect(income.operating_income_dollar).to eq '$15,876,000,000'
+        expect(income.other_income_expense_net).to eq 248_000_000
+        expect(income.other_income_expense_net_dollar).to eq '$248,000,000'
+        expect(income.ebit).to eq 15_876_000_000
+        expect(income.ebit_dollar).to eq '$15,876,000,000'
+        expect(income.interest_income).to eq 589_000_000
+        expect(income.interest_income_dollar).to eq '$589,000,000'
+        expect(income.pretax_income).to eq 16_124_000_000
+        expect(income.pretax_income_dollar).to eq '$16,124,000,000'
+        expect(income.income_tax).to eq 2_231_000_000
+        expect(income.income_tax_dollar).to eq '$2,231,000,000'
         expect(income.minority_interest).to eq 0
-        expect(income.net_income).to eq 8_809_000_000
-        expect(income.net_income_dollar).to eq '$8,809,000,000'
-        expect(income.net_income_basic).to eq 8_809_000_000
-        expect(income.net_income_basic_dollar).to eq '$8,809,000,000'
+        expect(income.net_income).to eq 13_893_000_000
+        expect(income.net_income_dollar).to eq '$13,893,000,000'
+        expect(income.net_income_basic).to eq 13_893_000_000
+        expect(income.net_income_basic_dollar).to eq '$13,893,000,000'
       end
     end
   end
 
+  context 'no result', vcr: { cassette_name: 'income/nsrgy' } do
+    subject do
+      client.income('nsrgy')
+    end
+    it 'returns empty array' do
+      expect(subject).to eq []
+    end
+  end
+
   context 'invalid symbol', vcr: { cassette_name: 'income/invalid' } do
     subject do
-      client.earnings('INVALID')
+      client.income('INVALID')
     end
     it 'fails with SymbolNotFoundError' do
       expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'