omnicontacts 0.3.4 → 0.3.5

data/lib/omnicontacts/importer/hotmail.rb

@@ -9,21 +9,29 @@ module OmniContacts
 
       attr_reader :auth_host, :authorize_path, :auth_token_path, :scope
 
-      def initialize *args
-        super *args
-        @auth_host = "oauth.live.com"
-        @authorize_path = "/authorize"
-        @scope = "wl.signin, wl.basic, wl.birthday , wl.emails ,wl.contacts_birthday , wl.contacts_photos"
-        @auth_token_path = "/token"
+      def initialize app, client_id, client_secret, options ={}
+        super app, client_id, client_secret, options
+        @auth_host = "login.live.com"
+        @authorize_path = "/oauth20_authorize.srf"
+        @scope = options[:permissions] || "wl.signin, wl.basic, wl.birthday , wl.emails ,wl.contacts_birthday , wl.contacts_photos"
+        @auth_token_path = "/oauth20_token.srf"
         @contacts_host = "apis.live.net"
         @contacts_path = "/v5.0/me/contacts"
+        @self_path = "/v5.0/me"
       end
 
       def fetch_contacts_using_access_token access_token, access_token_secret
+        fetch_current_user(access_token)
         contacts_response = https_get(@contacts_host, @contacts_path, :access_token => access_token)
         contacts_from_response contacts_response
       end
 
+      def fetch_current_user access_token
+        self_response =  https_get(@contacts_host, @self_path, :access_token => access_token)
+        user = current_user self_response
+        set_current_user user
+      end
+
       private
 
       def contacts_from_response response_as_json
@@ -31,10 +39,11 @@ module OmniContacts
         contacts = []
         response['data'].each do |entry|
           # creating nil fields to keep the fields consistent across other networks
-          contact = {:id => nil, :first_name => nil, :last_name => nil, :name => nil, :email => nil, :gender => nil, :birthday => nil, :profile_picture=> nil, :relation => nil}
-          contact[:id] = entry['user_id']
+          contact = {:id => nil, :first_name => nil, :last_name => nil, :name => nil, :email => nil, :gender => nil, :birthday => nil, :profile_picture=> nil, :relation => nil, :email_hashes => []}
+          contact[:id] = entry['user_id'] ? entry['user_id'] : entry['id']
           if valid_email? entry["name"]
             contact[:email] = entry["name"]
+            contact[:first_name], contact[:last_name], contact[:name] = email_to_name(contact[:email])
           else
             contact[:first_name] = normalize_name(entry['first_name'])
             contact[:last_name] = normalize_name(entry['last_name'])
@@ -42,12 +51,34 @@ module OmniContacts
           end
           contact[:birthday] = birthday_format(entry['birth_month'], entry['birth_day'], entry['birth_year'])
           contact[:gender] = entry['gender']
-          contact[:profile_picture] = 'https://apis.live.net/v5.0/' + entry['user_id'] + '/picture' if entry['user_id']
+          contact[:profile_picture] = image_url(entry['user_id'])
+          contact[:email_hashes] = entry['email_hashes']
           contacts << contact if contact[:name] || contact[:first_name]
         end
         contacts
       end
 
+      def parse_email(emails)
+        return nil if emails.nil?
+        emails['account']
+      end
+
+      def current_user me
+        return nil if me.nil?
+        me = JSON.parse(me)
+        email = parse_email(me['emails'])
+        user = {:id => me['id'], :email => email, :name => me['name'], :first_name => me['first_name'],
+                :last_name => me['last_name'], :gender => me['gender'], :profile_picture => image_url(me['id']),
+                :birthday => birthday_format(me['birth_month'], me['birth_day'], me['birth_year'])
+        }
+        user
+      end
+
+
+      def image_url hotmail_id
+        return 'https://apis.live.net/v5.0/' + hotmail_id + '/picture' if hotmail_id
+      end
+
       def escape_windows_format value
         value.gsub(/[\r\s]/, '')
       end

data/lib/omnicontacts/importer/yahoo.rb

@@ -20,11 +20,19 @@ module OmniContacts
 
       def fetch_contacts_from_token_and_verifier auth_token, auth_token_secret, auth_verifier
         (access_token, access_token_secret, guid) = fetch_access_token(auth_token, auth_token_secret, auth_verifier, ['xoauth_yahoo_guid'])
