moderation_api 1.2.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12e29ae7110131a4a7699d95b2e6270236650c6c61456ddc8d3818947aed8115
-  data.tar.gz: 65b580b31b50dcc68b0373b586be940c48807352b06e9b536405778fbae4a67d
+  metadata.gz: e7d5ba12d2690e74004078f8d787a1b64864d2ce70ffb1a6b664b86c1c025dfb
+  data.tar.gz: 6a24ef5021401d5a0d5a33797022bd14d14cb754299d1c63e423f770611883c4
 SHA512:
-  metadata.gz: 94531d1b4beb1a93012524b256c9525b5f7710634973544d2c534f5532a6049d30fc177faee1838a2cf2b7ce95ed51c23faf39a7426ed347f37b143fa1936027
-  data.tar.gz: e08851ca8ce76353c4078c56c37669e1a39c9bdf3300c7cd1e3dfa911340cc6619f1cac8a21b015b51510eef8a254a1f70afdc459c0bf35ca4387e60229446ad
+  metadata.gz: 92c7c5ec938b1f2dadef844161f7b118d590bc33bb5a73b8e030304b004dc0fb023246e4da5f8fa1bd3f99209a574d7ac48682c65bad4bd4e96d884c57cd4846
+  data.tar.gz: 4f7654eaceb8961be8b3df78822f86bf3fcf509ec33c6cdb29b6e7ec0e15112188495cfbad2a74ef00e0140f03626f2908e981eea7fb7cd550b1f817b40b9f09

