fastlane-plugin-firebase_app_distribution 0.2.0.pre.1 → 0.2.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab7379d2d8feb6112f778c3b4a64e2f2181a099a
-  data.tar.gz: bdb617b84fb387a5486faee45d23be3043a9d9af
+SHA256:
+  metadata.gz: 7387fdbb5db28a63ea91ef6e4feb290f4cdb71b93e8c7132595098f94f1ffc16
+  data.tar.gz: d24c551ec1c81f90ca38307aa75f7c3884982fdc58de2911f54b5971056a4a99
 SHA512:
-  metadata.gz: 69f808e806793eb81839ac45241445c8764884f35c92c25066c86121c5ecb7ebf981371ed347fceadbfb0161df03ac6613fbd3f2aebe42a935783ca55d239df5
-  data.tar.gz: 83c298cdfd08b945957f10f9194142423418b89ee5dc17a2718b1506013e79fbba2f94ad11e1b7c0b92a874c3e69731eba327e66f393bb61b99fae0bf423d5b5
+  metadata.gz: fe83dbc6eaca609c5471732598f004775ff2139d9d24487bb5021d821a909dfce61f955166c3ed1e115186909c7b455a0578237923845a5015d5ac776c57fe5c
+  data.tar.gz: 440ac81fb3b05743c511d22f2096c099a636cfc6df06a8d4a8703f9dff8d727c4841f6218e4503cec22d765d2379dc5bbca4ae76bc2b98dcb79007d2b45533ce

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

@@ -21,9 +21,8 @@ module Fastlane
 
       def self.run(params)
         params.values # to validate all inputs before looking for the ipa/apk
-        auth_token = fetch_auth_token(params[:service_credentials_file])
-        fad_api_client = Client::FirebaseAppDistributionApiClient.new(auth_token)
-        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+        auth_token = fetch_auth_token(params[:service_credentials_file], params[:firebase_cli_token])
+        fad_api_client = Client::FirebaseAppDistributionApiClient.new(auth_token, platform)
         binary_path = params[:ipa_path] || params[:apk_path]
 
         if params[:app] # Set app_id if it is specified as a parameter
@@ -38,7 +37,7 @@ module Fastlane
         if app_id.nil?
           UI.crash!(ErrorMessage::MISSING_APP_ID)
         end
-        release_id = fad_api_client.upload(app_id, binary_path)
+        release_id = fad_api_client.upload(app_id, binary_path, platform.to_s)
         if release_id.nil?
           return
         end
@@ -67,9 +66,11 @@ module Fastlane
         "Release your beta builds with Firebase App Distribution"
       end
 
-      def self.available_options
-        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+      def self.platform
+        @platform ||= Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+      end
 
+      def self.available_options
         if platform == :ios || platform.nil?
           ipa_path_default = Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last
         end

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

@@ -9,8 +9,13 @@ module Fastlane
       MAX_POLLING_RETRIES = 60
       POLLING_INTERVAL_SECONDS = 2
 
-      def initialize(auth_token)
+      def initialize(auth_token, platform)
         @auth_token = auth_token
+        if platform == :ios || platform.nil?
+          @binary_type = "IPA"
+        else
+          @binary_type = "APK"
+        end
       end
 
       # Enables tester access to the specified app release. Skips this
@@ -38,6 +43,7 @@ module Fastlane
         rescue Faraday::ClientError
           UI.user_error!("#{ErrorMessage::INVALID_TESTERS} \nEmails: #{emails} \nGroups: #{group_ids}")
         end
+        UI.success("Added testers/groups successfully.")
       end
 
       # Posts notes for the specified app release. Skips this
@@ -71,7 +77,7 @@ module Fastlane
         begin
           binary_hash = Digest::SHA256.hexdigest(File.open(binary_path).read)
         rescue Errno::ENOENT
-          UI.crash!("#{ErrorMessage::APK_NOT_FOUND}: #{binary_path}")
+          UI.crash!("#{ErrorMessage.binary_not_found(@binary_type)}: #{binary_path}")
         end
 
         begin
@@ -88,14 +94,17 @@ module Fastlane
         return upload_token_format(response.body[:appId], response.body[:projectNumber], binary_hash)
       end
 
