mirador 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTE2NmYxMWM5NmM4NWNmMmQ4NTIzZWRmNzEyZWRhMGI0YWNhZWY5Mg==
+    ZGFjNTRlZWI2MjFkYjI0YTk2MWFjYjNlMTM5ZmMzMmMxM2RmMjJmMg==
   data.tar.gz: !binary |-
-    MzA0NjY0MzQzYjQxZWQ3YjkzOTBiMmFkOGQ0ZjZiMjE5ZWVkYTc5YQ==
+    NmM2YTU2ZTM1ZmZkNTc4OThlNTM1MzU1OGQzOWI1OGE2MzZhMThhZg==
 SHA512:
   metadata.gz: !binary |-
-    YzFjY2MyY2MwNzY2OWRlYTk3ZmYzZTZmZDBkOTE5Y2U4ZDJjOWRjMjAxZTRl
-    MzhiMzk4YWU3ZTBmYzQxNmM3YjJiYjA5ZjEzYzA3ODJmYWNmODMwY2U3Njg1
-    NmFjZDNkNDgwZWRmNDMwMTRhYjIzNTA0Zjg3NTI4MTcyZTZhNmQ=
+    OTM5OTE3YjdhMjc2ZGIyY2YxNzVkOGRjODA1Mzc0Y2M0OGEzYzNjZWRlNGUw
+    NzkxMWZhMjk0MzQ0ZWU0NGE5NmQxZGZkMWQ1NTE5NDZjMjY2ZGU3NjY2NTZm
+    YzA4ZDk5OWIzODU1Mzk4OTQ5ODYwMTUwOGNkMGEyOTQxYzRkMGE=
   data.tar.gz: !binary |-
-    ZDgyMjFjODRlZDJlNjI0NTI2ODE4NDU5NzBhZGYzYWQ1ZjI1Y2ExOWI1ODkz
-    MDAyNWNjN2NlOGRiOGNkMmQ4OTU3NzdkYzE0NjNlMjliM2JlMzUwMDdhNTk1
-    Y2RmYjRhMTMxNzY3YjYxYjYxNWM1OWI5YzY2M2Y2MGQ5NTBlYmQ=
+    YmNkZDU1YzkyNzQwOWQwZjNlNTQzMTQ5MzhhMjdjZDE0YjI5OGQxMmZiNzRk
+    NjhhYTAzOWRkYzQ4ZjVjYTQzYTUxM2YwODE0ZDI3ODZlM2JjYzYwYmI5MzNk
+    ZmI4Y2Y0N2IwZGY3ZmNlN2Y1MGU5ZDIzMTI3ZjQzNTc5ZjRkYTg=

data/README.md

@@ -1,6 +1,6 @@
 # Mirador
 
-TODO: Write a gem description
+A simple Ruby client for the [mirador](http://mirador.im) Image moderation API.
 
 ## Installation
 
@@ -18,7 +18,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+There are really two basic methods available on the API. To get started, you need an API key, available from [mirador.im/join](http://mirador.im/join). If you have problems with the API or this client, please contact support@mirador.im.
+
+### `Mirador::Client.classify_files(files) -> [Mirador::Result]`
+
+This method takes a list of filenames and returns a list of `Mirador::Result` objects. See example:
+
+```ruby
+require 'mirador'
+
+mc = Mirador::Client.new('your_key_here')
+mc.classify_files('bathing-suit.jpg', 'nsfw-user-upload.png').each do |result|
+  puts "name: #{ result.name }, safe: #{ result.safe }, value: #{ result.value }"
+end
+
+```
+
+### `Mirdor::Client.classify_urls(urls) -> [Mirador::Result]`
+
+This method takes a list of urls and returns `Mirador::Result` objects. Identical to `classify_files`:
+
+```ruby
+require 'mirador'
+
+mc.classify_urls('http://possibly-nsfw.com/cool.png', 'http://mysite.net/image/bad-picture.jpg').each do |result|
+  puts "name: #{ result.name }, safe: #{ result.safe }, value: #{ result.value }"
+end
+
+```
+
+### `Mirador::Result`
+
+The `Mirador::Result` class has 3 fields:
+
+* `Result.name` - `string`, the filename or url for this request
+* `Result.safe` - `bool`, a boolean indicating whether image contains adult content.
+* `Result.value` - `float`, a number 0.0 - 1.0 indicating confidence of judgement
 
 ## Contributing
 
@@ -27,3 +62,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Support
+
+Please submit and bugs as issues, and don't hesitate to contact support@mirador.im with questions or issues.

data/bin/mirador-client

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+#@author nickjacob (nick@mirador.im)
+#####
+require 'mirador'
+require 'optparse'
+
+api_key = nil
+OptionParser.new do |opt|
+  opt.banner = "usage: #{ File.basename($0) } -k api_key file|url [file|url...]"
+
+  opt.on('-k', '--api-key API KEY', 'api key') do |k|
+    api_key = k
+  end
+
+end.parse!
+
+if not api_key
+  puts "api key required"
+  exit(2)
+end
+
+# url test
+urlrxp = /^https?:\/\//
+
+urls, files = [], []
+ARGV.each do |x|
+  if x =~ urlrxp
+    urls << x
+  else
+    files << x
+  end
+end
+
+# mirador client
+client = Mirador::Client.new(api_key)
+
+out = []
+if urls and urls.length > 0
+  out += client.classify_urls(urls)
+end
+
+if files and files.length > 0
+  out += client.classify_files(files)
+end
+
+
+out.each do |res|
+  puts "#{ res.to_s }"
+end
+
+

data/lib/mirador/version.rb

@@ -1,3 +1,3 @@
 module Mirador
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mirador.rb

@@ -6,10 +6,10 @@ module Mirador
   API_BASE = "http://api.mirador.im/v1/"
 
   class Result
+    attr_accessor :name, :safe, :value
 
     def initialize name, data
       @name = name
-
       @safe = data['safe']
       @value = data['value']
     end
@@ -43,6 +43,7 @@ module Mirador
     end
 
     def classify_urls urls
+
       res = self.class.get(
         "/v1/classify",
         {
@@ -61,11 +62,27 @@ module Mirador
 
     def classify_files files
       processed = files.map do |f| self.process_file(f) end
+      return self.classify_encoded processed
+    end
 
+
+    def classify_raw_images imgs
+      processed = imgs.map { |i| Base64.encode(i).gsub("\n", '') }
+      return self.classify_encoded processed
+    end
+
+    private
+
+    def process_file file
+      data = File.read(file)
+      Base64.encode64(data).gsub("\n", '')
+    end
+
+    def classify_encoded encoded
       res = self.class.post(
         "/v1/classify",
         {
-          body: @options.merge({image: processed}),
+          body: @options.merge({image: encoded}),
           headers: {'User-Agent' => 'Mirador Client v1.0/Ruby'},
         }
       )
@@ -81,11 +98,6 @@ module Mirador
       return Result.parse_results(files, res['results'])
     end
 
-    def process_file file
-      data = File.read(file)
-      Base64.encode64(data).gsub("\n", '')
-    end
-
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mirador
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -33,7 +33,8 @@ dependencies:
 description: Interface to the Mirador Image Moderation API
 email:
 - nick@mirador.im
-executables: []
+executables:
+- mirador-client
 extensions: []
 extra_rdoc_files: []
 files:
@@ -42,6 +43,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/mirador-client
 - lib/mirador.rb
 - lib/mirador/version.rb
 - mirador.gemspec