fastlane-plugin-appbox 3.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ac49ed2e0a409764830fb7855c1791757fe94118bcb569a9da553aef9c5e3b8
-  data.tar.gz: fd5191b76fffc00f4d6142ffdc5df137c72839806a08674e63f7598d996fd663
+  metadata.gz: 3db84f527f2c015f99d005447b3f209bfca6a1c020ca56fed4a099eb13ceff6e
+  data.tar.gz: fd340764d6fa68040b93ec7f7b88874850eadc71ae2eb2a67cd0666f620f78f5
 SHA512:
-  metadata.gz: dcc94414c7c62001123af387ea4aa5c5d427c0c566fa2914a35fe1e6a4094cb2204adf5259ffe076ff6692559082f1f161e0282f1f43ecf02d7042608f2486a4
-  data.tar.gz: 6462fcc5ce569eee114cb886a805931670cfbe3fd63128e64c65b6b70579354da1fb6a69f37954a7295151360efed4cf1a1055c4a2265794101db8931287785d
+  metadata.gz: f1ee9fbc055c6c129638af19988c734229a1bde2b0466e83d230b115d2bf80318e792153eb49cfa8714280765cdaf45a5a1a095d9a66ee8d70909b59cd81f6ba
+  data.tar.gz: 5729b9846272dc136a5d413195c1d44110f56a779e65355e7f44e5edbb39043107fdb662156317bf5dda83f1b800a327a6c8daadc3bd2b8e67c2a3024dff45d7

data/README.md

@@ -10,17 +10,28 @@
 fastlane add_plugin appbox
 ```
 
-**Step 2** - Download the latest version of AppBox from [here](https://github.com/vineetchoudhary/AppBox-iOSAppsWirelessInstallation/releases) or [here](https://getappbox.com/download) and install it into `/Applications` directory of you mac. Now, open AppBox and login with your Dropbox account.
+**Step 2** - Install AppBox using one of the following methods:
+
+- **Direct Install:**
+  ```bash
+  curl -s https://getappbox.com/install.sh | bash
+  ```
+
+- **Homebrew:**
+  ```bash
+  brew install --cask appbox
+  ```
+
+Now, open AppBox and login with your Dropbox account.
 
 **Step 3** - Define appbox action in your project Fastfile with emails and message. Here the available params for appbox plugins - 
 
-- `emails` (Required | String) - Comma-separated list of email address that should receive application installation link.
-- `message` (Optional | String) - Attach personal message in the email. Supported Keywords:  
-    >The {PROJECT_NAME} - For Project Name,    
-    >{BUILD_VERSION} - For Build Version, and   
-    >{BUILD_NUMBER} - For Build Number.
-- `appbox_path` (Optional | String) - If you've setup AppBox in the different directory then you need to mention that here. Default is `/Applications/AppBox.app`
+- `emails` (Optional | String) - Comma-separated list of email address that should receive application installation link.
+- `message` (Optional | String) - A personal message shown under "Message from the developer" in the email. Sent verbatim — AppBox 4 no longer substitutes `{PROJECT_NAME}` / `{BUILD_VERSION}` / `{BUILD_NUMBER}` placeholders, so build them yourself from fastlane's own variables (see the examples below).
 - `keep_same_link` (Optional | Bool) - This feature will keep same short URL for all future build/IPA uploaded with same bundle identifier. If this option is enabled, you can also download the previous build with the same URL. Read more [here](https://docs.getappbox.com/Features/keepsamelink/). 
+- `slack_webhook_url` (Optional | String) - Slack Incoming Webhook URL to post a notification to a Slack channel.
+- `ms_teams_webhook_url` (Optional | String) - Microsoft Teams Incoming Webhook URL to post a notification to a Teams channel.
+- `webhook_message` (Optional | String) - **Deprecated and ignored since AppBox 4.** The CLI prints a note and generates the notification text from the build itself. Still accepted so existing Fastfiles keep working.
 - `dropbox_folder_name` (Optional | String) - You can change the link by providing a Custom Dropbox Folder Name. By default folder name will be the application bundle identifier. So, AppBox will keep the same link for the IPA file available in the same folder. Read more [here](https://docs.getappbox.com/Features/keepsamelink/).
 
 
@@ -50,7 +61,7 @@ platform :ios do
   lane :gymbox do
     gym
     appbox(
-        emails: 'you@example.com,'someoneelse@example.com',
+        emails: 'you@example.com,someoneelse@example.com',
     )
   end
 end
@@ -66,7 +77,7 @@ platform :ios do
     gym
     appbox(
         emails: 'you@example.com',
-        message: '{PROJECT_NAME} - {BUILD_VERSION}({BUILD_NUMBER}) is ready to test.',
+        message: "#{lane_context[SharedValues::IPA_OUTPUT_PATH] ? File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa') : 'Build'} is ready to test.",
     )
   end
 end
@@ -82,7 +93,7 @@ platform :ios do
     gym
     appbox(
         emails: 'you@example.com',
-        message: '{PROJECT_NAME} - {BUILD_VERSION}({BUILD_NUMBER}) is ready to test.',
+        message: "#{lane_context[SharedValues::IPA_OUTPUT_PATH] ? File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa') : 'Build'} is ready to test.",
         keep_same_link: true,
     )
   end
@@ -99,7 +110,7 @@ platform :ios do
     gym
     appbox(
         emails: 'you@example.com',
-        message: '{PROJECT_NAME} - {BUILD_VERSION}({BUILD_NUMBER}) is ready to test.',
+        message: "#{lane_context[SharedValues::IPA_OUTPUT_PATH] ? File.basename(lane_context[SharedValues::IPA_OUTPUT_PATH], '.ipa') : 'Build'} is ready to test.",
         keep_same_link: true,
         dropbox_folder_name: 'Fastlane-Demo-Keep-Same-Link',
     )
@@ -107,33 +118,17 @@ platform :ios do
 end
 ```
 
