iex-ruby-client 1.1.0 → 1.4.0

data/spec/iex/endpoints/key_stats_spec.rb

@@ -19,6 +19,7 @@ describe IEX::Resources::KeyStats do
       expect(subject.week_52_high_dollar).to eq '$136.04'
       expect(subject.week_52_low).to eq 95.92
       expect(subject.week_52_low_dollar).to eq '$95.92'
+      expect(subject.week_52_change).to eq 0.371641
       expect(subject.week_52_change_dollar).to eq '$0.37'
     end
 

data/spec/iex/endpoints/quote_spec.rb

@@ -18,6 +18,8 @@ describe IEX::Resources::Quote do
       expect(subject.week_52_low).to eq 87.73
       expect(subject.change_percent).to eq(-0.00508)
       expect(subject.change_percent_s).to eq '-0.51%'
+      expect(subject.extended_change_percent).to eq(-0.00008)
+      expect(subject.extended_change_percent_s).to eq '-0.01%'
     end
     it 'coerces times' do
       expect(subject.latest_update).to eq 1_554_408_000_193

data/spec/iex/endpoints/ref_data_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe IEX::Api::Client do
+  include_context 'client'
+
+  describe '#ref_data_isin', vcr: { cassette_name: 'ref-data/isin' } do
+    context 'without options' 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
+
+    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
+
+    context 'with mapped option', vcr: { cassette_name: 'ref-data/isin_mapped' } do
+      subject { client.ref_data_isin(%w[US0378331005 US5949181045], mapped: true) }
+
+      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['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) }
+
+      it 'returns nil value for given ISIN' do
+        expect(subject).to eq('WRONG12345' => nil)
+      end
+    end
+  end
+
+  describe '#ref_data_symbols', vcr: { cassette_name: 'ref-data/symbols' } do
+    subject { client.ref_data_symbols }
+
+    it 'retrieves all symbols' do
+      expect(subject.count).to eq 8808
+    end
+
+    context 'first symbol' do
+      subject { client.ref_data_symbols.first }
+      it 'retrieves a symbol data' do
+        expect(subject.symbol).to eq 'A'
+        expect(subject.exchange).to eq 'NYS'
+        expect(subject.name).to eq 'Agilent Technologies Inc.'
+        expect(subject.date).to eq Date.parse('2020-04-30')
+        expect(subject.enabled).to eq true
+        expect(subject.enabled?).to eq true
+        expect(subject.type).to eq 'cs'
+        expect(subject.region).to eq 'US'
+        expect(subject.currency).to eq 'USD'
+        expect(subject.iex_id).to eq 'IEX_46574843354B2D52'
+        expect(subject.figi).to eq 'BBG000C2V3D6'
+        expect(subject.cik).to eq '1090872'
+      end
+    end
+  end
+end

data/spec/iex/endpoints/stock_market_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe IEX::Endpoints::StockMarket do
+  include_context 'client'
+
+  describe '#stock_market_list', vcr: { cassette_name: 'stock_market/list_mostactive' } do
+    subject { client.stock_market_list(:mostactive) }
+
+    it 'retrieves a list of quotes' do
+      expect(subject).to all(be_a(IEX::Resources::Quote))
+      expect(subject.map(&:symbol)).to match_array(%w[AAPL AMD BAC F GE INO INTC MSFT T XOM])
+    end
+  end
+end

data/spec/iex/resources/resource_spec.rb

@@ -37,6 +37,42 @@ describe IEX::Resources::Resource do
     end
   end
 
+  context 'percent to string (Positive)' do
+    subject do
+      IEX::Resources::Resource.percentage_to_string(3.3793)
+    end
+    it 'converts to percentage' do
+      expect(subject).to eq '+3.38%'
+    end
+  end
+
+  context 'percent to string (Negative)' do
+    subject do
+      IEX::Resources::Resource.percentage_to_string(-3.3793)
+    end
+    it 'converts to percentage' do
+      expect(subject).to eq '-3.38%'
+    end
+  end
+
+  context 'percent to string (nil)' do
+    subject do
+      IEX::Resources::Resource.percentage_to_string(nil)
+    end
+    it 'nil argument does not convert' do
+      expect(subject).to eq nil
+    end
+  end
+
+  context 'float number to percent (0)' do
+    subject do
+      IEX::Resources::Resource.percentage_to_string(0)
+    end
+    it 'Zero converts to +0.00%' do
+      expect(subject).to eq '+0.00%'
+    end
+  end
+
   context 'Unformatted money amount to dollar' do
     subject do
       IEX::Resources::Resource.to_dollar(amount: 123_391)

data/spec/spec_helper.rb

@@ -2,11 +2,12 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 
 require 'rubygems'
 require 'rspec'
+require 'dotenv'
 
 require 'iex-ruby-client'
 
-Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].each do |file|
+Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].sort.each do |file|
   require file
 end
 
