fastlane-plugin-appcircle_testing_distribution 0.4.3.beta.2 → 0.4.3.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f283cd5be2e98b217e7d2e42850522554fed9558546b93b866cc770e129f8d54
-  data.tar.gz: 56007872a9fa3cd4622aee13c333caed3ac64b40567daef6acfc68df3a4080ec
+  metadata.gz: d29253d3bd644428e3c3403ec7de545a6570cf3e2b470c58ba50ddb6c211da9d
+  data.tar.gz: 3e8298d2f5d547d5891a9f5d34a043c05fdfedf2c5c3c2d66f43def751a372d0
 SHA512:
-  metadata.gz: 32aed19f76d5041ae3e4e0347b643511a3f0208be7c7ccfbd0beab39aaf4f39a585005c518e99cb8b440962e263d4a37c4f4c5a4308e14689dc4bd39ce50d346
-  data.tar.gz: 99d4e56d0378881862c88fab9dc1a47b5fa3337005b7837e6440b86bdb72625040f0cd5909bab4550068c1b4d67b9a36700996e6adb9b9b6a639e2655912d924
+  metadata.gz: f5d216ec25e3c4162fcad0da1bcd5c2dc28fd9711d973d987c3841b1473f903b83fa2b827bcc894082b1006ce30c811ef6599138816d5455970599418ab8ffa6
+  data.tar.gz: 0c4280025c48eda9e4b54fdbe44bd7f839cca35bdd2439cd5ab7b0784a0f7d43d6a908df98617891b8f64e489078fb107b63954dc3cf8c80f81059b0cc2204b0

data/README.md

@@ -104,6 +104,24 @@ Provide **either** `personalAPIToken` **or** `personalAccessKey` — not both. I
 - `appPath`: Indicates the file path to the application package that will be uploaded to Appcircle Testing Distribution Profile.
 - `message`: Your message to testers, ensuring they receive important updates and information regarding the application.
 
+### Self-Hosted Appcircle
+
+If you run a self-hosted Appcircle installation, point the plugin to your own endpoints. Both parameters are optional and default to the Appcircle cloud, so existing cloud users do not need to set them.
+
+- `authEndpoint` (optional): Authentication endpoint URL. Defaults to `https://auth.appcircle.io`.
+- `apiEndpoint` (optional): API endpoint URL. Defaults to `https://api.appcircle.io`.
+
+```ruby
+  appcircle_testing_distribution(
+    personalAPIToken: ENV["AC_PERSONAL_API_TOKEN"],
+    authEndpoint: "https://auth.my-appcircle.example.com",
+    apiEndpoint: "https://api.my-appcircle.example.com",
+    profileName: ENV["AC_PROFILE_NAME"],
+    appPath: ENV["AC_APP_PATH"],
+    message: ENV["AC_MESSAGE"]
+  )
+```
+
 ## Further Details
 
 For more information please refer to the documentation.

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

@@ -33,6 +33,9 @@ module Fastlane
         #
         appPath = params[:appPath]
         message = params[:message]
+        #
+        authEndpoint = params[:authEndpoint]
+        apiEndpoint = params[:apiEndpoint]
 
         profileAuthType = AUTH_TYPE_MAPPING[profileAuthType] # map input to API values
 
@@ -46,23 +49,25 @@ module Fastlane
         # Auth
         authToken = self.ac_login(personal_api_token: personalAPIToken,
                                   personal_access_key: personalAccessKey,
-                                  sub_organization_name: subOrganizationName)
+                                  sub_organization_name: subOrganizationName,
+                                  auth_endpoint: authEndpoint,
+                                  api_endpoint: apiEndpoint)
 
         # Get or create profile
-        profileId = self.ac_get_or_create_profile(authToken, profileName, createProfileIfNotExists, profileCreationSettings, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames)
+        profileId = self.ac_get_or_create_profile(authToken, profileName, createProfileIfNotExists, profileCreationSettings, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames, apiEndpoint)
 
         # Upload package
