fastlane-plugin-firebase_app_distribution 0.3.1 → 0.3.2.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf7cfe204f09a005063f099ef379887cda33351ed6f1dfd1bb84773b1c989a4f
-  data.tar.gz: 3fc3e7c82e6506a670ab6b137ab8a4a55d968ba5f89ff0f20bcb0448ca0d2f76
+  metadata.gz: 2f128010598972c74283a13b7f0b5f4caf6d6e5c81a55d29afe2ce95aaec1689
+  data.tar.gz: cee09afb5df6a71d152b83aa8bd1ffb9d345d1a4bb67d023d873d66ee4a1ea8e
 SHA512:
-  metadata.gz: c25cb0b20720cd286c3665d8496b7c66e90121f34c2802fa7e63e52835a54aff81cc7fe2c91313af45a9e69ded27560b495917da498d0ea13a34712ae323dbbf
-  data.tar.gz: 1b45cb5e6657fac457d9bf34bbe4e5a624a8f912b193eaf58138d964cdb3d793aac0bf5036cd56dd997dee1b25e57ab2d30602a122e2c9f24d7171c8f7b25ccc
+  metadata.gz: 9c07147d44692df714866c88cfd48a6562e51727bb37bdd2e330060432f3f19301988942304d124aab72005b061e0139b6d781871af66469de76236f9da09e24
+  data.tar.gz: 515ce2300fe54efef6e165d3a942268ee80624d7fed9feba07144893855e34144899d03e4d770b6e3088282e743fb272c231f919e5658e758508f18bec65c14a

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

@@ -89,10 +89,6 @@ module Fastlane
         app_id
       end
 
-      def self.app_name_from_app_id(app_id)
-        "projects/#{app_id.split(':')[1]}/apps/#{app_id}"
-      end
-
       def self.xcode_archive_path
         # prevents issues on cross-platform build environments where an XCode build happens within
         # the same lane
@@ -187,7 +183,7 @@ module Fastlane
                                        default_value_dynamic: true,
                                        optional: true,
                                        verify_block: proc do |value|
-                                         UI.user_error!("firebase_app_distribution: '#{value}' is not a valid value for android_artifact_path. Should be 'APK' or 'AAB'") unless ['APK', 'AAB'].include?(value)
+                                         UI.user_error!("firebase_app_distribution: '#{value}' is not a valid value for android_artifact_type. Should be 'APK' or 'AAB'") unless ['APK', 'AAB'].include?(value)
                                        end),
           FastlaneCore::ConfigItem.new(key: :app,
                                        env_name: "FIREBASEAPPDISTRO_APP",
@@ -230,7 +226,7 @@ module Fastlane
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or 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_add_testers_action.rb

@@ -71,7 +71,7 @@ module Fastlane
                                       optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or 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

@@ -0,0 +1,111 @@
+require 'fastlane/action'
+require_relative '../client/firebase_app_distribution_api_client'
+require_relative '../helper/firebase_app_distribution_auth_client'
+require_relative '../helper/firebase_app_distribution_helper'
+
+module Fastlane
+  module Actions
+    class FirebaseAppDistributionGetLatestReleaseAction < 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])
+
+        UI.message("⏳ Fetching latest release for app #{params[:app]}...")
+
+        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].")
+        else
+          latest_release = releases[0]
+          UI.success("✅ Latest release fetched successfully. Returning release and setting Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE].")
+        end
+        Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE] = latest_release
+        return latest_release
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Fetches the latest release in Firebase App Distribution"
+      end
+
+      def self.details
+        [
+          "Fetches information about the most recently created release in App Distribution, including the version and release notes. Returns nil if no releases are found."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: "FIREBASEAPPDISTRO_APP",
+                                       description: "Your app's Firebase App ID. You can find the App ID in the Firebase console, on the General Settings page",
+                                       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",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :service_credentials_file,
+                                       description: "Path to Google service account json",
+                                       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.output
+        [
+          ['FIREBASE_APP_DISTRO_LATEST_RELEASE', 'A hash representing the lastest release created in Firebase App Distribution']
+        ]
+      end
+
+      def self.return_value
+        "Hash representation of the lastest release created in Firebase App Distribution (see https://firebase.google.com/docs/reference/app-distribution/rest/v1/projects.apps.releases#resource:-release)"
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.authors
+        ["lkellogg@google.com"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'release = firebase_app_distribution_get_latest_release(app: "1:1234567890:ios:0a1b2c3d4e5f67890")',
+          'increment_build_number({
+            build_number: firebase_app_distribution_get_latest_release(app: "1:1234567890:ios:0a1b2c3d4e5f67890")[:buildVersion].to_i + 1
+          })'
+        ]
+      end
+
+      def self.sample_return_value
+        {
+          name: "projects/123456789/apps/1:1234567890:ios:0a1b2c3d4e5f67890/releases/0a1b2c3d4",
+          releaseNotes: {
+            text: "Here are some release notes!"
+          },
+          displayVersion: "1.2.3",
+          buildVersion: "10",
+          createTime: "2021-10-06T15:01:23Z"
+        }
+      end
+    end
+  end
+end

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 for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or 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 for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or 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

@@ -220,7 +220,7 @@ module Fastlane
       rescue Faraday::ResourceNotFound
         UI.user_error!(ErrorMessage::INVALID_PROJECT)
       rescue Faraday::ClientError => e
-        if e.response_status == 429
+        if e.response[:status] == 429
           UI.user_error!(ErrorMessage::TESTER_LIMIT_VIOLATION)
         else
           raise e
@@ -247,6 +247,27 @@ module Fastlane
         UI.user_error!(ErrorMessage::INVALID_PROJECT)
       end
 
+      # List releases
+      #
+      # args
+      #   app_name - Firebase App resource name
+      #   page_size - The number of releases to return in the page
+      #   page_token - A page token, received from a previous call
+      #
+      # Returns the response body. Throws a user_error if the app hasn't been onboarded to App Distribution.
+      def list_releases(app_name, page_size = 100, page_token = nil)
+        begin
+          response = connection.get(list_releases_url(app_name), { pageSize: page_size.to_s, pageToken: page_token }) do |request|
+            request.headers[AUTHORIZATION] = "Bearer " + @auth_token
+            request.headers[CLIENT_VERSION] = client_version_header_value
+          end
+        rescue Faraday::ResourceNotFound
+          UI.user_error!("#{ErrorMessage::INVALID_APP_ID}: #{app_name}")
+        end
+
+        return response.body
+      end
+
       private
 
       def client_version_header_value
@@ -281,6 +302,10 @@ module Fastlane
         "/v1/#{operation_name}"
       end
 
+      def list_releases_url(app_name)
+        "#{v1_apps_url(app_name)}/releases"
+      end
+
       def get_udids_url(app_id)
         "#{v1alpha_apps_url(app_id)}/testers:getTesterUdids"
       end

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

@@ -53,6 +53,10 @@ module Fastlane
       def present?(value)
         !blank?(value)
       end
+
+      def app_name_from_app_id(app_id)
+        "projects/#{app_id.split(':')[1]}/apps/#{app_id}"
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.3.1"
+    VERSION = "0.3.2.pre.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.3.1
+  version: 0.3.2.pre.1
 platform: ruby
 authors:
 - Stefan Natchev
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -152,6 +152,7 @@ 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_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
@@ -178,9 +179,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: