iex-ruby-client 0.4.4 → 1.0.0

data/spec/iex/client_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe IEX::Api::Client do
+  before do
+    IEX::Api.config.reset!
+  end
+  context 'with defaults' do
+    let(:client) { described_class.new }
+    context '#initialize' do
+      it 'implements endpoint' do
+        expect(client.endpoint).to_not be nil
+      end
+      it 'includes default http configuration' 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 include IEX::VERSION
+      end
+      (IEX::Api::Config::ATTRIBUTES - [:logger]).each do |key|
+        it "sets #{key}" do
+          expect(client.send(key)).to eq IEX::Api::Config.send(key)
+        end
+      end
+    end
+  end
+  context 'with custom settings' do
+    context '#initialize' do
+      IEX::Api::Config::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 eq 'custom'
+          end
+        end
+      end
+    end
+  end
+  context 'global config' do
+    let(:client) { described_class.new }
+    context 'user-agent' do
+      before do
+        IEX::Api.configure do |config|
+          config.user_agent = 'custom/user-agent'
+        end
+      end
+      context '#initialize' do
+        it 'sets user-agent' do
+          expect(client.user_agent).to eq 'custom/user-agent'
+        end
+        it 'creates a connection with the custom user-agent' do
+          expect(client.send(:connection).headers).to include(
+            'Accept' => 'application/json; charset=utf-8',
+            'User-Agent' => 'custom/user-agent'
+          )
+        end
+      end
+    end
+    context 'proxy' do
+      before do
+        IEX::Api.configure do |config|
+          config.proxy = 'http://localhost:8080'
+        end
+      end
+      context '#initialize' do
+        it 'sets proxy' do
+          expect(client.proxy).to eq 'http://localhost:8080'
+        end
+        it 'creates a connection with the proxy' do
+          expect(client.send(:connection).proxy.uri.to_s).to eq 'http://localhost:8080'
+        end
+      end
+    end
+    context 'SSL options' do
+      before do
+        IEX::Api.configure do |config|
+          config.ca_path = '/ca_path'
+          config.ca_file = '/ca_file'
+        end
+      end
+      context '#initialize' do
+        it 'sets ca_path and ca_file' do
+          expect(client.ca_path).to eq '/ca_path'
+          expect(client.ca_file).to eq '/ca_file'
+        end
+        it 'creates a connection with ssl options' do
+          ssl = client.send(:connection).ssl
+          expect(ssl.ca_path).to eq '/ca_path'
+          expect(ssl.ca_file).to eq '/ca_file'
+        end
+      end
+    end
+    context 'logger option' do
+      let(:logger) { Logger.new(STDOUT) }
+      before do
+        IEX::Api.configure do |config|
+          config.logger = logger
+        end
+      end
+      context '#initialize' do
+        it 'sets logger' do
+          expect(client.logger).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
+    end
+    context 'timeout options' do
+      before do
+        IEX::Api.configure do |config|
+          config.timeout = 10
+          config.open_timeout = 15
+        end
+      end
+      context '#initialize' do
+        it 'sets timeout and open_timeout' do
+          expect(client.timeout).to eq 10
+          expect(client.open_timeout).to eq 15
+        end
+        it 'creates a connection with timeout options' do
+          conn = client.send(:connection)
+          expect(conn.options.timeout).to eq 10
+          expect(conn.options.open_timeout).to eq 15
+        end
+      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
+        expect do
+          client.get '/stock/msft/quote'
+        end.to raise_error IEX::Errors::PermissionDeniedError, /The API key provided is not valid./
+      end
+    end
+  end
+end

data/spec/iex/config_spec.rb

@@ -0,0 +1,22 @@
+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

data/spec/iex/{resources → endpoints}/chart_spec.rb

@@ -1,42 +1,44 @@
 require 'spec_helper'
 
 describe IEX::Resources::Chart do
+  include_context 'client'
+
   context 'known symbol', vcr: { cassette_name: 'chart/msft' } do
     subject do
-      IEX::Resources::Chart.get('MSFT')
+      client.chart('MSFT')
     end
     let(:first) { subject.first }
     let(:last) { subject.last }
     it 'retrieves a default chart' do
-      expect(subject.count).to eq 21
+      expect(subject.count).to eq 23
       expect(first).to be_a IEX::Resources::Chart::Default
