iex-ruby-client 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc54c99b44f20089d95fa121c4bdf07c799bcf85
-  data.tar.gz: c8ffcde3452f7141c61342f510d2700f6c0a0bbf
+SHA256:
+  metadata.gz: b8a4a5e3e694cd4af9310002178f918ed6b6802711860e29780e2bde8f494805
+  data.tar.gz: 415aa05993daba620a4aea9a32aa52d73a8e0b3bdc39fd96296fb655703b2921
 SHA512:
-  metadata.gz: cc798095fd893860bcf460bd836c6c0c8922f4a5831df83184842a2a5be537008220f51e42a5bdfab29a791b0ef7d9f28fd50b9781e59d8fc7d0a4b9238de331
-  data.tar.gz: cbad4c6f007f914c7548a92cdc5c9b0a77ea60c7b9f4dfd73a38c96930d8ccfca0f0ae0f436e6709e207c4afa91951b73f80c906361d86577b9757fe57ae8a62
+  metadata.gz: 43680c128f3354b4f64f485c51ddfed0f94c9a3f25b6be1c16f93a7a3a97534a0e1fa990a85394d92c1aca220410ceea1a9e9f0d061abce8c7e697ef91a022e3
+  data.tar.gz: 3f497b0bdcc8b295b1f370d3185e6768fea91cbafdde5acdf637d8a16b918d0e5fc229eb5bb702eca8d5848388b5803e797cf8c21feb156c895f3c8e1d5d2dd8

data/.env.sample

@@ -0,0 +1,2 @@
+IEX_API_PUBLISHABLE_TOKEN=test-iex-api-publishable-token
+IEX_API_SECRET_TOKEN=test-iex-api-secret-token

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/.rubocop_todo.yml

@@ -11,11 +11,3 @@
 Style/AsciiComments:
   Exclude:
     - 'lib/iex/resources/quote.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, Autocorrect.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
-  Exclude:
-    - 'lib/iex/api/config.rb'

data/CHANGELOG.md