-ENV['IEX_API_PUBLISHABLE_TOKEN'] ||= 'test-iex-api-publishable-token'
+Dotenv.load('.env', '.env.sample')

data/spec/support/vcr.rb

@@ -6,4 +6,7 @@ VCR.configure do |config|
   config.hook_into :webmock
   # config.default_cassette_options = { record: :new_episodes }
   config.configure_rspec_metadata!
+
+  config.filter_sensitive_data('test-iex-api-publishable-token') { ENV['IEX_API_PUBLISHABLE_TOKEN'] }
+  config.filter_sensitive_data('test-iex-api-secret-token') { ENV['IEX_API_SECRET_TOKEN'] }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iex-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -136,12 +136,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: dblock@dblock.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -160,16 +162,21 @@ files:
 - lib/iex-ruby-client.rb
 - lib/iex/api.rb
 - lib/iex/api/client.rb
-- lib/iex/api/config.rb
+- lib/iex/api/config/client.rb
+- lib/iex/api/config/logger.rb
 - lib/iex/cloud.rb
 - lib/iex/cloud/connection.rb
 - lib/iex/cloud/request.rb
 - lib/iex/cloud/response.rb
+- lib/iex/endpoints/advanced_stats.rb
+- lib/iex/endpoints/balance_sheet.rb
+- lib/iex/endpoints/cash_flow.rb
 - lib/iex/endpoints/chart.rb
 - lib/iex/endpoints/company.rb
 - lib/iex/endpoints/crypto.rb
 - lib/iex/endpoints/dividends.rb
 - lib/iex/endpoints/earnings.rb
+- lib/iex/endpoints/historial_prices.rb
 - lib/iex/endpoints/income.rb
 - lib/iex/endpoints/key_stats.rb
 - lib/iex/endpoints/largest_trades.rb
@@ -178,18 +185,24 @@ files:
 - lib/iex/endpoints/ohlc.rb
 - lib/iex/endpoints/price.rb
 - lib/iex/endpoints/quote.rb
+- lib/iex/endpoints/ref_data.rb
 - lib/iex/endpoints/sectors.rb
+- lib/iex/endpoints/stock_market.rb
 - lib/iex/errors.rb
 - lib/iex/errors/client_error.rb
 - lib/iex/errors/permission_denied_error.rb
 - lib/iex/errors/symbol_not_found_error.rb
 - lib/iex/logger.rb
 - lib/iex/resources.rb
+- lib/iex/resources/advanced_stats.rb
+- lib/iex/resources/balance_sheet.rb
+- lib/iex/resources/cash_flow.rb
 - lib/iex/resources/chart.rb
 - lib/iex/resources/company.rb
 - lib/iex/resources/crypto.rb
 - lib/iex/resources/dividends.rb
 - lib/iex/resources/earnings.rb
+- lib/iex/resources/historical_prices.rb
 - lib/iex/resources/income.rb
 - lib/iex/resources/key_stats.rb
 - lib/iex/resources/largest_trades.rb
@@ -199,7 +212,15 @@ files:
 - lib/iex/resources/quote.rb
 - lib/iex/resources/resource.rb
 - lib/iex/resources/sectors.rb
+- lib/iex/resources/symbol.rb
+- lib/iex/resources/symbols.rb
 - lib/iex/version.rb
