fastlane-plugin-applivery 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 896d1a5cf3e8bd2ca4026553c73b1260341495dc78ad9768e9e51f36f88a8ebe
-  data.tar.gz: 88b8923a87645ae48eaf99c6b9d542a5b4685aa66cb0b59cd9cab08b913a6ad5
+  metadata.gz: 2a52ad4e11f20fe0e95a88314e0ff3ffe9d76df86d5b170e8b5c8252ab3e1d79
+  data.tar.gz: b1e28178c7d60a27aad0105d5acace27afa759db510f5351a584e8b6922dc2b5
 SHA512:
-  metadata.gz: e4e5bbeed4475c9f4c5b01dcac9c780adcc24c8c018059f0dff02cc5fbfe8bed96ae2509f539471d547f32fe8e42e85cc07e4787a0ab43c1b4fdeb72dd1f0a0c
-  data.tar.gz: e7c02526e3305c6d27e733f4ebda50c8729a0102ced57c4cf609d86b7ab5f316557f8ba61ff2efa0fdb2cceb53347842a1e110530e10ed64e43a600e6717e581
+  metadata.gz: 11e6e6eb7fa83a5d83dedeb0be90b481ffa5b7e7044fe42fa531b5b2da36d4b9f8cf49b43e2f716572a86af17ce80b1f17cce1ab5e62dab8dba6718c4ce51723
+  data.tar.gz: 65a65cd114bbf6438244a5075901fd8c2729a74a95bd644beebcf4d5bf436a2db5cf2e0d76a5858d2a0b89f7a11d8140cadf5991760faaf5e45760c135715da7

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+All notable changes to this plugin are documented in this file.
+
+## 2.5.0
+
+### Fixed
+
+- **Compatibility with fastlane 2.238 and Faraday 2** ([#20](https://github.com/fastlane-community/fastlane-plugin-applivery/issues/20)). The
+  upload crashed with `uninitialized constant Faraday::UploadIO (NameError)`, because Faraday 2 moved
+  multipart support to the `faraday-multipart` gem. The plugin now works with Faraday 1 and Faraday 2, and
+  no longer depends on the unmaintained `faraday_middleware` gem (`FaradayMiddleware::ParseJson`).
+- **No more `fatal:` lines in the console** ([#18](https://github.com/fastlane-community/fastlane-plugin-applivery/issues/18)). Repositories
+  without tags (or folders that are not a repository at all) made git print
+  `fatal: No names found, cannot describe anything.` and
+  `fatal: empty string is not a valid pathspec...`, which looked like the upload had failed. Git commands
+  are now run without leaking their output, and the details are only shown with `--verbose`.
+- The git tag, commit hash and repository URL are no longer sent with a trailing line break.
+- The branch and the commit message are now read from git when fastlane cannot resolve them, instead of
+  being reported as empty.
+- The tag of the current commit is now resolved comparing full commit hashes, instead of abbreviated ones.
+- A failure with an unexpected response (an HTML error page from a proxy, an empty body, ...) reported
+  `undefined local variable or method 'response'` instead of the HTTP status code.
+- The detection of the build generated by the previous step of the lane no longer relies on an
+  always-true condition (`elsif :android`), and falls back to the IPA generated by `gym` when the lane
+  has no platform (`fastlane run applivery`).
+
+### Added
+
+- New `timeout` option (`APPLIVERY_TIMEOUT`, 600 seconds by default) so uploading big builds over a slow
+  network does not fail after the 60 seconds Net::HTTP defaults to.
+- The build number is also detected on GitHub Actions, GitLab CI, CircleCI, Bitrise and Azure Pipelines,
+  in addition to Xcode Server, Jenkins and Travis CI.
+- Missing or wrong `build_path` values now fail immediately with an actionable message, instead of
+  uploading an empty request and letting the API reject it. Timeouts and connection errors are also
+  reported with a readable message.
+- The `applivery` action returns the id of the new build, in addition to setting the
+  `APPLIVERY_BUILD_ID` shared value.
+
+### Changed
+
+- Unit tests (they no longer need a real app token to run) and a GitHub Actions workflow running them on
+  Ruby 3.1 to 3.4. The Travis CI and CircleCI configurations were removed.
+- A Docker based end-to-end suite (`e2e/`) that uploads a real build with the combinations users
+  actually have, from Ruby 2.6 + Faraday 1 to the newest fastlane on Faraday 2. See
+  [e2e/README.md](e2e/README.md).
+- `rubocop` configuration updated, the previous one referenced cops that no longer exist.
+
+## 2.4.0
+
+- Support for private tenants through the `tenant` option.
+
+## 2.3.1
+
+- Fixed the git tag interpolation.
+
+## 2.3.0
+
+- The build is uploaded to `upload.applivery.io`.
+- Added the `filter` option to choose which groups get notified.
+
+Older releases are listed in
+[GitHub](https://github.com/fastlane-community/fastlane-plugin-applivery/releases).

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Alejandro Jimenez <alejandro.jimenez@gigigo.com>
+Copyright (c) 2026 Applivery <info@applivery.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -11,18 +11,17 @@ This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To ge
 fastlane add_plugin applivery
 ```
 
+It works with Faraday 1 and Faraday 2, so any fastlane version from 2.x on is supported.
+
 ## About Applivery.com
 
 With [Applivery.com](https://www.applivery.com) you can easily distribute your iOS and Android Apps throughout a customizable platform with no need of your users have to be registered on it.
 
 **The main purpose of this plugin is to upload a new iOS or Android build to [Applivery.com](https://www.applivery.com).**
 
-If you usually use Fastlane tools to automate the most common development tasks now you can start using out Fastlane Plugin to easily deploy new iOS and Android versions of your Apps to Applivery and close your development the cycle: Build, Test & deploy like a pro!
-
-This **fastlane** plugin will also help you to have more context about the build, attaching and displaying the most relevant information: Direct link to the repository(GitHub & Bitbucket), commit hash, Branch, Tag, etc:
+If you usually use Fastlane tools to automate the most common development tasks now you can start using our Fastlane Plugin to easily deploy new iOS and Android versions of your Apps to Applivery and close your development cycle: Build, Test & deploy like a pro!
 
-<!--![List of builds](http://www.applivery.com/wp-content/uploads/2016/08/BuildsList.png)-->
-<!--![Build details](http://www.applivery.com/wp-content/uploads/2016/08/BuilInfo.png)-->
+This **fastlane** plugin will also help you to have more context about the build, attaching and displaying the most relevant information: Direct link to the repository (GitHub & Bitbucket), commit hash, branch, tag, etc.
 
 ## Examples
 
@@ -52,26 +51,27 @@ lane :applivery_android do
 end
 ```
 
-Please check out the [example `Fastfile`](fastlane/Fastfile) to see additional examples of how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`. 
+Please check out the [example `Fastfile`](fastlane/Fastfile) to see additional examples of how to use this plugin.
 
 ## Additional Parameters
-The above examples are the most simple configuration you can have but you can add additional parameters to fully customize the deployment process. They are:
-
-| Param                    | Description                          | Mandatory | Values       |
-|--------------------------|--------------------------------------|-----------|--------------|
-| `app_token`              | Applivery App Token                  | YES       | string -> Available in the App Settings |
-| `name`                   | Applivery Build name                 | NO        | string-> i.e.: "RC 1.0"       |
-| `notify_collaborators`   | Notify Collaborators after deploy    | NO        | boolean -> i.e.: `true` / `false` |
-| `notify_employees`       | Notify Employees after deploy        | NO        | boolean -> i.e.: `true` / `false` |
-| `notify_message`         | Notification message                 | NO        | string -> i.e.: "Enjoy the new version!" |
-| `changelog`              | Release notes                        | NO        | string -> i.e.: "Bug fixing"       |
-| `tags`                   | Tags to identify the build           | NO        | string -> comma separated. i.e.: `"RC1, QA"` |
-| `filter`                 | List of groups that will be notified | NO        | string -> comma separated + special chars. i.e.: `"group1,group2\|group3"` =  (grupo1 AND grupo2) OR (grupo3) |
-| `build_path`             | Build path to the APK/AAB/IPA file   | NO        | string -> by default it takes the IPA/APK build path |
-| `tenant`                 | Private tenant name or base domain   | NO        | string -> i.e.: `mycompany` or `mycompany-apps.com`  |
+The above examples are the most simple configuration you can have but you can add additional parameters to fully customize the deployment process. Every parameter can also be set with its environment variable, which is handy on CI. They are:
+
+| Param                    | Environment variable              | Description                          | Mandatory | Values       |
+|--------------------------|-----------------------------------|--------------------------------------|-----------|--------------|
+| `app_token`              | `APPLIVERY_APP_TOKEN`             | Applivery App Token                  | YES       | string -> Available in the App Settings |
+| `name`                   | `APPLIVERY_BUILD_NAME`            | Applivery Build name                 | NO        | string-> i.e.: "RC 1.0"       |
+| `notify_collaborators`   | `APPLIVERY_NOTIFY_COLLABORATORS`  | Notify Collaborators after deploy    | NO        | boolean -> i.e.: `true` / `false` |
+| `notify_employees`       | `APPLIVERY_NOTIFY_EMPLOYEES`      | Notify Employees after deploy        | NO        | boolean -> i.e.: `true` / `false` |
+| `notify_message`         | `APPLIVERY_NOTIFY_MESSAGE`        | Notification message                 | NO        | string -> i.e.: "Enjoy the new version!" |
+| `changelog`              | `APPLIVERY_BUILD_CHANGELOG`       | Release notes                        | NO        | string -> i.e.: "Bug fixing"       |
+| `tags`                   | `APPLIVERY_BUILD_TAGS`            | Tags to identify the build           | NO        | string -> comma separated. i.e.: `"RC1, QA"` |
+| `filter`                 | `APPLIVERY_FILTER`                | List of groups that will be notified | NO        | string -> comma separated + special chars. i.e.: `"group1,group2\|group3"` =  (grupo1 AND grupo2) OR (grupo3) |
+| `build_path`             | `APPLIVERY_BUILD_PATH`            | Build path to the APK/AAB/IPA file   | NO        | string -> by default it takes the IPA/APK/AAB build path |
+| `tenant`                 | `APPLIVERY_TENANT`                | Private tenant name or base domain   | NO        | string -> i.e.: `mycompany` or `mycompany-apps.com`  |
+| `timeout`                | `APPLIVERY_TIMEOUT`               | Upload timeout in seconds            | NO        | integer -> `600` by default |
 
 ## Shared Value
-Once your build is uploaded successfuly, the new generated build ID is provided by a Shared Value `APPLIVERY_BUILD_ID` that can be accesed in your lane with `lane_context[SharedValues::APPLIVERY_BUILD_ID]`
+Once your build is uploaded successfully, the new generated build ID is provided by a Shared Value `APPLIVERY_BUILD_ID` that can be accessed in your lane with `lane_context[SharedValues::APPLIVERY_BUILD_ID]`. The action returns that same id, so it can also be assigned directly.
 
 Example:
 
@@ -80,8 +80,9 @@ lane :applivery_ios do
   gym(
     scheme: "YOUR_APP_SCHEME",        # Your App Scheme
     export_method: 'enterprise')      # Choose between: enterprise or ad-hoc
-  applivery(
-    app_token: "YOUR_APP_TOKEN"       # Your Applivery App Token)
+  build_id = applivery(
+    app_token: "YOUR_APP_TOKEN")      # Your Applivery App Token
+  puts "BUILD ID: #{build_id}"
   puts "BUILD ID: #{lane_context[SharedValues::APPLIVERY_BUILD_ID]}"
 end
 ```
@@ -98,19 +99,48 @@ Or to create a direct link to a specific build in your enterprise store:
 "https://{YOUR_WORKSPACE_SLUG}.applivery.io/#{YOUR_APP_SLUG}?os={YOUR_APP_OS}&build=#{THIS_BUILD_ID}"
 ```
 
+## Build information
+
+Along with the build, the plugin sends the context of the deployment so you can identify every build in the Applivery dashboard: the build number of the CI job (Xcode Server, Jenkins, Travis CI, GitHub Actions, GitLab CI, CircleCI, Bitrise and Azure Pipelines are detected automatically), and the branch, commit, commit message, tag and repository URL of the current git checkout. All of them are optional: nothing is reported when the build is not made from a git repository.
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
 
 ```
-rake
+bundle install
+bundle exec rake
+```
+
+To only run the tests, or to only check the code style:
+
+```
+bundle exec rake spec
+bundle exec rubocop
 ```
 
-To automatically fix many of the styling issues, use 
+To automatically fix many of the styling issues, use
+
+```
+bundle exec rubocop -a
+```
+
+### End-to-end tests
+
+There is also a Docker based end-to-end suite that installs real fastlane and
+faraday combinations (from ruby 2.6 + faraday 1 to the newest release on faraday
+2) and uploads a real build to a real Applivery app in each of them:
+
 ```
-rubocop -a
+cp e2e/config.env.example e2e/config.env   # your token, tenant and build file
+./e2e/run.sh --list
+./e2e/run.sh
 ```
 
+It needs Docker and real credentials, so it is not part of `rake` nor of CI.
+See [e2e/README.md](e2e/README.md) for the version matrix, the scenarios and
+what each run costs.
+
 ## Issues and Feedback
 
 For any other issues and feedback about this plugin, please submit it to this repository or contact us at [support@applivery.com](mailto:support@applivery.com)
@@ -119,6 +149,12 @@ For any other issues and feedback about this plugin, please submit it to this re
 
 If you have trouble using plugins, check out the [Plugins Troubleshooting](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
 
+**`uninitialized constant Faraday::UploadIO`**: you are running a plugin version older than 2.5.0 with a fastlane version that uses Faraday 2 (2.238.0 and newer). Update the plugin with `bundle update fastlane-plugin-applivery`.
+
+**Upload timeouts**: big builds on a slow network may need more time than the 600 seconds used by default. Increase it with the `timeout` option.
+
+Run `fastlane` with `--verbose` to see the upload URL, the request body and the raw API response.
+
 ## Using `fastlane` Plugins
 
 For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).

data/lib/fastlane/plugin/applivery/actions/applivery_action.rb

@@ -2,94 +2,126 @@ require 'faraday'
 
 module Fastlane
   module Actions
-
     module SharedValues
       APPLIVERY_BUILD_ID = :APPLIVERY_BUILD_ID
     end
 
     class AppliveryAction < Action
+      UPLOAD_PATH = "/v1/integrations/builds".freeze
+
+      # Default timeout for the whole upload request. Big builds on a slow
+      # network need way more than the 60 seconds Net::HTTP defaults to.
+      DEFAULT_TIMEOUT = 600
 
       def self.run(params)
-        build_path = params[:build_path]
-        build = Faraday::UploadIO.new(build_path, 'application/octet-stream') if build_path && File.exist?(build_path)
-
-        base_domain = Helper::AppliveryHelper.get_base_domain(params[:tenant])
-        upload_api_url = "https://upload.#{base_domain}"
-
-        conn = Faraday.new(url: upload_api_url) do |faraday|
-          faraday.request :multipart
-          faraday.request :url_encoded
-          # faraday.response :logger
-          faraday.use FaradayMiddleware::ParseJson
-          faraday.adapter :net_http
-        end
+        build_path = validated_build_path(params[:build_path])
+        request_body = build_request_body(params, build_path)
+        connection = Helper::AppliveryHelper.upload_connection(params[:tenant], params[:timeout])
+
+        UI.message("Uploading to Applivery... 🛫")
+        response = upload(connection, request_body, params)
 
-        response = conn.post do |req|
-          req.url '/v1/integrations/builds'
+        handle_response(response)
+      end
+
+      def self.upload(connection, request_body, params)
+        connection.post do |req|
+          req.url(UPLOAD_PATH)
           req.headers['Content-Type'] = 'multipart/form-data'
           req.headers['Accept'] = 'application/json'
           req.headers['Authorization'] = "bearer #{params[:app_token]}"
-          request_body = {
-            changelog: params[:changelog],
-            notifyCollaborators: params[:notify_collaborators],
-            notifyEmployees: params[:notify_employees],
-            notifyMessage: params[:notify_message],
-            filter: params[:filter],
-            build: build,
-            deployer: {
-              name: "fastlane",
-              info: {
-                buildNumber: Helper::AppliveryHelper.get_integration_number,
-                branch: Helper::AppliveryHelper.git_branch,
-                commit: Helper::AppliveryHelper.git_commit,
-                commitMessage: Helper::AppliveryHelper.git_message,
-                repositoryUrl: Helper::AppliveryHelper.add_git_remote,
-                tag: Helper::AppliveryHelper.git_tag,
-                triggerTimestamp: Time.now.getutc.to_i
-              } 
-            }
-          }
-          request_body[:versionName] = params[:name] if !params[:name].nil?
-          request_body[:tags] = params[:tags] if !params[:tags].nil?
-
           req.body = request_body
-          UI.message "Uploading to Applivery... 🛫"
           UI.verbose("Request Body: #{req.body}")
         end
-        UI.verbose "Response Body: #{response.body}"
-        status = response.body["status"]
-        if status
-          UI.success "Build uploaded successfully! 💪"
-          Actions.lane_context[SharedValues::APPLIVERY_BUILD_ID] = response.body["data"]["id"]
+      rescue Faraday::TimeoutError
+        UI.user_error!("Timed out while uploading the build to Applivery. You can increase the `timeout` option (currently #{params[:timeout] || DEFAULT_TIMEOUT} seconds) and try again")
+      rescue Faraday::ConnectionFailed => e
+        UI.user_error!("Could not connect to Applivery: #{e.message}. Please check your network connection#{params[:tenant] ? " and the `tenant` option (#{params[:tenant]})" : ''}")
+      end
+
+      def self.handle_response(response)
+        body = Helper::AppliveryHelper.parse_response_body(response)
+        UI.verbose("Response Body: #{body}")
+
+        if body["status"]
+          UI.success("Build uploaded successfully! 💪")
+          build_id = (body["data"] || {})["id"]
+          Actions.lane_context[SharedValues::APPLIVERY_BUILD_ID] = build_id
+          return build_id
         else
-          UI.error "Oops! Something went wrong.... 🔥"
-          error = response.body["error"]
-          Helper::AppliveryHelper.parse_error(error)
+          UI.error("Oops! Something went wrong.... 🔥")
+          Helper::AppliveryHelper.parse_error(body["error"], response.status)
+        end
+      end
+
+      # Fails early with an actionable message instead of uploading an empty
+      # request and letting the API reject it.
+      def self.validated_build_path(build_path)
+        build_path = build_path.to_s.strip
+        if build_path.empty?
+          UI.user_error!("No build to upload. Please set the `build_path` option (or the APPLIVERY_BUILD_PATH environment variable) with the path to your IPA, APK or AAB file")
+        end
+        unless File.file?(build_path)
+          UI.user_error!("Build not found at '#{build_path}'. Please double-check the `build_path` option")
         end
 
+        return build_path
       end
 
+      def self.build_request_body(params, build_path)
+        request_body = {
+          changelog: params[:changelog],
+          notifyCollaborators: params[:notify_collaborators],
+          notifyEmployees: params[:notify_employees],
+          notifyMessage: params[:notify_message],
+          filter: params[:filter],
+          build: Helper::AppliveryHelper.file_part(build_path),
+          deployer: {
+            name: "fastlane",
+            info: {
+              buildNumber: Helper::AppliveryHelper.get_integration_number,
+              branch: Helper::AppliveryHelper.git_branch,
+              commit: Helper::AppliveryHelper.git_commit,
+              commitMessage: Helper::AppliveryHelper.git_message,
+              repositoryUrl: Helper::AppliveryHelper.add_git_remote,
+              tag: Helper::AppliveryHelper.git_tag,
+              triggerTimestamp: Time.now.getutc.to_i
+            }
+          }
+        }
+        request_body[:versionName] = params[:name] unless params[:name].nil?
+        request_body[:tags] = params[:tags] unless params[:tags].nil?
+
+        return request_body
+      end
+
+      # Build generated by the previous step of the lane, if any.
       def self.build_path
         platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
         ipa_path = Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
         aab_path = Actions.lane_context[Actions::SharedValues::GRADLE_AAB_OUTPUT_PATH]
         apk_path = Actions.lane_context[Actions::SharedValues::GRADLE_APK_OUTPUT_PATH]
 
-        if platform == :ios
-          return ipa_path
-        elsif :android and !aab_path.nil?
-          return aab_path
-        else
-          return apk_path
-        end
+        return ipa_path if platform == :ios
+        return aab_path unless aab_path.nil?
+        return apk_path unless apk_path.nil?
+        return ipa_path
       end
 
       def self.description
         "Upload new iOS or Android build to Applivery"
       end
 
+      def self.details
+        [
+          "Uploads an IPA, APK or AAB file to Applivery and attaches the information of the current build:",
+          "build number, git branch, commit, commit message, tag and repository URL.",
+          "By default it takes the build generated by `gym` or `gradle` in the same lane."
+        ].join(" ")
+      end
+
       def self.authors
-        ["Alejandro Jimenez", "Cesar Trigo"]
+        ["Applivery"]
       end
 
       def self.available_options
@@ -98,6 +130,7 @@ module Fastlane
             env_name: "APPLIVERY_APP_TOKEN",
             description: "Your application identifier",
             optional: false,
+            sensitive: true,
             type: String),
 
           FastlaneCore::ConfigItem.new(key: :name,
@@ -123,6 +156,7 @@ module Fastlane
             env_name: "APPLIVERY_BUILD_PATH",
             description: "Your build path",
             default_value: self.build_path,
+            default_value_dynamic: true,
             optional: true,
             type: String),
 
@@ -146,7 +180,7 @@ module Fastlane
             default_value: "New version uploaded!",
             optional: true,
             type: String),
-          
+
           FastlaneCore::ConfigItem.new(key: :filter,
             env_name: "APPLIVERY_FILTER",
             description: "List of groups that will be notified",
@@ -158,6 +192,16 @@ module Fastlane
             description: "Your private tenant name or base domain",
             optional: true,
             type: String),
+
+          FastlaneCore::ConfigItem.new(key: :timeout,
+            env_name: "APPLIVERY_TIMEOUT",
+            description: "Timeout in seconds for the upload request",
+            default_value: DEFAULT_TIMEOUT,
+            optional: true,
+            type: Integer,
+            verify_block: proc do |value|
+              UI.user_error!("`timeout` must be greater than 0") unless value.to_i.positive?
+            end)
         ]
       end
 
@@ -167,11 +211,13 @@ module Fastlane
         ]
       end
 
+      def self.return_value
+        "The id of the build created in Applivery"
+      end
+
       def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
-        
-        [:ios, :android].include?(platform)
+        # The action uploads any IPA, APK or AAB file, so it also works when the
+        # lane has no platform defined (for example with `fastlane run applivery`)
         true
       end
 
@@ -181,10 +227,24 @@ module Fastlane
 
       def self.example_code
         [
-          'applivery(app_token: "YOUR_APP_TOKEN")'
+          'applivery(app_token: "YOUR_APP_TOKEN")',
+          'applivery(
+            app_token: "YOUR_APP_TOKEN",
+            build_path: "./app/build/outputs/bundle/release/app-release.aab",
+            name: "RC 1.0",
+            changelog: "Bug fixing",
+            tags: "RC1, QA",
+            notify_collaborators: true,
+            notify_employees: false,
+            notify_message: "Enjoy the new version!",
+            filter: "group1,group2|group3"
+          )',
+          'applivery(
+            app_token: "YOUR_APP_TOKEN",
+            tenant: "mycompany"
+          )'
         ]
       end
-
     end
   end
 end

data/lib/fastlane/plugin/applivery/helper/applivery_helper.rb

@@ -1,12 +1,40 @@
+require 'faraday'
+require 'json'
+require 'open3'
+
+begin
+  # Faraday 2 extracted multipart support into the `faraday-multipart` gem and
+  # it has to be required explicitly. Faraday 1 ships it in the core gem.
+  require 'faraday/multipart'
+rescue LoadError
+  # Nothing else to load, Faraday 1 already provides multipart support.
+end
+
 module Fastlane
   module Helper
     class AppliveryHelper
       # class methods that you define here become available in your action
       # as `Helper::AppliveryHelper.your_method`
       #
-      def self.show_message
-        UI.message("Hello from the applivery plugin helper!")
-      end
+      DEFAULT_DOMAIN = "applivery.io".freeze
+      UPLOAD_MIME_TYPE = "application/octet-stream".freeze
+
+      # Seconds we wait for the connection to be established. The upload itself
+      # is limited by the `timeout` option of the action instead.
+      OPEN_TIMEOUT = 60
+
+      # Environment variables holding the build number of the current CI job,
+      # ordered by precedence.
+      INTEGRATION_NUMBER_ENV_VARS = [
+        "XCS_INTEGRATION_NUMBER", # Xcode Server
+        "BUILD_NUMBER",           # Jenkins
+        "TRAVIS_BUILD_NUMBER",    # Travis CI
+        "GITHUB_RUN_NUMBER",      # GitHub Actions
+        "CI_PIPELINE_IID",        # GitLab CI
+        "CIRCLE_BUILD_NUM",       # CircleCI
+        "BITRISE_BUILD_NUMBER",   # Bitrise
+        "BUILD_BUILDID"           # Azure Pipelines
+      ].freeze
 
       def self.platform
         platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
@@ -18,83 +46,154 @@ module Fastlane
       end
 
       def self.get_base_domain(tenant = nil)
-        default_domain = "applivery.io"
-        return default_domain if tenant.nil? || tenant.strip.empty?
+        tenant = tenant.to_s.strip
+        return DEFAULT_DOMAIN if tenant.empty?
         return tenant if tenant.include?(".")
-        return "#{tenant}.#{default_domain}"
+        return "#{tenant}.#{DEFAULT_DOMAIN}"
       end
 
       def self.get_integration_number
-        xcodeIntegrationNumber = ENV["XCS_INTEGRATION_NUMBER"] # XCode Server
-        jenkinsIntegrationNumber = ENV["BUILD_NUMBER"] # Jenkins
-        travisIntegrationNumber = ENV["TRAVIS_BUILD_NUMBER"] # Travis
-        integrationNumber = ""
-        
-        if !xcodeIntegrationNumber.nil?
-          integrationNumber += xcodeIntegrationNumber
-        elsif !jenkinsIntegrationNumber.nil?
-          integrationNumber += jenkinsIntegrationNumber
-        elsif !travisIntegrationNumber.nil?
-          integrationNumber += travisIntegrationNumber
+        INTEGRATION_NUMBER_ENV_VARS.each do |env_var|
+          integration_number = ENV[env_var].to_s.strip
+          return integration_number unless integration_number.empty?
         end
 
-        return integrationNumber
+        return ""
+      end
+
+      ### HTTP Methods ###
+
+      # Connection used to upload the build. Both the read and the write
+      # timeouts are set from `timeout` so uploading big builds over a slow
+      # network doesn't fail after Net::HTTP's default 60 seconds.
+      def self.upload_connection(tenant = nil, timeout = nil)
+        url = "https://upload.#{get_base_domain(tenant)}"
+        UI.verbose("Applivery upload URL: #{url}")
+
+        request_options = { open_timeout: OPEN_TIMEOUT }
+        request_options[:timeout] = timeout if timeout
+
+        Faraday.new(url: url, request: request_options) do |faraday|
+          faraday.request(:multipart)
+          faraday.request(:url_encoded)
+          faraday.adapter(:net_http)
+        end
+      rescue Faraday::Error => e
+        UI.user_error!("Could not prepare the upload request: #{e.message}. Please add `gem 'faraday-multipart'` to your Gemfile and run `bundle install`")
+      end
+
+      # Wraps the build in the multipart class provided by the installed Faraday
+      # version: `Faraday::Multipart::FilePart` (Faraday 2 and Faraday >= 1.10),
+      # `Faraday::FilePart` or the long deprecated `Faraday::UploadIO`.
+      def self.file_part(path, mime_type = UPLOAD_MIME_TYPE)
+        if defined?(Faraday::Multipart::FilePart)
+          Faraday::Multipart::FilePart.new(path, mime_type)
+        elsif defined?(Faraday::FilePart)
+          Faraday::FilePart.new(path, mime_type)
+        elsif defined?(Faraday::UploadIO)
+          Faraday::UploadIO.new(path, mime_type)
+        else
+          UI.user_error!("Faraday #{Faraday::VERSION} does not provide multipart support. Please add `gem 'faraday-multipart'` to your Gemfile and run `bundle install`")
+        end
       end
 
+      # Parses the response body, which is a Hash when a JSON middleware is
+      # installed in the connection and a String otherwise.
+      def self.parse_response_body(response)
+        body = response.body
+        return body if body.kind_of?(Hash)
+
+        parsed_body = JSON.parse(body.to_s)
+        parsed_body.kind_of?(Hash) ? parsed_body : {}
+      rescue JSON::ParserError
+        UI.verbose("Response body is not valid JSON: #{response.body}")
+        return {}
+      end
 
       ### GIT Methods ###
 
+      # fastlane resolves the branch from the environment of the CI when possible,
+      # git is only asked when it has nothing to report.
       def self.git_branch
-        return Actions.git_branch
-      rescue
-        return ""
+        branch = fastlane_git_value { Actions.git_branch }
+        return branch unless branch.empty?
+        return git_command("rev-parse", "--abbrev-ref", "HEAD")
       end
 
       def self.git_commit
-        return `git rev-parse --short HEAD`
-      rescue
-        return ""
+        return git_command("rev-parse", "--short", "HEAD")
       end
 
       def self.git_message
-        return Actions.last_git_commit_message
-      rescue
-        return ""
+        message = fastlane_git_value { Actions.last_git_commit_message }
+        return message unless message.empty?
+        return git_command("log", "-1", "--pretty=%B")
       end
 
       def self.add_git_remote
-        return `git config --get remote.origin.url`
-      rescue
-        return ""
+        return git_command("config", "--get", "remote.origin.url")
       end
 
+      # Returns the tag pointing at HEAD, or an empty String when the current
+      # commit is not tagged (or the repository has no tags at all).
       def self.git_tag
-        gitTag = `git describe --abbrev=0 --tags`
-        gitTagCommit = `git rev-list -n 1 --abbrev-commit '#{gitTag.strip}'`
-        gitCommit = `git rev-parse --short HEAD`
-        return gitTag if gitTagCommit == gitCommit
+        tag = git_command("describe", "--abbrev=0", "--tags")
+        return "" if tag.empty?
+
+        tag_commit = git_command("rev-list", "-n", "1", tag)
+        head_commit = git_command("rev-parse", "HEAD")
+        return tag if !tag_commit.empty? && tag_commit == head_commit
         return ""
-      rescue
+      end
+
+      # Values that fastlane can provide itself. It raises when there is no git
+      # information available, and then git is asked directly.
+      def self.fastlane_git_value
+        yield.to_s.strip
+      rescue StandardError => e
+        UI.verbose("Applivery: fastlane could not provide the git information: #{e.message}")
         return ""
       end
+      private_class_method :fastlane_git_value
 
-      def self.parse_error(error)
-        if error
-          case error["code"]
-          when 5006
-            UI.user_error! "Upload fail. The build path seems to be wrong or file is invalid"
-          when 4004
-            UI.user_error! "The app_token is not valid. Please, go to your app settings and doble-check the integration tokens"
-          when 4002
-            UI.user_error! "The app_token is empty. Please, go to your app Settings->Integrations to generate a token"
-          else
-            UI.user_error! "Upload fail. [#{error["code"]}]: #{error["message"]}"
-          end
-        else
-          UI.crash! "Upload fails unexpectedly. [#{response.status}]"
+      # Runs a git command without leaking anything to the console. Git writes
+      # to stderr when there are no tags, when the folder is not a repository,
+      # etc. and those `fatal:` lines used to look like the upload had failed.
+      def self.git_command(*args)
+        output, status = Open3.capture2("git", *args, err: File::NULL)
+        unless status.success?
+          UI.verbose("Applivery: `git #{args.join(' ')}` exited with #{status.exitstatus}")
+          return ""
         end
+
+        return output.strip
+      rescue StandardError => e
+        UI.verbose("Applivery: `git #{args.join(' ')}` failed: #{e.message}")
+        return ""
       end
+      private_class_method :git_command
+
+      # `error` is the `error` object returned by the API. Anything else (a
+      # missing body, an HTML error page from a proxy, ...) ends up in the
+      # generic message including the HTTP status code.
+      def self.parse_error(error, status = nil)
+        unless error.kind_of?(Hash)
+          details = error.to_s.strip
+          details = details.empty? ? "" : ": #{details}"
+          UI.user_error!("Upload failed unexpectedly. [HTTP #{status || 'unknown'}]#{details}")
+        end
 
+        case error["code"].to_i
+        when 5006
+          UI.user_error!("Upload failed. The build path seems to be wrong or the file is invalid")
+        when 4004
+          UI.user_error!("The app_token is not valid. Please, go to your app settings and double-check the integration tokens")
+        when 4002
+          UI.user_error!("The app_token is empty. Please, go to your app Settings->Integrations to generate a token")
+        else
+          UI.user_error!("Upload failed. [#{error['code']}]: #{error['message']}")
+        end
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Applivery
-    VERSION = "2.4.0"
+    VERSION = "2.5.0".freeze
   end
 end

metadata

@@ -1,105 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-applivery
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
-- Alejandro Jimenez
-autorequire: 
+- Applivery
 bindir: bin
 cert_chain: []
-date: 2025-03-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: fastlane
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
-  name: fastlane
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.98.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.98.0
-description: 
-email: a.j.agudo@gmail.com
+        version: '3.0'
+email:
+- info@applivery.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/fastlane/plugin/applivery.rb
@@ -109,8 +149,11 @@ files:
 homepage: https://github.com/fastlane-community/fastlane-plugin-applivery
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/fastlane-community/fastlane-plugin-applivery
+  source_code_uri: https://github.com/fastlane-community/fastlane-plugin-applivery
+  changelog_uri: https://github.com/fastlane-community/fastlane-plugin-applivery/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/fastlane-community/fastlane-plugin-applivery/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -118,15 +161,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Upload new build to Applivery
 test_files: []