apadmi_grout 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b05dbffa45a449751c8ce0eb6a0b8f66e2bf4ef5b9aeaa41617b3af4ea0fde
-  data.tar.gz: b0b6bd5fbaa0459f2e76f285a521bdafc8e3317e492cd0ea7c4c58f7d5bfb8bb
+  metadata.gz: af094b716e2764d75b2f0729c40c82e2bb2ffe13f2775a2e2d6480540c471922
+  data.tar.gz: 7ab7d36c4e120a348ee74e2e67386fd1f497d40c5bb684951777edef79caf5c8
 SHA512:
-  metadata.gz: 596f948aa2b574e36f3cba0ed4a596332f95f7c24d23c1f817ac1baa851e392ecb67222a7e18e871d1ab2fcd666d4f626944224bc843c576595581db68ef5281
-  data.tar.gz: a1e727a0b3d8786525a0102cf736a9f50b04f9459edc58c81e418776b83ca913753e575152a92ac91040b98c6e920ed86140edfa43ceaaab24b42a28ec948d72
+  metadata.gz: 586a0f1eaf5d0ca433ad18a9c09965da229459bd172a217e04d1ee74a82cfc349cd7841093b40b29f8762bbf37310f3a0a423731bfd1ded2e55697f32663c0a5
+  data.tar.gz: f77fb691459927030db6f936f5768aa69fd72b5906c23f044bc8e885a6a7084a9bd20c723a5736008a0f42800d955ffd935e8200200bb8ea9c6ec882bcd92e2f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Core Changelog
 
+## [2.6.0] - 2023-09-20
+* Add option to expand ADO tickets with additional information
+* Add ability to assign users to ADO tickets
+
+## [2.5.0] - 2023-09-20
+* Added more options to the ADO queries for more in granular filtering.
+
 ## [2.4.0] - 2023-09-04
 * No change - keeping version in sync with fastlane plugin.
 

data/lib/apadmi/grout/models/ado_config.rb

@@ -4,7 +4,12 @@ module Apadmi
   module Grout
     AdoConfig = Struct.new(
       :flag_tag,
+      :expand_type,
       keyword_init: true
-    )
+    ) do
+      def initialize(flag_tag:, expand_type: "none")
+        super
+      end
+    end
   end
 end

data/lib/apadmi/grout/models/find_tickets_options.rb

@@ -25,11 +25,12 @@ module Apadmi
 
     # Ado specific find tickets options
     class AdoFindTicketsOptions < FindTicketsOptions
-      attr_reader :required_tags, :not_tags
+      attr_reader :required_tags, :not_tags, :additional_fields
 
-      def initialize(required_tags: [], not_tags: [])
+      def initialize(required_tags: [], not_tags: [], additional_fields: {})
         @required_tags = required_tags
         @not_tags = not_tags
+        @additional_fields = additional_fields
       end
 
       def ==(other)
@@ -37,7 +38,7 @@ module Apadmi
       end
 
       def state
-        [@required_tags, @not_tags]
+        [@required_tags, @not_tags, @additional_fields]
       end
     end
   end

data/lib/apadmi/grout/service/board_service/ado_board_service.rb

@@ -24,7 +24,7 @@ module Apadmi
 
         keys = keys.map { |k| sanitise_key(k) } # Allows supporting raw keys, and keys prefixed with a hash which is common ADO practice
 
-        res = @network_service.do_get("/wit/workitems?ids=#{keys.join(",")}&errorPolicy=omit&api-version=7.1-preview.2")
+        res = @network_service.do_get("/wit/workitems?ids=#{keys.join(",")}&$expand=#{@ado_config.expand_type}&errorPolicy=omit&api-version=7.1-preview.2")
         parsed = JSON.parse(res.body)
         items = parsed["value"]
 
@@ -40,24 +40,16 @@ module Apadmi
 
       # @return [Array<Apadmi::Grout::Issue>]
       def search_unblocked_issues(component, status, ticket_types = [], options = nil)
