feat: add Google Email fetch and OAuth token refresh service (#9603)

This PR adds the following changes

1. Add `Imap::GoogleFetchEmailService` and
`Google::RefreshOauthTokenService`. The
`Google::RefreshOauthTokenService` uses
`OmniAuth::Strategies::GoogleOauth2` which is already added as a packge
2. Update `Inboxes::FetchImapEmailsJob` to handle Google inboxes
3. Add SMTP settings for Google in `ConversationReplyMailerHelper` to
allow sending emails


## Preview

#### Incoming emails

![CleanShot 2024-06-06 at 17 17
22@2x](https://github.com/chatwoot/chatwoot/assets/18097732/9d7d70d1-68e3-4c16-b1ca-e5a2e6f890e8)

#### Outgoing email

![CleanShot 2024-06-06 at 17 18
05@2x](https://github.com/chatwoot/chatwoot/assets/18097732/1b4abf0e-e311-493e-bdc8-386886afbb25)

---------

Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>

app/jobs/inboxes/fetch_imap_emails_job.rb

@@ -30,6 +30,8 @@ class Inboxes::FetchImapEmailsJob < MutexApplicationJob
   def process_email_for_channel(channel, interval)
     inbound_emails = if channel.microsoft?
                        Imap::MicrosoftFetchEmailService.new(channel: channel, interval: interval).perform
+                     elsif channel.google?
+                       Imap::GoogleFetchEmailService.new(channel: channel, interval: interval).perform
                      else
                        Imap::FetchEmailService.new(channel: channel, interval: interval).perform
                      end

app/mailers/conversation_reply_mailer_helper.rb

@@ -14,6 +14,7 @@ module ConversationReplyMailerHelper
       @options[:bcc] = cc_bcc_emails[1]
     end
     ms_smtp_settings
+    google_smtp_settings
     set_delivery_method
 
     Rails.logger.info("Email sent from #{email_from} to #{to_emails} with subject #{mail_subject}")
@@ -23,23 +24,36 @@ module ConversationReplyMailerHelper
 
   private
 
-  def ms_smtp_settings
-    return unless @inbox.email? && @channel.imap_enabled && @inbox.channel.provider == 'microsoft'
+  def google_smtp_settings
+    return unless @inbox.email? && @channel.imap_enabled && @inbox.channel.google?
 
-    smtp_settings = {
-      address: 'smtp.office365.com',
+    smtp_settings = base_smtp_settings('smtp.gmail.com')
+
+    @options[:delivery_method] = :smtp
+    @options[:delivery_method_options] = smtp_settings
+  end
+
+  def ms_smtp_settings
+    return unless @inbox.email? && @channel.imap_enabled && @inbox.channel.microsoft?
+
+    smtp_settings = base_smtp_settings('smtp.office365.com')
+
+    @options[:delivery_method] = :smtp
+    @options[:delivery_method_options] = smtp_settings
+  end
+
+  def base_smtp_settings(domain)
+    {
+      address: domain,
       port: 587,
       user_name: @channel.imap_login,
       password: @channel.provider_config['access_token'],
-      domain: 'smtp.office365.com',
+      domain: domain,
       tls: false,
       enable_starttls_auto: true,
       openssl_verify_mode: 'none',
       authentication: 'xoauth2'
     }
-
-    @options[:delivery_method] = :smtp
-    @options[:delivery_method_options] = smtp_settings
   end
 
   def set_delivery_method
@@ -69,12 +83,12 @@ module ConversationReplyMailerHelper
     @inbox.inbox_type == 'Email' && @channel.imap_enabled
   end
 
-  def email_microsoft_auth_enabled
-    @inbox.inbox_type == 'Email' && @channel.provider == 'microsoft'
+  def email_oauth_enabled
+    @inbox.inbox_type == 'Email' && (@channel.microsoft? || @channel.google?)
   end
 
   def email_from
-    email_microsoft_auth_enabled || email_smtp_enabled ? channel_email_with_name : from_email_with_name
+    email_oauth_enabled || email_smtp_enabled ? channel_email_with_name : from_email_with_name
   end
 
   def email_reply_to

app/services/base_refresh_oauth_token_service.rb

@@ -0,0 +1,62 @@
+class BaseRefreshOauthTokenService
+  pattr_initialize [:channel!]
+
+  # Additional references: https://gitlab.com/gitlab-org/ruby/gems/gitlab-mail_room/-/blob/master/lib/mail_room/microsoft_graph/connection.rb
+  def access_token
+    return provider_config[:access_token] unless access_token_expired?
+
+    refreshed_tokens = refresh_tokens
+    refreshed_tokens[:access_token]
+  end
+
+  def access_token_expired?
+    expiry = provider_config[:expires_on]
+
+    return true if expiry.blank?
+
+    # Adding a 5 minute window to expiry check to avoid any race
+    # conditions during the fetch operation. This would assure that the
+    # tokens are updated when we fetch the emails.
+    Time.current.utc >= DateTime.parse(expiry) - 5.minutes
+  end
+
+  # Refresh the access tokens using the refresh token
+  # Refer: https://github.com/microsoftgraph/msgraph-sample-rubyrailsapp/tree/b4a6869fe4a438cde42b161196484a929f1bee46
+  def refresh_tokens
+    oauth_strategy = build_oauth_strategy
+    token_service = build_token_service(oauth_strategy)
+
+    new_tokens = token_service.refresh!.to_hash.slice(:access_token, :refresh_token, :expires_at)
+
+    update_channel_provider_config(new_tokens)
+    channel.reload.provider_config
+  end
+
+  def update_channel_provider_config(new_tokens)
+    channel.provider_config = {
+      access_token: new_tokens[:access_token],
+      refresh_token: new_tokens[:refresh_token],
+      expires_on: Time.at(new_tokens[:expires_at]).utc.to_s
+    }
+    channel.save!
+  end
+
+  private
+
+  def build_oauth_strategy
+    raise NotImplementedError
+  end
+
+  def provider_config
+    @provider_config ||= channel.provider_config.with_indifferent_access
+  end
+
+  # Builds the token service using OAuth2
+  def build_token_service(oauth_strategy)
+    OAuth2::AccessToken.new(
+      oauth_strategy.client,
+      provider_config[:access_token],
+      refresh_token: provider_config[:refresh_token]
+    )
+  end
+end

app/services/google/refresh_oauth_token_service.rb

@@ -0,0 +1,12 @@
+# Refer: https://learn.microsoft.com/en-us/entra/identity-platform/configurable-token-lifetimes
+class Google::RefreshOauthTokenService < BaseRefreshOauthTokenService
+  private
+
+  # Builds the OAuth strategy for Microsoft Graph
+  def build_oauth_strategy
+    app_id = GlobalConfigService.load('GOOGLE_OAUTH_CLIENT_ID', nil)
+    app_secret = GlobalConfigService.load('GOOGLE_OAUTH_CLIENT_SECRET', nil)
+
+    OmniAuth::Strategies::GoogleOauth2.new(nil, app_id, app_secret)
+  end
+end

app/services/imap/google_fetch_email_service.rb

@@ -0,0 +1,17 @@
+class Imap::GoogleFetchEmailService < Imap::BaseFetchEmailService
+  def fetch_emails
+    return if channel.provider_config['access_token'].blank?
+
+    fetch_mail_for_channel
+  end
+
+  private
+
+  def authentication_type
+    'XOAUTH2'
+  end
+
+  def imap_password
+    Google::RefreshOauthTokenService.new(channel: channel).access_token
+  end
+end

app/services/microsoft/refresh_oauth_token_service.rb

@@ -1,64 +1,9 @@
 # Refer: https://learn.microsoft.com/en-us/entra/identity-platform/configurable-token-lifetimes
-class Microsoft::RefreshOauthTokenService
-  pattr_initialize [:channel!]
-
-  # Additional references: https://gitlab.com/gitlab-org/ruby/gems/gitlab-mail_room/-/blob/master/lib/mail_room/microsoft_graph/connection.rb
-  def access_token
-    return provider_config[:access_token] unless access_token_expired?
-
-    refreshed_tokens = refresh_tokens
-    refreshed_tokens[:access_token]
-  end
-
-  def access_token_expired?
-    expiry = provider_config[:expires_on]
-
-    return true if expiry.blank?
-
-    # Adding a 5 minute window to expiry check to avoid any race
-    # conditions during the fetch operation. This would assure that the
-    # tokens are updated when we fetch the emails.
-    Time.current.utc >= DateTime.parse(expiry) - 5.minutes
-  end
-
-  # Refresh the access tokens using the refresh token
-  # Refer: https://github.com/microsoftgraph/msgraph-sample-rubyrailsapp/tree/b4a6869fe4a438cde42b161196484a929f1bee46
-  def refresh_tokens
-    oauth_strategy = build_oauth_strategy
-    token_service = build_token_service(oauth_strategy)
-
-    new_tokens = token_service.refresh!.to_hash.slice(:access_token, :refresh_token, :expires_at)
-
-    update_channel_provider_config(new_tokens)
-    channel.reload.provider_config
-  end
-
-  def update_channel_provider_config(new_tokens)
-    channel.provider_config = {
-      access_token: new_tokens[:access_token],
-      refresh_token: new_tokens[:refresh_token],
-      expires_on: Time.at(new_tokens[:expires_at]).utc.to_s
-    }
-    channel.save!
-  end
-
+class Microsoft::RefreshOauthTokenService < BaseRefreshOauthTokenService
   private
 
-  def provider_config
-    @provider_config ||= channel.provider_config.with_indifferent_access
-  end
-
   # Builds the OAuth strategy for Microsoft Graph
   def build_oauth_strategy
     ::MicrosoftGraphAuth.new(nil, GlobalConfigService.load('AZURE_APP_ID', ''), GlobalConfigService.load('AZURE_APP_SECRET', ''))
   end
-
-  # Builds the token service using OAuth2
-  def build_token_service(oauth_strategy)
-    OAuth2::AccessToken.new(
-      oauth_strategy.client,
-      provider_config[:access_token],
-      refresh_token: provider_config[:refresh_token]
-    )
-  end
 end

app/views/api/v1/models/_inbox.json.jbuilder

@@ -73,7 +73,7 @@ if resource.email?
     json.imap_enabled resource.channel.try(:imap_enabled)
     json.imap_enable_ssl resource.channel.try(:imap_enable_ssl)
 
-    if resource.channel.try(:microsoft?)
+    if resource.channel.try(:microsoft?) || resource.channel.try(:google?)
       json.reauthorization_required resource.channel.try(:provider_config).empty? || resource.channel.try(:reauthorization_required?)
     end
   end