EmailToFace

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 18 Open GitHub ↗

A way to simply obtain a Facebook or Gravatar image from an email

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

EmailToFace
====

Installation
---

Easy:

[sudo|rvm] gem install email_to_face

Using Bundler:

gem "email_to_face"

Facebok Graph API
----

The Graph API is the simple, slick new interface to Facebook's data.  Using it to get a user image with EmailToFace is quite straightforward.
See [developers.facebook.com/docs/authentication/](https://developers.facebook.com/docs/authentication/) for more information on obtaining access tokens.

``` ruby
@email_to_face = EmailToFace::App.new(:facebook_user_token => oauth_access_token)
@email_to_face.convert('user@email.com')
=> { :url => 'https://graph.facebook.com/111111111/picture?type=large' }
```

Gravatar
----

If the user is not found via the Facebook Graph API, or if an access token is not passed, the Gravatar API will be called.

``` ruby
@email_to_face = EmailToFace::App.new()
@email_to_face.convert('user@email.com')
=> { :url => 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=180' }
```

Face.com
----

If face.com credentials are passed, the convert method will return the location of the users's face in the image.
See [developers.face.com](http://developers.face.com/) for more information.

``` ruby
@email_to_face = EmailToFace::App.new(
	:facebook_user_token => oauth_access_token,
	:face_api_key 		 => key,
	:face_api_secret 	 => secret)

@email_to_face.convert('user@email.com')
=> { :url => 'https://graph.facebook.com/111111111/picture?type=large', :x => 48.89, :y => 38.1 }
```

Optional settings
----

By default Gravatar always returns square centered images. If you want to use face.com to find the center of the face anyway, you can use the `:use_face_for_gravatar` option (default is false):

``` ruby
@email_to_face = EmailToFace::App.new(
	:use_face_for_gravatar 	=> true,
	:face_api_key			=> key,
	:face_api_secret		=> secret)

@email_to_face.convert('user@email.com')
=> { :url => 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=180', :x => 48.89, :y => 38.1 }
```

The Facebook Graph API lets you specify the picture size you want with the type argument, which should be one of square (50x50), small (50 pixels wide, variable height), normal (100 pixels wide, variable height), and large (180 pixels wide, variable height). You can assign this via the `:facebook_image_type` option (default is 'large', Gravatar will match):

``` ruby
@email_to_face = EmailToFace::App.new(
	:facebook_image_type => 'small'
	:facebook_user_token => oauth_access_token
	:)

@email_to_face.convert('facebook@email.com')
=> { :url => 'https://graph.facebook.com/111111111/picture?type=small' }

@email_to_face.convert('gravatar@email.com')
=> { :url => 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=50' }
```

EmailToFace

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README