iex-ruby-client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df29afbbbd95d15992840fdfe66fd8fa31ed1cee
-  data.tar.gz: df551117e4b8dcfa5e223a765c1fa97e7bc4bedb
+SHA256:
+  metadata.gz: 71bec851d78d50e5e8625f18e94212bd3d5825a1bf90a3809258e6ef88dcae34
+  data.tar.gz: b3f668404aada9eb2bcfa7f56767ce51083222c9f40a2fa95f15d005be9ee7ed
 SHA512:
-  metadata.gz: b28d4ea0c36db77958e86a5c0ad347a04876a7bd8e51582f853435316444f0b7277c1a1b98bd299e4b77f89821ec89dc58e9923c45e631e961433dcc5dfe2aa9
-  data.tar.gz: 34f851cf3b8e46f2475531717055c1a9cf9ca7abb96675fc50c88a766a5ff6f92f6f52459fda71e1d046eba4ade185d7e368639222195a662c8ee1bba957c4e9
+  metadata.gz: bf29091889a722d957ea6abceb5dc60d761fde868abc4212829c48723fc668870dbad46a75815823224bf324bd466fc917669792b320c85b0a907979b37008cc
+  data.tar.gz: 1222b56a8c47e79cd36b92b124128fa0162f8acbd9aa466f212cd0bc3bbe94036c2cc0c79243e348cf3b65ebb527ba47d46b91850dc8059cd081cab247568971

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [dblock]

data/.rubocop.yml

@@ -2,12 +2,15 @@ AllCops:
   Exclude:
     - vendor/**/*
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Naming/MethodName:
   Enabled: false
 
 Naming/FileName:
   Exclude:
