fastlane-plugin-saucelabs_appdist 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d3301d1ecefd85c6e0937b8ce1b7b1ff4b41c22cd28beb9f12ddb19e82ccdd4
+  data.tar.gz: eb8c4a6b0047a1a3c25fffcde4c607c4560b0f54eb858ed8d78a97ed0ad65ba5
+SHA512:
+  metadata.gz: 85b35a83c6c41e678d0fec3dcfa42fcdb356265d6feabd2e50c190c73b046889a670e5d1ad60b5d47afb01ec27fec73058920ccc4e4973e9d851483839596c8b
+  data.tar.gz: 4726a9fe7be5c1aa5a26466b1c1f9b860d186a89205ac0e121dde48da2747d0999c07067d8c52eaae93e2d97ccf8f392a9bf5659e8a2f0332916b4c575a30442

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simon Sarrafi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# fastlane-plugin-saucelabs_appdist
+
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-saucelabs_appdist.svg)](https://rubygems.org/gems/fastlane-plugin-saucelabs_appdist)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+A [Sauce Labs](https://saucelabs.com) fastlane plugin for uploading builds to **Mobile App Distribution**.
+
+For more information about Sauce Labs Mobile App Distribution, see the [product page](https://saucelabs.com/products/mobile-testing/app-betas).
+
+## Installation
+
+```sh
+fastlane add_plugin saucelabs_appdist
+```
+
+Or add the plugin manually to your project's `Pluginfile`:
+
+```ruby
+gem 'fastlane-plugin-saucelabs_appdist'
+```
+
+## Usage
+
+```ruby
+saucelabs_appdist(
+  api_key: "your_api_key",
+  ipa: "./path/to/app.ipa",
+  comment: "Build #{lane_context[SharedValues::BUILD_NUMBER]}"
+)
+```
+
+## Parameters
+
+| Key | Description | Default |
+|-----|-------------|---------|
+| `api_key` | API Key for Sauce Labs App Distribution | — |
+| `ipa` | Path to your IPA file (iOS) | — |
+| `apk` | Path to your APK file (Android) | — |
+| `symbols_file` | Symbols mapping file | — |
+| `upload_url` | API URL for App Distribution | `https://app.testfairy.com` |
+| `testers_groups` | Array of tester groups | `[]` |
+| `metrics` | Array of metrics to record | `[]` |
+| `comment` | Additional release notes | `No comment provided` |
+| `auto_update` | Auto-upgrade users (`on`/`off`) | `off` |
+| `notify` | Send email to testers (`on`/`off`) | `off` |
+| `options` | Array of options | `[]` |
+| `custom` | Custom options string | `""` |
+| `timeout` | Request timeout in seconds | — |
+| `tags` | Custom tags for builds | `[]` |
+| `folder_name` | Dashboard folder name | `""` |
+| `landing_page_mode` | Landing page visibility (`open`/`closed`) | `open` |
+| `upload_to_saucelabs` | Upload to Sauce Labs (`on`/`off`) | `off` |
+| `platform` | Platform override | `""` |
+
+## Response
+
+The `SAUCELABS_APPDIST_UPLOAD_RESPONSE` shared value contains the full JSON response from the upload API. It is set in `lane_context` and can be accessed in subsequent lanes:
+
+```ruby
+lane_context[SharedValues::SAUCELABS_APPDIST_UPLOAD_RESPONSE]
+```
+
+Example response:
+
+```json
+{
+  "status": "ok",
+  "build_id": "1",
+  "project_id": "1",
+  "app_name": "My Demo App",
+  "app_version": "2.0.2 - 2026-02-19 02:51:05",
+  "file_size": 2319620,
+  "build_url": "https://app.testfairy.com/projects/1/builds/1",
+  "download_page_url": "https://app.testfairy.com/join/xxxxxx",
+  "app_url": "https://app.testfairy.com/download/.../getapp",
+  "invite_testers_url": "https://app.testfairy.com/projects/1/builds/1/invite",
+  "icon_url": "https://app.testfairy.com/icons/.../icon.png",
+  "options": "video-quality=medium,screenshot-interval=1,session-length=60m,video,logcat,shake,cpu,memory,phone-signal,battery,wifi",
+  "platform": "iOS",
+  "tags": [],
+  "metadata": [],
+  "has_testfairy_sdk": true,
+  "symbols_download_url": null,
+  "attachments": null,
+  "landing_page_url": "https://app.testfairy.com/join/xxxxxx",
+  "build_specific_landing_page_url": "https://app.testfairy.com/join/xxxxxx?id=1",
+  "landing_page_mode": "closed"
+}
+```

data/lib/fastlane/plugin/saucelabs_appdist/actions/saucelabs_appdist_action.rb

@@ -0,0 +1,305 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      SAUCELABS_APPDIST_UPLOAD_RESPONSE = :SAUCELABS_APPDIST_UPLOAD_RESPONSE
+    end
+
+    class SaucelabsAppdistAction < Action
+      def self.upload_build(upload_url, ipa, options, timeout)
+        require 'faraday'
+        require 'faraday_middleware'
+
+        UI.success("Uploading to #{upload_url}...")
+
+        connection = Faraday.new(url: upload_url) do |builder|
+          builder.request(:multipart)
+          builder.request(:url_encoded)
+          builder.request(:retry, max: 3, interval: 5)
+          builder.response(:json, content_type: /\bjson$/)
+          builder.use(FaradayMiddleware::FollowRedirects)
+          builder.adapter(:net_http)
+        end
+
+        options[:file] = Faraday::UploadIO.new(ipa, 'application/octet-stream') if ipa && File.exist?(ipa)
+
+        symbols_file = options.delete(:symbols_file)
+        if symbols_file
+          options[:symbols_file] = Faraday::UploadIO.new(symbols_file, 'application/octet-stream')
+        end
+
+        begin
+          connection.post do |req|
+            req.options.timeout = timeout
+            req.url("/api/upload/")
+            req.body = options
+          end
+        rescue Faraday::TimeoutError
+          UI.crash!("Uploading build to Sauce Labs App Distribution timed out ⏳")
+        end
+      end
+
+      def self.run(params)
+        UI.success('Starting with ipa upload to Sauce Labs App Distribution...')
+
+        metrics_to_client = lambda do |metrics|
+          metrics.map do |metric|
+            case metric
+            when :cpu, :memory, :network, :gps, :battery, :mic, :wifi
+              metric.to_s
+            when :phone_signal
+              'phone-signal'
+            else
+              UI.user_error!("Unknown metric: #{metric}")
+            end
+          end
+        end
+
+        options_to_client = lambda do |options|
+          options.map do |option|
+            case option.to_sym
+            when :shake, :anonymous
+              option.to_s
+            when :video_only_wifi
+              'video-only-wifi'
+            else
+              UI.user_error!("Unknown option: #{option}")
+            end
+          end
+        end
+
+        # Rejecting key `upload_url` and `timeout` as we don't need it in options
+        client_options = Hash[params.values.reject do |key, value|
+          [:upload_url, :timeout].include?(key)
+        end.map do |key, value|
+          case key
+          when :api_key
+            [key, value]
+          when :ipa
+            [key, value]
+          when :apk
+            [key, value]
+          when :symbols_file
+            [key, value]
+          when :testers_groups
+            [key, value.join(',')]
+          when :metrics
+            [key, metrics_to_client.call(value).join(',')]
+          when :comment
+            [key, value]
+          when :auto_update
+            ['auto-update', value]
+          when :notify
+            [key, value]
+          when :options
+            [key, options_to_client.call(value).join(',')]
+          when :custom
+            [key, value]
+          when :tags
+            [key, value.join(',')]
+          when :folder_name
+            [key, value]
+          when :landing_page_mode
+            [key, value]
+          when :upload_to_saucelabs
+            [key, value]
+          when :platform
+            [key, value]
+          else
+            UI.user_error!("Unknown parameter: #{key}")
+          end
+        end]
+
+        path = params[:ipa] || params[:apk]
+        UI.user_error!("No ipa or apk were given") unless path
+
+        return path if Helper.test?
+
+        response = self.upload_build(params[:upload_url], path, client_options, params[:timeout])
+        if parse_response(response)
+          UI.success("Build successfully uploaded to Sauce Labs App Distribution.")
+          UI.success("Response:\n#{JSON.pretty_generate(Actions.lane_context[SharedValues::SAUCELABS_APPDIST_UPLOAD_RESPONSE])}")
+        else
+          UI.user_error!("Error when trying to upload ipa to Sauce Labs App Distribution")
+        end
+      end
+
+      def self.parse_response(response)
+        if response.body && response.body.key?('status') && response.body['status'] == 'ok'
+          Actions.lane_context[SharedValues::SAUCELABS_APPDIST_UPLOAD_RESPONSE] = response.body
+
+          return true
+        else
+          UI.error("Error uploading to Sauce Labs App Distribution: #{response.body}")
+
+          return false
+        end
+      end
+      private_class_method :parse_response
+
+      def self.description
+        'Upload a new build to Sauce Labs App Distribution'
+      end
+
+      def self.details
+        'A Sauce Labs fastlane plugin for uploading iOS and Android builds to Mobile App Distribution (MAD).'
+      end
+
+      def self.available_options
+        [
+          # required
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "FL_SAUCELABS_APPDIST_API_KEY",
+                                       description: "API Key for Sauce Labs App Distribution",
+                                       sensitive: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API key for Sauce Labs App Distribution given, pass using `api_key: 'key'`") unless value.to_s.length > 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                       env_name: 'SAUCELABS_APPDIST_IPA_PATH',
+                                       description: 'Path to your IPA file for iOS',
+                                       default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       conflicting_options: [:apk],
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find ipa file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :apk,
+                                       env_name: 'SAUCELABS_APPDIST_APK_PATH',
+                                       description: 'Path to your APK file for Android',
+                                       default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH],
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       conflicting_options: [:ipa],
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find apk file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          # optional
+          FastlaneCore::ConfigItem.new(key: :symbols_file,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_SYMBOLS_FILE",
+                                       description: "Symbols mapping file",
+                                       default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH],
+                                       default_value_dynamic: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find dSYM file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :upload_url,
+                                       env_name: "FL_SAUCELABS_APPDIST_UPLOAD_URL",
+                                       description: "API URL for Sauce Labs App Distribution",
+                                       default_value: "https://app.testfairy.com",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :testers_groups,
+                                       optional: true,
+                                       type: Array,
+                                       short_option: '-g',
+                                       env_name: "FL_SAUCELABS_APPDIST_TESTERS_GROUPS",
+                                       description: "Array of tester groups to be notified",
+                                       default_value: []),
+          FastlaneCore::ConfigItem.new(key: :metrics,
+                                       optional: true,
+                                       type: Array,
+                                       env_name: "FL_SAUCELABS_APPDIST_METRICS",
+                                       description: "Array of metrics to record (cpu,memory,network,phone_signal,gps,battery,mic,wifi)",
+                                       default_value: []),
+          FastlaneCore::ConfigItem.new(key: :comment,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_COMMENT",
+                                       description: "Additional release notes for this upload. This text will be added to email notifications",
+                                       default_value: 'No comment provided'),
+          FastlaneCore::ConfigItem.new(key: :auto_update,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_AUTO_UPDATE",
+                                       description: "Allows an easy upgrade of all users to the current version. To enable set to 'on'",
+                                       default_value: 'off'),
+          FastlaneCore::ConfigItem.new(key: :notify,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_NOTIFY",
+                                       description: "Send email to testers",
+                                       default_value: 'off'),
+          FastlaneCore::ConfigItem.new(key: :options,
+                                       optional: true,
+                                       type: Array,
+                                       env_name: "FL_SAUCELABS_APPDIST_OPTIONS",
+                                       description: "Array of options (shake,video_only_wifi,anonymous)",
+                                       default_value: []),
+          FastlaneCore::ConfigItem.new(key: :custom,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_CUSTOM",
+                                       description: "Array of custom options. Contact support for more information",
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :timeout,
+                                       env_name: "FL_SAUCELABS_APPDIST_TIMEOUT",
+                                       description: "Request timeout in seconds",
+                                       type: Integer,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :tags,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_TAGS",
+                                       description: "Custom tags that can be used to organize your builds",
+                                       type: Array,
+                                       default_value: []),
+          FastlaneCore::ConfigItem.new(key: :folder_name,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_FOLDER_NAME",
+                                       description: "Name of the dashboard folder that contains this app",
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :landing_page_mode,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_LANDING_PAGE_MODE",
+                                       description: "Visibility of build landing after upload. Can be 'open' or 'closed'",
+                                       default_value: 'open',
+                                       verify_block: proc do |value|
+                                         UI.user_error!("The landing page mode can only be open or closed") unless %w(open closed).include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :upload_to_saucelabs,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_UPLOAD_TO_SAUCELABS",
+                                       description: "Upload file directly to Sauce Labs. It can be 'on' or 'off'",
+                                       default_value: 'off',
+                                       verify_block: proc do |value|
+                                         UI.user_error!("The upload to Sauce Labs can only be on or off") unless %w(on off).include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                       optional: true,
+                                       env_name: "FL_SAUCELABS_APPDIST_PLATFORM",
+                                       description: "Use if upload build is not iOS or Android. Contact support for more information",
+                                       default_value: '')
+        ]
+      end
+
+      def self.example_code
+        [
+          'saucelabs_appdist(
+            api_key: "...",
+            ipa: "./ipa_file.ipa",
+            comment: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
+          )',
+          'saucelabs_appdist(
+            api_key: "...",
+            apk: "../build/app/outputs/apk/qa/release/app-qa-release.apk",
+            comment: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
+           )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
+
+      def self.output
+        [
+          ['SAUCELABS_APPDIST_UPLOAD_RESPONSE', 'Full response from the upload API']
+        ]
+      end
+
+      def self.authors
+        ["Sauce Labs"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/saucelabs_appdist/helper/saucelabs_appdist_helper.rb

@@ -0,0 +1,13 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class SaucelabsAppdistHelper
+      def self.show_message
+        UI.message("Hello from the saucelabs_appdist plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/saucelabs_appdist/saucelabs_appdist.rb

@@ -0,0 +1,13 @@
+require 'fastlane/plugin/saucelabs_appdist/version'
+
+module Fastlane
+  module SaucelabsAppdist
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+Fastlane::SaucelabsAppdist.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module SaucelabsAppdist
+    VERSION = "0.3.0"
+  end
+end

data/lib/fastlane/plugin/saucelabs_appdist.rb

@@ -0,0 +1 @@
+require 'fastlane/plugin/saucelabs_appdist/saucelabs_appdist'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-saucelabs_appdist
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Sauce Labs
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+description: A Sauce Labs fastlane plugin for uploading iOS and Android builds to
+  Mobile App Distribution.
+email: mobileappdistribution@saucelabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/saucelabs_appdist.rb
+- lib/fastlane/plugin/saucelabs_appdist/actions/saucelabs_appdist_action.rb
+- lib/fastlane/plugin/saucelabs_appdist/helper/saucelabs_appdist_helper.rb
+- lib/fastlane/plugin/saucelabs_appdist/saucelabs_appdist.rb
+- lib/fastlane/plugin/saucelabs_appdist/version.rb
+homepage: https://saucelabs.com/products/mobile-testing/app-betas
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Sauce Labs plugin for uploading builds to Mobile App Distribution
+test_files: []