iex-ruby-client 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc54c99b44f20089d95fa121c4bdf07c799bcf85
-  data.tar.gz: c8ffcde3452f7141c61342f510d2700f6c0a0bbf
+  metadata.gz: 2b9626afa318608562e32bba7dc1efa03d11928a
+  data.tar.gz: ed9d9e67df2e48214b7b8fce95169b175f806571
 SHA512:
-  metadata.gz: cc798095fd893860bcf460bd836c6c0c8922f4a5831df83184842a2a5be537008220f51e42a5bdfab29a791b0ef7d9f28fd50b9781e59d8fc7d0a4b9238de331
-  data.tar.gz: cbad4c6f007f914c7548a92cdc5c9b0a77ea60c7b9f4dfd73a38c96930d8ccfca0f0ae0f436e6709e207c4afa91951b73f80c906361d86577b9757fe57ae8a62
+  metadata.gz: 4df0e3c0b89750c3a5206de7329cb07ebd6de89fe43e55ac9d55649ab2c30d38ebfc3edf696208ffdabb2b3d2c355bbc0ed93034ee3b0e6b955bf29c32307922
+  data.tar.gz: a4603bca3d2106fb42cd24e9bdfe8fadc930e6a7a7954b8d5d82e7747fa03767a0446aedd1548cd00a8eb07d977831313d3a4fc49487ef0ada48b9a142e927bf

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,7 @@
+### 1.1.0 (2019/07/08)
+
+* [#55](https://github.com/dblock/iex-ruby-client/pull/55): Add `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).

data/README.md

@@ -22,6 +22,7 @@ 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)
@@ -216,7 +217,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 +294,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.

data/iex-ruby-client.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   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

@@ -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'

data/lib/iex/api/client.rb

@@ -6,6 +6,7 @@ module IEX
       include Endpoints::Crypto
       include Endpoints::Dividends
       include Endpoints::Earnings
+      include Endpoints::Income
       include Endpoints::KeyStats
       include Endpoints::LargestTrades
       include Endpoints::Logo

data/lib/iex/endpoints/chart.rb

@@ -10,11 +10,10 @@ module IEX
         ].compact.join('/')
 
         params = {}
-        if options
-          options.each_pair do |k, v|
-            k = k.to_s.split('_').map(&:capitalize).join.sub(/^[A-Z]/, &:downcase)
-            params[k.to_sym] = v
-          end
+
+        options&.each_pair do |k, v|
+          k = k.to_s.split('_').map(&:capitalize).join.sub(/^[A-Z]/, &:downcase)
+          params[k.to_sym] = v
         end
 
         response = get(url, params)

data/lib/iex/endpoints/income.rb

@@ -0,0 +1,13 @@
+module IEX
+  module Endpoints
+    module Income
+      def income(symbol, options = {})
+        get("stock/#{symbol}/income", options)['income'].map do |data|
+          IEX::Resources::Income.new(data)
+        end
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -4,6 +4,7 @@ require_relative 'resources/chart'
 require_relative 'resources/company'
 require_relative 'resources/dividends'
 require_relative 'resources/earnings'
+require_relative 'resources/income'
 require_relative 'resources/key_stats'
 require_relative 'resources/largest_trades'
 require_relative 'resources/logo'

data/lib/iex/resources/chart.rb