data/.ignore

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

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## 2.0.1 (2025-12-05)
+
+Full Changelog: [v2.0.0...v2.0.1](https://github.com/moderation-api/sdk-ruby/compare/v2.0.0...v2.0.1)
+
+### Documentation
+
+* updated readme ([a824572](https://github.com/moderation-api/sdk-ruby/commit/a8245722455e6486264a86e3e18d4bad516cc2f1))
+
+## 2.0.0 (2025-12-05)
+
+Full Changelog: [v0.0.1...v2.0.0](https://github.com/moderation-api/sdk-ruby/compare/v0.0.1...v2.0.0)
+
+### Features
+
+* **api:** api update ([400d1cc](https://github.com/moderation-api/sdk-ruby/commit/400d1cc55e946cd047ebe6837c64e881f9796120))
+* **api:** api update ([34ddc34](https://github.com/moderation-api/sdk-ruby/commit/34ddc3478338af0c07107d739c570bd0cb688215))
+* **api:** api update ([7b0c383](https://github.com/moderation-api/sdk-ruby/commit/7b0c38363370d29eeacc1a5e6cecb909c0b16353))
+* **api:** manual updates ([aa5e0e6](https://github.com/moderation-api/sdk-ruby/commit/aa5e0e6d3afd7be708d96205d2748a40845b7931))
+* **api:** manual updates ([c38719d](https://github.com/moderation-api/sdk-ruby/commit/c38719de057b770b675e67383cc4e5fac1973a9c))
+* **api:** manual updates ([e304765](https://github.com/moderation-api/sdk-ruby/commit/e304765ec2028a345bcc3e860f1e7f53ffb30a58))
+* **api:** manual updates ([2e5bc4c](https://github.com/moderation-api/sdk-ruby/commit/2e5bc4cfc267ccdfe6d26a9873409856d01ddc5d))
+* **api:** manual updates ([667a0b8](https://github.com/moderation-api/sdk-ruby/commit/667a0b81c42ac2f4fd04035386dedf0cf67380ea))
+* **api:** manual updates ([ed95ed4](https://github.com/moderation-api/sdk-ruby/commit/ed95ed44d04677ce0699a00d9bfedca7b1a1db8f))
+* **api:** manual updates ([495a03b](https://github.com/moderation-api/sdk-ruby/commit/495a03b50318611091d581c0ef3892c44883e391))
+* **api:** manual updates ([a17bf98](https://github.com/moderation-api/sdk-ruby/commit/a17bf98e0d126505db304b1d316812a42ccd2a81))
+* **api:** manual updates ([f20d9aa](https://github.com/moderation-api/sdk-ruby/commit/f20d9aaa79b9d5b043a07bcc133bbdcd930c25c7))
+* **api:** manual updates ([6dc2d9d](https://github.com/moderation-api/sdk-ruby/commit/6dc2d9d4c46a7b4c0fed2a5e2b5821c951e5ccdf))
+* **api:** removed deprecated moderate endpoints ([5b163bc](https://github.com/moderation-api/sdk-ruby/commit/5b163bc4faf3fc881ea176aef9c58cef265943fe))
+
+
+### Chores
+
+* configure new SDK language ([22d6295](https://github.com/moderation-api/sdk-ruby/commit/22d6295c55898708f8e39df213365f37ad17f075))
+* update SDK settings ([492eccb](https://github.com/moderation-api/sdk-ruby/commit/492eccbceb612aef715d3f9c295882c1e5bd5961))

data/README.md

@@ -1,99 +1,235 @@
 # Moderation API Ruby library
 
-The Moderation API Ruby library provides convenient access to the Moderation API from applications written in Ruby.
-
-Use the Moderation API to analyze text and images for offensive content, profanity, toxicity, discrimination, sentiment, language and more - or detect, hide, and extract data entities like emails, phone numbers, addresses and more.
+The Moderation API Ruby library provides convenient access to the Moderation API REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/moderation-api/sdk-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 ## Documentation
 
-See the [Moderation API docs](https://docs.moderationapi.com) for Ruby.
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/moderation_api).
+
+The REST API documentation can be found on [docs.moderationapi.com](https://docs.moderationapi.com).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
 
 ```ruby
-gem 'moderation_api'
+gem "moderation_api", "~> 2.0.1"
 ```
 
-And then execute:
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "moderation_api"
+
+moderation_api = ModerationAPI::Client.new(
+  secret_key: ENV["MODAPI_SECRET_KEY"] # This is the default and can be omitted
+)
+
+response = moderation_api.content.submit(content: {text: "x", type: "text"})
 
-```shell
-bundle install
+puts(response.recommendation)
 ```
 
-Or install it yourself as:
+### Handling errors
 
-```shell
-gem install moderation_api
+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 `ModerationAPI::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  content = moderation_api.content.submit(content: {text: "x", type: "text"})
+rescue ModerationAPI::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue ModerationAPI::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue ModerationAPI::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
 ```
 
-## Usage
+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.
 
-The package needs to be configured with your project's API key, which is
-available in your [Project Dashboard](https://moderationapi.com/app/projects). Configure the client with your key:
+You can use the `max_retries` option to configure or disable this:
 
 ```ruby
-require 'moderation_api'
+# Configure the default for all requests:
+moderation_api = ModerationAPI::Client.new(
+  max_retries: 0 # default is 2
+)
 
-ModerationApi.configure do |config|
-  config.access_token = 'proj_...'
-end
+# Or, configure per-request:
+moderation_api.content.submit(content: {text: "x", type: "text"}, request_options: {max_retries: 5})
+```
 
-api = ModerationApi::ModerateApi.new
+### Timeouts
 
-begin
-  analysis = api.moderation_text({value: 'Hello world!'})
-  puts analysis.flagged
-rescue ModerationApi::ApiError => e
-  puts "Error: #{e}"
-end
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+moderation_api = ModerationAPI::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+moderation_api.content.submit(content: {text: "x", type: "text"}, request_options: {timeout: 5})
 ```
 
-### Webhook signing
+On timeout, `ModerationAPI::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `ModerationAPI::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
 
-Moderation API can optionally sign the webhook events it sends to your endpoint, allowing you to validate that they were not sent by a third-party. You can read more about it [here](https://docs.moderationapi.com/review-queues/webhooks).
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
 
-Here's an example using Rails:
+Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-class WebhooksController < ApplicationController
-  skip_before_action :verify_authenticity_token
-
-  def create
-    payload = request.body.read
-    sig_header = request.env['HTTP_MODAPI_SIGNATURE']
-
-    begin
-      event_data = ModerationApi::Webhook.construct_event(
-        payload, sig_header, ENV['MODAPI_WEBHOOK_SECRET']
-      )
-    rescue JSON::ParserError => e
-      return render plain: "Invalid payload: #{e}", status: 400
-    rescue ModerationApi::Webhook::SignatureVerificationError => e
-      return render plain: "Invalid signature: #{e}", status: 400
-    end
-
-    # Handle the event
-    puts "Webhook received! #{event_data[:type]}"
-
-    head :ok
-  end
-end
+response =
+  moderation_api.content.submit(
+    content: {text: "x", type: "text"},
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(response[:my_undocumented_property])
+```
+
+#### 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 request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `ModerationAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `ModerationAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+moderation_api.content.submit(content: ModerationAPI::ContentSubmitParams::Content::Text.new(text: "x"))
 ```
 
-## Support
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+moderation_api.content.submit(content: {text: "x", type: "text"})
+
+# You can also splat a full Params class:
+params = ModerationAPI::ContentSubmitParams.new(
+  content: ModerationAPI::ContentSubmitParams::Content::Text.new(text: "x")
+)
+moderation_api.content.submit(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :trustLevel
+puts(ModerationAPI::AuthorListParams::SortBy::TRUST_LEVEL)
+
+# Revealed type: `T.all(ModerationAPI::AuthorListParams::SortBy, Symbol)`
+T.reveal_type(ModerationAPI::AuthorListParams::SortBy::TRUST_LEVEL)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+moderation_api.authors.list(
+  sort_by: ModerationAPI::AuthorListParams::SortBy::TRUST_LEVEL,
+  # …
+)
+
+# Literal values are also permissible:
+moderation_api.authors.list(
+  sort_by: :trustLevel,
+  # …
+)
+```
+
+## 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.
 
-New features and bug fixes are released on the latest major version of the `moderation_api` gem. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
 
-## Email support
+## Requirements
 
-Reach out at [support@moderationapi.com](mailto:support@moderationapi.com)
+Ruby 3.2.0 or higher.
 
-## More Information
+## Contributing
 
-- [REST API Reference](https://docs.moderationapi.com/api-reference/introduction)
-- [Rate limits](https://docs.moderationapi.com/api-reference/rate-limits)
-- [Error Handling](https://docs.moderationapi.com/api-reference/errors)
-- [Documentation](https://docs.moderationapi.com/get-started/introduction)
-- [Test your API key](https://docs.moderationapi.com/api-reference/authentication)
+See [the contributing documentation](https://github.com/moderation-api/sdk-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 Moderation API, please follow the respective company's security reporting guidelines.
+
+### Moderation API Terms and Policies
+
+Please contact support@moderationapi.com for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/moderation_api/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  class Client < ModerationAPI::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 :secret_key
+
+    # @return [ModerationAPI::Resources::Authors]
+    attr_reader :authors
+
+    # @return [ModerationAPI::Resources::Queue]
+    attr_reader :queue
+
+    # @return [ModerationAPI::Resources::Actions]
+    attr_reader :actions
+
+    # @return [ModerationAPI::Resources::Content]
+    attr_reader :content
+
+    # @return [ModerationAPI::Resources::Account]
+    attr_reader :account
+
+    # @return [ModerationAPI::Resources::Auth]
+    attr_reader :auth
+
+    # @return [ModerationAPI::Resources::Wordlist]
+    attr_reader :wordlist
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @secret_key.nil?
+
+      {"authorization" => "Bearer #{@secret_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param secret_key [String, nil] Defaults to `ENV["MODAPI_SECRET_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERATION_API_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(
+      secret_key: ENV["MODAPI_SECRET_KEY"],
+      base_url: ENV["MODERATION_API_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.moderationapi.com/v1"
+
+      if secret_key.nil?
+        raise ArgumentError.new("secret_key is required, and can be set via environ: \"MODAPI_SECRET_KEY\"")
+      end
+
+      @secret_key = secret_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
+      )
+
+      @authors = ModerationAPI::Resources::Authors.new(client: self)
+      @queue = ModerationAPI::Resources::Queue.new(client: self)
+      @actions = ModerationAPI::Resources::Actions.new(client: self)
+      @content = ModerationAPI::Resources::Content.new(client: self)
+      @account = ModerationAPI::Resources::Account.new(client: self)
+      @auth = ModerationAPI::Resources::Auth.new(client: self)
+      @wordlist = ModerationAPI::Resources::Wordlist.new(client: self)
+    end
+  end
+end