@@ -1,7 +1,41 @@
+### 1.3.0 (2020/10/31)
+
+* [#82](https://github.com/dblock/iex-ruby-client/pull/82): Added `config.referer` to set HTTP `Referer` header. This enables IEX's "Manage domains" domain locking for tokens - [@agrberg](https://github.com/agrberg).
+* [#70](https://github.com/dblock/iex-ruby-client/pull/70): Added support for `ref_data_isin` taking a single `String` parameter - [@rodolfobandeira](https://github.com/rodolfobandeira).
+* [#84](https://github.com/dblock/iex-ruby-client/pull/84): Added support for Advanced Stats API - [@FanaHOVA](https://github.com/fanahova).
+* [#86](https://github.com/dblock/iex-ruby-client/issues/86): Added advanced logger configuration to `config.logger`. Now a hash with keys `:instance, :options, and :proc` can be passed and used directly with Faraday - [@agrberg](https://github.com/agrberg).
+* [#88](https://github.com/dblock/iex-ruby-client/pull/88): Updated logger configuration to work like `Config` class and allow attribute and block based configuration - [@agrberg](https://github.com/agrberg).
+* [#89](https://github.com/dblock/iex-ruby-client/pull/89): Backfill breaking `Config#logger` setting change from [#88](https://github.com/dblock/iex-ruby-client/pull/88) - [@agrberg](https://github.com/agrberg).
+
+### 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): Add missing properties for key stats API - [@bingxie](https://github.com/bingxie).
-* Fix: `uninitialized constant IEX::Endpoints::Chart::Date (NameError)` - [@dblock](https://github.com/dblock).
+* [#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)
 
@@ -11,9 +45,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)
 
@@ -21,7 +55,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)
@@ -40,18 +74,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,8 @@ 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 'dotenv'
   gem 'pry'
 end

data/README.md

@@ -22,10 +22,17 @@ 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)
+  - [Logging](#logging)
+- [Sandbox Environment](#sandbox-environment)
 - [Errors](#errors)
   - [SymbolNotFound](#symbolnotfound)
   - [PermissionDeniedError](#permissiondeniederror)
@@ -47,14 +54,15 @@ Run `bundle install`.
 
 ### Get an API Token
 
-Create an account on [IEX Cloud](https://iexcloud.io) and get a publishable token from the IEX cloud console. You should use a sandbox token and endpoint for testing.
+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.endpoint = 'https://sandbox.iexapis.com/v1' # defaults to 'https://cloud.iexapis.com/v1'
+  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
 ```
 
@@ -62,8 +70,9 @@ You can also configure an instance of a client directly.
 
 ```ruby
 client = IEX::Api::Client.new(
-  publishable_token: 'token',
-  endpoint: 'https://sandbox.iexapis.com/v1'
+  publishable_token: 'publishable_token',
+  secret_token: 'secret_token',
+  endpoint: 'https://cloud.iexapis.com/v1'
 )
 ```
 
@@ -97,7 +106,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 #
@@ -216,7 +225,7 @@ 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_dollars # "$990,869,169,557"
+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
@@ -293,6 +302,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.
@@ -349,12 +377,75 @@ 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
+
+Convert 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
+```
+
+The API also lets you convert multiple ISINs to IEX Cloud symbols.
+
+```ruby
+symbols = client.ref_data_isin(['US0378331005', 'US0378331006'])
+```
+
+
+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|
+IEX::Api.configure do |config|
   config.publishable_token = ENV['IEX_API_PUBLISHABLE_TOKEN']
   config.endpoint = 'https://sandbox.iexapis.com/v1' # use sandbox environment
 end
@@ -363,7 +454,7 @@ end
 ```ruby
 client = IEX::Api::Client.new(
   publishable_token: ENV['IEX_API_PUBLISHABLE_TOKEN'],
-  endpoint: 'https://sandbox.iexapis.com/v1'
+  endpoint: 'https://cloud.iexapis.com/v1'
 )
 ```
 
@@ -375,11 +466,44 @@ user_agent          | User-agent, defaults to _IEX Ruby Client/version_.
 proxy               | Optional HTTP proxy.
 ca_path             | Optional SSL certificates path.
 ca_file             | Optional SSL certificates file.
-logger              | Optional `Logger` instance that logs HTTP requests.
+logger              | Optional `Logger` instance or logger configuration to log HTTP requests.
 timeout             | Optional open/read timeout in seconds.
 open_timeout        | Optional connection open timeout in seconds.
 publishable_token   | IEX Cloud API publishable token.
 endpoint            | Defaults to `https://cloud.iexapis.com/v1`.
+referer             | Optional string for HTTP `Referer` header, enables token domain management.
+
+### Logging
+
+Faraday will not log HTTP requests by default. In order to do this you can either provide a `logger` instance or configuration attributes to `IEX::Api::Client`. Configuration allows you to supply the `instance`, `options`, and `proc` to [Faraday](https://lostisland.github.io/faraday/middleware/logger#include-and-exclude-headersbodies).
+
+```ruby
+logger_instance = Logger.new(STDOUT)
+
+IEX::Api.configure do |config|
+  config.logger.instance = logger_instance
+  config.logger.options = { bodies: true }
+  config.logger.proc = proc { |logger| logger.filter(/T?[sp]k_\w+/i, '[REMOVED]') }
+end
+# or
+IEX::Api.logger do |logger|
+  logger.instance = logger_instance
+  logger.options = …
+  logger.proc = …
+end
+# or
+IEX::Api.logger = logger_instance
+# or
+IEX::Api::Client.new(logger: logger_instance)
+```
+
+## 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. In addition, results, such as closing market prices and dividend yield, are not accurate and vary on every call.
+
+See [IEX sandbox environment](https://intercom.help/iexcloud/en/articles/2915433-testing-with-the-iex-cloud-sandbox) for more information.
 
 ## Errors
 

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/api.rb

@@ -1,7 +1,9 @@
+require_relative 'endpoints/advanced_stats'
 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 +13,9 @@ 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/config/logger'
+require_relative 'api/config/client'
 require_relative 'api/client'

data/lib/iex/api/client.rb

@@ -1,11 +1,16 @@
 module IEX
   module Api
+    extend Config::Client::Accessor
+    extend Config::Logger::Accessor
+
     class Client
+      include Endpoints::AdvancedStats
       include Endpoints::Chart
       include Endpoints::Company
       include Endpoints::Crypto
       include Endpoints::Dividends
       include Endpoints::Earnings
+      include Endpoints::Income
       include Endpoints::KeyStats
       include Endpoints::LargestTrades
       include Endpoints::Logo
@@ -14,16 +19,22 @@ module IEX
       include Endpoints::Price
       include Endpoints::Quote
       include Endpoints::Sectors
+      include Endpoints::RefData
+      include Endpoints::StockMarket
 
       include Cloud::Connection
       include Cloud::Request
 
-      include Config
+      attr_accessor(*Config::Client::ATTRIBUTES)
+
+      attr_reader :logger
 
       def initialize(options = {})
-        Config::ATTRIBUTES.each do |key|
+        Config::Client::ATTRIBUTES.each do |key|
           send("#{key}=", options[key] || IEX::Api.config.send(key))
         end
+        @logger = Config::Logger.dup
+        @logger.instance = options[:logger] if options.key?(:logger)
       end
     end
   end