sightengine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c52700aefc81d507cf3a25c3f9b91bc5c25d472a
+  data.tar.gz: 1cb342bed62b587449689fe30ecf49e63217dc4b
+SHA512:
+  metadata.gz: dad55c114ea0dccda19f61b7a54d3146212ab76ae84e53030360ef8550531f4e0a57c3d9f614cd210bae458b7335ca71daccac4355dccd8befa2ac6fcd781a0e
+  data.tar.gz: fa8a5a1c13ed05b52445ef52421307f6c8bdcca2b4d12335c7be01839daad6fae2ac5ac4e5c16af71e91cee1d08e732039637c688b8f0de6da458243014c0206

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sightengine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Léonard Hetsch <leo.hetsch@gmail.com>
+
+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,85 @@
+# Sightengine
+
+Unofficial wrapper for the [Sightengine](https://sightengine.com/) API
+which provides image moderation including nudity detection, scammer detection,
+face attributes, and more.
+
+Official API docs can be found here: https://sightengine.com/docs/reference
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sightengine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sightengine
+
+## Usage
+
+### Configuration
+
+```ruby
+require 'sightengine'
+
+client = Sightengine::Client.new(
+  api_user: 'your api user',
+  api_secret: 'your api secret'
+)
+
+```
+
+### Nudity check
+
+```ruby
+response = client.nudity("https://sightengine.com/assets/img/examples/example2.jpg")
+
+response.raw_nudity? # false
+response.partial_nudity? # false
+response.safe? # true
+```
+
+### Face attributes
+
+```ruby
+response = client.face_attributes("https://sightengine.com/assets/img/examples/example7.jpg")
+
+response.faces.length # 1
+face = response.faces.first
+
+face.female? # true
+face.male? # true
+face.minor? # false
+face.coordinates # [x1, y1, x2, y2] = [0.5156, 0.1936, 0.6922, 0.6207]
+```
+
+### Scam detection
+
+```ruby
+response = client.scam("https://d3m9459r9kwism.cloudfront.net/img/examples/example-scam1-1000.jpg")
+
+response.scam? # true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/leoht/sightengine.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sightengine"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sightengine.rb

@@ -0,0 +1,6 @@
+require "sightengine/version"
+require "sightengine/connection"
+require "sightengine/client"
+
+module Sightengine
+end

data/lib/sightengine/api/base.rb

@@ -0,0 +1,19 @@
+module Sightengine
+  module Api
+    module Base
+      def check(image_url, models = [])
+        do_check(image_url, models)
+      end
+
+      private
+
+        def do_check(image_url, models)
+          connection.get build_uri('check.json') do |req|
+            req.headers[:content_type] = 'application/json'
+            req.params = default_params.merge({ url: image_url, models: models.join(",") })
+            p req.params.inspect
+          end.body
+        end
+    end
+  end
+end

data/lib/sightengine/api/face_attributes.rb

@@ -0,0 +1,51 @@
+module Sightengine
+  module Api
+    module FaceAttributes
+      class Face
+        attr_accessor :x1, :y1, :x2, :y2
+        attr_accessor :features
+        attr_accessor :attributes
+
+        def initialize(hash)
+          hash.each do |k, v|
+            send("#{k}=", v)
+          end
+        end
+
+        def coordinates
+          [x1, y1, x2, y2]
+        end
+
+        def female?(min_prob = 0.8)
+          attributes["female"].to_f > min_prob
+        end
+
+        def male?(min_prob = 0.8)
+          attributes["male"].to_f > min_prob
+        end
+
+        def minor?(min_prob = 0.8)
+          attributes["minor"].to_f > min_prob
+        end
+
+        def sunglasses?(min_prob = 0.8)
+          attributes["minor"].to_f > min_prob
+        end
+      end
+
+      class Response < ::Sightengine::Api::Response
+        attr_accessor :faces
+        
+        def faces
+          (self.instance_variable_get("@faces") || []).map do |face|
+            Face.new(face)
+          end
+        end
+      end
+
+      def face_attributes(image_url)
+        Response.new(do_check(image_url, ["face-attributes"]))
+      end
+    end
+  end
+end

data/lib/sightengine/api/nudity.rb

@@ -0,0 +1,25 @@
+module Sightengine
+  module Api
+    module Nudity
+      class Response < Sightengine::Api::Response
+        attr_accessor :nudity
+
+        def raw_nudity?(min_prob = 0.9)
+          nudity["raw"].to_f >= min_prob.to_f
+        end
+
+        def partial_nudity?(min_prob = 0.9)
+          nudity["partial"].to_f >= min_prob.to_f
+        end
+
+        def safe?(min_prob = 0.9)
+          nudity["safe"].to_f >= min_prob.to_f
+        end
+      end
+
+      def nudity(image_url)
+        Response.new(do_check(image_url, ["nudity"]))
+      end
+    end
+  end
+end

data/lib/sightengine/api/response.rb

@@ -0,0 +1,13 @@
+module Sightengine
+  module Api
+    class Response
+      attr_accessor :status, :request, :media, :error
+
+      def initialize(hash)
+        hash.each do |k, v|
+          send("#{k}=", v) if methods.include?("#{k}=".to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/sightengine/api/scam.rb

@@ -0,0 +1,17 @@
+module Sightengine
+  module Api
+    module Scam
+      class Response < ::Sightengine::Api::Response
+        attr_accessor :faces, :scam
+        
+        def scam?(min_prob = 0.8)
+          scam["prob"].to_f > min_prob
+        end
+      end
+
+      def scam(image_url)
+        Response.new(do_check(image_url, ["scam"]))
+      end
+    end
+  end
+end

data/lib/sightengine/api/wad.rb

@@ -0,0 +1,25 @@
+module Sightengine
+  module Api
+    module Wad
+      class Response < ::Sightengine::Api::Response
+        attr_accessor :weapon, :drugs, :alcohol
+        
+        def weapon?(min_prob = 0.8)
+          weapon.to_f > min_prob
+        end
+
+        def alcohol?(min_prob = 0.8)
+          alcohol.to_f > min_prob
+        end
+
+        def drugs?(min_prob = 0.8)
+          drugs.to_f > min_prob
+        end
+      end
+
+      def wad(image_url)
+        Response.new(do_check(image_url, ["wad"]))
+      end
+    end
+  end
+end

data/lib/sightengine/client.rb

@@ -0,0 +1,45 @@
+require "sightengine/api/response"
+require "sightengine/api/base"
+require "sightengine/api/nudity"
+require "sightengine/api/wad"
+require "sightengine/api/face_attributes"
+require "sightengine/api/scam"
+
+module Sightengine
+  class Client
+    include Sightengine::Connection
+    include Sightengine::Api::Base
+    include Sightengine::Api::Nudity
+    include Sightengine::Api::Wad
+    include Sightengine::Api::FaceAttributes
+    include Sightengine::Api::Scam
+
+    BASE_URI = 'https://api.sightengine.com'.freeze
+
+    VALID_OPTIONS = [
+      :api_user,
+      :api_secret,
+      :api_version
+    ].freeze
+
+    attr_accessor *VALID_OPTIONS
+
+    def initialize(**options)
+      options.merge(default_options).each do |opt, value|
+        send("#{opt}=", value)
+      end
+    end
+
+    def build_uri(path, **params)
+      "#{BASE_URI}/#{self.api_version}/#{path}"
+    end
+
+    def default_params
+      { api_user: self.api_user, api_secret: self.api_secret }
+    end
+
+    def default_options
+      { api_version: '1.0' }
+    end
+  end
+end

data/lib/sightengine/connection.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Sightengine
+  module Connection
+    def connection
+      Faraday::Connection.new({
+        headers: {'Content-Type' => 'application/json'}
+      }) do |conn|
+        conn.use Faraday::Request::UrlEncoded
+        conn.use FaradayMiddleware::ParseJson
+        conn.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/sightengine/version.rb

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

data/sightengine.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sightengine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sightengine"
+  spec.version       = Sightengine::VERSION
+  spec.authors       = ["Léonard Hetsch"]
+  spec.email         = ["leo.hetsch@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for the Sightengine image moderation API}
+  spec.description   = %q{Unofficial wrapper for the Sightengine API which provides image moderation including nudity detection, scammer detection, face attributes, and more.}
+  spec.homepage      = "https://github.com/leoht/sightengine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_runtime_dependency "faraday", "~> 0.12"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.11"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: sightengine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Léonard Hetsch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Unofficial wrapper for the Sightengine API which provides image moderation
+  including nudity detection, scammer detection, face attributes, and more.
+email:
+- leo.hetsch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sightengine.rb
+- lib/sightengine/api/base.rb
+- lib/sightengine/api/face_attributes.rb
+- lib/sightengine/api/nudity.rb
+- lib/sightengine/api/response.rb
+- lib/sightengine/api/scam.rb
+- lib/sightengine/api/wad.rb
+- lib/sightengine/client.rb
+- lib/sightengine/connection.rb
+- lib/sightengine/version.rb
+- sightengine.gemspec
+homepage: https://github.com/leoht/sightengine
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Sightengine image moderation API
+test_files: []