massiveclient 0.3.0

data/lib/massiveclient/rest/api/forex.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module MassiveClient
+  module Rest
+    class Forex < PolygonRestHandler
+      class HistoricTicksResponse < PolygonResponse
+        attribute? :day, Types::JSON::Date
+        attribute? :map, Types::Hash
+        attribute? :ms_latency, Types::Integer
+        attribute? :status, Types::String
+        attribute? :pair, Types::String
+        attribute? :type, Types::String
+        attribute :ticks, Types::Array do
+          attribute? :a, Types::JSON::Decimal     # Asking price
+          attribute? :b, Types::JSON::Decimal     # Bidding price
+          attribute? :x, Types::Integer           # Exchange ID
+          attribute? :t, Types::Integer
+        end
+      end
+
+      def historic_ticks(from, to, date, opts = {})
+        from = Types::String[from]
+        to = Types::String[to]
+        date = Types::JSON::Date[date]
+        opts = PagingParameters[opts]
+
+        res = client.request.get("/v1/historic/forex/#{from}/#{to}/#{date}", opts.to_h)
+        HistoricTicksResponse[res.body]
+      end
+
+      class CurrencyConversionResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :from, Types::String
+        attribute :to, Types::String
+        attribute :initial_amount, Types::Integer
+        attribute :converted, Types::JSON::Decimal
+        attribute :last do
+          attribute :bid, Types::JSON::Decimal
+          attribute :ask, Types::JSON::Decimal
+          attribute :exchange, Types::Integer
+          attribute :timestamp, Types::Integer
+        end
+      end
+
+      def convert_currency(from, to, amount, precision = 2)
+        from = Types::String[from]
+        to = Types::String[to]
+        amount = Types::Coercible::Decimal[amount]
+        precision = Types::Integer[precision]
+        opts = { amount: amount, precision: precision }
+
+        res = client.request.get("/v1/conversion/#{from}/#{to}", opts)
+        CurrencyConversionResponse[res.body]
+      end
+
+      class LastQuoteResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :symbol, Types::String
+        attribute :last do
+          attribute :bid, Types::JSON::Decimal
+          attribute :ask, Types::JSON::Decimal
+          attribute :exchange, Types::Integer
+          attribute :timestamp, Types::Integer
+        end
+      end
+
+      def last_quote(from, to)
+        from = Types::String[from]
+        to = Types::String[to]
+
+        res = client.request.get("/v1/last_quote/currencies/#{from}/#{to}")
+        LastQuoteResponse[res.body]
+      end
+
+      class SnapshotTicker < PolygonResponse
+        attribute :ticker, Types::String
+        attribute :day do
+          attribute :c, Types::JSON::Decimal
+          attribute :h, Types::JSON::Decimal
+          attribute :l, Types::JSON::Decimal
+          attribute :o, Types::JSON::Decimal
+          attribute :v, Types::JSON::Decimal
+        end
+        attribute :last_quote do
+          attribute :a, Types::JSON::Decimal
+          attribute :b, Types::JSON::Decimal
+          attribute :i, Types::JSON::Decimal
+          attribute :x, Types::Integer
+          attribute :t, Types::Integer
+        end
+        attribute :min do
+          attribute :c, Types::JSON::Decimal
+          attribute :h, Types::JSON::Decimal
+          attribute :l, Types::JSON::Decimal
+          attribute :o, Types::JSON::Decimal
+          attribute :v, Types::JSON::Decimal
+        end
+        attribute :prev_day do
+          attribute :c, Types::JSON::Decimal
+          attribute :h, Types::JSON::Decimal
+          attribute :l, Types::JSON::Decimal
+          attribute :o, Types::JSON::Decimal
+          attribute :v, Types::JSON::Decimal
+        end
+        attribute :todays_change, Types::JSON::Decimal
+        attribute :todays_change_perc, Types::JSON::Decimal
+        attribute :updated, Types::Integer
+      end
+
+      class FullSnapshotResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :tickers, Types::Array.of(SnapshotTicker)
+      end
+
+      def full_snapshot
+        res = client.request.get("/v2/snapshot/locale/global/markets/forex/tickers")
+        FullSnapshotResponse[res.body]
+      end
+
+      class SnapshotGainersLosersResponse < FullSnapshotResponse; end
+
+      def snapshot_gainers_losers(direction)
+        direction = Types::Coercible::String.enum("gainers", "losers")[direction]
+        res = client.request.get("/v2/snapshot/locale/global/markets/forex/#{direction}")
+        SnapshotGainersLosersResponse[res.body]
+      end
+    end
+  end
+end

