iex-ruby-client 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c7e9b5e2e6d7d24bdd96a69cc425066f793e3d37
-  data.tar.gz: d5173ee19bc5a824a9ba55e297911c895fe77b69
+SHA256:
+  metadata.gz: aadc76d9ae171fdabe4a3ea228f886eaee9d4eba1be253e340fae6df21a08f67
+  data.tar.gz: 4d0f8dc08ec139b05f0f00ae265487b9c6cc1b13b29b7e8e56935add30651511
 SHA512:
-  metadata.gz: 89c30e29f8fc386597b870ec70f4181f8a7b3db659fc6532caea0c439b0fde7f91375bb8575fe0c8fe0fefbfc0c87d1fe0a0cd56ba87930a2cc41e4bf0d50e9e
-  data.tar.gz: 34697845fe238e7ac05e9a77da770e87fb191aba6865a5291567caed7860aa5afe072d1df2f591e068723028ce4c906f67f87877dd859f43757d77e8c7f517d0
+  metadata.gz: 3ca0fbb369bcc5c5f860c4d29e24c21bca12138b2393f5afc50029f9065bd88862018d760b0d615b84f8579b53e32bfaf410c7fdf4902561809c9d01da94fbb3
+  data.tar.gz: f750e5d85f77744783e4a8a0ff7f335991775971cab7b444996287b948bf71f97d226065e09d0ba5b9af428a80fc1f8abd4cf79ae3e8f19f0b219ca2252916a1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.4.3 (2018/08/18)
+
+* [#27](https://github.com/dblock/iex-ruby-client/pull/27): Added `IEX::Resources::Earnings` - [@rodolfobandeira](https://github.com/rodolfobandeira).
+
 ### 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).

data/Gemfile

@@ -2,11 +2,8 @@ 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'
+  gem 'pry'
 end

data/README.md

@@ -10,7 +10,7 @@ A Ruby client for the [IEX Finance API](https://iextrading.com/developer).
 # Table of Contents
 
 - [Installation](#installation)
-- [Methods Available:](#methods-available)
+- [Methods Available](#methods-available)
 - [Usage](#usage)
   - [Get a Single Price](#get-a-single-price)
   - [Get a Quote](#get-a-quote)
@@ -22,6 +22,7 @@ A Ruby client for the [IEX Finance API](https://iextrading.com/developer).
   - [Get Chart](#get-chart)
   - [Get Key Stats](#get-key-stats)
   - [Get Dividends](#get-dividends)
+  - [Get Earnings](#get-earnings)
 - [Errors](#errors)
   - [SymbolNotFound](#symbolnotfound)
   - [ClientError](#clienterror)
@@ -40,7 +41,7 @@ gem 'iex-ruby-client'
 Run `bundle install`.
 
 
-## Methods Available:
+## Methods Available
 
 - [Get a Single Price](#get-a-single-price)
 - [Get a Quote](#get-a-quote)
@@ -52,6 +53,7 @@ Run `bundle install`.
 - [Get Chart](#get-chat)
 - [Get Key Stats](#get-key-stats)
 - [Get Dividends](#get-dividends)
+- [Get Earnings](#get-earnings)
 
 
 ## Usage
@@ -276,6 +278,32 @@ dividends.indicated # ''
 See [#dividends](https://iextrading.com/developer/docs/#dividends) for detailed documentation or [dividends.rb](lib/iex/resources/dividends.rb) for returned fields.
 
 
+### Get Earnings
+
+Fetches earnings for a symbol.
+
+```ruby
+earnings = IEX::Resources::Earnings.get('MSFT')
+
+earnings.actual_eps # 1.13
+earnings.consensus_eps # 1.07
+earnings.estimated_eps # 1.07
+earnings.announce_time # 'AMC'
+earnings.number_of_estimates # 14
+earnings.eps_surprise_dollar # 0.06
+earnings.eps_report_date # '2018-07-19'
+earnings.fiscal_period # 'Q4 2018'
+earnings.fiscal_end_date # '2018-06-30'
+earnings.year_ago # 0.98
+earnings.year_ago_change_percent # 0.15306122448979584
+earnings.year_ago_change_percent_s # '+15.31%'
+earnings.estimated_change_percent # 0.09183673469387764
+earnings.estimated_change_percent_s # '+9.18%'
+earnings.symbol_id # 4563
+```
+See [#earnings](https://iextrading.com/developer/docs/#earnings) for detailed documentation or [earnings.rb](lib/iex/resources/earnings.rb) for returned fields.
+
+
 ## Errors
 
 ### SymbolNotFound

data/lib/iex/api.rb

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

data/lib/iex/api/chart.rb

@@ -13,12 +13,6 @@ module IEX
       end
 
       def self.connection(symbol, range)
-        puts [
-          symbol,
-          'chart',
-          range && range.respond_to?(:strftime) ? "date/#{range.strftime('%Y%m%d')}" : range
-        ].compact.join('/')
-
         IEX::Api.default_connection [
           symbol,
           'chart',

data/lib/iex/api/earnings.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Api
+    module Earnings
+      def self.get(symbol)
+        connection(symbol).get.body
+      end
+
+      def self.connection(symbol)
+        IEX::Api.default_connection "#{symbol}/earnings"
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -3,6 +3,7 @@ require_relative 'resources/resource'
 require_relative 'resources/chart'
 require_relative 'resources/company'
 require_relative 'resources/dividends'
+require_relative 'resources/earnings'
 require_relative 'resources/key_stats'
 require_relative 'resources/logo'
 require_relative 'resources/news'

data/lib/iex/resources/earnings.rb

@@ -0,0 +1,31 @@
+require_relative 'base'
+
+module IEX
+  module Resources
+    class Earnings < Resource
+      property 'actual_eps', from: 'actualEPS'
+      property 'consensus_eps', from: 'consensusEPS'
+      property 'estimated_eps', from: 'estimatedEPS'
+      property 'announce_time', from: 'announceTime'
+      property 'number_of_estimates', from: 'numberOfEstimates'
+      property 'eps_surprise_dollar', from: 'EPSSurpriseDollar'
+      property 'eps_report_date', from: 'EPSReportDate'
+      property 'fiscal_period', from: 'fiscalPeriod'
+      property 'fiscal_end_date', from: 'fiscalEndDate'
+      property 'year_ago', from: 'yearAgo'
+      property 'year_ago_change_percent', from: 'yearAgoChangePercent'
+      property 'year_ago_change_percent_s', from: 'yearAgoChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'estimated_change_percent', from: 'estimatedChangePercent'
+      property 'estimated_change_percent_s', from: 'estimatedChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'symbol_id', from: 'symbolId'
+
+      def self.get(stock_symbol)
+        Base.symbol(stock_symbol) do
+          IEX::Api::Earnings.get(stock_symbol)['earnings'].map do |data|
+            new data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/iex/version.rb

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

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

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/INVALID/earnings
+    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:
+      - Wed, 15 Aug 2018 01:06:15 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=29d5876cf17f40ebb98f027a7a443647; Domain=.iextrading.com; Path=/; Expires=Wed,
+        15 Aug 2018 13:06:15 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: Wed, 15 Aug 2018 01:06:15 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/MSFT/earnings
+    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:
+      - Wed, 15 Aug 2018 01:14:34 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '1346'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=7590339f2473416cbe5a802b0fbcafc5; Domain=.iextrading.com; Path=/; Expires=Wed,
+        15 Aug 2018 13:14:34 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: '{"symbol":"MSFT","earnings":[{"actualEPS":1.13,"consensusEPS":1.07,"estimatedEPS":1.07,"announceTime":"AMC","numberOfEstimates":14,"EPSSurpriseDollar":0.06,"EPSReportDate":"2018-07-19","fiscalPeriod":"Q4
+        2018","fiscalEndDate":"2018-06-30","yearAgo":0.98,"yearAgoChangePercent":0.15306122448979584,"estimatedChangePercent":0.09183673469387764,"symbolId":4563},{"actualEPS":0.95,"consensusEPS":0.85,"estimatedEPS":0.85,"announceTime":"AMC","numberOfEstimates":14,"EPSSurpriseDollar":0.1,"EPSReportDate":"2018-04-26","fiscalPeriod":"Q3
+        2018","fiscalEndDate":"2018-03-31","yearAgo":0.73,"yearAgoChangePercent":0.3013698630136986,"estimatedChangePercent":0.1643835616438356,"symbolId":4563},{"actualEPS":0.96,"consensusEPS":0.86,"estimatedEPS":0.86,"announceTime":"AMC","numberOfEstimates":14,"EPSSurpriseDollar":0.1,"EPSReportDate":"2018-01-31","fiscalPeriod":"Q2
+        2018","fiscalEndDate":"2017-12-31","yearAgo":0.83,"yearAgoChangePercent":0.1566265060240964,"estimatedChangePercent":0.036144578313253045,"symbolId":4563},{"actualEPS":0.84,"consensusEPS":0.72,"estimatedEPS":0.72,"announceTime":"AMC","numberOfEstimates":14,"EPSSurpriseDollar":0.12,"EPSReportDate":"2017-10-26","fiscalPeriod":"Q1
+        2018","fiscalEndDate":"2017-09-30","yearAgo":0.76,"yearAgoChangePercent":0.1052631578947368,"estimatedChangePercent":-0.05263157894736847,"symbolId":4563}]}'
+    http_version: 
+  recorded_at: Wed, 15 Aug 2018 01:14:34 GMT
+recorded_with: VCR 4.0.0

data/spec/iex/resources/earnings_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe IEX::Resources::Earnings do
+  context 'known symbol' do
+    context 'with defaults', vcr: { cassette_name: 'earnings/msft' } do
+      subject do
+        IEX::Resources::Earnings.get('MSFT')
+      end
+      let(:earnings) { subject.first }
+      it 'retrieves earnings' do
+        expect(subject.size).to eq 4
+        expect(earnings.actual_eps).to eq 1.13
+        expect(earnings.consensus_eps).to eq 1.07
+        expect(earnings.estimated_eps).to eq 1.07
+        expect(earnings.announce_time).to eq 'AMC'
+        expect(earnings.number_of_estimates).to eq 14
+        expect(earnings.eps_surprise_dollar).to eq 0.06
+        expect(earnings.eps_report_date).to eq '2018-07-19'
+        expect(earnings.fiscal_period).to eq 'Q4 2018'
+        expect(earnings.fiscal_end_date).to eq '2018-06-30'
+        expect(earnings.year_ago).to eq 0.98
+        expect(earnings.year_ago_change_percent).to eq 0.15306122448979584
+        expect(earnings.year_ago_change_percent_s).to eq '+15.31%'
+        expect(earnings.estimated_change_percent).to eq 0.09183673469387764
+        expect(earnings.estimated_change_percent_s).to eq '+9.18%'
+        expect(earnings.symbol_id).to eq 4563
+      end
+    end
+  end
+  context 'invalid symbol', vcr: { cassette_name: 'earnings/invalid' } do
+    subject do
+      IEX::Resources::Earnings.get('INVALID')
+    end
+    it 'fails with SymbolNotFoundError' do
+      expect { subject }.to raise_error IEX::Errors::SymbolNotFoundError, 'Symbol INVALID Not Found'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iex-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,6 +162,7 @@ files:
 - lib/iex/api/chart.rb
 - lib/iex/api/company.rb
 - lib/iex/api/dividends.rb
+- lib/iex/api/earnings.rb
 - lib/iex/api/key_stats.rb
 - lib/iex/api/logo.rb
 - lib/iex/api/news.rb
@@ -179,6 +180,7 @@ files:
 - lib/iex/resources/chart/one_day.rb
 - lib/iex/resources/company.rb
 - lib/iex/resources/dividends.rb
+- lib/iex/resources/earnings.rb
 - lib/iex/resources/key_stats.rb
 - lib/iex/resources/logo.rb
 - lib/iex/resources/news.rb
@@ -203,6 +205,8 @@ files:
 - 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/earnings/invalid.yml
+- spec/fixtures/iex/earnings/msft.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/logo/msft.yml
@@ -220,6 +224,7 @@ files:
 - spec/iex/resources/chart_spec.rb
 - spec/iex/resources/company_spec.rb
 - spec/iex/resources/dividends_spec.rb
+- spec/iex/resources/earnings_spec.rb
 - spec/iex/resources/key_stats_spec.rb
 - spec/iex/resources/logo_spec.rb
 - spec/iex/resources/news_spec.rb
@@ -249,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: IEX Finance API Ruby client with support for retrieving stock quotes.
@@ -268,6 +273,8 @@ test_files:
 - 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/earnings/invalid.yml
+- spec/fixtures/iex/earnings/msft.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/logo/msft.yml
@@ -285,6 +292,7 @@ test_files:
 - spec/iex/resources/chart_spec.rb
 - spec/iex/resources/company_spec.rb
 - spec/iex/resources/dividends_spec.rb
+- spec/iex/resources/earnings_spec.rb
 - spec/iex/resources/key_stats_spec.rb
 - spec/iex/resources/logo_spec.rb
 - spec/iex/resources/news_spec.rb