-      expect(first.label).to eq 'Feb 26'
-      expect(first.change_percent_s).to eq '+1.45%'
-      expect(first.close).to eq 95.42
-      expect(first.date).to eq Date.new(2018, 2, 26)
-      expect(last.label).to eq 'Mar 26'
+      expect(first.label).to eq 'Mar 6'
+      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'
     end
   end
 
   context '1d', vcr: { cassette_name: 'chart/1d' } do
     subject do
-      IEX::Resources::Chart.get('MSFT', '1d')
+      client.chart('MSFT', '1d')
     end
     let(:first) { subject.first }
     let(:last) { subject.last }
     it 'retrieves a 1 day chart' do
-      expect(subject.count).to eq 385
+      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 94.97
-      expect(first.low).to eq 94.76
+      expect(first.high).to eq 119.67
+      expect(first.low).to eq 119.43
       expect(first.minute).to eq '09:30'
     end
   end
 
   context 'with options', vcr: { cassette_name: 'chart/chartInterval' } do
     subject do
-      IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10)
+      client.chart('MSFT', '1d', chart_interval: 10)
     end
     let(:first) { subject.first }
     it 'retrieves a 1 day chart with chartInterval applied' do
@@ -45,33 +47,33 @@ describe IEX::Resources::Chart do
     end
   end
 
-  context 'date', vcr: { cassette_name: 'chart/20180227' } do
+  context 'date', vcr: { cassette_name: 'chart/20190306' } do
     subject do
-      IEX::Resources::Chart.get('MSFT', Date.new(2018, 2, 27))
+      client.chart('MSFT', Date.new(2019, 3, 6))
     end
     let(:first) { subject.first }
-    it 'retrieves a 1 day chart from 2018/2/27' do
+    it 'retrieves a 1 day chart from 2019/3/6' do
       expect(subject.count).to eq 390
       expect(first).to be_a IEX::Resources::Chart::OneDay
-      expect(first.date).to eq Date.new(2018, 2, 27)
+      expect(first.date).to eq Date.new(2019, 3, 6)
     end
   end
 
   context 'dynamic 1m', vcr: { cassette_name: 'chart/dynamic/1m' } do
     subject do
-      IEX::Resources::Chart.get('MSFT', :dynamic)
+      client.chart('MSFT', :dynamic)
     end
     let(:first) { subject.first }
     it 'retrieves a 1m chart from' do
-      expect(subject.count).to eq 21
+      expect(subject.count).to eq 23
       expect(first).to be_a IEX::Resources::Chart::Default
-      expect(first.date).to eq Date.new(2018, 2, 26)
+      expect(first.date).to eq Date.new(2019, 3, 6)
     end
   end
 
   context 'invalid symbol', vcr: { cassette_name: 'chart/invalid' } do
     subject do
-      IEX::Resources::Chart.get('INVALID')
+      client.chart('INVALID')
     end
     it 'fails with SymbolNotFoundError' do
       expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
@@ -80,7 +82,7 @@ describe IEX::Resources::Chart do
 
   context 'with client error', vcr: { cassette_name: 'chart/bad_option' } do
     subject do
-      IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10, bad_option: 'option')
+      client.chart('MSFT', '1d', chart_interval: 10, bad_option: 'option')
     end
 
     it 'fails with ClientError' do

data/spec/iex/{resources → endpoints}/company_spec.rb

@@ -1,25 +1,29 @@
 require 'spec_helper'
 
 describe IEX::Resources::Company do
+  include_context 'client'
+
   context 'known symbol', vcr: { cassette_name: 'company/msft' } do
     subject do
-      IEX::Resources::Company.get('MSFT')
+      client.company('MSFT')
     end
     it 'retrieves company information' do
       expect(subject.symbol).to eq 'MSFT'
       expect(subject.ceo).to eq 'Satya Nadella'
-      expect(subject.company_name).to eq 'Microsoft Corporation'
-      expect(subject.description).to include 'Microsoft Corp is a technology company.'
-      expect(subject.exchange).to eq 'Nasdaq Global Select'
-      expect(subject.industry).to eq 'Application Software'
+      expect(subject.company_name).to eq 'Microsoft Corp.'
+      expect(subject.description).to include 'Develops, manufactures and distributes software products'
+      expect(subject.exchange).to eq 'NASDAQ'
+      expect(subject.industry).to eq 'Packaged Software'
       expect(subject.issue_type).to eq 'cs'
       expect(subject.website).to eq 'http://www.microsoft.com'