+        fetch_current_user(access_token, access_token_secret, guid)
         contacts_path = "/v1/user/#{guid}/contacts"
-        contacts_response = http_get(@contacts_host, contacts_path, contacts_req_params(access_token, access_token_secret, contacts_path))
+        contacts_response = https_get(@contacts_host, contacts_path, contacts_req_params(access_token, access_token_secret, contacts_path))
         contacts_from_response contacts_response
       end
 
+      def fetch_current_user access_token, access_token_secret, guid
+        self_path = "/v1/user/#{guid}/profile"
+        self_response =  https_get(@contacts_host, self_path, contacts_req_params(access_token, access_token_secret, self_path))
+        user = current_user self_response
+        set_current_user user
+      end
+
       private
 
       def contacts_req_params access_token, access_token_secret, contacts_path
@@ -35,10 +43,9 @@ module OmniContacts
             :oauth_signature_method => 'HMAC-SHA1',
             :oauth_timestamp => timestamp,
             :oauth_token => access_token,
-            :oauth_version => OmniContacts::Authorization::OAuth1::OAUTH_VERSION,
-            :view => 'compact'
+            :oauth_version => OmniContacts::Authorization::OAuth1::OAUTH_VERSION
         }
-        contacts_url = "http://#{@contacts_host}#{contacts_path}"
+        contacts_url = "https://#{@contacts_host}#{contacts_path}"
         params['oauth_signature'] = oauth_signature('GET', contacts_url, params, access_token_secret)
         params
       end
@@ -49,34 +56,120 @@ module OmniContacts
         return contacts unless response['contacts']['contact']
         response['contacts']['contact'].each do |entry|
           # creating nil fields to keep the fields consistent across other networks
-          contact = {:id => nil, :first_name => nil, :last_name => nil, :name => nil, :email => nil, :gender => nil, :birthday => nil, :profile_picture=> nil, :relation => nil}
+          contact = { :id => nil,
+                      :first_name => nil,
+                      :last_name => nil,
+                      :name => nil,
+                      :email => nil,
+                      :gender => nil,
+                      :birthday => nil,
+                      :profile_picture=> nil,
+                      :address_1 => nil,
+                      :address_2 => nil,
+                      :city => nil,
+                      :region => nil,
+                      :postcode => nil,
+                      :relation => nil }
           yahoo_id = nil
           contact[:id] = entry['id'].to_s
           entry['fields'].each do |field|
-            if field['type'] == 'name'
+            case field['type']
+            when 'name'
               contact[:first_name] = normalize_name(field['value']['givenName'])
               contact[:last_name] = normalize_name(field['value']['familyName'])
               contact[:name] = full_name(contact[:first_name],contact[:last_name])
-            end
-            contact[:email] = field['value'] if field['type'] == 'email'
-
-            if field['type'] == 'yahooid'
+            when 'email'
+              contact[:email] = field['value'] if field['type'] == 'email'
+            when 'yahooid'
               yahoo_id = field['value']
+            when 'address'
+              value = field['value']
+              contact[:address_1] = street = value['street']
+              if street.index("\n")
+                parts = street.split("\n")
+                contact[:address_1] = parts.first
+                contact[:address_2] = parts[1..-1].join(', ')
+              end
+              contact[:city] = value['city']
+              contact[:region] = value['stateOrProvince']
+              contact[:postcode] = value['postalCode']
+            when 'birthday'
+              contact[:birthday] = birthday_format(field['value']['month'], field['value']['day'],field['value']['year'])
             end
-
             contact[:first_name], contact[:last_name], contact[:name] = email_to_name(contact[:email]) if contact[:name].nil? && contact[:email]
             # contact[:first_name], contact[:last_name], contact[:name] = email_to_name(yahoo_id) if (yahoo_id && contact[:name].nil? && contact[:email].nil?)
 
-            if field['type'] == 'birthday'
-              contact[:birthday] = birthday_format(field['value']['month'], field['value']['day'],field['value']['year'])
+            if yahoo_id
+              contact[:profile_picture] = image_url(yahoo_id)
+            else
+              contact[:profile_picture] = image_url_from_email(contact[:email])
             end
           end
           contacts << contact if contact[:name]
         end
-        contacts.uniq! {|c| c[:email] || c[:name]}
+        contacts.uniq! {|c| c[:email] || c[:profile_picture] || c[:name]}
         contacts
       end
 
