iex-ruby-client 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 122b8435449269a11df3e45d0c9742f2cc23090d
-  data.tar.gz: d7581662b889893a85d771d79c3bcbbd657b7273
+  metadata.gz: 31f82e417e023dae4b43a116a26c363f998452ee
+  data.tar.gz: f567de4892dbc778d9c4a285269d9fb2bfc2a204
 SHA512:
-  metadata.gz: 66c2cf2f5e2df6f46aea535436961d0aac6adf86259d135411f7879ab41db1e750e47275255a27db4b4c37ab187d579e1a69d72dc4d86e19c2ef26b721b5d6ae
-  data.tar.gz: 73611d7582829ef959585c72114d4f1bc135a4afad69b0765b308a00f02fa58516dfc680d4b9e416909ff416d6b31e338b508b302fbc54d6fd7e054b1bbfb138
+  metadata.gz: 8682c270ea7b9fb8a19deb4b6423252bcbd4b8fd1bdfb5b1805b28d94866309a126bbccea0c70b6c1b58e00e216e2315509f982bac3c20f701a1e5882a1d50a5
+  data.tar.gz: ea4d46ac096195a920681dc104a1822d97544c97a1089b2a386030f76e284147b6581e64fb87a20742c0f75695d1ec2a27749159240c907fe5e57f6f3701c19c

data/.rubocop_todo.yml

@@ -1,28 +1,28 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-27 05:38:15 -0400 using RuboCop version 0.58.2.
+# on 2018-08-05 20:08:18 -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: 1
-Metrics/AbcSize:
-  Max: 16
-
-# Offense count: 5
+# Offense count: 9
 # Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 79
+  Max: 85
+
+# Offense count: 64
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 221
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 17
+  Max: 15
 
 # Offense count: 1
-# Configuration parameters: AllowedChars.
 Style/AsciiComments:
   Exclude:
     - 'lib/iex/resources/quote.rb'
@@ -33,12 +33,6 @@ Style/DateTime:
     - 'lib/iex/resources/news.rb'
     - 'spec/iex/resources/news_spec.rb'
 
-# Offense count: 23
+# Offense count: 26
 Style/Documentation:
   Enabled: false
