fastlane-plugin-firebase_app_distribution 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745bfb3dfc4c6c48f389c8e4d75b50026cf37e872ce26e7510aefef049280329
-  data.tar.gz: 8122801b30f95422216c9c5343d102bc6b11fbc16308f268515e7a3405bbf070
+  metadata.gz: 5e7f18a8f8eafbf185e2668199992945f10c594eb0905a7f44dacc19d896dec7
+  data.tar.gz: 8d04a88db55901df3e117bd620d3db5b05080f7ba381b9a26cd7fd857c863bb2
 SHA512:
-  metadata.gz: 6ac42a57fdbda601b6ef2656a7e0d1b38304f022a26c970a75f1e0a43d01f2607f993c5500bceaf8ffb5b24ada6fbcbcb1ccf84d7dc8d87dc7d62049561d7886
-  data.tar.gz: ae12197e0149e187b02716e28a71207cd5ce67d14ea331bb9c230e41a53237e1c3e4359b1178f09bf059ac2d9697cb4b667d358a1d4751a3b47006efcaf131bb
+  metadata.gz: 144d169438dbefce6a18448ef9b64012e29d2675487f638b11aeb99ccbb9b075391bb77d57bac106718d1510a791e70fa31d4ddcf6a3b757854e6b93f0e18fde
+  data.tar.gz: 114836ed3247cd167071a10ec5d1868da3c090c3f37c792913529438dce1a9ff7ce3d3f4ee3b9c67d2d5f9dae1ab8769872f7cd6992dc6210b0b651a3ab30739

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

@@ -30,6 +30,11 @@ module Fastlane
 
         fad_api_client.add_testers(params[:project_number], emails)
 
+        unless blank?(params[:group_alias])
+          UI.message("⏳ Adding testers to group #{params[:group_alias]}...")
+          fad_api_client.add_testers_to_group(params[:project_number], params[:group_alias], emails)
+        end
+
         # The add_testers response lists all the testers from the request
         # regardless of whether or not they were created or if they already
         # exists so can't get an accurate count of the number of newly created testers
@@ -66,6 +71,11 @@ module Fastlane
                                       description: "Path to a file containing a comma separated list of tester emails to be created. A maximum of 1000 testers can be deleted at a time",
                                       optional: true,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :group_alias,
+                                       env_name: "FIREBASEAPPDISTRO_ADD_TESTERS_GROUP_ALIAS",
+                                       description: "Alias of the group to add the specified testers to. The group must already exist. If not specified, testers will not be added to a group",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :service_credentials_file,
                                       description: "Path to Google service credentials file",
                                       optional: true,

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

@@ -0,0 +1,87 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+
+require_relative '../helper/firebase_app_distribution_helper'
+require_relative '../helper/firebase_app_distribution_auth_client'
+
+module Fastlane
+  module Actions
+    class FirebaseAppDistributionCreateGroupAction < Action
+      extend Auth::FirebaseAppDistributionAuthClient
+      extend Helper::FirebaseAppDistributionHelper
+
+      def self.run(params)
+        auth_token = fetch_auth_token(params[:service_credentials_file], params[:firebase_cli_token])
+        fad_api_client = Client::FirebaseAppDistributionApiClient.new(auth_token, params[:debug])
+
+        if blank?(params[:alias])
+          UI.user_error!("Must specify `alias`.")
+        end
+
+        if blank?(params[:display_name])
+          UI.user_error!("Must specify `display_name`.")
+        end
+
+        project_number = params[:project_number]
+        group_alias = params[:alias]
+        display_name = params[:display_name]
+
+        UI.message("⏳ Creating tester group '#{group_alias} (#{display_name})' in project #{project_number}...")
+
+        fad_api_client.create_group(project_number, group_alias, display_name)
+
+        UI.success("✅ Group created successfully.")
+      end
+
+      def self.description
+        "Create a tester group"
+      end
+
+      def self.authors
+        ["Garry Jeromson"]
+      end
+
+      # supports markdown.
+      def self.details
+        "Create a tester group"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :project_number,
+                                       env_name: "FIREBASEAPPDISTRO_PROJECT_NUMBER",
+                                       description: "Your Firebase project number. You can find the project number in the Firebase console, on the General Settings page",
+                                       type: Integer,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :alias,
+                                       env_name: "FIREBASEAPPDISTRO_CREATE_GROUP_ALIAS",
+                                       description: "Alias of the group to be created",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :display_name,
+                                       env_name: "FIREBASEAPPDISTRO_CREATE_GROUP_DISPLAY_NAME",
+                                       description: "Display name for the group to be created",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :service_credentials_file,
+                                       description: "Path to Google service credentials file",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
+                                       description: "Auth token generated using the Firebase CLI's login:ci command",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :debug,
+                                       description: "Print verbose debug output",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+
+require_relative '../helper/firebase_app_distribution_helper'
+require_relative '../helper/firebase_app_distribution_auth_client'
+
+module Fastlane
+  module Actions
+    class FirebaseAppDistributionDeleteGroupAction < Action
+      extend Auth::FirebaseAppDistributionAuthClient
+      extend Helper::FirebaseAppDistributionHelper
+
+      def self.run(params)
+        auth_token = fetch_auth_token(params[:service_credentials_file], params[:firebase_cli_token])
+        fad_api_client = Client::FirebaseAppDistributionApiClient.new(auth_token, params[:debug])
+
+        if blank?(params[:alias])
+          UI.user_error!("Must specify `alias`.")
+        end
+
+        project_number = params[:project_number]
+        group_alias = params[:alias]
+
+        UI.message("⏳ Deleting tester group '#{group_alias}' in project #{project_number}...")
+
+        fad_api_client.delete_group(project_number, group_alias)
+
+        UI.success("✅ Group deleted successfully.")
+      end
+
+      def self.description
+        "Delete a tester group"
+      end
+
+      def self.authors
+        ["Garry Jeromson"]
+      end
+
+      # supports markdown.
+      def self.details
+        "Delete a tester group"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :project_number,
+                                       env_name: "FIREBASEAPPDISTRO_PROJECT_NUMBER",
+                                       description: "Your Firebase project number. You can find the project number in the Firebase console, on the General Settings page",
+                                       type: Integer,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :alias,
+                                       env_name: "FIREBASEAPPDISTRO_DELETE_GROUP_ALIAS",
+                                       description: "Alias of the group to be deleted",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :service_credentials_file,
+                                       description: "Path to Google service credentials file",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
+                                       description: "Auth token generated using the Firebase CLI's login:ci command",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :debug,
+                                       description: "Print verbose debug output",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -26,11 +26,15 @@ module Fastlane
           UI.user_error!("A maximum of 1000 testers can be removed at a time.")
         end
 
