omniauth-microsoft_graph 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d89d349bdaa2e7c2d75edf01ef55baa73fb647ec0ce79a6542ad946e84f6cfe4
-  data.tar.gz: 7d1f758e047e86b318f8d71007d3ba5735b771a1075726c49b8a2e95bc7cbdff
+  metadata.gz: 52fd8e2974f69cc1724772712dcc133fb7ac39b5043348702d8da1cc1e6cd96f
+  data.tar.gz: 504e046b7ca25c06306a7526403e1ae9d86f568cfd83983b07b270ca984a7726
 SHA512:
-  metadata.gz: afdcf7236c17dc9a213c64a44b7dc8a81e6ee46bd34696ad3889ef9207066eb46b51a8efe5cf88612975356d8d126b24714f0f0bdf8a4e3fad216eeb26b34b8c
-  data.tar.gz: a6f547877dacd8c7dbfcd1f8299a2fc432de9b1712b2bf74f8ae50326c360b524a790f1b63a1f9803795b51c49ff88ac9e4d2f94572454482dc4972f39334a35
+  metadata.gz: 359a084ad05f7d14463bc7a458dacec43d6563c3fc5a37db931dc08bf91dc652db782e1525567c8d2f921a811687e2295844b3b3d5322f4a5a436e3a020aca87
+  data.tar.gz: 05d76aefd01bc242ba5763fa6041156960f46835e2ddbd69e807b53a9404be558fe79a349addfcfb2c1a50b5e7e40b4b2cb5ff385439e8754e129115a123d691

data/lib/omniauth/microsoft_graph/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module MicrosoftGraph
-    VERSION = "2.0.1"
+    VERSION = "2.1.0"
   end
 end

data/lib/omniauth/strategies/microsoft_graph.rb

@@ -6,6 +6,8 @@ module OmniAuth
       BASE_SCOPE_URL = 'https://graph.microsoft.com/'
       BASE_SCOPES = %w[offline_access openid email profile].freeze
       DEFAULT_SCOPE = 'offline_access openid email profile User.Read'.freeze
+      YAMMER_PROFILE_URL = 'https://www.yammer.com/api/v1/users/current.json'
+      MICROSOFT_GRAPH_PROFILE_URL = 'https://graph.microsoft.com/v1.0/me'
 
       option :name, :microsoft_graph
 
@@ -64,7 +66,7 @@ module OmniAuth
       end
 
       def raw_info
-        @raw_info ||= access_token.get('https://graph.microsoft.com/v1.0/me').parsed
+        @raw_info ||= access_token.get(profile_endpoint).parsed
       end
 
       def callback_url
@@ -73,11 +75,27 @@ module OmniAuth
 
       def custom_build_access_token
         access_token = get_access_token(request)
+        # Get the profile(microsoft graph / yammer) endpoint choice based on returned bearer token
+        @profile_endpoint = determine_profile_endpoint(request)
         access_token
       end
 
       alias build_access_token custom_build_access_token
 
+      def profile_endpoint
+        @profile_endpoint ||= MICROSOFT_GRAPH_PROFILE_URL
+      end
+
+      def determine_profile_endpoint(request)
+        scope = request&.env&.dig('omniauth.params', 'scope')
+
+        if scope&.include?('yammer')
+          YAMMER_PROFILE_URL
+        else
+          MICROSOFT_GRAPH_PROFILE_URL
+        end
+      end
+
       private
 
       def get_access_token(request)

data/spec/omniauth/strategies/microsoft_graph_oauth2_spec.rb

@@ -457,4 +457,82 @@ describe OmniAuth::Strategies::MicrosoftGraph do
       end.to raise_error(OAuth2::Error)
     end
   end
+
+  describe 'Yammer profile endpoint support' do
+    describe '#profile_endpoint' do
+      context 'when no profile endpoint is determined' do
+        it 'defaults to Microsoft Graph profile URL' do
+          expect(subject.profile_endpoint).to eq('https://graph.microsoft.com/v1.0/me')
+        end
+      end
+
+      context 'when profile endpoint is already set' do
+        before { subject.instance_variable_set(:@profile_endpoint, 'https://custom.endpoint.com') }
+
+        it 'returns the previously set endpoint' do
+          expect(subject.profile_endpoint).to eq('https://custom.endpoint.com')
+        end
+      end
+    end
+
+    describe '#determine_profile_endpoint' do
+      let(:request) { double('Request', env: request_env) }
+
+      context 'when scope includes Yammer access_as_user scope' do
+        let(:request_env) { { 'omniauth.params' => { 'scope' => 'https://api.yammer.com/access_as_user' } } }
+
+        it 'returns Yammer profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://www.yammer.com/api/v1/users/current.json')
+        end
+      end
+
+      context 'when scope includes Yammer user_impersonation scope' do
+        let(:request_env) { { 'omniauth.params' => { 'scope' => 'openid profile https://api.yammer.com/user_impersonation' } } }
+
+        it 'returns Yammer profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://www.yammer.com/api/v1/users/current.json')
+        end
+      end
+
+      context 'when scope includes Yammer scope among other scopes' do
+        let(:request_env) { { 'omniauth.params' => { 'scope' => 'offline_access openid email profile https://api.yammer.com/access_as_user User.Read' } } }
+
+        it 'returns Yammer profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://www.yammer.com/api/v1/users/current.json')
+        end
+      end
+
+      context 'when scope includes multiple Yammer scopes' do
+        let(:request_env) { { 'omniauth.params' => { 'scope' => 'openid profile https://api.yammer.com/access_as_user https://api.yammer.com/user_impersonation' } } }
+
+        it 'returns Yammer profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://www.yammer.com/api/v1/users/current.json')
+        end
+      end
+
+      context 'when scope does not include any Yammer scopes' do
+        let(:request_env) { { 'omniauth.params' => { 'scope' => 'openid profile User.Read' } } }
+
+        it 'returns Microsoft Graph profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://graph.microsoft.com/v1.0/me')
+        end
+      end
+
+      context 'when scope is nil' do
+        let(:request_env) { { 'omniauth.params' => { 'scope' => nil } } }
+
+        it 'returns Microsoft Graph profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://graph.microsoft.com/v1.0/me')
+        end
+      end
+
+      context 'when omniauth.params is nil' do
+        let(:request_env) { { 'omniauth.params' => nil } }
+
+        it 'returns Microsoft Graph profile URL' do
+          expect(subject.determine_profile_endpoint(request)).to eq('https://graph.microsoft.com/v1.0/me')
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-microsoft_graph
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Peter Philips
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-02 00:00:00.000000000 Z
+date: 2025-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt