rubysightengine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 708021926ab3de966aafefff79704209a9f849fd57253c9e88e14487b59b4cc3
+  data.tar.gz: bb11400f404695329622743e7d08d3fd5739bc3f57485af572ea36c0aef79291
+SHA512:
+  metadata.gz: fcd20c98b8b32be1bfad99258be71799ce9241dc045626968d19e9aa32a5084d31a2bd715536c41ac8b2f74aa8dd705a05aa25e763bf32c9d3252c01659d90d2
+  data.tar.gz: 8129869074aecd4bb8cd2370cfb40f51e08863d82b5c9d534ddff7e9aa93992f1d5338f3d0053d8886a86c56c1773e8a5e55ff64215c29f65164906f660179fd

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    rubysightengine (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubysightengine!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 k1tsu
+
+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,66 @@
+# Rubysightengine
+
+An easy to use sightengine wrapper for ruby. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubysightengine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubysightengine
+
+## Usage
+
+### General 
+
+A SightEngine class is provided which will give access to the method `check`. Once the data has been receieved from SightEngine, a new `Checked` object will be created. 
+There are five different `Checked` methods used to get the data from the request, all are below, discluding the method `.raw` which will give the request's body. The minimum testing value is defaulted at `0.9`.
+
+### Workflows 
+
+`.set_workflow(...)` can be used to set the current workflow, or it can be set as an argument when creating a new SightEngine object. These are completely optional and are manipulated in the SightEngine interface.
+
+```ruby 
+s = SightEngine.new(api_user, api_secret, optional_workflow)
+
+s.set_workflow(new_workflow) # Optional 
+
+b = s.check (
+    "https://images.unsplash.com/photo-1533227268428-f9ed0900fb3b?ixid=MXwxMjA3fDB8MHxzZWFyY2h8MXx8aGFwcHklMjBtYW58ZW58MHx8MHw%3D&ixlib=rb-1.2.1&w=1000&q=80", 
+    'nudity', 
+    'offensive'
+)
+
+b.set_min(0.5) # Optional 
+
+b.safe? # => {"nudity"=>true}
+
+b.has? 'nudity', 'offensive' # => {"nudity"=>false, "offensive"=>false}
+
+b.stat_hash 'offensive', 'nudity' # => [{"prob"=>0.117, "boxes"=>[{"x1"=>0.29997, "y1"=>0.49264, "x2"=>0.39483, "y2"=>0.6242, "label"=>"middlefinger", "prob"=>0.117}, {"x1"=>0.61118, "y1"=>0.43277, "x2"=>0.70978, "y2"=>0.56579, "label"=>"middlefinger", "prob"=>0.052}]}, {"raw"=>0.01, "partial"=>0.01}]
+
+b.boxes # => [{"x1"=>0.29997, "y1"=>0.49264, "x2"=>0.39483, "y2"=>0.6242, "label"=>"middlefinger", "prob"=>0.117}]
+```
+
+## 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/[USERNAME]/rubysightengine.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/README.rdoc

@@ -0,0 +1,24 @@
+## rubysightengine 
+#### An easy to use sightengine SDK for ruby. 
+
+## Installation 
+
+## 
+```ruby 
+s = SightEngine.new(api_user, api_secret, optional_workflow)
+s.set_workflow(new_workflow)
+
+b = s.check (
+    "https://images.unsplash.com/photo-1533227268428-f9ed0900fb3b?ixid=MXwxMjA3fDB8MHxzZWFyY2h8MXx8aGFwcHklMjBtYW58ZW58MHx8MHw%3D&ixlib=rb-1.2.1&w=1000&q=80", 
+    'nudity', 
+    'offensive'
+)
+
+b.safe? # => {"nudity"=>true}
+
+b.has? 'nudity', 'offensive' # => {"nudity"=>false, "offensive"=>false}
+
+b.stat_hash 'offensive', 'nudity' # => [{"prob"=>0.117, "boxes"=>[{"x1"=>0.29997, "y1"=>0.49264, "x2"=>0.39483, "y2"=>0.6242, "label"=>"middlefinger", "prob"=>0.117}, {"x1"=>0.61118, "y1"=>0.43277, "x2"=>0.70978, "y2"=>0.56579, "label"=>"middlefinger", "prob"=>0.052}]}, {"raw"=>0.01, "partial"=>0.01}]
+
+b.boxes # => [{"x1"=>0.29997, "y1"=>0.49264, "x2"=>0.39483, "y2"=>0.6242, "label"=>"middlefinger", "prob"=>0.117}]
+```

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 "rubysightengine"
+
+# 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/rubysightengine.rb

@@ -0,0 +1,16 @@
+require "rubysightengine/version"
+require_relative "rubysightengine/client"
+
+module SightEngine
+  class Error < StandardError; end
+  class << self
+
+    def new(a, b, c=nil)
+
+      return SightEngineE.new(a, b, c)
+
+    end 
+
+  end 
+
+end

data/lib/rubysightengine/checked.rb

@@ -0,0 +1,127 @@
+require "json"
+
+# The Checked class, used for handling responses.
+class Checked  
+
+    # Creates a new Checked object.
+    # @param data [String] the data from the request.
+    # @param min [Float] the minimum score from the content filter that will pass.
+    def initialize(data, min=0.9)
+
+        @raw = JSON.parse(data)
+        @min = min 
+        @type = @raw.keys.delete_if {|h| ["status", "media", "request"].include? h}
+        
+    end 
+
+    # Changes the testing value minimum content is compared against. 
+    # @param min [Float] the minimum score.
+    def set_min(min)
+
+        @min = min 
+
+    end 
+
+    # Returns the raw JSON parsed data
+    # @return [Hash] 
+    def raw
+
+        @raw
+
+    end 
+
+    # Returns the statistic hash of each given type.
+    # @param type [string] the types of content filters.
+    # @return [Array]
+    def stat_hash(*type)
+
+        if type === []
+            type = @type 
+        end 
+
+        return type.map {|t| @raw[t]}
+
+    end 
+
+    # Returns all box coordinates from location based filters.
+    # @return [Array]
+    def boxes 
+
+        all_boxes = []
+        @raw.each do |h|
+
+            if ["status", "media", "request"].include?(h[0]) == false && h[1]['boxes'] != nil 
+                all_boxes << h[1]['boxes'][0]   
+            end  
+        end 
+        return all_boxes
+    end 
+
+    # Checks if response has filter type. You can include multiple types. 
+    # @param type [string] the types of content filters. 
+      def has?(*type)
+
+        if type === []
+            type = @type
+        end
+
+        checker = {}
+
+        type.each do |t|
+
+            if @raw.keys.include? t 
+
+                avg = 0 
+                current = @raw[t]
+
+                current.keys.each do |stat|
+            
+                    misc = nil 
+
+                    if stat != "safe" and stat != "boxes"
+
+                        avg += current[stat] 
+                        
+                    end 
+
+                end 
+              
+                if (avg/current.delete_if {|x| x === "safe"}.count) <= @min
+                    checker[t] = false 
+                else
+                    checker[t] = true
+                end 
+
+            else 
+
+                raise "sightengine category '#{t}' not found, check spelling?"
+
+            end
+
+        end 
+
+        checker
+        # @return [Array] 
+
+    end 
+
+    #Checks if image has 'safe' key and compares it to minimum score.
+    # @param type [string] the types of content filters.
+    # @return [Array]  
+    def safe?(*type)
+
+        if type === []
+            type = @type 
+        end 
+
+        type.delete_if {|t| @raw[t]['safe'] === nil}
+        type.map {|t| [t, (@raw[t]['safe'] >= @min)]}.to_h
+
+    end 
+
+end 
+
+
+
+
+

data/lib/rubysightengine/client.rb

@@ -0,0 +1,83 @@
+require 'net/http'
+require_relative "checked.rb"
+
+ 
+# The sightengine class.
+class SightEngineE
+
+    # The sightengine endpoint.
+    BASE_URL = "https://api.sightengine.com/1.0/check.json"
+
+    # The valid categories that sightengine api takes.
+    VALID_CATEGORIES = [
+        "nudity", 
+        "wad", 
+        "properties", 
+        "celebrities", 
+        "offensive", 
+        "faces", 
+        "scam", 
+        "text-content", 
+        "face-attributes", 
+        "text"
+    ] 
+
+    # Creates a new sightengine object with credentials and an optional workflow.
+
+    # @param [String] api_user the api_user credential provided by sightengine. 
+    # @param api_secret [String] the api_secret credential provided by sightengine. 
+    # @param worklfow [String] the workflow you have created in the sightengine interface, this is optional. 
+    def initialize(api_user, api_secret, workflow=nil)
+
+        @api_user = api_user
+        @api_secret = api_secret
+        @workflow = nil 
+        @min = 0.9     
+
+    end
+
+    # Sets the workflow for the class.
+    # @param workflow [String] the target workflow to set as the class workflow.
+    def set_workflow(workflow)
+
+        @workflow = workflow
+
+    end 
+    
+    # Checks a image for any content by making an HTTP request to the sightengine servers.
+    # @param target_url [String] the url of the target image.
+    # @param type [String] the type of content to be scanned for. 
+    def check(target_url, *type)
+
+ 
+        if type.any? {|t| VALID_CATEGORIES.include?(t) === false}
+
+            raise "while checking, one or more of your sightengine types were not found"
+
+        end
+
+        uri = URI("https://api.sightengine.com/1.0/check.json")
+
+        form_h = {api_user: @api_user, api_secret: @api_secret, url: target_url} 
+        form_h[:workflow] = @workflow if @workflow != nil
+        form_h[:models] = type.join(",")
+        uri.query = URI.encode_www_form(form_h)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == 'https')
+
+        request = Net::HTTP::Get.new(uri)
+        request.body = ""
+        request.add_field 'Accept', 'application/json'
+        response = http.request(request)
+
+        if response.is_a?(Net::HTTPSuccess) === false 
+            raise "sightengine server gave a #{response.code} error: #{response.msg}"
+        end 
+
+        # @return [Checked] if request is 200 
+        return Checked.new(response.body)
+
+    end
+
+end 

data/lib/rubysightengine/version.rb

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

data/rubysightengine.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubysightengine/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysightengine"
+  spec.version       = Rubysightengine::VERSION
+  spec.authors       = ["k1tsu"]
+  spec.email         = ["k1tsu@github.com"]
+
+  spec.summary       = "An easy to use sightengine wrapper for ruby." 
+  spec.homepage      = "https://github.com/k1tsu/rubysightengine"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rubysightengine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- k1tsu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 
+email:
+- k1tsu@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubysightengine.rb
+- lib/rubysightengine/checked.rb
+- lib/rubysightengine/client.rb
+- lib/rubysightengine/version.rb
+- rubysightengine.gemspec
+homepage: https://github.com/k1tsu/rubysightengine
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An easy to use sightengine wrapper for ruby.
+test_files: []