iex-ruby-client 1.1.1 → 1.4.1

data/lib/iex/resources/balance_sheet.rb

@@ -0,0 +1,60 @@
+module IEX
+  module Resources
+    class BalanceSheet < Resource
+      property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
+      property 'current_cash', from: 'currentCash'
+      property 'current_cash_dollar', from: 'currentCash', with: ->(v) { to_dollar(amount: v) }
+      property 'short_term_investments', from: 'shortTermInvestments'
+      property 'short_term_investments_dollar', from: 'shortTermInvestments', with: ->(v) { to_dollar(amount: v) }
+      property 'receivables'
+      property 'receivables_dollar', from: 'receivables', with: ->(v) { to_dollar(amount: v) }
+      property 'inventory'
+      property 'inventory_dollar', from: 'inventory', with: ->(v) { to_dollar(amount: v) }
+      property 'other_current_assets', from: 'otherCurrentAssets'
+      property 'other_current_assets_dollar', from: 'otherCurrentAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'current_assets', from: 'currentAssets'
+      property 'current_assets_dollar', from: 'currentAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'long_term_investments', from: 'longTermInvestments'
+      property 'long_term_investments_dollar', from: 'longTermInvestments', with: ->(v) { to_dollar(amount: v) }
+      property 'property_plant_equipment', from: 'propertyPlantEquipment'
+      property 'property_plant_equipment_dollar', from: 'propertyPlantEquipment', with: ->(v) { to_dollar(amount: v) }
+      property 'goodwill'
+      property 'goodwill_dollar', from: 'goodwill', with: ->(v) { to_dollar(amount: v) }
+      property 'intangible_assets', from: 'intangibleAssets'
+      property 'intangible_assets_dollar', from: 'intangibleAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'other_assets', from: 'otherAssets'
+      property 'other_assets_dollar', from: 'otherAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'total_assets', from: 'totalAssets'
+      property 'total_assets_dollar', from: 'totalAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'accounts_payable', from: 'accountsPayable'
+      property 'accounts_payable_dollar', from: 'accountsPayable', with: ->(v) { to_dollar(amount: v) }
+      property 'current_long_term_debt', from: 'currentLongTermDebt'
+      property 'current_long_term_debt_dollar', from: 'currentLongTermDebt', with: ->(v) { to_dollar(amount: v) }
+      property 'other_current_liabilities', from: 'otherCurrentLiabilities'
+      property 'other_current_liabilities_dollar', from: 'otherCurrentLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'total_current_liabilities', from: 'totalCurrentLiabilities'
+      property 'total_current_liabilities_dollar', from: 'totalCurrentLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'long_term_debt', from: 'longTermDebt'
+      property 'long_term_debt_dollar', from: 'longTermDebt', with: ->(v) { to_dollar(amount: v) }
+      property 'other_liabilities', from: 'otherLiabilities'
+      property 'other_liabilities_dollar', from: 'otherLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'minority_interest', from: 'minorityInterest'
+      property 'minority_interest_dollar', from: 'minorityInterest', with: ->(v) { to_dollar(amount: v) }
+      property 'total_liabilities', from: 'totalLiabilities'
+      property 'total_liabilities_dollar', from: 'totalLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'common_stock', from: 'commonStock'
+      property 'retained_earnings', from: 'retainedEarnings'
+      property 'retained_earnings_dollar', from: 'retainedEarnings', with: ->(v) { to_dollar(amount: v) }
+      property 'treasury_stock', from: 'treasuryStock'
+      property 'treasury_stock_dollar', from: 'treasuryStock', with: ->(v) { to_dollar(amount: v) }
+      property 'capital_surplus', from: 'capitalSurplus'
+      property 'capital_surplus_dollar', from: 'capitalSurplus', with: ->(v) { to_dollar(amount: v) }
+      property 'shareholder_equity', from: 'shareholderEquity'
+      property 'shareholder_equity_dollar', from: 'shareholderEquity', with: ->(v) { to_dollar(amount: v) }
+      property 'net_tangible_assets', from: 'netTangibleAssets'
+      property 'net_tangible_assets_dollar', from: 'netTangibleAssets', with: ->(v) { to_dollar(amount: v) }
+    end
+  end
+end

data/lib/iex/resources/cash_flow.rb