-        UI.message("⏳ Removing #{emails.count} testers from project #{params[:project_number]}...")
-
-        count = fad_api_client.remove_testers(params[:project_number], emails)
-
-        UI.success("✅ #{count} tester(s) removed successfully.")
+        if blank?(params[:group_alias])
+          UI.message("⏳ Removing #{emails.count} testers from project #{params[:project_number]}...")
+          count = fad_api_client.remove_testers(params[:project_number], emails)
+          UI.success("✅ #{count} tester(s) removed successfully.")
+        else
+          UI.message("⏳ Removing #{emails.count} testers from group #{params[:group_alias]}...")
+          fad_api_client.remove_testers_from_group(params[:project_number], params[:group_alias], emails)
+          UI.success("✅ Tester(s) removed successfully.")
+        end
       end
 
       def self.description
@@ -55,14 +59,19 @@ module Fastlane
                                        optional: false),
           FastlaneCore::ConfigItem.new(key: :emails,
                                       env_name: "FIREBASEAPPDISTRO_REMOVE_TESTERS_EMAILS",
-                                      description: "Comma separated list of tester emails to be deleted. A maximum of 1000 testers can be deleted at a time",
+                                      description: "Comma separated list of tester emails to be deleted (or removed from a group if a group alias is specified). A maximum of 1000 testers can be deleted/removed at a time",
                                       optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :file,
                                       env_name: "FIREBASEAPPDISTRO_REMOVE_TESTERS_FILE",
-                                      description: "Path to a file containing a comma separated list of tester emails to be deleted. A maximum of 1000 testers can be deleted at a time",
+                                      description: "Path to a file containing a comma separated list of tester emails to be deleted (or removed from a group if a group alias is specified). A maximum of 1000 testers can be deleted/removed at a time",
                                       optional: true,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :group_alias,
+                                       env_name: "FIREBASEAPPDISTRO_REMOVE_TESTERS_GROUP_ALIAS",
+                                       description: "Alias of the group to remove the specified testers from. Testers will not be deleted from the project",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :service_credentials_file,
                                       description: "Path to Google service credentials file",
                                       optional: true,

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

@@ -251,6 +251,102 @@ module Fastlane
         UI.user_error!(ErrorMessage::INVALID_PROJECT)
       end
 
+      # Create tester group
+      #
+      # args
+      #   project_number - Firebase project number
+      #   group_alias - Alias of the tester group
+      #   display_name - Display name of the tester group
+      #
+      def create_group(project_number, group_alias, display_name)
+        payload = { name: "projects/#{project_number}/groups/#{group_alias}",
+                    displayName: display_name }
+        response = connection.post(add_tester_group_url(project_number), payload.to_json) do |request|
+          request.params["groupId"] = group_alias
+          request.headers[AUTHORIZATION] = "Bearer " + @auth_token
+          request.headers[CONTENT_TYPE] = APPLICATION_JSON
+          request.headers[CLIENT_VERSION] = client_version_header_value
+        end
+        response.body
+      rescue Faraday::BadRequestError
+        UI.user_error!(ErrorMessage::INVALID_TESTER_GROUP_NAME)
+      rescue Faraday::ResourceNotFound
+        UI.user_error!(ErrorMessage::INVALID_PROJECT)
+      rescue Faraday::ConflictError
+        UI.important("Tester group #{group_alias} already exists.")
+        return {
+          name: "projects/#{project_number}/groups/#{group_alias}"
+        }
+      rescue Faraday::ClientError => e
+        raise e
+      end
+
+      # Add testers to group
+      #
+      # args
+      #   project_number - Firebase project number
+      #   group_alias - Alias of the tester group
+      #   emails - An array of emails to be added to the group.
+      #            A maximum of 1000 testers can be added at a time, if creating missing testers is enabled.
+      #   create_missing_testers - If true, missing testers will be created and added to the group.
+      #
+      def add_testers_to_group(project_number, group_alias, emails, create_missing_testers = false)
+        payload = { emails: emails,
+                    createMissingTesters: create_missing_testers }
+        response = connection.post(add_testers_to_group_url(project_number, group_alias), 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
+        response.body
+      rescue Faraday::BadRequestError
+        UI.user_error!(ErrorMessage::INVALID_EMAIL_ADDRESS)
+      rescue Faraday::ResourceNotFound
+        UI.user_error!(ErrorMessage::INVALID_TESTER_GROUP)
+      rescue Faraday::ClientError => e
+        raise e
+      end
+
+      # Remove testers from group
+      #
+      # args
+      #   project_number - Firebase project number
+      #   group_alias - Alias of the tester group
+      #   emails - An array of emails to be removed from the group.
+      #
+      def remove_testers_from_group(project_number, group_alias, emails)
+        payload = { emails: emails }
+        response = connection.post(remove_testers_from_group_url(project_number, group_alias), 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
+        response.body
+      rescue Faraday::BadRequestError
+        UI.user_error!(ErrorMessage::INVALID_EMAIL_ADDRESS)
+      rescue Faraday::ResourceNotFound
+        UI.user_error!(ErrorMessage::INVALID_TESTER_GROUP)
+      rescue Faraday::ClientError => e
+        raise e
+      end
+
+      # Delete tester group
+      #
+      # args
+      #   project_number - Firebase project number
+      #   group_alias - Alias of the tester group
+      #
+      def delete_group(project_number, group_alias)
+        response = connection.delete(delete_tester_group_url(project_number, group_alias)) do |request|
+          request.headers[AUTHORIZATION] = "Bearer " + @auth_token
+          request.headers[CONTENT_TYPE] = APPLICATION_JSON
+          request.headers[CLIENT_VERSION] = client_version_header_value
+        end
+        response.body
+      rescue Faraday::ResourceNotFound
+        UI.user_error!(ErrorMessage::INVALID_TESTER_GROUP)
+      end
+
       # List releases
       #
       # args
@@ -269,7 +365,7 @@ module Fastlane
           UI.user_error!("#{ErrorMessage::INVALID_APP_ID}: #{app_name}")
         end
 
-        return response.body
+        response.body
       end
 
       private
@@ -322,6 +418,22 @@ module Fastlane
         "/v1/projects/#{project_number}/testers:batchRemove"
       end
 
+      def add_tester_group_url(project_number)
+        "/v1/projects/#{project_number}/groups"
+      end
+
+      def delete_tester_group_url(project_number, group_alias)
+        "/v1/projects/#{project_number}/groups/#{group_alias}"
+      end
+
+      def add_testers_to_group_url(project_number, group_alias)
+        "/v1/projects/#{project_number}/groups/#{group_alias}:batchJoin"
+      end
+
+      def remove_testers_from_group_url(project_number, group_alias)
+        "/v1/projects/#{project_number}/groups/#{group_alias}:batchLeave"
+      end
+
       def connection
         @connection ||= Faraday.new(url: BASE_URL) do |conn|
           conn.response(:json, parser_options: { symbolize_names: true })

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

@@ -13,6 +13,8 @@ module ErrorMessage
   INVALID_PROJECT = "App Distribution could not find your Firebase project. Make sure to onboard an app in your project by pressing the \"Get started\" button on the App Distribution page in the Firebase console: https://console.firebase.google.com/project/_/appdistribution."
   INVALID_PATH = "Could not read content from"
   INVALID_TESTERS = "Could not enable access for testers. Check that the tester emails are formatted correctly, the groups exist and you are using group aliases (not group names) for specifying groups."
+  INVALID_TESTER_GROUP = "App Distribution could not find your tester group. Make sure that it exists before trying to add testers, and that the group alias is specified correctly."
+  INVALID_TESTER_GROUP_NAME = "The tester group name should be 4-63 characters, and valid characters are /[a-z][0-9]-/."
   INVALID_RELEASE_NOTES = "Failed to add release notes"
   SERVICE_CREDENTIALS_ERROR = "App Distribution could not generate credentials from the service credentials file specified"
   PLAY_ACCOUNT_NOT_LINKED = "This project is not linked to a Google Play account."

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-firebase_app_distribution
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Stefan Natchev
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -153,6 +153,8 @@ files:
 - lib/fastlane/plugin/firebase_app_distribution.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb
 - lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb
+- lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_create_group_action.rb
+- lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_delete_group_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_remove_testers_action.rb
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Release your beta builds to Firebase App Distribution. https://firebase.google.com/docs/app-distribution