-      def upload_binary(app_id, binary_path)
+      def upload_binary(app_id, binary_path, platform)
         connection.post(binary_upload_url(app_id), File.open(binary_path).read) do |request|
           request.headers["Authorization"] = "Bearer " + @auth_token
+          request.headers["X-APP-DISTRO-API-CLIENT-ID"] = "fastlane"
+          request.headers["X-APP-DISTRO-API-CLIENT-TYPE"] =  platform
+          request.headers["X-APP-DISTRO-API-CLIENT-VERSION"] = Fastlane::FirebaseAppDistribution::VERSION
         end
       rescue Faraday::ResourceNotFound
         UI.crash!("#{ErrorMessage::INVALID_APP_ID}: #{app_id}")
       rescue Errno::ENOENT
-        UI.crash!("#{ErrorMessage::APK_NOT_FOUND}: #{binary_path}")
+        UI.crash!("#{ErrorMessage.binary_not_found(@binary_type)}: #{binary_path}")
       end
 
       # Uploads the binary file if it has not already been uploaded
@@ -107,28 +116,36 @@ module Fastlane
       #
       # Returns the release_id on a successful release, otherwise returns nil.
       #
-      # Throws an error if the number of polling retries exceeds MAX_POLLING_RETRIES
-      def upload(app_id, binary_path)
+      # Throws a UI error if the number of polling retries exceeds MAX_POLLING_RETRIES
+      # Crashes if not able to upload the binary
+      def upload(app_id, binary_path, platform)
         upload_token = get_upload_token(app_id, binary_path)
         upload_status_response = get_upload_status(app_id, upload_token)
-        if upload_status_response.success?
-          UI.success("This APK/IPA has been uploaded before. Skipping upload step.")
+        if upload_status_response.success? || upload_status_response.already_uploaded?
+          UI.success("This #{@binary_type} has been uploaded before. Skipping upload step.")
         else
-          UI.message("This APK has not been uploaded before.")
+          UI.message("This #{@binary_type} has not been uploaded before")
+          UI.message("Uploading the #{@binary_type}.")
+          unless upload_status_response.in_progress?
+            upload_binary(app_id, binary_path, platform)
+          end
           MAX_POLLING_RETRIES.times do
-            if upload_status_response.success?
-              UI.success("Uploaded APK/IPA Successfully!")
+            upload_status_response = get_upload_status(app_id, upload_token)
+            if upload_status_response.success? || upload_status_response.already_uploaded?
+              UI.success("Uploaded #{@binary_type} Successfully!")
               break
             elsif upload_status_response.in_progress?
               sleep(POLLING_INTERVAL_SECONDS)
             else
-              UI.message("Uploading the APK/IPA.")
-              upload_binary(app_id, binary_path)
+              if !upload_status_response.message.nil?
+                UI.user_error!("#{ErrorMessage.upload_binary_error(@binary_type)}: #{upload_status_response.message}")
+              else
+                UI.user_error!(ErrorMessage.upload_binary_error(@binary_type))
+              end
             end
-            upload_status_response = get_upload_status(app_id, upload_token)
           end
           unless upload_status_response.success?
-            UI.error("It took longer than expected to process your APK/IPA, please try again.")
+            UI.error("It took longer than expected to process your #{@binary_type}, please try again.")
             return nil
           end
         end

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

@@ -5,33 +5,74 @@ module Fastlane
     module FirebaseAppDistributionAuthClient
       TOKEN_CREDENTIAL_URI = "https://oauth2.googleapis.com/token"
 
-      def fetch_auth_token(google_service_path)
+      # Returns the auth token for any of the auth methods (Firebase CLI token,
+      # Google service account, firebase-tools). To ensure that a specific
+      # auth method is used, unset all other auth variables/parameters to nil/empty
+      #
+      # 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
+      #
+      # env variables
+      #   GOOGLE_APPLICATION_CREDENTIALS - see google_service_path
+      #   FIREBASE_TOKEN - see firebase_cli_token
+      #
+      # Crashes if given invalid or missing credentials
+      def fetch_auth_token(google_service_path, firebase_cli_token)
         if !google_service_path.nil? && !google_service_path.empty?