-#### 6. Upload IPA file where AppBox available at some custom path instead of macOS Application Directory.
-
-```rb
-default_platform(:ios)
-
-platform :ios do
-  lane :gymbox do
-    gym
-    appbox(
-        emails: 'you@example.com,'someoneelse@example.com',
-        appbox_path:'/Users/vineetchoudhary/Desktop/AppBox2.8.0/AppBox.app',
-    )
-  end
-end
-```
+#### Note
+When you run this for the first time, a pop-up will appear stating that "Terminal.app" wants to access data from other apps. You must allow this to copy the IPA file to the Appbox temporary directory, enabling Appbox to access and upload it.
+![](/AppBox-Fastlane-Demo-Project/images/terminal-permission.webp)
 
 ## 3. Supported AppBox link access via Fastlane SharedValues
 - `APPBOX_SHARE_URL` - AppBox short shareable URL to install uploaded application.   
 - `APPBOX_IPA_URL`- Upload IPA file URL to download IPA file.   
 - `APPBOX_MANIFEST_URL` - Manifest file URL for upload application.   
-- `APPBOX_LONG_SHARE_UR` - AppBox long shareable URL to install uploaded application.   
-
-![](/AppBox-Fastlane-Demo-Project/AppBoxFastlane.gif)
-
 
 ## 4. About AppBox