data/lib/massiveclient/rest/api/reference/locales.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MassiveClient
+  module Rest
+    module Reference
+      class Locales < PolygonRestHandler
+        class LocalesResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :results, Types::Array do
+            attribute :locale, Types::String
+            attribute :name, Types::String
+          end
+        end
+
+        def list
+          res = client.request.get("/v2/reference/locales")
+          LocalesResponse[res.body]
+        end
+      end
+    end
+  end
+end

data/lib/massiveclient/rest/api/reference/markets.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MassiveClient
+  module Rest
+    module Reference
+      class Markets < PolygonRestHandler
+        class MarketsResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :results, Types::Array do
+            attribute :market, Types::String
+            attribute :desc, Types::String
+          end
+        end
+
+        def list
+          res = client.request.get("/v2/reference/markets")
+          MarketsResponse[res.body]
+        end
+
+        class MarketStatusResponse < PolygonResponse
+          attribute :market, Types::String
+          attribute :server_time, Types::String
+          attribute :exchanges do
+            attribute :nyse, Types::String
+            attribute :nasdaq, Types::String
+            attribute :otc, Types::String
+          end
+          attribute :currencies do
+            attribute :fx, Types::String
+            attribute :crypto, Types::String
+          end
+        end
+
+        def status
+          res = client.request.get("/v1/marketstatus/now")
+          MarketStatusResponse[res.body]
+        end
+
+        class MarketHolidaysResponse < PolygonResponse
+          attribute :exchange, Types::String
+          attribute :name, Types::String
+          attribute :status, Types::String
+          attribute :date, Types::JSON::DateTime
+          attribute? :open, Types::JSON::DateTime
+          attribute? :close, Types::JSON::DateTime
+        end
+
+        def holidays
+          res = client.request.get("/v1/marketstatus/upcoming")
+          Types::Array.of(MarketHolidaysResponse)[res.body]
+        end
+      end
+    end
+  end
+end

data/lib/massiveclient/rest/api/reference/stocks.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MassiveClient
+  module Rest
+    module Reference
+      class Stocks < PolygonRestHandler
+        class StockSplitsResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :count, Types::Integer
+          attribute :results, Types::Array do
+            attribute :ticker, Types::String
+            attribute :ex_date, Types::JSON::Date
+            attribute :payment_date, Types::JSON::Date
+            attribute? :record_date, Types::JSON::Date
+            attribute? :declared_date, Types::JSON::Date
+            attribute :ratio, Types::JSON::Decimal
+            attribute? :to_factor, Types::Integer
+            attribute? :for_factor, Types::Integer
+          end
+        end
+
+        def splits(symbol)
+          res = client.request.get("/v2/reference/splits/#{symbol}")
+          StockSplitsResponse[res.body]
+        end
+
+        class StockDividendsResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :count, Types::Integer
+          attribute :results, Types::Array do
+            attribute :ticker, Types::String
+            attribute? :type, Types::String
+            attribute :ex_date, Types::String
+            attribute :payment_date, Types::JSON::Date
+            attribute :record_date, Types::JSON::Date
+            attribute? :declared_date, Types::JSON::Date
+            attribute :amount, Types::JSON::Decimal
+            attribute? :qualified, Types::String
+            attribute? :flag, Types::String
+          end
+        end
+
+        def dividends(symbol)
+          res = client.request.get("/v2/reference/dividends/#{symbol}")
+          StockDividendsResponse[res.body]
+        end
+
+        class StockFinancialsResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute? :count, Types::Integer
+          # I'm lazy and didn't want to copy every field here. Please submit PR if you want to crack at it!
+          attribute :results, Types::Array.of(Types::Hash)
+        end
+
+        class StockFinancialsParameters < Dry::Struct
+          attribute? :limit, Types::Integer
+          attribute? :type, Types::String.enum("Y", "YA", "Q", "QA", "T", "TA")
+          attribute? :sort, Types::String.enum("reportPeriod", "-reportPeriod", "calendarDate", "-calendarDate")
+        end
+
+        def financials(symbol, params = {})
+          params = StockFinancialsParameters[params]
+
+          res = client.request.get("/v2/reference/financials/#{symbol}", params.to_h)
+          StockFinancialsResponse[res.body]
+        end
+      end
+    end
+  end
+end