-          service_account(google_service_path)
-        elsif ENV["FIREBASE_TOKEN"]
-          firebase_token
-        elsif ENV["GOOGLE_APPLICATION_CREDENTIALS"]
-          service_account(ENV["GOOGLE_APPLICATION_CREDENTIALS"])
+          UI.message("Authenticating with --service_credentials_file path parameter: #{google_service_path}")
+          token = service_account(google_service_path)
+        elsif !firebase_cli_token.nil? && !firebase_cli_token.empty?
+          UI.message("Authenticating with --firebase_cli_token parameter")
+          token = firebase_token(firebase_cli_token)
+        elsif !ENV["FIREBASE_TOKEN"].nil? && !ENV["FIREBASE_TOKEN"].empty?
+          UI.message("Authenticating with FIREBASE_TOKEN environment variable")
+          token = firebase_token(ENV["FIREBASE_TOKEN"])
+        elsif !ENV["GOOGLE_APPLICATION_CREDENTIALS"].nil? && !ENV["GOOGLE_APPLICATION_CREDENTIALS"].empty?
+          UI.message("Authenticating with GOOGLE_APPLICATION_CREDENTIALS environment variable: #{ENV['GOOGLE_APPLICATION_CREDENTIALS']}")
+          token = service_account(ENV["GOOGLE_APPLICATION_CREDENTIALS"])
+        elsif (refresh_token = refresh_token_from_firebase_tools)
+          UI.message("No authentication method specified. Using cached Firebase CLI credentials.")
+          token = firebase_token(refresh_token)
         else
-          UI.crash!(ErrorMessage::MISSING_CREDENTIALS)
+          UI.user_error!(ErrorMessage::MISSING_CREDENTIALS)
         end
+        UI.success("Successfully authenticated!")
+        token
       end
 
       private
 
-      def firebase_token
-        begin
-          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,
-            refresh_token: ENV["FIREBASE_TOKEN"]
-          )
-        rescue Signet::AuthorizationError
-          UI.crash!(ErrorMessage::REFRESH_TOKEN_ERROR)
+      def refresh_token_from_firebase_tools
+        if ENV["XDG_CONFIG_HOME"].nil? || ENV["XDG_CONFIG_HOME"].empty?
+          config_path = File.expand_path(".config/configstore/firebase-tools.json", "~")
+        else
+          config_path = File.expand_path("configstore/firebase-tools.json", ENV["XDG_CONFIG_HOME"])
+        end
+
+        if File.exist?(config_path)
+          begin
+            refresh_token = JSON.parse(File.read(config_path))['tokens']['refresh_token']
+            refresh_token unless refresh_token.nil? || refresh_token.empty?
+          # TODO: Catch parser errors, improve error handling here
+          # Returns nil when there is an empty "tokens" field in the firebase-tools json
+          rescue NoMethodError
+          end
         end
+      end
+
+      def firebase_token(refresh_token)
+        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,
+          refresh_token: refresh_token
+        )
         client.fetch_access_token!
         client.access_token
+      rescue Signet::AuthorizationError
+        UI.user_error!(ErrorMessage::REFRESH_TOKEN_ERROR)
       end
 
       def service_account(google_service_path)
@@ -41,7 +82,9 @@ module Fastlane
         )
         service_account_credentials.fetch_access_token!["access_token"]
       rescue Errno::ENOENT
-        UI.crash!("#{ErrorMessage::SERVICE_CREDENTIALS_NOT_FOUND}: #{google_service_path}")
+        UI.user_error!("#{ErrorMessage::SERVICE_CREDENTIALS_NOT_FOUND}: #{google_service_path}")
+      rescue Signet::AuthorizationError
+        UI.user_error!("#{ErrorMessage::SERVICE_CREDENTIALS_ERROR}: #{google_service_path}")
       end
     end
   end

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

@@ -1,16 +1,12 @@
 module ErrorMessage
