fastlane-plugin-appcenter 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f420746739b204f6bfd6e9e5dd23f841028009e63ed49adf45107b053eeb24ac
-  data.tar.gz: '07896d07c221682028e2c59166c8d248a2ede8d953a3da408f734509eb10ae3a'
+  metadata.gz: 39cd3b20f7c98ea0ac0068fdcdb5e8528b763e747efba88d4c6f8da48f902d6d
+  data.tar.gz: ca7d95d7ed15b4b5aef398dbfc7d83ef318cf7bb976d8551733950b25bf80fec
 SHA512:
-  metadata.gz: 71b84cb05df74504d82d8aaf83626c999f69fdc06481fc072baada8aa29d24fd9e13652359f84a8cca5417b64f3457b5f33dd12d1a769e388e9aa430b0befb7e
-  data.tar.gz: 6e85fa4da98dfbba7a4147aad34aed090dc1e69224495be770587149dd0efb27747ac5b4ed4b7d1570b24656a610477dab359edbaaedcd6a05fde8d5ef50a452
+  metadata.gz: c4f6ae8f7f2b77e0546aa65897362f64959be25b3475c364a85cd3371da31ea3b8b9a8dbc7d77232bdc69172ba34faf61354b5e9b6ea24838e8cab6d14ee418c
+  data.tar.gz: de52913eb094b8592428f60835691873e5ad306b5885de6a1bf7b048cdbfcddc69067cc60806bf1306bee40ed5b9aba5e1d5911fca3315859a024c5a57d924c8

data/README.md

@@ -13,47 +13,103 @@ fastlane add_plugin appcenter
 ```
 
 ## About App Center
-With [App Center](https://appcenter.ms) you can continuously build, test, release, and monitor your apps. This plugin provides an `appcenter_upload` action which allows you to upload and [release distribute](https://docs.microsoft.com/en-us/appcenter/distribution/uploading) apps to your testers on App Center as well as to upload .dSYM files to [collect detailed crash reports](https://docs.microsoft.com/en-us/appcenter/crashes/ios) in App Center.
+With [App Center](https://appcenter.ms) you can continuously build, test, release, and monitor your apps. This plugin provides a set of actions to interact with App Center.
+
+`appcenter_fetch_devices` allows you to obtain the list of iOS devices to distribute an app to (useful for automatic provisioning of testers' devices).
+
+`appcenter_upload` allows you to upload and [distribute](https://docs.microsoft.com/en-us/appcenter/distribution/uploading) apps to your testers on App Center as well as to upload .dSYM files to [collect detailed crash reports](https://docs.microsoft.com/en-us/appcenter/crashes/ios) in App Center.
 
 ## Usage
 
 To get started, first, [obtain an API token](https://appcenter.ms/settings/apitokens) in App Center. The API Token is used to authenticate with the App Center API in each call.
 
 ```ruby
