Findface

By Rubyeffect.

This is a ruby gem to provide easy implementation of utilities of FindFace Cloud API. The FindFace Cloud API offers integration with a face detection, verification, and identification platform. This API enables face comparison, and human detection with coordinates and sizes. REST calls are supported with JSON responses and Token-Based HTTP authentication. FindFace is a Cyprus based software development firm.

Installation

Add this line to your application's Gemfile:

gem 'findface'

And then execute:

$ bundle

Or install it yourself as:

$ gem install findface

Usage

The details on usage of "findface" gem are present at: http://blog.rubyeffect.com/category/findface/. If you wish to see Findface's API documentation, please visit the url: https://findface.pro/en/docs.html

1. Add gem to your application’s Gemfile

   gem 'findface'

2. Set the API key in initializer file by creating it (config/initializers/findface.rb)

   Findface.api_key = 'YOUR-API-KEY'

3. Start using the gem 🙂

Documentation

1. Findface Gem Introduction
2. Findface Face Module Endpoints
3. Findface Gallery Module Endpoints
4. Findface Utility Module Endpoints
5. Findface Gem – Endpoints supporting Paginated results

TODO

1. Addition of any new endpoints with respect to Findface Cloud API latest changelog.
2. Support for ruby versions < 2.2.2 .
3. Writing more test cases.

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.

Running tests

To the run tests get key from https://saas.findface.pro/account/dashboard then run:

$ env FINDFACE_API_KEY='<YOUR-API-KEY>' rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/findface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Authored by

Sandeep Mallela a.k.a Sam (sandeep@rubyeffect.com)

About RubyEffect

RubyEffect builds intuitive, live and elegant software that solves real world problems. We love open source and it's community.

Liked this gem? You may also like the articles we post on our blog. Please do check

We would love to work on your ideas and see them grow. Say hello @ http://rubyeffect.com/contact