iex-ruby-client 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31f82e417e023dae4b43a116a26c363f998452ee
-  data.tar.gz: f567de4892dbc778d9c4a285269d9fb2bfc2a204
+  metadata.gz: c7e9b5e2e6d7d24bdd96a69cc425066f793e3d37
+  data.tar.gz: d5173ee19bc5a824a9ba55e297911c895fe77b69
 SHA512:
-  metadata.gz: 8682c270ea7b9fb8a19deb4b6423252bcbd4b8fd1bdfb5b1805b28d94866309a126bbccea0c70b6c1b58e00e216e2315509f982bac3c20f701a1e5882a1d50a5
-  data.tar.gz: ea4d46ac096195a920681dc104a1822d97544c97a1089b2a386030f76e284147b6581e64fb87a20742c0f75695d1ec2a27749159240c907fe5e57f6f3701c19c
+  metadata.gz: 89c30e29f8fc386597b870ec70f4181f8a7b3db659fc6532caea0c439b0fde7f91375bb8575fe0c8fe0fefbfc0c87d1fe0a0cd56ba87930a2cc41e4bf0d50e9e
+  data.tar.gz: 34697845fe238e7ac05e9a77da770e87fb191aba6865a5291567caed7860aa5afe072d1df2f591e068723028ce4c906f67f87877dd859f43757d77e8c7f517d0

data/.rubocop_todo.yml

@@ -1,17 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-05 20:08:18 -0400 using RuboCop version 0.51.0.
+# on 2018-08-13 14:38:05 -0400 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 9
+# Offense count: 11
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 85
+  Max: 86
 
-# Offense count: 64
+# Offense count: 67
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
@@ -33,6 +33,6 @@ Style/DateTime:
     - 'lib/iex/resources/news.rb'
     - 'spec/iex/resources/news_spec.rb'
 
-# Offense count: 26
+# Offense count: 28
 Style/Documentation:
   Enabled: false

data/.travis.yml

@@ -4,3 +4,6 @@ cache: bundler
 
 rvm:
   - 2.4.1
