face_detect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa441dc7c2d9525533a9b65f43813791871a4c9d
+  data.tar.gz: 862176e4951cb4ceee392d0c2480da02a202f714
+SHA512:
+  metadata.gz: 16b5de33d46972b9cb274f76f4c5c8538c6b9abbb4c367be5f4d65b08bd86ad0e0cc9f3af68099bce936bb047cf37fa05b2b894e5b8af39f30fe7bc57e5b1112
+  data.tar.gz: 5771a878d9bc011a2a5b25c706c94f9cc22a2fa1da23016d5537b6720a49e898ac8f10b3b3108783433be7edb15a642b3caea706318ec6588c5c9ab2955cd815

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/mustachio-*.json

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at aidan.feldman@gsa.gov. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/afeld/face_detect. 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.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Aidan Feldman
+
+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,50 @@
+# Face Detect
+
+A Ruby gem for face detection in images. Also includes detection of facial features/landmarks. The backends are swappable.
+
+While the intention is to support multiple adapters, the only one available for now is the [**Google Cloud Vision API**](https://cloud.google.com/vision/).
+
+## Installation
+
+Requires Ruby 2.x.
+
+1. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'face_detect'
+    gem 'googleauth'
+    gem 'google-api-client'
+    ```
+
+1. Execute:
+
+    ```bash
+    bundle
+    ```
+
+1. [Create a JSON service account key.](https://console.cloud.google.com/apis/credentials/serviceaccountkey)
+
+## Usage
+
+1. The JSON file that you downloaded contains your credentials. Set the full contents as an environment variable.
+
+    ```bash
+    export GOOGLE_CREDENTIALS_JSON=$(cat <credentials>.json)
+    ```
+
+1. Add the following to your code:
+
+    ```ruby
+    require 'face_detect'
+    require 'face_detect/adapter/google'
+
+    input = File.new('image.png')
+    detector = FaceDetect.new(
+      file: input,
+      adapter: FaceDetect::Adapter::Google
+    )
+    results = detector.run
+    results #=> [<FaceDetect::Face>, ...]
+    face = results.first
+    face.mouth_left.x #=> 225.06
+    ```

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 "face_detect"
+
+# 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/face_detect.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'face_detect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "face_detect"
+  spec.version       = FaceDetect::VERSION
+  spec.authors       = ["Aidan Feldman"]
+  spec.email         = ["aidan.feldman@gmail.com"]
+
+  spec.summary       = %q{Simple face detection}
+  spec.homepage      = "https://github.com/afeld/face_detect"
+  spec.license       = "MIT"
+
+  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.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "google-api-client", "~> 0.9.6"
+  spec.add_development_dependency "googleauth", "~> 0.5.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+end

data/lib/face_detect.rb

@@ -0,0 +1,15 @@
+Dir[File.expand_path('face_detect/*.rb', __dir__)].each { |file| require file }
+
+class FaceDetect
+  attr_reader :file, :adapter_instance
+
+  # TODO accept a File or a URL
+  def initialize(file:, adapter:)
+    @file = file
+    @adapter_instance = adapter.new(file)
+  end
+
+  def run
+    adapter_instance.run
+  end
+end

data/lib/face_detect/adapter/google.rb

@@ -0,0 +1,51 @@
+require_relative 'google/auth_helper'
+require_relative 'google/service'
+
+class FaceDetect
+  module Adapter
+    class Google
+      attr_reader :file
+
+      def initialize(file)
+        @file = file
+      end
+
+      def run
+        batch_response = execute
+        response = batch_response.responses.first
+        response.face_annotations.map do |annotation|
+          convert_face(annotation)
+        end
+      end
+
+      private
+
+      def authorization
+        AuthHelper.authorization
+      end
+
+      def execute
+        service = Service.new(authorization, file)
+        batch_response = service.run
+      end
+
+      def landmarks_by_name(annotation)
+        results = {}
+        annotation.landmarks.each do |google_landmark|
+          name = google_landmark.type.downcase
+          results[name] = convert_landmark(google_landmark)
+        end
+        results
+      end
+
+      def convert_face(annotation)
+        FaceDetect::Face.new(landmarks_by_name(annotation))
+      end
+
+      def convert_landmark(google_landmark)
+        pos = google_landmark.position
+        FaceDetect::Landmark.new(pos.x, pos.y)
+      end
+    end
+  end
+end

data/lib/face_detect/adapter/google/auth_helper.rb

@@ -0,0 +1,28 @@
+require 'googleauth'
+require 'stringio'
+
+class FaceDetect
+  module Adapter
+    class Google
+      module AuthHelper
+        class << self
+          def scopes
+            ['https://www.googleapis.com/auth/cloud-platform']
+          end
+
+          def credentials
+            ENV.fetch('GOOGLE_CREDENTIALS_JSON')
+          end
+
+          def authorization
+            key_io = StringIO.new(credentials)
+            ::Google::Auth::ServiceAccountCredentials.make_creds(
+              json_key_io: key_io,
+              scope: scopes
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/face_detect/adapter/google/service.rb

@@ -0,0 +1,58 @@
+require 'google/apis/vision_v1'
+
+class FaceDetect
+  module Adapter
+    class Google
+      class Service
+        # alias the module
+        # http://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/VisionV1/VisionService
+        Vision = ::Google::Apis::VisionV1
+
+        attr_reader :authorization, :file
+
+        def initialize(authorization, file)
+          @authorization = authorization
+          @file = file
+        end
+
+        def run
+          service.authorization = authorization
+          service.annotate_image(batch_request, fields: fields)
+        end
+
+        private
+
+        def service
+          @service ||= Vision::VisionService.new
+        end
+
+        def image_contents
+          File.read(file)
+        end
+
+        def image
+          Vision::Image.new(content: image_contents)
+        end
+
+        def features
+          [Vision::Feature.new(type: 'FACE_DETECTION')]
+        end
+
+        def batch_request
+          @batch_request ||= Vision::BatchAnnotateImagesRequest.new(
+            requests: [
+              {
+                image: image,
+                features: features
+              }
+            ]
+          )
+        end
+
+        def fields
+          'responses(faceAnnotations(landmarks))'
+        end
+      end
+    end
+  end
+end

data/lib/face_detect/face.rb

@@ -0,0 +1,54 @@
+require 'set'
+
+class FaceDetect
+  class Face
+    # https://cloud.google.com/vision/reference/rest/v1/images/annotate#Landmark
+    LANDMARK_NAMES = %i(
+      left_eye
+      right_eye
+      left_of_left_eyebrow
+      right_of_left_eyebrow
+      left_of_right_eyebrow
+      right_of_right_eyebrow
+      midpoint_between_eyes
+      nose_tip
+      upper_lip
+      lower_lip
+      mouth_left
+      mouth_right
+      mouth_center
+      nose_bottom_right
+      nose_bottom_left
+      nose_bottom_center
+      left_eye_top_boundary
+      left_eye_right_corner
+      left_eye_bottom_boundary
+      left_eye_left_corner
+      right_eye_top_boundary
+      right_eye_right_corner
+      right_eye_bottom_boundary
+      right_eye_left_corner
+      left_eyebrow_upper_midpoint
+      right_eyebrow_upper_midpoint
+      left_ear_tragion
+      right_ear_tragion
+      left_eye_pupil
+      right_eye_pupil
+      forehead_glabella
+      chin_gnathion
+      chin_left_gonion
+      chin_right_gonion
+    ).to_set.freeze
+
+    attr_reader *LANDMARK_NAMES
+
+    def initialize(landmarks_by_name={})
+      landmarks_by_name.each do |name, landmark|
+        unless LANDMARK_NAMES.include?(name.to_sym)
+          raise "'#{name}' not a valid landmark name."
+        end
+        instance_variable_set("@#{name}", landmark)
+      end
+    end
+  end
+end

data/lib/face_detect/landmark.rb

@@ -0,0 +1,10 @@
+class FaceDetect
+  class Landmark
+    attr_reader :x, :y
+
+    def initialize(x, y)
+      @x = x.to_f
+      @y = y.to_f
+    end
+  end
+end

data/lib/face_detect/version.rb

@@ -0,0 +1,3 @@
+class FaceDetect
+  VERSION = "0.1.0"
+end

data/script/test_google_full.rb

@@ -0,0 +1,19 @@
+# After following the installation steps in the README, run
+#
+#   bundle exec ruby script/test_google_full.rb
+#
+# You can also specify the IMG environment variable as a path to an image if you want to test with something else.
+#
+require 'pp'
+
+require_relative '../lib/face_detect'
+require_relative '../lib/face_detect/adapter/google'
+
+path = ENV['IMG'] || File.expand_path('../spec/fixtures/obama.jpg', __dir__)
+input = File.new(path)
+detector = FaceDetect.new(
+  file: input,
+  adapter: FaceDetect::Adapter::Google
+)
+result = detector.run
+pp result

data/script/test_google_service.rb

@@ -0,0 +1,18 @@
+# After following the installation steps in the README, run
+#
+#   bundle exec ruby script/test_google_adatper.rb
+#
+# You can also specify the IMG environment variable as a path to an image if you want to test with something else.
+#
+require 'json'
+
+require_relative '../lib/face_detect'
+require_relative '../lib/face_detect/adapter/google'
+
+path = ENV['IMG'] || File.expand_path('../spec/fixtures/obama.jpg', __dir__)
+input = File.new(path)
+
+authorization = FaceDetect::Adapter::Google::AuthHelper.authorization
+service = FaceDetect::Adapter::Google::Service.new(authorization, input)
+result = service.run
+puts result.to_json

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: face_detect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Feldman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-01 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: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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: webmock
+  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:
+- aidan.feldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- face_detect.gemspec
+- lib/face_detect.rb
+- lib/face_detect/adapter/google.rb
+- lib/face_detect/adapter/google/auth_helper.rb
+- lib/face_detect/adapter/google/service.rb
+- lib/face_detect/face.rb
+- lib/face_detect/landmark.rb
+- lib/face_detect/version.rb
+- script/test_google_full.rb
+- script/test_google_service.rb
+homepage: https://github.com/afeld/face_detect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Simple face detection
+test_files: []