@@ -0,0 +1,43 @@
+module IEX
+  module Resources
+    class CashFlow < Resource
+      property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
+      property 'net_income', from: 'netIncome'
+      property 'net_income_dollar', from: 'netIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'depreciation'
+      property 'depreciation_dollar', from: 'depreciation', with: ->(v) { to_dollar(amount: v) }
+      property 'changes_in_receivables', from: 'changesInReceivables'
+      property 'changes_in_receivables_dollar', from: 'changesInReceivables', with: ->(v) { to_dollar(amount: v) }
+      property 'changes_in_inventories', from: 'changesInInventories'
+      property 'changes_in_inventories_dollar', from: 'changesInInventories', with: ->(v) { to_dollar(amount: v) }
+      property 'cash_change', from: 'cashChange'
+      property 'cash_change_dollar', from: 'cashChange', with: ->(v) { to_dollar(amount: v) }
+      property 'cash_flow', from: 'cashFlow'
+      property 'cash_flow_dollar', from: 'cashFlow', with: ->(v) { to_dollar(amount: v) }
+      property 'capital_expenditures', from: 'capitalExpenditures'
+      property 'capital_expenditures_dollar', from: 'capitalExpenditures', with: ->(v) { to_dollar(amount: v) }
+      property 'investments'
+      property 'investments_dollar', from: 'investments', with: ->(v) { to_dollar(amount: v) }
+      property 'investing_activity_other', from: 'investingActivityOther'
+      property 'investing_activity_other_dollar', from: 'investingActivityOther', with: ->(v) { to_dollar(amount: v) }
+      property 'total_investing_cash_flows', from: 'totalInvestingCashFlows'
+      property 'total_investing_cash_flows_dollar', from: 'totalInvestingCashFlows', with: ->(v) { to_dollar(amount: v) }
+      property 'dividends_paid', from: 'dividendsPaid'
+      property 'dividends_paid_dollar', from: 'dividendsPaid', with: ->(v) { to_dollar(amount: v) }
+      property 'net_borrowings', from: 'netBorrowings'
+      property 'net_borrowings_dollar', from: 'netBorrowings', with: ->(v) { to_dollar(amount: v) }
+      property 'other_financing_cash_flows', from: 'otherFinancingCashFlows'
+      property 'other_financing_cash_flows_dollar', from: 'otherFinancingCashFlows', with: ->(v) { to_dollar(amount: v) }
+      property 'cash_flow_financing', from: 'cashFlowFinancing'
+      property 'cash_flow_financing_dollar', from: 'cashFlowFinancing', with: ->(v) { to_dollar(amount: v) }
+      property 'exchange_rate_effect', from: 'exchangeRateEffect'
+      property 'exchange_rate_effect_dollar', from: 'exchangeRateEffect', with: ->(v) { to_dollar(amount: v) }
+
+      def initialize(data = {})
+        super
+      end
+    end
+  end
+end

data/lib/iex/resources/historical_prices.rb

@@ -0,0 +1,31 @@
+module IEX
+  module Resources
+    class HistorialPrices < Resource
+      property 'date'
+      property 'open'
+      property 'open_dollar', from: 'open', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'close'
+      property 'close_dollar', from: 'close', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'high'
+      property 'high_dollar', from: 'high', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'low'
+      property 'low_dollar', from: 'low', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'volume'
+      property 'u_open', from: 'uOpen'
+      property 'u_open_dollar', from: 'uOpen', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_close', from: 'uClose'
+      property 'u_close_dollar', from: 'uClose', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_low', from: 'uLow'
+      property 'u_low_dollar', from: 'uLow', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_high', from: 'uHigh'
+      property 'u_high_dollar', from: 'uHigh', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_volume', from: 'uVolume'
+      property 'change'
+      property 'change_percent', from: 'changePercent'
+      property 'change_percent_s', from: 'changePercent', with: ->(v) { percentage_to_string(v) }
+      property 'label'
+      property 'change_over_time', from: 'changeOverTime'
+      property 'change_over_time_s', from: 'changeOverTime', with: ->(v) { percentage_to_string(v) }
+    end
+  end
+end

data/lib/iex/resources/income.rb

@@ -2,6 +2,8 @@ module IEX
   module Resources
     class Income < Resource
       property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
       property 'total_revenue', from: 'totalRevenue'
       property 'total_revenue_dollar', from: 'totalRevenue', with: ->(v) { to_dollar(amount: v) }
       property 'cost_of_revenue', from: 'costOfRevenue'

