Fetch email address from LinkedIn API

Author: pjg

lib/omniauth/strategies/linkedin.rb

@@ -3,32 +3,24 @@
 module OmniAuth
   module Strategies
     class LinkedIn < OmniAuth::Strategies::OAuth2
-      # Give your strategy a name.
       option :name, 'linkedin'
 
-      # This is where you pass the options you would pass when
-      # initializing your consumer from the OAuth gem.
       option :client_options, {
         :site => 'https://api.linkedin.com',
         :authorize_url => 'https://www.linkedin.com/oauth/v2/authorization?response_type=code',
         :token_url => 'https://www.linkedin.com/oauth/v2/accessToken'
       }
 
       option :scope, 'r_liteprofile r_emailaddress'
-      option :fields, ['id', 'first-name', 'last-name', 'picture-url']
+      option :fields, ['id', 'first-name', 'last-name', 'picture-url', 'email-address']
 
-      # These are called after authentication has succeeded. If
-      # possible, you should try to set the UID without making
-      # additional calls (if the user id is returned with the token
-      # or as a URI parameter). This may not be possible with all
-      # providers.
       uid do
         raw_info['id']
       end
 
       info do
         {
-          :email => nil,
+          :email => email_address,
           :first_name => localized_field('firstName'),
           :last_name => localized_field('lastName'),
           :picture_url => picture_url
@@ -60,6 +52,30 @@ def raw_info
 
       private
 
+      def email_address
+        if options.fields.include? 'email-address'
+          fetch_email_address
+          parse_email_address
+        end
+      end
+
+      def fetch_email_address
+        @email_address_response ||= access_token.get(email_address_endpoint).parsed
+      end
+
+      def parse_email_address
+        return unless email_address_available?
+
+        @email_address_response['elements'].first['handle~']['emailAddress']
+      end
+
+      def email_address_available?
+        @email_address_response['elements'] &&
+          @email_address_response['elements'].is_a?(Array) &&
+          @email_address_response['elements'].first &&
+          @email_address_response['elements'].first['handle~']
+      end
+
       def fields_mapping
         {
           'id' => 'id',
@@ -71,7 +87,7 @@ def fields_mapping
 
       def fields
         options.fields.each.with_object([]) do |field, result|
-          result << fields_mapping[field]
+          result << fields_mapping[field] if fields_mapping.has_key? field
         end
       end
 
@@ -106,6 +122,10 @@ def picture_references
         raw_info['profilePicture']['displayImage~']['elements']
       end
 
+      def email_address_endpoint
+        '/v2/emailAddress?q=members&projection=(elements*(handle~))'
+      end
+
       def profile_endpoint
         "/v2/me?projection=(#{ fields.join(',') })"
       end

spec/omniauth/strategies/linkedin_spec.rb

@@ -38,16 +38,36 @@
     end
   end
 
-  describe '#info' do
+  describe '#info / #raw_info' do
+    let(:access_token) { instance_double OAuth2::AccessToken }
+
+    let(:parsed_response) { Hash[:foo => 'bar'] }
+
+    let(:profile_endpoint) { '/v2/me?projection=(id,firstName,lastName,profilePicture(displayImage~:playableStreams))' }
+    let(:email_address_endpoint) { '/v2/emailAddress?q=members&projection=(elements*(handle~))' }
+
+    let(:email_address_response) { instance_double OAuth2::Response, parsed: parsed_response }
+    let(:profile_response) { instance_double OAuth2::Response, parsed: parsed_response }
+
     before :each do
-      allow(subject).to receive(:raw_info) { {} }
+      allow(subject).to receive(:access_token).and_return access_token
+
+      allow(access_token).to receive(:get)
+        .with(email_address_endpoint)
+        .and_return(email_address_response)
+
+      allow(access_token).to receive(:get)
+        .with(profile_endpoint)
+        .and_return(profile_response)
     end
 
-    context 'and therefore has all the necessary fields' do
-      specify { expect(subject.info).to have_key :email }
-      specify { expect(subject.info).to have_key :first_name }
-      specify { expect(subject.info).to have_key :last_name }
-      specify { expect(subject.info).to have_key :picture_url }
+    it 'returns parsed responses using access token' do
+      expect(subject.info).to have_key :email
+      expect(subject.info).to have_key :first_name
+      expect(subject.info).to have_key :last_name
+      expect(subject.info).to have_key :picture_url
+
+      expect(subject.raw_info).to eq({ :foo => 'bar' })
     end
   end
 
@@ -78,25 +98,6 @@
     specify { expect(subject.access_token.expires_at).to eq expires_at }
   end
 
-  describe '#raw_info' do
-    let(:access_token) { instance_double OAuth2::AccessToken }
-    let(:parsed_response) { Hash[:foo => 'bar'] }
-    let(:response) { instance_double OAuth2::Response, parsed: parsed_response }
-    let(:profile_endpoint) { '/v2/me?projection=(id,firstName,lastName,profilePicture(displayImage~:playableStreams))' }
-
-    before :each do
-      allow(subject).to receive(:access_token).and_return access_token
-
-      expect(access_token).to receive(:get)
-        .with(profile_endpoint)
-        .and_return(response)
-    end
-
-    it 'returns parsed response from the access token' do
-      expect(subject.raw_info).to eq({ :foo => 'bar' })
-    end
-  end
-
   describe '#authorize_params' do
     describe 'scope' do
       before :each do