polygonio-ruby 0.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0025e44c36af5a1d8091cca11ac55ebf929a3dae3ecde2f047bf6d4effb46d52
+  data.tar.gz: 0306c02483d4f80046c64adb45b3062b49c4bb5c979708d1c096c95b397e1087
+SHA512:
+  metadata.gz: e4026dea18165f8554ac3f66c28460a85f15a8caba691eaf3c9dfde7f91d9a2f10ac419f87ece14eed5af0548bb3b29d54ab8a537a8c92720f5f51fa63f6026d
+  data.tar.gz: '01865cb6d541ed0e6d49c9c0897528bb98c9f89581d906f023a4578e9b9689c5f920834c80a3f23e3b35458086f831f7261a4ed6d1c39af3d85908d4e3f51dd1'

data/.gitignore

@@ -0,0 +1,2 @@
+.env
+pkg

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.6.0
+  DisabledByDefault: false
+  Exclude:
+    - '**/vendor/**/*'
+    - 'bin/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 24
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: group
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Performance:
+  Exclude:
+    - '**/test/**/*'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gatekeeper_client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# Polygonio (Ruby)
+
+## Table of Contents
+
+- [Background](#background)
+- [Installation](#installation)
+- [Usage](#usage)
+
+## Background
+
+This is a client library for Polygon.io. Please see [Polygon.io](https://polygon.io)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'polygonio'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+**Create an instance of the client:**
+
+All methods follow the documentation found [here]:https://polygon.io/docs pretty closely:
+
+
+
+```ruby
+client = Polygonio::Rest::Client.new(api_key)
+
+# See tests for a full reference of all of methods
+client.reference.tickers.list
+
+client.stocks.list_exchanges
+
+client.forex.historic_ticks
+
+client.crypto.list # list exchanges
+
+Polygonio::Websocket::Client.new("crypto", api_key).subscribe("XQ.BTC-USD") do |event|
+  pp "Incoming message"
+  pp event
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "polygonio"
+require "dotenv/load"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module Polygonio
+  module Rest
+    class Crypto < PolygonRestHandler
+      class CryptoExchange < PolygonResponse
+        attribute :id, Types::Integer
+        attribute :type, Types::String
+        attribute :market, Types::String
+        attribute :name, Types::String
+        attribute :url, Types::String
+      end
+
+      def list
+        res = client.request.get("/v1/meta/crypto-exchanges")
+        Types::Array.of(CryptoExchange)[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::JSON::Decimal
+          attribute :exchange, Types::Integer
+          attribute :conditions, Types::Array.of(Types::Integer)
+          attribute :timestamp, Types::Integer
+        end
+        attribute :last_average do
+          attribute :avg, Types::JSON::Decimal
+          attribute :trades_averaged, Types::Integer
+        end
+      end
+
+      def last_trade(from, to)
+        from = Types::String[from]
+        to = Types::String[to]
+
+        res = client.request.get("/v1/last/crypto/#{from}/#{to}")
+        LastTradeResponse[res.body]
+      end
+
+      class DailyOpenCloseResponse < PolygonResponse
+        attribute :symbol, Types::String
+        attribute :is_utc, Types::Bool
+        attribute :day, Types::JSON::Date
+        attribute :open, Types::JSON::Decimal
+        attribute :close, Types::JSON::Decimal
+        attribute :open_trades, Types::Array do
+          attribute? :p, Types::JSON::Decimal
+          attribute? :s, Types::JSON::Decimal
+          attribute? :x, Types::Integer
+          attribute? :c, Types::Array.of(Types::Integer)
+          attribute? :t, Types::Integer
+        end
+        attribute :closing_trades, Types::Array do
+          attribute? :p, Types::JSON::Decimal
+          attribute? :s, Types::JSON::Decimal
+          attribute? :x, Types::Integer
+          attribute? :c, Types::Array.of(Types::Integer)
+          attribute? :t, Types::Integer
+        end
+      end
+
+      def daily_open_close(from, to, date)
+        from = Types::String[from]
+        to = Types::String[to]
+        date = Types::JSON::Date[date]
+
+        res = client.request.get("/v1/open-close/crypto/#{from}/#{to}/#{date}")
+        DailyOpenCloseResponse[res.body]
+      end
+
+      class HistoricTradesResponse < PolygonResponse
+        attribute? :day, Types::JSON::Date
+        attribute? :map, Types::Hash
+        attribute? :ms_latency, Types::Integer
+        attribute? :status, Types::String
+        attribute? :symbol, Types::String
+        attribute? :type, Types::String
+        attribute :ticks, Types::Array do
+          attribute? :p, Types::JSON::Decimal
+          attribute? :s, Types::JSON::Decimal
+          attribute? :x, Types::Integer
+          attribute? :c, Types::Array.of(Types::Integer)
+          attribute? :t, Types::Integer
+        end
+      end
+
+      def historic_trades(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/crypto/#{from}/#{to}/#{date}", opts.to_h)
+        HistoricTradesResponse[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 :p, Types::JSON::Decimal
+          attribute :s, Types::JSON::Decimal
+          attribute :x, Types::Integer
+          attribute :c, Types::Array.of(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/crypto/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/global/markets/crypto/tickers/#{ticker}")
+        SnapshotResponse[res.body]
+      end
+
+      class SnapshotBookResponse < PolygonResponse
+        attribute :status, Types::String
+        attribute :data do
+          attribute :ticker, Types::String
+          attribute :bids, Types::Array do
+            attribute :p, Types::JSON::Decimal
+            attribute :x do
+              PolygonResponse::NUMBERS_TO_WORDS.each do |_n, w|
+                attribute? w.to_sym, Types::JSON::Decimal
+              end
+            end
+          end
+          attribute :asks, Types::Array do
+            attribute :p, Types::JSON::Decimal
+            attribute :x do
+              PolygonResponse::NUMBERS_TO_WORDS.each do |_n, w|
+                attribute? w.to_sym, Types::JSON::Decimal
+              end
+            end
+          end
+          attribute :bid_count, Types::JSON::Decimal
+          attribute :ask_count, Types::JSON::Decimal
+          attribute :spread, Types::JSON::Decimal
+          attribute :updated, Types::Integer
+        end
+      end
+
+      def snapshot_book(ticker)
+        ticker = Types::String[ticker]
+        res = client.request.get("/v2/snapshot/locale/global/markets/crypto/tickers/#{ticker}/book")
+        SnapshotBookResponse[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/crypto/#{direction}")
+        SnapshotGainersLosersResponse[res.body]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Polygonio
+  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/polygonio/rest/api/reference/locales.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Polygonio
+  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/polygonio/rest/api/reference/markets.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Polygonio
+  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/polygonio/rest/api/reference/stocks.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Polygonio
+  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