fastlane-plugin-appcircle_testing_distribution 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01adda887a2e03213c82a2f1dd4c73e068599c6f2a72107663bc40b0246259d
-  data.tar.gz: 551d74f7d9d2ba2f9683fbc20c69c7e06c8897c7a711d98a6d636ce50fab7d82
+  metadata.gz: 213b75b8d9c150a9206153fa4bb835277992aac5ba70544ac201337a53eae712
+  data.tar.gz: 6dc6d2d960d77b3b7db6976b58aeefc17e0cfb3164bc52d137779a2f7765ae36
 SHA512:
-  metadata.gz: d77f4bf600f1281ac845c37c5a37cbe76c2ffffa3630f6d27d12e793912c80c01197ec746c2ef8d15f2c4c7a75e2798faeae10bad0485bb3e1ee5d65fbd5c472
-  data.tar.gz: fa09b51a8528c0693bf8a4371b29fd3ba1a87e42185069599744f28d0d06eab8430f8f38af5198fce624b9483ca0e20b6ad51df9f8cdc1565dcec150c7015ff1
+  metadata.gz: 3ec4a590c5418d685a2f2c7fa9b2618bf09d91d3a6bcc26252d1ec6e164b4d39a756065f0b35d886f79e75e04c0ea40a797c9de9c373ab35c9b3e3b920fdbabe
+  data.tar.gz: 0e980015ac5ee5f865da4262a1d7bd090f2c2d5cb8ce4e761ff8e8e718d61ea8822bb8c47295f1f45342d28bfaa2204923dcea78853b081a013ab21fca6aece7

data/README.md

@@ -13,7 +13,7 @@ Testing distribution is the process of distributing test builds to designated te
 ## Benefits of Using Testing Distribution
 
 1. **Simplified Binary Distribution**.
-   - **Skip Traditional Stores:** Share .xcarchive .IPA, APK, AAB, Zip, files directly, avoiding the need to use App Store TestFlight or Google Play Internal Testing.
+   - **Skip Traditional Stores:** Share IPA, APK, AAB files directly, avoiding the need to use App Store TestFlight or Google Play Internal Testing.
 2. **Streamlined Workflow:**
    - **Automated Processes:** Platforms like Appcircle automate the distribution process, saving time and reducing manual effort.
    - **Seamless Integration:** Integrates smoothly with existing DevOps pipelines, enabling efficient build and distribution workflows.
@@ -67,9 +67,10 @@ fastlane add_plugin appcircle_testing_distribution
 ```ruby
   appcircle_testing_distribution(
     personalAPIToken: ENV["AC_PERSONAL_API_TOKEN"],
+    personalAccessKey: ENV["AC_PERSONAL_ACCESS_KEY"],
     subOrganizationName: ENV["AC_SUB_ORGANIZATION_NAME"],
     profileName: ENV["AC_PROFILE_NAME"],
-    createProfileIfNotExists: ENV["AC_CREATE_PROFILE_IF_NOT_EXISTS"],
+    createProfileIfNotExists: ENV["AC_CREATE_PROFILE_IF_NOT_EXISTS"] == "true",
     profileCreationSettings: {
       authType: ENV["AC_PROFILE_AUTH_TYPE"],
       username: ENV["AC_PROFILE_USERNAME"],
@@ -81,7 +82,17 @@ fastlane add_plugin appcircle_testing_distribution
   )
 ```
 
+### Authentication
+
+Provide **either** `personalAPIToken` **or** `personalAccessKey` — not both. If neither is provided, or both are provided at the same time, the plugin fails fast with a descriptive error.
+
 - `personalAPIToken`: The Appcircle Personal API token used to authenticate and authorize access to Appcircle services within this plugin.
+- `personalAccessKey`: Alternative authentication method using a Personal Access Key. Use this if your organization provisions access keys instead of API tokens.
+
+> **Note:** `subOrganizationName` is currently supported only when authenticating with `personalAPIToken`. When used together with `personalAccessKey`, the sub-organization switch is skipped with a warning.
+
+### Other parameters
+
 - `subOrganizationName` (optional): Required when the Root Organization's `personalAPIToken` is used, and you want to create the profile under a sub-organization. In this case, provide the name of the sub-organization in this field. If you directly used the sub-organization's `personalAPIToken`, this parameter is not needed.
 - `profileName`: Specifies the profile that will be used for uploading the app.
 - `createProfileIfNotExists` (optional): Ensures that a testing distribution profile is automatically created if it does not already exist; if the profile name already exists, the app will be uploaded to that existing profile instead.

