rekognize 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6ec425b35afe0aaddd2428fab06ef8c95f4015a
-  data.tar.gz: 66d1c9f56c47be34bba975a146f065e075e7719b
+  metadata.gz: 0e82c31f2c5970ea2ab78c8cbc9259151f9e89b3
+  data.tar.gz: 38bef2bcc97bd4e0b9da4d6f5abed1d57b55444e
 SHA512:
-  metadata.gz: 18abc1cd0bb0467d33dc1d51d18dfa9559914ff79cdd6fa9b4308844e642a413eef1ee851be5bd70843290c1c2a253b00f33a61388e20192bc54043173585119
-  data.tar.gz: 42b0a479d57705ad9f4b69f6008eaf2564911f18a17c2bbc4e27dcdd7ae20329456be07ea7c25728f09fe9c92dde826f5c4b0f9dbdfeedeb6b042388304a2da6
+  metadata.gz: 75c0be3f977c60d5217468f916e3ea4bf099605630ec37ca1c0c14d92fdfffce3800f158f998898255a1fc027e3da8911b010870befd738cbc759bff4fc4310b
+  data.tar.gz: 61d7c807973b6d715e7ea2efca5d18a1491e10bc526195776f9eb9f97bec59b9ffc52f78c56eefc077e1b47a900cf118c3fcbf0d1c91788f700c94fa9a499d2c

data/README.md

@@ -1,6 +1,6 @@
 # Rekognize
 
-TODO: Write a gem description
+Sign up for your api credentials at: http://rekognition.com/user/create
 
 ## Installation
 
@@ -18,12 +18,58 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    irb:
+    require 'rekognize'
+    >> true
 
-## Contributing
+    client = Rekognize::Client::Base.new(api_key: YOUR_API_KEY, api_secret: YOUR_API_SECRET)
+    client.face_detect(urls: image_url/base64, jobs: 'face_detect')
 
-1. Fork it
-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 new Pull Request
+## Methods
+For the official documentation please refer to: http://rekognition.com/developer/docs
+
+    face_detect:
+      required: [:jobs, :urls]
+      optional: []
+    
+    face_add:
+      required: [:jobs, :urls]
+      optional: [:name_space, :user_id, :tag]
+
+    face_train:
+      required: [:jobs]
+      optional: [:name_space, :user_id, :tags]
+
+    face_cluster:
+      required: [:jobs]
+      optional: [:name_space, :user_id, :aggressiveness]
+    
+    face_crawl:
+      required: [:jobs, :fb_id, :access_token]
+      optional: [:name_space, :user_id]
+
+    face_recognize:
+      required: [:jobs, :urls]
+      optional: [:name_space, :user_id, :num_return, :tags]
+
+    face_visualize:
+      required: [:jobs]
+      optional: [:name_space, :user_id, :tags, :num_tag_return, :num_img_return_pertag]
+    
+    face_search:
+      required: [:jobs, :urls]
+      optional: [:name_space, :user_id, :num_return]
+
+    face_delete:
+      required: [:jobs, :name_space]
+      optional: [:user_id, :tag, :img_index]
+
+    face_rename:
+      required: [:jobs, :tag, :new_tag, :user_id]
+      optional: [:img_index]
+
+    face_stats:
+      required: [:jobs]
+
+    scene_understanding:
+      required: [:jobs, :urls]

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task :refresh => [:build] do |t|
+  sh 'gem install pkg/rekognize-0.0.1.gem'
+end

data/lib/misc/hash.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../object', __FILE__)
+
+class Hash
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+    each_key {|k| raise(ArgumentError, "Unknown key #{k}") unless valid_keys.include?(k)}
+  end
+
+  def to_params
+    '&'+collect{|k, v| v.to_query(k)}.sort * '&'
+  end
+end

data/lib/misc/object.rb

@@ -0,0 +1,11 @@
+class Object 
+
+  def to_param
+    to_s
+  end
+
+  def to_query(key)
+    require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+    "#{CGI.escape(key.to_s).gsub(/%(5B|5D)/n) { [$1].pack('H*') }}=#{CGI.escape(to_param.to_s)}"
+  end
+end

data/lib/rekognize.rb

@@ -1,5 +1,13 @@
 require "rekognize/version"
+require 'rest-client'
+require 'json'
+
+require File.expand_path('../misc/hash.rb', __FILE__)
+require File.expand_path('../rekognize/client.rb', __FILE__)
 
 module Rekognize
-  # Your code goes here...
+  def self.get_client
+    Rekognize::Client::Base.new
+  end
+
 end

data/lib/rekognize/client.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../client/base.rb', __FILE__)
+
+module Rekognize
+  module Client
+
+  end
+end

