knockapi 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02b5965b9c39219da8275caf8ea54d22451c919330a110155657f1dbc5fa480c
-  data.tar.gz: b43840005837b8649093bbb354b82f5401afcfcb260adb93c175a3837206f7dd
+  metadata.gz: 903d2d837a18e4bb3ffa9c023971afcd4185354ab2d743af96d63e8601c85617
+  data.tar.gz: 3557d001b592fd33171c716392a98f76ca8e1d78c9b0297f034fa39489153487
 SHA512:
-  metadata.gz: 8ffbb9e5354ab085a0e1551d689847d3f6cb5ee9ad3ec0c765cbf54943cac5c3e1b663848a2c21395e8d83dd32838e0c2b0f9a1c88ad1bd38b7f37f6a149ce60
-  data.tar.gz: a904c79300bdd5f979520191dc2d10321814ba231243a74f2c8a1a093df9f21952bda7c4833a0d91fae529320f825bc09858aa5a97a60f6c4de58349de797ea9
+  metadata.gz: 7868b8ab6b9afa7bb213512d0eb9ee7efef256a6f87dd949712986bb3700028e8a9506253de8b359d1a6054380f803d70db021278e843595cd0a65ae1427d381
+  data.tar.gz: 9db5d54b2c22dd351cfe895dc0a0dda56511a63915dcf770ea9cb97e013907c5f57c4c5ced290843099590e418c5fef162e0864ef3550fdbd6db15c82b9aa77b

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 1.0.0 (2025-05-01)
+
+Full Changelog: [v0.6.2...v1.0.0](https://github.com/knocklabs/knock-ruby/compare/v0.6.2...v1.0.0)
+
+### Features
+
+* **api:** manual updates ([0d8043c](https://github.com/knocklabs/knock-ruby/commit/0d8043c40d338254cffd95c5bf060c31e01df817))
+* **api:** manual updates ([4653cd4](https://github.com/knocklabs/knock-ruby/commit/4653cd4dc7b6f2350040335188c828248b91ac8e))
+* **api:** manual updates ([5db7143](https://github.com/knocklabs/knock-ruby/commit/5db71437a429d5c23a01679ca17c7bd33e76927b))
+
+
+### Chores
+
+* sync repo ([603bdff](https://github.com/knocklabs/knock-ruby/commit/603bdff217b859fa636333ee19f4e8a0099a2829))
+* update SDK settings ([f89c129](https://github.com/knocklabs/knock-ruby/commit/f89c129b79de76e1b69b99d53c036ea5081d1198))
+* update SDK settings ([02bbb1c](https://github.com/knocklabs/knock-ruby/commit/02bbb1cdd204dc68f5c70ac979ac08679dcdbbec))
+* update SDK settings ([5feae14](https://github.com/knocklabs/knock-ruby/commit/5feae14501d46021f9f5bfd9da198816a9fb680e))
+* update SDK settings ([bdd01f1](https://github.com/knocklabs/knock-ruby/commit/bdd01f128840d10797e51673a3caf66f70adc033))

data/README.md

@@ -1,148 +1,211 @@
-# Knock Ruby library
+# Knock Ruby API library
 
-Knock API access for applications written in Ruby.
+The Knock Ruby library provides convenient access to the Knock REST API from any Ruby 3.2.0+ application.
+
+It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-See the documentation for Ruby usage examples.
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/knockapi).
+
+The REST API documentation can be found on [docs.knock.app](https://docs.knock.app).
 
 ## Installation
 
-```bash
-gem install knockapi
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "knockapi", "~> 1.0.0"
 ```
 
-## Configuration
+<!-- x-release-please-end -->
 
-To use the library you must provide a secret API key, provided in the Knock dashboard.
+## Usage
 
-You can set it as an environment variable:
+```ruby
+require "bundler/setup"
+require "knockapi"
 
-```bash
-KNOCK_API_KEY="sk_12345"
-```
+knock = Knockapi::Client.new(
+  api_key: "My API Key" # defaults to ENV["KNOCK_API_KEY"]
+)
 
-Or, you may set the key yourself in an initializer:
+response = knock.workflows.trigger("dinosaurs-loose", recipients: ["dnedry"], data: {dinosaur: "triceratops"})
 
-```ruby
-# /config/initializers/knock.rb
-Knock.configure do |config|
-  config.key = '[your api key]'
-  config.timeout = 120
-end
+puts(response.workflow_run_id)
 ```
 
-## Usage
+## Sorbet
 
-### Identifying users
+This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
+
+When using sorbet, it is recommended to use model classes as below. This provides stronger type checking and tooling integration.
 
 ```ruby
-Knock::Users.identify(
-  id: "jhammond",
-  data: {
-    name: "John Hammond",
-    email: "jhammond@ingen.net",
-  }
-)
+knock.workflows.trigger("dinosaurs-loose", recipients: ["dnedry"], data: {dinosaur: "triceratops"})
 ```
 
-### Sending notifies (triggering workflows)
+### Pagination
+
+List methods in the Knock API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
 
 ```ruby
-# The key of the workflow (from Knock dashboard)
-Knock::Workflows.trigger(
-  key: "dinosaurs-loose",
-  # user id of who performed the action
-  actor: "dnedry",
-  # list of user ids for who should receive the notif
-  recipients: ["jhammond", "agrant", "imalcolm", "esattler"],
-  # data payload to send through
-  data: {
-    type: "trex",
-    priority: 1,
-  },
-  # an optional key to provide to cancel a notify
-  cancellation_key: trigger_alert.id,
-)
+page = knock.users.list
+
+# Fetch single item from page.
+user = page.entries[0]
+puts(user.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |user|
+  puts(user.id)
+end
 ```
 
-### Retrieving users
+### Errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Knockapi::Errors::APIError` will be thrown:
 
 ```ruby
-Knock::Users.get(id: "jhammond")
+begin
+  user = knock.users.get("dnedry")
+rescue Knockapi::Errors::APIError => e
+  puts(e.status) # 400
+end
 ```
 
-### Deleting users
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
 
 ```ruby
-Knock::Users.delete(id: "jhammond")
+# Configure the default for all requests:
+knock = Knockapi::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+knock.users.get("dnedry", request_options: {max_retries: 5})
 ```
 
-### Preferences
+### Timeouts
+
+By default, requests will time out after 60 seconds.
+
+Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
+
+You can use the `timeout` option to configure or disable this:
 
 ```ruby
-# Set an entire preference set
-Knock::Users.set_preferences(
-  user_id: "jhammond",
-  channel_types: { email: true, sms: false },
-  workflows: {
-    'dinosaurs-loose': {
-      channel_types: { email: false, in_app_feed: false }
-    }
-  }
+# Configure the default for all requests:
+knock = Knockapi::Client.new(
+  timeout: nil # default is 60
 )
 
-# Get an entire preference set
-Knock::Users.get_preferences(user_id: "jhammond")
+# Or, configure per-request:
+knock.users.get("dnedry", request_options: {timeout: 5})
 ```
 
-### Getting and setting channel data
+## Model DSL
+
+This library uses a simple DSL to represent request parameters and response shapes in `lib/knockapi/models`.
+
+With the right [editor plugins](https://shopify.github.io/ruby-lsp), you can ctrl-click on elements of the DSL to navigate around and explore the library.
+
+In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can also be used. For example, the following are interchangeable as arguments:
 
 ```ruby
-# Set channel data for an APNS
-Knock::Users.set_channel_data(
-  id: "jhammond",
-  channel_id: KNOCK_APNS_CHANNEL_ID,
-  channel_data: {
-    'tokens': [apns_token]
-  }
-)
+# This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
+params = Knockapi::Models::WorkflowTriggerParams.new(recipients: ["dnedry"], data: {dinosaur: "triceratops"})
 
-# Get channel data for the APNS channel
-Knock::Users.get_channel_data(user_id: "jhammond", channel_id: KNOCK_APNS_CHANNEL_ID)
+# This also works
+params = {
+  recipients: ["dnedry"],
+  data: {dinosaur: "triceratops"}
+}
 ```
 
-### Cancelling workflows
+## Editor support
+
+A combination of [Shopify LSP](https://shopify.github.io/ruby-lsp) and [Solargraph](https://solargraph.org/) is recommended for non-[Sorbet](https://sorbet.org) users. The former is especially good at go to definition, while the latter has much better auto-completion support.
+
+## Advanced concepts
+
+### Making custom/undocumented requests
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
 
 ```ruby
-Knock::Workflows.cancel(
-  key: "dinosaurs-loose",
-  cancellation_key: trigger_alert.id,
-  # Optionally, you can provide recipients to cancel for
-  recipients: ["jhammond"]
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"he": "llo"},
 )
 ```
 
-### Signing JWTs
+### Concurrency & connection pooling
 
-You can use the `jwt` gem to sign JWTs easily. You will need to generate an environment specific signing key, which you can find in the Knock dashboard.
+The `Knockapi::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count.
 
-If you're using a signing token you will need to pass this to your client to perform authentication. You can read more about [clientside authentication here](https://docs.knock.app/client-integration/authenticating-users).
+When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
 
-```ruby
-require 'jwt'
-
-secret = ENV['KNOCK_SIGNING_KEY']
-now = Time.now.to_i
-
-payload = {
-  # The subject of the token
-  sub: 'jhammond',
-  # When the token was issued
-  iat: now,
-  # Expire the token in 1 week
-  exp: now + (24 * 7 * 3600)
-}
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+Currently, `Knockapi::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+
+### Sorbet
 
-JWT.encode(payload, secret, 'RS256')
+#### Argument passing trick
+
+It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator.
+
+```ruby
+params = Knockapi::Models::WorkflowTriggerParams.new(recipients: ["dnedry"], data: {dinosaur: "triceratops"})
+knock.workflows.trigger("dinosaurs-loose", **params)
 ```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/knocklabs/knock-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Knock please follow the respective company's security reporting guidelines.
+
+### Knock Terms and Policies
+
+Please contact security@knock.app for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/knockapi/client.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Knockapi
+  class Client < Knockapi::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [Knockapi::Resources::Shared]
+    attr_reader :shared
+
+    # @return [Knockapi::Resources::Recipients]
+    attr_reader :recipients
+
+    # @return [Knockapi::Resources::Users]
+    attr_reader :users
+
+    # @return [Knockapi::Resources::Objects]
+    attr_reader :objects
+
+    # @return [Knockapi::Resources::Tenants]
+    attr_reader :tenants
+
+    # @return [Knockapi::Resources::BulkOperations]
+    attr_reader :bulk_operations
+
+    # @return [Knockapi::Resources::Messages]
+    attr_reader :messages
+
+    # @return [Knockapi::Resources::Providers]
+    attr_reader :providers
+
+    # @return [Knockapi::Resources::Integrations]
+    attr_reader :integrations
+
+    # @return [Knockapi::Resources::Workflows]
+    attr_reader :workflows
+
+    # @return [Knockapi::Resources::Schedules]
+    attr_reader :schedules
+
+    # @return [Knockapi::Resources::Channels]
+    attr_reader :channels
+
+    # @return [Knockapi::Resources::Audiences]
+    attr_reader :audiences
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["KNOCK_API_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["KNOCK_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["KNOCK_API_KEY"],
+      base_url: ENV["KNOCK_BASE_URL"],
+      max_retries: Knockapi::Client::DEFAULT_MAX_RETRIES,
+      timeout: Knockapi::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Knockapi::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.knock.app"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"KNOCK_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @shared = Knockapi::Resources::Shared.new(client: self)
+      @recipients = Knockapi::Resources::Recipients.new(client: self)
+      @users = Knockapi::Resources::Users.new(client: self)
+      @objects = Knockapi::Resources::Objects.new(client: self)
+      @tenants = Knockapi::Resources::Tenants.new(client: self)
+      @bulk_operations = Knockapi::Resources::BulkOperations.new(client: self)
+      @messages = Knockapi::Resources::Messages.new(client: self)
+      @providers = Knockapi::Resources::Providers.new(client: self)
+      @integrations = Knockapi::Resources::Integrations.new(client: self)
+      @workflows = Knockapi::Resources::Workflows.new(client: self)
+      @schedules = Knockapi::Resources::Schedules.new(client: self)
+      @channels = Knockapi::Resources::Channels.new(client: self)
+      @audiences = Knockapi::Resources::Audiences.new(client: self)
+    end
+  end
+end

data/lib/knockapi/errors.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < Knockapi::Errors::Error
+    end
+
+    class APIError < Knockapi::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < Knockapi::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < Knockapi::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < Knockapi::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [Knockapi::Errors::APIStatusError]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          Knockapi::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Knockapi::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Knockapi::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Knockapi::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Knockapi::Errors::ConflictError.new(**kwargs)
+        in 422
+          Knockapi::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Knockapi::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Knockapi::Errors::InternalServerError.new(**kwargs)
+        else
+          Knockapi::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end