ruby_face_recognition 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b899c91149dec1631859fab73f3020d15360724e74c804902b4a0e30f45e9c2
+  data.tar.gz: 0de3145d5c735ca74db4a0f33d915b8c20c1c7b252522a89fa9b91904b76c860
+SHA512:
+  metadata.gz: 466bbce79a3416be655661da5c8e06099f79abd35f5214b9d4041ebccac1707d1499cb3d959264bc74907a1fc485114ec691ec4b211d9d20b07a2092d70d17ed
+  data.tar.gz: 8b5ec85e4f3719e4205d05ce4432ec829c5160f00800ee3a45e91643297cb4d06ec4fc97efe668b43de2d03496d2e5d5f41b18220767675130a17430d5b6f67e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

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 rogerluo410@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_face_recognition.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+
+gem 'pycall', '~> 1.4.1'

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    ruby_face_recognition (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    pycall (1.4.1)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pycall (~> 1.4.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  ruby_face_recognition!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 rogerluo410
+
+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,152 @@
+# RubyFaceRecognition
+
+A Ruby wrapper for recognize and manipulate faces.  
+
+## Enables
+
+  * Fetch face encoding.    
+  * Get distance between two face encodings.  
+  * Compare two faces are same person.  
+
+## Dependencies
+
+ - pycall >= 1.4.1, see https://github.com/mrkn/pycall.rb for more.
+
+ - python 3
+    
+  * Install python 3.7 and face recognition
+
+        1) If use `pyenv`, install python with command to load libpython in pycall:
+
+            envPYTHON_CONFIGURE_OPTS="--enable-framework" CFLAGS="-I$(xcrun --show-sdk-path)/usr/include" pyenv install 3.7.0
+
+
+        2) Export LIBPYTHON environment variable:
+
+            export LIBPYTHON="/Users/xxx/.pyenv/versions/3.7.0/lib/libpython3.7m.a"
+
+        3) Install face recognition tool, see https://github.com/ageitgey/face_recognition:
+
+            pip3 install face_recognition
+
+  * Another way for ubuntu
+
+        1) Make install python3 and pip3
+
+        2) Install dlib
+        
+            git clone https://github.com/davisking/dlib.git
+            cd dlib
+            mkdir build; cd build; cmake ..; cmake --build .
+            cd ..
+            python3 setup.py install
+
+        3) Install plugin
+
+            pip3 install face_recognition
+
+ - face_recognition, see https://github.com/ageitgey/face_recognition for more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_face_recognition'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby_face_recognition
+
+## Usage
+
+```ruby
+    require 'ruby_face_recognition'
+
+    # See ./examples folder for images
+    wdz1_doubles = FaceRecognition.fetch_face_encoding('./wdz1.jpeg')
+    wdz2_doubles = FaceRecognition.fetch_face_encoding('./wdz2.jpeg')
+    ycg1_doubles = FaceRecognition.fetch_face_encoding('./ycg1.jpeg')
+    ycg2_doubles = FaceRecognition.fetch_face_encoding('./ycg2.jpeg')
+
+    pp "wdz1 and wdz2 is same: #{FaceRecognition.same_person?(wdz1_doubles,
+                                                            wdz2_doubles)}, tolerant is #{FaceRecognition.get_tolerant(
+                                                                wdz1_doubles, wdz2_doubles
+                                                            )}"
+    pp "wdz1 and ycg1 is same: #{FaceRecognition.same_person?(wdz1_doubles,
+                                                            ycg1_doubles)}, tolerant is #{FaceRecognition.get_tolerant(
+                                                                wdz1_doubles, ycg1_doubles
+                                                            )}"
+    pp "ycg1 and ycg2 is same: #{FaceRecognition.same_person?(ycg1_doubles,
+                                                            ycg2_doubles)}, tolerant is #{FaceRecognition.get_tolerant(
+                                                                ycg1_doubles, ycg2_doubles
+                                                            )}"
+
+    #Output:
+    "wdz1 and wdz2 is same: true, tolerant is 0.31643992115339953"
+    "wdz1 and ycg1 is same: false, tolerant is 1.1141872408732252"
+    "ycg1 and ycg2 is same: true, tolerant is 0.338220706580959"
+
+```
+
+### Use in Rails
+
+Assuming Database is postgresql: 
+
+  - Create field to save face encoding.   
+
+    `add_column :table_name, :column_name, :float, array: true, comment: 'face encoding'`  
+
+  - Create distance function script to Databse.   
+
+    ```ruby
+        class AddDistanceFunctionToDb < ActiveRecord::Migration[6.1]
+            def self.up
+                execute "CREATE OR REPLACE FUNCTION distance(l double precision[], r double precision[]) RETURNS double precision AS $$
+                DECLARE
+                    s double precision;
+                BEGIN
+                    s := 0;
+                    FOR i IN 1..128 LOOP
+                    s := s + power(l[i] - r[i], 2);
+                    END LOOP;
+                    RETURN sqrt(s);
+                END;
+                $$ LANGUAGE plpgsql;"
+            end
+            def self.down
+                execute "drop function distance(l double precision[], r double precision[]) cascade"
+            end
+        end
+
+    ```  
+
+  - Use distance function in SQL  
+
+    ```sql
+       tolerant = ActiveRecord::Base.connection.exec_query("select distance(ARRAY#{face_encoding1}, ARRAY#{face_encoding2})").rows[0][0]
+    ```  
+
+## 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.
+
+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/[USERNAME]/ruby_face_recognition. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby_face_recognition/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubyFaceRecognition project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_face_recognition/blob/master/CODE_OF_CONDUCT.md).

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 "ruby_face_recognition"
+
+# 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(__FILE__)

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/examples/example.rb