data/lib/massiveclient/rest/api/reference/tickers.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module MassiveClient
+  module Rest
+    module Reference
+      class Tickers < PolygonRestHandler
+        class Ticker < PolygonResponse
+          attribute :ticker, Types::String
+          attribute :name, Types::String
+          attribute :market, Types::String
+          attribute :locale, Types::String
+          attribute? :primary_exchange, Types::String
+          attribute? :type, Types::String
+          attribute :active, Types::Bool
+          attribute? :currency_name, Types::String
+          attribute? :cik, Types::String
+          attribute? :composite_figi, Types::String
+          attribute? :share_class_figi, Types::String
+          attribute? :last_updated_utc, Types::String
+        end
+
+        class TickerResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :results, Types::Array.of(Ticker)
+          attribute? :next_url, Types::String
+          attribute? :count, Types::Integer
+        end
+
+        class TickersParameters < Dry::Struct
+          attribute? :sort, Types::String
+          attribute? :type, Types::String
+          attribute? :market, Types::String
+          attribute? :locale, Types::String
+          attribute? :search, Types::String
+          attribute? :perpage, Types::String
+          attribute? :page, Types::Integer
+          attribute? :active, Types::Bool
+        end
+
+        def list(params = {})
+          params = TickersParameters[params]
+          res = client.request.get("/v3/reference/tickers", params.to_h)
+          TickerResponse[res.body]
+        end
+
+        class TickerTypesResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :results do
+            attribute :types, Types::Hash
+            attribute :index_types, Types::Hash
+          end
+        end
+
+        def types
+          res = client.request.get("/v2/reference/types")
+          TickerTypesResponse[res.body]
+        end
+
+        class TickerDetailsResponse < PolygonResponse
+          attribute? :logo, Types::String
+          attribute :exchange, Types::String
+          attribute :exchange_symbol, Types::String
+          attribute :name, Types::String
+          attribute :symbol, Types::String
+          attribute? :listdate, Types::JSON::Date
+          attribute? :cik, Types::String
+          attribute? :bloomberg, Types::String
+          attribute? :figi, Types::String.optional
+          attribute? :lie, Types::String
+          attribute? :sic, Types::Integer
+          attribute? :country, Types::String
+          attribute? :industry, Types::String
+          attribute? :sector, Types::String
+          attribute? :marketcap, Types::Integer
+          attribute? :employees, Types::Integer
+          attribute? :phone, Types::String
+          attribute? :ceo, Types::String
+          attribute? :url, Types::String
+          attribute? :description, Types::String
+          attribute? :similar, Types::Array
+          attribute? :tags, Types::Array
+          attribute? :hq_address, Types::String
+          attribute? :hq_state, Types::String
+          attribute? :hq_country, Types::String
+          attribute? :active, Types::Bool
+          attribute? :updated, Types::String
+        end
+
+        def details(symbol)
+          symbol = Types::String[symbol]
+          res = client.request.get("/v1/meta/symbols/#{symbol}/company")
+          TickerDetailsResponse[res.body]
+        end
+
+        class NewsResponse < PolygonResponse
+          attribute :status, Types::String
+          attribute :results, Types::Array do
+            attribute? :id, Types::String
+            attribute? :publisher do
+              attribute? :name, Types::String
+              attribute? :homepage_url, Types::String
+              attribute? :logo_url, Types::String
+              attribute? :favicon_url, Types::String
+            end
+            attribute :title, Types::String
+            attribute? :author, Types::String
+            attribute :published_utc, Types::String
+            attribute :article_url, Types::String
+            attribute :tickers, Types::Array.of(Types::String)
+            attribute? :amp_url, Types::String
+            attribute? :image_url, Types::String
+            attribute? :description, Types::String
+            attribute? :keywords, Types::Array.of(Types::String)
+            attribute? :insights, Types::Array do
+              attribute :ticker, Types::String
+              attribute :sentiment, Types::String
+              attribute :sentiment_reasoning, Types::String
+            end
+          end
+          attribute? :count, Types::Integer
+          attribute? :next_url, Types::String
+          attribute? :request_id, Types::String
+        end
+
+        def news(ticker, limit = 10)
+          ticker = Types::String[ticker]
+          limit = Types::Integer[limit]
+          opts = { ticker: ticker, limit: limit }
+
+          res = client.request.get("/v2/reference/news", opts)
+          NewsResponse[res.body]
+        end
+      end
+    end
+  end
+end