-    - 'lib/iex-ruby-client.rb'
+    - "lib/iex-ruby-client.rb"
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 1.2.0 (2020/09/01)
+
+* [#78](https://github.com/dblock/iex-ruby-client/pull/78): Added `Quote#extended_change_percent` and `Quote#extended_change_percent_s` properties to Quote - [@reddavis](https://github.com/reddavis).
+* [#71](https://github.com/dblock/iex-ruby-client/pull/71): Added `symbols` resource - [@ryosuke-endo](https://github.com/ryosuke-endo).
+* [#69](https://github.com/dblock/iex-ruby-client/pull/69): Fixed `ref_data_isin` request - [@bguban](https://github.com/bguban).
+* [#72](https://github.com/dblock/iex-ruby-client/pull/72): Cache `Faraday::Connection` for persistent adapters - [@dblock](https://github.com/dblock).
+
+### 1.1.2 (2020/03/25)
+
+* [#68](https://github.com/dblock/iex-ruby-client/pull/68): Fixed `ref_data_isin` request with wrong isin - [@bguban](https://github.com/bguban).
+* [#67](https://github.com/dblock/iex-ruby-client/pull/67): Added required ruby version to gemspec - [@wdperson](https://github.com/wdperson).
+* [#66](https://github.com/dblock/iex-ruby-client/pull/66): Fixed `KeyStats#week_52_change always` returns nil - [@brunjo](https://github.com/brunjo).
+* [#65](https://github.com/dblock/iex-ruby-client/pull/65): Added `stock_market_list` - [@bguban](https://github.com/bguban).
+* [#64](https://github.com/dblock/iex-ruby-client/pull/64): Added `ref_data_isin` - [@bguban](https://github.com/bguban).
+
+### 1.1.1 (2020/03/02)
+
+* [#63](https://github.com/dblock/iex-ruby-client/pull/63): Allow direct API calls with support for secret_token - [@bguban](https://github.com/bguban).
+* [#61](https://github.com/dblock/iex-ruby-client/pull/61): Fixed income endpoint if the api returns no result - [@brunjo](https://github.com/brunjo).
+* [#57](https://github.com/dblock/iex-ruby-client/pull/57): Updated properties for chart api endpoint - [@brunjo](https://github.com/brunjo).
+
+### 1.1.0 (2019/07/08)
+
+* [#55](https://github.com/dblock/iex-ruby-client/pull/55): Added `income` statement API and add `tags` to the `company` - [@bingxie](https://github.com/bingxie).
+
+### 1.0.1 (2019/07/08)
+
+* [#50](https://github.com/dblock/iex-ruby-client/pull/50): Added missing properties for key stats API - [@bingxie](https://github.com/bingxie).
+* Fixed `uninitialized constant IEX::Endpoints::Chart::Date (NameError)` - [@dblock](https://github.com/dblock).
+
 ### 1.0.0 (2019/04/23)
 
 * [#42](https://github.com/dblock/iex-ruby-client/pull/42): Migrated to the IEX Cloud API - [@bingxie](https://github.com/bingxie).
@@ -6,9 +36,9 @@
 ### 0.4.4 (2018/12/27)
 
 * [#39](https://github.com/dblock/iex-ruby-client/pull/39): Remove default range and use iextrading default range 1m instead in `IEX::Api::Dividends` - [@ildarkayumov](https://github.com/ildarkayumov).
-* [#37](https://github.com/dblock/iex-ruby-client/pull/37): Add `IEX::Resource::Crypto` - [@rodolfobandeira](https://github.com/rodolfobandeira).
-* [#34](https://github.com/dblock/iex-ruby-client/pull/34): Add `IEX::Resource::LargestTrades` - [@gil27](https://github.com/gil27).
-* [#32](https://github.com/dblock/iex-ruby-client/pull/32): Add `IEX::Resource::Sectors` - [@gil27](https://github.com/gil27).
+* [#37](https://github.com/dblock/iex-ruby-client/pull/37): Added `IEX::Resource::Crypto` - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* [#34](https://github.com/dblock/iex-ruby-client/pull/34): Added `IEX::Resource::LargestTrades` - [@gil27](https://github.com/gil27).
+* [#32](https://github.com/dblock/iex-ruby-client/pull/32): Added `IEX::Resource::Sectors` - [@gil27](https://github.com/gil27).
 
 ### 0.4.3 (2018/08/18)
 
@@ -16,7 +46,7 @@
 
 ### 0.4.2 (2018/08/14)
 
-* [#24](https://github.com/dblock/iex-ruby-client/pull/24): Add danger-toc and danger-changelog - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* [#24](https://github.com/dblock/iex-ruby-client/pull/24): Added danger-toc and danger-changelog - [@rodolfobandeira](https://github.com/rodolfobandeira).
 * [#21](https://github.com/dblock/iex-ruby-client/pull/21): Added `IEX::Resources::Dividends` - [@rodolfobandeira](https://github.com/rodolfobandeira).
 
 ### 0.4.1 (2018/08/07)
@@ -35,18 +65,18 @@
 
 ### 0.3.2 (2018/05/26)
 
-* Fix: undefined method > for nil:NilClass error - [@dblock](https://github.com/dblock).
+* Fixed undefined method > for nil:NilClass error - [@dblock](https://github.com/dblock).
 
 ### 0.3.1 (2018/05/23)
 
-* [#3](https://github.com/dblock/iex-ruby-client/issues/3): Fix: do not error on undefined properties - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/iex-ruby-client/issues/3): Fixed do not error on undefined properties - [@dblock](https://github.com/dblock).
 
 ### 0.3.0 (2018/05/22)
 
 * Added `IEX::Resources::Chart#get` - [@dblock](https://github.com/dblock).
 * Added `IEX::Resources::News#get` - [@dblock](https://github.com/dblock).
 * Added `IEX::Resources::Price#get` - [@dblock](https://github.com/dblock).
-* Fix: added `IEX::Resources::Quote#extendedPrice` and `IEX::Resources::Quote#extendedPriceTime` - [@dblock](https://github.com/dblock).
+* Fixed added `IEX::Resources::Quote#extendedPrice` and `IEX::Resources::Quote#extendedPriceTime` - [@dblock](https://github.com/dblock).
 
 ### 0.2.0 (2018/03/26)
 

data/Dangerfile

@@ -1,2 +1,2 @@
-toc.check
-changelog.check
+toc.check!
+changelog.check!

data/Gemfile

@@ -3,7 +3,7 @@ source 'http://rubygems.org'
 gemspec
 
 group :test do
-  gem 'danger-changelog', '~> 0.3.0'
-  gem 'danger-toc', '~> 0.1'
+  gem 'danger-changelog', '~> 0.6.0'
+  gem 'danger-toc', '~> 0.2.0'
   gem 'pry'
 end

data/README.md

@@ -22,10 +22,16 @@ A Ruby client for the [The IEX Cloud API](https://iexcloud.io/docs/api/).
   - [Get Key Stats](#get-key-stats)
   - [Get Dividends](#get-dividends)
   - [Get Earnings](#get-earnings)
+  - [Get Income Statement](#get-income-statement)
   - [Get Sector Performance](#get-sector-performance)
   - [Get Largest Trades](#get-largest-trades)
   - [Get a Quote for Crypto Currencies](#get-a-quote-for-crypto-currencies)
+  - [ISIN Mapping](#isin-mapping)
+  - [Get Symbols](#get-symbols)
+  - [Get List](#get-list)
+  - [Other Requests](#other-requests)
 - [Configuration](#configuration)
+- [Sandbox Environment](#sandbox-environment)
 - [Errors](#errors)
   - [SymbolNotFound](#symbolnotfound)
   - [PermissionDeniedError](#permissiondeniederror)
@@ -47,20 +53,26 @@ Run `bundle install`.
 
 ### Get an API Token
 
-Create an account on [IEX Cloud](https://iexcloud.io) and get a publishable token from the cloud console.
+Create an account on [IEX Cloud](https://iexcloud.io) and get a publishable token from the IEX cloud console.
 
 ### Configure
 
 ```ruby
 IEX::Api.configure do |config|
-  config.publishable_token = 'token' # defaults to ENV['IEX_API_PUBLISHABLE_TOKEN']
+  config.publishable_token = 'publishable_token' # defaults to ENV['IEX_API_PUBLISHABLE_TOKEN']
+  config.secret_token = 'secret_token' # defaults to ENV['IEX_API_SECRET_TOKEN']
+  config.endpoint = 'https://cloud.iexapis.com/v1' # use 'https://sandbox.iexapis.com/v1' for Sandbox
 end
 ```
 
 You can also configure an instance of a client directly.
 
 ```ruby
-client = IEX::Api::Client.new(publishable_token: 'token')
+client = IEX::Api::Client.new(
+  publishable_token: 'publishable_token',
+  secret_token: 'secret_token',
+  endpoint: 'https://cloud.iexapis.com/v1'
+)
 ```
 
 ### Get a Single Price
@@ -68,7 +80,7 @@ client = IEX::Api::Client.new(publishable_token: 'token')
 Fetches a single number, being the IEX real time price, the 15 minute delayed market price, or the previous close price.
 
 ```ruby
-client.get('MSFT') # 93.78
+client.price('MSFT') # 93.78
 ```
 
 See [#price](https://iexcloud.io/docs/api/#price) for detailed documentation.
@@ -93,7 +105,7 @@ See [#quote](https://iexcloud.io/docs/api/#quote) for detailed documentation or
 Fetches a single stock OHLC price. Open and Close prices contain timestamp.
 
 ```ruby
-ohlc = client.ohlc.get('MSFT')
+ohlc = client.ohlc('MSFT')
 
 ohlc.close.price # 90.165
 ohlc.close.time #
@@ -186,6 +198,19 @@ client.chart('MSFT', Date.new(2018, 3, 26)) # a specific date
 client.chart('MSFT', '1d', chart_interval: 10) # every n-th data point
 ```
 
+Note that calling the chart API weighs more than 1 IEX message (you pay more than 1 call).
+
+```
+# 1 message per minute capped at 50 messages to intraday_prices
+client.chart('MSFT', '1d')
+
+# 2x22 trading days = 44 messages to historical_close_prices
+client.chart('MSFT', '1m', chart_close_only: true)
+
+# 2x251 trading days = 502 messages to historical_close_prices
+client.chart('MSFT', '1y', chart_close_only: true)
+```
+
 ### Get Key Stats
 
 Fetches company's key stats for a symbol.
@@ -193,35 +218,48 @@ Fetches company's key stats for a symbol.
 ```ruby
 key_stats = client.key_stats('MSFT')
 
-key_stats.market_cap # 825814890000
-key_stats.market_cap_dollars # '$825,814,890,000'
-key_stats.week_52_high # 111.15
-key_stats.week_52_high_dollar # '$111.15'
-key_stats.week_52_low # 71.28
-key_stats.week_52_low_dollar # '$71.28'
-key_stats.week_52_change_dollar # '$51.77'
-key_stats.dividend_yield # 1.5617738
-key_stats.ex_dividend_date # '2018-08-15 00:00:00.0'
-key_stats.shares_outstanding # 7677000000
-key_stats.float # 7217387757
-key_stats.ttm_eps # 3.51
-key_stats.day_200_moving_avg # 91.99065
-key_stats.day_50_moving_avg # 102.2528
-key_stats.year_5_change_percent # 2.85141424991049
-key_stats.year_5_change_percent_s # '+285.14%'
-key_stats.year_2_change_percent # 0.9732002824884664
-key_stats.year_2_change_percent_s # '+97.32%'
-key_stats.year_1_change_percent # 0.5200287133805482
-key_stats.year_1_change_percent_s # '+52.00%'
-key_stats.ytd_change_percent # 0.2628699562098638
-key_stats.month_6_change_percent # 0.23345097958275707
-key_stats.month_6_change_percent_s # '+23.35%'
-key_stats.month_3_change_percent # 0.14846686026648437
-key_stats.month_3_change_percent_s # '+14.85%'
-key_stats.month_1_change_percent # 0.08601716304896513
-key_stats.month_1_change_percent_s # '+8.60%'
-key_stats.day_5_change_percent # -0.0010215453194652084
-key_stats.day_5_change_percent_s # '-0.10%'
+key_stats.week_52_change_dollar # "$0.37"
+key_stats.week_52_high # 136.04
+key_stats.week_52_high_dollar # "$136.04"
+key_stats.week_52_low # 95.92,
+key_stats.week_52_low_dollar # "$95.92"
+key_stats.market_cap # 990869169557
+key_stats.market_cap_dollar # "$990,869,169,557"
+key_stats.employees # 133074
+key_stats.day_200_moving_avg # 112.43
+key_stats.day_50_moving_avg # 121
+key_stats.float # 7694414092
+key_stats.avg_10_volume # 25160156.2
+key_stats.avg_30_volume # 23123700.13
+key_stats.ttm_eps # 4.66
+key_stats.ttm_dividend_rate # 1.8
+key_stats.company_name # "Microsoft Corp."
+key_stats.shares_outstanding # 7849945172
+key_stats.max_change_percent # 4.355607
+key_stats.year_5_change_percent # 2.32987
+key_stats.year_5_change_percent_s # "+232.99%"
+key_stats.year_2_change_percent # 0.84983
+key_stats.year_2_change_percent_s # "+84.98%"
+key_stats.year_1_change_percent # 0.383503
+key_stats.year_1_change_percent_s # "+38.35%"
+key_stats.ytd_change_percent # 0.270151
+key_stats.ytd_change_percent_s # "+27.02%"
+key_stats.month_6_change_percent # 0.208977
+key_stats.month_6_change_percent_s # "+20.90%"
+key_stats.month_3_change_percent # 0.212188
+key_stats.month_3_change_percent_s # "+21.22%"
+key_stats.month_1_change_percent # 0.076335
+key_stats.month_1_change_percent_s # "+7.63%"
+key_stats.day_30_change_percent # 0.089589
+key_stats.day_30_change_percent_s # "+8.96%"
+key_stats.day_5_change_percent # -0.010013
+key_stats.day_5_change_percent_s # "-1.00%"
+key_stats.next_dividend_date # "2019-05-21"
+key_stats.dividend_yield # 0.014087248841960684
+key_stats.next_earnings_date # "2019-07-29"
+key_stats.ex_dividend_date # "2019-05-24"
+key_stats.pe_ratio # 29.47
+key_stats.beta # 1.4135449089973444
 ```
 
 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.
@@ -263,6 +301,25 @@ earnings.year_ago_change_percent_s # '+15.31%'
 
 See [#earnings](https://iexcloud.io/docs/api/#earnings) for detailed documentation or [earnings.rb](lib/iex/resources/earnings.rb) for returned fields.
 
+### Get Income Statement
+
+Fetches income statement for a symbol.
+
+```ruby
+income = client.income('MSFT')
+
+income.report_date # '2019-03-31'
+income.total_revenue # 30_505_000_000
+income.total_revenue_dollar # '$30,505,000,000'
+income.cost_of_revenue # 10_170_000_000
+income.cost_of_revenue_dollar # '$10,170,000,000'
+income.gross_profit # 20_335_000_000
+income.gross_profit_dollar # '$20,335,000,000'
+...
+```
+
+See [#income-statement](https://iexcloud.io/docs/api/#income-statement) for detailed documentation or [income.rb](lib/iex/resources/income.rb) for returned fields.
+
 ### Get Sector Performance
 
 Fetches latest sector's performance.
@@ -319,20 +376,77 @@ crypto.high_dollar #'$3,590'
 
 See [#crypto](https://iexcloud.io/docs/api/#crypto) for detailed documentation or [crypto.rb](lib/iex/resources/crypto.rb) for returned fields.
 
+### ISIN Mapping
+
+Converts ISIN to IEX Cloud symbols.
+
+```ruby
+symbols = client.ref_data_isin(['US0378331005'])
+
+symbols.first.exchange # NAS
+symbols.first.iex_id # IEX_4D48333344362D52
+symbols.first.region # US
+symbols.first.symbol # AAPL
+```
+
+You can use `mapped: true` option to receive symbols grouped by their ISINs.
+
+```ruby
+client.ref_data_isin(['US0378331005', 'US5949181045'], mapped: true) # {'US0378331005' => [...], 'US5949181045' => [...]}
+```
+
+See [#ISIN Mapping](https://iexcloud.io/docs/api/#isin-mapping) for detailed documentation or [isin_mapping.rb](lib/iex/resources/isin_mapping.rb) for returned fields.
+
+### Get Symbols
+
+Returns an array of symbols
+
+```ruby
+symbols = client.ref_data_symbols()
+
+symbol = symbols.first
+symbol.exchange # NAS
+symbol.iex_id # IEX_46574843354B2D52
+symbol.region # US
+symbol.symbol # A
+```
+
+See [#symbols](https://iexcloud.io/docs/api/#symbols) for detailed documentation or [symbols.rb](lib/iex/resources/symbols.rb) for returned fields.
+
+### Get List
+
+Returns an array of quotes for the top 10 symbols in a specified list.
+
+```ruby
+client.stock_market_list(:mostactive) # [{symbol: 'AAPL', ...}, {...}]
+```
+
+See [#list](https://iexcloud.io/docs/api/#list) for detailed documentation or [quote.rb](lib/iex/resources/quote.rb) for returned fields.
+
+### Other Requests
+
+Public endpoints that aren't yet supported by the client can be called using `client.get`, `client.post`, `client.put`
+and `client.delete` methods. Pass the required token explicitly:
+
+```ruby
+client.post('ref-data/isin', isin: ['US0378331005'], token: 'secret_token') # [{'exchange' => 'NAS', ..., 'symbol' => 'AAPL'}, {'exchange' => 'ETR', ..., 'symbol' => 'APC-GY']
+```
+
 ## Configuration
 
 You can configure client options globally or directly with a `IEX::Api::Client` instance.
 
 ```ruby
 IEX::Api::Client.configure do |config|
-  config.user_agent = 'IEX Ruby Client/1.0.0'
+  config.publishable_token = ENV['IEX_API_PUBLISHABLE_TOKEN']
+  config.endpoint = 'https://sandbox.iexapis.com/v1' # use sandbox environment
 end
 ```
 
 ```ruby
 client = IEX::Api::Client.new(
-  publishable_token: 'token',
-  user_agent: 'IEX Ruby Client/1.0.0'
+  publishable_token: ENV['IEX_API_PUBLISHABLE_TOKEN'],
+  endpoint: 'https://cloud.iexapis.com/v1'
 )
 ```
 
@@ -350,6 +464,14 @@ open_timeout        | Optional connection open timeout in seconds.
 publishable_token   | IEX Cloud API publishable token.
 endpoint            | Defaults to `https://cloud.iexapis.com/v1`.
 
+## Sandbox Environment
+
+IEX recommends you use a sandbox token and endpoint for testing.
+
+However, please note that data in the IEX sandbox environment is scrambled. Therefore elements such as company and people names, descriptions, tags, and website URLs don't render any coherent data.
+
+See [IEX sandbox environment](https://intercom.help/iexcloud/en/articles/2915433-testing-with-the-iex-cloud-sandbox) for more information.
+
 ## Errors
 
 ### SymbolNotFound

data/iex-ruby-client.gemspec

@@ -9,19 +9,20 @@ Gem::Specification.new do |s|
   s.email = 'dblock@dblock.org'
   s.platform = Gem::Platform::RUBY
   s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version = '>= 2.3.0'
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
   s.homepage = 'http://github.com/dblock/iex-ruby-client'
   s.licenses = ['MIT']
   s.summary = 'IEX Finance API Ruby client with support for retrieving stock quotes.'
-  s.add_dependency 'faraday', '>= 0.9'
+  s.add_dependency 'faraday', '>= 0.17'
   s.add_dependency 'faraday_middleware'
   s.add_dependency 'hashie'
   s.add_dependency 'money_helper'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.67.2'
+  s.add_development_dependency 'rubocop', '0.72.0'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 end

data/lib/iex-ruby-client.rb

@@ -3,6 +3,7 @@ require 'faraday_middleware'
 require 'faraday_middleware/response_middleware'
 require 'hashie'
 require 'money_helper'
+require 'date'
 
 require_relative 'iex/version'
 require_relative 'iex/errors'

data/lib/iex/api.rb

@@ -2,6 +2,7 @@ require_relative 'endpoints/chart'
 require_relative 'endpoints/company'
 require_relative 'endpoints/dividends'
 require_relative 'endpoints/earnings'
+require_relative 'endpoints/income'
 require_relative 'endpoints/largest_trades'
 require_relative 'endpoints/logo'
 require_relative 'endpoints/key_stats'
@@ -11,6 +12,8 @@ require_relative 'endpoints/price'
 require_relative 'endpoints/quote'
 require_relative 'endpoints/sectors'
 require_relative 'endpoints/crypto'
+require_relative 'endpoints/ref_data'
+require_relative 'endpoints/stock_market'
 
 require_relative 'api/config'
 require_relative 'api/client'