+
+before_script:
+  - bundle exec danger

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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).
+* [#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)
 
 * [#18](https://github.com/dblock/iex-ruby-client/pull/18): Added `IEX::Resources::KeyStats` - [@rodolfobandeira](https://github.com/rodolfobandeira).
@@ -9,8 +14,8 @@
 
 ### 0.3.3 (2018/07/06)
 
-* [#5](https://github.com/dblock/iex-ruby-client/pull/5): Added `IEX::Resources::OHLC#get` - [@jromanovs](https://github.com/jromanovs). 
-* [#5](https://github.com/dblock/iex-ruby-client/pull/5): Added `IEX::Resources::OHLC#market` - [@jromanovs](https://github.com/jromanovs). 
+* [#5](https://github.com/dblock/iex-ruby-client/pull/5): Added `IEX::Resources::OHLC#get` - [@jromanovs](https://github.com/jromanovs).
+* [#5](https://github.com/dblock/iex-ruby-client/pull/5): Added `IEX::Resources::OHLC#market` - [@jromanovs](https://github.com/jromanovs).
 
 ### 0.3.2 (2018/05/26)
 

data/Dangerfile

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

data/Gemfile

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

data/README.md

@@ -6,6 +6,29 @@ IEX Finance API
 
 A Ruby client for the [IEX Finance API](https://iextrading.com/developer).
 
+
+# Table of Contents
+
+- [Installation](#installation)
+- [Methods Available:](#methods-available)
+- [Usage](#usage)
+  - [Get a Single Price](#get-a-single-price)
+  - [Get a Quote](#get-a-quote)
+  - [Get a OHLC (Open, High, Low, Close) price](#get-a-ohlc-open-high-low-close-price)
+  - [Get a market OHLC (Open, High, Low, Close) prices](#get-a-market-ohlc-open-high-low-close-prices)
+  - [Get Company Information](#get-company-information)
+  - [Get a Company Logo](#get-a-company-logo)
+  - [Get Recent News](#get-recent-news)
+  - [Get Chart](#get-chart)
+  - [Get Key Stats](#get-key-stats)
+  - [Get Dividends](#get-dividends)
+- [Errors](#errors)
+  - [SymbolNotFound](#symbolnotfound)
+  - [ClientError](#clienterror)
+- [Contributing](#contributing)
+- [Copyright and License](#copyright-and-license)
+
+
 ## Installation
 
 Add to Gemfile.
@@ -28,6 +51,7 @@ Run `bundle install`.
 - [Get Recent News](#get-recent-news)
 - [Get Chart](#get-chat)
 - [Get Key Stats](#get-key-stats)
+- [Get Dividends](#get-dividends)
 
 
 ## Usage
@@ -154,14 +178,9 @@ first.high # 94.97
 You can specify a chart range and additional options.
 
 ```ruby
-# 1d or 1m data depending on the day or week and time of day
-IEX::Resources::Chart.get('MSFT', 'dynamic')
-
-# a specific date
-IEX::Resources::Chart.get('MSFT', Date.new(2018, 3, 26))
-
-# every n-th data point
-IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10)
+IEX::Resources::Chart.get('MSFT', 'dynamic') # 1d or 1m data depending on the day or week and time of day
+IEX::Resources::Chart.get('MSFT', Date.new(2018, 3, 26)) # a specific date
+IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10) # every n-th data point
 ```
 
 ### Get Key Stats
@@ -237,6 +256,25 @@ key_stats.day_5_change_percent_s # '-0.10%'
 ```
 See [#key-stats](https://iextrading.com/developer/docs/#key-stats) for detailed documentation or [key_stats.rb](lib/iex/resources/key_stats.rb) for returned fields.
 
+### Get Dividends
+
+Fetches dividends for a symbol.
+
+```ruby
+dividends = IEX::Resources::Dividends.get('MSFT', '6m') # Options are: 5y, 2y, 1y, ytd, 6m, 3m, 1m
+
+dividends.payment_date # '2018-03-08'
+dividends.record_date # '2018-02-15'
+dividends.declared_date # '2017-11-29'
+dividends.amount # 0.42
+dividends.amount_dollar # '$0.42'
+dividends.flag # ''
+dividends.type # 'Dividend income'
+dividends.qualified # 'Q'
+dividends.indicated # ''
+```
+See [#dividends](https://iextrading.com/developer/docs/#dividends) for detailed documentation or [dividends.rb](lib/iex/resources/dividends.rb) for returned fields.
+
 
 ## Errors
 

data/iex-ruby-client.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday', '>= 0.9'
   s.add_dependency 'faraday_middleware'
   s.add_dependency 'hashie'
-  s.add_dependency 'money_helper'
+  s.add_dependency 'money_helper', '~> 1.0'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop', '0.51.0'

data/lib/iex/api.rb

@@ -19,6 +19,7 @@ end
 
 require_relative 'api/chart'
 require_relative 'api/company'
+require_relative 'api/dividends'
 require_relative 'api/logo'
 require_relative 'api/key_stats'
 require_relative 'api/news'

data/lib/iex/api/dividends.rb

@@ -0,0 +1,18 @@
+module IEX
+  module Api
+    module Dividends
+      def self.get(symbol, range = nil)
+        connection(symbol, range).get.body
+      end
+
+      def self.connection(symbol, range = nil)
+        IEX::Api.default_connection [
+          symbol,
+          'dividends',
+          range ? '6m' : nil,
+          range
+        ].compact.join('/')
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -1,9 +1,11 @@
 require_relative 'resources/resource'
-require_relative 'resources/quote'
+
+require_relative 'resources/chart'
 require_relative 'resources/company'
-require_relative 'resources/price'
+require_relative 'resources/dividends'
+require_relative 'resources/key_stats'
+require_relative 'resources/logo'
 require_relative 'resources/news'
-require_relative 'resources/chart'
 require_relative 'resources/ohlc'
-require_relative 'resources/logo'
-require_relative 'resources/key_stats'
+require_relative 'resources/price'
+require_relative 'resources/quote'

data/lib/iex/resources/dividends.rb

@@ -0,0 +1,31 @@
+require_relative 'base'
+
+module IEX
+  module Resources
+    class Dividends < Resource
+      property 'payment_date', from: 'paymentDate'
+      property 'record_date', from: 'recordDate'
+      property 'declared_date', from: 'declaredDate'
+      property 'amount'
+      property 'amount_dollar'
+      property 'flag'
+      property 'type'
+      property 'qualified'
+      property 'indicated'
+
+      def initialize(data)
+        super
+        # TODO: require Hashie >= 2.5.8, see https://github.com/intridea/hashie/pull/457
+        self['amount_dollar'] = Base.to_dollar(amount: amount, ignore_cents: false)
+      end
+
+      def self.get(stock_symbol, range = nil)
+        Base.symbol(stock_symbol) do
+          IEX::Api::Dividends.get(stock_symbol, range).map do |data|
+            new data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/iex/resources/key_stats.rb

@@ -26,7 +26,7 @@ module IEX
       property 'symbol'
       property 'ebitda', from: 'EBITDA'
       property 'revenue'
-      property 'revenue_dollar', from: 'revenue', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'revenue_dollar'
       property 'gross_profit', from: 'grossProfit'
       property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { Base.to_dollar(amount: v) }
       property 'cash'
@@ -71,6 +71,12 @@ module IEX
       property 'day_5_change_percent', from: 'day5ChangePercent'
       property 'day_5_change_percent_s', from: 'day5ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
 
+      def initialize(data = {})
+        super
+        # TODO: require Hashie >= 2.5.8, see https://github.com/intridea/hashie/pull/457
+        self['revenue_dollar'] = Base.to_dollar(amount: revenue)
+      end
+
       def self.get(symbol)
         new IEX::Api::KeyStats.get(symbol)
       rescue Faraday::ResourceNotFound => e

data/lib/iex/version.rb

@@ -1,3 +1,3 @@
 module IEX
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.2'.freeze
 end

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

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/INVALID/dividends/6m/INVALID
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      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, 10 Aug 2018 19:58:42 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=b745053a8bbf4a93bb35eb797014e8bd; Domain=.iextrading.com; Path=/; Expires=Sat,
+        11 Aug 2018 07:58:42 GMT; Secure
+      Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      X-Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      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, 10 Aug 2018 19:58:42 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/dividends/msft.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/MSFT/dividends/6m/6m
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      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, 10 Aug 2018 19:58:42 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '371'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=4cd7bd7bcc2c4ee4b5db344ca760c90c; Domain=.iextrading.com; Path=/; Expires=Sat,
+        11 Aug 2018 07:58:42 GMT; Secure
+      Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      X-Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      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: UTF-8
+      string: '[{"exDate":"2018-02-14","paymentDate":"2018-03-08","recordDate":"2018-02-15","declaredDate":"2017-11-29","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""},{"exDate":"2017-11-15","paymentDate":"2017-12-14","recordDate":"2017-11-16","declaredDate":"2017-09-19","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""}]'
+    http_version: 
+  recorded_at: Fri, 10 Aug 2018 19:58:42 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/dividends/msft_1y.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/MSFT/dividends/6m/1y
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      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, 10 Aug 2018 19:58:42 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '371'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=36ba9e13ade0470e938240d302a243c1; Domain=.iextrading.com; Path=/; Expires=Sat,
+        11 Aug 2018 07:58:42 GMT; Secure
+      Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      X-Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      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: UTF-8
+      string: '[{"exDate":"2018-02-14","paymentDate":"2018-03-08","recordDate":"2018-02-15","declaredDate":"2017-11-29","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""},{"exDate":"2017-11-15","paymentDate":"2017-12-14","recordDate":"2017-11-16","declaredDate":"2017-09-19","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""}]'
+    http_version: 
+  recorded_at: Fri, 10 Aug 2018 19:58:42 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/dividends/msft_default_range.yml

@@ -0,0 +1,68 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/MSFT/dividends
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      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:
+      - Sat, 11 Aug 2018 13:16:51 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '186'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=ccb88e016a434ff3b028933badc76184; Domain=.iextrading.com; Path=/; Expires=Sun,
+        12 Aug 2018 01:16:51 GMT; Secure
+      Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      X-Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      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: UTF-8
+      string: '[{"exDate":"2018-02-14","paymentDate":"2018-03-08","recordDate":"2018-02-15","declaredDate":"2017-11-29","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""}]'
+    http_version: 
+  recorded_at: Sat, 11 Aug 2018 13:16:51 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/iex/dividends/msft_invalid_range.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/MSFT/dividends/6m/INVALID
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      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:
+      - Sat, 11 Aug 2018 13:18:55 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '371'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=810c099ba2f8423e9f5adb38c85efd59; Domain=.iextrading.com; Path=/; Expires=Sun,
+        12 Aug 2018 01:18:55 GMT; Secure
+      Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      X-Content-Security-Policy:
+      - default-src 'self'; child-src 'none'; object-src 'none'; style-src 'self'
+        'unsafe-inline'; font-src data:; frame-src 'self'; connect-src 'self' https://auth.iextrading.com
+        https://api.iextrading.com https://api.iextrading.com wss://iextrading.com
+        wss://tops.iextrading.com wss://api.iextrading.com wss://iextrading.com; script-src
+        'self' 'unsafe-inline' 'unsafe-eval';
+      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: UTF-8
+      string: '[{"exDate":"2018-02-14","paymentDate":"2018-03-08","recordDate":"2018-02-15","declaredDate":"2017-11-29","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""},{"exDate":"2017-11-15","paymentDate":"2017-12-14","recordDate":"2017-11-16","declaredDate":"2017-09-19","amount":0.42,"flag":"","type":"Dividend
+        income","qualified":"Q","indicated":""}]'
+    http_version: 
+  recorded_at: Sat, 11 Aug 2018 13:18:55 GMT
+recorded_with: VCR 4.0.0

data/spec/iex/resources/dividends_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe IEX::Resources::Dividends do
+  context 'known symbol' do
+    context 'with defaults', vcr: { cassette_name: 'dividends/msft' } do
+      subject do
+        IEX::Resources::Dividends.get('MSFT', '6m')
+      end
+      let(:dividends) { subject.first }
+      it 'retrieves dividends' do
+        expect(dividends.payment_date).to eq '2018-03-08'
+        expect(dividends.record_date).to eq '2018-02-15'
+        expect(dividends.declared_date).to eq '2017-11-29'
+        expect(dividends.amount_dollar).to eq '$0.42'
+        expect(dividends.flag).to eq ''
+        expect(dividends.type).to eq 'Dividend income'
+        expect(dividends.qualified).to eq 'Q'
+        expect(dividends.indicated).to eq ''
+      end
+    end
+    context 'without range', vcr: { cassette_name: 'dividends/msft_default_range' } do
+      subject do
+        IEX::Resources::Dividends.get('MSFT')
+      end
+      it 'retrieves dividends when no range is passed' do
+        expect(subject.size).to eq 1
+      end
+    end
+    context 'invalid range', vcr: { cassette_name: 'dividends/msft_invalid_range' } do
+      subject do
+        IEX::Resources::Dividends.get('MSFT', 'INVALID')
+      end
+      let(:dividends) { subject.first }
+      it 'retrieves dividends when invalid range is passed' do
+        expect(subject.size).to eq 2 # Falls into default 1 year
+        expect(dividends.type).to eq 'Dividend income'
+      end
+    end
+    context 'with range', vcr: { cassette_name: 'dividends/msft_1y' } do
+      subject do
+        IEX::Resources::Dividends.get('MSFT', '1y')
+      end
+      it 'retrieves dividends with range of 1 year' do
+        expect(subject.size).to eq 2
+      end
+    end
+  end
+  context 'invalid symbol', vcr: { cassette_name: 'dividends/invalid' } do
+    subject do
+      IEX::Resources::Dividends.get('INVALID', 'INVALID')
+    end
+    it 'fails with SymbolNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
+    end
+  end
+end

data/spec/iex/resources/key_stats_spec.rb

@@ -38,6 +38,7 @@ describe IEX::Resources::KeyStats do
       expect(subject.eps_surprise_percent).to eq 11.6279
       expect(subject.eps_surprise_percent_s).to eq '+1162.79%'
       expect(subject.ebitda).to eq 23_558_000_000
+      expect(subject.revenue).to eq 53_456_000_000
       expect(subject.revenue_dollar).to eq '$53,456,000,000'
       expect(subject.gross_profit).to eq 34_114_000_000
       expect(subject.gross_profit_dollar).to eq '$34,114,000,000'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iex-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,16 +56,16 @@ dependencies:
   name: money_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +149,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - LICENSE.md
 - README.md
@@ -160,6 +161,7 @@ files:
 - lib/iex/api.rb
 - lib/iex/api/chart.rb
 - lib/iex/api/company.rb
+- lib/iex/api/dividends.rb
 - lib/iex/api/key_stats.rb
 - lib/iex/api/logo.rb
 - lib/iex/api/news.rb
@@ -176,6 +178,7 @@ files:
 - lib/iex/resources/chart/default.rb
 - lib/iex/resources/chart/one_day.rb
 - lib/iex/resources/company.rb
+- lib/iex/resources/dividends.rb
 - lib/iex/resources/key_stats.rb
 - lib/iex/resources/logo.rb
 - lib/iex/resources/news.rb
@@ -195,6 +198,11 @@ files:
 - spec/fixtures/iex/chart/msft.yml
 - spec/fixtures/iex/company/invalid.yml
 - spec/fixtures/iex/company/msft.yml
+- spec/fixtures/iex/dividends/invalid.yml
+- spec/fixtures/iex/dividends/msft.yml
+- spec/fixtures/iex/dividends/msft_1y.yml
+- spec/fixtures/iex/dividends/msft_default_range.yml
+- spec/fixtures/iex/dividends/msft_invalid_range.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/logo/msft.yml
@@ -211,6 +219,7 @@ files:
 - spec/iex/resources/base_spec.rb
 - spec/iex/resources/chart_spec.rb
 - spec/iex/resources/company_spec.rb
+- spec/iex/resources/dividends_spec.rb
 - spec/iex/resources/key_stats_spec.rb
 - spec/iex/resources/logo_spec.rb
 - spec/iex/resources/news_spec.rb
@@ -254,6 +263,11 @@ test_files:
 - spec/fixtures/iex/chart/msft.yml
 - spec/fixtures/iex/company/invalid.yml
 - spec/fixtures/iex/company/msft.yml
+- spec/fixtures/iex/dividends/invalid.yml
+- spec/fixtures/iex/dividends/msft.yml
+- spec/fixtures/iex/dividends/msft_1y.yml
+- spec/fixtures/iex/dividends/msft_default_range.yml
+- spec/fixtures/iex/dividends/msft_invalid_range.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/logo/msft.yml
@@ -270,6 +284,7 @@ test_files:
 - spec/iex/resources/base_spec.rb
 - spec/iex/resources/chart_spec.rb
 - spec/iex/resources/company_spec.rb
+- spec/iex/resources/dividends_spec.rb
 - spec/iex/resources/key_stats_spec.rb
 - spec/iex/resources/logo_spec.rb
 - spec/iex/resources/news_spec.rb