+      def image_url yahoo_id
+        return 'https://img.msg.yahoo.com/avatar.php?yids=' + yahoo_id if yahoo_id
+      end
+
+      def parse_email(emails)
+        return nil if emails.nil?
+        email = nil
+        if emails.is_a?(Hash)
+          if emails.has_key?("primary")
+            email = emails['handle']
+          end
+        elsif emails.is_a?(Array)
+          emails.each do |e|
+            if e.has_key?('primary') && e['primary']
+              email = e['handle']
+              break
+            end
+          end
+        end
+        email
+      end
+
+      def birthday dob
+        return nil if dob.nil?
+        birthday = dob.split('/')
+        return birthday_format(birthday[0], birthday[1], birthday[3]) if birthday.size == 3
+        return birthday_format(birthday[0], birthday[1], nil) if birthday.size == 2
+
+      end
+
+      def gender g
+        return "female" if g == "F"
+        return "male" if g == "M"
+      end
+
+      def my_image img
+        return nil if img.nil?
+        return img['imageUrl']
+      end
+
+      def current_user me
+        return nil if me.nil?
+        me = JSON.parse(me)
+        me = me['profile']
+        email = parse_email(me['emails'])
+        user = {:id => me["guid"], :email => email, :name => full_name(me['givenName'],me['familyName']), :first_name => normalize_name(me['givenName']),
+                :last_name => normalize_name(me['familyName']), :gender => gender(me['gender']), :birthday => birthday(me['birthdate']),
+                :profile_picture => my_image(me['image'])
+               }
+        user
+      end
+
+      #def profile_image_url(guid, access_token, access_token_secret)
+      #  image_path = "/v1/user/#{guid}/profile/image/48x48"
+      #  response = https_get(@contacts_host, image_path, contacts_req_params(access_token, access_token_secret, image_path))
+      #  image_data = JSON.parse(response)
+      #  return image_data['image']['imageUrl'] if image_data['image']
+      #  return nil
+      #end
     end
   end
 end

data/lib/omnicontacts/middleware/base_oauth.rb

@@ -13,7 +13,7 @@ module OmniContacts
 
       def initialize app, options
         @app = app
-        @listening_path = "/contacts/" + class_name
+        @listening_path = MOUNT_PATH + class_name
         @ssl_ca_file = options[:ssl_ca_file]
       end
 
@@ -69,6 +69,10 @@ module OmniContacts
         end
       end
 
+      def set_current_user user
+        @env["omnicontacts.user"] = user
+      end
+
       #  This method rescues executes a block of code and
       #  rescue all exceptions. In case of an exception the 
       #  user is redirected to the failure endpoint.
@@ -83,8 +87,10 @@ module OmniContacts
       end
 
       def handle_error error_type, exception
-        logger << ("Error #{error_type} while processing #{@env["PATH_INFO"]}: #{exception.message}") if logger
-        [302, {"Content-Type" => "text/html", "location" => "/contacts/failure?error_message=#{error_type}&importer=#{class_name}"}, []]
+        logger.puts("Error #{error_type} while processing #{@env["PATH_INFO"]}: #{exception.message}") if logger
+        failure_url = "#{ MOUNT_PATH }failure?error_message=#{error_type}&importer=#{class_name}"
+        target_url = append_state_query(failure_url)
+        [302, {"Content-Type" => "text/html", "location" => target_url}, []]
       end
 
       def session
@@ -100,6 +106,15 @@ module OmniContacts
         "omnicontacts." + class_name
       end
 
+      def append_state_query(target_url)
+        state = Rack::Utils.parse_query(@env['QUERY_STRING'])['state']
+
+        unless state.nil?
+          target_url = target_url + (target_url.include?("?")?"&":"?") + 'state=' + state
+        end
+
+        return target_url
+      end
     end
   end
 end

data/lib/omnicontacts/middleware/oauth1.rb

@@ -18,7 +18,7 @@ module OmniContacts
         super app, options
         @consumer_key = consumer_key
         @consumer_secret = consumer_secret
-        @callback_path = options[:callback_path] || "/contacts/#{class_name}/callback"
+        @callback_path = options[:callback_path] || "#{ MOUNT_PATH }#{class_name}/callback"
         @token_prop_name = "#{base_prop_name}.oauth_token"
       end
 
@@ -43,7 +43,9 @@ module OmniContacts
       end
 
       def redirect_to_authorization_site auth_token
