fastlane-plugin-firebase_app_distribution 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c1ecfa3d259597531bf5d000974d70de8f91aaf2e530f4b277f9382627bb27c
-  data.tar.gz: 64de62eea1701401a75adee5b412970e6bc3abb14964ad9f4fc7a57ce74d03e6
+  metadata.gz: 745bfb3dfc4c6c48f389c8e4d75b50026cf37e872ce26e7510aefef049280329
+  data.tar.gz: 8122801b30f95422216c9c5343d102bc6b11fbc16308f268515e7a3405bbf070
 SHA512:
-  metadata.gz: 01423717bdd9b128f047b81c3e91072067441aeb0378b27e45b72af59f4387bb37d40144f2d082f1608bcf59f709bae0feefa9fcdba490873e679fff9898dca2
-  data.tar.gz: 02d60865da2daee4b649bcebe14c35f64eaba2c8fd09f4ebd21d3099632779492d81eeac454697052db836ba63425f68ef7a1a59656d6f915b14a36a57cc2096
+  metadata.gz: 6ac42a57fdbda601b6ef2656a7e0d1b38304f022a26c970a75f1e0a43d01f2607f993c5500bceaf8ffb5b24ada6fbcbcb1ccf84d7dc8d87dc7d62049561d7886
+  data.tar.gz: ae12197e0149e187b02716e28a71207cd5ce67d14ea331bb9c230e41a53237e1c3e4359b1178f09bf059ac2d9697cb4b667d358a1d4751a3b47006efcaf131bb

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb

@@ -11,6 +11,10 @@ require_relative '../helper/firebase_app_distribution_auth_client'
 ## How should we document the usage of release notes?
 module Fastlane
   module Actions
+    module SharedValues
+      FIREBASE_APP_DISTRO_RELEASE ||= :FIREBASE_APP_DISTRO_RELEASE
+    end
+
     class FirebaseAppDistributionAction < Action
       extend Auth::FirebaseAppDistributionAuthClient
       extend Helper::FirebaseAppDistributionHelper
@@ -48,6 +52,7 @@ module Fastlane
 
         upload_status_response = fad_api_client.upload(app_name, binary_path, platform.to_s, upload_timeout)
         release_name = upload_status_response.release_name
+        release = upload_status_response.release
 
         if binary_type == :AAB && aab_info && !aab_info.certs_provided?
           updated_aab_info = fad_api_client.get_aab_info(app_name)
@@ -62,14 +67,19 @@ module Fastlane
           end
         end
 
-        fad_api_client.update_release_notes(release_name, release_notes(params))
+        release_notes = release_notes(params)
+        if release_notes.nil? || release_notes.empty?
+          UI.message("⏩ No release notes passed in. Skipping this step.")
+        else
+          release = fad_api_client.update_release_notes(release_name, release_notes)
+        end
 
         testers = get_value_from_value_or_file(params[:testers], params[:testers_file])
         groups = get_value_from_value_or_file(params[:groups], params[:groups_file])
         emails = string_to_array(testers)
         group_aliases = string_to_array(groups)
         fad_api_client.distribute(release_name, emails, group_aliases)
-        UI.success("🎉 App Distribution upload finished successfully.")
+        UI.success("🎉 App Distribution upload finished successfully. Setting Actions.lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] to the uploaded release.")
 
         if upload_status_response.firebase_console_uri
           UI.message("🔗 View this release in the Firebase console: #{upload_status_response.firebase_console_uri}")
@@ -82,6 +92,9 @@ module Fastlane
         if upload_status_response.binary_download_uri
           UI.message("🔗 Download the release binary (link expires in 1 hour): #{upload_status_response.binary_download_uri}")
         end
+
+        Actions.lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE] = release
+        release
       end
 
       def self.description
@@ -256,7 +269,7 @@ module Fastlane
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
+                                       description: "Auth token generated using the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :debug,
@@ -294,6 +307,12 @@ module Fastlane
           CODE
         ]
       end
+
+      def self.output
+        [
+          ['FIREBASE_APP_DISTRO_RELEASE', 'A hash representing the uploaded release created in Firebase App Distribution']
+        ]
+      end
     end
   end
 end

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb

@@ -71,7 +71,7 @@ module Fastlane
                                       optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
+                                       description: "Auth token generated using the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :debug,

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_latest_release.rb

@@ -5,6 +5,9 @@ require_relative '../helper/firebase_app_distribution_helper'
 
 module Fastlane
   module Actions
+    module SharedValues
+      FIREBASE_APP_DISTRO_LATEST_RELEASE ||= :FIREBASE_APP_DISTRO_LATEST_RELEASE
+    end
     class FirebaseAppDistributionGetLatestReleaseAction < Action
       extend Auth::FirebaseAppDistributionAuthClient
       extend Helper::FirebaseAppDistributionHelper
@@ -18,12 +21,12 @@ module Fastlane
         releases = fad_api_client.list_releases(app_name_from_app_id(params[:app]), 1)[:releases] || []
         if releases.empty?
           latest_release = nil
-          UI.important("No releases for app #{params[:app]} found in App Distribution. Returning nil and setting Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE].")
+          UI.important("No releases for app #{params[:app]} found in App Distribution. Returning nil and setting Actions.lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE].")
         else
           latest_release = releases[0]
-          UI.success("✅ Latest release fetched successfully. Returning release and setting Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE].")
+          UI.success("✅ Latest release fetched successfully. Returning release and setting Actions.lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE].")
         end
-        Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE] = latest_release
+        Actions.lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE] = latest_release
         return latest_release
       end
 
@@ -49,7 +52,7 @@ module Fastlane
                                        optional: false,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
+                                       description: "Auth token generated using Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :service_credentials_file,

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_udids.rb

@@ -63,7 +63,7 @@ module Fastlane
                                        optional: false,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
+                                       description: "Auth token generated using the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :service_credentials_file,

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_remove_testers_action.rb

@@ -68,7 +68,7 @@ module Fastlane
                                       optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
+                                       description: "Auth token generated using the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :debug,

data/lib/fastlane/plugin/firebase_app_distribution/client/firebase_app_distribution_api_client.rb

@@ -1,5 +1,4 @@
 require 'fastlane_core/ui/ui'
-require_relative '../actions/firebase_app_distribution_login'
 require_relative '../client/error_response'
 require_relative '../client/aab_info'
 require_relative '../helper/firebase_app_distribution_helper'
@@ -59,29 +58,26 @@ module Fastlane
       #   release_name - App release resource name, returned by upload_status endpoint
       #   release_notes - String of notes for this release
       #
+      # Returns a hash of the release
+      #
       # Throws a user_error if the release_notes are invalid
       def update_release_notes(release_name, release_notes)