-        self.ac_upload(authToken, appPath, profileId, profileName, message)
+        self.ac_upload(authToken, appPath, profileId, profileName, message, apiEndpoint)
       end
 
-      def self.ac_login(personal_api_token:, personal_access_key:, sub_organization_name:)
+      def self.ac_login(personal_api_token:, personal_access_key:, sub_organization_name:, auth_endpoint:, api_endpoint:)
         begin
           token = ''
 
           if personal_access_key
-            user = TDAuthService.get_ac_token_with_personal_access_key(personal_access_key: personal_access_key)
+            user = TDAuthService.get_ac_token_with_personal_access_key(personal_access_key: personal_access_key, auth_endpoint: auth_endpoint)
           else
-            user = TDAuthService.get_ac_token(pat: personal_api_token)
+            user = TDAuthService.get_ac_token(pat: personal_api_token, auth_endpoint: auth_endpoint)
           end
           UI.success("Login is successful.")
           token = user.accessToken
@@ -71,8 +76,8 @@ module Fastlane
             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)
+              organization_id = TDAuthService.get_organization_id(access_token: token, name: sub_organization_name, api_endpoint: api_endpoint)
+              user = TDAuthService.get_ac_token(pat: personal_api_token, sub_organization_id: organization_id, auth_endpoint: auth_endpoint)
               UI.message("Switched to sub-organization: #{sub_organization_name}")
               token = user.accessToken
             end
@@ -85,9 +90,9 @@ module Fastlane
         end
       end
 
-      def self.ac_get_or_create_profile(authToken, profileName, createProfileIfNotExists, profileCreationSettings, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames)
+      def self.ac_get_or_create_profile(authToken, profileName, createProfileIfNotExists, profileCreationSettings, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames, apiEndpoint)
         begin
-          profileId = TDUploadService.get_profile_id(authToken, profileName)
+          profileId = TDUploadService.get_profile_id(authToken, profileName, apiEndpoint)
 
           if profileId
             UI.message("Profile '#{profileName}' found with ID: #{profileId}.")
@@ -97,7 +102,7 @@ module Fastlane
             UI.user_error!("Error: Profile '#{profileName}' not found. The option 'createProfileIfNotExists' is set to false, so a new profile was not created. To automatically create a new profile when it doesn't exist, set 'createProfileIfNotExists' to true.")
           elsif profileId.nil? && createProfileIfNotExists
             UI.message("Profile '#{profileName}' not found. Creating the new profile...")
-            profileId = TDUploadService.create_profile(authToken, profileName, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames)
+            profileId = TDUploadService.create_profile(authToken, profileName, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames, apiEndpoint)
           end
 
           return profileId
@@ -107,11 +112,11 @@ module Fastlane
         end
       end
 
-      def self.ac_upload(token, appPath, profileID, profileName, message)
+      def self.ac_upload(token, appPath, profileID, profileName, message, apiEndpoint)
         begin
           UI.message("Upload started.")
-          response = TDUploadService.upload_artifact(token: token, message: message, app: appPath, dist_profile_id: profileID)
-          result = self.checkTaskStatus(token, response['taskId'])
+          response = TDUploadService.upload_artifact(token: token, message: message, app: appPath, dist_profile_id: profileID, api_endpoint: apiEndpoint)
+          result = self.checkTaskStatus(token, response['taskId'], apiEndpoint)
 
           if result
             UI.success("#{appPath} uploaded to profile '#{profileName}' successfully  🎉")
@@ -122,8 +127,8 @@ module Fastlane
         end
       end
 
-      def self.checkTaskStatus(authToken, taskId)
-        uri = URI.parse("https://api.appcircle.io/task/v1/tasks/#{taskId}")
+      def self.checkTaskStatus(authToken, taskId, apiEndpoint)
+        uri = URI.parse("#{apiEndpoint}/task/v1/tasks/#{taskId}")
         
         check_interval = 1
         # timeout = 2 * 60 * 60 # 2 hours in seconds
@@ -197,6 +202,20 @@ module Fastlane
                                        optional: true,
                                        type: String),
 
