microsoft-cognitive-face 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dc03879782a07de1c1718d85c4a6e441b8993a9
+  data.tar.gz: 02e571bd869cdd8ef7025a4525d19d63ac595b66
+SHA512:
+  metadata.gz: 57fc6e015a9369c30add408b6949c5c5ab070cb701cf736f3cd815fecf2de16454c4bd3dcbbe2b4b1ff31d16c275b8b1a148d3c5d848914a34f762214b8b8b51
+  data.tar.gz: ba6191c82c306a74eae4333cfafd019dba7436c167260d2c686f552397c86197d4e1a18ba6b8191c8603d7946b0e3503ba9777ff125ca28911560c24ad1e628b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jdaviderb@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jdaviderb
+
+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,124 @@
+# Microsoft Cognitive Services Face for Ruby
+
+Detect human faces and compare similar ones, organize people into groups according to visual similarity, and identify previously tagged people in images
+
+https://www.microsoft.com/cognitive-services/en-us/face-api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'microsoft-cognitive-face'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install microsoft-cognitive-face
+
+## Usage
+
+```ruby 
+  client = Cognitive::Face::Client.new key: 'MICROSOFT_FACE_KEY'
+```
+
+Face - Detect
+
+https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236
+
+```ruby 
+  face = client.detect File.read('dhh.png')
+  # => #<OpenStruct faceId="6c6a4eea-795f-4ab8-92d2-a99735af6f31", faceRectangle={"top"=>153, "left"=>98, "width"=>203, "height"=>203}>
+```
+
+Face List - Create a Face List
+
+https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b
+
+```ruby 
+ secure_face_list_id = SecureRandom.uuid
+ face_list = client.create_face_list(
+  name: 'Ruby test',
+  face_list_id: secure_face_list_id
+ )
+ #=> true
+```
+
+Face List - Add a Face to a Face List
+
+https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250
+
+```ruby 
+  face = face_client.add_face_to_face_list(
+    face: File.read('dhh.jpg'),
+    face_list_id: secure_face_list_id
+  )
+  #=> #<OpenStruct persistedFaceId="d91bc779-66ac-4fa6-a4e2-62552c3f5404">
+
+```
+
+
+
+Face - Find Similar
+
+https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237
+
+```ruby
+  face_client.find_similar(
+      face_list_id: secure_face_list_id,
+      face_id: 'd91bc779-66ac-4fa6-a4e2-62552c3f5404'
+  )
+  # => [#<OpenStruct persistedFaceId="47e5313c-efb6-47f4-ab3e-80b71b2ba381", confidence=1.0>]
+
+```
+
+
+Face List - Delete a Face from a Face List
+
+https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251
+
+```ruby
+  face_client.delete_face_to_face_list(
+    face_id: 'd91bc779-66ac-4fa6-a4e2-62552c3f5404',
+    face_list_id: secure_face_list_id
+  )
+  # => true
+```
+
+
+Face List - Delete a Face List
+
+https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f
+
+
+
+```ruby
+  face_client.delete_face_list(
+    face_list_id: secure_face_list_id
+  )
+  # => true
+```
+
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `MICROSOFT_FACE_KEY=APIKEY rake spec ` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jdaviderb/microsoft-cognitive-face-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,6 @@
+require 'json'
+require 'ostruct'
+require 'restclient'
+require "cognitive/face/version"
+require "cognitive/face/client"
+require "cognitive/face/response"

data/lib/cognitive/face/client.rb