data/lib/rekognize/client/base.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../endpoints.rb', __FILE__)
+require File.expand_path('../jobs.rb', __FILE__)
+
+module Rekognize
+  module Client
+    class Base
+
+      include Rekognize::Client::Endpoints
+      include Rekognize::Client::Jobs
+
+      attr_accessor :api_key, :api_secret
+
+      def initialize(opts={})
+        opts.assert_valid_keys(:api_key, :api_secret)
+        @api_key, @api_secret = [opts[:api_key], opts[:api_secret]]
+      end
+    end
+  end
+end

data/lib/rekognize/client/endpoints.rb

@@ -0,0 +1,19 @@
+module Rekognize
+  module Client
+    module Endpoints
+
+      def configure_payload(opts={})
+        base_uri = "http://rekognition.com/func/api/?api_key=#{api_key}&api_secret=#{api_secret}"
+        base_uri + opts.to_params
+      end
+
+      def get_request(uri)
+        JSON.parse RestClient.get(uri)
+      end
+
+      def post_request(opts)
+        JSON.parse RestClient.post(base_uri, opts)
+      end
+    end
+  end
+end

data/lib/rekognize/client/jobs.rb

@@ -0,0 +1,67 @@
+module Rekognize
+  module Client
+    module Jobs
+
+      def face_detect(opts={})
+        opts.assert_valid_keys(:jobs, :urls)
+        get_request configure_payload(opts)
+      end
+
+      def face_add(opts={})
+        opts.assert_valid_keys(:jobs, :urls, :name_space, :user_id, :tag)
+        post_request opts
+      end
+
+      def face_delete(opts={})
+        opts.assert_valid_keys(:jobs, :name_space, :user_id, :tag, :img_index)
+        get_request configure_payload(opts)
+      end
+
+      def face_train(opts={})
+        opts.assert_valid_keys(:jobs, :name_space, :user_id, :tags)
+        post_request opts
+      end
+
+      def face_cluster(opts={})
+        opts.assert_valid_keys(:jobs, :name_space, :user_id, :aggressiveness)
+        post_request opts
+      end
+
+      def face_crawl(opts={})
+        opts.assert_valid_keys(:jobs, :fb_id, :access_token, :name_space, :user_id)
+        post_request opts
+      end
+
+      def face_recognize(opts={})
+        opts.assert_valid_keys(:jobs, :urls, :name_space, :user_id, :num_return, :tags)
+        post_request opts
+      end
+
+      def face_visualize(opts={})
+        opts.assert_valid_keys(:jobs, :name_space, :user_id, :tags, :num_tag_return, :num_img_return_pertag)
+        post_request opts
+      end
+
+      def face_search(opts={})
+        opts.assert_valid_keys(:jobs, :urls, :name_space, :user_id, :num_return)
+        post_request opts
+      end
+
+      def face_rename(opts={})
+        opts.assert_valid_keys(:jobs, :tag, :new_tag, :name_space, :user_id, :img_index)
+        post_request opts
+      end
+
+      def face_stats(opts={})
+        opts.assert_valid_keys(:jobs)
+        post_request opts
+      end
+
+      def scene_understanding(opts={})
+        opts.assert_valid_keys(:jobs, :urls)
+        post_request opts
+      end
+
+    end
+  end
+end

data/lib/rekognize/version.rb

@@ -1,3 +1,3 @@
 module Rekognize
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rekognize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Dennis de Vulder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,22 +38,67 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: description
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rest-client
+  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: json
+  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:
 - dennisdevulder@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
 - README.md
+- Gemfile
 - Rakefile
-- lib/rekognize.rb
+- lib/misc/hash.rb
+- lib/misc/object.rb
+- lib/rekognize/client/base.rb
+- lib/rekognize/client/endpoints.rb
+- lib/rekognize/client/jobs.rb
+- lib/rekognize/client.rb
 - lib/rekognize/version.rb
-- rekognize.gemspec
-homepage: http://youfirst.nl
+- lib/rekognize.rb
+homepage: http://rubygems.org/gems/rekognize
 licenses:
 - MIT
 metadata: {}
@@ -76,5 +121,5 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: summary
+summary: Ruby wrapper of Rekognition Face and Scenery Detection and Recognition API
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 TODO: Write your name
-
-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/rekognize.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rekognize/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "rekognize"
-  spec.version       = Rekognize::VERSION
-  spec.authors       = ["Dennis de Vulder"]
-  spec.email         = ["dennisdevulder@gmail.com"]
-  spec.description   = %q{description}
-  spec.summary       = %q{summary}
-  spec.homepage      = "http://youfirst.nl"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  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.3"
-  spec.add_development_dependency "rake"
-end