sightengine 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c52700aefc81d507cf3a25c3f9b91bc5c25d472a
-  data.tar.gz: 1cb342bed62b587449689fe30ecf49e63217dc4b
+  metadata.gz: 828d67cc2cf495058fcda68d876bcdaf24bc2880
+  data.tar.gz: 4f8434aa1b2402154e88a9672c237ad874f9ac46
 SHA512:
-  metadata.gz: dad55c114ea0dccda19f61b7a54d3146212ab76ae84e53030360ef8550531f4e0a57c3d9f614cd210bae458b7335ca71daccac4355dccd8befa2ac6fcd781a0e
-  data.tar.gz: fa8a5a1c13ed05b52445ef52421307f6c8bdcca2b4d12335c7be01839daad6fae2ac5ac4e5c16af71e91cee1d08e732039637c688b8f0de6da458243014c0206
+  metadata.gz: 4ef556ebf8ec0c00cf65f1ad3b384bf34cc2cb48bdfd8c9c4843c30648afbb624e4a40ff49e914f49acde46ad064dd104ac404ca6358db112a1a863ddd266cbe
+  data.tar.gz: d8bee6aad4af2e5d97077f45421ee212281aba58b0e114bb7c71c390cd180572d9b537684d4da878f688c1b3978531208b240f40fd9731cc5b7416b1466ab8ad

data/README.md