-  MISSING_CREDENTIALS = "Missing credentials. Please check that a refresh token was set or service credentials were passed in and try again"
-  APK_NOT_FOUND = "Could not find the APK/IPA. Make sure you set the apk_path parameter to point to your APK/IPA"
+  MISSING_CREDENTIALS = "Missing authentication credentials. Check that your Firebase refresh token is set or that your service account file path is correct and try again."
   MISSING_APP_ID = "Missing app id. Please check that it was passed in and try again"
   SERVICE_CREDENTIALS_NOT_FOUND = "Service credentials file does not exist. Please check the service credentials path and try again"
   PARSE_SERVICE_CREDENTIALS_ERROR = "Failed to extract service account information from the service credentials file"
-  PARSE_APK_METADATA_ERROR = "Failed to extract APK/IPA metadata from the APK/IPA path"
   UPLOAD_RELEASE_NOTES_ERROR = "App Distribution halted because it had a problem uploading release notes"
   UPLOAD_TESTERS_ERROR = "App Distribution halted because it had a problem adding testers/groups"
-  UPLOAD_APK_ERROR = "App Distribution halted because it had a problem uploading the APK/IPA"
-  APK_PROCESSING_ERROR = "App Distribution failed to process the APK/IPA"
   GET_RELEASE_TIMEOUT = "App Distribution failed to fetch release information"
-  REFRESH_TOKEN_ERROR = "Could not generate credentials from the refresh token specified"
+  REFRESH_TOKEN_ERROR = "Could not generate credentials from the refresh token specified."
   GET_APP_ERROR = "App Distribution failed to fetch app information"
   APP_NOT_ONBOARDED_ERROR = "App Distribution not onboarded"
   GET_APP_NO_CONTACT_EMAIL_ERROR = "App Distribution could not find a contact email associated with this app. Contact Email"
@@ -18,4 +14,21 @@ module ErrorMessage
   INVALID_PATH = "Could not read content from"
   INVALID_TESTERS = "Could not enable access for testers. Ensure that the groups exist and the tester emails are formatted correctly"
   INVALID_RELEASE_ID = "App distribution failed to fetch release with id"
+  SERVICE_CREDENTIALS_ERROR = "Could not generate credentials from the service credentials file specified. Service Account Path"
+
+  def self.binary_not_found(binary_type)
+    "Could not find the #{binary_type}. Make sure you set the #{binary_type} path parameter to point to your #{binary_type}"
+  end
+
+  def self.parse_binary_metadata_error(binary_type)
+    "Failed to extract #{binary_type} metadata from the #{binary_type} path"
+  end
+
+  def self.upload_binary_error(binary_type)
+    "App Distribution halted because it had a problem uploading the #{binary_type}"
+  end
+
+  def self.binary_processing_error(binary_type)
+    "App Distribution failed to process the #{binary_type}"
+  end
 end

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

@@ -1,4 +1,5 @@
 require 'fastlane_core/ui/ui'
+require 'cfpropertylist'
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
   module Helper
@@ -23,6 +24,10 @@ module Fastlane
         return string_array
       end
 
+      def parse_plist(path)
+        CFPropertyList.native_types(CFPropertyList::List.new(file: path).value)
+      end
+
       def get_ios_app_id_from_archive(path)
         app_path = parse_plist("#{path}/Info.plist")["ApplicationProperties"]["ApplicationPath"]
         UI.shell_error!("can't extract application path from Info.plist at #{path}") if app_path.empty?

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

@@ -12,7 +12,15 @@ class UploadStatusResponse
   end
 
   def in_progress?
-    status == "IN_PROGRESS"
+    status == 'IN_PROGRESS'
+  end
+
+  def error?
+    status == 'ERROR'
+  end
+
+  def already_uploaded?
+    status == 'ALREADY_UPLOADED'
   end
 
   def release_hash
@@ -22,4 +30,8 @@ class UploadStatusResponse
   def release_id
     release_hash ? release_hash[:id] : nil
   end
+
+  def message
+    @response_json_hash[:message]
+  end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.2.0.pre.1"
+    VERSION = "0.2.0.pre.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-firebase_app_distribution
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.1
+  version: 0.2.0.pre.2
 platform: ruby
 authors:
 - Stefan Natchev
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -177,8 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Release your beta builds to Firebase App Distribution. https://firebase.google.com/docs/app-distribution