+- spec/fixtures/iex/advanced_stats/invalid.yml
+- spec/fixtures/iex/advanced_stats/msft.yml
+- spec/fixtures/iex/balance_sheet/invalid.yml
+- spec/fixtures/iex/balance_sheet/msft.yml
+- spec/fixtures/iex/cash_flow/invalid.yml
+- spec/fixtures/iex/cash_flow/msft.yml
 - spec/fixtures/iex/chart/1d.yml
 - spec/fixtures/iex/chart/20190306.yml
 - spec/fixtures/iex/chart/bad_option.yml
@@ -218,8 +239,17 @@ files:
 - spec/fixtures/iex/dividends/msft_invalid_range.yml
 - spec/fixtures/iex/earnings/invalid.yml
 - spec/fixtures/iex/earnings/msft.yml
+- spec/fixtures/iex/historical_prices/abcd.yml
+- spec/fixtures/iex/historical_prices/invalid.yml
+- spec/fixtures/iex/historical_prices/invalid_date.yml
+- spec/fixtures/iex/historical_prices/invalid_range.yml
+- spec/fixtures/iex/historical_prices/msft.yml
+- spec/fixtures/iex/historical_prices/msft_5d.yml
+- spec/fixtures/iex/historical_prices/msft_date_and_chart_by_day.yml
+- spec/fixtures/iex/historical_prices/msft_specific_date_trimmed.yml
 - spec/fixtures/iex/income/invalid.yml
 - spec/fixtures/iex/income/msft.yml
+- spec/fixtures/iex/income/nsrgy.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/largest-trades/aapl.yml
@@ -234,15 +264,25 @@ files:
 - spec/fixtures/iex/price/msft.yml
 - spec/fixtures/iex/quote/invalid.yml
 - spec/fixtures/iex/quote/msft.yml
+- spec/fixtures/iex/ref-data/isin.yml
+- spec/fixtures/iex/ref-data/isin_mapped.yml
+- spec/fixtures/iex/ref-data/symbols.yml
+- spec/fixtures/iex/ref-data/wrong_isin_mapped.yml
 - spec/fixtures/iex/sectors/invalid.yml
 - spec/fixtures/iex/sectors/sectors-performance.yml
+- spec/fixtures/iex/stock_market/list_mostactive.yml
 - spec/iex/client_spec.rb
-- spec/iex/config_spec.rb
+- spec/iex/config/client_spec.rb
+- spec/iex/config/logger_spec.rb
+- spec/iex/endpoints/advanced_stats_spec.rb
+- spec/iex/endpoints/balance_sheet_spec.rb
+- spec/iex/endpoints/cash_flow_spec.rb
 - spec/iex/endpoints/chart_spec.rb
 - spec/iex/endpoints/company_spec.rb
 - spec/iex/endpoints/crypto_spec.rb
 - spec/iex/endpoints/dividends_spec.rb
 - spec/iex/endpoints/earnings_spec.rb
+- spec/iex/endpoints/historical_prices_spec.rb
 - spec/iex/endpoints/income_spec.rb
 - spec/iex/endpoints/key_stats_spec.rb
 - spec/iex/endpoints/largest_trades_spec.rb
@@ -251,7 +291,9 @@ files:
 - spec/iex/endpoints/ohlc_spec.rb
 - spec/iex/endpoints/price_spec.rb
 - spec/iex/endpoints/quote_spec.rb
+- spec/iex/endpoints/ref_data_spec.rb
 - spec/iex/endpoints/sectors_spec.rb
+- spec/iex/endpoints/stock_market_spec.rb
 - spec/iex/resources/resource_spec.rb
 - spec/iex/version_spec.rb
 - spec/spec_helper.rb
@@ -261,7 +303,7 @@ homepage: http://github.com/dblock/iex-ruby-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,19 +311,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: IEX Finance API Ruby client with support for retrieving stock quotes.
 test_files:
+- spec/fixtures/iex/advanced_stats/invalid.yml
+- spec/fixtures/iex/advanced_stats/msft.yml
+- spec/fixtures/iex/balance_sheet/invalid.yml
+- spec/fixtures/iex/balance_sheet/msft.yml
+- spec/fixtures/iex/cash_flow/invalid.yml
+- spec/fixtures/iex/cash_flow/msft.yml
 - spec/fixtures/iex/chart/1d.yml
 - spec/fixtures/iex/chart/20190306.yml
 - spec/fixtures/iex/chart/bad_option.yml
