qstash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd39eb04db27197abf82b76f458ac5c7142d6ddb976efd81e4b87c3319c91245
+  data.tar.gz: 8f2d438cdf82010113c1298bb0de7b844f53ef6cff656eb796b450334eed2856
+SHA512:
+  metadata.gz: d6d60b5e86997cbb8a3e477646b1eb3008ee7fe30979b8d59d282d213b20631f2f1c07d480f0b3f4df980bcad9f6d12611ee1657321a1ac017694dd1ab841d91
+  data.tar.gz: d162c3b3e312921ed357d46c619904f3d6896e8979dcb5d032a8ad2363b9dc034113dd2888ed07a86919ff0c09e90b1fe25a37e44df551984363e029e38681ad

data/.dockerignore

@@ -0,0 +1,9 @@
+./.bundle
+/vendor/
+Gemfile.lock
+
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: ci
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.3]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.3]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake lint

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.standard.yml

@@ -0,0 +1,3 @@
+parallel: true
+format: progress
+

data/Dockerfile-3.3

@@ -0,0 +1,30 @@
+FROM ruby:3.3-alpine as base
+
+RUN apk add --update --no-cache \
+  build-base \
+  cmake \
+  tzdata \
+  bash \
+  git
+
+ENV APP_PATH /var/www/qstash-rb
+RUN mkdir -p $APP_PATH
+
+# Build intermediate
+FROM base as intermediate
+
+WORKDIR $APP_PATH
+
+RUN rm -rf /var/cache/apk/*
+
+FROM base as development
+
+COPY --from=intermediate $APP_PATH $APP_PATH
+
+WORKDIR $APP_PATH
+
+ENV GEM_HOME $APP_PATH/vendor/bundle
+ENV BUNDLE_PATH vendor/bundle
+
+COPY . ./
+RUN bundle check || bundle install

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in qstash-rb.gemspec
+gemspec
+
+gem "rake", ">= 12.0"
+gem "minitest", "~> 5.0"
+gem "minitest-reporters", ">= 1.4"
+gem "mocha", ">= 1.12"
+gem "pry"
+
+gem "guard"
+gem "guard-minitest"
+gem "yard"
+
+gem "standard"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Drew Monroe
+
+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,247 @@
+# QStash
+
+[![ci](https://github.com/dvmonroe/qstash-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/dvmonroe/qstash-rb/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/56ffdaabb1df70536c88/maintainability)](https://codeclimate.com/github/dvmonroe/qstash-rb/maintainability)
+
+A Ruby client for the [QStash](https://upstash.com/qstash) service from Upstash.
+
+QStash is an HTTP-based messaging and scheduling solution, designed for serverless and edge computing environments, guaranteeing at-least-once delivery.
+
+If you're coming from a Rails background, you'll be familiar with ActiveJob, Sidekiq, and/or DelayedJob for background job processing. QStash can run background jobs which may/may not be a use case if you're using Ruby in a serverless environment but it's also much more than that. It can:
+
+- Schedule messages to be delivered at a later time.
+- Serve as a FIFO message queue.
+- Serve as a push based fanout exchange (think RabbitMQ).
+
+## Contents
+
+- [QStash](#qstash)
+  - [Contents](#contents)
+  - [Getting Started](#getting-started)
+  - [Messages](#messages)
+  - [Events](#events)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qstash'
+```
+
+Setup your thread safe configuration:
+
+```ruby
+QStash.configure do |q|
+  q.token = "your-qstash-token"
+  q.url = "https://qstash.upstash.io"
+end
+```
+
+or you can set the following ENV variables at runtime:
+
+```bash
+QSTASH_TOKEN=your-qstash-token
+QSTASH_URL=https://qstash.upstash.io
+```
+
+## Messages
+
+#### Publish
+To [publish a message](https://upstash.com/docs/qstash/api/publish) to a queue:
+
+```ruby
+QStash::Message.publish(destination: "https://example.com/api/message-receiver", body: "Hello, World!")
+```
+
+From Upstash's docs:
+
+> Destination can either be a topic name or id that you configured in the Upstash console, a valid url where the message gets sent to, or a valid QStash API name like api/llm. If the destination is a URL, make sure the URL is prefixed with a valid protocol (http:// or https://)
+
+You can also pass in headers. We help format Upstash's headers for you if you pass them in:
+
+```
+- "Upstash-Method",
+- "Upstash-Timeout",
+- "Upstash-Retries",
+- "Upstash-Callback",
+- "Upstash-Failure-Callback",
+- "Upstash-Forward-*
+- "Upstash-Delay",
+- "Upstash-Not-Before",
+- "Upstash-Deduplication-Id",
+- "Upstash-Content-Based-Deduplication"
+```
+
+```ruby
+QStash::Message.publish(
+  destination: "https://example.com/api/message-receiver",
+  body: "Hello, World!",
+  headers: { upstash_retries: 2 }
+)
+```
+
+#### Enqueue
+
+To [enqueue a message](https://upstash.com/docs/qstash/api/enqueue) to a queue:
+
+```ruby
+QStash::Message.enqueue(
+  queue_name: "my-queue",
+  destination: "https://example.com/api/message-receiver",
+  body: "Hello, World!"
+)
+```
+
+#### Batch
+
+To [batch publish messages](https://upstash.com/docs/qstash/api/messages/batch):
+
+```ruby
+QStash::Message.batch_publish(messages: [
+  {
+    destination: "https://example.com/api/message-receiver",
+    body: "Hello, World!"
+  },
+  {
+    destination: "https://example.com/api/message-receiver",
+    body: "Hello, World Again!",
+    headers: { upstash_retries: 2 }
+  }
+])
+```
+
+#### Get
+
+To [get a message](https://upstash.com/docs/qstash/api/messages/get) from a queue:
+
+```ruby
+QStash::Message.get("1234") # 1234 is the message id
+```
+
+#### Cancel
+
+To [cancel a message](https://upstash.com/docs/qstash/api/messages/cancel) from a queue:
+
+```ruby
+QStash::Message.cancel("1234") # 1234 is the message id
+```
+
+#### Bulk Cancel
+
+To [bulk cancel messages](https://upstash.com/docs/qstash/api/messages/bulk-cancel) from a queue:
+
+```ruby
+QStash::Message.cancel(["1234", "5678"])
+```
+
+## Events
+
+#### List
+
+To [list all events](https://upstash.com/docs/qstash/api/events/list):
+
+```ruby
+QStash::Event.list
+```
+
+You can pass in any filters available from the [Upstash docs](https://upstash.com/docs/qstash/api/events/list).
+
+```ruby
+QStash::Event.list(filters: {
+  queueName: "my-queue",
+  fromDate: Time.now - 1.day,
+  toDate: Time.now
+})
+```
+
+## Signing Keys
+
+#### Get
+
+To get your current [signing keys](https://upstash.com/docs/qstash/api/signingKeys/get):
+
+```ruby
+QStash::SigningKeys.get
+```
+
+#### Rotate
+
+To [rotate signing keys](https://upstash.com/docs/qstash/api/signingKeys/rotate):
+
+```ruby
+QStash::SigningKeys.rotate
+```
+
+## Dead Letter Queue
+
+#### Get
+
+To [get dead letter messages](https://upstash.com/docs/qstash/api/dlq/getMessage):
+
+```ruby
+QStash::DLQ.get("1234") # 1234 is the dlq id of the message
+```
+
+#### List
+
+To [list dead letter messages](https://upstash.com/docs/qstash/api/dlq/listMessages):
+
+```ruby
+QStash::DLQ.list
+```
+
+To [list dead letter messages with filters](https://upstash.com/docs/qstash/api/dlq/listMessages):
+
+```ruby
+QStash::DLQ.list(filters: {
+  queueName: "my-queue", 
+  fromDate: Time.now - 1.day, 
+  toDate: Time.now 
+})
+```
+
+#### Delete
+
+To [delete dead letter messages](https://upstash.com/docs/qstash/api/dlq/deleteMessage):
+
+```ruby
+QStash::DLQ.delete("1234") # 1234 is the dlq id of the message
+```
+
+#### Delete Multiple
+
+To [delete multiple dead letter messages](https://upstash.com/docs/qstash/api/dlq/deleteMessages):
+
+```ruby
+QStash::DLQ.delete(["1234", "5678"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Testing across all supported versions:
+
+To run tests across all gem supported ruby versions (requires Docker):
+```sh
+bin/dev-test
+```
+To run lint across all gem supported ruby versions (requires Docker):
+```sh
+bin/dev-lint
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/qstash-rb.
+
+## 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,18 @@
+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
+
+task :lint do
+  if ENV["CI"]
+    sh "bin/standardrb"
+  else
+    sh "bin/standardrb --fix"
+  end
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qstash"
+
+require "pry"
+Pry.start

data/bin/dev-lint

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+system "docker-compose run --rm 3.3 bin/standardrb"

data/bin/dev-test

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+system "docker-compose run --rm 3.3 bundle exec rake test"

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/standardrb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/docker-compose.yml

@@ -0,0 +1,20 @@
+version: '3.9'
+
+services:
+  '3.3':
+    build:
+      context: .
+      dockerfile: Dockerfile-3.3
+    tty: true
+    stdin_open: true
+    volumes:
+      - ./bin:/var/www/qstash-rb/bin/
+      - ./lib:/var/www/qstash-rb/lib/
+      - ./test:/var/www/qstash-rb/test/
+    container_name: qstah-rb-3.3
+    command: bash
+
+volumes:
+  bin:
+  lib:
+  test:

data/lib/qstash/callable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module QStash
+  module Callable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def call(*args, **)
+        if args.empty?
+          new(**).call
+        else
+          new(*args, **).call
+        end
+      end
+    end
+  end
+end

data/lib/qstash/configuration.rb

@@ -0,0 +1,25 @@
+module QStash
+  module Configuration
+    extend self
+
+    def token
+      Thread.current[:qstash_token] || ENV.fetch("QSTASH_TOKEN", "")
+    end
+
+    def token=(value)
+      Thread.current[:qstash_token] = value
+    end
+
+    def url
+      Thread.current[:qstash_url] || ENV.fetch("QSTASH_URL", "https://qstash.upstash.io")
+    end
+
+    def url=(value)
+      Thread.current[:qstash_url] = value
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/qstash/dlq/delete.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/dlq/deleteMessage
+module QStash
+  module DLQ
+    class Delete
+      include QStash::Callable
+      attr_reader :dlq_ids, :headers
+
+      def initialize(dlq_ids, headers: {})
+        @dlq_ids = Array(dlq_ids)
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.delete(body, headers)
+      end
+
+      private
+
+      def base_url
+        QStash.config.url.sub(/\/$/, "")
+      end
+
+      def body
+        (dlq_ids.length > 1) ? {dlqIds: dlq_ids} : {}
+      end
+
+      def endpoint
+        [
+          base_url,
+          (dlq_ids.length > 1) ? Endpoints::DLQ_ENDPOINT : "#{Endpoints::DLQ_ENDPOINT}/#{dlq_ids.first}"
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/dlq/get.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/dlq/getMessage
+module QStash
+  module DLQ
+    class Get
+      include QStash::Callable
+      attr_reader :headers, :dlq_id
+
+      def initialize(dlq_id, headers: {})
+        @dlq_id = dlq_id
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.get(headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::DLQ_ENDPOINT,
+          dlq_id
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/dlq/list.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/dlq/listMessages
+module QStash
+  module DLQ
+    class List
+      include QStash::Callable
+      attr_reader :filters, :headers
+
+      def initialize(filters: {}, headers: {})
+        @filters = filters
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.get(headers)
+      end
+
+      private
+
+      def endpoint
+        url = [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::DLQ_ENDPOINT
+        ].join("/")
+
+        # Add query params from filters hash
+        url += "?#{URI.encode_www_form(filters)}" unless filters.empty?
+
+        url
+      end
+    end
+  end
+end

data/lib/qstash/dlq.rb

@@ -0,0 +1,23 @@
+require "qstash/dlq/get"
+require "qstash/dlq/list"
+require "qstash/dlq/delete"
+
+module QStash
+  module DLQ
+    class << self
+      def get(dlq_id, headers: {})
+        Get.call(dlq_id, headers: headers)
+      end
+
+      def list(filters: {}, headers: {})
+        List.call(filters: filters, headers: headers)
+      end
+
+      def delete(dlq_id, headers: {})
+        Delete.call(dlq_id, headers: headers)
+      end
+    end
+
+    private_constant :Get, :List, :Delete
+  end
+end

data/lib/qstash/endpoints.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module QStash
+  module Endpoints
+    # Messages
+    ENQUEUE_ENDPOINT = "v2/enqueue"
+    PUBLISH_ENDPOINT = "v2/publish"
+    BATCH_ENDPOINT = "v2/batch"
+    GET_ENDPOINT = "v2/messages"
+    CANCEL_ENDPOINT = "v2/messages"
+    BULK_CANCEL_ENDPOINT = "v2/messages"
+
+    # Events
+    LIST_EVENTS_ENDPOINT = "v2/events"
+
+    # Signing Keys
+    ROTATE_SIGNING_KEY_ENDPOINT = "v2/keys/rotate"
+    SIGNING_KEYS_ENDPOINT = "v2/keys"
+
+    # Dead Letter Queue
+    DLQ_ENDPOINT = "v2/dlq"
+  end
+end

data/lib/qstash/events/list.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/events/list
+module QStash
+  module Events
+    class List
+      include QStash::Callable
+      attr_reader :filters, :headers
+
+      def initialize(filters: {}, headers: {})
+        @filters = filters
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.get(headers)
+      end
+
+      private
+
+      def endpoint
+        url = [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::LIST_EVENTS_ENDPOINT
+        ].join("/")
+
+        # Add query params from filters hash
+        url += "?#{URI.encode_www_form(filters)}" unless filters.empty?
+
+        url
+      end
+    end
+  end
+end

data/lib/qstash/events.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "qstash/events/list"
+
+module QStash
+  module Events
+    class << self
+      def list(filters: {}, headers: {})
+        List.call(filters: filters, headers: headers)
+      end
+    end
+
+    private_constant :List
+  end
+end

data/lib/qstash/headers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module QStash
+  module Headers
+    extend self
+
+    def qstash_header_key(key)
+      case key.to_sym
+      when :content_type
+        "Content-Type"
+      when :upstash_method
+        "Upstash-Method"
+      when :upstash_timeout
+        "Upstash-Timeout"
+      when :upstash_retries
+        "Upstash-Retries"
+      when :upstash_callback
+        "Upstash-Callback"
+      when :upstash_failure_callback
+        "Upstash-Failure-Callback"
+      when /^upstash_forward_/
+        "Upstash-Forward-#{key.to_s.gsub(/^upstash_forward_/, "").camelize(:lower)}"
+      when :upstash_delay
+        "Upstash-Delay"
+      when :upstash_not_before
+        "Upstash-Not-Before"
+      when :upstash_deduplication_id
+        "Upstash-Deduplication-Id"
+      when :upstash_content_based_deduplication
+        "Upstash-Content-Based-Deduplication"
+      else
+        key.to_s
+      end
+    end
+  end
+end

data/lib/qstash/http_client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module QStash
+  class HttpClient
+    attr_reader :uri
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def delete(body, headers = {})
+      request = Net::HTTP::Delete.new(uri)
+      request.body = body.to_json
+      set_headers(request, headers)
+
+      make_request(request)
+    end
+
+    def get(headers = {})
+      request = Net::HTTP::Get.new(uri)
+      set_headers(request, headers)
+
+      make_request(request)
+    end
+
+    def post(body, headers = {})
+      request = Net::HTTP::Post.new(uri)
+      request.body = body.to_json
+      set_headers(request, headers)
+
+      make_request(request)
+    end
+
+    private
+
+    def make_request(request)
+      request["Authorization"] = "Bearer #{QStash.config.token}"
+      request["User-Agent"] = "qstash-rb/#{QStash::VERSION}"
+
+      Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+        http.request(request).then do |response|
+          Response.new(response)
+        end
+      end
+    end
+
+    def set_headers(request, headers)
+      headers.each do |key, value|
+        request[QStash::Headers.qstash_header_key(key)] = value
+      end
+    end
+  end
+end

data/lib/qstash/message/batch.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/messages/batch
+module QStash
+  module Message
+    class Batch
+      include QStash::Callable
+      attr_reader :messages, :headers
+
+      def initialize(messages:, headers: {})
+        @messages = messages
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.post(messages, headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::BATCH_ENDPOINT
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/message/cancel.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/messages/cancel
+# https://upstash.com/docs/qstash/api/messages/bulk-cancel
+module QStash
+  module Message
+    class Cancel
+      include QStash::Callable
+      attr_reader :message_ids, :headers
+
+      def initialize(message_ids, headers: {})
+        @message_ids = Array(message_ids)
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.delete(body, headers)
+      end
+
+      private
+
+      def base_url
+        QStash.config.url.sub(/\/$/, "")
+      end
+
+      def body
+        (message_ids.length > 1) ? {messageIds: message_ids} : {}
+      end
+
+      def endpoint
+        [
+          base_url,
+          (message_ids.length > 1) ? Endpoints::BULK_CANCEL_ENDPOINT : "#{Endpoints::CANCEL_ENDPOINT}/#{message_ids.first}"
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/message/enqueue.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/enqueue
+module QStash
+  module Message
+    class Enqueue
+      include QStash::Callable
+      attr_reader :queue_name, :destination, :body, :headers
+
+      def initialize(queue_name:, destination:, body:, headers: {})
+        @queue_name = queue_name
+        @destination = destination
+        @body = body
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.post(body, headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::ENQUEUE_ENDPOINT,
+          queue_name,
+          destination
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/message/get.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/messages/get
+module QStash
+  module Message
+    class Get
+      include QStash::Callable
+      attr_reader :message_id, :headers
+
+      def initialize(message_id, headers: {})
+        @message_id = message_id
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.get(headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::GET_ENDPOINT,
+          message_id
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/message/publish.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/publish
+module QStash
+  module Message
+    class Publish
+      include QStash::Callable
+      attr_reader :destination, :body, :headers
+
+      def initialize(destination:, body:, headers: {})
+        @destination = destination
+        @body = body
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.post(body, headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::PUBLISH_ENDPOINT,
+          destination
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/message.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "qstash/message/publish"
+require "qstash/message/enqueue"
+require "qstash/message/batch"
+require "qstash/message/get"
+require "qstash/message/cancel"
+
+module QStash
+  module Message
+    class << self
+      def batch(messages:, headers: {})
+        Batch.call(messages: messages, headers: headers)
+      end
+
+      def cancel(message_ids, headers: {})
+        Cancel.call(message_ids, headers: headers)
+      end
+
+      def enqueue(queue_name:, destination:, body:, headers: {})
+        Enqueue.call(queue_name: queue_name, destination: destination, body: body, headers: headers)
+      end
+
+      def get(message_id, headers: {})
+        Get.call(message_id, headers: headers)
+      end
+
+      def publish(destination:, body:, headers: {})
+        Publish.call(destination: destination, body: body, headers: headers)
+      end
+    end
+
+    private_constant :Publish, :Enqueue, :Batch, :Get, :Cancel
+  end
+end

data/lib/qstash/response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module QStash
+  class Response
+    attr_reader :status, :headers, :body, :message
+
+    def initialize(response)
+      @status = response.code.to_i
+      @headers = response.to_hash
+      @message = response.message
+      @body = begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        response.body
+      end
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} #{status} #{message} readbody=true>"
+    end
+  end
+end

data/lib/qstash/signing_keys/get.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/signingKeys/get
+module QStash
+  module SigningKeys
+    class Get
+      include QStash::Callable
+      attr_reader :headers
+
+      def initialize(headers: {})
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.get(headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::SIGNING_KEYS_ENDPOINT
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/signing_keys/rotate.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# https://upstash.com/docs/qstash/api/signingKeys/rotate
+module QStash
+  module SigningKeys
+    class Rotate
+      include QStash::Callable
+      attr_reader :headers
+
+      def initialize(headers: {})
+        @headers = headers
+      end
+
+      def call
+        uri = URI(endpoint)
+        client = QStash::HttpClient.new(uri)
+        client.post({}, headers)
+      end
+
+      private
+
+      def endpoint
+        [
+          QStash.config.url.sub(/\/$/, ""),
+          Endpoints::ROTATE_SIGNING_KEY_ENDPOINT
+        ].join("/")
+      end
+    end
+  end
+end

data/lib/qstash/signing_keys.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "qstash/signing_keys/get"
+require "qstash/signing_keys/rotate"
+
+module QStash
+  module SigningKeys
+    class << self
+      def get(headers: {})
+        Get.call(headers: headers)
+      end
+
+      def rotate(headers: {})
+        Rotate.call(headers: headers)
+      end
+    end
+
+    private_constant :Get, :Rotate
+  end
+end

data/lib/qstash/version.rb

@@ -0,0 +1,3 @@
+module QStash
+  VERSION = "0.1.0"
+end

data/lib/qstash.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+require "qstash/version"
+require "qstash/configuration"
+require "qstash/headers"
+require "qstash/http_client"
+require "qstash/response"
+require "qstash/callable"
+require "qstash/endpoints"
+
+require "qstash/message"
+require "qstash/events"
+require "qstash/signing_keys"
+require "qstash/dlq"
+
+module QStash
+  class Error < StandardError; end
+
+  class << self
+    def configure
+      yield Configuration
+    end
+
+    def configuration
+      Configuration
+    end
+
+    alias_method :config, :configuration
+  end
+end

data/qstash.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "qstash/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "qstash"
+  spec.version = QStash::VERSION
+  spec.authors = ["Drew Monroe"]
+  spec.email = ["drew@pinecreeklabs.com"]
+
+  spec.summary = "A Ruby client for the QStash API"
+  spec.description = "A Ruby client for the QStash API"
+  spec.homepage = "https://github.com/dvmonroe/qstash-ruby"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: qstash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Monroe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-03 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby client for the QStash API
+email:
+- drew@pinecreeklabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".standard.yml"
+- Dockerfile-3.3
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dev-lint
+- bin/dev-test
+- bin/setup
+- bin/standardrb
+- docker-compose.yml
+- lib/qstash.rb
+- lib/qstash/callable.rb
+- lib/qstash/configuration.rb
+- lib/qstash/dlq.rb
+- lib/qstash/dlq/delete.rb
+- lib/qstash/dlq/get.rb
+- lib/qstash/dlq/list.rb
+- lib/qstash/endpoints.rb
+- lib/qstash/events.rb
+- lib/qstash/events/list.rb
+- lib/qstash/headers.rb
+- lib/qstash/http_client.rb
+- lib/qstash/message.rb
+- lib/qstash/message/batch.rb
+- lib/qstash/message/cancel.rb
+- lib/qstash/message/enqueue.rb
+- lib/qstash/message/get.rb
+- lib/qstash/message/publish.rb
+- lib/qstash/response.rb
+- lib/qstash/signing_keys.rb
+- lib/qstash/signing_keys/get.rb
+- lib/qstash/signing_keys/rotate.rb
+- lib/qstash/version.rb
+- qstash.gemspec
+homepage: https://github.com/dvmonroe/qstash-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dvmonroe/qstash-ruby
+  source_code_uri: https://github.com/dvmonroe/qstash-ruby
+  changelog_uri: https://github.com/dvmonroe/qstash-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: A Ruby client for the QStash API
+test_files: []