webpurify_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a4ea6940d9d2711e3bfdee6291b989844830c37
+  data.tar.gz: 50ace9352abfe313b9ea5bb584666f724db45f20
+SHA512:
+  metadata.gz: b4d89746dc1a46f4815b0e52fa870b2b974ee3ecb82fb7eeb78e19fef08a1bd71f964be93cdef4d53e01e65ac68cf4393b44c24eaf7e8b1455bd467c490b853d
+  data.tar.gz: aa034514dfa5adee93d8280f6a7b65513c98c77e0e42af6e513c9d46acf75c46a34f07cfcd6f1dcd8b44bee7bfa7353b811eeb21e15ffc26516bcb41da35ef60

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Olivier
+
+MIT License
+
+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,37 @@
+# WebpurifyApi
+
+API Wrapper for http://webpurify.com image moderation api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webpurify_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webpurify_api
+
+## Usage
+
+```
+image = WebpurifyApi::Image.new(api_key: 'XXX', live: false)
+res = image.check(image_url)
+puts image.status(res['imgid']).inspect
+```
+
+See API docs for more informations: http://www.webpurify.com/image-moderation/documentation/
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/veilleperso/webpurify_api_/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/webpurify_api.rb

@@ -0,0 +1,8 @@
+require 'rest-client'
+require 'active_support/all'
+require "webpurify_api/version"
+require "webpurify_api/base"
+require "webpurify_api/image"
+
+module WebpurifyApi
+end

data/lib/webpurify_api/base.rb

@@ -0,0 +1,78 @@
+class WebpurifyApi::Base
+  attr_accessor :api_key, :endpoint
+
+  def initialize(api_key: nil, live: nil, endpoint: nil)
+    self.api_key = api_key || ENV['WEBPURIFY_APIKEY']
+    self.live = live.nil? ? ENV['WEBPURIFY_LIVE'].to_s == 'true' : live
+    self.endpoint = endpoint if endpoint
+  end
+
+  def live?
+    !!self.live
+  end
+
+  def logger
+    return @logger if defined?(@logger)
+    @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  end
+
+  def logger=(val)
+    @logger = val
+  end
+
+  def error_message_for(code)
+    case code.to_i
+    when 100 then "Invalid API Key"
+    when 101 then "API Key is inactive"
+    when 102 then "API Key is missing in request"
+    when 103 then "Not a valid URL"
+    when 105 then "Unable to locate image"
+    when 106 then "Out of Requests"
+    else "Unknown error #{code}"
+    end
+  end
+
+  protected
+
+  attr_accessor :live
+
+  def do_request(method, options = {})
+    return false if api_key.blank?
+    return false if endpoint.blank?
+    return false unless valid_method?(method)
+
+    url = build_url_for(method, options.delete(:params))
+    res = RestClient.get(url, content_type: :json, accept: :json)
+    if res.body.to_s.match('<?xml')
+      # errors seems to be always returned in xml, whatever the format we ask
+      (Hash.from_xml(res.body) || {})['rsp']
+    else
+      (JSON.parse(res.body) || {})['rsp']
+    end
+  rescue RestClient::BadGateway, RestClient::ServiceUnavailable => err
+    logger.error("#{err.inspect}")
+    {}
+  end
+
+  private
+
+  def valid_method?(method)
+    %w(imgcheck imgstatus imgaccount).include?(method.to_s)
+  end
+
+  def request_method(method)
+    live_request?(method) ? "webpurify.live.#{method}" : "webpurify.sandbox.#{method}"
+  end
+
+  def live_request?(method)
+    method.to_s == 'imgaccount' ? true : live?
+  end
+
+  def build_url_for(method, params = nil)
+    params ||= {}
+    params.reverse_merge!(format: 'json', api_key: self.api_key)
+    params[:method] = request_method(method)
+    query = params.select { |k, v| !v.blank? }.collect { |k, v| "#{k}=#{CGI.escape(v.to_s)}"}.join("&")
+    "#{endpoint}?#{query}"
+  end
+end

data/lib/webpurify_api/image.rb

@@ -0,0 +1,20 @@
+class WebpurifyApi::Image < WebpurifyApi::Base
+  def initialize(api_key: nil, live: nil)
+    super(api_key: api_key, live: live, endpoint: "https://im-api1.webpurify.com/services/rest/")
+  end
+  
+  # callback url receive a get request  with +imgid+ and +status+ parameters
+  # status: 1 = approved , status: 2 = declined
+  def check(url, custom_image_id: nil, callback: nil)
+    res = do_request(:imgcheck, params: { imgurl: url, customimgid: custom_image_id, callback: callback })
+    res
+  end
+
+  def status(image_id)
+    do_request(:imgstatus, params: { imgid: image_id })
+  end
+
+  def account
+    do_request(:imgaccount)
+  end
+end

data/lib/webpurify_api/version.rb

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

data/webpurify_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webpurify_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webpurify_api"
+  spec.version       = WebpurifyApi::VERSION
+  spec.authors       = ["Olivier"]
+  spec.email         = ["olivier@veilleperso.com"]
+  spec.summary       = %q{Small wrapper aroud webpurify.com image moderation api.}
+  spec.description   = %q{Wrapper for webpurify.com image moderation api, built for my own needs.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "rest-client", "~> 1.7.2"
+  spec.add_runtime_dependency "activesupport"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: webpurify_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for webpurify.com image moderation api, built for my own needs.
+email:
+- olivier@veilleperso.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webpurify_api.rb
+- lib/webpurify_api/base.rb
+- lib/webpurify_api/image.rb
+- lib/webpurify_api/version.rb
+- webpurify_api.gemspec
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Small wrapper aroud webpurify.com image moderation api.
+test_files: []