polygonio-ruby 0.2.8

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Polygonio
+  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 :currency, Types::String
+          attribute :active, Types::Bool
+          attribute :primary_exch?, Types::String
+          attribute? :type, Types::String
+          attribute? :codes do
+            attribute? :cik, Types::String
+            attribute? :figiuid, Types::String
+            attribute? :scfigi, Types::String
+            attribute? :cfigi, Types::String
+            attribute? :figi, Types::String
+          end
+          attribute :updated, Types::JSON::Date
+          attribute :url, Types::String
+        end
+
+        class TickerResponse < PolygonResponse
+          attribute :page, Types::Integer
+          attribute :per_page, Types::Integer
+          attribute :count, Types::Integer
+          attribute :status, Types::String
+          attribute :tickers, Types::Array.of(Ticker)
+        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("/v2/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 :symbols, Types::Array.of(Types::String)
+          attribute :title, Types::String
+          attribute :url, Types::String
+          attribute :source, Types::String
+          attribute :summary, Types::String
+          attribute? :image, Types::String
+          attribute :timestamp, Types::JSON::DateTime
+          attribute :keywords, Types::Array.of(Types::String)
+        end
+
+        def news(symbol, page = 1, perpage = 50)
+          symbol = Types::String[symbol]
+          page = Types::Integer[page]
+          perpage = Types::Integer[perpage]
+          opts = { page: page, perpage: perpage }
+
+          res = client.request.get("/v1/meta/symbols/#{symbol}/news", opts)
+          Types::Array.of(NewsResponse)[res.body]
+        end
+      end
+    end
+  end
+end

data/lib/polygonio/rest/api/stocks.rb

@@ -0,0 +1,327 @@
+# frozen_string_literal: true
+
+module Polygonio
+  module Rest
+    class Stocks < PolygonRestHandler
+      class StockExchange < PolygonResponse
+        attribute :id, Types::Integer
+        attribute :type, Types::String
+        attribute :market, Types::String
+        attribute? :mic, Types::String
+        attribute :name, Types::String
+        attribute? :tape, Types::String
+      end
+
+      def list_exchanges
+        res = client.request.get("/v1/meta/exchanges")
+        Types::Array.of(StockExchange)[res.body]
+      end
+
+      class HistoricTradesResponse < PolygonResponse
+        attribute :results_count, Types::Integer
+        attribute :db_latency, Types::Integer
+        attribute :success, Types::Bool
+        attribute :ticker, Types::String
+        attribute :map, Types::Hash
+        attribute :results, Types::Array do
+          attribute? :T, Types::String # Not receiving for some reason
+          attribute :t, Types::Integer
+          attribute :y, Types::Integer
+          attribute? :f, Types::Integer
+          attribute :q, Types::Integer
+          attribute :i, Types::String
+          attribute :x, Types::Integer
+          attribute :s, Types::Integer
+          attribute :c, Types::Array.of(Types::Integer)
+          attribute :p, Types::JSON::Decimal
+          attribute :z, Types::Integer
+        end
+      end
+
+      class HistoricParams < Dry::Struct
+        attribute? :timestamp, Types::Integer
+        attribute? :timestampLimit, Types::Integer # TODO: change to underscore?
+        attribute? :reverse, Types::Bool
+        attribute? :limit, Types::Integer
+      end
+
+      def historic_trades(ticker, date, params = {})
+        ticker = Types::String[ticker]
+        date = Types::JSON::Date[date]
+        params = HistoricParams[params]
+
+        res = client.request.get("/v2/ticks/stocks/trades/#{ticker}/#{date}", params.to_h)
+        HistoricTradesResponse[res.body]
+      end
+
+      class HistoricQuotesResponse < PolygonResponse
+        attribute :results_count, Types::Integer
+        attribute :db_latency, Types::Integer
+        attribute :success, Types::Bool
+        attribute :ticker, Types::String
+        attribute :map, Types::Hash
+        attribute :results, Types::Array do
+          attribute? :T, Types::String # Not receiving for some reason
+          attribute :t, Types::Integer
+          attribute :y, Types::Integer
+          attribute? :f, Types::Integer
+          attribute :q, Types::Integer
+          attribute? :i, Types::Array.of(Types::Integer)
+          attribute :p, Types::JSON::Decimal
+          attribute :x, Types::Integer
+          attribute :s, Types::Integer
+          attribute? :P, Types::JSON::Decimal
+          attribute? :X, Types::Integer
+          attribute? :S, Types::Integer
+          attribute :c, Types::Array.of(Types::Integer)
+          attribute :z, Types::Integer
+        end
+      end
+
+      def historic_quotes(ticker, date, params = {})
+        ticker = Types::String[ticker]
+        date = Types::JSON::Date[date]
+        params = HistoricParams[params]
+
+        res = client.request.get("/v2/ticks/stocks/nbbo/#{ticker}/#{date}", params.to_h)
+        HistoricQuotesResponse[res.body]
+      end
+
+      class LastTradeResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :symbol, Types::String
+        attribute :last do
+          attribute :price, Types::JSON::Decimal
+          attribute :size, Types::Integer
+          attribute :exchange, Types::Integer
+          attribute :cond1, Types::Integer
+          attribute :cond2, Types::Integer
+          attribute :cond3, Types::Integer
+          attribute? :cond4, Types::Integer
+          attribute :timestamp, Types::Integer
+        end
+      end
+
+      def last_trade(symbol)
+        symbol = Types::String[symbol]
+
+        res = client.request.get("/v1/last/stocks/#{symbol}")
+        LastTradeResponse[res.body]
+      end
+
+      class LastQuoteResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :symbol, Types::String
+        attribute :last do
+          attribute :askprice, Types::JSON::Decimal
+          attribute :asksize, Types::Integer
+          attribute :askexchange, Types::Integer
+          attribute :bidprice, Types::JSON::Decimal
+          attribute :bidsize, Types::Integer
+          attribute :bidexchange, Types::Integer
+          attribute :timestamp, Types::Integer
+        end
+      end
+
+      def last_quote(symbol)
+        symbol = Types::String[symbol]
+
+        res = client.request.get("/v1/last_quote/stocks/#{symbol}")
+        LastQuoteResponse[res.body]
+      end
+
+      class DailyOpenCloseResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :symbol, Types::String
+        attribute :open, Types::JSON::Decimal
+        attribute :high, Types::JSON::Decimal
+        attribute :low, Types::JSON::Decimal
+        attribute :close, Types::JSON::Decimal
+        attribute :volume, Types::Integer
+        attribute :after_hours, Types::JSON::Decimal
+        attribute :from, Types::JSON::DateTime
+      end
+
+      def daily_open_close(symbol, date)
+        symbol = Types::String[symbol]
+        date = Types::JSON::Date[date]
+
+        res = client.request.get("/v1/open-close/#{symbol}/#{date}")
+        DailyOpenCloseResponse[res.body]
+      end
+
+      def condition_mappings(tick_type)
+        tick_type = Types::String.enum("trades", "quotes")[tick_type]
+
+        res = client.request.get("/v1/meta/conditions/#{tick_type}")
+        Types::Hash[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_trade do
+          attribute? :c1, Types::Integer
+          attribute? :c2, Types::Integer
+          attribute? :c3, Types::Integer
+          attribute? :c4, Types::Integer
+          attribute? :e, Types::Integer
+          attribute :p, Types::JSON::Decimal
+          attribute :s, Types::Integer
+          attribute :t, Types::Integer
+        end
+        attribute :last_quote do
+          attribute :p, Types::JSON::Decimal
+          attribute :s, Types::Integer
+          attribute? :P, Types::JSON::Decimal
+          attribute? :S, 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/us/markets/stocks/tickers")
+        FullSnapshotResponse[res.body]
+      end
+
+      class SnapshotResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :ticker, SnapshotTicker
+      end
+
+      def snapshot(ticker)
+        ticker = Types::String[ticker]
+
+        res = client.request.get("/v2/snapshot/locale/us/markets/stocks/tickers/#{ticker}")
+        SnapshotResponse[res.body]
+      end
+
+      class SnapshotGainersLosersResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :tickers, Types::Array.of(SnapshotTicker)
+      end
+
+      def snapshot_gainers_losers(direction)
+        direction = Types::String.enum("gainers", "losers")[direction]
+
+        res = client.request.get("/v2/snapshot/locale/us/markets/stocks/#{direction}")
+        SnapshotGainersLosersResponse[res.body]
+      end
+
+      class PreviousCloseResponse < PolygonResponse
+        attribute :ticker, Types::String
+        attribute :status, Types::String
+        attribute :adjusted, Types::Bool
+        attribute :query_count, Types::Integer
+        attribute :results_count, Types::Integer
+        attribute :results, Types::Array do
+          attribute :T, Types::String
+          attribute :v, Types::JSON::Decimal
+          attribute :vw, Types::JSON::Decimal
+          attribute :o, Types::JSON::Decimal
+          attribute :c, Types::JSON::Decimal
+          attribute :h, Types::JSON::Decimal
+          attribute :l, Types::JSON::Decimal
+          attribute :t, Types::Integer
+          attribute? :n, Types::Integer
+        end
+      end
+
+      def previous_close(ticker, unadjusted = false)
+        ticker = Types::String[ticker]
+        unadjusted = Types::Bool[unadjusted]
+
+        res = client.request.get("/v2/aggs/ticker/#{ticker}/prev", { unadjusted: unadjusted })
+        PreviousCloseResponse[res.body]
+      end
+
+      class AggregatesResponse < PolygonResponse
+        attribute :ticker, Types::String
+        attribute :status, Types::String
+        attribute :adjusted, Types::Bool
+        attribute :query_count, Types::Integer
+        attribute :results_count, Types::Integer
+        attribute :results, Types::Array do
+          attribute? :T, Types::String # Not appearing
+          attribute :v, Types::JSON::Decimal
+          attribute? :vw, Types::JSON::Decimal
+          attribute :o, Types::JSON::Decimal
+          attribute :c, Types::JSON::Decimal
+          attribute :h, Types::JSON::Decimal
+          attribute :l, Types::JSON::Decimal
+          attribute :t, Types::Integer
+          attribute? :n, Types::Integer
+        end
+      end
+
+      def aggregates(ticker, multiplier, timespan, from, to, unadjusted = false) # rubocop:disable Metrics/ParameterLists
+        ticker = Types::String[ticker]
+        multiplier = Types::Integer[multiplier]
+        timespan = Types::Coercible::String.enum("minute", "hour", "day", "week", "month", "quarter", "year")[timespan]
+        from = Types::JSON::Date[from]
+        to = Types::JSON::Date[to]
+        unadjusted = Types::Bool[unadjusted]
+
+        res = client.request.get("/v2/aggs/ticker/#{ticker}/range/#{multiplier}/#{timespan}/#{from}/#{to}", { unadjusted: unadjusted })
+        AggregatesResponse[res.body]
+      end
+
+      class GroupedDailyResponse < PolygonResponse
+        attribute? :ticker, Types::String
+        attribute :status, Types::String
+        attribute :adjusted, Types::Bool
+        attribute :query_count, Types::Integer
+        attribute :results_count, Types::Integer
+        attribute :results, Types::Array do
+          attribute :T, Types::String # Not appearing
+          attribute :v, Types::JSON::Decimal
+          attribute? :vw, Types::JSON::Decimal
+          attribute :o, Types::JSON::Decimal
+          attribute :c, Types::JSON::Decimal
+          attribute :h, Types::JSON::Decimal
+          attribute :l, Types::JSON::Decimal
+          attribute :t, Types::Integer
+          attribute? :n, Types::Integer
+        end
+      end
+
+      def grouped_daily(locale, market, date, unadjusted = false)
+        locale = Types::String[locale]
+        market = Types::Coercible::String.enum("stocks", "crypto", "bonds", "mf", "mmf", "indices", "fx")[market]
+        date = Types::JSON::Date[date]
+        unadjusted = Types::Bool[unadjusted]
+
+        res = client.request.get("/v2/aggs/grouped/locale/#{locale}/market/#{market.upcase}/#{date}", { unadjusted: unadjusted })
+        GroupedDailyResponse[res.body]
+      end
+    end
+  end
+end

data/lib/polygonio/rest/api.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Polygonio
+  module Rest
+    class PolygonResponse < Dry::Struct
+      NUMBERS_TO_WORDS = {
+        "10" => "ten",
+        "9" => "nine",
+        "8" => "eight",
+        "7" => "seven",
+        "6" => "six",
+        "5" => "five",
+        "4" => "four",
+        "3" => "three",
+        "2" => "two",
+        "1" => "one"
+      }.freeze
+
+      transform_keys do |k|
+        k = NUMBERS_TO_WORDS[k] if NUMBERS_TO_WORDS.key?(k)
+        k = k.underscore unless k.length == 1
+        k.to_sym
+      end
+    end
+  end
+end
+
+require_relative "api/crypto"
+require_relative "api/forex"
+require_relative "api/stocks"
+require_relative "api/reference/locales"
+require_relative "api/reference/markets"
+require_relative "api/reference/stocks"
+require_relative "api/reference/tickers"

data/lib/polygonio/rest/client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Polygonio
+  module Rest
+    class Client
+      Struct.new("Reference", :locales, :markets, :stocks, :tickers)
+
+      BASE_URL = "https://api.polygon.io/"
+
+      attr_reader :url, :api_key
+
+      def initialize(api_key, &block)
+        @url = BASE_URL
+        @api_key = Types::String[api_key]
+        @request_builder = block if block_given?
+      end
+
+      RETRY_OPTIONS = {
+        max: 2,
+        interval: 0.05,
+        interval_randomness: 0.5,
+        backoff_factor: 2,
+        exceptions: [Faraday::ConnectionFailed].concat(Faraday::Request::Retry::DEFAULT_EXCEPTIONS)
+      }.freeze
+
+      def request
+        Faraday.new(url: "#{url}?apiKey=#{api_key}") do |builder|
+          builder.request :retry, RETRY_OPTIONS
+          builder.use ErrorMiddleware
+          @request_builder&.call(builder)
+          builder.request :json
+          builder.response :oj
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def reference
+        Struct::Reference.new(
+          Rest::Reference::Locales.new(self),
+          Rest::Reference::Markets.new(self),
+          Rest::Reference::Stocks.new(self),
+          Rest::Reference::Tickers.new(self)
+        )
+      end
+
+      def stocks
+        Rest::Stocks.new(self)
+      end
+
+      def forex
+        Rest::Forex.new(self)
+      end
+
+      def crypto
+        Rest::Crypto.new(self)
+      end
+    end
+
+    class PolygonRestHandler
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+    end
+
+    class PagingParameters < Dry::Struct
+      attribute? :offset, Types::Integer.optional
+      attribute? :limit, Types::Integer.default(100)
+    end
+  end
+end

data/lib/polygonio/rest/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Polygonio
+  module Errors
+    class PolygonRestClientError < StandardError; end
+
+    class BadRequestError < PolygonRestClientError; end
+    class UnauthorizedError < PolygonRestClientError; end
+    class ForbiddenError < PolygonRestClientError; end
+    class ResourceNotFoundError < PolygonRestClientError; end
+    class ServerError < PolygonRestClientError; end
+    class UnknownError < PolygonRestClientError; end
+    class UnexpectedResponseError < PolygonRestClientError; end
+  end
+
+  class ErrorMiddleware < Faraday::Middleware
+    CLIENT_ERROR_STATUSES = (400...500).freeze
+    SERVER_ERROR_STATUSES = (500...600).freeze
+
+    def on_complete(response_env) # rubocop:disable Metrics/MethodLength
+      status = response_env.status
+
+      case status
+      when 400
+        raise Errors::BadRequestError
+      when 401
+        raise Errors::UnauthorizedError
+      when 403
+        raise Errors::ForbiddenError
+      when 404
+        raise Errors::ResourceNotFoundError
+      when CLIENT_ERROR_STATUSES
+        raise Errors::UnknownError
+      when SERVER_ERROR_STATUSES
+        raise Errors::ServerError
+      end
+    end
+
+    def call(request_env)
+      @app.call(request_env).on_complete(&method(:on_complete))
+    end
+  end
+end

data/lib/polygonio/rest.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "rest/client"
+require_relative "rest/api"
+require_relative "rest/errors"

data/lib/polygonio/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Polygonio
+  module Types
+    include Dry::Types(default: :strict)
+  end
+end

data/lib/polygonio/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Polygonio
+  VERSION = "0.2.8"
+end