moderation_api 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b054414c274bbd8477a7eb3119f1590d1ef83474500cdfd7cd2d52ee1ff069
-  data.tar.gz: fc294ed0ba8cf33972dda43dd359a2ff25eb8bfb5bba8d3b438563411c8d3ffb
+  metadata.gz: b96c2a55f8eb106f72c0942c2baa3580e6953b62cd392b3eda65974e13e86a58
+  data.tar.gz: 898ea1fd212f0097a9a844fc2a406a942f98428cd53c8e5ac50d4a5506bc5153
 SHA512:
-  metadata.gz: 2a72621a0abbc91d8bd61c51a1afeaf0b9e64b0fda84f137ab7a1afd4aa7fc553b8dd548b921da4f9117f3b2e0150c5bdd2e72a5cbfe68c22f1b4cd29dfadc83
-  data.tar.gz: c5f8f6268af67cfb9bf208d32e34aad785a515e8d063f31d5550f47602ec4a8b711f6d8701f80905733dcc32cf580de5a878f96edb1c5336d54f1dbe5f96e61b
+  metadata.gz: 803a8cbf6499f703a2b82560583d88e0b725a607c9598bcff15b5e88f41b920feab7af7d063cb021ecac171892842e6828d56c6d07be32460a876dc0a5303cf9
+  data.tar.gz: f9d66475f7832887ec37f105be250bcf7b58220dd9735a5a664e586f238ee65a89c9c26bfe037289e6e5651c1caa97b21ffc7c9023cde3e7eb0001d211112979

data/README.md

@@ -1,15 +1,12 @@
-# moderation_api
+# Moderation API Ruby library
 
-ModerationAPI - the Ruby gem for the Moderation API
+The Moderation API Ruby library provides convenient access to the Moderation API from applications written in Ruby.
 
-API for automated content moderation
+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.
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+## Documentation
 
