fastlane-plugin-appcircle_testing_distribution 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a02bb68865ce3d94c903651486aa0da0dd6ce65b1a031d49f9ae65dd1f280df3
-  data.tar.gz: 7cf9e84c39f8dac3db289e273d15b4b458baf1a3c3c8307e1fa04ae483dcda07
+  metadata.gz: 56a980fcdde02bf5a93e7fd18711e5048365b997e4781590aca5c95ce5a0c438
+  data.tar.gz: 0ccaae94dc8a36a4c93951dc63bd6ad776686b0803ccce88e385c49573453af8
 SHA512:
-  metadata.gz: 3c220a3b09805d02df2e3cab87bb4cb89714a00a27b598cfc83a51f61436b3ee84c709c4378effbf161fed1654b2fe2250dc95fcefff34a45c60896ed2a76c0e
-  data.tar.gz: 387fc503a7975c0f8fa3f021e4f5c466c79a8cdcc11b9c38669c932bfe7d96469bb53b6a8181c3fcb6059f160ade2612f306f74518ec407cf966dd938f814e97
+  metadata.gz: d108ba67106e1d9917f6c4b94791bc61f697f269400a1d4bf16df7cf42a6f6fe572f74bce80d55159774967e7941d015c95d2644e4544bee58c8d2226ffb6a8f
+  data.tar.gz: 2a452dd82232e4718adf69087fc2ed0be9ee0a0fe753bebe966d358c276880ffd1562f6dc52c8dc63f215c48e30f038d92b7927867183e223f753d9cc89b8c23

data/README.md

@@ -38,6 +38,19 @@ Testing distribution is the process of distributing test builds to designated te
 
 Overall, using testing distribution in mobile DevOps significantly enhances the efficiency, security, and effectiveness of the software development process, leading to better products and faster delivery times.
 
+## System Requirements
+
+**Compatible Agents:**
+
+- macOS 14.2, 14.5
+
+**Supported Version:**
+
+- Fastlane 2.222.0
+- Ruby 3.2.2
+
+Note: Currently, plugins are only compatible to use with **Appcircle Cloud**. **Self-hosted** support will be available in future releases.
+
 ## Testing Distribution
 
 In order to share your builds with testers, you can create distribution profiles and assign testing groups to the distribution profiles.
@@ -66,17 +79,28 @@ fastlane add_plugin appcircle_testing_distribution
 
 ```yml
   appcircle_testing_distribution(
-    accessToken: "$(AC_ACCESS_TOKEN)",
-    profileID: "$(AC_PROFILE_ID)",
+    personalAPIToken: "$(AC_PERSONAL_API_TOKEN)",
+    profileName: "$(AC_PROFILE_NAME)",
+    createProfileIfNotExists: Boolean,
     appPath: "$(AC_APP_PATH)",
     message: "$(AC_MESSAGE)",
   )
 ```
 
+- `personalAPIToken`: The Appcircle Personal API token is utilized to authenticate and secure access to Appcircle services, ensuring that only authorized users can perform actions within the platform.
+- `profileName`: Specifies the profile that will be used for uploading the app.
+- `createProfileIfNotExists`: Ensures that a user 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.
+- `appPath`: Indicates the file path to the application that will be uploaded to Appcircle Testing Distribution Profile.
+- `message`: Your message to testers, ensuring they receive important updates and information regarding the application.
+
 ### Leveraging Environment Variables
 
 Utilize environment variables seamlessly by substituting the parameters with `$(VARIABLE_NAME)` in your task inputs. The extension automatically retrieves values from the specified environment variables within your pipeline.
 