-[AppBox](https://getappbox.com) is a tool for iOS developers to build and deploy Development, Ad-Hoc and In-house (Enterprise) applications directly to the devices from your Dropbox account. Also, available on [Github](https://github.com/vineetchoudhary/AppBox-iOSAppsWirelessInstallation).
+[AppBox](https://getappbox.com) is a tool for iOS developers to build and deploy Development, Ad-Hoc and In-house (Enterprise) applications directly to the devices from your Dropbox account. Also, available on [Github](https://github.com/getappbox/AppBox-iOSAppsWirelessInstallation).
 
 ## 5. Example
 
@@ -142,6 +137,6 @@ Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plu
 ## 6. Issues and Feedback
 For any other issues and feedback about this plugin, please submit it to this [repository](https://github.com/getappbox/fastlane-plugin-appbox/issues/new).
 
-## 6. Troubleshooting
+## 7. Troubleshooting
 If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
 

data/lib/fastlane/plugin/appbox/actions/appbox_action.rb

@@ -1,4 +1,5 @@
 require "json"
+require "shellwords"
 require 'fastlane/action'
 require_relative '../helper/appbox_helper'
 
@@ -8,111 +9,97 @@ module Fastlane
       APPBOX_IPA_URL = :APPBOX_IPA_URL
       APPBOX_SHARE_URL = :APPBOX_SHARE_URL
       APPBOX_MANIFEST_URL = :APPBOX_MANIFEST_URL
-      APPBOX_LONG_SHARE_URL = :APPBOX_LONG_SHARE_URL
     end
 
     class AppboxAction < Action
       def self.run(params)
-        #emails param
+
+        #custom dropbox folder name
+        if params[:dropbox_folder_name]
+          dropbox_folder_name = params[:dropbox_folder_name]
+          UI.message("Dropbox folder name - #{dropbox_folder_name}")
+        end
+
+        # AppBox CLI
+        appboxcli = "appboxcli"
+        appboxcli_path = `which #{appboxcli}`.strip
+        if appboxcli_path.empty?
+          UI.user_error!("AppBox CLI not found. Install it from AppBox Preferences > General, or read more here - https://docs.getappbox.com/CommandLineInterface/")
+        end
+
+        ipa_path = Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH]
+        if ipa_path.nil? || ipa_path.to_s.empty?
+          UI.user_error!("No IPA found. Run `gym`/`build_app` before `appbox`, or set lane_context[SharedValues::IPA_OUTPUT_PATH] yourself.")
+        end
+        UI.user_error!("IPA not found at #{ipa_path}") unless File.exist?(ipa_path)
+        UI.message("IPA PATH - #{ipa_path}")
+
+        # Start AppBox
+        UI.message("")
+        UI.message("Starting AppBox...")
+        UI.message("Upload process will start soon. Upload process might take a few minutes. Please don't interrupt the script.")
+
+        # Built as an argv array and run without a shell, so a value containing a
+        # quote or a space cannot break the command.
+        args = [appboxcli, "--ipa", ipa_path.to_s]
+
         if params[:emails]
-          emails = params[:emails]
-          UI.message("Emails - #{emails}")
+          args += ["--emails", params[:emails].to_s]
+          UI.message("Emails - #{params[:emails]}")
         end
 
-        #developer personal message param
         if params[:message]
-          message = params[:message]
-          UI.message("Message - #{message}")
+          args += ["--message", params[:message].to_s]
+          UI.message("Message - #{params[:message]}")
         end
 
-        #keep same linkparam
-        if params[:keep_same_link]
-          keep_same_link = params[:keep_same_link]
-          UI.message("Keep Same Link - #{keep_same_link}")
+        if params[:keep_same_link] == true
+          args << "--keepsamelink"
+          UI.message("Keep Same Link - #{params[:keep_same_link]}")
         end
 
-        #custom dropbox folder name
-        if params[:dropbox_folder_name]
-          dropbox_folder_name = params[:dropbox_folder_name]
-          UI.message("Dropbox folder name - #{dropbox_folder_name}")
+        if dropbox_folder_name
+          args += ["--dbfolder", dropbox_folder_name.to_s]
+          UI.message("Dropbox Folder Name - #{dropbox_folder_name}")
         end
 
-        #AppBox Path
-        if params[:appbox_path]
-          appbox_path = "#{params[:appbox_path]}/Contents/MacOS/AppBox"
-        else
-          appbox_path =  "/Applications/AppBox.app/Contents/MacOS/AppBox"
+        if params[:slack_webhook_url]
+          args += ["--slackwebhook", params[:slack_webhook_url].to_s]
+          UI.message("Slack Webhook URL - #{params[:slack_webhook_url]}")
         end
 
-        #Check if AppBox exist at given path 
-        if File.file?(appbox_path)
-          UI.message("")
-          UI.message("AppBox Path - #{appbox_path}")
-
-          ipa_path = Actions.lane_context[ Actions::SharedValues::IPA_OUTPUT_PATH ]
-          ipa_file_name = File.basename(ipa_path)
-          UI.message("IPA PATH - #{ipa_path}")
-
-          # Copy ipa file into AppBox temporary directory
-          appbox_data_dir = File.expand_path("~/Library/Containers/com.developerinsider.AppBox/Data")
-          appbox_temp_path = File.join(appbox_data_dir, "tmp")
-          UI.message("Copying IPA file to AppBox temporary directory - #{appbox_temp_path}")
-          FileUtils.cp ipa_path, appbox_temp_path
-          temp_ipa_path = File.join(appbox_temp_path, ipa_file_name)
-
-          # Start AppBox
-          UI.message("")
-          UI.message("Starting AppBox...")
-          UI.message("Upload process will start soon. Upload process might take a few minutes. Please don't interrupt the script.")
-          if dropbox_folder_name
-            exit_status = system("exec #{appbox_path} ipa='#{temp_ipa_path}' email='#{emails}' message='#{message}' keepsamelink=#{keep_same_link} dbfolder='#{dropbox_folder_name}'")
-          else
-            exit_status = system("exec #{appbox_path} ipa='#{temp_ipa_path}' email='#{emails}' message='#{message}' keepsamelink='#{keep_same_link}'")
-          end
+        if params[:ms_teams_webhook_url]
+          args += ["--msteamswebhook", params[:ms_teams_webhook_url].to_s]
+          UI.message("MS Teams Webhook URL - #{params[:ms_teams_webhook_url]}")
+        end
 
-          # Print upload status
-          if exit_status
-            UI.success("Successfully uploaded the IPA file to DropBox. Check below summary for more details.")
-            # Check if share url file exist and print value
-            share_url_file_path = File.join(appbox_data_dir, "Documents", ".appbox_share_value.json")
-            if File.file?(share_url_file_path)
-              file = File.read(share_url_file_path)
-              share_urls_values = JSON.parse(file)
-
-              Actions.lane_context[SharedValues::APPBOX_IPA_URL] = share_urls_values['APPBOX_IPA_URL']
-              Actions.lane_context[SharedValues::APPBOX_SHARE_URL] = share_urls_values['APPBOX_SHARE_URL']
-              Actions.lane_context[SharedValues::APPBOX_MANIFEST_URL] = share_urls_values['APPBOX_MANIFEST_URL']
-
-              FastlaneCore::PrintTable.print_values(config: share_urls_values, hide_keys: [], title: "Summary for AppBox")
-            end
-            clean_temporary_files(appbox_temp_path)
-            UI.success('AppBox finished successfully')
-          else 
-            clean_temporary_files(appbox_temp_path)
-            UI.error('AppBox finished with errors')
-            UI.message('Please feel free to open an issue on the project GitHub page. Please include a description of what is not working right with your issue. https://github.com/getappbox/fastlane-plugin-appbox/issues/new')
-            exit
-          end
-        else
-          UI.error("AppBox not found at path #{appbox_path}. Please download (https://getappbox.com/download) and install appbox first. ")
-          exit
+        if params[:webhook_message]
+          args += ["--webhookmessage", params[:webhook_message].to_s]
+          UI.message("Webhook Message - #{params[:webhook_message]}")
         end
-        
-      end
 
-      # Delete all files/folders in AppBox temporary directory
-      def self.clean_temporary_files(appbox_temp_path)
-        UI.message("Cleaning AppBox temporary directory - #{appbox_temp_path}")
-        if File.directory?(appbox_temp_path)
-          Dir.foreach(appbox_temp_path) do |file|
-            next if file == '.' or file == '..'
-            file_path = File.join(appbox_temp_path, file)
-            if File.file?(file_path)
-              File.delete(file_path)
-            else
-              FileUtils.rm_rf(file_path)
-            end
+        UI.message("AppBox Command - #{Shellwords.join(args)}")
+
+        # Execute without a shell.
+        exit_status = system(*args)
+
+        # Print upload status
+        if exit_status
+          UI.success("Successfully uploaded the IPA file to DropBox. Check below summary for more details.")
+          # Check if share url file exist and print value
+          share_url_file_path = File.join(File.expand_path('~'), ".appbox_share_value.json")
+          if File.file?(share_url_file_path)
+            file = File.read(share_url_file_path)
+            share_urls_values = JSON.parse(file)
+            Actions.lane_context[SharedValues::APPBOX_IPA_URL] = share_urls_values['APPBOX_IPA_URL']
+            Actions.lane_context[SharedValues::APPBOX_SHARE_URL] = share_urls_values['APPBOX_SHARE_URL']
+            Actions.lane_context[SharedValues::APPBOX_MANIFEST_URL] = share_urls_values['APPBOX_MANIFEST_URL']
+            FastlaneCore::PrintTable.print_values(config: share_urls_values, hide_keys: [], title: "Summary for AppBox")
           end
+          UI.success('AppBox finished successfully')
+        else
+          UI.error('AppBox finished with errors')
+          UI.user_error!('AppBox upload failed. Please feel free to open an issue on the project GitHub page, including a description of what is not working. https://github.com/getappbox/fastlane-plugin-appbox/issues/new')
         end
       end
 
@@ -121,7 +108,6 @@ module Fastlane
           ['APPBOX_IPA_URL', 'Upload IPA file URL to download IPA file.'],
           ['APPBOX_MANIFEST_URL', 'Manifest file URL for upload application.'],
           ['APPBOX_SHARE_URL', 'AppBox short shareable URL to install uploaded application.'],
-          ['APPBOX_LONG_SHARE_URL', 'AppBox long shareable URL to install uploaded application.']
         ]
       end
 
@@ -142,16 +128,11 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :emails,
                                        env_name: "FL_APPBOX_EMAILS",
                                        description: "Comma-separated list of email address that should receive application installation link",
-                                       optional: false),
-
-          FastlaneCore::ConfigItem.new(key: :appbox_path,
-                                       env_name: "FL_APPBOX_PATH",
-                                       description: "If you've setup AppBox in the different directory then you need to mention that here. Default is '/Applications/AppBox.app'",
                                        optional: true),
 
           FastlaneCore::ConfigItem.new(key: :message,
                                        env_name: "FL_APPBOX_MESSAGE",
-                                       description: "Attach personal message in the email. Supported Keywords: The {PROJECT_NAME} - For Project Name, {BUILD_VERSION} - For Build Version, and {BUILD_NUMBER} - For Build Number",
+                                       description: "A personal message shown under \"Message from the developer\" in the email. Sent verbatim; AppBox 4 does not substitute {BUILD_NAME}/{BUILD_VERSION}/{BUILD_NUMBER} placeholders",
                                        optional: true),
 
           FastlaneCore::ConfigItem.new(key: :keep_same_link,
@@ -165,6 +146,21 @@ module Fastlane
                                        env_name: "FL_APPBOX_DB_FOLDER_NAME",
                                        description: "You can change the link by providing a Custom Dropbox Folder Name. By default folder name will be the application bundle identifier. So, AppBox will keep the same link for the IPA file available in the same folder. Read more here - https://docs.getappbox.com/Features/keepsamelink/",
                                        optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :slack_webhook_url,
+                                       env_name: "FL_APPBOX_SLACK_WEBHOOK_URL",
+                                       description: "Slack Incoming Webhook URL to send notification to a Slack channel",
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :ms_teams_webhook_url,
+                                       env_name: "FL_APPBOX_MS_TEAMS_WEBHOOK_URL",
+                                       description: "Microsoft Teams Incoming Webhook URL to send notification to a Teams channel",
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :webhook_message,
+                                       env_name: "FL_APPBOX_WEBHOOK_MESSAGE",
+                                       description: "Deprecated and ignored since AppBox 4 — the notification text is generated from the build. Accepted so existing Fastfiles keep working",
+                                       optional: true),
         ]
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Appbox
-    VERSION = "3.4.0"
+    VERSION = "4.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appbox
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Vineet Choudhary
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-24 00:00:00.000000000 Z
+date: 2026-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Deploy Development, Ad-Hoc and In-house (Enterprise) iOS applications directly