async-polygon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72601ebefe1b4076f1e0023b517cac7f59003ec1e656a7eb7c236503b77f4e44
+  data.tar.gz: f9ad0cf70c8555c8a11a2daeb8ef04621478e4994664e1c137474458f9223e20
+SHA512:
+  metadata.gz: b6964250f6fdc464898ec480030f5b68991a7805ebf18c68eae89569f8028ec6f0de50344332c6f3121f4cd4b80efbad8f3551939a3794248d18b9a8fb4bacf7
+  data.tar.gz: 31afcacc010c7b687c91c0bfad8e1574607a42986eb4d7287703bc01b49716eb0bcd7da927512050fb320cecaa46f8a3b639412746655f6cc227707ab3036539

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 William T. Nelson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Async::Polygon
+
+A stub asynchronous HTTP/2 client for [polygon.io](https://polygon.io/docs/). Made with [async-http](https://github.com/socketry/async-http).
+
+## Installation
+
+```bash
+gem install async-polygon
+```
+
+## Usage
+
+### Create a client
+
+An API key is required and can be set in the `POLYGON_API_KEY` environment variable or specified at client initialization:
+
+```ruby
+client = Async::Polygon::Client.new api_key: '2qKgb9s3qUIwt6B2zGSqrVe6H5v44y6m'
+```
+
+By default, requests are rate limited to 5 per minute. For subscription tiers above basic, initialize a client with `basic: false` to remove the restriction.
+
+### Make a request
+
+```ruby
+uri = URI 'https://api.polygon.io/v3/reference/tickers'
+uri.query = URI.encode_www_form ticker: 'SPY', date: '2024-10-04'
+client = Async::Polygon::Client.new
+res = client.get uri
+fail if ! res.success?
+data = JSON.parse res.read
+```
+
+### Make requests asynchronously
+
+```ruby
+client = Async::Polygon::Client.new basic: false
+ticker_symbols = %w[AAPL MSFT NVDA GOOGL AMZN BRK.A WMT JPM AFMJF FLMMF NGXXF]
+date = Date.new 2024, 10, 4
+count = 99
+start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+Sync do
+  count.times do
+    Async do
+      uri = URI 'https://api.polygon.io/v3/reference/tickers'
+      uri.query = URI.encode_www_form ticker: ticker_symbols.sample, date: date.to_s
+      res = client.get uri
+      fail if ! res.success?
+    end
+  end
+end
+
+finish = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+duration = finish - start
+
+puts "#{duration.round 2} seconds elapsed (#{(count/duration).round 2} per sec)"
+```
+
+Starting with the hundredth request, non-basic clients are rate limited [per usage recommendations](https://polygon.io/knowledge-base/article/what-is-the-request-limit-for-polygons-restful-apis).
+
+## TODO
+
+* Add a WebSocket client using [async-websocket](https://github.com/socketry/async-websocket).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/async/polygon/client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'async/http'
+
+module Async
+  module Polygon
+    class Client
+      def initialize(api_key: ENV['POLYGON_API_KEY'], basic: true)
+        api_key.to_s.length == 32 \
+          or raise ArgumentError, 'API key required'
+        set_pace basic
+        @auth_headers = {'authorization' => "Bearer #{api_key}"}
+        @client = Async::HTTP::Internet.new
+        @request_semaphore = Async::Semaphore.new @reconnect_after
+        @completion_semaphore = Async::Semaphore.new @reconnect_after
+        @reset_mutex = Mutex.new
+      end
+
+      def get(uri)
+        ensure_client_readiness
+        @request_semaphore.acquire
+        @completion_semaphore.acquire do
+          Sync do
+            @client.get uri, @auth_headers
+          end
+        end
+      end
+
+      private
+
+      def set_pace(basic)
+        if basic
+          @reconnect_after =  5  # free tier
+          @reset_delay     = 60
+        else
+          @reconnect_after = 99  # go fast
+          @reset_delay     =  1
+        end
+      end
+
+      def ensure_client_readiness
+        if @request_semaphore.blocking?  # time to reset
+          Sync do
+            @reset_mutex.synchronize do
+              return if ! @request_semaphore.blocking?
+              @reconnect_after.times { @completion_semaphore.acquire }  # wait for requests
+              @client.close
+              @client = Async::HTTP::Internet.new
+              sleep @reset_delay
+              @reconnect_after.times { @completion_semaphore.release }
+              @reconnect_after.times { @request_semaphore.release }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/async/polygon/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Async
+  module Polygon
+    VERSION = '0.1.0'
+  end
+end

data/lib/async/polygon.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'polygon/version'
+require_relative 'polygon/client'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: async-polygon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William T. Nelson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+description:
+email:
+- 35801+wtn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/async/polygon.rb
+- lib/async/polygon/client.rb
+- lib/async/polygon/version.rb
+homepage: https://github.com/wtn/async-polygon
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.20
+signing_key:
+specification_version: 4
+summary: async client for polygon.io
+test_files: []