@@ -18,7 +18,7 @@ module IEX
         property 'change_percent', from: 'changePercent'
         property 'change_percent_s', from: 'changePercent', with: lambda { |v|
           [
-            v > 0 ? '+' : '',
+            v.positive? ? '+' : '',
             format('%.2f', v),
             '%'
           ].join

data/lib/iex/resources/company.rb

@@ -12,6 +12,7 @@ module IEX
       property 'issue_type', from: 'issueType' # common issue type of the stock
       property 'sector'
       property 'employees'
+      property 'tags'
     end
   end
 end

data/lib/iex/resources/income.rb

@@ -0,0 +1,36 @@
+module IEX
+  module Resources
+    class Income < Resource
+      property 'report_date', from: 'reportDate'
+      property 'total_revenue', from: 'totalRevenue'
+      property 'total_revenue_dollar', from: 'totalRevenue', with: ->(v) { to_dollar(amount: v) }
+      property 'cost_of_revenue', from: 'costOfRevenue'
+      property 'cost_of_revenue_dollar', from: 'costOfRevenue', with: ->(v) { to_dollar(amount: v) }
+      property 'gross_profit', from: 'grossProfit'
+      property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { to_dollar(amount: v) }
+      property 'research_and_development', from: 'researchAndDevelopment'
+      property 'research_and_development_dollar', from: 'researchAndDevelopment', with: ->(v) { to_dollar(amount: v) }
+      property 'selling_general_and_admin', from: 'sellingGeneralAndAdmin'
+      property 'selling_general_and_admin_dollar', from: 'sellingGeneralAndAdmin', with: ->(v) { to_dollar(amount: v) }
+      property 'operating_expense', from: 'operatingExpense'
+      property 'operating_expense_dollar', from: 'operatingExpense', with: ->(v) { to_dollar(amount: v) }
+      property 'operating_income', from: 'operatingIncome'
+      property 'operating_income_dollar', from: 'operatingIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'other_income_expense_net', from: 'otherIncomeExpenseNet'
+      property 'other_income_expense_net_dollar', from: 'otherIncomeExpenseNet', with: ->(v) { to_dollar(amount: v) }
+      property 'ebit'
+      property 'ebit_dollar', from: 'ebit', with: ->(v) { to_dollar(amount: v) }
+      property 'interest_income', from: 'interestIncome'
+      property 'interest_income_dollar', from: 'interestIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'pretax_income', from: 'pretaxIncome'
+      property 'pretax_income_dollar', from: 'pretaxIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'income_tax', from: 'incomeTax'
+      property 'income_tax_dollar', from: 'incomeTax', with: ->(v) { to_dollar(amount: v) }
+      property 'minority_interest', from: 'minorityInterest'
+      property 'net_income', from: 'netIncome'
+      property 'net_income_dollar', from: 'netIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'net_income_basic', from: 'netIncomeBasic'
+      property 'net_income_basic_dollar', from: 'netIncomeBasic', with: ->(v) { to_dollar(amount: v) }
+    end
+  end
+end

data/lib/iex/resources/key_stats.rb

@@ -3,7 +3,7 @@ module IEX
     class KeyStats < Resource
       property 'company_name', from: 'companyName'
       property 'market_cap', from: 'marketcap'
-      property 'market_cap_dollars', from: 'marketcap', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'market_cap_dollar', from: 'marketcap', with: ->(v) { Resource.to_dollar(amount: v) }
       property 'week_52_high', from: 'week52high'
       property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
       property 'week_52_low', from: 'week52low'

data/lib/iex/resources/quote.rb

@@ -16,12 +16,12 @@ module IEX
       property 'latest_source', from: 'latestSource' # the source of latestPrice - IEX real time price, 15 minute delayed price, Close or Previous close
       property 'latest_time', from: 'latestTime' # human readable time of the latestPrice
       property 'latest_update', from: 'latestUpdate' # the update time of latestPrice in milliseconds since midnight Jan 1, 1970
-      property 'latest_update_t', from: 'latestUpdate', with: ->(v) { v && v > 0 ? Time.at(v / 1000) : nil } # the update time of latestPrice
+      property 'latest_update_t', from: 'latestUpdate', with: ->(v) { v&.positive? ? Time.at(v / 1000) : nil } # the update time of latestPrice
       property 'latest_volume', from: 'latestVolume' # the total market volume of the stock
       property 'iex_realtime_price', from: 'iexRealtimePrice' # last sale price of the stock on IEX
       property 'iex_realtime_size', from: 'iexRealtimeSize' # last sale size of the stock on IEX
       property 'iex_last_updated', from: 'iexLastUpdated' # last update time of the data in milliseconds since midnight Jan 1, 1970 UTC or -1 or 0; if the value is -1 or 0, IEX has not quoted the symbol in the trading day
-      property 'iex_last_updated_t', from: 'iexLastUpdated', with: ->(v) { v && v > 0 ? Time.at(v / 1000) : nil } # last update time of the data
+      property 'iex_last_updated_t', from: 'iexLastUpdated', with: ->(v) { v&.positive? ? Time.at(v / 1000) : nil } # last update time of the data
       property 'delayed_price', from: 'delayedPrice' # 15 minute delayed market price
       property 'delayed_price_time', from: 'delayedPriceTime' # time of the delayed market price
       property 'extended_price', from: 'extendedPrice' # ?
@@ -32,7 +32,7 @@ module IEX
       property 'change_percent_s', from: 'changePercent', with: lambda { |v|
         if v
           [
-            v > 0 ? '+' : '',
+            v.positive? ? '+' : '',
             format('%.2f', v * 100),
             '%'
           ].join

data/lib/iex/resources/resource.rb

@@ -8,7 +8,7 @@ module IEX
         return '+0.00%' if float_number.zero?
 
         [
-          float_number > 0 ? '+' : '',
+          float_number.positive? ? '+' : '',
           format('%.2f', float_number * 100),
           '%'
         ].join

data/lib/iex/version.rb

@@ -1,3 +1,3 @@
 module IEX
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

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

@@ -0,0 +1,49 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://cloud.iexapis.com/v1/stock/INVALID/earnings?token=test-iex-api-publishable-token
+      body:
+        encoding: US-ASCII
+        string: ""
+      headers:
+        Accept:
+          - application/json; charset=utf-8
+        User-Agent:
+          - IEX Ruby Client/1.0.1
+        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:
+          - Mon, 08 Jul 2019 05:44:19 GMT
+        Content-Type:
+          - text/html; charset=utf-8
+        Transfer-Encoding:
+          - chunked
+        Connection:
+          - keep-alive
+        Set-Cookie:
+          - ctoken=5eb12a74846a4e03b399e201d6853f6a; Max-Age=43200; Path=/; Expires=Mon,
+            08 Jul 2019 17:44:19 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
+      body:
+        encoding: ASCII-8BIT
+        string: Unknown symbol
+      http_version:
+    recorded_at: Mon, 08 Jul 2019 05:44:19 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,53 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://cloud.iexapis.com/v1/stock/MSFT/income?token=test-iex-api-publishable-token
+      body:
+        encoding: US-ASCII
+        string: ""
+      headers:
+        Accept:
+          - application/json; charset=utf-8
+        User-Agent:
+          - IEX Ruby Client/1.0.1
+        Accept-Encoding:
+          - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Server:
+          - nginx
+        Date:
+          - Mon, 08 Jul 2019 04:53:26 GMT
+        Content-Type:
+          - application/json; charset=utf-8
+        Transfer-Encoding:
+          - chunked
+        Connection:
+          - keep-alive
+        Set-Cookie:
+          - ctoken=153fb65c56854cf995c8112a5cd5f554; Max-Age=43200; Path=/; Expires=Mon,
+            08 Jul 2019 16:53:26 GMT
+        Iexcloud-Messages-Used:
+          - "1000"
+        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":"MSFT","income":[{"reportDate":"2019-03-31","totalRevenue":30505000000,"costOfRevenue":10170000000,"grossProfit":20335000000,"researchAndDevelopment":4316000000,"sellingGeneralAndAdmin":5744000000,"operatingExpense":20230000000,"operatingIncome":10275000000,"otherIncomeExpenseNet":211000000,"ebit":10275000000,"interestIncome":671000000,"pretaxIncome":10486000000,"incomeTax":1677000000,"minorityInterest":0,"netIncome":8809000000,"netIncomeBasic":8809000000}]}'
+      http_version:
+    recorded_at: Mon, 08 Jul 2019 04:53:26 GMT
+recorded_with: VCR 4.0.0

data/spec/iex/endpoints/company_spec.rb

@@ -19,6 +19,7 @@ describe IEX::Resources::Company do
       expect(subject.sector).to eq 'Technology Services'
       expect(subject.employees).to eq 131_000
       expect(subject.security_name).to eq 'Microsoft Corporation'
+      expect(subject.tags).to eq ['Technology Services', 'Packaged Software']
     end
   end
   context 'invalid symbol', vcr: { cassette_name: 'company/invalid' } do

data/spec/iex/endpoints/income_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe IEX::Resources::Income do
+  include_context 'client'
+
+  context 'known symbol' do
+    context 'with defaults', vcr: { cassette_name: 'income/msft' } do
+      subject do
+        client.income('MSFT')
+      end
+      let(:income) { subject.first }
+
+      it 'retrieves income statement' do
+        expect(subject.size).to eq 1
+        expect(income.report_date).to eq '2019-03-31'
+        expect(income.total_revenue).to eq 30_505_000_000
+        expect(income.total_revenue_dollar).to eq '$30,505,000,000'
+        expect(income.cost_of_revenue).to eq 10_170_000_000
+        expect(income.cost_of_revenue_dollar).to eq '$10,170,000,000'
+        expect(income.gross_profit).to eq 20_335_000_000
+        expect(income.gross_profit_dollar).to eq '$20,335,000,000'
+        expect(income.research_and_development).to eq 4_316_000_000
+        expect(income.research_and_development_dollar).to eq '$4,316,000,000'
+        expect(income.selling_general_and_admin).to eq 5_744_000_000
+        expect(income.selling_general_and_admin_dollar).to eq '$5,744,000,000'
+        expect(income.operating_expense).to eq 20_230_000_000
+        expect(income.operating_expense_dollar).to eq '$20,230,000,000'
+        expect(income.operating_income).to eq 10_275_000_000
+        expect(income.operating_income_dollar).to eq '$10,275,000,000'
+        expect(income.other_income_expense_net).to eq 211_000_000
+        expect(income.other_income_expense_net_dollar).to eq '$211,000,000'
+        expect(income.ebit_dollar).to eq '$10,275,000,000'
+        expect(income.ebit).to eq 10_275_000_000
+        expect(income.interest_income).to eq 671_000_000
+        expect(income.interest_income_dollar).to eq '$671,000,000'
+        expect(income.pretax_income).to eq 10_486_000_000
+        expect(income.pretax_income_dollar).to eq '$10,486,000,000'
+        expect(income.income_tax).to eq 1_677_000_000
+        expect(income.income_tax_dollar).to eq '$1,677,000,000'
+        expect(income.minority_interest).to eq 0
+        expect(income.net_income).to eq 8_809_000_000
+        expect(income.net_income_dollar).to eq '$8,809,000,000'
+        expect(income.net_income_basic).to eq 8_809_000_000
+        expect(income.net_income_basic_dollar).to eq '$8,809,000,000'
+      end
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'income/invalid' } do
+    subject do
+      client.earnings('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/endpoints/key_stats_spec.rb

@@ -10,7 +10,7 @@ describe IEX::Resources::KeyStats do
     it 'retrieves a keyStats' do
       expect(subject.company_name).to eq 'Microsoft Corp.'
       expect(subject.market_cap).to eq 990_869_169_557
-      expect(subject.market_cap_dollars).to eq '$990,869,169,557'
+      expect(subject.market_cap_dollar).to eq '$990,869,169,557'
       expect(subject.employees).to eq 133_074
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iex-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.72.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.72.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,7 @@ files:
 - lib/iex/endpoints/crypto.rb
 - lib/iex/endpoints/dividends.rb
 - lib/iex/endpoints/earnings.rb
+- lib/iex/endpoints/income.rb
 - lib/iex/endpoints/key_stats.rb
 - lib/iex/endpoints/largest_trades.rb
 - lib/iex/endpoints/logo.rb
@@ -189,6 +190,7 @@ files:
 - lib/iex/resources/crypto.rb
 - lib/iex/resources/dividends.rb
 - lib/iex/resources/earnings.rb
+- lib/iex/resources/income.rb
 - lib/iex/resources/key_stats.rb
 - lib/iex/resources/largest_trades.rb
 - lib/iex/resources/logo.rb
@@ -216,6 +218,8 @@ files:
 - spec/fixtures/iex/dividends/msft_invalid_range.yml
 - spec/fixtures/iex/earnings/invalid.yml
 - spec/fixtures/iex/earnings/msft.yml
+- spec/fixtures/iex/income/invalid.yml
+- spec/fixtures/iex/income/msft.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/largest-trades/aapl.yml
@@ -239,6 +243,7 @@ files:
 - spec/iex/endpoints/crypto_spec.rb
 - spec/iex/endpoints/dividends_spec.rb
 - spec/iex/endpoints/earnings_spec.rb
+- spec/iex/endpoints/income_spec.rb
 - spec/iex/endpoints/key_stats_spec.rb
 - spec/iex/endpoints/largest_trades_spec.rb
 - spec/iex/endpoints/logo_spec.rb
@@ -295,6 +300,8 @@ 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/income/invalid.yml
+- spec/fixtures/iex/income/msft.yml
 - spec/fixtures/iex/key_stats/invalid.yml
 - spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/largest-trades/aapl.yml
@@ -318,6 +325,7 @@ test_files:
 - spec/iex/endpoints/crypto_spec.rb
 - spec/iex/endpoints/dividends_spec.rb
 - spec/iex/endpoints/earnings_spec.rb
+- spec/iex/endpoints/income_spec.rb
 - spec/iex/endpoints/key_stats_spec.rb
 - spec/iex/endpoints/largest_trades_spec.rb
 - spec/iex/endpoints/logo_spec.rb