+          FastlaneCore::ConfigItem.new(key: :authEndpoint,
+                                       env_name: "AC_AUTH_ENDPOINT",
+                                       description: "Optional: Authentication endpoint URL for self-hosted Appcircle installations. Defaults to the Appcircle cloud",
+                                       optional: true,
+                                       default_value: "https://auth.appcircle.io",
+                                       type: String),
+
+          FastlaneCore::ConfigItem.new(key: :apiEndpoint,
+                                       env_name: "AC_API_ENDPOINT",
+                                       description: "Optional: API endpoint URL for self-hosted Appcircle installations. Defaults to the Appcircle cloud",
+                                       optional: true,
+                                       default_value: "https://api.appcircle.io",
+                                       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",

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

@@ -13,8 +13,8 @@ class UserResponse
 end
 
 module TDAuthService
-  def self.get_ac_token(pat:, sub_organization_id: nil)
-    endpoint_url = 'https://auth.appcircle.io/auth/v2/token'
+  def self.get_ac_token(pat:, sub_organization_id: nil, auth_endpoint: 'https://auth.appcircle.io')
+    endpoint_url = "#{auth_endpoint}/auth/v2/token"
     uri = URI(endpoint_url)
 
     # Create HTTP request
@@ -46,8 +46,8 @@ module TDAuthService
     end
   end
 
-  def self.get_organization_id(access_token:, name:)
-    endpoint_url = 'https://api.appcircle.io/identity/v1/organizations'
+  def self.get_organization_id(access_token:, name:, api_endpoint: 'https://api.appcircle.io')
+    endpoint_url = "#{api_endpoint}/identity/v1/organizations"
     uri = URI(endpoint_url)
 
     # Create HTTP request
@@ -74,8 +74,8 @@ module TDAuthService
     end
   end
 
-  def self.get_ac_token_with_personal_access_key(personal_access_key:)
-    endpoint_url = 'https://auth.appcircle.io/auth/v1/token'
+  def self.get_ac_token_with_personal_access_key(personal_access_key:, auth_endpoint: 'https://auth.appcircle.io')
+    endpoint_url = "#{auth_endpoint}/auth/v1/token"
     uri = URI(endpoint_url)
 
     # Create HTTP request

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

@@ -8,12 +8,12 @@ BASE_URL = "https://api.appcircle.io"
 module TDUploadService
   UI = FastlaneCore::UI
 
-  def self.upload_artifact(token:, message:, app:, dist_profile_id:)
+  def self.upload_artifact(token:, message:, app:, dist_profile_id:, api_endpoint: BASE_URL)
     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"
+    upload_info_url = "#{api_endpoint}/distribution/v1/profiles/#{dist_profile_id}/app-versions"
     headers = {
       Authorization: "Bearer #{token}",
       accept: 'application/json'
@@ -53,7 +53,7 @@ module TDUploadService
         raise "File upload failed."
       end
 
-      commit_url = "#{BASE_URL}/distribution/v1/profiles/#{dist_profile_id}/app-versions"
+      commit_url = "#{api_endpoint}/distribution/v1/profiles/#{dist_profile_id}/app-versions"
       uri = URI(commit_url)
       uri.query = URI.encode_www_form({ action: 'commitFileUpload' })
 
@@ -87,8 +87,8 @@ module TDUploadService
     end
   end
 
-  def self.get_distribution_profiles(auth_token:)
-    url = "#{BASE_URL}/distribution/v2/profiles"
+  def self.get_distribution_profiles(auth_token:, api_endpoint: BASE_URL)
+    url = "#{api_endpoint}/distribution/v2/profiles"
   
     # Set up the headers with authentication
     headers = {
@@ -106,8 +106,8 @@ module TDUploadService
     end
   end
 
-  def self.get_testing_groups(auth_token:)
-    url = "#{BASE_URL}/distribution/v2/testing-groups"
+  def self.get_testing_groups(auth_token:, api_endpoint: BASE_URL)
+    url = "#{api_endpoint}/distribution/v2/testing-groups"
   
     # Set up the headers with authentication
     headers = {
@@ -125,8 +125,8 @@ module TDUploadService
     end
   end
 
-  def self.create_distribution_profile(name:, auth_token:)
-    url = "#{BASE_URL}/distribution/v2/profiles"
+  def self.create_distribution_profile(name:, auth_token:, api_endpoint: BASE_URL)
+    url = "#{api_endpoint}/distribution/v2/profiles"
     headers = {
       Authorization: "Bearer #{auth_token}",
       content_type: :json,
@@ -146,8 +146,8 @@ module TDUploadService
     end
   end
 
-  def self.update_distribution_profile(profile_id:, auth_type:, username:, password:, testing_group_ids:, auth_token:)
-    url = "#{BASE_URL}/distribution/v2/profiles/#{profile_id}"
+  def self.update_distribution_profile(profile_id:, auth_type:, username:, password:, testing_group_ids:, auth_token:, api_endpoint: BASE_URL)
+    url = "#{api_endpoint}/distribution/v2/profiles/#{profile_id}"
     headers = {
       Authorization: "Bearer #{auth_token}",
       content_type: :json,
@@ -179,11 +179,11 @@ module TDUploadService
     end
   end
 
-  def self.get_profile_id(authToken, profileName)
+  def self.get_profile_id(authToken, profileName, api_endpoint = BASE_URL)
     profileId = nil
 
     begin
-      profiles = TDUploadService.get_distribution_profiles(auth_token: authToken)
+      profiles = TDUploadService.get_distribution_profiles(auth_token: authToken, api_endpoint: api_endpoint)
       profiles.each do |profile|
         if profile["name"] == profileName
           profileId = profile['id']
@@ -197,12 +197,12 @@ module TDUploadService
     return profileId
   end
 
-  def self.get_testing_group_ids(authToken, testingGroupNames)
+  def self.get_testing_group_ids(authToken, testingGroupNames, api_endpoint = BASE_URL)
     testingGroupIds = []
     remainingGroupNames = Set.new(testingGroupNames)
 
     begin
-      groups = TDUploadService.get_testing_groups(auth_token: authToken)
+      groups = TDUploadService.get_testing_groups(auth_token: authToken, api_endpoint: api_endpoint)
 
       groups.each do |group|
         if remainingGroupNames.include?(group["name"])
@@ -219,17 +219,18 @@ module TDUploadService
     return testingGroupIds
   end
 
-  def self.create_profile(authToken, profileName, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames)
+  def self.create_profile(authToken, profileName, profileAuthType, profileUsername, profilePassword, profileTestingGroupNames, api_endpoint = BASE_URL)
     # Get testing group IDs
     if !profileTestingGroupNames&.empty?
-      profileTestingGroupIds = TDUploadService.get_testing_group_ids(authToken, profileTestingGroupNames)
+      profileTestingGroupIds = TDUploadService.get_testing_group_ids(authToken, profileTestingGroupNames, api_endpoint)
     end
-    
+
     # Create
     begin
       new_profile = TDUploadService.create_distribution_profile(
         name: profileName,
-        auth_token: authToken
+        auth_token: authToken,
+        api_endpoint: api_endpoint
       )
       if new_profile.nil?
         raise "Error: The new profile could not be created."
@@ -248,7 +249,8 @@ module TDUploadService
         username: profileUsername,
         password: profilePassword,
         testing_group_ids: profileTestingGroupIds,
-        auth_token: authToken
+        auth_token: authToken,
+        api_endpoint: api_endpoint
       )
       if configured_profile.nil?
         raise "Error: The new profile could not be configured."

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

@@ -1,5 +1,5 @@
 module Fastlane
   module AppcircleTestingDistribution
-    VERSION = "0.4.3.beta.2"
+    VERSION = "0.4.3.beta.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appcircle_testing_distribution
 version: !ruby/object:Gem::Version
-  version: 0.4.3.beta.2
+  version: 0.4.3.beta.3
 platform: ruby
 authors:
 - appcircleio