@@ -0,0 +1,171 @@
+module Cognitive
+  module Face
+
+    class Client
+      # Constructor
+      #
+      # @param key [String] Subscription key which provides access to this API
+
+      def initialize(key:)
+        @key = key
+        @headers = {
+          'Ocp-Apim-Subscription-Key' => @key,
+          'Content-Type': 'application/json'
+        }
+        @endpoints = {
+          detect:'https://api.projectoxford.ai/face/v1.0/detect',
+          facelist: 'https://api.projectoxford.ai/face/v1.0/facelists/',
+          findsimilar: 'https://api.projectoxford.ai/face/v1.0/findsimilars'
+        }
+      end
+
+      # Detect human faces in an image and returns face locations, and optionally with faceIds, landmarks, and attributes
+      # Api rest documentation https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236
+      #
+      # @param face [File] JPEG, PNG, GIF
+      # @param return_face_id [Boolean] return face id or not. default true 
+
+      def detect(face:,return_face_id: true,
+                returnFaceLandmarks:false, 
+                returnFaceAttributes: nil)
+        query_params = {
+          returnFaceId: return_face_id,
+          returnFaceLandmarks: returnFaceLandmarks
+        }
+
+        headers = @headers.merge(
+          params: query_params,
+          'Content-Type': 'application/octet-stream'
+        )
+
+       client = RestClient.post(
+        @endpoints[:detect],
+        face,
+        headers
+       )
+       Response.new(client).get
+      end
+
+      # Get information a face list id
+      # Api rest documentation https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c
+      # @param face_list_id [String]
+
+      def get_face_list(face_list_id:)
+        client = RestClient.get(
+          @endpoints[:facelist] + face_list_id.to_s,
+          @headers
+        )
+        Response.new(client).get
+      end
+
+      # Delete face list
+      # @param face_list_id[String]
+      # Api rest documentation https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f
+      
+      def delete_face_list(face_list_id:)
+        client = RestClient.delete(
+          @endpoints[:facelist] + face_list_id.to_s,
+          @headers
+        )
+        Response.new(
+          client,
+          json: false,
+          response_custom: lambda {|client| client.code == 200}
+        ).get
+      end
+
+
+      # Get all face lists
+      # Api rest documentation https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c
+
+      def get_face_lists
+        client = RestClient.get(
+          @endpoints[:facelist],
+          @headers
+        )
+        Response.new(client).get
+      end
+
+      # Create face list
+      # @param face_list_id[String] unique indentify
+      # @param name[String] name face list
+      # @param user_data[String] Optinal info
+
+      def create_face_list(face_list_id:,name:,user_data: nil)
+        params = {
+          name: name,
+          userData: user_data
+        }.to_json
+        client = RestClient.put(
+          @endpoints[:facelist]+face_list_id.to_s,
+          params,
+          @headers
+        )
+         Response.new(
+          client,
+          json: false,
+          response_custom: lambda {|client| client.code == 200}
+          ).get
+      end
+
+      # Add face to face list
+      # @param face[File] Image
+      # @param face_list_id[String]
+      # @param user_data[String] Optinal
+      # @param target_face Optional
+      def add_face_to_face_list(face:, face_list_id:, user_data: nil, target_face: nil)
+        headers = @headers.merge(
+          params: {
+            userData: user_data,
+            targetFace: target_face
+          },
+          'Content-Type': 'application/octet-stream'
+        )
+        client = RestClient.post(
+          @endpoints[:facelist]+"#{face_list_id}/persistedFaces",
+          face,
+          headers
+        )
+        Response.new(client).get
+      end
+
+      # Deleted face from a face list
+      # @param face_id[String]
+      # @param face_list_id[String]
+
+      def delete_face_to_face_list(face_id:, face_list_id:)
+        client = RestClient.delete(
+          @endpoints[:facelist]+"#{face_list_id}/persistedFaces/#{face_id}",
+          @headers
+        )
+        Response.new(
+          client,
+          json: false,
+          response_custom: lambda {|client| client.code == 200}
+        ).get
+      end
+
+      # Find face from  a face list
+      # @param face_id[String]
+      # @param face_list_id[String]
+      # @param mode[String] 
+
+      def find_similar(face_id:, face_list_id:, mode: 'matchPerson')
+        data = {
+          faceId: face_id,
+          faceListId: face_list_id,
+          mode: mode
+        }
+        client = RestClient.post(
+          @endpoints[:findsimilar],
+          data.to_json,
+          @headers
+        )
+        Response.new(client).get
+      end
+    
+    end
+
+
+  end
+end

data/lib/cognitive/face/response.rb

@@ -0,0 +1,29 @@
+module Cognitive
+  module Face
+    class Response
+      def initialize(http_response,json: true, response_custom: nil)
+        @json = json
+        @response_custom = response_custom
+        @http_response = http_response
+      end
+
+      def get
+        return @response_custom.call(@http_response) unless @response_custom.nil?
+        if @json
+          data = JSON.parse @http_response.body
+          data.map! { |data|
+            OpenStruct.new(data)
+          } if data.kind_of?(Array)
+          data = OpenStruct.new(data) if data.kind_of?(Hash)
+          return data
+        end
+      end
+
+    end
+  end
+end
+
+
+
+
+

data/lib/cognitive/face/version.rb

@@ -0,0 +1,6 @@
+module Cognitive
+  module Face
+    VERSION = "0.1.0"
+  end
+end
+

data/microsoft-cognitive-face.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cognitive/face/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "microsoft-cognitive-face"
+  spec.version       = Cognitive::Face::VERSION
+  spec.authors       = ["jdaviderb"]
+  spec.email         = ["jdaviderb@gmail.com"]
+
+  spec.summary       = 'Microsoft cognitive face client for ruby'
+  spec.homepage      = "https://github.com/jdaviderb/microsoft-cognitive-face-ruby"
+  spec.license       = "MIT"
+
+  # 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rest-client", "~>2.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: microsoft-cognitive-face
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jdaviderb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- jdaviderb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/dhh.jpg
+- lib/cognitive/face.rb
+- lib/cognitive/face/client.rb
+- lib/cognitive/face/response.rb
+- lib/cognitive/face/version.rb
+- microsoft-cognitive-face.gemspec
+homepage: https://github.com/jdaviderb/microsoft-cognitive-face-ruby
+licenses:
+- MIT
+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: Microsoft cognitive face client for ruby
+test_files: []