oxford-face-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb77992f311699a0c0fcb4d58cd8f306e3b20758
+  data.tar.gz: ab4b7af6a2dca1278ef7653aa4774cbe1a2ad9c9
+SHA512:
+  metadata.gz: 86dffbe90c64f7acb8ac544dd226a87916c9f9604d423b728591c4cd393ed3133b282d99449ba4fbaea3980bde7473f8152b47e6c1c7eb992a0eafdcddf87b49
+  data.tar.gz: 63a96d5badd5864bccb8d70b60b67876b5eae2ecafeacff4497bd98d60d1d9c36c6da54d59a8eff03ae4080dae811764c3edcf6a10a12ced0ba3155f76085e22

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swo
+*.swp
+*.gem
+/test/key.txt
+.DS_Store

data/Gemfile

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

data/README.md

@@ -0,0 +1,21 @@
+# oxford-face-api
+Ruby gem for Microsoft Oxford Face api
+
+### Usage
+
+```
+require 'oxford/face/api'
+
+KEY="YOUR_API_KEY" # from Microsoft Oxford
+OxfordFaceApi.init(KEY)
+
+f = OxfordFaceApi::Face.new
+
+img_url = "https://raw.githubusercontent.com/tantara/oxford-face-api/master/test/example.jpg"
+return_face_id = true
+return_face_landmarks = false
+return_face_attributes = "age,gender"
+
+res = f.detect(img_url, return_face_id, return_face_landmarks, return_face_attributes)
+puts res.body # => https://gist.github.com/tantara/5d72786bd3c6acc285a29ec44c4a8d1e
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oxford/face/api"
+
+# 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/oxford/face/api.rb

@@ -0,0 +1,278 @@
+require "oxford/face/api/version"
+require "oxford/face/http_client"
+
+module OxfordFaceApi
+  @api_key = ""
+
+  def self.init(api_key)
+	@api_key = api_key
+  end
+
+  def self.API_KEY
+	@api_key
+  end
+
+  class Face
+	def initialize
+	  raise if OxfordFaceApi.API_KEY.empty?
+	  @client = HttpClient.new(OxfordFaceApi.API_KEY)
+	end
+
+	# Detect
+	# POST https://api.projectoxford.ai/face/v1.0/detect[?returnFaceId][&returnFaceLandmarks][&returnFaceAttributes]
+	def detect(url, return_face_id = true, return_face_landmarks = false, return_face_attributes = "")
+	  params = {
+		url: url
+	  }
+	  @client.post("/detect?returnFaceId=#{return_face_id}&returnFaceLandmarks=#{return_face_landmarks}&returnFaceAttributes=#{return_face_attributes}", params)
+	end
+
+	# TODO
+	# Find Similar
+	# POST https://api.projectoxford.ai/face/v1.0/findsimilars
+	def find_similar
+	  params = {
+	  }
+	  @client.post("/findsimilars", params)
+	end
+
+	# TODO
+	# Group
+	# POST https://api.projectoxford.ai/face/v1.0/group
+	def group
+	  params = {
+	  }
+	  @client.post("/group", params)
+	end
+
+	# Identify
+	# POST https://api.projectoxford.ai/face/v1.0/identify
+	def identify(group_id, face_ids, max_num_of_candidates_returned = 1, confidence_threshold = 0.5)
+	  params = {
+		faceIds: face_ids,
+		personGroupId: group_id, 
+		maxNumOfCandidatesReturned: max_num_of_candidates_returned,
+		confidenceThreshold: confidence_threshold
+	  }
+	  @client.post("/identify", params)
+	end
+
+	# Verify
+	# POST https://api.projectoxford.ai/face/v1.0/verify
+	def verify(face_id, group_id, person_id = "")
+	  if person_id.empty?
+		face_id1 = face_id
+		face_id2 = group_id
+
+		params = {
+		  faceId1: face_id1,
+		  faceId2: face_id2,
+		}
+	  else
+		params = {
+		  faceId: face_id,
+		  personGroupId: group_id,
+		  personId: person_id
+		}
+	  end
+	  @client.post("/verify", params)
+	end
+  end
+
+  class FaceList
+	def initialize
+	  raise if OxfordFaceApi.API_KEY.empty?
+	  @client = HttpClient.new(OxfordFaceApi.API_KEY)
+	end
+
+	# Add a Face to a Face List
+	# POST https://api.projectoxford.ai/face/v1.0/facelists/{faceListId}/persistedFaces[?userData][&targetFace]
+	def add_face(face_list_id, url, user_data = "", target_face = "")
+	  params = {
+		url: url
+	  }
+	  @client.post("/facelists/#{face_list_id}/persistedFaces?userData=#{user_data}&targetFace=#{target_face}", params)
+	end
+
+	# Create a Face List
+	# PUT https://api.projectoxford.ai/face/v1.0/facelists/{faceListId}
+	def create(face_list_id, name, user_data = "")
+	  params = {
+		name: name,
+		userData: user_data
+	  }
+	  @client.put("/facelists/#{face_list_id}", params)
+	end
+
+	# FIXME
+	# Delete a Face from a Face List
+	# DELETE https://api.projectoxford.ai/face/v1.0/facelists/{faceListId}/persistedFaces/{persistedFaceId}
+	def delete_face(face_list_id, face_id)
+	  @client.delete("/facelists/#{face_list_id}/persistedFaces/#{face_id}")
+	end
+
+	# FIXME
+	# Delete a Face List
+	# DELETE https://api.projectoxford.ai/face/v1.0/facelists/{faceListId}
+	def delete(face_list_id)
+	  @client.delete("/facelists/#{face_list_id}")
+	end
+
+	# Get a Face List
+	# GET https://api.projectoxford.ai/face/v1.0/facelists/{faceListId}
+	def faces(face_list_id)
+	  @client.get("/facelists/#{face_list_id}")
+	end
+
+	# List Face Lists
+	# GET https://api.projectoxford.ai/face/v1.0/facelists
+	def all
+	  @client.get("/facelists")
+	end
+
+	# Update a Face List
+	# PATCH https://api.projectoxford.ai/face/v1.0/facelists/{faceListId}
+	def update(face_list_id, name, user_data)
+	  params = {
+		name: name,
+		userData: user_data
+	  }
+	  @client.patch("/facelists/#{face_list_id}", params)
+	end
+  end
+
+  class Person
+	def initialize
+	  raise if OxfordFaceApi.API_KEY.empty?
+	  @client = HttpClient.new(OxfordFaceApi.API_KEY)
+	end
+
+	# Add a Person Face
+	# POST https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedFaces[?userData][&targetFace]
+	def add_face(group_id, person_id, url, user_data = "", target_face = "")
+	  params = {
+		url: url
+	  }
+	  @client.post("/persongroups/#{group_id}/persons/#{person_id}/persistedFaces?userData=#{user_data}&targetFace=#{target_face}", params)
+	end
+
+	# Create a Person
+	# POST https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons
+	def create(group_id, name, user_data = "")
+	  params = {
+		name: name,
+		userData: user_data
+	  }
+	  @client.post("/persongroups/#{group_id}/persons", params)
+	end
+
+	# FIXME
+	# Delete a Person
+	# DELETE https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}
+	def delete(group_id, person_id)
+	  @client.delete("/persongroups/#{group_id}/persons/#{person_id}")
+	end
+
+	# FIXME
+	# Delete a Person Face
+	# DELETE https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedFaces/{persistedFaceId}
+	def delete_face(group_id, person_id, face_id)
+	  @client.delete("/persongroups/#{group_id}/persons/#{person_id}/persistedFaces/#{face_id}")
+	end
+
+	# Get a Person
+	# GET https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}
+	def get(group_id, person_id)
+	  @client.get("/persongroups/#{group_id}/persons/#{person_id}")
+	end
+
+	# Get a Person Face
+	# GET https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedFaces/{persistedFaceId}
+	def face(group_id, person_id, face_id)
+	  @client.get("/persongroups/#{group_id}/persons/#{person_id}/persistedFaces/#{face_id}")
+	end
+
+	# List Persons in a Person Group
+	# GET https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons
+	def all(group_id)
+	  @client.get("/persongroups/#{group_id}/persons")
+	end
+
+	# Update a Person
+	# PATCH https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}
+	def update(group_id, person_id, name, user_data)
+	  params = {
+		name: name,
+		userData: user_data
+	  }
+	  @client.patch("/persongroups/#{group_id}/persons/#{person_id}", params)
+	end
+
+	# Update a Person Face
+	# PATCH ttps://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedFaces/{persistedFaceId}
+	def update_face(group_id, person_id, face_id, user_data)
+	  params = {
+		userData: user_data
+	  }
+	  @client.patch("/persongroups/#{group_id}/persons/#{person_id}/persistedFaces/#{face_id}", params)
+	end
+  end
+
+  class PersonGroup
+	def initialize
+	  raise if OxfordFaceApi.API_KEY.empty?
+	  @client = HttpClient.new(OxfordFaceApi.API_KEY)
+	end
+
+	# Create a Person Group
+	# PUT https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
+	def create(group_id, name, user_data = "")
+	  params = {
+		name: name,
+		userData: user_data
+	  }
+	  @client.put("/persongroups/#{group_id}", params)
+	end
+
+	# FIXME
+	# Delete a Person Group
+	# DELETE https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
+	def delete(group_id)
+	  @client.delete("/persongroups/#{group_id}")
+	end
+
+	# Get a Person Group
+	# GET https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
+	def get(group_id)
+	  @client.get("/persongroups/#{group_id}")
+	end
+
+	# Get Person Group Training Status
+	# GET https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/training
+	def status(group_id)
+	  @client.get("/persongroups/#{group_id}/training")
+	end
+
+	# List Person Groups
+	# GET https://api.projectoxford.ai/face/v1.0/persongroups[?start][&top]
+	def all(start = 1, top = 1000)
+	  @client.get("/persongroups?start=#{start}&top=#{top}")
+	end
+
+	# Train Person Group
+	# POST https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/train
+	def train(group_id)
+	  @client.post("/persongroups/#{group_id}/train")
+	end
+
+	# Update a Person Group
+	# PATCH https://api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
+	def update(group_id, name, user_data)
+	  params = {
+		name: name,
+		userData: user_data
+	  }
+	  @client.patch("/persongroups/#{group_id}", params)
+	end
+  end
+end

data/lib/oxford/face/api/version.rb

@@ -0,0 +1,7 @@
+module Oxford
+  module Face
+    module Api
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/oxford/face/http_client.rb

@@ -0,0 +1,89 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+
+class HttpClient
+  def initialize(api_key)
+    uris = URI.parse("https://api.projectoxford.ai")
+    @http = Net::HTTP.new(uris.host, uris.port)
+    @http.use_ssl = true
+    @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    @api_key = api_key
+  end
+
+  def get(path, params = {})
+    request = Net::HTTP::Get.new("/face/v1.0#{path}")
+    request.content_type = "application/json"
+    request['Ocp-Apim-Subscription-Key'] = @api_key
+
+    if params.is_a?(Hash)
+      request.set_form_data(params)
+    else
+      request.body = params
+    end
+
+    response = @http.request(request)
+    response
+  end
+
+  def post(path, params = {})
+    request = Net::HTTP::Post.new("/face/v1.0#{path}")
+    request.content_type = "application/json"
+    request['Ocp-Apim-Subscription-Key'] = @api_key
+
+    if params.is_a?(Hash)
+      request.body = params.to_json
+    else
+      request.body = params
+    end
+
+    response = @http.request(request)
+    response
+  end
+
+  def put(path, params = {})
+    request = Net::HTTP::Put.new("/face/v1.0#{path}")
+    request.content_type = "application/json"
+    request['Ocp-Apim-Subscription-Key'] = @api_key
+
+    if params.is_a?(Hash)
+      request.body = params.to_json
+    else
+      request.body = params
+    end
+
+    response = @http.request(request)
+    response
+  end
+
+  def patch(path, params = {})
+    request = Net::HTTP::Patch.new("/face/v1.0#{path}")
+    request.content_type = "application/json"
+    request['Ocp-Apim-Subscription-Key'] = @api_key
+
+    if params.is_a?(Hash)
+      request.body = params.to_json
+    else
+      request.body = params
+    end
+
+    response = @http.request(request)
+    response
+  end
+
+  def delete(path, params = {})
+    request = Net::HTTP::Delete.new("/face/v1.0#{path}")
+    request.content_type = "application/json"
+    request['Ocp-Apim-Subscription-Key'] = @api_key
+
+    if params.is_a?(Hash)
+      request.set_form_data(params)
+    else
+      request.body = params
+    end
+
+    response = @http.request(request)
+    response
+  end
+end

data/oxford-face-api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oxford/face/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oxford-face-api"
+  spec.version       = Oxford::Face::Api::VERSION
+  spec.authors       = ["Taekmin Kim"]
+  spec.email         = ["tantara.tm@gmail.com"]
+
+  spec.summary       = %q{Oxford Face API}
+  spec.description       = %q{Microsoft Oxford Face API}
+  spec.homepage      = "https://github.com/tantara/oxford-face-api"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.10.1"
+
+  spec.add_dependency "rake", ">= 10.0"
+  spec.add_dependency "json", ">= 2.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: oxford-face-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taekmin Kim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Microsoft Oxford Face API
+email:
+- tantara.tm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oxford/face/api.rb
+- lib/oxford/face/api/version.rb
+- lib/oxford/face/http_client.rb
+- oxford-face-api.gemspec
+homepage: https://github.com/tantara/oxford-face-api
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Oxford Face API
+test_files: []