Module: WebPurify::ImageFilters

Included in:
Client
Defined in:
lib/web_purify/methods/image_filters.rb

Overview

WebPurify::ImageFilters

Handles methods related to determining/filtering prohibited image content

Instance Method Summary collapse

Instance Method Details

#imgaccount ⇒ Integer

Return number of image submissions remaining on license

Returns:

  • (Integer) —

    Number of image submissions remaining



41
42
43
44
45
46
47
 
# File 'lib/web_purify/methods/image_filters.rb', line 41

def imgaccount
  params = {
    :method => WebPurify::Constants.methods[:imgaccount]
  }
  parsed = WebPurify::Request.query(image_request_base, @query_base, params)
  return parsed[:remaining].to_i
end

#imgcheck(imgurl, options = {}) ⇒ String

Check for existence of prohibited image content

Parameters:

  • imgurl (String) —

    URL of the image to be moderated

  • options (Hash) (defaults to: {}) —

    Options hash, used to set additional parameters

Returns:

  • (String) —

    Image ID that is used to return results to the callback function



13
14
15
16
17
18
19
20
 
# File 'lib/web_purify/methods/image_filters.rb', line 13

def imgcheck(imgurl, options={})
  params = {
    :method => WebPurify::Constants.methods[:imgcheck],
    :imgurl => imgurl
  }
  parsed = WebPurify::Request.query(image_request_base, @query_base, params.merge(options))
  return parsed[:imgid]
end

#imgstatus(imgid, options = {}) ⇒ String

Return status of image moderation

Parameters:

  • imgid (String) —

    ID of the image being moderated

  • options (Hash) (defaults to: {}) —

    Options hash, used to set additional parameters

Returns:

  • (String) —

    Status of image moderation



28
29
30
31
32
33
34
35
 
# File 'lib/web_purify/methods/image_filters.rb', line 28

def imgstatus(imgid, options={})
  params = {
    :method => WebPurify::Constants.methods[:imgstatus],
    :imgid  => imgid
  }
  parsed = WebPurify::Request.query(image_request_base, @query_base, params.merge(options))
  return parsed[:status]
end