iex-ruby-client 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd85bc6a798e1c37eb803200aed631db1d1ff3fb6090714cceb01bb5d12c6c9f
-  data.tar.gz: 0e483fa9cf10d511714de9563034309c463278931628d077c580a33bbdbf32d0
+  metadata.gz: ab2cf9c9b5a300629e51b810e4f556ba5d3113a226faa0b2a9293be2939cdb24
+  data.tar.gz: cbab6366388a36eddac8a9e55c4eb4e9e5254cd883f0fe135bdb63d7e359f137
 SHA512:
-  metadata.gz: fe22b477b65f4ade43d1c0f9b44c07dc99664744f4d8fc0081aec8b29053e54c06d3c290e47a27a37c8452c81557f5d2c371d39e936ecd19d5ac0dbd68cd2124
-  data.tar.gz: 14b3664d77a34096534dc9c46fadfa8f7056c7d8bfe82bd5264ee390817363619ccc7de809e1bd8c80e9d7d5cce04e8e5d33b1f8ab8d88f86cf81d1f40e59027
+  metadata.gz: 3a08d8c90fdc3a1ac756321711a76d2b65f01d8c5935b160125fcb41751452da65588d5b29ab1f3f000026171c61ceafdb9ce270af62c342c701512e83a706e0
+  data.tar.gz: b6cbac7f892c7e1ce514cb5906180d60d73b66b5a80edb777eb7ac754fad309b9ce8745b08e8ce1c5f4cc27c109f84b558025f70bc53b754c1ef2e0ac4ccd3e4

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 .DS_Store
 .bundle
 .idea