+**Ensure that this action is added after build steps have been completed.**
+
+**If multiple workflows start simultaneously, the order in which versions are shared in the Testing Distribution is determined by the execution order of the publish step. The version that completes its build and triggers the publish plugin first will be shared first, followed by the others in sequence.**
+
 Efficiently distribute test binaries or beta versions using Appcircle, featuring seamless IPA and APK distribution capabilities. Streamline your testing process with our versatile tool designed to optimize your distribution workflow. If you need support or more information, please [contact us](https://appcircle.io/contact?utm_source=fastlane&utm_medium=plugin&utm_campaign=testing_distribution)
 
 ## Issues and Feedback
@@ -89,6 +113,6 @@ If you have trouble using plugins, check out the [Plugins Troubleshooting](https
 
 ## Reference
 
-- For details on generating an Appcircle Personal Access Token, visit [Generating/Managing Personal API Tokens](https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens?utm_source=fastlane&utm_medium=plugin&utm_campaign=testing_distribution)
+- For details on generating an Appcircle Personal API Token, visit [Generating/Managing Personal API Tokens](https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens?utm_source=fastlane&utm_medium=plugin&utm_campaign=testing_distribution)
 
 - To create or learn more about Appcircle testing and distribution profiles, please refer to [Creating or Selecting a Distribution Profile](https://docs.appcircle.io/distribute/create-or-select-a-distribution-profile?utm_source=fastlane&utm_medium=plugin&utm_campaign=testing_distribution)

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

@@ -2,21 +2,32 @@ require 'fastlane/action'
 require 'net/http'
 require 'uri'
 require 'json'
+
 require_relative '../helper/appcircle_testing_distribution_helper'
+require_relative '../helper/TDAuthService'
+require_relative '../helper/TDUploadService'
 
 module Fastlane
   module Actions
     class AppcircleTestingDistributionAction < Action
       def self.run(params)
-        accessToken = params[:accessToken]
-        profileID = params[:profileID]
+        personalAPIToken = params[:personalAPIToken]
+        profileName = params[:profileName]
         appPath = params[:appPath]
         message = params[:message]
+        createProfileIfNotExists = params[:createProfileIfNotExists]
+
+        valid_extensions = ['.apk', '.aab', '.ipa', '.zip']
+
+        file_extension = File.extname(appPath).downcase
+        unless valid_extensions.include?(file_extension)
+          raise "Invalid file extension: #{file_extension}. For Android, use .apk or .aab. For iOS, use .ipa or .zip(.xcarchive)."
+        end
 
-        if accessToken.nil?
-          raise UI.error("Access token is required to authenticate connections to Appcircle services. Please provide a valid access token")
-        elsif profileID.nil?
-          raise UI.error("Distribution profile ID is required to distribute applications. Please provide a valid distribution profile ID")
+        if personalAPIToken.nil?
+          raise UI.error("Personal API Token is required to authenticate connections to Appcircle services. Please provide a valid access token")
+        elsif profileName.nil?
+          raise UI.error("Distribution profile name is required to distribute applications. Please provide a distribution profile name")
         elsif appPath.nil?
           raise UI.error("Application file path is required to distribute applications. Please provide a valid application file path")
         elsif message.nil?
@@ -24,32 +35,33 @@ module Fastlane
         end
 
 
-        self.ac_login(accessToken)
-        self.ac_upload(appPath, profileID, message)
+        authToken = self.ac_login(personalAPIToken)
+
+        profileId = TDUploadService.get_profile_id(authToken, profileName, createProfileIfNotExists)
+        self.ac_upload(authToken, appPath, profileId, message)
       end
 
-      def self.ac_login(accessToken)
-        ac_login = `appcircle login --pat #{accessToken}`
-        if $?.success?
-          UI.success("Logged in to Appcircle successfully.")
-        else
-          raise "Error executing command of logging to Appcircle. Please make sure you have installed Appcircle CLI and provided a valid access token. For more information, please visit https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens #{ac_login}"
+      def self.ac_login(personalAPIToken)
+        begin
+          user = TDAuthService.get_ac_token(pat: personalAPIToken)
+          UI.success("Login is successful.")
+          return user.accessToken
+        rescue => e
+          puts "Login failed: #{e.message}"
         end
       end
       
-      def self.checkTaskStatus(taskId)
+      def self.checkTaskStatus(authToken, taskId)
         uri = URI.parse("https://api.appcircle.io/task/v1/tasks/#{taskId}")
         timeout = 1
-        jwtToken = `appcircle config get AC_ACCESS_TOKEN -o json`
-        apiAccessToken = JSON.parse(jwtToken)
         
-        response = self.send_request(uri, apiAccessToken["AC_ACCESS_TOKEN"])
+        response = self.send_request(uri, authToken)
         if response.is_a?(Net::HTTPSuccess)
           stateValue = JSON.parse(response.body)["stateValue"]
           
           if stateValue == 1
             sleep(1)
-            return checkTaskStatus(taskId)
+            return checkTaskStatus(authToken, taskId)
           end
           if stateValue == 3
             return true
@@ -58,8 +70,7 @@ module Fastlane
             raise "Upload could not completed successfully"
           end
         else
-          UI.error("Request failed with response code #{response.code} and message #{response.message}")
-          raise "Request failed"
+          raise "Upload failed with response code #{response.code} and message '#{response.message}'"
         end
       end
 
@@ -71,16 +82,16 @@ module Fastlane
         http.request(request)
       end
 
-      def self.ac_upload(appPath, profileID, message)
-        ac_upload = `appcircle testing-distribution upload --app=#{appPath} --distProfileId=#{profileID} --message "#{message}" -o json`
-        taskId = JSON.parse(ac_upload)["taskId"]
-        UI.message("taskID #{taskId}")
-        result = self.checkTaskStatus(taskId)
+      def self.ac_upload(token, appPath, profileID, message)
+        begin
+          response = TDUploadService.upload_artifact(token: token, message: message, app: appPath, dist_profile_id: profileID)
+          result = self.checkTaskStatus(token, response['taskId'])
 
-        if $?.success? and result
-          UI.success("#{appPath} Uploaded to Appcircle successfully.")
-        else
-          raise "Error executing command of uploading to Appcircle. Please make sure you have provide the valid app path and distribution profile id. For more information\n" + ac_upload
+          if $?.success? and result
+            UI.success("#{appPath} Uploaded to profile id #{profileID} successfully  🎉")
+          end
+        rescue => e
+          UI.error("Upload failed with status code #{e.response.code}, with message '#{e.message}'")
         end
       end
 
@@ -103,17 +114,23 @@ module Fastlane
 
       def self.available_options
         [
-          FastlaneCore::ConfigItem.new(key: :accessToken,
-                                       env_name: "AC_ACCESS_TOKEN",
-                                       description: "Provide the Appcircle access token to authenticate connections to Appcircle services",
+          FastlaneCore::ConfigItem.new(key: :personalAPIToken,
+                                       env_name: "AC_PERSONAL_API_TOKEN",
+                                       description: "Provide Personal API Token to authenticate connections to Appcircle services",
                                        optional: false,
                                        type: String),
-
-          FastlaneCore::ConfigItem.new(key: :profileID,
-                                       env_name: "AC_PROFILE_ID",
-                                       description: "Enter the ID of the Appcircle distribution profile. This ID uniquely identifies the profile under which your applications will be distributed",
+          
+          FastlaneCore::ConfigItem.new(key: :profileName,
+                                       env_name: "AC_PROFILE_NAME",
+                                       description: "Enter the profile name of the Appcircle distribution profile. This name uniquely identifies the profile under which your applications will be distributed",
                                        optional: false,
                                        type: String),
+          
+          FastlaneCore::ConfigItem.new(key: :createProfileIfNotExists,
+                                       env_name: "AC_CREATE_PROFILE_IF_NOT_EXISTS",
+                                       description: "If the profile does not exist, create a new profile with the given name",
+                                       optional: true,
+                                       type: Boolean),
 
           FastlaneCore::ConfigItem.new(key: :appPath,
                                        env_name: "AC_APP_PATH",

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

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'json'
+
+
+class UserResponse
+  attr_accessor :accessToken
+
+  def initialize(accessToken:)
+    @accessToken = accessToken
+  end
+end
+
+module TDAuthService
+  def self.get_ac_token(pat:)
+    endpoint_url = 'https://auth.appcircle.io/auth/v2/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 = { pat: pat }
+    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 "HTTP Request failed (#{response.code} #{response.message})"
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'rest-client'
+
+BASE_URL = "https://api.appcircle.io"
+
+module TDUploadService
+  def self.upload_artifact(token:, message:, app:, dist_profile_id:)
+    url = "https://api.appcircle.io/distribution/v2/profiles/#{dist_profile_id}/app-versions"
+    headers = {
+      Authorization: "Bearer #{token}",
+      Message: message,
+      content_type: :multipart
+    }
+    payload = {
+      Message: message,
+      File: File.new(app, 'rb')
+    }
+  
+    begin
+      response = RestClient.post(url, payload, headers)
+      JSON.parse(response.body) rescue response.body
+    rescue RestClient::ExceptionWithResponse => e
+      raise e
+    rescue StandardError => e
+      raise e
+    end
+  end
+
+  def self.get_distribution_profiles(auth_token:)
+    url = "#{BASE_URL}/distribution/v2/profiles"
+  
+    # Set up the headers with authentication
+    headers = {
+      Authorization: "Bearer #{auth_token}",
+      accept: 'application/json'
+    }
+  
+    begin
+      response = RestClient.get(url, headers)
+      parsed_response = JSON.parse(response.body)
+  
+      parsed_response
+    rescue RestClient::ExceptionWithResponse => e
+      raise e
+    rescue StandardError => e
+      raise e
+    end
+  end
+
+  def self.create_distribution_profile(name:, auth_token:)
+    url = "#{BASE_URL}/distribution/v2/profiles"
+    headers = {
+      Authorization: "Bearer #{auth_token}",
+      content_type: :json,
+      accept: 'application/json'
+    }
+    payload = {
+      name: name
+    }.to_json
+  
+    begin
+      response = RestClient.post(url, payload, headers)
+      JSON.parse(response.body)
+    rescue RestClient::ExceptionWithResponse => e
+      raise e
+    rescue StandardError => e
+      raise e
+    end
+  end
+
+  def self.get_profile_id(authToken, profileName, createProfileIfNotExists)
+    profileId = nil
+
+    begin
+      profiles = TDUploadService.get_distribution_profiles(auth_token: authToken)
+      profiles.each do |profile|
+        if profile["name"] == profileName
+          profileId = profile['id']
+        end
+      end
+    rescue => e
+      raise "Something went wrong while fetching profiles: #{e.message}"
+    end
+      
+    if profileId.nil? && !createProfileIfNotExists
+      raise "Error: The test profile '#{profileName}' could not be found. The option 'createProfileIfNotExists' is set to false, so no new profile was created. To automatically create a new profile if it doesn't exist, set 'createProfileIfNotExists' to true."
+    end
+
+    if profileId.nil? && createProfileIfNotExists
+      begin
+        puts "The test profile '#{profileName}' could not be found. A new profile is being created..."
+        new_profile = TDUploadService.create_distribution_profile(name: profileName, auth_token: authToken)
+        if new_profile.nil?
+          raise "Error: The new profile could not be created."
+        end
+        profileId = new_profile['id']
+      rescue => e
+        raise "Something went wrong while creating a new profile: #{e.message}"
+      end
+    end
+
+    return profileId
+  end
+
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module AppcircleTestingDistribution
-    VERSION = "0.1.6"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appcircle_testing_distribution
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - appcircleio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
-dependencies: []
+date: 2024-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: cloud@appcircle.io
 executables: []
@@ -23,6 +37,8 @@ files:
 - images/extension-icon.png
 - lib/fastlane/plugin/appcircle_testing_distribution.rb
 - lib/fastlane/plugin/appcircle_testing_distribution/actions/appcircle_testing_distribution_action.rb
+- lib/fastlane/plugin/appcircle_testing_distribution/helper/TDAuthService.rb
+- lib/fastlane/plugin/appcircle_testing_distribution/helper/TDUploadService.rb
 - lib/fastlane/plugin/appcircle_testing_distribution/helper/appcircle_testing_distribution_helper.rb
 - lib/fastlane/plugin/appcircle_testing_distribution/version.rb
 homepage: https://github.com/appcircleio/fastlane_plugin_appcircle_testing_distribution