data/lib/fastlane/plugin/appcircle_testing_distribution/actions/appcircle_testing_distribution_action.rb

@@ -10,7 +10,7 @@ require_relative '../helper/TDUploadService'
 module Fastlane
   module Actions
     class AppcircleTestingDistributionAction < Action
-      VALID_EXTENSIONS = ['.apk', '.aab', '.ipa', '.zip']
+      VALID_EXTENSIONS = ['.apk', '.aab', '.ipa']
       AUTH_TYPE_MAPPING = {
         'none' => 1, # None
         'static' => 3, # Static Username and Password
@@ -20,6 +20,7 @@ module Fastlane
       
       def self.run(params)
         personalAPIToken = params[:personalAPIToken]
+        personalAccessKey = params[:personalAccessKey]
         subOrganizationName = params[:subOrganizationName]
         profileName = params[:profileName]
         createProfileIfNotExists = params[:createProfileIfNotExists] || false
@@ -32,11 +33,20 @@ module Fastlane
         #
         appPath = params[:appPath]
         message = params[:message]
-        
+
         profileAuthType = AUTH_TYPE_MAPPING[profileAuthType] # map input to API values
 
+        # Validate auth input (either-or, not both, not none)
+        if personalAPIToken.nil? && personalAccessKey.nil?
+          UI.user_error!("Either Personal API Token or Personal Access Key is required to authenticate connections to Appcircle services. Please provide a valid access token or access key.")
+        elsif !personalAPIToken.nil? && !personalAccessKey.nil?
+          UI.user_error!("Personal API Token and Personal Access Key cannot be used together. Please provide only one authentication method.")
+        end
+
         # Auth
-        authToken = self.ac_login(personalAPIToken, subOrganizationName)
+        authToken = self.ac_login(personal_api_token: personalAPIToken,
+                                  personal_access_key: personalAccessKey,
+                                  sub_organization_name: subOrganizationName)
 
         # Get or create profile
         profileId = self.ac_get_or_create_profile(authToken, profileName, createProfileIfNotExists, profileCreationSettings, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames)
@@ -45,21 +55,29 @@ module Fastlane
         self.ac_upload(authToken, appPath, profileId, profileName, message)
       end
 
-      def self.ac_login(personalAPIToken, subOrganizationName)
+      def self.ac_login(personal_api_token:, personal_access_key:, sub_organization_name:)
         begin
           token = ''
 
-          user = TDAuthService.get_ac_token(pat: personalAPIToken)
+          if personal_access_key
+            user = TDAuthService.get_ac_token_with_personal_access_key(personal_access_key: personal_access_key)
+          else
+            user = TDAuthService.get_ac_token(pat: personal_api_token)
+          end
           UI.success("Login is successful.")
           token = user.accessToken
-          
-          if subOrganizationName
-            organization_id = TDAuthService.get_organization_id(access_token: token, name: subOrganizationName)
-            user = TDAuthService.get_ac_token(pat: personalAPIToken, sub_organization_id: organization_id)
-            UI.message("Switched to sub-organization: #{subOrganizationName}")
-            token = user.accessToken
+
+          if sub_organization_name
+            if personal_access_key
+              UI.important("Warning: subOrganizationName is currently only supported with personalAPIToken auth. Ignoring sub-organization switch for Personal Access Key login.")
+            else
+              organization_id = TDAuthService.get_organization_id(access_token: token, name: sub_organization_name)
+              user = TDAuthService.get_ac_token(pat: personal_api_token, sub_organization_id: organization_id)
+              UI.message("Switched to sub-organization: #{sub_organization_name}")
+              token = user.accessToken
+            end
           end
-          
+
           return token
 
         rescue => e
@@ -162,19 +180,25 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :personalAPIToken,
-                                       description: "Provide Personal API Token to authenticate connections to Appcircle services",
-                                       optional: false,
-                                       type: String,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("Personal API Token cannot be empty. Please provide a valid access token.") unless value && !value.empty?
-                                       end),
+                                       env_name: "AC_PERSONAL_API_TOKEN",
+                                       description: "Provide Personal API Token to authenticate connections to Appcircle services (alternative to personalAccessKey)",
+                                       optional: true,
+                                       type: String),
+
+          FastlaneCore::ConfigItem.new(key: :personalAccessKey,
+                                       env_name: "AC_PERSONAL_ACCESS_KEY",
+                                       description: "Provide Personal Access Key to authenticate connections to Appcircle services (alternative to personalAPIToken)",
+                                       optional: true,
+                                       type: String),
 
           FastlaneCore::ConfigItem.new(key: :subOrganizationName,
+                                       env_name: "AC_SUB_ORGANIZATION_NAME",
                                        description: "Optional: Sub-organization name for app distribution. Profiles will be created under root organization if not provided",
                                        optional: true,
                                        type: String),
 
           FastlaneCore::ConfigItem.new(key: :profileName,
+                                       env_name: "AC_PROFILE_NAME",
                                        description: "Enter the profile name of the Appcircle testing distribution profile. This name uniquely identifies the profile under which your applications will be distributed",
                                        optional: false,
                                        type: String,
@@ -183,6 +207,7 @@ module Fastlane
                                        end),
 
           FastlaneCore::ConfigItem.new(key: :createProfileIfNotExists,
+                                       env_name: "AC_CREATE_PROFILE_IF_NOT_EXISTS",
                                        description: "Optional: If the profile does not exist, create a new profile with the given name",
                                        optional: true,
                                        type: Boolean),