-      expect(subject.sector).to eq 'Technology'
+      expect(subject.sector).to eq 'Technology Services'
+      expect(subject.employees).to eq 131_000
+      expect(subject.security_name).to eq 'Microsoft Corporation'
     end
   end
   context 'invalid symbol', vcr: { cassette_name: 'company/invalid' } do
     subject do
-      IEX::Resources::Company.get('INVALID')
+      client.company('INVALID')
     end
     it 'fails with SymbolNotFoundError' do
       expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'

data/spec/iex/endpoints/crypto_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe IEX::Resources::Crypto do
+  include_context 'client'
+
+  context 'gets crypto information', vcr: { cassette_name: 'crypto/btcusdt' } do
+    subject do
+      client.crypto('BTCUSDT')
+    end
+    it 'retrieves real-time information' do
+      expect(subject.symbol).to eq 'BTCUSDT'
+      expect(subject.company_name).to eq 'Bitcoin USD'
+      expect(subject.primary_exchange).to eq 'crypto'
+      expect(subject.sector).to eq 'cryptocurrency'
+      expect(subject.calculation_price).to eq 'realtime'
+      expect(subject.open).to eq 3527.79
+      expect(subject.open_dollar).to eq '$3,527'
+      expect(subject.open_time).to eq 1_548_082_840_296
+      expect(subject.close).to eq 3522.05522498
+      expect(subject.close_dollar).to eq '$3,522'
+      expect(subject.close_time).to eq 1_548_169_240_296
+      expect(subject.high).to eq 3590.51
+      expect(subject.high_dollar).to eq '$3,590'
+      expect(subject.low).to eq 3434.85
+      expect(subject.low_dollar).to eq '$3,434'
+      expect(subject.latest_price).to eq 3563.22
+      expect(subject.latest_price_dollar).to eq '$3,563'
+      expect(subject.latest_source).to eq 'Real time price'
+      expect(subject.latest_time).to eq '10:00:40 AM'
+      expect(subject.latest_update).to eq 1_548_169_240_296
+      expect(subject.latest_volume).to eq 28_053.196533
+      expect(subject.latest_volume_dollar).to eq '$28,053'
+      expect(subject.iex_realtime_price).to eq nil
+      expect(subject.iex_realtime_size).to eq nil
+      expect(subject.iex_last_updated).to eq nil
+      expect(subject.delayed_price).to eq nil
+      expect(subject.delayed_price_time).to eq nil
+      expect(subject.extended_change).to eq nil
+      expect(subject.extended_change_percent).to eq nil
+      expect(subject.extended_price_time).to eq nil
+      expect(subject.previous_close).to eq 3527.79
+      expect(subject.previous_close_dollar).to eq '$3,527'
+      expect(subject.change).to eq 35.43
+      expect(subject.change_percent).to eq 0.01004
+      expect(subject.change_percent_s).to eq '+1.00%'
+      expect(subject.iex_market_percent).to eq nil
+      expect(subject.iex_volume).to eq nil
+      expect(subject.avg_total_volume).to eq nil
+      expect(subject.iex_bid_price).to eq nil
+      expect(subject.iex_bid_size).to eq nil
+      expect(subject.iex_ask_price).to eq nil
+      expect(subject.iex_ask_size).to eq nil
+      expect(subject.market_cap).to eq nil
+      expect(subject.pe_ratio).to eq nil
+      expect(subject.week52_high).to eq nil
+      expect(subject.week52_high_dollar).to eq nil
+      expect(subject.week52_low).to eq nil
+      expect(subject.week52_low_dollar).to eq nil
+      expect(subject.ytd_change).to eq nil
+      expect(subject.bid_price).to eq 3562.94
+      expect(subject.bid_size).to eq 0.061728
+      expect(subject.ask_price).to eq 3563.22
+      expect(subject.ask_size).to eq 0.134326
+    end
+  end
+end

data/spec/iex/{resources → endpoints}/dividends_spec.rb

@@ -1,26 +1,29 @@
 require 'spec_helper'
 
 describe IEX::Resources::Dividends do
