sightengine-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3292075bd36340a245fe9b2f560c403b10763231e4e780b3b5ffc6642f83320
+  data.tar.gz: e1149781d1782cbb1cd3cf7dd45e3dec89c633947c1301c8ad29974d7d57253d
+SHA512:
+  metadata.gz: 58207c39ad23e78d215059437c9447dd0f8f135e935891d2205a8e1b57d9b9d4566ac68e74c5b2263cf773bc03bdeb4b2cf796b7302296125499a02c597ccf78
+  data.tar.gz: f330afdc8e11989bbb91ff4360770c75578de37d98c300cf5f380724d7beb1f24076c72ed055561965f697cd35c256f472858cf47e302d813ee0ff56b4affea0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sergey Pustovalov
+
+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,56 @@
+# SightengineRb
+
+This gem provides a convenient way to interact with the [Sightengine API](https://sightengine.com/) for content moderation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sightengine-rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sightengine-rb
+
+## Usage
+
+First, configure the client with your API user and secret. You can do this in an initializer file (e.g., `config/initializers/sightengine.rb`):
+
+```ruby
+SightengineRb.configure do |config|
+  config.api_user = 'YOUR_API_USER'
+  config.api_secret = 'YOUR_API_SECRET'
+end
+```
+
+Then, you can create a client instance:
+
+```ruby
+client = SightengineRb::Client.new
+```
+
+And make requests to the API. For example, to check an image for nudity:
+
+```ruby
+# Check a remote image
+response = client.check('nudity', image_url: 'https://example.com/image.jpg')
+
+# Check a local image
+response = client.check('nudity', file: 'path/to/image.jpg')
+```
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pustserg/sightengine_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pustserg/sightengine_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/sightengine-rb/client/base_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module SightengineRb
+  class Client
+    class BaseRequest
+      include HTTParty
+      base_uri "https://api.sightengine.com/1.0"
+
+      def initialize(api_user, api_secret)
+        @api_user = api_user
+        @api_secret = api_secret
+      end
+
+      def post(path, params = {})
+        if params[:file]
+          params[:media] = params.delete(:file)
+          self.class.post(path, body: params.merge(api_user: @api_user, api_secret: @api_secret))
+        else
+          self.class.post(path, query: params.merge(api_user: @api_user, api_secret: @api_secret))
+        end
+      end
+    end
+  end
+end

data/lib/sightengine-rb/client/check_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SightengineRb
+  class Client
+    class CheckRequest < BaseRequest
+      def post(models, image_url: nil, file: nil)
+        params = { models: models }
+        params[:url] = image_url if image_url
+        params[:file] = File.open(file) if file
+
+        super("/check.json", params)
+      end
+    end
+  end
+end

data/lib/sightengine-rb/client/set_celebrity_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SightengineRb
+  class Client
+    class SetCelebrityRequest < BaseRequest
+      def post(celebrity_id, image_url: nil, file: nil)
+        params = { id: celebrity_id }
+        params[:url] = image_url if image_url
+        params[:file] = File.open(file) if file
+
+        super("/celebrities.json", params)
+      end
+    end
+  end
+end

data/lib/sightengine-rb/client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "client/base_request"
+require_relative "client/check_request"
+require_relative "client/set_celebrity_request"
+
+module SightengineRb
+  class Client
+    attr_reader :api_user, :api_secret
+
+    def initialize
+      @api_user = SightengineRb.config.api_user
+      @api_secret = SightengineRb.config.api_secret
+    end
+
+    def check(models, image_url: nil, file: nil)
+      CheckRequest.new(api_user, api_secret).post(models, image_url: image_url, file: file)
+    end
+
+    def set_celebrity(celebrity_id, image_url: nil, file: nil)
+      SetCelebrityRequest.new(api_user, api_secret).post(celebrity_id, image_url: image_url, file: file)
+    end
+  end
+end

data/lib/sightengine-rb/config.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "anyway_config"
+
+module SightengineRb
+  class Config < Anyway::Config
+    config_name :sightengine
+    attr_config :api_user, :api_secret
+  end
+end

data/lib/sightengine-rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SightengineRb
+  VERSION = "0.1.0"
+end

data/lib/sightengine-rb.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "sightengine-rb/version"
+require_relative "sightengine-rb/client"
+require_relative "sightengine-rb/config"
+
+module SightengineRb
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+  class Error < StandardError; end
+end

data/sig/sightengine_ruby.rbs

@@ -0,0 +1,4 @@
+module SightengineRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sightengine-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Pustovalov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: This gem provides a convenient way to interact with the Sightengine API
+  for content moderation.
+email:
+- sergey@pustovalov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sightengine-rb.rb
+- lib/sightengine-rb/client.rb
+- lib/sightengine-rb/client/base_request.rb
+- lib/sightengine-rb/client/check_request.rb
+- lib/sightengine-rb/client/set_celebrity_request.rb
+- lib/sightengine-rb/config.rb
+- lib/sightengine-rb/version.rb
+- sig/sightengine_ruby.rbs
+homepage: https://github.com/pustserg/sightengine_ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pustserg/sightengine_ruby
+  source_code_uri: https://github.com/pustserg/sightengine_ruby
+  changelog_uri: https://github.com/pustserg/sightengine_ruby/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Ruby wrapper for the Sightengine API.
+test_files: []