@@ -212,7 +237,8 @@ module Fastlane
                                        end),
 
           FastlaneCore::ConfigItem.new(key: :appPath,
-                                       description: "Specify the path to your application file. For iOS, this can be a .ipa or .xcarchive file path. For Android, specify the .apk or .appbundle file path",
+                                       env_name: "AC_APP_PATH",
+                                       description: "Specify the path to your application file. For iOS, this can be a .ipa file path. For Android, specify the .apk or .aab file path",
                                        optional: false,
                                        type: String,
                                        verify_block: proc do |value|
@@ -220,11 +246,12 @@ module Fastlane
 
                                          file_extension = File.extname(value).downcase
                                          unless VALID_EXTENSIONS.include?(file_extension)
-                                           UI.user_error!("Invalid file extension: '#{file_extension}'. For Android, use .apk or .aab. For iOS, use .ipa or .zip(.xcarchive).")
+                                           UI.user_error!("Invalid file extension: '#{file_extension}'. For Android, use .apk or .aab. For iOS, use .ipa.")
                                          end
                                        end),
 
           FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "AC_MESSAGE",
                                        description: "Message to include with the distribution to provide additional information to testers or users receiving the build",
                                        optional: false,
                                        type: String,

data/lib/fastlane/plugin/appcircle_testing_distribution/helper/TDAuthService.rb

@@ -49,23 +49,23 @@ module TDAuthService
   def self.get_organization_id(access_token:, name:)
     endpoint_url = 'https://api.appcircle.io/identity/v1/organizations'
     uri = URI(endpoint_url)
-  
+
     # Create HTTP request
     request = Net::HTTP::Get.new(uri)
     request['Authorization'] = "Bearer #{access_token}"
     request['Accept'] = 'application/json'
-  
+
     # Make the HTTP request
     response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
       http.request(request)
     end
-  
+
     # Check response
     if response.is_a?(Net::HTTPSuccess)
       response_data = JSON.parse(response.body)
       organizations = response_data['data']
       organization = organizations.find { |org| org['name'] == name }
-      
+
       raise "Organization with name '#{name}' not found" unless organization
       return organization['id']
 
@@ -73,4 +73,36 @@ module TDAuthService
       raise "Error: (#{response.code} #{response.message})"
     end
   end