+  include_context 'client'
+
   context 'known symbol' do
     context 'with defaults', vcr: { cassette_name: 'dividends/msft' } do
       subject do
-        IEX::Resources::Dividends.get('MSFT', '6m')
+        client.dividends('MSFT', '6m')
       end
       let(:dividends) { subject.first }
       it 'retrieves dividends' do
-        expect(dividends.payment_date).to eq '2018-03-08'
-        expect(dividends.record_date).to eq '2018-02-15'
-        expect(dividends.declared_date).to eq '2017-11-29'
-        expect(dividends.amount_dollar).to eq '$0.42'
-        expect(dividends.flag).to eq ''
-        expect(dividends.type).to eq 'Dividend income'
-        expect(dividends.qualified).to eq 'Q'
-        expect(dividends.indicated).to eq ''
+        expect(dividends.ex_date).to eq '2019-05-15'
+        expect(dividends.payment_date).to eq '2019-06-13'
+        expect(dividends.record_date).to eq '2019-05-16'
+        expect(dividends.declared_date).to eq '2019-03-11'
+        expect(dividends.amount).to eq 0.46
+        expect(dividends.amount_dollar).to eq '$0.46'
+        expect(dividends.currency).to eq 'USD'
+        expect(dividends.description).to eq 'Microsoft Corp. Declares Quarterly Dividend of $0.46 Per Share'
+        expect(dividends.frequency).to eq 'Quarterly'
       end
     end
     context 'without range', vcr: { cassette_name: 'dividends/msft_default_range' } do
       subject do
-        IEX::Resources::Dividends.get('MSFT')
+        client.dividends('MSFT')
       end
       it 'retrieves dividends when no range is passed' do
         expect(subject.size).to eq 1
@@ -28,7 +31,7 @@ describe IEX::Resources::Dividends do
     end
     context 'invalid range', vcr: { cassette_name: 'dividends/msft_invalid_range' } do
       subject do
-        IEX::Resources::Dividends.get('MSFT', 'INVALID')
+        client.dividends('MSFT', 'INVALID')
       end
       let(:dividends) { subject.first }
       it 'retrieves dividends when invalid range is passed' do
@@ -37,16 +40,16 @@ describe IEX::Resources::Dividends do
     end
     context 'with range', vcr: { cassette_name: 'dividends/msft_1y' } do
       subject do
-        IEX::Resources::Dividends.get('MSFT', '1y')
+        client.dividends('MSFT', '1y')
       end
       it 'retrieves dividends with range of 1 year' do
-        expect(subject.size).to eq 4
+        expect(subject.size).to eq 5
       end
     end
   end
   context 'invalid symbol', vcr: { cassette_name: 'dividends/invalid' } do
     subject do
-      IEX::Resources::Dividends.get('INVALID', 'INVALID')
+      client.dividends('INVALID', 'INVALID')
     end
     it 'fails with SymbolNotFoundError' do
       expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'

data/spec/iex/endpoints/earnings_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe IEX::Resources::Earnings do
+  include_context 'client'
+
+  context 'known symbol' do
+    context 'with defaults', vcr: { cassette_name: 'earnings/msft' } do
+      subject do
+        client.earnings('MSFT')
+      end
+      let(:earnings) { subject.first }
+      it 'retrieves earnings' do
+        expect(subject.size).to eq 1
+        expect(earnings.actual_eps).to eq 1.1
+        expect(earnings.consensus_eps).to eq 1.09
+        expect(earnings.announce_time).to eq 'AMC'
+        expect(earnings.number_of_estimates).to eq 29
+        expect(earnings.eps_surprise_dollar).to eq 0.01
+        expect(earnings.eps_report_date).to eq '2019-01-30'
+        expect(earnings.fiscal_period).to eq 'Q4 2018'
+        expect(earnings.fiscal_end_date).to eq '2018-12-31'
+        expect(earnings.year_ago).to eq 0.96
+        expect(earnings.year_ago_change_percent).to eq 0.1458
+        expect(earnings.year_ago_change_percent_s).to eq '+14.58%'
+      end
+    end
+  end
+  context 'invalid symbol', vcr: { cassette_name: 'earnings/invalid' } do
+    subject do
+      client.earnings('INVALID')
+    end
+    it 'fails with SymbolNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
+    end
+  end
+end