-        [302, {"Content-Type" => "application/x-www-form-urlencoded", "location" => authorization_url(auth_token)}, []]
+        authorization_url = authorization_url(auth_token)
+        target_url = append_state_query(authorization_url)
+        [302, {"Content-Type" => "application/x-www-form-urlencoded", "location" => target_url}, []]
       end
 
       # Parses the authorization token from the query string and 

data/lib/omnicontacts/middleware/oauth2.rb

@@ -19,12 +19,13 @@ module OmniContacts
         super app, options
         @client_id = client_id
         @client_secret = client_secret
-        @redirect_path = options[:redirect_path] || "/contacts/#{class_name}/callback"
+        @redirect_path = options[:redirect_path] || "#{ MOUNT_PATH }#{class_name}/callback"
         @ssl_ca_file = options[:ssl_ca_file]
       end
 
       def request_authorization_from_user
-        [302, {"Content-Type" => "application/x-www-form-urlencoded", "location" => authorization_url}, []]
+        target_url = append_state_query(authorization_url)
+        [302, {"location" => target_url}, []]
       end
 
       def redirect_uri

data/lib/omnicontacts/parse_utils.rb

@@ -12,7 +12,6 @@ module OmniContacts
     def normalize_name name
       return nil if name.nil?
       name.chomp!
-      name = name.split(' ').map(&:capitalize).join(' ')
       name.squeeze!(' ')
       name.strip!
       return name
@@ -38,5 +37,20 @@ module OmniContacts
       return username, nil, username
     end
 
+    # create an image_url from a gmail or yahoo email id.
+    def image_url_from_email email
+      return nil if email.nil? || !email.include?('@')
+      username, domain = *(email.split('@'))
+      return nil if username.nil? or domain.nil?
+      gmail_base_url = "https://profiles.google.com/s2/photos/profile/"
+      yahoo_base_url = "https://img.msg.yahoo.com/avatar.php?yids="
+      if domain.include?('gmail')
+        image_url = gmail_base_url + username
+      elsif domain.include?('yahoo')
+        image_url = yahoo_base_url + username
+      end
+      image_url
+    end
+
   end
 end

data/omnicontacts.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/omnicontacts', __FILE__)
 Gem::Specification.new do |gem|
   gem.name = 'omnicontacts'
   gem.description = %q{A generalized Rack middleware for importing contacts from major email providers.}
-  gem.authors = ['Diego Castorina']
-  gem.email = ['diegocastorina@gmail.com']
+  gem.authors = ['Diego Castorina', 'Jordan Lance']
+  gem.email = ['diegocastorina@gmail.com', 'voorruby@gmail.com']
 
   gem.add_runtime_dependency 'rack'
   gem.add_runtime_dependency 'json'

data/spec/omnicontacts/authorization/oauth1_spec.rb

@@ -76,7 +76,7 @@ describe OmniContacts::Authorization::OAuth1 do
   end
 
   describe "oauth_signature" do
-    subject { test_target.oauth_signature("GET", "http://social.yahooapis.com/v1/user", {:name => "diego", :surname => "castorina"}, "secret2") }
-    it { should eq("ZqWoQISWcuz%2FSDnDxWihtsFDKwc%3D") }
+    subject { test_target.oauth_signature("GET", "https://social.yahooapis.com/v1/user", {:name => "diego", :surname => "castorina"}, "secret2") }
+    it { should eq("xfumZoyVYUbHXSAafdha3HZUqQg%3D") }
   end
 end

data/spec/omnicontacts/http_utils_spec.rb

@@ -12,6 +12,12 @@ describe OmniContacts::HTTPUtils do
         result.should eq("surname=doe&name=john")
       end
     end
+
+    it "should work for integer values in the map" do
+      result = OmniContacts::HTTPUtils.to_query_string(:client_id => 1234, :secret => "1234HJL8")
+      result.should eq("client_id=1234&secret=1234HJL8")
+    end
+
   end
 
   describe "encode" do

data/spec/omnicontacts/importer/facebook_spec.rb

@@ -5,6 +5,33 @@ describe OmniContacts::Importer::Facebook do
 
   let(:facebook) { OmniContacts::Importer::Facebook.new({}, "client_id", "client_secret") }
 
