email_to_face 0.0.3 → 0.0.4

data/README.md

@@ -3,32 +3,82 @@ 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:
 
-	@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' }
+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 Graph API, or if an access token is not passed, the gravatar api will be called.
 
-	@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' }
+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=200' }
+```
 
 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.
 
-	@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 }
+``` 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=200', :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 (about 200 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' }
+```

data/email_to_face.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["jatescher@gmail.com"]
   s.homepage    = "https://github.com/jtescher/EmailToFace"
   s.summary     = %q{ Email to user image tool }
-  s.description = %q{ A way to simply obtain a facebook or gravatar image from an email. }
+  s.description = %q{ A way to simply obtain a Facebook or Gravatar image from an email. }
 
   s.rubyforge_project = "email_to_face"
 

data/lib/email_to_face.rb

@@ -7,8 +7,9 @@ require 'email_to_face/app'
 module EmailToFace
   class Facebook
 
-    def self.init(fb_access_token)
+    def self.init(fb_access_token, facebook_image_type)
       @access_token = fb_access_token
+      @image_type = facebook_image_type
     end
 
     def self.user_image(email)
@@ -31,16 +32,17 @@ module EmailToFace
       raise result["error"]["message"] if result["error"]
 
       # Return either the url, or nil
-      result['data'] == [] ? nil : "https://graph.facebook.com/#{result['data'][0]['id']}/picture?type=large"
+      result['data'] == [] ? nil : "https://graph.facebook.com/#{result['data'][0]['id']}/picture?type=#{@image_type || 'large'}"
     end
 
   end
 
   class Gravatar
 
-    def self.user_image(email)
+    def self.user_image(email, fb_type=nil)
+      fb_types = { 'square' => 50, 'small' => 50, 'normal' => 100, 'large' => 200 }
       begin
-        url = "http://www.gravatar.com/avatar.php?gravatar_id=#{Digest::MD5::hexdigest(email)}&d=404"
+        url = "http://www.gravatar.com/avatar.php?gravatar_id=#{Digest::MD5::hexdigest(email)}&d=404&s=#{fb_types[fb_type] || 200}"
         response = Net::HTTP.get_response(URI.parse(url))
         response.code == '200' ? url : nil
       rescue Exception => e
@@ -53,11 +55,13 @@ module EmailToFace
 
   class FaceAPI
 
-    def self.init(face_api_key, face_api_secret)
+    def self.init(face_api_key, face_api_secret, use_face_for_gravatar)
       @client = Face.get_client(:api_key => face_api_key, :api_secret => face_api_secret)
+      @use_face_for_gravatar = use_face_for_gravatar || false
     end
 
     def self.get_center(url)
+      return if url.match(/gravatar.com/) and @use_face_for_gravatar == false
       begin
         result = @client.faces_detect(:urls => url)
         result['photos'][0]['tags'].empty? ? nil : result['photos'][0]['tags'][0]['center']

data/lib/email_to_face/app.rb

@@ -1,18 +1,20 @@
 module EmailToFace
   class App
-    attr_accessor :fb_init, :face_init
+    attr_accessor :fb_init, :face_init, :fb_type
 
     def initialize(options={})
 
       # Initialize Facebook if params present
       if options[:facebook_user_token]
-        Facebook.init(options[:facebook_user_token])
+
+        Facebook.init(options[:facebook_user_token], options[:facebook_image_type])
         @fb_init = true
+        @fb_type = options[:facebook_image_type]
       end
 
       # Initialize Face.com API if params present
       if options[:face_api_key] and options[:face_api_secret]
-        FaceAPI.init(options[:face_api_key], options[:face_api_secret])
+        FaceAPI.init(options[:face_api_key], options[:face_api_secret], options[:use_face_for_gravatar])
         @face_init = true
       end
     end
@@ -27,15 +29,14 @@ module EmailToFace
 
       # If not found and twitter is initialized
       if image_url.nil?
-        image_url = Gravatar.user_image(email)
+        image_url = Gravatar.user_image(email, @fb_type)
       end
 
       # If still no image found, return nil
       return nil if image_url.nil?
 
       # If present, grab face x,y from face.com
-      if @face_init
-        xy = FaceAPI.get_center(image_url)
+      if @face_init and xy = FaceAPI.get_center(image_url)
         { :url => image_url, :x => xy['x'], :y => xy['y'] }
       else
         { :url => image_url }

data/lib/email_to_face/version.rb

@@ -1,3 +1,3 @@
 module EmailToFace
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/email_to_face/app_spec.rb

@@ -3,17 +3,19 @@ require 'spec_helper'
 describe EmailToFace::App do
   before :all do
     @app = EmailToFace::App.new(
-      :facebook_user_token      => ENV['FB_USER_TOKEN'],
-      :face_api_key             => ENV['FACE_API_KEY'],
-      :face_api_secret          => ENV['FACE_API_SECRET'])
+      :facebook_user_token  => ENV['FB_USER_TOKEN'],
+      :face_api_key         => ENV['FACE_API_KEY'],
+      :face_api_secret      => ENV['FACE_API_SECRET'])
   end
 
   describe "#convert" do
+
     it "should raise an error if email is nil or malformed" do
       expect { @app.convert(nil) } .to raise_error(ArgumentError)
       expect { @app.convert('@email.com') } .to raise_error(ArgumentError)
       expect { @app.convert('good@email.com') } .to_not raise_error(ArgumentError)
     end
+
     context 'for facebook' do
       it "should return an object with a url and center x,y if valid" do
         result = @app.convert("pat2man@gmail.com")
@@ -21,15 +23,41 @@ describe EmailToFace::App do
         result[:x].should == 48.89
         result[:y].should == 42.29
       end
+
+      it "should return a :facebook_image_type facebook image if :facebook_image_type is set" do
+        @app = EmailToFace::App.new(
+          :facebook_user_token  => ENV['FB_USER_TOKEN'],
+          :facebook_image_type  => 'small')
+
+        result = @app.convert("pat2man@gmail.com")
+        result[:url].should == 'https://graph.facebook.com/518026574/picture?type=small'
+      end
     end
+
     context 'for gravatar' do
-      it "should return an object with a url and center x,y if valid" do
+      it "should return an object with a url and center x,y if valid and :use_face_for_gravatar set" do
+         @app = EmailToFace::App.new(
+            :use_face_for_gravatar  => true,
+            :facebook_user_token    => ENV['FB_USER_TOKEN'],
+            :face_api_key           => ENV['FACE_API_KEY'],
+            :face_api_secret        => ENV['FACE_API_SECRET'])
+        result = @app.convert("virulent@gmail.com")
+        result[:url].should == 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=200'
+        result[:x].should == 31.75
+        result[:y].should == 60.75
+      end
+
+      it "should return an object with a url if :use_face_for_gravatar not set" do
+         @app = EmailToFace::App.new(
+            :face_api_key           => ENV['FACE_API_KEY'],
+            :face_api_secret        => ENV['FACE_API_SECRET'])
         result = @app.convert("virulent@gmail.com")
-        result[:url].should == 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404'
-        result[:x].should == 30.63
-        result[:y].should == 60.63
+        result[:url].should == 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=200'
+        result[:x].should be_nil
+        result[:y].should be_nil
       end
     end
+
   end
 
 end

data/spec/lib/email_to_face_spec.rb

@@ -22,12 +22,16 @@ end
 describe EmailToFace::Gravatar do
   describe ".user_image" do
     it "returns the url for the user's image if it exists" do
-      EmailToFace::Gravatar.user_image('virulent@gmail.com').should == 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404'
+      EmailToFace::Gravatar.user_image('virulent@gmail.com').should == 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=200'
     end
 
     it "returns nil if the user does not exist" do
       EmailToFace::Gravatar.user_image('notanemail').should be_nil
     end
+
+    it "returns the proper size if fb_type is set" do
+      EmailToFace::Gravatar.user_image('virulent@gmail.com', 'small').should == 'http://www.gravatar.com/avatar.php?gravatar_id=c44b0f24cfce9aacc7c1969c5666cfae&d=404&s=50'
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: email_to_face
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Julian Tescher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-14 00:00:00 -07:00
+date: 2011-09-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
-description: " A way to simply obtain a facebook or gravatar image from an email. "
+description: " A way to simply obtain a Facebook or Gravatar image from an email. "
 email: 
 - jatescher@gmail.com
 executables: []