Contents

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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
iex-ruby-client-2.1.0	spec/iex/endpoints/key_stat_spec.rb
iex-ruby-client-2.0.0	spec/iex/endpoints/key_stat_spec.rb
iex-ruby-client-1.6.0	spec/iex/endpoints/key_stat_spec.rb
iex-ruby-client-1.5.0	spec/iex/endpoints/key_stat_spec.rb