-
-# Offense count: 43
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 221

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 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).
+
 ### 0.4.0 (2018/07/29)
 
 * [#9](https://github.com/dblock/iex-ruby-client/pull/9): Added `IEX::Errors::ClientError` - [@rodolfobandeira](https://github.com/rodolfobandeira).

data/README.md

@@ -16,6 +16,20 @@ gem 'iex-ruby-client'
 
 Run `bundle install`.
 
+
+## Methods Available:
+
+- [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 Company Logo](#get-company-logo)
+- [Get Recent News](#get-recent-news)
+- [Get Chart](#get-chat)
+- [Get Key Stats](#get-key-stats)
+
+
 ## Usage
 
 ### Get a Single Price
@@ -83,7 +97,7 @@ company.company_name # 'Microsoft Corporation'
 
 See [#company](https://iextrading.com/developer/docs/#company) for detailed documentation or [company.rb](lib/iex/resources/company.rb) for returned fields.
 
-### Get Company Logo
+### Get a Company Logo
 
 Fetches company logo for a symbol.
 
@@ -150,7 +164,79 @@ IEX::Resources::Chart.get('MSFT', Date.new(2018, 3, 26))
 IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10)
 ```
 
-See [#chart](https://iextrading.com/developer/docs/#chart) for detailed documentation or [chart/default](lib/iex/resources/chart/default.rb) and [chart/one_day](lib/iex/resources/chart/one_day.rb) for returned fields.
+### Get Key Stats
+
+Fetches company's key stats for a symbol.
+
+```ruby
+key_stats = IEX::Resources::KeyStats.get('MSFT')
+
+key_stats.symbol # MSFT
+key_stats.market_cap # 825814890000
+key_stats.market_cap_dollars # '$825,814,890,000'
+key_stats.beta # 1.261768
+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.short_interest # 47158592
+key_stats.short_date # '2018-07-13'
+key_stats.dividend_rate # 1.68
+key_stats.dividend_yield # 1.5617738
+key_stats.ex_dividend_date # '2018-08-15 00:00:00.0'
+key_stats.latest_eps # 2.11
+key_stats.latest_eps_date # '2018-06-30'
+key_stats.shares_outstanding # 7677000000
+key_stats.float # 7217387757
+key_stats.return_on_equity # 20.82
+key_stats.consensus_eps # 0.86
+key_stats.number_of_estimates # 14
+key_stats.eps_surprise_dollar # nil
+key_stats.eps_surprise_percent # 11.6279
+key_stats.eps_surprise_percent_s # '+1162.79%'
+key_stats.ebitda # 23558000000
+key_stats.revenue_dollar # '$53,456,000,000'
+key_stats.gross_profit # 34114000000
+key_stats.gross_profit_dollar # '$34,114,000,000'
+key_stats.cash_dollar # '$281,251,000,000'
+key_stats.ttm_eps # 3.51
+key_stats.revenue_per_share # 7
+key_stats.revenue_per_employee # 431097
+key_stats.pe_ratio_high # 0
+key_stats.pe_ratio_low # 0
+key_stats.return_on_assets # 6.46
+key_stats.return_on_capital # nil
+key_stats.profit_margin # 15.1
+key_stats.price_to_sales # 7.393182
+key_stats.price_to_sales_dollar # '$7.39'
+key_stats.price_to_book # 10.73
+key_stats.price_to_book_dollar # '$10.73'
+key_stats.day_200_moving_avg # 91.99065
+key_stats.day_50_moving_avg # 102.2528
+key_stats.institution_percent # 75.1
+key_stats.institution_percent_s # '+7510.00%'
+key_stats.insider_percent # nil
+key_stats.insider_percent_s # nil
+key_stats.short_ratio # 1.7330703
+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%'
+```
+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.
+
 
 ## Errors
 

data/iex-ruby-client.gemspec

@@ -18,6 +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_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop', '0.51.0'

data/lib/iex-ruby-client.rb

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

data/lib/iex/api.rb

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

data/lib/iex/api/key_stats.rb

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

data/lib/iex/resources.rb

@@ -6,3 +6,4 @@ require_relative 'resources/news'
 require_relative 'resources/chart'
 require_relative 'resources/ohlc'
 require_relative 'resources/logo'
+require_relative 'resources/key_stats'

data/lib/iex/resources/base.rb

@@ -8,6 +8,20 @@ module IEX
       rescue Faraday::ClientError => e
         raise IEX::Errors::ClientError, e.response
       end
+
+      def self.float_to_percentage(float_number)
+        return unless float_number.is_a? Numeric
+        return '+0.00%' if float_number.zero?
+        [
+          float_number > 0 ? '+' : '',
+          format('%.2f', float_number * 100),
+          '%'
+        ].join
+      end
+
+      def self.to_dollar(amount:, ignore_cents: true)
+        MoneyHelper.money_to_text(amount, 'USD', nil, no_cents: ignore_cents)
+      end
     end
   end
 end

data/lib/iex/resources/key_stats.rb

@@ -0,0 +1,81 @@
+module IEX
+  module Resources
+    class KeyStats < Resource
+      property 'company_name', from: 'companyName'
+      property 'market_cap', from: 'marketcap'
+      property 'market_cap_dollars', from: 'marketcap', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'beta'
+      property 'week_52_high', from: 'week52high'
+      property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
+      property 'week_52_low', from: 'week52low'
+      property 'week_52_low_dollar', from: 'week52low', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
+      property 'week_52_change'
+      property 'week_52_change_dollar', from: 'week52change', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
+      property 'short_interest', from: 'shortInterest'
+      property 'short_date', from: 'shortDate'
+      property 'dividend_rate', from: 'dividendRate'
+      property 'dividend_yield', from: 'dividendYield'
+      property 'ex_dividend_date', from: 'exDividendDate'
+      property 'latest_eps', from: 'latestEPS'
+      property 'latest_eps_date', from: 'latestEPSDate'
+      property 'shares_outstanding', from: 'sharesOutstanding'
+      property 'float'
+      property 'return_on_equity', from: 'returnOnEquity'
+      property 'consensus_eps', from: 'consensusEPS'
+      property 'number_of_estimates', from: 'numberOfEstimates'
+      property 'symbol'
+      property 'ebitda', from: 'EBITDA'
+      property 'revenue'
+      property 'revenue_dollar', from: 'revenue', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'gross_profit', from: 'grossProfit'
+      property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'cash'
+      property 'cash_dollar', from: 'cash', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'dept'
+      property 'dept_dollar', from: 'dept', with: ->(v) { Base.to_dollar(amount: v) }
+      property 'ttm_eps', from: 'ttmEPS'
+      property 'revenue_per_share', from: 'revenuePerShare'
+      property 'revenue_per_employee', from: 'revenuePerEmployee'
+      property 'pe_ratio_high', from: 'peRatioHigh'
+      property 'pe_ratio_low', from: 'peRatioLow'
+      property 'eps_surprise_dollar', from: 'EPSSurpriseDollar'
+      property 'eps_surprise_percent', from: 'EPSSurprisePercent'
+      property 'eps_surprise_percent_s', from: 'EPSSurprisePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'return_on_assets', from: 'returnOnAssets'
+      property 'return_on_capital', from: 'returnOnCapital'
+      property 'profit_margin', from: 'profitMargin'
+      property 'price_to_sales', from: 'priceToSales'
+      property 'price_to_book', from: 'priceToBook'
+      property 'price_to_sales_dollar', from: 'priceToSales', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
+      property 'price_to_book_dollar', from: 'priceToBook', with: ->(v) { Base.to_dollar(amount: v, ignore_cents: false) }
+      property 'day_200_moving_avg', from: 'day200MovingAvg'
+      property 'day_50_moving_avg', from: 'day50MovingAvg'
+      property 'institution_percent', from: 'institutionPercent'
+      property 'institution_percent_s', from: 'institutionPercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'insider_percent', from: 'insiderPercent'
+      property 'insider_percent_s', from: 'insiderPercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'short_ratio', from: 'shortRatio'
+      property 'year_5_change_percent', from: 'year5ChangePercent'
+      property 'year_5_change_percent_s', from: 'year5ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'year_2_change_percent', from: 'year2ChangePercent'
+      property 'year_2_change_percent_s', from: 'year2ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'year_1_change_percent', from: 'year1ChangePercent'
+      property 'year_1_change_percent_s', from: 'year1ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'ytd_change_percent', from: 'ytdChangePercent'
+      property 'month_6_change_percent', from: 'month6ChangePercent'
+      property 'month_6_change_percent_s', from: 'month6ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'month_3_change_percent', from: 'month3ChangePercent'
+      property 'month_3_change_percent_s', from: 'month3ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'month_1_change_percent', from: 'month1ChangePercent'
+      property 'month_1_change_percent_s', from: 'month1ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+      property 'day_5_change_percent', from: 'day5ChangePercent'
+      property 'day_5_change_percent_s', from: 'day5ChangePercent', with: ->(v) { Base.float_to_percentage(v) }
+
+      def self.get(symbol)
+        new IEX::Api::KeyStats.get(symbol)
+      rescue Faraday::ResourceNotFound => e
+        raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
+      end
+    end
+  end
+end

data/lib/iex/version.rb

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

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

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/INVALID/stats
+    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, 03 Aug 2018 23:45:27 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=f749efd72bd44615ae05dbd800720ac3; Domain=.iextrading.com; Path=/; Expires=Sat,
+        04 Aug 2018 11:45:27 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, 03 Aug 2018 23:45:27 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,68 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.iextrading.com/1.0/stock/MSFT/stats
+    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, 03 Aug 2018 23:45:26 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '1311'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=743c58ee68264c2c8adc8b1713024ad6; Domain=.iextrading.com; Path=/; Expires=Sat,
+        04 Aug 2018 11:45:26 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: '{"companyName":"Microsoft Corporation","marketcap":825814890000,"beta":1.261768,"week52high":111.15,"week52low":71.28,"week52change":51.7715,"shortInterest":47158592,"shortDate":"2018-07-13","dividendRate":1.68,"dividendYield":1.5617738,"exDividendDate":"2018-08-15
+        00:00:00.0","latestEPS":2.11,"latestEPSDate":"2018-06-30","sharesOutstanding":7677000000,"float":7217387757,"returnOnEquity":20.82,"consensusEPS":0.86,"numberOfEstimates":14,"EPSSurpriseDollar":null,"EPSSurprisePercent":11.6279,"symbol":"MSFT","EBITDA":23558000000,"revenue":53456000000,"grossProfit":34114000000,"cash":281251000000,"debt":180503000000,"ttmEPS":3.51,"revenuePerShare":7,"revenuePerEmployee":431097,"peRatioHigh":0,"peRatioLow":0,"returnOnAssets":6.46,"returnOnCapital":null,"profitMargin":15.1,"priceToSales":7.393182,"priceToBook":10.73,"day200MovingAvg":91.99065,"day50MovingAvg":102.2528,"institutionPercent":75.1,"insiderPercent":null,"shortRatio":1.7330703,"year5ChangePercent":2.85141424991049,"year2ChangePercent":0.9732002824884664,"year1ChangePercent":0.5200287133805482,"ytdChangePercent":0.2628699562098638,"month6ChangePercent":0.23345097958275707,"month3ChangePercent":0.14846686026648437,"month1ChangePercent":0.08601716304896513,"day5ChangePercent":-0.0010215453194652084,"day30ChangePercent":0.06357524223848124}'
+    http_version: 
+  recorded_at: Fri, 03 Aug 2018 23:45:26 GMT
+recorded_with: VCR 4.0.0

data/spec/iex/resources/base_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe IEX::Resources::Base do
+  context 'float number to percent (Positive)' do
+    subject do
+      IEX::Resources::Base.float_to_percentage(0.09123)
+    end
+    it 'converts to percentage' do
+      expect(subject).to eq '+9.12%'
+    end
+  end
+
+  context 'float number to percent (Negative)' do
+    subject do
+      IEX::Resources::Base.float_to_percentage(-0.09123)
+    end
+    it 'converts to percentage' do
+      expect(subject).to eq '-9.12%'
+    end
+  end
+
+  context 'float number to percent (nil)' do
+    subject do
+      IEX::Resources::Base.float_to_percentage(nil)
+    end
+    it 'nil argument does not convert' do
+      expect(subject).to eq nil
+    end
+  end
+
+  context 'float number to percent (0)' do
+    subject do
+      IEX::Resources::Base.float_to_percentage(0)
+    end
+    it 'Zero converts to +0.00%' do
+      expect(subject).to eq '+0.00%'
+    end
+  end
+
+  context 'Unformatted money amount to dollar' do
+    subject do
+      IEX::Resources::Base.to_dollar(amount: 123_391)
+    end
+    it 'converts to dollar' do
+      expect(subject).to eq '$123,391'
+    end
+  end
+end

data/spec/iex/resources/key_stats_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe IEX::Resources::KeyStats do
+  context 'general information', vcr: { cassette_name: 'key_stats/msft' } do
+    subject do
+      IEX::Resources::KeyStats.get('MSFT')
+    end
+    it 'retrieves a keyStats' do
+      expect(subject.symbol).to eq 'MSFT'
+      expect(subject.company_name).to eq 'Microsoft Corporation'
+      expect(subject.market_cap).to eq 825_814_890_000
+      expect(subject.market_cap_dollars).to eq '$825,814,890,000'
+      expect(subject.beta).to eq 1.261768
+    end
+
+    it 'weekly stats' do
+      expect(subject.week_52_high).to eq 111.15
+      expect(subject.week_52_high_dollar).to eq '$111.15'
+      expect(subject.week_52_low).to eq 71.28
+      expect(subject.week_52_low_dollar).to eq '$71.28'
+      expect(subject.week_52_change_dollar).to eq '$51.77'
+    end
+
+    it 'general stats' do
+      expect(subject.short_interest).to eq 47_158_592
+      expect(subject.short_date).to eq '2018-07-13'
+      expect(subject.dividend_rate).to eq 1.68
+      expect(subject.dividend_yield).to eq 1.5617738
+      expect(subject.ex_dividend_date).to eq '2018-08-15 00:00:00.0'
+      expect(subject.latest_eps).to eq 2.11
+      expect(subject.latest_eps_date).to eq '2018-06-30'
+      expect(subject.shares_outstanding).to eq 7_677_000_000
+      expect(subject.float).to eq 7_217_387_757
+      expect(subject.return_on_equity).to eq 20.82
+      expect(subject.consensus_eps).to eq 0.86
+      expect(subject.number_of_estimates).to eq 14
+      expect(subject.eps_surprise_dollar).to eq nil
+      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_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'
+      expect(subject.cash_dollar).to eq '$281,251,000,000'
+      expect(subject.ttm_eps).to eq 3.51
+      expect(subject.revenue_per_share).to eq 7
+      expect(subject.revenue_per_employee).to eq 431_097
+      expect(subject.pe_ratio_high).to eq 0
+      expect(subject.pe_ratio_low).to eq 0
+      expect(subject.return_on_assets).to eq 6.46
+      expect(subject.return_on_capital).to eq nil
+      expect(subject.profit_margin).to eq 15.1
+      expect(subject.price_to_sales).to eq 7.393182
+      expect(subject.price_to_sales_dollar).to eq '$7.39'
+      expect(subject.price_to_book).to eq 10.73
+      expect(subject.price_to_book_dollar).to eq '$10.73'
+      expect(subject.day_200_moving_avg).to eq 91.99065
+      expect(subject.day_50_moving_avg).to eq 102.2528
+      expect(subject.institution_percent).to eq 75.1
+      expect(subject.institution_percent_s).to eq '+7510.00%'
+      expect(subject.insider_percent).to eq nil
+      expect(subject.insider_percent_s).to eq nil
+      expect(subject.short_ratio).to eq 1.7330703
+    end
+
+    it 'changes stats' do
+      expect(subject.year_5_change_percent).to be 2.85141424991049
+      expect(subject.year_5_change_percent_s).to eq '+285.14%'
+      expect(subject.year_2_change_percent).to eq 0.9732002824884664
+      expect(subject.year_2_change_percent_s).to eq '+97.32%'
+      expect(subject.year_1_change_percent).to eq 0.5200287133805482
+      expect(subject.year_1_change_percent_s).to eq '+52.00%'
+      expect(subject.ytd_change_percent).to eq 0.2628699562098638
+      expect(subject.month_6_change_percent).to eq 0.23345097958275707
+      expect(subject.month_6_change_percent_s).to eq '+23.35%'
+      expect(subject.month_3_change_percent).to eq 0.14846686026648437
+      expect(subject.month_3_change_percent_s).to eq '+14.85%'
+      expect(subject.month_1_change_percent).to eq 0.08601716304896513
+      expect(subject.month_1_change_percent_s).to eq '+8.60%'
+      expect(subject.day_5_change_percent).to eq 0.0010215453194652084 * -1
+      expect(subject.day_5_change_percent_s).to eq '-0.10%'
+    end
+  end
+
+  context 'invalid symbol', vcr: { cassette_name: 'key_stats/invalid' } do
+    subject do
+      IEX::Resources::KeyStats.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.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: money_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,7 @@ files:
 - lib/iex/api.rb
 - lib/iex/api/chart.rb
 - lib/iex/api/company.rb
+- lib/iex/api/key_stats.rb
 - lib/iex/api/logo.rb
 - lib/iex/api/news.rb
 - lib/iex/api/ohlc.rb
@@ -161,6 +176,7 @@ files:
 - lib/iex/resources/chart/default.rb
 - lib/iex/resources/chart/one_day.rb
 - lib/iex/resources/company.rb
+- lib/iex/resources/key_stats.rb
 - lib/iex/resources/logo.rb
 - lib/iex/resources/news.rb
 - lib/iex/resources/ohlc.rb
@@ -179,6 +195,8 @@ files:
 - spec/fixtures/iex/chart/msft.yml
 - spec/fixtures/iex/company/invalid.yml
 - spec/fixtures/iex/company/msft.yml
+- spec/fixtures/iex/key_stats/invalid.yml
+- spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/logo/msft.yml
 - spec/fixtures/iex/news/invalid.yml
 - spec/fixtures/iex/news/market.yml
@@ -190,8 +208,10 @@ files:
 - spec/fixtures/iex/price/msft.yml
 - spec/fixtures/iex/quote/invalid.yml
 - spec/fixtures/iex/quote/msft.yml
+- spec/iex/resources/base_spec.rb
 - spec/iex/resources/chart_spec.rb
 - spec/iex/resources/company_spec.rb
+- spec/iex/resources/key_stats_spec.rb
 - spec/iex/resources/logo_spec.rb
 - spec/iex/resources/news_spec.rb
 - spec/iex/resources/ohlc_spec.rb
@@ -234,6 +254,8 @@ test_files:
 - spec/fixtures/iex/chart/msft.yml
 - spec/fixtures/iex/company/invalid.yml
 - spec/fixtures/iex/company/msft.yml
+- spec/fixtures/iex/key_stats/invalid.yml
+- spec/fixtures/iex/key_stats/msft.yml
 - spec/fixtures/iex/logo/msft.yml
 - spec/fixtures/iex/news/invalid.yml
 - spec/fixtures/iex/news/market.yml
@@ -245,8 +267,10 @@ test_files:
 - spec/fixtures/iex/price/msft.yml
 - spec/fixtures/iex/quote/invalid.yml
 - spec/fixtures/iex/quote/msft.yml
+- spec/iex/resources/base_spec.rb
 - spec/iex/resources/chart_spec.rb
 - spec/iex/resources/company_spec.rb
+- spec/iex/resources/key_stats_spec.rb
 - spec/iex/resources/logo_spec.rb
 - spec/iex/resources/news_spec.rb
 - spec/iex/resources/ohlc_spec.rb