data/lib/iex/resources/key_stats.rb

@@ -8,7 +8,7 @@ module IEX
       property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
       property 'week_52_low', from: 'week52low'
       property 'week_52_low_dollar', from: 'week52low', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
-      property 'week_52_change'
+      property 'week_52_change', from: 'week52change'
       property 'week_52_change_dollar', from: 'week52change', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
       property 'dividend_yield', from: 'dividendYield'
       property 'ex_dividend_date', from: 'exDividendDate'

data/lib/iex/resources/news.rb

@@ -6,7 +6,10 @@ module IEX
       property 'source'
       property 'url'
       property 'summary'
+      property 'image'
       property 'related', transform_with: ->(v) { v.split(',') if v.is_a?(String) }
+      property 'paywalled', from: 'hasPaywall'
+      property 'language', from: 'lang'
     end
   end
 end

data/lib/iex/resources/quote.rb

@@ -24,8 +24,18 @@ module IEX
       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' # ?
-      property 'extended_price_time', from: 'extendedPriceTime' # ?
+      property 'extended_price', from: 'extendedPrice' # the pre market and post market price
+      property 'extended_change_percent', from: 'extendedChangePercent' # price change percent between extended_price and latest_price
+      property 'extended_change_percent_s', from: 'extendedChangePercent', with: lambda { |v|
+        if v
+          [
+            v.positive? ? '+' : '',
+            format('%.2f', v * 100),
+            '%'
+          ].join
+        end
+      } # change in percent as a String with a leading + or - sign
+      property 'extended_price_time', from: 'extendedPriceTime' # the last update time of extended_price
       property 'previous_close', from: 'previousClose' # adjusted close price of the last trading day of the stock
       property 'change' # change in value, calculated using calculation_price from previous_close
       property 'change_percent', from: 'changePercent' # change in percent, calculated using calculation_price from previous_close

data/lib/iex/resources/resource.rb

@@ -14,6 +14,18 @@ module IEX
         ].join
       end
 
+      # Useful for values that are already a percent but we want to convert into a 2 decimal place string
+      def self.percentage_to_string(float_percent)
+        return unless float_percent.is_a? Numeric
+        return '+0.00%' if float_percent.zero?
+
+        [
+          float_percent.positive? ? '+' : '',
+          format('%.2f', float_percent),
+          '%'
+        ].join
+      end
+
       def self.to_dollar(amount:, ignore_cents: true)
         MoneyHelper.money_to_text(amount, 'USD', nil, no_cents: ignore_cents)
       end

data/lib/iex/resources/symbol.rb

@@ -0,0 +1,10 @@
+module IEX
+  module Resources
+    class Symbol < Resource
+      property 'exchange'
+      property 'iex_id', from: 'iexId'
+      property 'region'
+      property 'symbol'
+    end
+  end
+end

data/lib/iex/resources/symbols.rb

@@ -0,0 +1,19 @@
+module IEX
+  module Resources
+    class Symbols < Resource
+      property 'symbol'
+      property 'exchange'
+      property 'name'
+      property 'date', transform_with: ->(v) { Date.parse(v) }
+      property 'enabled', from: 'isEnabled'
+      property 'type'
+      property 'region'
+      property 'currency'
+      property 'iex_id', from: 'iexId'
+      property 'figi'
+      property 'cik'
+
+      alias :enabled? enabled
+    end
+  end
+end

data/lib/iex/version.rb

