iex-ruby-client 1.2.0 → 1.5.0

data/spec/iex/endpoints/fx_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe IEX::Endpoints::FX do
+  include_context 'client'
+
+  context 'known symbol', vcr: { cassette_name: 'fx/latest_one_symbol' } do
+    subject do
+      client.fx_latest('USDCAD')
+    end
+    it 'retrieves a list of CurrencyRates' do
+      expect(subject.length).to eq 1
+
+      expect(subject[0].symbol).to eq 'USDCAD'
+      expect(subject[0].rate).to eq 1.25674
+      expect(subject[0].timestamp).to eq Date.strptime('1627045829.863', '%s')
+    end
+  end
+
+  context 'known symbols', vcr: { cassette_name: 'fx/latest' } do
+    subject do
+      client.fx_latest(%w[USDCAD USDGBP USDJPY])
+    end
+    it 'retrieves a list of CurrencyRates' do
+      expect(subject.length).to eq 3
+
+      expect(subject[0].symbol).to eq 'USDCAD'
+      expect(subject[0].rate).to eq 1.25674
+      expect(subject[0].timestamp).to eq Date.strptime('1627045829.863', '%s')
+
+      expect(subject[1].symbol).to eq 'USDGBP'
+      expect(subject[1].rate).to eq 0.7262111386264443
+      expect(subject[1].timestamp).to eq Date.strptime('1627045780.863', '%s')
+
+      expect(subject[2].symbol).to eq 'USDJPY'
+      expect(subject[2].rate).to eq 110.426
+      expect(subject[2].timestamp).to eq Date.strptime('1627045825.365', '%s')
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'fx/invalid' } do
+    subject do
+      client.fx_latest(%w[INVALID])
+    end
+    it 'fails with InvalidSymbolsList' do
+      expect { subject }.to raise_error IEX::Errors::InvalidSymbolsList, 'Invalid symbol list: INVALID'
+    end
+  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,36 +14,38 @@ 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

data/spec/iex/endpoints/key_stat_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe IEX::Endpoints::KeyStat do
+  include_context 'client'
+
+  let(:stat) { 'ttmDividendRate' }
+  let(:symbol) { 'VTI' }
+
+  context 'when asking for a single stat', vcr: { cassette_name: 'key_stat/individual' } do
+    subject { client.key_stat(symbol, stat) }
+
+    it 'returns that stat in the type provided by the API' do
+      expect(subject).to be_within(0.0001).of(2.7887)
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'key_stat/invalid_symbol' } do
+    subject { client.key_stat('INVALID', stat) }
+
+    it 'fails with SymbolNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
+    end
+  end
+
+  context 'invalid stat', vcr: { cassette_name: 'key_stat/invalid_stat' } do
+    subject { client.key_stat(symbol, 'INVALID') }
+
+    it 'fails with StatNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::StatNotFoundError, 'Stat INVALID Not Found'
+    end
+
+    it 'keeps the API response so it can be used if caught' do
+      response = begin
+                   subject
+                 rescue IEX::Errors::StatNotFoundError => e
+                   e.response
+                 end
+
+      expect(response).to be_a(Hash)
+      expect(response).to have_key(stat)
+    end
+  end
+end

data/spec/iex/endpoints/news_spec.rb

@@ -14,6 +14,9 @@ describe IEX::Resources::News do
         expect(news.datetime.to_f).to eq 1_554_412_248.0
         expect(news.headline).to eq "Spotify joins Microsoft's Xbox Game Bar"
         expect(news.related).to eq(['MSFT'])
+        expect(news.image).to eq('https://cloud.iexapis.com/beta/news/image/b8a6ae18-ab19-42e8-b066-d9a9dc111f1f')
+        expect(news.paywalled).to eq(false)
+        expect(news.language).to eq('en')
       end
     end
     context 'with range', vcr: { cassette_name: 'news/msft_7' } do

data/spec/iex/endpoints/ref_data_spec.rb

@@ -9,8 +9,22 @@ describe IEX::Api::Client do
 
       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')
+        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 '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
 
@@ -20,20 +34,25 @@ describe IEX::Api::Client do
       it 'converts ISINs to IEX Cloud symbols mapped by ISIN' do
         expect(subject.keys).to contain_exactly('US0378331005', 'US5949181045')
 
-        expect(subject['US0378331005'].first).to eq('exchange' => 'NAS', 'iex_id' => 'IEX_4D48333344362D52', 'region' => 'US', 'symbol' => 'AAPL')
-        expect(subject['US0378331005'].last).to eq('exchange' => 'ETR', 'iex_id' => 'IEX_464D46474C312D52', 'region' => 'DE', 'symbol' => 'APC-GY')
+        expect(subject['US0378331005'].first).to eq('exchange' => 'NAS', 'iex_id' => 'IEX_4D48333344362D52',
+                                                    'region' => 'US', 'symbol' => 'AAPL')
+        expect(subject['US0378331005'].last).to eq('exchange' => 'ETR', 'iex_id' => 'IEX_464D46474C312D52',
+                                                   'region' => 'DE', 'symbol' => 'APC-GY')
 
-        expect(subject['US5949181045'][0]).to eq('exchange' => 'NAS', 'iex_id' => 'IEX_5038523343322D52', 'region' => 'US', 'symbol' => 'MSFT')
-        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')
+        expect(subject['US5949181045'][0]).to eq('exchange' => 'NAS', 'iex_id' => 'IEX_5038523343322D52',
+                                                 'region' => 'US', 'symbol' => 'MSFT')
+        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
@@ -63,4 +82,30 @@ describe IEX::Api::Client do
       end
     end
   end
+
+  describe '#ref_data_symbols_for_exchange', vcr: { cassette_name: 'ref-data/exchange_symbols' } do
+    subject { client.ref_data_symbols_for_exchange('TSX') }
+
+    it 'retrieves all symbols' do
+      expect(subject.count).to eq 1869
+    end
+
+    context 'first symbol' do
+      subject { client.ref_data_symbols_for_exchange('TSX').first }
+      it 'retrieves a symbol data' do
+        expect(subject.symbol).to eq 'A-CV'
+        expect(subject.exchange).to eq 'TSX'
+        expect(subject.name).to eq 'Armor Minerals Inc'
+        expect(subject.date).to eq Date.parse('2021-05-14')
+        expect(subject.enabled).to eq true
+        expect(subject.enabled?).to eq true
+        expect(subject.type).to eq 'cs'
+        expect(subject.region).to eq 'CA'
+        expect(subject.currency).to eq 'CAD'
+        expect(subject.iex_id).to eq 'IEX_4656374258322D52'
+        expect(subject.figi).to eq 'BBG000V98LH2'
+        expect(subject.cik).to eq '0001682145'
+      end
+    end
+  end
 end