-- API version: 1.0.0
-- Package version: 1.2.0
-- Generator version: 7.10.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+See the [Moderation API docs](https://docs.moderationapi.com) for Ruby.
 
 ## Installation
 
@@ -31,114 +28,72 @@ Or install it yourself as:
 gem install moderation_api
 ```
 
-## Getting Started
+## Usage
 
-Please follow the [installation](#installation) procedure and then run the following code:
+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:
 
 ```ruby
-# Load the gem
 require 'moderation_api'
 
-# Setup authorization
 ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-  # Configure a proc to get access tokens in lieu of the static access_token configuration
-  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
-  # Configure faraday connection
-  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+  config.access_token = 'proj_...'
 end
 
-api_instance = ModerationAPI::AccountApi.new
+api = ModerationAPI::ModerateApi.new
 
 begin
-  #Get account details
-  result = api_instance.account_get
-  p result
+  analysis = api.moderation_text({value: 'Hello world!'})
+  puts analysis.flagged
 rescue ModerationAPI::ApiError => e
-  puts "Exception when calling AccountApi->account_get: #{e}"
+  puts "Error: #{e}"
 end
+```
+
+### Webhook signing
+
+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).
 
+Here's an example using Rails:
+
+```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
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://moderationapi.com/api/v1*
-
-| Class                            | Method                                                                               | HTTP request                         | Description         |
-| -------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------ | ------------------- |
-| _ModerationAPI::AccountApi_      | [**account_get**](docs/AccountApi.md#account_get)                                    | **GET** /account                     | Get account details |
-| _ModerationAPI::ModerateApi_     | [**moderation_audio**](docs/ModerateApi.md#moderation_audio)                         | **POST** /moderate/audio             | Analyze audio       |
-| _ModerationAPI::ModerateApi_     | [**moderation_image**](docs/ModerateApi.md#moderation_image)                         | **POST** /moderate/image             | Analyze image       |
-| _ModerationAPI::ModerateApi_     | [**moderation_object**](docs/ModerateApi.md#moderation_object)                       | **POST** /moderate/object            | Analyze object.     |
-| _ModerationAPI::ModerateApi_     | [**moderation_text**](docs/ModerateApi.md#moderation_text)                           | **POST** /moderate/text              | Analyze text.       |
-| _ModerationAPI::ModerateApi_     | [**moderation_video**](docs/ModerateApi.md#moderation_video)                         | **POST** /moderate/video             | Analyze video       |
-| _ModerationAPI::QueueActionsApi_ | [**actions_create**](docs/QueueActionsApi.md#actions_create)                         | **POST** /actions                    | Create an action    |
-| _ModerationAPI::QueueActionsApi_ | [**actions_delete**](docs/QueueActionsApi.md#actions_delete)                         | **DELETE** /actions/{id}             | Delete an action    |
-| _ModerationAPI::QueueActionsApi_ | [**actions_execute**](docs/QueueActionsApi.md#actions_execute)                       | **POST** /actions/execute            | Execute an action   |
-| _ModerationAPI::QueueActionsApi_ | [**actions_execute_deprecated**](docs/QueueActionsApi.md#actions_execute_deprecated) | **POST** /actions/{actionId}/execute | Execute an action   |
-| _ModerationAPI::QueueActionsApi_ | [**actions_get**](docs/QueueActionsApi.md#actions_get)                               | **GET** /actions/{id}                | Get an action       |
-| _ModerationAPI::QueueActionsApi_ | [**actions_list**](docs/QueueActionsApi.md#actions_list)                             | **GET** /actions                     | List actions        |
-| _ModerationAPI::QueueActionsApi_ | [**actions_update**](docs/QueueActionsApi.md#actions_update)                         | **PUT** /actions/{id}                | Update an action    |
-
-## Documentation for Models
-
-- [ModerationAPI::AccountGet200Response](docs/AccountGet200Response.md)
-- [ModerationAPI::AccountGet200ResponseCurrentProject](docs/AccountGet200ResponseCurrentProject.md)
-- [ModerationAPI::ActionsCreateRequest](docs/ActionsCreateRequest.md)
-- [ModerationAPI::ActionsCreateRequestWebhooksInner](docs/ActionsCreateRequestWebhooksInner.md)
-- [ModerationAPI::ActionsDelete200Response](docs/ActionsDelete200Response.md)
-- [ModerationAPI::ActionsExecute200Response](docs/ActionsExecute200Response.md)
-- [ModerationAPI::ActionsExecuteDeprecatedRequest](docs/ActionsExecuteDeprecatedRequest.md)
-- [ModerationAPI::ActionsExecuteRequest](docs/ActionsExecuteRequest.md)
-- [ModerationAPI::ActionsGet200Response](docs/ActionsGet200Response.md)
-- [ModerationAPI::ActionsGet200ResponseWebhooksInner](docs/ActionsGet200ResponseWebhooksInner.md)
-- [ModerationAPI::ActionsList200ResponseInner](docs/ActionsList200ResponseInner.md)
-- [ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner](docs/ActionsList200ResponseInnerPossibleValuesInner.md)
-- [ModerationAPI::ActionsList400Response](docs/ActionsList400Response.md)
-- [ModerationAPI::ActionsList400ResponseIssuesInner](docs/ActionsList400ResponseIssuesInner.md)
-- [ModerationAPI::ActionsUpdateRequest](docs/ActionsUpdateRequest.md)
-- [ModerationAPI::ModerationAudioRequest](docs/ModerationAudioRequest.md)
-- [ModerationAPI::ModerationImage200Response](docs/ModerationImage200Response.md)
-- [ModerationAPI::ModerationImage200ResponseLabelsInner](docs/ModerationImage200ResponseLabelsInner.md)
-- [ModerationAPI::ModerationImageRequest](docs/ModerationImageRequest.md)
-- [ModerationAPI::ModerationObject200Response](docs/ModerationObject200Response.md)
-- [ModerationAPI::ModerationObject200ResponseAllOfEntitiesInner](docs/ModerationObject200ResponseAllOfEntitiesInner.md)
-- [ModerationAPI::ModerationObject200ResponseAllOfFieldsInner](docs/ModerationObject200ResponseAllOfFieldsInner.md)
-- [ModerationAPI::ModerationObject200ResponseAllOfLabelsInner](docs/ModerationObject200ResponseAllOfLabelsInner.md)
-- [ModerationAPI::ModerationObjectRequest](docs/ModerationObjectRequest.md)
-- [ModerationAPI::ModerationObjectRequestValue](docs/ModerationObjectRequestValue.md)
-- [ModerationAPI::ModerationObjectRequestValueDataValue](docs/ModerationObjectRequestValueDataValue.md)
-- [ModerationAPI::ModerationText200Response](docs/ModerationText200Response.md)
-- [ModerationAPI::ModerationText200ResponseAllOfAddress](docs/ModerationText200ResponseAllOfAddress.md)
-- [ModerationAPI::ModerationText200ResponseAllOfEmail](docs/ModerationText200ResponseAllOfEmail.md)
-- [ModerationAPI::ModerationText200ResponseAllOfName](docs/ModerationText200ResponseAllOfName.md)
-- [ModerationAPI::ModerationText200ResponseAllOfNsfw](docs/ModerationText200ResponseAllOfNsfw.md)
-- [ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores](docs/ModerationText200ResponseAllOfNsfwLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfPhone](docs/ModerationText200ResponseAllOfPhone.md)
-- [ModerationAPI::ModerationText200ResponseAllOfProfanity](docs/ModerationText200ResponseAllOfProfanity.md)
-- [ModerationAPI::ModerationText200ResponseAllOfPropriety](docs/ModerationText200ResponseAllOfPropriety.md)
-- [ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores](docs/ModerationText200ResponseAllOfProprietyLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfQuality](docs/ModerationText200ResponseAllOfQuality.md)
-- [ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores](docs/ModerationText200ResponseAllOfQualityLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfRequest](docs/ModerationText200ResponseAllOfRequest.md)
-- [ModerationAPI::ModerationText200ResponseAllOfSensitive](docs/ModerationText200ResponseAllOfSensitive.md)
-- [ModerationAPI::ModerationText200ResponseAllOfSentiment](docs/ModerationText200ResponseAllOfSentiment.md)
-- [ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores](docs/ModerationText200ResponseAllOfSentimentLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfToxicity](docs/ModerationText200ResponseAllOfToxicity.md)
-- [ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores](docs/ModerationText200ResponseAllOfToxicityLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfUrl](docs/ModerationText200ResponseAllOfUrl.md)
-- [ModerationAPI::ModerationText200ResponseAllOfUsername](docs/ModerationText200ResponseAllOfUsername.md)
-- [ModerationAPI::ModerationText200ResponseAllOfWordlist](docs/ModerationText200ResponseAllOfWordlist.md)
-- [ModerationAPI::ModerationText200ResponseAllOfWordlistsInner](docs/ModerationText200ResponseAllOfWordlistsInner.md)
-- [ModerationAPI::ModerationTextRequest](docs/ModerationTextRequest.md)
-- [ModerationAPI::ModerationVideo200Response](docs/ModerationVideo200Response.md)
-- [ModerationAPI::ModerationVideoRequest](docs/ModerationVideoRequest.md)
-
-## Documentation for Authorization
-
-Authentication schemes defined for the API:
-
-### Authorization
-
-- **Type**: Bearer authentication
+## Support
+
+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.
+
+## Email support
+
+Reach out at [support@moderationapi.com](mailto:support@moderationapi.com)
+
+## More Information
+
+- [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)

data/lib/moderation_api/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.10.0
 =end
 
 module ModerationAPI
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/lib/moderation_api/webhook.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'openssl'
+
+module ModerationAPI
+  class Webhook
+    class SignatureVerificationError < StandardError; end
+
+    # This method attempts to verify the webhook signature from Moderation API.
+    #   payload: The raw request body
+    #   sig_header: The 'HTTP_MODAPI_SIGNATURE' header from the request
+    #   secret: Your webhook signing secret
+    #
+    def self.construct_event(payload, sig_header, secret)
+      # Verify the signature
+      digest = OpenSSL::Digest.new('sha256')
+      signed = OpenSSL::HMAC.hexdigest(digest, secret, payload)
+
+      if secure_compare(signed, sig_header)
+        JSON.parse(payload, symbolize_names: true)
+      else
+        raise SignatureVerificationError, 'Signature verification failed'
+      end
+    end
+
+    private
+
+    # Compares the signature in a way that mitigates timing attacks
+    #
+    def self.secure_compare(a, b)
+      return false unless a.bytesize == b.bytesize
+
+      l = a.unpack "C#{a.bytesize}"
+
+      res = 0
+      b.each_byte { |byte| res |= byte ^ l.shift }
+      res == 0
+    end
+  end
+end 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moderation_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Moderation API
@@ -201,6 +201,8 @@ files:
 - lib/moderation_api/models/moderation_video200_response.rb
 - lib/moderation_api/models/moderation_video_request.rb
 - lib/moderation_api/version.rb
+- lib/moderation_api/webhook.rb
+- moderation_api-1.2.0.gem
 - moderation_api.gemspec
 - spec/api/account_api_spec.rb
 - spec/api/moderate_api_spec.rb