fastlane-plugin-airwatch_workspaceone 1.0.2 → 2.0.0

data/lib/fastlane/plugin/airwatch_workspaceone/actions/delete_specific_version_action.rb

@@ -0,0 +1,205 @@
+require 'fastlane/action'
+require_relative '../helper/airwatch_workspaceone_helper'
+
+module Fastlane
+  module Actions
+    class DeleteSpecificVersionAction < Action
+      
+      APP_VERSIONS_LIST_SUFFIX    = "/API/mam/apps/search?bundleid=%s"
+      INTERNAL_APP_DELETE_SUFFIX  = "/API/mam/apps/internal/%d"
+      
+      $is_debug = false
+
+      def self.run(params)
+        UI.message("The airwatch_workspaceone plugin is working!")
+
+        # check if debug is enabled
+        $is_debug = params[:debug]
+
+        if debug
+          UI.message("---------------------------------------------")
+          UI.message("DeleteSpecificVersionAction debug information")
+          UI.message("---------------------------------------------")
+          UI.message(" host_url: #{params[:host_url]}")
+          UI.message(" aw_tenant_code: #{params[:aw_tenant_code]}")
+          UI.message(" b64_encoded_auth: #{params[:b64_encoded_auth]}")
+          UI.message(" app_identifier: #{params[:app_identifier]}")
+          UI.message(" version_number: #{params[:version_number]}")
+        end
+
+        $host_url         = params[:host_url]
+        $aw_tenant_code   = params[:aw_tenant_code]
+        $b64_encoded_auth = params[:b64_encoded_auth]
+        app_identifier    = params[:app_identifier]
+        version_number    = params[:version_number]
+
+        # step 1: find app
+        UI.message("-----------------------")
+        UI.message("1. Finding app versions")
+        UI.message("-----------------------")
+
+        app_versions = find_app(app_identifier)
+        app_version_numbers = app_versions.map {|app_version| app_version.values[1]}
+        UI.success("Found %d app version(s)" % [app_versions.count])
+        UI.success("Version number(s): %s" % [app_version_numbers])
+
+        # step 2: delete specific version
+        UI.message("--------------------------------")
+        UI.message("2. Deleting specific app version")
+        UI.message("--------------------------------")
+
+        if app_version_numbers.include? version_number
+          version_index = app_version_numbers.index(version_number)
+          app_version_to_delete = app_versions[version_index]
+          delete_app(app_version_to_delete)
+        else
+          UI.user_error!("A version with the given version number: %s does not exist on the console for this application or is already deleted." % [version_number])
+        end
+
+        UI.success("Version %s successfully deleted" % [version_number])
+      end
+
+      def self.find_app(app_identifier)
+        # get the list of apps 
+        data = list_app_versions(app_identifier)
+        app_versions = Array.new
+
+        data['Application'].each do |app|
+          app_version = Hash.new
+          app_version['Id'] = app['Id']['Value']
+          app_version['Version'] = app['AppVersion']
+          app_versions << app_version
+        end
+
+        return app_versions
+      end
+
+      def self.list_app_versions(app_identifier)
+        require 'rest-client'
+        require 'json'
+        
+        response = RestClient.get($host_url + APP_VERSIONS_LIST_SUFFIX % [app_identifier], {accept: :json, 'aw-tenant-code': $aw_tenant_code, 'Authorization': "Basic " + $b64_encoded_auth})
+
+        if debug
+          UI.message("Response code: %d" % [response.code])
+          UI.message("Response body:")
+          UI.message(response.body)
+        end
+
+        if response.code != 200
+          UI.user_error!("There was an error in finding app versions. One possible reason is that an app with the bundle identifier given does not exist on Console.")
+          exit
+        end
+
+        json = JSON.parse(response.body)
+        return json
+      end
+
+      def self.delete_app(app_version)
+        require 'rest-client'
+        require 'json'
+
+        UI.message("Starting to delete app version: %s" % [app_version['Version']])
+        response = RestClient.delete($host_url + INTERNAL_APP_DELETE_SUFFIX % [app_version['Id']],  {accept: :json, 'aw-tenant-code': $aw_tenant_code, 'Authorization': "Basic " + $b64_encoded_auth})
+
+        if debug
+          UI.message("Response code: %d" % [response.code])
+        end
+
+        if response.code == 204
+          UI.message("Successfully deleted app version: %s" % [app_version['Version']])
+        else
+          UI.message("Failed to delete app version: %s" % [app_version['Version']])
+        end
+      end
+
+      def self.description
+        "The main purpose of this action is to delete a specific version of an application. This action takes a string parameter where you can specify the version number to delete."
+      end
+
+      def self.authors
+        ["Ram Awadhesh Sharan"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "delete_specific_version - To delete specific version of an application on the AirWatch console."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :host_url,
+                                  env_name: "AIRWATCH_HOST_API_URL",
+                               description: "Host API URL of the AirWatch instance",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No AirWatch Host API URl given.") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :aw_tenant_code,
+                                  env_name: "AIRWATCH_API_KEY",
+                               description: "API key to access AirWatch Rest APIs",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("Api tenant code header is missing.") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :b64_encoded_auth,
+                                  env_name: "AIRWATCH_BASE64_ENCODED_BASIC_AUTH_STRING",
+                               description: "The base64 encoded Basic Auth string generated by authorizing username and password to the AirWatch instance",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("The authorization header is empty or the scheme is not basic") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                  env_name: "APP_IDENTIFIER",
+                               description: "Bundle identifier of your app",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No app identifier given, pass using `app_identifier: 'com.example.app'`") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :version_number,
+                                  env_name: "AIRWATCH_VERSION_NUMBER",
+                               description: "Version number of the application to retire",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No version number given, pass using `version_number: '1.0'`") unless value and !value.empty?
+                                            end),
+
+          FastlaneCore::ConfigItem.new(key: :debug,
+                                  env_name: "AIRWATCH_DEBUG",
+                               description: "Debug flag, set to true to show extended output. default: false",
+                                  optional: true,
+                                 is_string: false,
+                             default_value: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+
+        [:ios, :android].include?(platform)
+        true
+      end
+
+      # helpers
+      
+      def self.debug
+        $is_debug
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/airwatch_workspaceone/actions/deploy_build_action.rb

@@ -5,12 +5,12 @@ module Fastlane
   module Actions
     class DeployBuildAction < Action
 
-      UPLOAD_BLOB_SUFFIX = "/API/mam/blobs/uploadblob?fileName=%s&organizationGroupId=%s"
-      BEGIN_INSTALL_SUFFIX = "/API/mam/apps/internal/begininstall"
+      UPLOAD_BLOB_SUFFIX    = "/API/mam/blobs/uploadblob?fileName=%s&organizationGroupId=%s"
+      BEGIN_INSTALL_SUFFIX  = "/API/mam/apps/internal/begininstall"
 
-      $is_debug = false
-      $device_type = "Apple"
-      $supported_device_models = Hash.new
+      $is_debug                 = false
+      $device_type              = "Apple"
+      $supported_device_models  = Hash.new
 
       def self.run(params)
         UI.message("The airwatch_workspaceone plugin is working!")
@@ -19,27 +19,26 @@ module Fastlane
         $is_debug = params[:debug]
 
         if debug
-          UI.message("---------------------------------")
-          UI.message("AirWatch plugin debug information")
-          UI.message("---------------------------------")
+          UI.message("-----------------------------------")
+          UI.message("DeployBuildAction debug information")
+          UI.message("-----------------------------------")
           UI.message(" host_url: #{params[:host_url]}")
           UI.message(" aw_tenant_code: #{params[:aw_tenant_code]}")
           UI.message(" b64_encoded_auth: #{params[:b64_encoded_auth]}")
+          UI.message(" organization_group_id: #{params[:org_group_id]}")
           UI.message(" app_name: #{params[:app_name]}")
           UI.message(" file_name: #{params[:file_name]}")
           UI.message(" path_to_file: #{params[:path_to_file]}")
-          UI.message(" organization_group_id: #{params[:org_group_id]}")
           UI.message(" push_mode: #{params[:push_mode]}")
-          UI.message("---------------------------------")
         end
 
-        host_url          = params[:host_url]
-        aw_tenant_code    = params[:aw_tenant_code]
-        b64_encoded_auth  = params[:b64_encoded_auth]
+        $host_url         = params[:host_url]
+        $aw_tenant_code   = params[:aw_tenant_code]
+        $b64_encoded_auth = params[:b64_encoded_auth]
+        $org_group_id     = params[:org_group_id]
         app_name          = params[:app_name]
         file_name         = params[:file_name]
         path_to_file      = params[:path_to_file]
-        org_group_id      = params[:org_group_id]
         push_mode         = params[:push_mode]
 
         # step 1: determining device type
@@ -54,7 +53,7 @@ module Fastlane
         UI.message("2. Setting supported device models")
         UI.message("----------------------------------")
         $supported_device_models = find_supported_device_models(path_to_file)
-        UI.success("Supported Device Models are: %s" % [$supported_device_models.to_json])
+        UI.success("Supported Device Model(s): %s" % [$supported_device_models.to_json])
 
         # step 3: uploading app blob file
         UI.message("---------------------")
@@ -64,7 +63,7 @@ module Fastlane
           UI.message("3. Uploading IPA file")
         end
         UI.message("---------------------")
-        blobID = upload_blob(host_url, aw_tenant_code, b64_encoded_auth, file_name, path_to_file, org_group_id)
+        blobID = upload_blob(file_name, path_to_file)
 
         if $device_type == "Android"
           UI.success("Successfully uploaded apk blob")
@@ -80,7 +79,7 @@ module Fastlane
         UI.message("------------------------------------")
         UI.message("4. Deploying app version on console")
         UI.message("------------------------------------")
-        deploy_app(host_url, aw_tenant_code, b64_encoded_auth, blobID, app_name, push_mode, org_group_id)
+        deploy_app(blobID, app_name, push_mode)
         UI.success("Successfully deployed the app version")
       end
 
@@ -134,21 +133,21 @@ module Fastlane
         return model_hash
       end
 
-      def self.upload_blob(host_url, aw_tenant_code, b64_encoded_auth, file_name, path_to_file, org_group_id)
+      def self.upload_blob(file_name, path_to_file)
         require 'rest-client'
         require 'json'
 
         response = RestClient::Request.execute(
-          :url => host_url + UPLOAD_BLOB_SUFFIX % [file_name, org_group_id],
-          :method => :post,
-          :headers => {
-            'Authorization' => "Basic " + b64_encoded_auth,
-            'aw-tenant-code' => aw_tenant_code,
-            'Accept' => 'application/json',
-            'Content-Type' => 'application/octet-stream',
-            'Expect' => '100-continue'
+          :url      => $host_url + UPLOAD_BLOB_SUFFIX % [file_name, $org_group_id],
+          :method   => :post,
+          :headers  => {
+            'Authorization'   => "Basic " + $b64_encoded_auth,
+            'aw-tenant-code'  => $aw_tenant_code,
+            'Accept'          => 'application/json',
+            'Content-Type'    => 'application/octet-stream',
+            'Expect'          => '100-continue'
           },
-          :payload => File.open(path_to_file, "rb")
+          :payload  => File.open(path_to_file, "rb")
         )
 
         if debug
@@ -161,17 +160,17 @@ module Fastlane
         return json['Value']
       end
 
-      def self.deploy_app(host_url, aw_tenant_code, b64_encoded_auth, blobID, app_name, push_mode, org_group_id)
+      def self.deploy_app(blobID, app_name, push_mode)
         require 'rest-client'
         require 'json'
 
         body = {
-          "BlobId" => blobID.to_s,
-          "DeviceType" => $device_type, 
+          "BlobId"          => blobID.to_s,
+          "DeviceType"      => $device_type, 
           "ApplicationName" => app_name,
           "SupportedModels" => $supported_device_models,
-          "PushMode" => push_mode,
-          "LocationGroupId" => org_group_id
+          "PushMode"        => push_mode,
+          "LocationGroupId" => $org_group_id
         }
 
         if debug
@@ -179,7 +178,7 @@ module Fastlane
           UI.message(body.to_json)
         end
 
-        response = RestClient.post(host_url + BEGIN_INSTALL_SUFFIX, body.to_json, {content_type: :json, accept: :json, 'aw-tenant-code': aw_tenant_code, 'Authorization': "Basic " + b64_encoded_auth})
+        response = RestClient.post($host_url + BEGIN_INSTALL_SUFFIX, body.to_json, {content_type: :json, accept: :json, 'aw-tenant-code': $aw_tenant_code, 'Authorization': "Basic " + $b64_encoded_auth})
 
         if debug
           UI.message("Response code: %d" % [response.code])
@@ -205,7 +204,7 @@ module Fastlane
 
       def self.details
         # Optional:
-        "deploy_app - To upload an iOS ipa OR Android APK to AirWatch/WorkspaceOne console."
+        "deploy_build - To upload an iOS ipa OR Android APK to AirWatch/WorkspaceOne console."
       end
 
       def self.available_options
@@ -237,6 +236,15 @@ module Fastlane
                                               UI.user_error!("The authorization header is empty or the scheme is not basic") unless value and !value.empty?
                                             end),
 
+          FastlaneCore::ConfigItem.new(key: :org_group_id,
+                                  env_name: "AIRWATCH_ORGANIZATION_GROUP_ID",
+                               description: "Organization Group ID integer identifying the customer or container",
+                                  optional: false,
+                                      type: String,
+                              verify_block: proc do |value|
+                                              UI.user_error!("No Organization Group ID integer given, pass using `org_group_id: MyOrgGroupId`") unless value and !value.empty?
+                                            end),
+
           FastlaneCore::ConfigItem.new(key: :app_name,
                                   env_name: "AIRWATCH_APPLICATION_NAME",
                                description: "Name of the application",
@@ -264,15 +272,6 @@ module Fastlane
                                               UI.user_error!("Path to the file not given, pass using `path_to_file: '/path/to/the/file/on/disk'`") unless value and !value.empty?
                                             end),
 
-          FastlaneCore::ConfigItem.new(key: :org_group_id,
-                                  env_name: "AIRWATCH_ORGANIZATION_GROUP_ID",
-                               description: "Organization Group ID integer identifying the customer or container",
-                                  optional: false,
-                                      type: String,
-                              verify_block: proc do |value|
-                                              UI.user_error!("No Organization Group ID integer given, pass using `org_group_id: MyOrgGroupId`") unless value and !value.empty?
-                                            end),
-
           FastlaneCore::ConfigItem.new(key: :push_mode,
                                   env_name: "AIRWATCH_APP_PUSH_MODE",
                                description: "Push mode for the application",

data/lib/fastlane/plugin/airwatch_workspaceone/actions/retire_previous_versions_action.rb

@@ -5,8 +5,9 @@ module Fastlane
   module Actions
     class RetirePreviousVersionsAction < Action
       
-      APPS_LIST_SUFFIX = "/API/mam/apps/search?bundleid=%s"
-      INTERNAL_APP_RETIRE_SUFFIX = "/API/mam/apps/internal/%d/retire"
+      APP_VERSIONS_LIST_SUFFIX    = "/API/mam/apps/search?bundleid=%s"
+      INTERNAL_APP_RETIRE_SUFFIX  = "/API/mam/apps/internal/%d/retire"
+      
       $is_debug = false
 
       def self.run(params)
@@ -16,67 +17,72 @@ module Fastlane
         $is_debug = params[:debug]
 
         if debug
-          UI.message("---------------------------------")
-          UI.message("AirWatch plugin debug information")
-          UI.message("---------------------------------")
+          UI.message("----------------------------------------------")
+          UI.message("RetirePreviousVersionsAction debug information")
+          UI.message("----------------------------------------------")
           UI.message(" host_url: #{params[:host_url]}")
           UI.message(" aw_tenant_code: #{params[:aw_tenant_code]}")
           UI.message(" b64_encoded_auth: #{params[:b64_encoded_auth]}")
           UI.message(" app_identifier: #{params[:app_identifier]}")
-          UI.message(" app_name: #{params[:app_name]}")
-          UI.message("---------------------------------")
+          UI.message(" keep_latest_versions_count: #{params[:keep_latest_versions_count]}")
         end
 
-        host_url          = params[:host_url]
-        aw_tenant_code    = params[:aw_tenant_code]
-        b64_encoded_auth  = params[:b64_encoded_auth]
-        app_identifier    = params[:app_identifier]
-        app_name          = params[:app_name]
+        $host_url                   = params[:host_url]
+        $aw_tenant_code             = params[:aw_tenant_code]
+        $b64_encoded_auth           = params[:b64_encoded_auth]
+        app_identifier              = params[:app_identifier]
+        keep_latest_versions_count  = params[:keep_latest_versions_count]
 
         # step 1: find app
         UI.message("------------------------------")
         UI.message("1. Finding active app versions")
         UI.message("------------------------------")
 
-        appIDs = find_app(app_identifier, host_url, aw_tenant_code, b64_encoded_auth)
-        UI.success("Found %d active app versions" % [appIDs.count])
-        if debug
-          UI.success("Integer app ids:")
-          UI.success(appIDs)
-        end
+        app_versions = find_app(app_identifier)
+        UI.success("Found %d active app version(s)" % [app_versions.count])
+        UI.success("Version number(s): %s" % [app_versions.map {|app_version| app_version.values[1]}])
 
         # step 2: retire previous versions
-        UI.message("-------------------------------")
-        UI.message("2. Retiring active app versions")
-        UI.message("-------------------------------")
-
-        appIDs.each do |appID|
-          retire_app(host_url, aw_tenant_code, b64_encoded_auth, appID)
+        UI.message("-----------------------------------------")
+        UI.message("2. Retiring requested active app versions")
+        UI.message("-----------------------------------------")
+
+        keep_latest_versions_count_int = keep_latest_versions_count.to_i
+        if app_versions.count < keep_latest_versions_count_int
+          UI.important("Given number of latest versions to keep is greater than available number of versions on the store.")
+          UI.important("Will not retire any version.")
+        else
+          app_versions.pop(keep_latest_versions_count_int)
+          UI.important("Version number(s) to retire: %s" % [app_versions.map {|app_version| app_version.values[1]}])
+          app_versions.each do |app_version|
+            retire_app(app_version)
+          end
+          UI.success("Version(s) %s successfully retired." % [app_versions.map {|app_version| app_version.values[1]}])
         end
-
-        UI.success("All active app versions successfully retired")
       end
 
-      def self.find_app(app_identifier, host_url, aw_tenant_code, b64_encoded_auth)
+      def self.find_app(app_identifier)
         # get the list of apps 
-        data = list_apps(host_url, aw_tenant_code, b64_encoded_auth, app_identifier)
-        active_app_version_ids = Array.new
+        data = list_app_versions(app_identifier)
+        active_app_versions = Array.new
 
         data['Application'].each do |app|
           if app['Status'] == "Active"
-            active_app_version_ids << app['Id']['Value']
+            active_app_version = Hash.new
+            active_app_version['Id'] = app['Id']['Value']
+            active_app_version['Version'] = app['AppVersion']
+            active_app_versions << active_app_version
           end
         end
 
-        active_app_version_ids.pop
-        return active_app_version_ids
+        return active_app_versions
       end
 
-      def self.list_apps(host_url, aw_tenant_code, b64_encoded_auth, app_identifier)
+      def self.list_app_versions(app_identifier)
         require 'rest-client'
         require 'json'
         
-        response = RestClient.get(host_url + APPS_LIST_SUFFIX % [app_identifier], {accept: :json, 'aw-tenant-code': aw_tenant_code, 'Authorization': "Basic " + b64_encoded_auth})
+        response = RestClient.get($host_url + APP_VERSIONS_LIST_SUFFIX % [app_identifier], {accept: :json, 'aw-tenant-code': $aw_tenant_code, 'Authorization': "Basic " + $b64_encoded_auth})
 
         if debug
           UI.message("Response code: %d" % [response.code])
@@ -84,35 +90,40 @@ module Fastlane
           UI.message(response.body)
         end
 
+        if response.code != 200
+          UI.user_error!("There was an error in finding app versions. One possible reason is that an app with the bundle identifier given does not exist on Console.")
+          exit
+        end
+
         json = JSON.parse(response.body)
         return json
       end
 
-      def self.retire_app(host_url, aw_tenant_code, b64_encoded_auth, app_id)
+      def self.retire_app(app_version)
         require 'rest-client'
         require 'json'
 
         body = {
-          "applicationid" => app_id
+          "applicationid" => app_version['Id']
         }
 
-        UI.message("Starting to retire app version having integer identifier: %d" % [app_id])
-        response = RestClient.post(host_url + INTERNAL_APP_RETIRE_SUFFIX % [app_id], body.to_json,  {accept: :json, 'aw-tenant-code': aw_tenant_code, 'Authorization': "Basic " + b64_encoded_auth})
+        UI.message("Starting to retire app version: %s" % [app_version['Version']])
+        response = RestClient.post($host_url + INTERNAL_APP_RETIRE_SUFFIX % [app_version['Id']], body.to_json,  {accept: :json, 'aw-tenant-code': $aw_tenant_code, 'Authorization': "Basic " + $b64_encoded_auth})
 
         if debug
           UI.message("Response code: %d" % [response.code])
         end
 
         if response.code == 202
-          UI.message("Successfully retired app version having integer identifier: %d" % [app_id])
+          UI.message("Successfully retired app version: %s" % [app_version['Version']])
         else
           json = JSON.parse(response.body)
-          UI.message("Failed to retire app version having integer identifier: %d" % [app_id])
+          UI.message("Failed to retire app version: %s" % [app_version['Version']])
         end
       end
 
       def self.description
-        "The main purpose of this action is to retire previous versions of the application"
+        "The main purpose of this action is to retire previous active versions of an application. This action takes a string parameter where you can specify the number of latest versions to keep if you do not want to retire all the previous active versions."
       end
 
       def self.authors
@@ -125,7 +136,7 @@ module Fastlane
 
       def self.details
         # Optional:
-        "retire_previous_versions - To retire all active versions of the application on the AirWatch console except the latest version."
+        "retire_previous_versions - To retire previous active versions of an application on the AirWatch console except the latest version."
       end
 
       def self.available_options
@@ -166,13 +177,14 @@ module Fastlane
                                               UI.user_error!("No app identifier given, pass using `app_identifier: 'com.example.app'`") unless value and !value.empty?
                                             end),
 
-          FastlaneCore::ConfigItem.new(key: :app_name,
-                                  env_name: "AIRWATCH_APPLICATION_NAME",
-                               description: "Name of the application",
-                                  optional: false,
+          FastlaneCore::ConfigItem.new(key: :keep_latest_versions_count,
+                                  env_name: "AIRWATCH_KEEP_LATEST_VERSIONS_COUNT",
+                               description: "Name of the application. default: 1",
+                                  optional: true,
                                       type: String,
+                             default_value: "1",
                               verify_block: proc do |value|
-                                              UI.user_error!("No app name given, pass using `app_name: 'My sample app'`") unless value and !value.empty?
+                                              UI.user_error!("The number of latest versions to keep can not be zero or negative") unless value.to_i > 0
                                             end),
 
           FastlaneCore::ConfigItem.new(key: :debug,
@@ -200,4 +212,4 @@ module Fastlane
 
     end
   end
-end
+end