yandex_image_moderation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02bdb7bdb855be5fd3a7e4cfe30510dff3e6cdd2
+  data.tar.gz: 389cc34648ed382ba58134c74230922725d2bd8c
+SHA512:
+  metadata.gz: 421ce9d15b0acdd26f0ff6068a2cda7b69d7a043dd93dc3d7dfaf2cb4d9790b082a8d079a305132cabacd1830572697911f06c7725b009308a8698f2fa2bdb58
+  data.tar.gz: b631b6ad51c9e12579fdc1dae177baf48b55b418bd143d36a1381cd57a43dacca8cc0b61e0f93e916c4f163bfff525081b9e03c97549be76e4f4536f6db691fd

data/.gitignore

@@ -0,0 +1,10 @@
+.idea/*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+branches:
+  only:
+    - master
+script:
+  - rake
+rvm:
+  - 2.0.0-p648
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'multipart-post'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sergey Tsvetkov (stsvetkov@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,63 @@
+# YandexImageModeration
+
+This gem provides a class for access to Yandex Image Moderation API
+(https://imagemoderation.yandexdatafactory.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yandex_image_moderation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yandex_image_moderation
+
+## Configuration
+
+For Yandex API access you have to provide an API key. Do it by calling config method of the YandexImageModeration class:
+
+```ruby
+YandexImageModeration.config do |c|
+  c.token = 'your_API_key'
+end
+```
+
+If you use Rails, this configuration would probably go into a proper initializer.
+
+In some cases you may need to change URL of the API (i.e. when you use not the SAAS API, but a docker version on your own server).
+To override the standard URL just add url attribute to the config. In the URL provide the path to the *moderate* service, do not add any parameters like *?model=moderate...*
+
+```ruby
+YandexImageModeration.config do |c|
+  c.url = 'http://your_server/path_to/moderate'
+  c.token = 'your_API_key'
+end
+```
+
+## Usage
+
+To moderate an image (remember: Yandex API works with JPEG only) just call a *moderate* methods with a path to the image file as a parameter:
+
+```ruby
+result = YandexImageModeration.moderate('/var/www/uploads/test.jpg')
+puts result
+
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tgrave/yandex_image_moderation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Build Status [![Build Status](https://secure.travis-ci.org/tgrave/yandex_image_moderation.png?branch=master)](http://travis-ci.org/tgrave/yandex_image_moderation)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb', 'test/**/test_*.rb']
+  t.verbose = true
+end
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/lib/yandex_image_moderation/config.rb

@@ -0,0 +1,29 @@
+# Configuration of our class
+module YandexImageModeration
+  class << self
+    # Configure it
+    #
+    # @yieldparam [OpenStruct] an object on which to set configuration
+    #   options
+    #
+    # @return [OpenStruct] options
+    def config
+      @options ||= OptionSetter.new
+      yield(@options.config) if block_given?
+      @options.config
+    end
+
+    # Responsible for collecting options in the DSL and creating
+    # lookup objects using those options.
+    class OptionSetter
+      attr_accessor :config
+
+      def initialize
+        @config = OpenStruct.new
+        @config.url = 'https://cv-albion.ydf.yandex.net/moderate'.freeze
+      end
+    end
+
+    private_constant :OptionSetter
+  end
+end

data/lib/yandex_image_moderation/error.rb

@@ -0,0 +1,20 @@
+module YandexImageModeration
+  # Error messages that can be raised by this gem. To catch any
+  # related error message, use Error::Base.
+  #
+  #   begin
+  #     ...
+  #   rescue YandexImageModeration::Error::Base => e
+  #     puts "YandexImageModeration Error: #{e.message}"
+  #   end
+  module Error
+    # Top-level error. All other timezone errors subclass this one.
+    class Base < StandardError; end
+    # Indicates an invalid result received from the server.
+    class InvalidResult < Base; end
+    # Indicates a request failure.
+    class Moderate < Base; end
+    # Indicates an invalid configuration.
+    class InvalidConfig < Base; end
+  end
+end

data/lib/yandex_image_moderation/http_client.rb

@@ -0,0 +1,32 @@
+require 'uri'
+require 'net/http'
+require 'net/http/post/multipart'
+
+# YandexImageModeration module part for HTTP Client
+module YandexImageModeration
+  # @!visibility private
+  # A basic HTTP Client that handles requests to Yandex.
+  #
+  class NetHTTPClient
+    def initialize(config)
+      uri = parse_url config
+      @http = Net::HTTP.new(uri.host, uri.port)
+      @http.open_timeout = config.open_timeout || 10
+      @http.read_timeout = config.read_timeout || 30
+      @http.use_ssl = !(config.url =~ /^https/i).nil?
+    end
+
+    def post(url, body, headers)
+      request = Net::HTTP::Post::Multipart.new(url, body)
+      headers.each { |k, v| request[k.to_s] = v } unless headers.nil? || !headers.is_a?(Hash)
+      @http.request(request)
+    end
+
+    protected
+
+    def parse_url(config)
+      raise(::YandexImageModeration::Error::InvalidConfig, 'missing url') if config.url.to_s.empty?
+      URI.parse(config.url)
+    end
+  end
+end

data/lib/yandex_image_moderation/result.rb

@@ -0,0 +1,63 @@
+require 'yandex_image_moderation/error'
+
+# YandexImageModeration module part for HTTP Client
+module YandexImageModeration
+  # @!visibility public
+  # Moderation result with some useful methods
+  #
+  class Result
+    attr_reader :data
+    attr_reader :result
+
+    def initialize(data)
+      raise(::YandexImageModeration::Error::InvalidResult, 'no result data') if data.nil?
+      @data = data
+      parse_data
+    end
+
+    def good?
+      @status.to_s == 'ok'
+    end
+
+    def bad?
+      !good?
+    end
+
+    def porn_score
+      @result['pornography']['scores']['explicit'] unless @result.nil? || @result['pornography'].nil?
+    end
+
+    def erotic_score
+      @result['moderation']['scores']['erotic'] unless @result.nil? || @result['moderation'].nil?
+    end
+
+    def ad_score
+      @result['ad']['scores']['ads'] unless @result.nil? || @result['ad'].nil?
+    end
+
+    def ad?
+      ad_score > 0.5
+    end
+
+    def porn?
+      porn_score > 0.3
+    end
+
+    def erotic?
+      erotic_score > 0.4
+    end
+
+    def predicted_class
+      @result['moderation']['predictedClass'] unless @result.nil? || @result['moderation'].nil?
+    end
+
+    private
+
+    def parse_data
+      raise(::YandexImageModeration::Error::InvalidResult,
+            'invalid result') if @data.nil? || !@data.is_a?(Hash) || @data.empty?
+      @status = @data['status']
+      @result = @data['result']['classification'] unless @data['result'].nil?
+    end
+  end
+end

data/lib/yandex_image_moderation/version.rb

@@ -0,0 +1,3 @@
+module YandexImageModeration
+  VERSION = '0.1.0'.freeze
+end

data/lib/yandex_image_moderation.rb

@@ -0,0 +1,42 @@
+require 'json'
+require 'yandex_image_moderation/version'
+require 'yandex_image_moderation/config'
+require 'yandex_image_moderation/http_client'
+require 'yandex_image_moderation/result'
+
+# YandexImageModeration gem code
+module YandexImageModeration
+  class << self
+    # Returns an instance of the request handler.
+    #
+    # @return [#post] an instance of a request handler
+    def client
+      @client ||= ::YandexImageModeration::NetHTTPClient.new(config)
+    end
+
+    # Send a request for moderation
+    #
+    # @return [Result] an instance of the Result
+    def moderate(file)
+      return if file.nil? || !File.exist?(file)
+
+      url = "#{config.url}?models=moderation,gender,pornography,ad"
+      parse_response client.post(url, prepare_body(file), {})
+    end
+
+    protected
+
+    def parse_response(response)
+      return unless response.code.to_i == 200
+      raise(::YandexImageModeration::Error::InvalidResult, 'empty response') if response.body.nil?
+      ::YandexImageModeration::Result.new JSON.parse(response.body)
+    end
+
+    def prepare_body(file)
+      {
+        'file' => UploadIO.new(file, 'image/jpeg', File.basename(file)),
+        'token' => @options.config.token
+      }
+    end
+  end
+end

data/yandex_image_moderation.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex_image_moderation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yandex_image_moderation'
+  spec.version       = YandexImageModeration::VERSION
+  spec.authors       = ['Sergey Tsvetkov']
+  spec.email         = ['stsvetkov@gmail.com']
+
+  spec.summary       = "yandex_image_moderation-#{YandexImageModeration::VERSION}"
+  spec.description   = 'An interface for Yandex Image Moderation API'
+  spec.homepage      = 'https://github.com/tgrave/yandex_image_moderation'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: yandex_image_moderation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Tsvetkov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An interface for Yandex Image Moderation API
+email:
+- stsvetkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yandex_image_moderation.rb
+- lib/yandex_image_moderation/config.rb
+- lib/yandex_image_moderation/error.rb
+- lib/yandex_image_moderation/http_client.rb
+- lib/yandex_image_moderation/result.rb
+- lib/yandex_image_moderation/version.rb
+- yandex_image_moderation.gemspec
+homepage: https://github.com/tgrave/yandex_image_moderation
+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.4.5
+signing_key: 
+specification_version: 4
+summary: yandex_image_moderation-0.1.0
+test_files: []