@@ -0,0 +1,19 @@
+require 'ruby_face_recognition'
+
+wdz1_doubles = FaceRecognition.fetch_face_encoding('./wdz1.jpeg')
+wdz2_doubles = FaceRecognition.fetch_face_encoding('./wdz2.jpeg')
+ycg1_doubles = FaceRecognition.fetch_face_encoding('./ycg1.jpeg')
+ycg2_doubles = FaceRecognition.fetch_face_encoding('./ycg2.jpeg')
+
+pp "wdz1 and wdz2 is same: #{FaceRecognition.same_person?(wdz1_doubles,
+                                                          wdz2_doubles)}, tolerant is #{FaceRecognition.get_tolerant(
+                                                            wdz1_doubles, wdz2_doubles
+                                                          )}"
+pp "wdz1 and ycg1 is same: #{FaceRecognition.same_person?(wdz1_doubles,
+                                                          ycg1_doubles)}, tolerant is #{FaceRecognition.get_tolerant(
+                                                            wdz1_doubles, ycg1_doubles
+                                                          )}"
+pp "ycg1 and ycg2 is same: #{FaceRecognition.same_person?(ycg1_doubles,
+                                                          ycg2_doubles)}, tolerant is #{FaceRecognition.get_tolerant(
+                                                            ycg1_doubles, ycg2_doubles
+                                                          )}"

data/lib/ruby_face_recognition/ruby_face_recognition.rb

@@ -0,0 +1,46 @@
+require 'pycall'
+require 'pycall/import'
+require 'logger'
+
+PyCall.init('python3')
+
+LOGGER = Logger.new(STDOUT)
+
+# wrapper for face_recognition
+class FaceRecognition
+  class << self
+    def fetch_face_encoding(image_full_path)
+      begin # rubocop:disable Style/RedundantBegin
+        face_recognition = PyCall.import_module('face_recognition') # use python wrap in ruby class domain
+        known_image = face_recognition.load_image_file(image_full_path)
+        face_encoding = face_recognition.face_encodings(known_image)[0]
+        list = face_encoding.tolist() # rubocop:disable Style/MethodCallWithoutArgsParentheses
+        list.to_a
+      rescue PyCall::PyError => e
+        LOGGER.fatal e
+      end
+    end
+
+    def same_person?(l_doubles, r_doubles)
+      raise 'l_doubles must be Array' unless l_doubles.is_a? Array
+      raise 'r_doubles must be Array' unless r_doubles.is_a? Array
+
+      # If the tolerant value less than 0.55, judge they are same person.
+      get_tolerant(l_doubles, r_doubles) < 0.55
+    end
+
+    def get_tolerant(l_doubles, r_doubles)
+      raise 'l_doubles must be Array' unless l_doubles.is_a? Array
+      raise 'r_doubles must be Array' unless r_doubles.is_a? Array
+      raise 'l_doubles must have 128 doubles' unless l_doubles.length == 128
+      raise 'r_doubles must have 128 doubles' unless r_doubles.length == 128
+
+      s = 0
+      (0..127).to_a.each do |i|
+        s += (l_doubles[i] - r_doubles[i]) * 2
+      end
+
+      Math.sqrt(s)
+    end
+  end
+end

data/lib/ruby_face_recognition/version.rb

@@ -0,0 +1,3 @@
+module RubyFaceRecognition
+  VERSION = "0.1.0"
+end

data/lib/ruby_face_recognition.rb

@@ -0,0 +1,2 @@
+require_relative 'ruby_face_recognition/version'
+require_relative 'ruby_face_recognition/ruby_face_recognition'

data/ruby_face_recognition.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/ruby_face_recognition/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_face_recognition'
+  spec.version       = RubyFaceRecognition::VERSION
+  spec.authors       = ['rogerluo410']
+  spec.email         = ['rogerluo410@gmail.com']
+
+  spec.summary       = 'A Ruby wrapper for face recognition.'
+  spec.description   = 'A Ruby wrapper for recognize and manipulate faces.'
+  spec.homepage      = 'https://github.com/rogerluo410/ruby_face_recognition'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rogerluo410/ruby_face_recognition'
+  spec.metadata['changelog_uri'] = 'https://github.com/rogerluo410/ruby_face_recognition'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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']
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ruby_face_recognition
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rogerluo410
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-28 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby wrapper for recognize and manipulate faces.
+email:
+- rogerluo410@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/example.rb
+- examples/wdz1.jpeg
+- examples/wdz2.jpeg
+- examples/ycg1.jpeg
+- examples/ycg2.jpeg
+- lib/ruby_face_recognition.rb
+- lib/ruby_face_recognition/ruby_face_recognition.rb
+- lib/ruby_face_recognition/version.rb
+- ruby_face_recognition.gemspec
+homepage: https://github.com/rogerluo410/ruby_face_recognition
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/rogerluo410/ruby_face_recognition
+  source_code_uri: https://github.com/rogerluo410/ruby_face_recognition
+  changelog_uri: https://github.com/rogerluo410/ruby_face_recognition
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for face recognition.
+test_files: []