@@ -1,3 +1,3 @@
 module IEX
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.4.1'.freeze
 end

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

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/INVALID/advanced-stats?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.2.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:
+      - Tue, 20 Oct 2020 23:57:05 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=aa7b4e3cbfee43e0a6d8075ad7d24f32; Max-Age=43200; Path=/; Expires=Wed,
+        21 Oct 2020 11:57:05 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, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: Unknown symbol
+  recorded_at: Tue, 20 Oct 2020 23:57:05 GMT
+recorded_with: VCR 6.0.0

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

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/MSFT/advanced-stats?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.2.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:
+      - Tue, 20 Oct 2020 23:57:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=767762d0898c40be8baf5aaf659ee42b; Max-Age=43200; Path=/; Expires=Wed,
+        21 Oct 2020 11:57:04 GMT
+      Iexcloud-Messages-Used:
+      - '3005'
+      Iexcloud-Premium-Messages-Used:
+      - '0'
+      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, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: '{"week52change":0.533539,"week52high":232.86,"week52low":132.52,"marketcap":1621141983000,"employees":163000,"day200MovingAvg":187.72,"day50MovingAvg":212.09,"float":7454581741,"avg10Volume":26989991,"avg30Volume":31404571.1,"ttmEPS":5.8207,"ttmDividendRate":2.04,"companyName":"Microsoft
+        Corp.","sharesOutstanding":7567650000,"maxChangePercent":7.1248,"year5ChangePercent":3.3093,"year2ChangePercent":1.0108,"year1ChangePercent":0.572482,"ytdChangePercent":0.367576,"month6ChangePercent":0.229899,"month3ChangePercent":0.082709,"month1ChangePercent":0.082549,"day30ChangePercent":0.025251,"day5ChangePercent":-0.007859,"nextDividendDate":"2020-11-18","dividendYield":0.009522920362244423,"nextEarningsDate":"2020-10-27","exDividendDate":"2020-08-19","peRatio":36.88,"beta":1.1472751624864646,"totalCash":136527000000,"currentDebt":5905000000,"revenue":143015000000,"grossProfit":96937000000,"totalRevenue":143015000000,"EBITDA":65259000000,"revenuePerShare":18.9,"revenuePerEmployee":877392.64,"debtToEquity":0.69,"profitMargin":0.3096248645247002,"enterpriseValue":1607892999000,"enterpriseValueToRevenue":11.24,"priceToSales":11.62,"priceToBook":13.703188252299162,"forwardPERatio":null,"pegRatio":5.6,"peHigh":40.49739130434783,"peLow":23.046956521739133,"week52highDate":"2020-09-02","week52lowDate":"2020-03-23","putCallRatio":0.36251766583920975}'
+  recorded_at: Tue, 20 Oct 2020 23:57:04 GMT
+recorded_with: VCR 6.0.0

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

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/INVALID/balance-sheet?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.3.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:
+      - Sat, 07 Nov 2020 17:58:55 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=0250f7135874468e9c6d193d526f671f; Max-Age=43200; Path=/; Expires=Sun,
+        08 Nov 2020 05:58:55 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, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: Unknown symbol
+  recorded_at: Sat, 07 Nov 2020 17:58:55 GMT
+recorded_with: VCR 6.0.0

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

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cloud.iexapis.com/v1/stock/MSFT/balance-sheet?token=test-iex-api-publishable-token
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      Content-Type:
+      - application/json; charset=utf-8
+      User-Agent:
+      - IEX Ruby Client/1.3.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:
+      - Sat, 07 Nov 2020 17:58:54 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ctoken=3f205ff8735442119f697085c8de5813; Max-Age=43200; Path=/; Expires=Sun,
+        08 Nov 2020 05:58:54 GMT
+      Iexcloud-Messages-Used:
+      - '3000'
+      Iexcloud-Premium-Messages-Used:
+      - '0'
+      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, Request-Source
+    body:
+      encoding: ASCII-8BIT
+      string: '{"symbol":"MSFT","balancesheet":[{"reportDate":"2020-09-30","fiscalDate":"2020-09-30","currency":"USD","currentCash":17205000000,"shortTermInvestments":120772000000,"receivables":22851000000,"inventory":2705000000,"otherCurrentAssets":13544000000,"currentAssets":177077000000,"longTermInvestments":3196000000,"propertyPlantEquipment":56974000000,"goodwill":43890000000,"intangibleAssets":6923000000,"otherAssets":12941000000,"totalAssets":301001000000,"accountsPayable":12509000000,"currentLongTermDebt":7093000000,"otherCurrentLiabilities":46326000000,"totalCurrentLiabilities":70056000000,"longTermDebt":74379000000,"otherLiabilities":32987000000,"minorityInterest":0,"totalLiabilities":177609000000,"commonStock":7564000000,"retainedEarnings":39193000000,"treasuryStock":null,"capitalSurplus":null,"shareholderEquity":123392000000,"netTangibleAssets":17585000000}]}'
+  recorded_at: Sat, 07 Nov 2020 17:58:54 GMT
+recorded_with: VCR 6.0.0