@@ -300,8 +347,17 @@ test_files:
 - spec/fixtures/iex/dividends/msft_invalid_range.yml
 - spec/fixtures/iex/earnings/invalid.yml
 - spec/fixtures/iex/earnings/msft.yml
+- spec/fixtures/iex/historical_prices/abcd.yml
+- spec/fixtures/iex/historical_prices/invalid.yml
+- spec/fixtures/iex/historical_prices/invalid_date.yml
+- spec/fixtures/iex/historical_prices/invalid_range.yml
+- spec/fixtures/iex/historical_prices/msft.yml
+- spec/fixtures/iex/historical_prices/msft_5d.yml
+- spec/fixtures/iex/historical_prices/msft_date_and_chart_by_day.yml
+- spec/fixtures/iex/historical_prices/msft_specific_date_trimmed.yml
 - spec/fixtures/iex/income/invalid.yml
 - spec/fixtures/iex/income/msft.yml
+- spec/fixtures/iex/income/nsrgy.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/largest-trades/aapl.yml
@@ -316,15 +372,25 @@ test_files:
 - spec/fixtures/iex/price/msft.yml
 - spec/fixtures/iex/quote/invalid.yml
 - spec/fixtures/iex/quote/msft.yml
+- spec/fixtures/iex/ref-data/isin.yml
+- spec/fixtures/iex/ref-data/isin_mapped.yml
+- spec/fixtures/iex/ref-data/symbols.yml
+- spec/fixtures/iex/ref-data/wrong_isin_mapped.yml
 - spec/fixtures/iex/sectors/invalid.yml
 - spec/fixtures/iex/sectors/sectors-performance.yml
+- spec/fixtures/iex/stock_market/list_mostactive.yml
 - spec/iex/client_spec.rb
-- spec/iex/config_spec.rb
+- spec/iex/config/client_spec.rb
+- spec/iex/config/logger_spec.rb
+- spec/iex/endpoints/advanced_stats_spec.rb
+- spec/iex/endpoints/balance_sheet_spec.rb
+- spec/iex/endpoints/cash_flow_spec.rb
 - spec/iex/endpoints/chart_spec.rb
 - spec/iex/endpoints/company_spec.rb
 - spec/iex/endpoints/crypto_spec.rb
 - spec/iex/endpoints/dividends_spec.rb
 - spec/iex/endpoints/earnings_spec.rb
+- spec/iex/endpoints/historical_prices_spec.rb
 - spec/iex/endpoints/income_spec.rb
 - spec/iex/endpoints/key_stats_spec.rb
 - spec/iex/endpoints/largest_trades_spec.rb
@@ -333,7 +399,9 @@ test_files:
 - spec/iex/endpoints/ohlc_spec.rb
 - spec/iex/endpoints/price_spec.rb
 - spec/iex/endpoints/quote_spec.rb
+- spec/iex/endpoints/ref_data_spec.rb
 - spec/iex/endpoints/sectors_spec.rb
+- spec/iex/endpoints/stock_market_spec.rb
 - spec/iex/resources/resource_spec.rb
 - spec/iex/version_spec.rb
 - spec/spec_helper.rb

data/lib/iex/api/config.rb

@@ -1,45 +0,0 @@
-module IEX
-  module Api
-    module Config
-      extend self
-
-      ATTRIBUTES = %i[
-        proxy
-        user_agent
-        ca_path
-        ca_file
-        logger
-        timeout
-        open_timeout
-        endpoint
-        publishable_token
-      ].freeze
-
-      attr_accessor(*Config::ATTRIBUTES)
-
-      def reset!
-        self.endpoint = 'https://cloud.iexapis.com/v1'
-        self.publishable_token = ENV['IEX_API_PUBLISHABLE_TOKEN']
-        self.user_agent = "IEX Ruby Client/#{IEX::VERSION}"
-        self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
-        self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
-        self.proxy = nil
-        self.logger = nil
-        self.timeout = nil
-        self.open_timeout = nil
-      end
-    end
-
-    class << self
-      def configure
-        block_given? ? yield(Config) : Config
-      end
-
-      def config
-        Config
-      end
-    end
-  end
-end
-
-IEX::Api::Config.reset!