+  let(:self_response) {
+    '{
+        "first_name":"Chris",
+        "last_name":"Johnson",
+        "name":"Chris Johnson",
+        "id":"543216789",
+        "gender":"male",
+        "birthday":"06/21/1982",
+        "significant_other":{"id": "243435322"},
+        "relationship_status": "Married",
+        "picture":{"data":{"url":"http://profile.ak.fbcdn.net/hprofile-ak-snc6/186364_543216789_2089044200_q.jpg","is_silhouette":false}},
+        "email": "chrisjohnson@gmail.com"
+    }'
+  }
+
+  let(:spouse_response) {
+    '{
+        "first_name":"Mary",
+        "last_name":"Johnson",
+        "name":"Mary Johnson",
+        "id":"243435322",
+        "gender":"female",
+        "birthday":"01/21",
+        "picture":{"data":{"url":"http://profile.ak.fbcdn.net/hprofile-ak-snc6/186364_243435322_2089044200_q.jpg","is_silhouette":false}}
+    }'
+  }
+
   let(:contacts_as_json) {
     '{"data":[
         {
@@ -24,23 +51,39 @@ describe OmniContacts::Importer::Facebook do
     let(:token) { "token" }
     let(:token_type) { "token_type" }
 
+    before(:each) do
+      facebook.instance_variable_set(:@env, {})
+    end
 
-    it "should request the contacts by providing the token in the url and fields params only for family and friends requests" do
+    it "should request the contacts by providing the token in the url" do
+      facebook.should_receive(:https_get) do |host, self_path, params, headers|
+        params[:access_token].should eq(token)
+        params[:fields].should eq('first_name,last_name,name,id,gender,birthday,picture,relationship_status,significant_other,email')
+        self_response
+      end
+      facebook.should_receive(:https_get) do |host, spouse_path, params, headers|
+        params[:access_token].should eq(token)
+        params[:fields].should eq('first_name,last_name,name,id,gender,birthday,picture')
+        spouse_response
+      end
       facebook.should_receive(:https_get) do |host, path, params, headers|
         params[:access_token].should eq(token)
-        params[:fields].should be_nil
+        params[:fields].should eq('first_name,last_name,name,id,gender,birthday,picture,relationship')
         contacts_as_json
-      end
+      end.exactly(1).times
       facebook.should_receive(:https_get) do |host, path, params, headers|
         params[:access_token].should eq(token)
         params[:fields].should eq('first_name,last_name,name,id,gender,birthday,picture')
         contacts_as_json
-      end.at_most(2).times
+      end.exactly(1).times
+
       facebook.fetch_contacts_using_access_token token, token_type
     end
 
     it "should correctly parse id, name,email,gender, birthday, profile picture and relation" do
-      3.times { facebook.should_receive(:https_get).and_return(contacts_as_json) }
+      1.times { facebook.should_receive(:https_get).and_return(self_response) }
+      1.times { facebook.should_receive(:https_get) }
+      2.times { facebook.should_receive(:https_get).and_return(contacts_as_json) }
       result = facebook.fetch_contacts_using_access_token token, token_type
       result.size.should be(1)
       result.first[:id].should eq('608061886')
@@ -50,9 +93,28 @@ describe OmniContacts::Importer::Facebook do
       result.first[:email].should be_nil
       result.first[:gender].should eq('male')
       result.first[:birthday].should eq({:day=>21, :month=>06, :year=>nil})
-      result.first[:profile_picture].should eq('http://profile.ak.fbcdn.net/hprofile-ak-snc6/186364_608061886_2089044200_q.jpg')
+      result.first[:profile_picture].should eq('https://graph.facebook.com/608061886/picture')
       result.first[:relation].should eq('cousin')
     end
+
+    it "should correctly parse and set logged in user information" do
+      1.times { facebook.should_receive(:https_get).and_return(self_response) }
+      1.times { facebook.should_receive(:https_get) }
+      2.times { facebook.should_receive(:https_get).and_return(contacts_as_json) }
+
+      facebook.fetch_contacts_using_access_token token, token_type
+
+      user = facebook.instance_variable_get(:@env)["omnicontacts.user"]
+      user.should_not be_nil
+      user[:id].should eq("543216789")
+      user[:first_name].should eq("Chris")
+      user[:last_name].should eq("Johnson")
+      user[:name].should eq("Chris Johnson")
+      user[:email].should eq("chrisjohnson@gmail.com")
+      user[:gender].should eq("male")
+      user[:birthday].should eq({:day=>21, :month=>06, :year=>1982})
+      user[:profile_picture].should eq("https://graph.facebook.com/543216789/picture")
+    end
   end
 
 end