-        if release_notes.nil? || release_notes.empty?
-          UI.success("✅ No release notes passed in. Skipping this step.")
-          return
-        end
-        begin
-          payload = {
-            name: release_name,
-            releaseNotes: {
-              text: release_notes
-            }
+        payload = {
+          name: release_name,
+          releaseNotes: {
+            text: release_notes
           }
-          connection.patch(update_release_notes_url(release_name), payload.to_json) do |request|
-            request.headers[AUTHORIZATION] = "Bearer " + @auth_token
-            request.headers[CONTENT_TYPE] = APPLICATION_JSON
-            request.headers[CLIENT_VERSION] = client_version_header_value
-          end
-        rescue Faraday::ClientError => e
-          error = ErrorResponse.new(e.response)
-          UI.user_error!("#{ErrorMessage::INVALID_RELEASE_NOTES}: #{error.message}")
+        }
+        response = connection.patch(update_release_notes_url(release_name), payload.to_json) do |request|
+          request.headers[AUTHORIZATION] = "Bearer " + @auth_token
+          request.headers[CONTENT_TYPE] = APPLICATION_JSON
+          request.headers[CLIENT_VERSION] = client_version_header_value
         end
         UI.success("✅ Posted release notes.")
+        response.body
+      rescue Faraday::ClientError => e
+        error = ErrorResponse.new(e.response)
+        UI.user_error!("#{ErrorMessage::INVALID_RELEASE_NOTES}: #{error.message}")
       end
 
       # Get AAB info (Android apps only)
@@ -136,7 +132,7 @@ module Fastlane
       #   binary_path - Absolute path to your app's aab/apk/ipa file
       #   timeout - The amount of seconds before the upload will timeout, if not completed
       #
-      # Returns the release_name of the uploaded release.
+      # Returns a `UploadStatusResponse` with the upload is complete.
       #
       # Crashes if the number of polling retries exceeds MAX_POLLING_RETRIES or if the binary cannot
       # be uploaded.

data/lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_auth_client.rb

@@ -6,6 +6,12 @@ module Fastlane
       TOKEN_CREDENTIAL_URI = "https://oauth2.googleapis.com/token"
       REDACTION_EXPOSED_LENGTH = 5
       REDACTION_CHARACTER = "X"
+      SCOPE = "https://www.googleapis.com/auth/cloud-platform"
+
+      # In this type of application, the client secret is not treated as a secret.
+      # See: https://developers.google.com/identity/protocols/OAuth2InstalledApp
+      CLIENT_ID = "563584335869-fgrhgmd47bqnekij5i8b5pr03ho849e6.apps.googleusercontent.com"
+      CLIENT_SECRET = "j9iVZfS8kkCEFUPaAeJV0sAi"
 
       # Returns the auth token for any of the auth methods (Firebase CLI token,
       # Google service account, firebase-tools). To ensure that a specific
@@ -13,8 +19,7 @@ module Fastlane
       #
       # args
       #   google_service_path - Absolute path to the Google service account file
-      #   firebase_cli_token - Firebase CLI refresh token from login action or
-      #                        CI environment
+      #   firebase_cli_token - Refresh token
       #   debug - Whether to enable debug-level logging
       #
       # env variables
@@ -74,8 +79,8 @@ module Fastlane
       def firebase_token(refresh_token, debug)
         client = Signet::OAuth2::Client.new(
           token_credential_uri: TOKEN_CREDENTIAL_URI,
-          client_id: Fastlane::Actions::FirebaseAppDistributionLoginAction::CLIENT_ID,
-          client_secret: Fastlane::Actions::FirebaseAppDistributionLoginAction::CLIENT_SECRET,
+          client_id: CLIENT_ID,
+          client_secret: CLIENT_SECRET,
           refresh_token: refresh_token
         )
         client.fetch_access_token!
@@ -94,7 +99,7 @@ module Fastlane
       def service_account(google_service_path, debug)
         service_account_credentials = Google::Auth::ServiceAccountCredentials.make_creds(
           json_key_io: File.open(google_service_path),
-          scope: Fastlane::Actions::FirebaseAppDistributionLoginAction::SCOPE
+          scope: SCOPE
         )
         service_account_credentials.fetch_access_token!["access_token"]
       rescue Errno::ENOENT

data/lib/fastlane/plugin/firebase_app_distribution/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-firebase_app_distribution
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Stefan Natchev
 - Manny Jimenez
 - Alonso Salas Infante
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -138,7 +138,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.127.1
-description:
+description: 
 email:
 - snatchev@google.com
 - mannyjimenez@google.com
@@ -155,7 +155,6 @@ files:
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_latest_release.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_udids.rb
-- lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_login.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_remove_testers_action.rb
 - lib/fastlane/plugin/firebase_app_distribution/client/aab_info.rb
 - lib/fastlane/plugin/firebase_app_distribution/client/error_response.rb
@@ -169,7 +168,7 @@ homepage: https://github.com/fastlane/fastlane-plugin-firebase_app_distribution
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.4.6
+signing_key: 
 specification_version: 4
 summary: Release your beta builds to Firebase App Distribution. https://firebase.google.com/docs/app-distribution
 test_files: []

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_login.rb

@@ -1,121 +0,0 @@
-require 'googleauth'
-require "fileutils"
-
-module Fastlane
-  module Actions
-    class FirebaseAppDistributionLoginAction < Action
-      SCOPE = "https://www.googleapis.com/auth/cloud-platform"
-
-      # In this type of application, the client secret is not treated as a secret.
-      # See: https://developers.google.com/identity/protocols/OAuth2InstalledApp
-      CLIENT_ID = "563584335869-fgrhgmd47bqnekij5i8b5pr03ho849e6.apps.googleusercontent.com"
-      CLIENT_SECRET = "j9iVZfS8kkCEFUPaAeJV0sAi"
-
-      def self.run(params)
-        callback_uri = "http://localhost:#{params[:port]}"
-        client_id = Google::Auth::ClientId.new(CLIENT_ID, CLIENT_SECRET)
-        authorizer = Google::Auth::UserAuthorizer.new(client_id, SCOPE, nil, callback_uri)
-
-        # Create an anti-forgery state token as described here:
-        # https://developers.google.com/identity/protocols/OpenIDConnect#createxsrftoken
-        state = SecureRandom.hex(16)
-        url = authorizer.get_authorization_url(state: state)
-
-        UI.message("Open the following address in your browser and sign in with your Google account:")
-        UI.message(url)
-
-        response_params = get_authorization_code(params[:port])
-
-        # Confirm that the state in the response matches the state token used to
-        # generate the authorization URL.
-        unless state == response_params['state'][0]
-          UI.crash!('An error has occurred. The state parameter in the authorization response does not match the expected state, which could mean that a malicious attacker is trying to make a login request.')
-        end
-
-        user_credentials = authorizer.get_credentials_from_code(
-          code: response_params['code'][0]
-        )
-        UI.success("Set the refresh token as the FIREBASE_TOKEN environment variable")
-        UI.success("Refresh Token: #{user_credentials.refresh_token}")
-      rescue => error
-        UI.error(error.to_s)
-        UI.crash!("An error has occurred, please login again.")
-      end
-
-      def self.get_authorization_code(port)
-        begin
-          server = TCPServer.open(port)
-        rescue Errno::EADDRINUSE => error
-          UI.error(error.to_s)
-          UI.crash!("Port #{port} is in use. Please specify a different one using the port parameter.")
-        end
-        client = server.accept
-        callback_request = client.readline
-        # Use a regular expression to extract the request line from the first line of
-        # the callback request, e.g.:
-        #   GET /?code=AUTH_CODE&state=XYZ&scope=... HTTP/1.1
-        matcher = /GET +([^ ]+)/.match(callback_request)
-        response_params = CGI.parse(URI.parse(matcher[1]).query) unless matcher.nil?
-
-        client.puts("HTTP/1.1 200 OK")
-        client.puts("Content-Type: text/html")
-        client.puts("")
-        client.puts("<b>")
-        if response_params['code'].nil?
-          client.puts("Failed to retrieve authorization code.")
-        else
-          client.puts("Authorization code was successfully retrieved.")
-        end
-        client.puts("</b>")
-        client.puts("<p>Please check the console output.</p>")
-        client.close
-
-        return response_params
-      end
-
-      #####################################################
-      # @!group Documentation
-      #####################################################
-
-      def self.description
-        "Authenticate with Firebase App Distribution using a Google account."
-      end
-
-      def self.details
-        "Log in to Firebase App Distribution using a Google account to generate an authentication "\
-        "token. This token is stored within an environment variable and used to authenticate with your Firebase project. "\
-        "See https://firebase.google.com/docs/app-distribution/ios/distribute-fastlane for more information."
-      end
-
-      def self.authors
-        ["Manny Jimenez Github: mannyjimenez0810, Alonso Salas Infante Github: alonsosalasinfante"]
-      end
-
-      def self.is_supported?(platform)
-        [:ios, :android].include?(platform)
-      end
-
-      def self.available_options
-        [
-          FastlaneCore::ConfigItem.new(key: :port,
-                                       env_name: "FIREBASEAPPDISTRO_LOGIN_PORT",
-                                       description: "Port for the local web server which receives the response from Google's authorization server",
-                                       default_value: "8081",
-                                       optional: true,
-                                       type: String)
-
-        ]
-      end
-
-      def self.category
-        :deprecated
-      end
-
-      def self.deprecated_notes
-        "The firebase_app_distribution_login task is deprecated and will be removed in Q1 2023. See "\
-        "https://firebase.google.com/docs/app-distribution/android/distribute-gradle#authenticate "\
-        "for more information on alternative ways to authenticate."
-      end
-    end
-  end
-end