+
+  def self.get_ac_token_with_personal_access_key(personal_access_key:)
+    endpoint_url = 'https://auth.appcircle.io/auth/v1/token'
+    uri = URI(endpoint_url)
+
+    # Create HTTP request
+    request = Net::HTTP::Post.new(uri)
+    request.content_type = 'application/x-www-form-urlencoded'
+    request['Accept'] = 'application/json'
+
+    # Encode parameters
+    params = { 'personal-access-key' => personal_access_key }
+    request.body = URI.encode_www_form(params)
+
+    # Make the HTTP request
+    response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      http.request(request)
+    end
+
+    # Check response
+    if response.is_a?(Net::HTTPSuccess)
+      response_data = JSON.parse(response.body)
+
+      user = UserResponse.new(
+        accessToken: response_data['access_token']
+      )
+
+      return user
+    else
+      raise "Error: (#{response.code} #{response.message})."
+    end
+  end
 end

data/lib/fastlane/plugin/appcircle_testing_distribution/helper/TDUploadService.rb

@@ -6,20 +6,80 @@ require 'rest-client'
 BASE_URL = "https://api.appcircle.io"
 
 module TDUploadService
+  UI = FastlaneCore::UI
+
   def self.upload_artifact(token:, message:, app:, dist_profile_id:)
-    url = "https://api.appcircle.io/distribution/v2/profiles/#{dist_profile_id}/app-versions"
+    file_path = app
+    file_name = File.basename(file_path)
+    file_size = File.size(file_path)
+
+    upload_info_url = "#{BASE_URL}/distribution/v1/profiles/#{dist_profile_id}/app-versions"
     headers = {
-      Authorization: "Bearer #{token}"
-    }
-    payload = {
-      Message: message,
-      File: File.new(app, 'rb'),
-      multipart: true # Force multipart encoding for RestClient
+      Authorization: "Bearer #{token}",
+      accept: 'application/json'
     }
-  
+
+    uri = URI(upload_info_url)
+    uri.query = URI.encode_www_form({
+      action: 'uploadInformation',
+      fileName: file_name,
+      fileSize: file_size
+    })
+
     begin
-      response = RestClient.post(url, payload, headers)
-      JSON.parse(response.body) rescue response.body
+      UI.message("Getting file upload information...")
+      response = RestClient.get(uri.to_s, headers)
+      upload_info = JSON.parse(response.body)
+      if response.code.between?(200, 299)
+        UI.success("File upload information retrieved successfully with status code: #{response.code}")
+      else
+        UI.error("Failed to retrieve file upload information with status code: #{response.code}")
+        raise "Failed to retrieve file upload information."
+      end
+      file_id = upload_info['fileId']
+      upload_url = upload_info['uploadUrl']
+
+      file_content = File.binread(file_path)
+      UI.message("Uploading file to Appcircle...")
+      response = RestClient.put(
+        upload_url,
+        file_content,
+        { content_type: 'application/octet-stream' }
+      )
+      if response.code.between?(200, 299)
+        UI.success("File upload finished successfully with status code: #{response.code}")
+      else
+        UI.error("File upload failed with status code: #{response.code}")
+        raise "File upload failed."
+      end
+
+      commit_url = "#{BASE_URL}/distribution/v1/profiles/#{dist_profile_id}/app-versions"
+      uri = URI(commit_url)
+      uri.query = URI.encode_www_form({ action: 'commitFileUpload' })
+
+      commit_payload = {
+        fileId: file_id,
+        fileName: file_name,
+        message: message
+      }.to_json
+
+      commit_headers = {
+        Authorization: "Bearer #{token}",
+        content_type: :json,
+        accept: 'application/json'
+      }
+
+      UI.message("Committing file upload...")
+      commit_response = RestClient.post(uri.to_s, commit_payload, commit_headers)
+      if commit_response.code.between?(200, 299)
+        result = JSON.parse(commit_response.body)
+        UI.success("Commit successful with status code: #{commit_response.code}")
+      else
+        UI.error("Commit failed with status code: #{commit_response.code}")
+        raise "Commit failed with status code: #{commit_response.code}"
+      end
+
+      return result
     rescue RestClient::ExceptionWithResponse => e
       raise e
     rescue StandardError => e

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

@@ -1,5 +1,5 @@
 module Fastlane
   module AppcircleTestingDistribution
-    VERSION = "0.4.0"
+    VERSION = "0.4.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appcircle_testing_distribution
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - appcircleio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2026-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Efficiently distribute application builds to users or testing groups using