+.irbrc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.5.0 (2021/08/15)
+* [#105](https://github.com/dblock/iex-ruby-client/pull/105): Added support for fetching latest foreign exchange rates - [@mathu97](https://github.com/mathu97).
+* [#106](https://github.com/dblock/iex-ruby-client/pull/106): Added support for fetching a single key stat with `key_stat(symbol, stat)` endpoint - [@agrberg](https://github.com/agrberg).
+* [#107](https://github.com/dblock/iex-ruby-client/pull/107): Added `./script/console` for ease of local development - [@agrberg](https://github.com/agrberg).
+
 ### 1.4.1 (2021/05/15)
 * [#103](https://github.com/dblock/iex-ruby-client/pull/103): Added support for fetching symbols for an exchange - [@mathu97](https://github.com/mathu97).
 * [#99](https://github.com/dblock/iex-ruby-client/pull/99): Added `image` and `paywalled` to news - [@reddavis](https://github.com/reddavis).

data/README.md

@@ -33,6 +33,7 @@ A Ruby client for the [The IEX Cloud API](https://iexcloud.io/docs/api/).
   - [ISIN Mapping](#isin-mapping)
   - [Get Symbols](#get-symbols)
   - [Get Symbols for an Exchange](#get-symbols-for-an-exchange)
+  - [Get Latest Foreign Exchange Rates](#get-latest-foreign-exchange-rates)
   - [Get List](#get-list)
   - [Other Requests](#other-requests)
 - [Configuration](#configuration)
@@ -157,23 +158,23 @@ NOTE: If you use the `date` value for the `range` parameter:
 This is a complicated endpoint as there is a lot of granularity over the time period of data returned. See below for a variety of ways to request data, NOTE: this is _NOT_ as exhaustive list.
 
 ```ruby
-historial_prices = client.historical_prices('MSFT') # One month of data
-historial_prices = client.historical_prices('MSFT', {range: 'max'}) # All data up to 15 years
-historial_prices = client.historical_prices('MSFT', {range: 'ytd'}) # Year to date data
-historial_prices = client.historical_prices('MSFT', {range: '5y'}) # 5 years of data
-historial_prices = client.historical_prices('MSFT', {range: '6m'}) # 6 months of data
-historial_prices = client.historical_prices('MSFT', {range: '5d'}) # 5 days of data
-historial_prices = client.historical_prices('MSFT', {range: 'date', date: '20200930', chartByDay: 'true'}) # One day of data
-historial_prices = client.historical_prices('MSFT', {range: 'date', date: Date.parse('2020-09-30'), chartByDay: 'true'}) # One day of data
+historical_prices = client.historical_prices('MSFT') # One month of data
+historical_prices = client.historical_prices('MSFT', {range: 'max'}) # All data up to 15 years
+historical_prices = client.historical_prices('MSFT', {range: 'ytd'}) # Year to date data
+historical_prices = client.historical_prices('MSFT', {range: '5y'}) # 5 years of data
+historical_prices = client.historical_prices('MSFT', {range: '6m'}) # 6 months of data
+historical_prices = client.historical_prices('MSFT', {range: '5d'}) # 5 days of data
+historical_prices = client.historical_prices('MSFT', {range: 'date', date: '20200930', chartByDay: 'true'}) # One day of data
+historical_prices = client.historical_prices('MSFT', {range: 'date', date: Date.parse('2020-09-30'), chartByDay: 'true'}) # One day of data
 ...
 ```
 
 Once you have the data over the preferred time period, you can access the following fields
 
 ```ruby
-historial_prices = client.historical_prices('MSFT') # One month of data
+historical_prices = client.historical_prices('MSFT') # One month of data
 
-historial_price = historial_prices.first
+historical_price = historical_prices.first
 historical_price.date # 2020-10-07
 historical_price.open #207.06
 historical_price.open_dollar # '$207.06'
@@ -322,6 +323,12 @@ key_stats.pe_ratio # 29.47
 key_stats.beta # 1.4135449089973444
 ```
 
+You can also fetch a single stat for a symbol. **Note** that IEX uses `lowerCamelCase` for the names of the stats.
+
+```ruby
+client.key_stat('VTI', 'dividendYield') # 0.01271760965303361
+```
+
 See [#key-stats](https://iexcloud.io/docs/api/#key-stats) for detailed documentation or [key_stats.rb](lib/iex/resources/key_stats.rb) for returned fields.
 
 ### Get Advanced Stats
@@ -555,7 +562,7 @@ See [#ISIN Mapping](https://iexcloud.io/docs/api/#isin-mapping) for detailed doc
 
 ### Get Symbols
 
-Returns an array of symbols
+Returns an array of symbols.
 
 ```ruby
 symbols = client.ref_data_symbols()
@@ -571,7 +578,7 @@ See [#symbols](https://iexcloud.io/docs/api/#symbols) for detailed documentation
 
 ### Get Symbols for an Exchange
 
-Returns an array of symbols for a given exchange
+Returns an array of symbols for a given exchange.
 
 ```ruby
 symbols = client.ref_data_symbols_for_exchange('TSX')
@@ -583,7 +590,22 @@ symbol.region # CA
 symbol.symbol # A-CV
 ```
 
-See [#international-symbols](https://iexcloud.io/docs/api/#international-symbols).
+See [#international-symbols](https://iexcloud.io/docs/api/#international-symbols) for returned fields.
+
+### Get Latest Foreign Exchange Rates
+
+Returns an array of foreign exchange rates for a given list of symbols.
+
+```ruby
+rates = client.fx_latest(['USDCAD', 'USDGBP', 'USDJPY'])
+
+rate = rates.first
+rate.symbol # USDCAD
+rate.rate # 1.25674
+rate.timestamp # <Date: 2021-07-23 ((2459419j,0s,0n),+0s,2299161j)>
+```
+
+See [#latest-currency-rates](https://iexcloud.io/docs/api/#latest-currency-rates) for returned fields.
 
 ### Get List
 

data/RELEASING.md

@@ -11,7 +11,7 @@ bundle install
 rake
 ```
 
-Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/iex-ruby-client) for all supported platforms.
+Check that the last build succeeded in [Travis CI](https://travis-ci.com/github/dblock/iex-ruby-client) for all supported platforms.
 
 Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
 

data/lib/iex/api.rb

@@ -5,10 +5,12 @@ require_relative 'endpoints/chart'
 require_relative 'endpoints/company'
 require_relative 'endpoints/dividends'
 require_relative 'endpoints/earnings'
+require_relative 'endpoints/fx'
 require_relative 'endpoints/historial_prices'
 require_relative 'endpoints/income'
 require_relative 'endpoints/largest_trades'
 require_relative 'endpoints/logo'
+require_relative 'endpoints/key_stat'
 require_relative 'endpoints/key_stats'
 require_relative 'endpoints/news'
 require_relative 'endpoints/ohlc'

data/lib/iex/api/client.rb

@@ -12,8 +12,10 @@ module IEX
       include Endpoints::Crypto
       include Endpoints::Dividends
       include Endpoints::Earnings
+      include Endpoints::FX
       include Endpoints::HistoricalPrices
       include Endpoints::Income
+      include Endpoints::KeyStat
       include Endpoints::KeyStats
       include Endpoints::LargestTrades
       include Endpoints::Logo

data/lib/iex/endpoints/fx.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module FX
+      def fx_latest(symbols, options = {})
+        symbols = Array(symbols)
+        response = get('fx/latest', { token: publishable_token, symbols: symbols.join(',') }.merge(options))
+        response.map { |row| IEX::Resources::CurrencyRate.new(row) }
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::InvalidSymbolsList.new(symbols, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/endpoints/key_stat.rb

@@ -0,0 +1,14 @@
+module IEX
+  module Endpoints
+    module KeyStat
+      def key_stat(symbol, stat, options = {})
+        result = get("stock/#{symbol}/stats/#{stat}", { token: publishable_token }.merge(options))
+        raise IEX::Errors::StatNotFoundError.new(stat, result) if result.is_a?(Hash)
+
+        result
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/errors.rb

@@ -1,3 +1,5 @@
-require_relative 'errors/symbol_not_found_error'
 require_relative 'errors/client_error'
+require_relative 'errors/invalid_symbols_list'
 require_relative 'errors/permission_denied_error'
+require_relative 'errors/stat_not_found_error'
+require_relative 'errors/symbol_not_found_error'

data/lib/iex/errors/invalid_symbols_list.rb

@@ -0,0 +1,14 @@
+module IEX
+  module Errors
+    class InvalidSymbolsList < StandardError
+      attr_reader :symbols
+      attr_reader :response
+
+      def initialize(symbols, response)
+        @response = response
+        @symbols = symbols
+        super "Invalid symbol list: #{symbols.join(',')}"
+      end
+    end
+  end
+end

data/lib/iex/errors/stat_not_found_error.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Errors
+    class StatNotFoundError < StandardError
+      attr_reader :response, :stat
+
+      def initialize(stat, response)
+        @response = response
+        @stat = stat
+        super "Stat #{stat} Not Found"
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -4,6 +4,7 @@ require_relative 'resources/advanced_stats'
 require_relative 'resources/balance_sheet'
 require_relative 'resources/cash_flow'
 require_relative 'resources/chart'
+require_relative 'resources/currency_rate'
 require_relative 'resources/company'
 require_relative 'resources/dividends'
 require_relative 'resources/earnings'

data/lib/iex/resources/currency_rate.rb

@@ -0,0 +1,9 @@
+module IEX
+  module Resources
+    class CurrencyRate < Resource
+      property 'symbol'
+      property 'rate'
+      property 'timestamp', transform_with: ->(v) { Date.strptime((v.to_f / 1000).to_s, '%s') }
+    end
+  end
+end

data/lib/iex/version.rb

@@ -1,3 +1,3 @@
 module IEX
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/script/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << './lib'
+
+require 'dotenv/load'
+require 'iex-ruby-client'
+require 'irb'
+
+IRB.start

data/spec/fixtures/iex/fx/invalid.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://cloud.iexapis.com/v1/fx/latest?symbols=INVALID&token=test-iex-api-publishable-token
+      body:
+        encoding: US-ASCII
+        string: ""
+      headers:
+        User-Agent:
+          - Faraday v0.15.4
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+        Accept:
+          - "*/*"
+    response:
+      status:
+        code: 404
+        message: Not Found
+      headers:
+        Server:
+          - nginx
+        Date:
+          - Fri, 05 Apr 2019 02:59:49 GMT
+        Content-Type:
+          - text/html; charset=utf-8
+        Transfer-Encoding:
+          - chunked
+        Connection:
+          - keep-alive
+        Set-Cookie:
+          - ctoken=333d7c703c954832b14c34cb8cca7b3a; Max-Age=43200; Path=/; Expires=Fri,
+            05 Apr 2019 14:59:49 GMT
+        Content-Security-Policy:
+          - "default-src 'self'; child-src 'none'; object-src 'self'; style-src
+            'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self'
+            https://js.intercomcdn.com/fonts/ https://fonts.gstatic.com; frame-src 'self'
+            https://portal.productboard.com/ https://js.stripe.com/; img-src 'self'
+            data: https://*.intercomcdn.com/ https://static.intercomassets.com/ https://www.google-analytics.com
+            https://downloads.intercomcdn.com/; connect-src 'self' https://auth.iexcloud.io
+            https://api.iexcloud.io https://api.iexcloud.io https://cloud.iexapis.com
+            wss://iexcloud.io wss://tops.iexcloud.io wss://api.iexcloud.io wss://iexcloud.io
+            https://api-iam.intercom.io/messenger/ https://nexus-websocket-a.intercom.io/
+            https://nexus-websocket-b.intercom.io/ wss://nexus-websocket-a.intercom.io/
+            wss://nexus-websocket-b.intercom.io/ https://www.google-analytics.com; script-src
+            'self' 'unsafe-inline' 'unsafe-eval' https://www.google.com/recaptcha/api.js
+            https://www.google-analytics.com https://js.stripe.com/v3/ https://widget.intercom.io/widget/lhos563b
+            https://js.intercomcdn.com/ https://www.googletagmanager.com;"
+        X-Content-Security-Policy:
+          - "default-src 'self'; child-src 'none'; object-src 'self'; style-src
+            'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self'
+            https://js.intercomcdn.com/fonts/ https://fonts.gstatic.com; frame-src 'self'
+            https://portal.productboard.com/ https://js.stripe.com/; img-src 'self'
+            data: https://*.intercomcdn.com/ https://static.intercomassets.com/ https://www.google-analytics.com
+            https://downloads.intercomcdn.com/; connect-src 'self' https://auth.iexcloud.io
+            https://api.iexcloud.io https://api.iexcloud.io https://cloud.iexapis.com
+            wss://iexcloud.io wss://tops.iexcloud.io wss://api.iexcloud.io wss://iexcloud.io
+            https://api-iam.intercom.io/messenger/ https://nexus-websocket-a.intercom.io/
+            https://nexus-websocket-b.intercom.io/ wss://nexus-websocket-a.intercom.io/
+            wss://nexus-websocket-b.intercom.io/ https://www.google-analytics.com; script-src
+            'self' 'unsafe-inline' 'unsafe-eval' https://www.google.com/recaptcha/api.js
+            https://www.google-analytics.com https://js.stripe.com/v3/ https://widget.intercom.io/widget/lhos563b
+            https://js.intercomcdn.com/ https://www.googletagmanager.com;"
+        Frame-Options:
+          - SAMEORIGIN
+        X-Frame-Options:
+          - SAMEORIGIN
+        Strict-Transport-Security:
+          - max-age=15768000
+        Access-Control-Allow-Origin:
+          - "*"
+        Access-Control-Allow-Credentials:
+          - "true"
+        Access-Control-Allow-Methods:
+          - GET, OPTIONS
+        Access-Control-Allow-Headers:
+          - Origin, X-Requested-With, Content-Type, Accept
+      body:
+        encoding: ASCII-8BIT
+        string: Unknown symbol
+      http_version:
+    recorded_at: Fri, 05 Apr 2019 02:59:49 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/fx/latest.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://cloud.iexapis.com/v1/fx/latest?symbols=USDCAD,USDGBP,USDJPY&token=test-iex-api-publishable-token
+      body:
+        encoding: US-ASCII
+        string: ""
+      headers:
+        User-Agent:
+          - Faraday v0.15.4
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+        Accept:
+          - "*/*"
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Server:
+          - nginx
+        Date:
+          - Fri, 05 Apr 2019 02:59:48 GMT
+        Content-Type:
+          - application/json; charset=utf-8
+        Content-Length:
+          - "6"
+        Connection:
+          - keep-alive
+        Set-Cookie:
+          - ctoken=3859f7adf5e24bb0ac6a2283b1d2c588; Max-Age=43200; Path=/; Expires=Fri,
+            05 Apr 2019 14:59:48 GMT
+        Content-Security-Policy:
+          - "default-src 'self'; child-src 'none'; object-src 'self'; style-src
+            'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self'
+            https://js.intercomcdn.com/fonts/ https://fonts.gstatic.com; frame-src 'self'
+            https://portal.productboard.com/ https://js.stripe.com/; img-src 'self'
+            data: https://*.intercomcdn.com/ https://static.intercomassets.com/ https://www.google-analytics.com
+            https://downloads.intercomcdn.com/; connect-src 'self' https://auth.iexcloud.io
+            https://api.iexcloud.io https://api.iexcloud.io https://cloud.iexapis.com
+            wss://iexcloud.io wss://tops.iexcloud.io wss://api.iexcloud.io wss://iexcloud.io
+            https://api-iam.intercom.io/messenger/ https://nexus-websocket-a.intercom.io/
+            https://nexus-websocket-b.intercom.io/ wss://nexus-websocket-a.intercom.io/
+            wss://nexus-websocket-b.intercom.io/ https://www.google-analytics.com; script-src
+            'self' 'unsafe-inline' 'unsafe-eval' https://www.google.com/recaptcha/api.js
+            https://www.google-analytics.com https://js.stripe.com/v3/ https://widget.intercom.io/widget/lhos563b
+            https://js.intercomcdn.com/ https://www.googletagmanager.com;"
+        X-Content-Security-Policy:
+          - "default-src 'self'; child-src 'none'; object-src 'self'; style-src
+            'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self'
+            https://js.intercomcdn.com/fonts/ https://fonts.gstatic.com; frame-src 'self'
+            https://portal.productboard.com/ https://js.stripe.com/; img-src 'self'
+            data: https://*.intercomcdn.com/ https://static.intercomassets.com/ https://www.google-analytics.com
+            https://downloads.intercomcdn.com/; connect-src 'self' https://auth.iexcloud.io
+            https://api.iexcloud.io https://api.iexcloud.io https://cloud.iexapis.com
+            wss://iexcloud.io wss://tops.iexcloud.io wss://api.iexcloud.io wss://iexcloud.io
+            https://api-iam.intercom.io/messenger/ https://nexus-websocket-a.intercom.io/
+            https://nexus-websocket-b.intercom.io/ wss://nexus-websocket-a.intercom.io/
+            wss://nexus-websocket-b.intercom.io/ https://www.google-analytics.com; script-src
+            'self' 'unsafe-inline' 'unsafe-eval' https://www.google.com/recaptcha/api.js
+            https://www.google-analytics.com https://js.stripe.com/v3/ https://widget.intercom.io/widget/lhos563b
+            https://js.intercomcdn.com/ https://www.googletagmanager.com;"
+        Frame-Options:
+          - SAMEORIGIN
+        X-Frame-Options:
+          - SAMEORIGIN
+        X-Content-Type-Options:
+          - nosniff
+        Strict-Transport-Security:
+          - max-age=15768000
+        Access-Control-Allow-Origin:
+          - "*"
+        Access-Control-Allow-Credentials:
+          - "true"
+        Access-Control-Allow-Methods:
+          - GET, OPTIONS
+        Access-Control-Allow-Headers:
+          - Origin, X-Requested-With, Content-Type, Accept
+      body:
+        encoding: ASCII-8BIT
+        string: '[{"symbol":"USDCAD","rate":1.25674,"timestamp":1627045829863,"isDerived":false},{"symbol":"USDGBP","rate":0.7262111386264443,"timestamp":1627045780863,"isDerived":false},{"symbol":"USDJPY","rate":110.426,"timestamp":1627045825365,"isDerived":false}]'
+      http_version:
+    recorded_at: Fri, 05 Apr 2019 02:59:48 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/fx/latest_one_symbol.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://cloud.iexapis.com/v1/fx/latest?symbols=USDCAD&token=test-iex-api-publishable-token
+      body:
+        encoding: US-ASCII
+        string: ""
+      headers:
+        User-Agent:
+          - Faraday v0.15.4
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+        Accept:
+          - "*/*"
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Server:
+          - nginx
+        Date:
+          - Fri, 05 Apr 2019 02:59:48 GMT
+        Content-Type:
+          - application/json; charset=utf-8
+        Content-Length:
+          - "6"
+        Connection:
+          - keep-alive
+        Set-Cookie:
+          - ctoken=3859f7adf5e24bb0ac6a2283b1d2c588; Max-Age=43200; Path=/; Expires=Fri,
+            05 Apr 2019 14:59:48 GMT
+        Content-Security-Policy:
+          - "default-src 'self'; child-src 'none'; object-src 'self'; style-src
+            'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self'
+            https://js.intercomcdn.com/fonts/ https://fonts.gstatic.com; frame-src 'self'
+            https://portal.productboard.com/ https://js.stripe.com/; img-src 'self'
+            data: https://*.intercomcdn.com/ https://static.intercomassets.com/ https://www.google-analytics.com
+            https://downloads.intercomcdn.com/; connect-src 'self' https://auth.iexcloud.io
+            https://api.iexcloud.io https://api.iexcloud.io https://cloud.iexapis.com
+            wss://iexcloud.io wss://tops.iexcloud.io wss://api.iexcloud.io wss://iexcloud.io
+            https://api-iam.intercom.io/messenger/ https://nexus-websocket-a.intercom.io/
+            https://nexus-websocket-b.intercom.io/ wss://nexus-websocket-a.intercom.io/
+            wss://nexus-websocket-b.intercom.io/ https://www.google-analytics.com; script-src
+            'self' 'unsafe-inline' 'unsafe-eval' https://www.google.com/recaptcha/api.js
+            https://www.google-analytics.com https://js.stripe.com/v3/ https://widget.intercom.io/widget/lhos563b
+            https://js.intercomcdn.com/ https://www.googletagmanager.com;"
+        X-Content-Security-Policy:
+          - "default-src 'self'; child-src 'none'; object-src 'self'; style-src
+            'self' 'unsafe-inline' https://fonts.googleapis.com; font-src 'self'
+            https://js.intercomcdn.com/fonts/ https://fonts.gstatic.com; frame-src 'self'
+            https://portal.productboard.com/ https://js.stripe.com/; img-src 'self'
+            data: https://*.intercomcdn.com/ https://static.intercomassets.com/ https://www.google-analytics.com
+            https://downloads.intercomcdn.com/; connect-src 'self' https://auth.iexcloud.io
+            https://api.iexcloud.io https://api.iexcloud.io https://cloud.iexapis.com
+            wss://iexcloud.io wss://tops.iexcloud.io wss://api.iexcloud.io wss://iexcloud.io
+            https://api-iam.intercom.io/messenger/ https://nexus-websocket-a.intercom.io/
+            https://nexus-websocket-b.intercom.io/ wss://nexus-websocket-a.intercom.io/
+            wss://nexus-websocket-b.intercom.io/ https://www.google-analytics.com; script-src
+            'self' 'unsafe-inline' 'unsafe-eval' https://www.google.com/recaptcha/api.js
+            https://www.google-analytics.com https://js.stripe.com/v3/ https://widget.intercom.io/widget/lhos563b
+            https://js.intercomcdn.com/ https://www.googletagmanager.com;"
+        Frame-Options:
+          - SAMEORIGIN
+        X-Frame-Options:
+          - SAMEORIGIN
+        X-Content-Type-Options:
+          - nosniff
+        Strict-Transport-Security:
+          - max-age=15768000
+        Access-Control-Allow-Origin:
+          - "*"
+        Access-Control-Allow-Credentials:
+          - "true"
+        Access-Control-Allow-Methods:
+          - GET, OPTIONS
+        Access-Control-Allow-Headers:
+          - Origin, X-Requested-With, Content-Type, Accept
+      body:
+        encoding: ASCII-8BIT
+        string: '[{"symbol":"USDCAD","rate":1.25674,"timestamp":1627045829863}]'
+      http_version:
+    recorded_at: Fri, 05 Apr 2019 02:59:48 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/key_stat/individual.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/VTI/stats/ttmDividendRate?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.4.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Thu, 12 Aug 2021 20:04:24 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '18'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=8df9fdfb440744638edd9bfdc8e0d27b; Max-Age=43200; Path=/; Expires=Fri,
+        13 Aug 2021 08:04:24 GMT
+      Iexcloud-Messages-Used:
+      - '2'
+      Iexcloud-Credits-Used:
+      - '2'
+      Iexcloud-Premium-Messages-Used:
+      - '0'
+      Iexcloud-Premium-Credits-Used:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=15768000
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Headers:
+      - Origin, X-Requested-With, Content-Type, Accept, Request-Source
+    body:
+      encoding: UTF-8
+      string: '2.7887693754001748'
+  recorded_at: Thu, 12 Aug 2021 20:04:24 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/iex/key_stat/invalid_stat.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/VTI/stats/INVALID?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.4.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Fri, 13 Aug 2021 17:45:21 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=f9f32af4b36f4a1bac8e9b2ff9018275; Max-Age=43200; Path=/; Expires=Sat,
+        14 Aug 2021 05:45:21 GMT
+      Iexcloud-Messages-Used:
+      - '6'
+      Iexcloud-Credits-Used:
+      - '6'
+      Iexcloud-Premium-Messages-Used:
+      - '0'
+      Iexcloud-Premium-Credits-Used:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=15768000
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Headers:
+      - Origin, X-Requested-With, Content-Type, Accept, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: '{"companyName":"Vanguard Group, Inc.","marketcap":260737447690,"week52high":230.02,"week52low":160.5,"week52highSplitAdjustOnly":230.02,"week52lowSplitAdjustOnly":162.85,"week52change":0.3645993202513256,"sharesOutstanding":1133542508,"float":0,"avg10Volume":2888645,"avg30Volume":3320395,"day200MovingAvg":213.89,"day50MovingAvg":225.73,"employees":0,"ttmEPS":0,"ttmDividendRate":2.788769375400175,"dividendYield":0.012124029977394032,"nextDividendDate":"","exDividendDate":"2021-06-24","nextEarningsDate":"","peRatio":0,"beta":1.0132372909433216,"maxChangePercent":3.578068183401369,"year5ChangePercent":1.249480952953752,"year2ChangePercent":0.6180018710916342,"year1ChangePercent":0.3635630717574918,"ytdChangePercent":0.1893429658290111,"month6ChangePercent":0.1156861042707178,"month3ChangePercent":0.10073637646122013,"month1ChangePercent":0.015496004591408763,"day30ChangePercent":0.021176470588235352,"day5ChangePercent":0.006255741720985197}'
+  recorded_at: Fri, 13 Aug 2021 17:45:21 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/iex/key_stat/invalid_symbol.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/INVALID/stats/ttmDividendRate?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.4.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Fri, 13 Aug 2021 17:45:20 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=8e6f76d57e134a4ca1be468312f5f33c; Max-Age=43200; Path=/; Expires=Sat,
+        14 Aug 2021 05:45:20 GMT
+      Strict-Transport-Security:
+      - max-age=15768000
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Methods:
+      - GET, OPTIONS
+      Access-Control-Allow-Headers:
+      - Origin, X-Requested-With, Content-Type, Accept, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: Unknown symbol
+  recorded_at: Fri, 13 Aug 2021 17:45:20 GMT
+recorded_with: VCR 6.0.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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iex-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-15 00:00:00.000000000 Z
+date: 2021-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: dblock@dblock.org
 executables: []
 extensions: []
@@ -176,8 +176,10 @@ files:
 - lib/iex/endpoints/crypto.rb
 - lib/iex/endpoints/dividends.rb
 - lib/iex/endpoints/earnings.rb
+- lib/iex/endpoints/fx.rb
 - lib/iex/endpoints/historial_prices.rb
 - lib/iex/endpoints/income.rb
+- lib/iex/endpoints/key_stat.rb
 - lib/iex/endpoints/key_stats.rb
 - lib/iex/endpoints/largest_trades.rb
 - lib/iex/endpoints/logo.rb
@@ -190,7 +192,9 @@ files:
 - lib/iex/endpoints/stock_market.rb
 - lib/iex/errors.rb
 - lib/iex/errors/client_error.rb
+- lib/iex/errors/invalid_symbols_list.rb
 - lib/iex/errors/permission_denied_error.rb
+- lib/iex/errors/stat_not_found_error.rb
 - lib/iex/errors/symbol_not_found_error.rb
 - lib/iex/logger.rb
 - lib/iex/resources.rb
@@ -200,6 +204,7 @@ files:
 - lib/iex/resources/chart.rb
 - lib/iex/resources/company.rb
 - lib/iex/resources/crypto.rb
+- lib/iex/resources/currency_rate.rb
 - lib/iex/resources/dividends.rb
 - lib/iex/resources/earnings.rb
 - lib/iex/resources/historical_prices.rb
@@ -215,6 +220,7 @@ files:
 - lib/iex/resources/symbol.rb
 - lib/iex/resources/symbols.rb
 - lib/iex/version.rb
+- script/console
 - spec/fixtures/iex/advanced_stats/invalid.yml
 - spec/fixtures/iex/advanced_stats/msft.yml
 - spec/fixtures/iex/balance_sheet/invalid.yml
@@ -239,6 +245,9 @@ files:
 - spec/fixtures/iex/dividends/msft_invalid_range.yml
 - spec/fixtures/iex/earnings/invalid.yml
 - spec/fixtures/iex/earnings/msft.yml
+- spec/fixtures/iex/fx/invalid.yml
+- spec/fixtures/iex/fx/latest.yml
+- spec/fixtures/iex/fx/latest_one_symbol.yml
 - spec/fixtures/iex/historical_prices/abcd.yml
 - spec/fixtures/iex/historical_prices/invalid.yml
 - spec/fixtures/iex/historical_prices/invalid_date.yml
@@ -250,6 +259,9 @@ files:
 - spec/fixtures/iex/income/invalid.yml
 - spec/fixtures/iex/income/msft.yml
 - spec/fixtures/iex/income/nsrgy.yml
+- spec/fixtures/iex/key_stat/individual.yml
+- spec/fixtures/iex/key_stat/invalid_stat.yml
+- spec/fixtures/iex/key_stat/invalid_symbol.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/largest-trades/aapl.yml
@@ -283,8 +295,10 @@ files:
 - spec/iex/endpoints/crypto_spec.rb
 - spec/iex/endpoints/dividends_spec.rb
 - spec/iex/endpoints/earnings_spec.rb
+- spec/iex/endpoints/fx_spec.rb
 - spec/iex/endpoints/historical_prices_spec.rb
 - spec/iex/endpoints/income_spec.rb
+- spec/iex/endpoints/key_stat_spec.rb
 - spec/iex/endpoints/key_stats_spec.rb
 - spec/iex/endpoints/largest_trades_spec.rb
 - spec/iex/endpoints/logo_spec.rb
@@ -304,7 +318,7 @@ homepage: http://github.com/dblock/iex-ruby-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -319,8 +333,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: IEX Finance API Ruby client with support for retrieving stock quotes.
 test_files:
@@ -348,6 +362,9 @@ 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/fx/invalid.yml
+- spec/fixtures/iex/fx/latest.yml
+- spec/fixtures/iex/fx/latest_one_symbol.yml
 - spec/fixtures/iex/historical_prices/abcd.yml
 - spec/fixtures/iex/historical_prices/invalid.yml
 - spec/fixtures/iex/historical_prices/invalid_date.yml
@@ -359,6 +376,9 @@ test_files:
 - spec/fixtures/iex/income/invalid.yml
 - spec/fixtures/iex/income/msft.yml
 - spec/fixtures/iex/income/nsrgy.yml
+- spec/fixtures/iex/key_stat/individual.yml
+- spec/fixtures/iex/key_stat/invalid_stat.yml
+- spec/fixtures/iex/key_stat/invalid_symbol.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/largest-trades/aapl.yml
@@ -392,8 +412,10 @@ test_files:
 - spec/iex/endpoints/crypto_spec.rb
 - spec/iex/endpoints/dividends_spec.rb
 - spec/iex/endpoints/earnings_spec.rb
+- spec/iex/endpoints/fx_spec.rb
 - spec/iex/endpoints/historical_prices_spec.rb
 - spec/iex/endpoints/income_spec.rb
+- spec/iex/endpoints/key_stat_spec.rb
 - spec/iex/endpoints/key_stats_spec.rb
 - spec/iex/endpoints/largest_trades_spec.rb
 - spec/iex/endpoints/logo_spec.rb