@@ -68,6 +68,30 @@ response = client.scam("https://d3m9459r9kwism.cloudfront.net/img/examples/examp
 response.scam? # true
 ```
 
+### Celebrities detection
+
+```ruby
+response = client.celebrities("https://sightengine.com/assets/img/examples/example-craig-300.jpg")
+
+response.celebrity? # true
+response.celebrities # [{"name"=>"Daniel Craig", "prob"=>0.99}, {"name"=>"Graham Fellows", "prob"=>0.08}, ...]
+```
+
+### Multi-models check
+
+```ruby
+# Detect nudity, scammers and celebrities in picture
+response = client.check("https://d3m9459r9kwism.cloudfront.net/img/examples/example-scam1-1000.jpg", [
+    Sightengine::NUDITY,
+    Sightengine::SCAM,
+    Sightengine::CELEBRITIES
+])
+
+response.raw_nudity? # false
+response.scam? # true
+response.celebrity? # false
+```
+
 ## 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.

data/lib/sightengine.rb

@@ -3,4 +3,10 @@ require "sightengine/connection"
 require "sightengine/client"
 
 module Sightengine
+  NUDITY = "nudity"
+  WAD = "wad"
+  SCAM = "scam"
+  CELEBRITIES = "celebrities"
+  FACE_ATTRIBUTES = "face-attributes"
+  FACE = "face"
 end

data/lib/sightengine/api/base.rb

@@ -2,7 +2,7 @@ module Sightengine
   module Api
     module Base
       def check(image_url, models = [])
-        do_check(image_url, models)
+        Sightengine::Api::Response.new(do_check(image_url, models))
       end
 
       private
@@ -11,7 +11,6 @@ module Sightengine
           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

data/lib/sightengine/api/celebrity.rb

@@ -0,0 +1,9 @@
+module Sightengine
+  module Api
+    module Celebrity
+      def celebrities(image_url)
+        Sightengine::Api::Response.new(do_check(image_url, ["celebrities"]))
+      end
+    end
+  end
+end

data/lib/sightengine/api/face_attributes.rb

@@ -5,6 +5,7 @@ module Sightengine
         attr_accessor :x1, :y1, :x2, :y2
         attr_accessor :features
         attr_accessor :attributes
+        attr_accessor :celebrity
 
         def initialize(hash)
           hash.each do |k, v|
@@ -33,18 +34,8 @@ module Sightengine
         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"]))
+        Sightengine::Api::Response.new(do_check(image_url, ["face-attributes"]))
       end
     end
   end

data/lib/sightengine/api/nudity.rb

@@ -1,24 +1,8 @@
 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"]))
+        Sightengine::Api::Response.new(do_check(image_url, ["nudity"]))
       end
     end
   end

data/lib/sightengine/api/response.rb

@@ -1,6 +1,18 @@
+require "sightengine/api/responses/nudity"
+require "sightengine/api/responses/wad"
+require "sightengine/api/responses/scam"
+require "sightengine/api/responses/face_attributes"
+require "sightengine/api/responses/celebrity"
+
 module Sightengine
   module Api
     class Response
+      include Sightengine::Api::Responses::Nudity
+      include Sightengine::Api::Responses::Wad
+      include Sightengine::Api::Responses::Scam
+      include Sightengine::Api::Responses::FaceAttributes
+      include Sightengine::Api::Responses::Celebrity
+
       attr_accessor :status, :request, :media, :error
 
       def initialize(hash)

data/lib/sightengine/api/responses/celebrity.rb

@@ -0,0 +1,21 @@
+module Sightengine
+  module Api
+    module Responses
+      module Celebrity
+        def celebrities
+          faces.map { |face|
+            face["celebrity"] || []
+          }.flatten
+        end
+
+        def celebrity?(min_prob = 0.95)
+          self.faces.any? { |face|
+            face["celebrity"].any? { |c|
+              c["prob"] >= min_prob
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sightengine/api/responses/face_attributes.rb

@@ -0,0 +1,19 @@
+module Sightengine
+  module Api
+    module Responses
+      module FaceAttributes
+        def self.included(base)
+          base.class_eval do
+            attr_accessor :faces
+          end
+        end
+
+        def faces
+          (self.instance_variable_get("@faces") || []).map do |face|
+            Sightengine::Api::FaceAttributes::Face.new(face)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sightengine/api/responses/nudity.rb

@@ -0,0 +1,25 @@
+module Sightengine
+  module Api
+    module Responses
+      module Nudity
+        def self.included(base)
+          base.class_eval do
+            attr_accessor :nudity
+          end
+        end
+
+        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
+    end
+  end
+end

data/lib/sightengine/api/responses/scam.rb

@@ -0,0 +1,17 @@
+module Sightengine
+  module Api
+    module Responses
+      module Scam
+        def self.included(base)
+          base.class_eval do
+            attr_accessor :faces, :scam
+          end
+        end
+
+        def scam?(min_prob = 0.8)
+          scam["prob"].to_f > min_prob
+        end
+      end
+    end
+  end
+end

data/lib/sightengine/api/responses/wad.rb

@@ -0,0 +1,25 @@
+module Sightengine
+  module Api
+    module Responses
+      module Wad
+        def self.included(base)
+          base.class_eval do
+            attr_accessor :weapon, :drugs, :alcohol
+          end
+        end
+
+        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
+    end
+  end
+end

data/lib/sightengine/api/scam.rb

@@ -1,16 +1,8 @@
 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"]))
+        Sightengine::Api::Response.new(do_check(image_url, ["scam"]))
       end
     end
   end

data/lib/sightengine/api/wad.rb

@@ -1,24 +1,8 @@
 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"]))
+        Sightengine::Api::Response.new(do_check(image_url, ["wad"]))
       end
     end
   end

data/lib/sightengine/client.rb

@@ -4,6 +4,7 @@ require "sightengine/api/nudity"
 require "sightengine/api/wad"
 require "sightengine/api/face_attributes"
 require "sightengine/api/scam"
+require "sightengine/api/celebrity"
 
 module Sightengine
   class Client
@@ -13,6 +14,7 @@ module Sightengine
     include Sightengine::Api::Wad
     include Sightengine::Api::FaceAttributes
     include Sightengine::Api::Scam
+    include Sightengine::Api::Celebrity
 
     BASE_URI = 'https://api.sightengine.com'.freeze
 

data/lib/sightengine/version.rb

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

data/sightengine.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sightengine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Léonard Hetsch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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:
@@ -99,9 +113,16 @@ files:
 - bin/setup
 - lib/sightengine.rb
 - lib/sightengine/api/base.rb
+- lib/sightengine/api/celebrity.rb
 - lib/sightengine/api/face_attributes.rb
+- lib/sightengine/api/feedback.rb
 - lib/sightengine/api/nudity.rb
 - lib/sightengine/api/response.rb
+- lib/sightengine/api/responses/celebrity.rb
+- lib/sightengine/api/responses/face_attributes.rb
+- lib/sightengine/api/responses/nudity.rb
+- lib/sightengine/api/responses/scam.rb
+- lib/sightengine/api/responses/wad.rb
 - lib/sightengine/api/scam.rb
 - lib/sightengine/api/wad.rb
 - lib/sightengine/client.rb