-        tags = (options&.required_tags || []).push(*component).filter { |it| !it.blank? }
-        not_tags = (options&.not_tags || []).filter { |it| !it.blank? }
-
-        raise "Tags can either be required or not required, not both" unless (tags & not_tags).empty?
-
-        tags_filter = tags.map { |tag| " AND [System.Tags] CONTAINS '#{tag}' " }.join(" ")
-        not_tags_filter = not_tags.map { |tag| " AND [System.Tags] NOT CONTAINS '#{tag}'" }.join(" ")
-
         status_filter = ("AND [System.State]='#{status}' " unless status.blank?) || ""
         type_filter = ("AND [System.WorkItemType] IN (#{ticket_types.map { |t| "'#{t}'" }.join(", ")})" unless ticket_types.empty?) || ""
+        options_filter = get_options_filter(component, options)
         wiql = %(
           Select [System.Id]
           From WorkItems
           Where [System.Id] >= 1
           #{status_filter}
-          #{tags_filter}
-          #{not_tags_filter}
           #{type_filter}
+          #{options_filter}
         )
 
         get_issues_by_wiql(wiql)
@@ -90,6 +82,12 @@ module Apadmi
         @network_service.do_post("/wit/workitems/#{key}/comments?#{API_VERSION_PARAM}-preview.3", payload.to_json)
       end
 
+      # @param String key
+      # @param [Array<Hash>] payload
+      def update_ticket(key, payload)
+        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+      end
+
       # @param [String] key
       # @param [String] tag
       def add_tag(key, tag)
@@ -98,7 +96,7 @@ module Apadmi
           "path" => "/fields/System.Tags",
           "value" => tag
         }]
-        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+        update_ticket(key, payload)
       end
 
       # @param [String] key
@@ -112,7 +110,7 @@ module Apadmi
           "path" => "/fields/System.Tags",
           "value" => new_tags.join("; ")
         }]
-        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+        update_ticket(key, payload)
       end
 
       # @param [String] key
@@ -140,7 +138,7 @@ module Apadmi
           "path" => "/fields/Microsoft.VSTS.Build.IntegrationBuild",
           "value" => versions.join("; ")
         }]
-        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+        update_ticket(key, payload)
       end
 
       # @param [String] key
@@ -161,7 +159,27 @@ module Apadmi
           "path" => "/fields/System.State",
           "value" => state_name
         }]
-        @network_service.do_patch("/wit/workitems/#{key}?#{API_VERSION_PARAM}", payload.to_json)
+        update_ticket(key, payload)
+      end
+
+      # @param [String] key
+      # @param [String] user
+      def assign_to_user(key, user)
+        key = sanitise_key(key)
+
+        payload = if user
+                    [{
+                      "op": "add",
+                      "path": "/fields/System.AssignedTo",
+                      "value": user
+                    }]
+                  else
+                    [{
+                      "op": "remove",
+                      "path": "/fields/System.AssignedTo"
+                    }]
+                  end
+        update_ticket(key, payload)
       end
 
       # @param [String] key
@@ -194,6 +212,28 @@ module Apadmi
         ids = items.map { |item| item["id"] } || []
         find_issues_by_keys(ids)
       end
+
+      # @param component [String] Included to be consistent with JIRA, this will boil down to a tag in ADO
+      # @param options [Apadmi::Grout::AdoFindTicketsOptions] options as defined to query
+
+      # @return [String]
+      def get_options_filter(component, options = nil)
+        tags = (options&.required_tags || []).push(*component).filter { |it| !it.blank? }
+        not_tags = (options&.not_tags || []).filter { |it| !it.blank? }
+        additional_fields = (options&.additional_fields || {}).reject { |k, _v| k.blank? }
+
+        raise "Tags can either be required or not required, not both" unless (tags & not_tags).empty?
+
+        tags_filter = tags.map { |tag| " AND [System.Tags] CONTAINS '#{tag}' " }.join(" ")
+        not_tags_filter = not_tags.map { |tag| " AND [System.Tags] NOT CONTAINS '#{tag}'" }.join(" ")
+        additional_fields_filter = additional_fields.collect { |k, v| "AND [#{k}]='#{v}'" }.join(" ")
+
+        %(
+          #{tags_filter}
+          #{not_tags_filter}
+          #{additional_fields_filter}
+        )
+      end
     end
   end
 end

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "2.4.0"
+    VERSION = "2.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Apadmi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-04 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday