sightengine-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c34cd83e2ec2fcef4c3eef13df2baa77abf9ae1e
+  data.tar.gz: 64b471adac0b2e2a108d92b08a9991893527a22b
+SHA512:
+  metadata.gz: 5c45eb836fdaef31421ef35df9f74df59083918c4ddd6fa3b96089f325e670f7bdf885dfe2a42087590f880552ad09f4b71df375656cb7135f8742685ba77963
+  data.tar.gz: d7297480f0584fbea321d5a6dd1bcafd7f24d5824dc900dc5c23d6d0e7854c69bee0373c3b30ef7d25174d2261f1ed7cb4e6309eb3a8b0ecadcda7189169135e

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.3.0
+before_install: gem install bundler -v 1.11.2
+notifications:
+  slack:
+    rooms:
+      secure: YmvTbKjuBF5i7p3dLF/n1CWuRyyeMwhPUx/lUYsTyiad9pAgHr4pnrxoYUV7WX3nDTEcFJqD0Ekfp8aoBsGU0o/OLb76/WGkh9Gqi0HyNUCCseNz2arbnJfZ68z2UE8S7Z0WNo8oPOkvDEYukPcj9Mi/0SGtNAZMk0/V4Vl1z7TKRTqlVQg0Hm5+Iiaiy09bP2kiaqLgmkRrHUwMllAmH51PshQveN6GpJPILggD4wQW6ecsgGH5RKerG3Vss2AsHrdSl0RdFevS/8/gktcsFU96RUnbwim3FakXsdTmYKV5bPcQXu8yhcalJSE4w5HboJ3vxjj4EMLR2XKBslLuBmDboASWLdRh2igjdfIphtFeCL7K8jh+mwsKDyCtiGF66HvRuuHRlcgGjZazbP/sSDHTbxwKVXOPWd7Uw9QSjuJVoXpnSQjBHAtsEYUn8DwSu/OrPP7Q6mYTkXAFZrG2hHDaUyfAn1Q+n7taUMGtbWyFOEQt72SHYWgWB7PiUQlmJlX5LDJpTKJZmGQvlaLJQ7LU0iKVt+hg24lUi+kyseLHr4aC+6fw168g/EvMLiYZpV+/n/POzY9HAqfD+Ihp2PYgyq6uDUfFKAZEUCn+qvhK5aE5vTQFsrQAszVtlHaA9LtKEYGn+3eFIJOudXJECYfmlX+9w5Q3JyLuby5UFA8=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,53 @@
+<img src="http://d324imu86q1bqn.cloudfront.net/uploads/user/avatar/641/large_Ello.1000x1000.png" width="200px" height="200px" />
+
+# Sightengine API Ruby Wrapper
+
+This gem provides a ruby API to the [Sightengine image moderation service](https://sightengine.com/).
+
+[![Build Status](https://travis-ci.org/ello/sightengine-ruby.svg?branch=master)](https://travis-ci.org/ello/sightengine-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sightengine-ruby', github: 'ello/sightengine-ruby', require: 'sightengine'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Before making any calls, you'll need to set your credentials using the `SIGHTENGINE_API_USER` and `SIGHTENGINE_API_SECRET` environment variables.
+
+The Sightengine API has one call - `moderate`, which [checks an image for nudity](https://sightengine.readme.io/docs/nudityjson) and returns an evaluation of it.
+
+```ruby
+  puts Sightengine.moderate('https://unsplash.it/200/300?random')
+  #<struct Sightengine::Response status="success", nudity_result=false, nudity_confidence=66>
+```
+
+## Development
+
+After checking out the repo, run `rake` to run the tests. 
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+If you're adding new calls to Sightengine, running tests may require a valid API user ID and secret as described above. Normal test runs are stubbed via VCR, and should not require credentials.
+
+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/ello/sightengine-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+Ello was created by idealists who believe that the essential nature of all human beings is to be kind, considerate, helpful, intelligent, responsible, and respectful of others. To that end, we will be enforcing [the Ello rules](https://ello.co/wtf/policies/rules/) within all of our open source projects. If you don’t follow the rules, you risk being ignored, banned, or reported for abuse.

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

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/version.rb

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

data/lib/sightengine.rb

@@ -0,0 +1,67 @@
+require 'sightengine/version'
+
+require 'net/http'
+require 'json'
+require 'forwardable'
+
+module Sightengine
+  extend SingleForwardable
+
+  class << self
+    def client(service_url = 'https://api.sightengine.com/1.0',
+                api_user = ENV['SIGHTENGINE_API_USER'],
+                api_secret = ENV['SIGHTENGINE_API_SECRET'])
+      @client ||= Client.new(service_url, api_user, api_secret)
+    end
+
+    def client=(client)
+      @client = client
+    end
+  end
+
+  def_delegators :client, :moderate
+
+  Response = Struct.new(:status, :nudity_result, :nudity_confidence) do
+
+    def self.from_json(json)
+      new(json['status'],
+          json.dig('nudity', 'result'),
+          json.dig('nudity', 'confidence'))
+    end
+  end
+
+  class Client
+    def initialize(service_uri, user, secret)
+      @service_uri  = service_uri
+      @user         = user
+      @secret       = secret
+    end
+
+    def moderate(url)
+      http_client(path: '/nudity.json', http_verb: 'GET', params: { url: url })
+    end
+
+    private
+
+    def http_client(path:, http_verb:, body: "", params: {})
+      uri     = URI(@service_uri + "#{path}")
+      uri.query = URI.encode_www_form(params.merge(api_user: @user, api_secret: @secret))
+      http    = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+      request = create_request(http_verb).new(uri)
+      request.body = body
+      request.add_field 'Accept', 'application/json'
+      response = http.request(request)
+      Response.from_json(JSON.parse(response.body))
+    end
+
+    def create_request(verb)
+      case verb.downcase
+        when 'get'
+          Net::HTTP::Get
+        when 'post'
+          Net::HTTP::Post
+      end
+    end
+  end
+end

data/sightengine-ruby.gemspec

@@ -0,0 +1,28 @@
+# 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-ruby"
+  spec.version       = Sightengine::VERSION
+  spec.authors       = ["Jay Zeschin"]
+  spec.email         = ["jay@ello.co"]
+
+  spec.summary       = %q{Ruby wrapper for the SightEngine image moderation API}
+  spec.homepage      = "https://github.com/ello/sightengine-ruby"
+  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 "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: sightengine-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jay Zeschin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: dotenv
+  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: vcr
+  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: webmock
+  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: 
+email:
+- jay@ello.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sightengine.rb
+- lib/sightengine/version.rb
+- sightengine-ruby.gemspec
+homepage: https://github.com/ello/sightengine-ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the SightEngine image moderation API
+test_files: []