-appcenter_upload(
+appcenter_fetch_devices(
   api_token: "<appcenter token>",
   owner_name: "<appcenter account name of the owner of the app (username or organization URL name)>",
   app_name: "<appcenter app name>",
-  apk: "<path to android build binary>",
+  destinations: "*", # Default is 'Collaborators', use '*' for all distribution groups
+  devices_file: "devices.txt" # Default. If you customize, the extension must be .txt
+)
+```
+
+```ruby
+appcenter_upload(
+  api_token: "<appcenter token>",
+  owner_name: "<appcenter owner name of the app (as seen in app URL)>",
+  app_name: "<appcenter app name (as seen in app URL)>",
+  file: "<path to android build binary>",
   notify_testers: true # Set to false if you don't want to notify testers of your new release (default: `false`)
 )
 ```
 
-The action parameters `api_token` and `owner_name` can also be omitted when their values are [set as environment variables](https://docs.fastlane.tools/advanced/#environment-variables). Below a list of all available environment variables:
-
-- `APPCENTER_API_TOKEN` - API Token for App Center
-- `APPCENTER_OWNER_TYPE` - Owner type - `user` or `organization` (default value is `user`)
-- `APPCENTER_OWNER_NAME` - Owner name
-- `APPCENTER_APP_NAME` - App name. If there is no app with such name, you will be prompted to create one
-- `APPCENTER_DISTRIBUTE_APK` - Build release path for android build
-- `APPCENTER_DISTRIBUTE_AAB` - Build release path for android app bundle build
-- `APPCENTER_DISTRIBUTE_IPA` - Build release path for ios build
-- `APPCENTER_DISTRIBUTE_DSYM` - Path to your symbols (app.dSYM.zip) file
-- `APPCENTER_DISTRIBUTE_UPLOAD_DSYM_ONLY` - Flag to upload only the dSYM file to App Center
-- `APPCENTER_DISTRIBUTE_ANDROID_MAPPING` - Path to your Android mapping.txt file
-- `APPCENTER_DISTRIBUTE_UPLOAD_ANDROID_MAPPING_ONLY` - Flag to upload only the mapping file to App Center
-- `APPCENTER_DISTRIBUTE_DESTINATIONS` - Comma separated list of destination names. Both distribution groups and stores are supported. All names are required to be of the same destination type. Default is `Collaborators`.
-- `APPCENTER_DISTRIBUTE_DESTINATION_TYPE` - Destination type of distribution destination. `group` and `store` are supported. Default is `group`
-- `APPCENTER_DISTRIBUTE_MANDATORY_UPDATE` - Require users to update to this release
-- `APPCENTER_DISTRIBUTE_NOTIFY_TESTERS` - Send email notification about release (default: `false`)
-- `APPCENTER_DISTRIBUTE_RELEASE_NOTES` - Release notes
-- `APPCENTER_DISTRIBUTE_RELEASE_NOTES_CLIPPING` - Clip release notes if its length is more then 5000, `true` by default
-- `APPCENTER_DISTRIBUTE_RELEASE_NOTES_LINK` - Additional release notes link
-- `APPCENTER_DISTRIBUTE_TIMEOUT` - Sets the request timeout in seconds. Used when uploading builds to App Center.
+### Help
+
+Once installed, information and help for an action can be printed out with this command:
+
+```bash
+fastlane action appcenter_upload # or any action included with this plugin
+```
+
+### A note on App Name
+
+The `app_name` and `owner_name` as set in the Fastfile come from the app's URL in App Center, in the below form:
+```
+https://appcenter.ms/users/{owner_name}/apps/{app_name}
+```
+They should not be confused with the displayed name on App Center pages, which is called `app_display_name ` instead.
+
+### Parameters
+
+The action parameters `api_token`, `owner_name`, `app_name`, and others can also be omitted when their values are [set as environment variables](https://docs.fastlane.tools/advanced/#environment-variables). By default, `appcenter_upload` will use the same `api_token`, `owner_name`, and `app_name` you used in `appcenter_fetch_devices`.
+
+Here is the list of all existing parameters:
+
+#### `appcenter_fetch_devices`
+
+| Key & Env Var | Description |
+|-----------------|--------------------|
+| `api_token` <br/> `APPCENTER_API_TOKEN` | API Token for App Center |
+| `owner_type` <br/> `APPCENTER_OWNER_TYPE` | Owner type, either 'user' or 'organization' (default: `user`) |
+| `owner_name` <br/> `APPCENTER_OWNER_NAME` | Owner name, as found in the App's URL in App Center |
+| `destinations` <br/> `APPCENTER_DISTRIBUTE_DESTINATIONS` | Comma separated list of distribution group names. Default is 'Collaborators', use '*' for all distribution groups |
+| `devices_file` <br/> `FL_REGISTER_DEVICES_FILE` | File to save the devices list to. Same environment variable as _fastlane_'s `register_devices` action |
+
+#### `appcenter_upload`
+
+| Key & Env Var | Description |
+|-----------------|--------------------|
+| `api_token` <br/> `APPCENTER_API_TOKEN` | API Token for App Center |
+| `owner_type` <br/> `APPCENTER_OWNER_TYPE` | Owner type, either 'user' or 'organization' (default: `user`) |
+| `owner_name` <br/> `APPCENTER_OWNER_NAME` | Owner name, as found in the App's URL in App Center |
+| `app_name` <br/> `APPCENTER_APP_NAME` | App name as found in the App's URL in App Center, if there is no app with such name, you will be prompted to create one |
+| `app_display_name` <br/> `APPCENTER_APP_DISPLAY_NAME` | App display name to use when creating a new app |
+| `app_os` <br/> `APPCENTER_APP_OS` | App OS. Used for new app creation, if app 'app_name' was not found |
+| `app_platform` <br/> `APPCENTER_APP_PLATFORM` | App Platform. Used for new app creation, if app 'app_name' was not found |
+| `apk` <br/> `APPCENTER_DISTRIBUTE_APK` | Build release path for android build |
+| `aab` <br/> `APPCENTER_DISTRIBUTE_AAB` | Build release path for android app bundle build |
+| `ipa` <br/> `APPCENTER_DISTRIBUTE_IPA` | Build release path for iOS builds |
+| `file` <br/> `APPCENTER_DISTRIBUTE_FILE` | Build release path for generic builds (.aab, .app, .app.zip, .apk, .dmg, .ipa, .pkg) |
+| `dsym` <br/> `APPCENTER_DISTRIBUTE_DSYM` | Path to your symbols file. For iOS provide path to app.dSYM.zip |
+| `upload_dsym_only` <br/> `APPCENTER_DISTRIBUTE_UPLOAD_DSYM_ONLY` | Flag to upload only the dSYM file to App Center (default: `false`) |
+| `mapping` <br/> `APPCENTER_DISTRIBUTE_ANDROID_MAPPING` | Path to your Android mapping.txt |
+| `upload_mapping_only` <br/> `APPCENTER_DISTRIBUTE_UPLOAD_ANDROID_MAPPING_ONLY` | Flag to upload only the mapping.txt file to App Center (default: `false`) |
+| `destinations` <br/> `APPCENTER_DISTRIBUTE_DESTINATIONS` | Comma separated list of destination names. Both distribution groups and stores are supported. All names are required to be of the same destination type (default: `Collaborators`) |
+| `destination_type` <br/> `APPCENTER_DISTRIBUTE_DESTINATION_TYPE` | Destination type of distribution destination. 'group' and 'store' are supported (default: `group`) |
+| `mandatory_update` <br/> `APPCENTER_DISTRIBUTE_MANDATORY_UPDATE` | Require users to update to this release. Ignored if destination type is 'store' (default: `false`) |
+| `notify_testers` <br/> `APPCENTER_DISTRIBUTE_NOTIFY_TESTERS` | Send email notification about release. Ignored if destination type is 'store' (default: `false`) |
+| `release_notes` <br/> `APPCENTER_DISTRIBUTE_RELEASE_NOTES` | Release notes (default: `No changelog given`) |
+| `should_clip` <br/> `APPCENTER_DISTRIBUTE_RELEASE_NOTES_CLIPPING` | Clip release notes if its length is more then 5000, true by default (default: `true`) |
+| `release_notes_link` <br/> `APPCENTER_DISTRIBUTE_RELEASE_NOTES_LINK` | Additional release notes link |
+| `build_number` <br/> `APPCENTER_DISTRIBUTE_BUILD_NUMBER` | The build number, required for Android ProGuard mapping files, as well as macOS .pkg and .dmg builds |
+| `version` <br/> `APPCENTER_DISTRIBUTE_VERSION` | The build version, required for Android ProGuard mapping files, as well as macOS .pkg and .dmg builds |
+| `timeout` <br/> `APPCENTER_DISTRIBUTE_TIMEOUT` | Request timeout in seconds |
+| `dsa_signature` <br/> `APPCENTER_DISTRIBUTE_DSA_SIGNATURE` | DSA signature of the macOS or Windows releases for Sparkle update feed |
+
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+Check out this [example `Fastfile`](fastlane/Fastfile) to see how to use the `appcenter_upload` action. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
 Sample uses `.env` for setting private variables like API token, owner name, .etc. You need to replace it in `Fastfile` by your own values.
 
@@ -62,6 +118,8 @@ There are three examples in `test` lane:
 - upload release for ios with all set parameters
 - upload only dSYM file for ios
 
+Check out this [example `Fastfile`](fastlane/fetch_devices/Fastfile) for a full example of fetching devices, registering them with Apple, provisioning the devices, and signing an app.
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/appcenter/actions/appcenter_fetch_devices_action.rb

@@ -0,0 +1,138 @@
+require 'fastlane/action'
+require 'csv'
+require 'faraday'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      APPCENTER_API_TOKEN = :APPCENTER_API_TOKEN
+      APPCENTER_OWNER_NAME = :APPCENTER_OWNER_NAME
+      APPCENTER_APP_NAME = :APPCENTER_APP_NAME
+      APPCENTER_DISTRIBUTE_DESTINATIONS = :APPCENTER_DISTRIBUTE_DESTINATIONS
+    end
+
+    class AppcenterFetchDevicesAction < Action
+      def self.run(params)
+        api_token = params[:api_token]
+        owner_name = params[:owner_name]
+        app_name = params[:app_name]
+        destinations = params[:destinations]
+
+        Actions.lane_context[SharedValues::APPCENTER_API_TOKEN] = api_token
+        Actions.lane_context[SharedValues::APPCENTER_OWNER_NAME] = owner_name
+        Actions.lane_context[SharedValues::APPCENTER_APP_NAME] = app_name
+
+        group_names = []
+        if destinations == '*'
+          UI.message("Looking up all distribution groups for #{owner_name}/#{app_name}")
+          distribution_groups = Helper::AppcenterHelper.fetch_distribution_groups(
+            api_token: api_token,
+            owner_name: owner_name,
+            app_name: app_name
+          )
+          UI.abort_with_message!("Failed to list distribution groups for #{owner_name}/#{app_name}") unless distribution_groups
+          distribution_groups.each do |group|
+            group_names << group['name']
+          end
+        else
+          group_names += destinations.split(',').map(&:strip)
+        end
+
+        Actions.lane_context[SharedValues::APPCENTER_DISTRIBUTE_DESTINATIONS] = group_names.join(',')
+
+        devices = []
+        group_names.each do |group_name|
+          group_devices = Helper::AppcenterHelper.fetch_devices(
+            api_token: api_token,
+            owner_name: owner_name,
+            app_name: app_name,
+            distribution_group: group_name
+          )
+          UI.abort_with_message!("Failed to get devices for group '#{group_name}'") unless group_devices
+          devices << group_devices
+        end
+
+        self.write_devices(devices: devices, devices_file: params[:devices_file])
+      end
+
+      def self.write_devices(devices:, devices_file:)
+        CSV.open(devices_file, 'w',
+                 write_headers: true,
+                 headers: ['Device ID', 'Device Name'],
+                 col_sep: "\t") do |csv|
+
+          devices.each do |device|
+            CSV.parse(device, { col_sep: "\t", headers: true }) do |row|
+              csv << row
+            end
+          end
+        end
+      end
+
+      def self.description
+        "Fetches a list of devices from App Center to distribute an iOS app to"
+      end
+
+      def self.authors
+        ["benkane"]
+      end
+
+      def self.return_value
+        "CSV file formatted for multi-device registration with Apple"
+      end
+
+      def self.details
+        "List is a tab-delimited CSV file containing every device from specified distribution groups for an app in App Center. " +
+          "Especially useful when combined with register_devices and match to automatically register and provision devices with Apple. " +
+          "By default, only the Collaborators group will be included, use `destination: '*'` to match all groups."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                  env_name: "APPCENTER_API_TOKEN",
+                                  sensitive: true,
+                               description: "API Token for App Center",
+                                  optional: false,
+                                      type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("No API token for App Center given, pass using `api_token: 'token'`") unless value && !value.empty?
+                             end),
+          FastlaneCore::ConfigItem.new(key: :owner_name,
+                                  env_name: "APPCENTER_OWNER_NAME",
+                               description: "Owner name",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                UI.user_error!("No Owner name for App Center given, pass using `owner_name: 'name'`") unless value && !value.empty?
+                              end),
+          FastlaneCore::ConfigItem.new(key: :app_name,
+                                  env_name: "APPCENTER_APP_NAME",
+                               description: "App name",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                UI.user_error!("No App name given, pass using `app_name: 'app name'`") unless value && !value.empty?
+                              end),
+          FastlaneCore::ConfigItem.new(key: :devices_file,
+                                  env_name: "FL_REGISTER_DEVICES_FILE",
+                               description: "File to save devices to",
+                                      type: String,
+                             default_value: "devices.txt",
+                              verify_block: proc do |value|
+                                UI.important("Important: Devices file is #{value}. If you plan to upload this file to Apple Developer Center, the file must have the .txt extension") unless value && value.end_with?('.txt')
+                              end),
+          FastlaneCore::ConfigItem.new(key: :destinations,
+                                  env_name: "APPCENTER_DISTRIBUTE_DESTINATIONS",
+                               description: "Comma separated list of distribution group names. Default is 'Collaborators', use '*' for all distribution groups",
+                             default_value: "Collaborators",
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/appcenter/actions/appcenter_upload_action.rb

@@ -94,6 +94,7 @@ module Fastlane
         values = params.values
         api_token = params[:api_token]
         owner_name = params[:owner_name]
+        owner_type = params[:owner_type]
         app_name = params[:app_name]
         destinations = params[:destinations]
         destination_type = params[:destination_type]
@@ -105,6 +106,7 @@ module Fastlane
         timeout = params[:timeout]
         build_number = params[:build_number]
         version = params[:version]
+        dsa_signature = params[:dsa_signature]
 
         if release_notes.length >= Constants::MAX_RELEASE_NOTES_LENGTH
           unless should_clip
@@ -166,9 +168,11 @@ module Fastlane
 
           if uploaded
             release_id = uploaded['release_id']
-            UI.message("Release '#{release_id}' committed")
+            release_url = Helper::AppcenterHelper.get_release_url(owner_type, owner_name, app_name, release_id)
+            UI.message("Release '#{release_id}' committed: #{release_url}")
 
             Helper::AppcenterHelper.update_release(api_token, owner_name, app_name, release_id, release_notes)
+            Helper::AppcenterHelper.update_release_metadata(api_token, owner_name, app_name, release_id, dsa_signature)
 
             destinations_array = destinations.split(',')
             destinations_array.each do |destination_name|
@@ -177,14 +181,17 @@ module Fastlane
                 destination_id = destination['id']
                 distributed_release = Helper::AppcenterHelper.add_to_destination(api_token, owner_name, app_name, release_id, destination_type, destination_id, mandatory_update, notify_testers)
                 if distributed_release
-                  UI.success("Release #{distributed_release['short_version']} was successfully distributed to #{destination_type} \"#{destination_name}\"")
+                  UI.success("Release '#{release_id}' (#{distributed_release['short_version']}) was successfully distributed to #{destination_type} \"#{destination_name}\"")
                 else
-                  UI.error("Release '#{release_id}' was not found")
+                  UI.error("Release '#{release_id}' was not found for destination '#{destination_name}'")
                 end
               else
                 UI.error("#{destination_type} '#{destination_name}' was not found")
               end
             end
+
+            safe_download_url = Helper::AppcenterHelper.get_install_url(owner_type, owner_name, app_name)
+            UI.message("Release '#{release_id}' is available for download at: #{safe_download_url}")
           else
             UI.user_error!("Failed to upload release")
           end
@@ -260,6 +267,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :api_token,
                                   env_name: "APPCENTER_API_TOKEN",
                                description: "API Token for App Center",
+                             default_value: Actions.lane_context[SharedValues::APPCENTER_API_TOKEN],
                                   optional: false,
                                       type: String,
                               verify_block: proc do |value|
@@ -268,7 +276,7 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :owner_type,
                                   env_name: "APPCENTER_OWNER_TYPE",
-                               description: "Owner type",
+                               description: "Owner type, either 'user' or 'organization'",
                                   optional: true,
                              default_value: "user",
                                       type: String,
@@ -279,7 +287,8 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :owner_name,
                                   env_name: "APPCENTER_OWNER_NAME",
-                               description: "Owner name",
+                               description: "Owner name as found in the App's URL in App Center",
+                             default_value: Actions.lane_context[SharedValues::APPCENTER_OWNER_NAME],
                                   optional: false,
                                       type: String,
                               verify_block: proc do |value|
@@ -288,7 +297,8 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :app_name,
                                   env_name: "APPCENTER_APP_NAME",
-                               description: "App name. If there is no app with such name, you will be prompted to create one",
+                               description: "App name as found in the App's URL in App Center. If there is no app with such name, you will be prompted to create one",
+                             default_value: Actions.lane_context[SharedValues::APPCENTER_APP_NAME],
                                   optional: false,
                                       type: String,
                               verify_block: proc do |value|
@@ -303,13 +313,13 @@ module Fastlane
 
           FastlaneCore::ConfigItem.new(key: :app_os,
                                   env_name: "APPCENTER_APP_OS",
-                               description: "App OS. Used for new app creation, if app with 'app_name' name was not found",
+                               description: "App OS. Used for new app creation, if app 'app_name' was not found",
                                   optional: true,
                                       type: String),
 
           FastlaneCore::ConfigItem.new(key: :app_platform,
                                   env_name: "APPCENTER_APP_PLATFORM",
-                               description: "App Platform. Used for new app creation, if app with 'app_name' name was not found",
+                               description: "App Platform. Used for new app creation, if app 'app_name' was not found",
                                   optional: true,
                                       type: String),
 
@@ -428,7 +438,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :destinations,
                                   env_name: "APPCENTER_DISTRIBUTE_DESTINATIONS",
                                description: "Comma separated list of destination names. Both distribution groups and stores are supported. All names are required to be of the same destination type",
-                             default_value: "Collaborators",
+                             default_value: Actions.lane_context[SharedValues::APPCENTER_DISTRIBUTE_DESTINATIONS] || "Collaborators",
                                   optional: true,
                                       type: String),
 
@@ -494,6 +504,12 @@ module Fastlane
                                        description: "Request timeout in seconds",
                                        optional: true,
                                        type: Integer),
+
+          FastlaneCore::ConfigItem.new(key: :dsa_signature,
+                                       env_name: "APPCENTER_DISTRIBUTE_DSA_SIGNATURE",
+                                       description: "DSA signature of the macOS or Windows releases for Sparkle update feed",
+                                       optional: true,
+                                       type: String)
         ]
       end
 

data/lib/fastlane/plugin/appcenter/helper/appcenter_helper.rb

@@ -16,12 +16,12 @@ module Fastlane
       end
 
       # create request
-      def self.connection(upload_url = false, dsym = false)
+      def self.connection(upload_url = nil, dsym = false, csv = false)
         require 'faraday'
         require 'faraday_middleware'
 
         options = {
-          url: upload_url ? upload_url : ENV.fetch('APPCENTER_UPLOAD_URL', "https://api.appcenter.ms")
+          url: upload_url || ENV.fetch('APPCENTER_UPLOAD_URL', "https://api.appcenter.ms")
         }
 
         Faraday.new(options) do |builder|
@@ -31,7 +31,7 @@ module Fastlane
           else
             builder.request :json
           end
-          builder.response :json, content_type: /\bjson$/
+          builder.response :json, content_type: /\bjson$/ unless csv
           builder.use FaradayMiddleware::FollowRedirects
           builder.adapter :net_http
         end
@@ -151,6 +151,9 @@ module Fastlane
         when 200...300
           UI.message("DEBUG: #{JSON.pretty_generate(response.body)}\n") if ENV['DEBUG']
           response.body
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error #{response.status}: #{response.body}")
           false
@@ -177,6 +180,9 @@ module Fastlane
         when 200...300
           self.update_symbol_upload(api_token, owner_name, app_name, symbol_upload_id, 'committed')
           UI.success("#{logType} uploaded")
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error uploading #{logType} #{response.status}: #{response.body}")
           self.update_symbol_upload(api_token, owner_name, app_name, symbol_upload_id, 'aborted')
@@ -206,6 +212,9 @@ module Fastlane
         when 200...300
           UI.message("Binary uploaded")
           self.update_release_upload(api_token, owner_name, app_name, upload_id, 'committed')
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error uploading binary #{response.status}: #{response.body}")
           self.update_release_upload(api_token, owner_name, app_name, upload_id, 'aborted')
@@ -230,6 +239,9 @@ module Fastlane
         when 200...300
           UI.message("DEBUG: #{JSON.pretty_generate(response.body)}\n") if ENV['DEBUG']
           response.body
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         when 500...600
           UI.crash!("Internal Service Error, please try again later")
         else
@@ -254,6 +266,9 @@ module Fastlane
         when 404
           UI.error("Not found, invalid release url")
           false
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error fetching information about release #{response.status}: #{response.body}")
           false
@@ -277,6 +292,9 @@ module Fastlane
         when 404
           UI.error("Not found, invalid distribution #{destination_type} name")
           false
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error getting #{destination_type} #{response.status}: #{response.body}")
           false
@@ -291,7 +309,7 @@ module Fastlane
           req.headers['X-API-Token'] = api_token
           req.headers['internal-request-source'] = "fastlane"
           req.body = {
-            "release_notes" => release_notes
+            release_notes: release_notes
           }
         end
 
@@ -300,6 +318,7 @@ module Fastlane
           # get full release info
           release = self.get_release(api_token, owner_name, app_name, release_id)
           return false unless release
+
           download_url = release['download_url']
 
           UI.message("DEBUG: #{JSON.pretty_generate(release)}") if ENV['DEBUG']
@@ -307,18 +326,53 @@ module Fastlane
           Actions.lane_context[Fastlane::Actions::SharedValues::APPCENTER_DOWNLOAD_LINK] = download_url
           Actions.lane_context[Fastlane::Actions::SharedValues::APPCENTER_BUILD_INFORMATION] = release
 
-          UI.message("Release #{release['short_version']} was successfully updated")
+          UI.message("Release '#{release_id}' (#{release['short_version']}) was successfully updated")
 
           release
         when 404
           UI.error("Not found, invalid release id")
           false
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error adding updating release #{response.status}: #{response.body}")
           false
         end
       end
 
+      # updates release metadata
+      def self.update_release_metadata(api_token, owner_name, app_name, release_id, dsa_signature)
+        return if dsa_signature.to_s == ''
+
+        release_metadata = {
+          dsa_signature: dsa_signature
+        }
+
+        connection = self.connection
+        response = connection.patch("v0.1/apps/#{owner_name}/#{app_name}/releases/#{release_id}") do |req|
+          req.headers['X-API-Token'] = api_token
+          req.headers['internal-request-source'] = "fastlane"
+          req.body = {
+            metadata: release_metadata
+          }
+        end
+
+        case response.status
+        when 200...300
+          UI.message("Release Metadata was successfully updated for release '#{release_id}'")
+        when 404
+          UI.error("Not found, invalid release id")
+          false
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
+        else
+          UI.error("Error adding updating release metadata #{response.status}: #{response.body}")
+          false
+        end
+      end
+      
       # add release to distribution group or store
       def self.add_to_destination(api_token, owner_name, app_name, release_id, destination_type, destination_id, mandatory_update = false, notify_testers = false)
         connection = self.connection
@@ -342,6 +396,7 @@ module Fastlane
           # get full release info
           release = self.get_release(api_token, owner_name, app_name, release_id)
           return false unless release
+
           download_url = release['download_url']
 
           UI.message("DEBUG: received release #{JSON.pretty_generate(release)}") if ENV['DEBUG']
@@ -349,12 +404,15 @@ module Fastlane
           Actions.lane_context[Fastlane::Actions::SharedValues::APPCENTER_DOWNLOAD_LINK] = download_url
           Actions.lane_context[Fastlane::Actions::SharedValues::APPCENTER_BUILD_INFORMATION] = release
 
-          UI.message("Public Download URL: #{download_url}") if download_url
+          UI.message("Release '#{release_id}' (#{release['short_version']}) was successfully distributed'")
 
           release
         when 404
           UI.error("Not found, invalid distribution #{destination_type} name")
           false
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error adding to #{destination_type} #{response.status}: #{response.body}")
           false
@@ -377,6 +435,9 @@ module Fastlane
         when 404
           UI.message("DEBUG: #{JSON.pretty_generate(response.body)}\n") if ENV['DEBUG']
           false
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error getting app #{owner_name}/#{app_name}, #{response.status}: #{response.body}")
           false
@@ -406,11 +467,78 @@ module Fastlane
           UI.message("DEBUG: #{JSON.pretty_generate(created)}") if ENV['DEBUG']
           UI.success("Created #{os}/#{platform} app with name \"#{created['name']}\" and display name \"#{created['display_name']}\" for #{owner_type} \"#{owner_name}\"")
           true
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
         else
           UI.error("Error creating app #{response.status}: #{response.body}")
           false
         end
       end
+
+      def self.fetch_distribution_groups(api_token:, owner_name:, app_name:)
+        connection = self.connection
+
+        endpoint = "/v0.1/apps/#{owner_name}/#{app_name}/distribution_groups"
+
+        response = connection.get(endpoint) do |req|
+          req.headers['X-API-Token'] = api_token
+          req.headers['internal-request-source'] = "fastlane"
+        end
+
+        case response.status
+        when 200...300
+          UI.message("DEBUG: #{JSON.pretty_generate(response.body)}\n") if ENV['DEBUG']
+          response.body
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
+        when 404
+          UI.error("Not found, invalid owner or application name")
+          false
+        else
+          UI.error("Error #{response.status}: #{response.body}")
+          false
+        end
+      end
+
+      def self.fetch_devices(api_token:, owner_name:, app_name:, distribution_group:)
+        connection = self.connection(nil, false, true)
+
+        endpoint = "/v0.1/apps/#{owner_name}/#{app_name}/distribution_groups/#{ERB::Util.url_encode(distribution_group)}/devices/download_devices_list"
+
+        response = connection.get(endpoint) do |req|
+          req.headers['X-API-Token'] = api_token
+          req.headers['internal-request-source'] = "fastlane"
+        end
+
+        case response.status
+        when 200...300
+          UI.message("DEBUG: #{response.body.inspect}") if ENV['DEBUG']
+          response.body
+        when 401
+          UI.user_error!("Auth Error, provided invalid token")
+          false
+        when 404
+          UI.error("Not found, invalid owner, application or distribution group name")
+          false
+        else
+          UI.error("Error #{response.status}: #{response.body}")
+          false
+        end
+      end
+
+      # Note: This does not support testing environment (INT)
+      def self.get_release_url(owner_type, owner_name, app_name, release_id)
+        owner_path = owner_type == "user" ? "users/#{owner_name}" : "orgs/#{owner_name}"
+        return "https://appcenter.ms/#{owner_path}/apps/#{app_name}/distribute/releases/#{release_id}"
+      end
+
+      # Note: This does not support testing environment (INT)
+      def self.get_install_url(owner_type, owner_name, app_name)
+        owner_path = owner_type == "user" ? "users/#{owner_name}" : "orgs/#{owner_name}"
+        return "https://install.appcenter.ms/#{owner_path}/apps/#{app_name}"
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Appcenter
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-appcenter
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/appcenter.rb
+- lib/fastlane/plugin/appcenter/actions/appcenter_fetch_devices_action.rb
 - lib/fastlane/plugin/appcenter/actions/appcenter_upload_action.rb
 - lib/fastlane/plugin/appcenter/helper/appcenter_helper.rb
 - lib/fastlane/plugin/appcenter/version.rb