checkoff 0.185.0 → 0.186.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c144884f931d0a839d66654dbb1ce02487d6024bbd32ca3a56ed749dfb650fa
-  data.tar.gz: fbce0b5063ca8dbec172cc2f3d062a266daae30af1d70d090586cb8eee485b03
+  metadata.gz: ab93a442000f1d706e304c5d574a9266c19dcff4be222107dc943f6c1d3ecd3f
+  data.tar.gz: 373ce95b10e181827c2423bfce1a0a37f43a12b32ebebd79ea5b8e98dcc0787f
 SHA512:
-  metadata.gz: c77b6170bf7eaa08e532eb38013ff25ae581d7363543128516a98d1cf354bc5137e6caa24e8f99d5d2ec52747ed300fc3e9ab279a3a209e89eee5a64b5900b10
-  data.tar.gz: 928dba035f252897d2a400b1b55ba05bf98dc91f676818395a6d070f14ed0f179a8e09421f4580f9c7c3bff15d1570eee7b7561d0a4d01b0d3dfcd68d0f6ab83
+  metadata.gz: b4f7267e3254bb4d22593bca64557ec58641b69ff95ceb7890c34a5c87512b27a5dda4fecf7db78ee5088692dbcc8c5380f673459a9df3c1edd744746215d364
+  data.tar.gz: '0680cf901961be8001249375c81ceaa77ed903e0acb2f06ecc3b62093a110d7d4bcc225e706d46b31838a50d08d0f8811f4e636166715f5d48b73e33a940f521'

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.185.0)
+    checkoff (0.186.0)
       activesupport
       asana (> 0.10.0)
       cache_method

data/config/definitions.rb

@@ -50,6 +50,8 @@
 #         def due_at; end
 #         # @return [String,nil]
 #         def due_on; end
+#         # @return [String,nil]
+#         def name; end
 #         # @return [Hash<String, String>, nil]
 #         def assignee; end
 #         # @return [String, nil]
@@ -61,8 +63,14 @@
 #           def create(client, assignee:, workspace:, name:); end
 #         end
 #       end
+#       class Section
+#         # @return [String,nil]
+#         def name; end
+#       end
 #       class Project
 #         # @return [String,nil]
+#         def name; end
+#         # @return [String,nil]
 #         def due_date; end
 #       end
 #       class Portfolio
@@ -70,6 +78,9 @@
 #         def get_items(options = {}); end
 #       end
 #     end
+#     module Errors
+#       class NotFound < StandardError; end
+#     end
 #     module Resources
 #       class Workspace
 #         # @return [String, nil]

data/lib/checkoff/events.rb

@@ -7,6 +7,7 @@ require 'cache_method'
 require_relative 'internal/config_loader'
 require_relative 'internal/logging'
 require_relative 'internal/asana_event_filter'
+require_relative 'internal/asana_event_enrichment'
 require_relative 'workspaces'
 require_relative 'clients'
 
@@ -34,19 +35,28 @@ module Checkoff
     # @param config [Hash]
     # @param workspaces [Checkoff::Workspaces]
     # @param tasks [Checkoff::Tasks]
+    # @param sections [Checkoff::Sections]
+    # @param projects [Checkoff::Projects]
     # @param clients [Checkoff::Clients]
     # @param client [Asana::Client]
     # @param asana_event_filter_class [Class<Checkoff::Internal::AsanaEventFilter>]
+    # @param asana_event_enrichment [Checkoff::Internal::AsanaEventEnrichment]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    workspaces: Checkoff::Workspaces.new(config: config),
                    tasks: Checkoff::Tasks.new(config: config),
+                   sections: Checkoff::Sections.new(config: config),
+                   projects: Checkoff::Projects.new(config: config),
                    clients: Checkoff::Clients.new(config: config),
                    client: clients.client,
-                   asana_event_filter_class: Checkoff::Internal::AsanaEventFilter)
+                   asana_event_filter_class: Checkoff::Internal::AsanaEventFilter,
+                   asana_event_enrichment: Checkoff::Internal::AsanaEventEnrichment.new)
       @workspaces = workspaces
       @tasks = tasks
+      @sections = sections
+      @projects = projects
       @client = client
       @asana_event_filter_class = asana_event_filter_class
+      @asana_event_enrichment = asana_event_enrichment
     end
 
     # @param filters [Array<Hash>, nil] The filters to match against
@@ -65,34 +75,35 @@ module Checkoff
     #
     # @return [Hash]
     def enrich_event(asana_event)
-      finer { "Enriching event: #{asana_event}" }
-      asana_event = asana_event.dup
-      enrich_event_resource!(asana_event)
-      asana_event
+      asana_event_enrichment.enrich_event(asana_event)
     end
 
-    private
+    # @param filter [Hash<String,[String,Array<String>]>]
+    #
+    # @return [Hash<String,[String,Array<String>]>]
+    def enrich_filter(filter)
+      asana_event_enrichment.enrich_filter(filter)
+    end
 
-    # @param asana_event [Hash{'resource' => Hash}]
+    # @param webhook_subscription [Hash] Hash of the request made to
+    #   webhook POST endpoint - https://app.asana.com/api/1.0/webhooks
+    #   https://developers.asana.com/reference/createwebhook
     #
     # @return [void]
-    def enrich_event_resource!(asana_event)
-      # @type [Hash{String => String }]
-      resource = asana_event['resource']
-      # @type [String]
-      resource_type = resource.fetch('resource_type')
-      # @type [String]
-      gid = resource.fetch('gid')
-
-      if resource_type == 'task'
-        task = tasks.task_by_gid(gid, only_uncompleted: false)
-        resource['checkoff:name'] = task.name if task
-      end
-      nil
+    def enrich_webhook_subscription!(webhook_subscription)
+      asana_event_enrichment.enrich_webhook_subscription!(webhook_subscription)
     end
 
+    private
+
     include Logging
 
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+
+    # @return [Checkoff::Sections]
+    attr_reader :sections
+
     # @return [Checkoff::Tasks]
     attr_reader :tasks
 
@@ -102,6 +113,9 @@ module Checkoff
     # @return [Asana::Client]
     attr_reader :client
 
+    # @return [Checkoff::Internal::AsanaEventEnrichment]
+    attr_reader :asana_event_enrichment
+
     # bundle exec ./events.rb
     # :nocov:
     class << self

data/lib/checkoff/internal/asana_event_enrichment.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require 'checkoff/internal/config_loader'
+require 'checkoff/internal/logging'
+require 'checkoff/internal/asana_event_enrichment'
+require 'checkoff/workspaces'
+require 'checkoff/clients'
+
+module Checkoff
+  module Internal
+    # Add useful info (like resource task names) into an Asana
+    # event/event filters/webhook subscription for human consumption
+    class AsanaEventEnrichment
+      # @param config [Hash]
+      # @param workspaces [Checkoff::Workspaces]
+      # @param tasks [Checkoff::Tasks]
+      # @param sections [Checkoff::Sections]
+      # @param projects [Checkoff::Projects]
+      # @param clients [Checkoff::Clients]
+      # @param client [Asana::Client]
+      # @param asana_event_enrichment [Checkoff::Internal::AsanaEventEnrichment]
+      def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                     workspaces: Checkoff::Workspaces.new(config: config),
+                     tasks: Checkoff::Tasks.new(config: config),
+                     sections: Checkoff::Sections.new(config: config),
+                     projects: Checkoff::Projects.new(config: config),
+                     clients: Checkoff::Clients.new(config: config),
+                     client: clients.client)
+        @workspaces = workspaces
+        @tasks = tasks
+        @sections = sections
+        @projects = projects
+        @client = client
+      end
+
+      # Add useful info (like resource task names) into an event for
+      # human consumption
+      #
+      # @param asana_event [Hash]
+      #
+      # @return [Hash]
+      def enrich_event(asana_event)
+        finer { "Enriching event: #{asana_event}" }
+        asana_event = asana_event.dup
+        enrich_event_resource!(asana_event)
+        enrich_event_parent!(asana_event)
+        asana_event
+      end
+
+      # @param filter [Hash<String,[String,Array<String>]>]
+      #
+      # @return [Hash<String,[String,Array<String>]>]
+      def enrich_filter(filter)
+        filter = filter.dup
+        enrich_filter_section!(filter)
+        enrich_filter_resource!(filter)
+        enrich_filter_parent_gid!(filter)
+        filter
+      end
+
+      # @param webhook_subscription [Hash] Hash of the request made to
+      #   webhook POST endpoint - https://app.asana.com/api/1.0/webhooks
+      #   https://developers.asana.com/reference/createwebhook
+      #
+      # @return [void]
+      def enrich_webhook_subscription!(webhook_subscription)
+        webhook_subscription&.fetch('filters', nil)&.map! do |filter|
+          enrich_filter(filter)
+        end
+        resource = webhook_subscription&.fetch('resource', nil)
+        # @sg-ignore
+        name, resource_type = enrich_gid(resource) if resource
+        webhook_subscription['checkoff:enriched:name'] = name if name
+        webhook_subscription['checkoff:enriched:resource_type'] = resource_type if resource_type
+      end
+
+      private
+
+      # Attempt to look up a GID in situations where we don't have a
+      # resource type provided, and returns the name of the resource.
+      #
+      # @param gid [String]
+      # @param resource_type [String,nil]
+      #
+      # @return [Array<([String, nil], [String,nil])>]
+      def enrich_gid(gid, resource_type: nil)
+        %w[task section project].each do |resource_type_to_try|
+          next unless [resource_type_to_try, nil].include?(resource_type)
+
+          name = method(:"enrich_#{resource_type_to_try}_gid").call(gid)
+          return [name, resource_type_to_try] if name
+        end
+        [nil, nil]
+      end
+
+      # @param filter [Hash{String => String}]
+      #
+      # @return [String, nil]
+      def enrich_filter_parent_gid!(filter)
+        parent_gid = filter['checkoff:parent.gid']
+        return unless parent_gid
+
+        # @sg-ignore
+        name, resource_type = enrich_gid(parent_gid)
+        filter['checkoff:enriched:parent.name'] = name if name
+        filter['checkoff:enriched:parent.resource_type'] = resource_type if resource_type
+      end
+
+      # @param gid [String]
+      #
+      # @return [String, nil]
+      def enrich_task_gid(gid)
+        task = tasks.task_by_gid(gid, only_uncompleted: false)
+        task&.name
+      end
+
+      # @param section_gid [String]
+      #
+      # @return [String, nil]
+      def enrich_section_gid(section_gid)
+        section = sections.section_by_gid(section_gid)
+        section&.name
+      end
+
+      # @param project_gid [String]
+      #
+      # @return [String, nil]
+      def enrich_project_gid(project_gid)
+        project = projects.project_by_gid(project_gid)
+        project&.name
+      end
+
+      # @param filter [Hash{String => String}]
+      #
+      # @return [void]
+      def enrich_filter_resource!(filter)
+        resource_gid = filter['checkoff:resource.gid']
+
+        return unless resource_gid
+
+        task = tasks.task_by_gid(resource_gid)
+        filter['checkoff:enriched:resource.name'] = task.name if task
+      end
+
+      # @param filter [Hash{String => [String,Array<String>]}]
+      #
+      # @return [void]
+      def enrich_filter_section!(filter)
+        section_gid = filter['checkoff:fetched.section.gid']
+        return unless section_gid
+
+        name = enrich_section_gid(section_gid)
+        filter['checkoff:enriched:fetched.section.name'] = name if name
+      end
+
+      # @param asana_event [Hash{'resource' => Hash}]
+      #
+      # @return [void]
+      def enrich_event_parent!(asana_event)
+        # @type [Hash{String => String }]
+        parent = asana_event['parent']
+
+        return unless parent
+
+        # @type [String]
+        resource_type = parent.fetch('resource_type')
+        # @type [String]
+        gid = parent.fetch('gid')
+        # @sg-ignore
+        name, _resource_type = enrich_gid(gid, resource_type: resource_type)
+        parent['checkoff:enriched:name'] = name if name
+
+        nil
+      end
+
+      # @param asana_event [Hash{'resource' => Hash}]
+      #
+      # @return [void]
+      def enrich_event_resource!(asana_event)
+        # @type [Hash{String => String }]
+        resource = asana_event['resource']
+        # @type [String]
+        resource_type = resource.fetch('resource_type')
+
+        # @type [String]
+        gid = resource.fetch('gid')
+
+        # @sg-ignore
+        name, _resource_type = enrich_gid(gid, resource_type: resource_type)
+        resource['checkoff:enriched:name'] = name if name
+
+        nil
+      end
+
+      include Logging
+
+      # @return [Checkoff::Projects]
+      attr_reader :projects
+
+      # @return [Checkoff::Sections]
+      attr_reader :sections
+
+      # @return [Checkoff::Tasks]
+      attr_reader :tasks
+
+      # @return [Checkoff::Workspaces]
+      attr_reader :workspaces
+
+      # @return [Asana::Client]
+      attr_reader :client
+    end
+  end
+end

data/lib/checkoff/projects.rb

@@ -3,6 +3,7 @@
 require_relative 'internal/config_loader'
 require_relative 'internal/project_hashes'
 require_relative 'internal/project_timing'
+require_relative 'internal/logging'
 require_relative 'workspaces'
 require_relative 'clients'
 require_relative 'timing'
@@ -99,9 +100,12 @@ module Checkoff
     # @param gid [String]
     # @param [Array<String>] extra_fields
     #
-    # @return [Asana::Resources::Project]
+    # @return [Asana::Resources::Project,nil]
     def project_by_gid(gid, extra_fields: [])
       projects.find_by_id(gid, options: { fields: %w[name] + extra_fields })
+    rescue Asana::Errors::NotFound => e
+      debug e
+      nil
     end
     cache_method :project_by_gid, REALLY_LONG_CACHE_TIME
 
@@ -192,8 +196,15 @@ module Checkoff
       timing.in_period?(project_date, period)
     end
 
+    # @return [Hash]
+    def as_cache_key
+      {}
+    end
+
     private
 
+    include Logging
+
     # @return [Checkoff::Timing]
     attr_reader :timing
 

data/lib/checkoff/sections.rb

@@ -5,6 +5,7 @@ require_relative 'projects'
 require_relative 'workspaces'
 require_relative 'clients'
 require_relative 'my_tasks'
+require_relative 'internal/logging'
 
 module Checkoff
   # Query different sections of Asana projects
@@ -197,15 +198,26 @@ module Checkoff
 
     # @param gid [String]
     #
-    # @return [Asana::Resources::Section]
+    # @return [Asana::Resources::Section, nil]
     def section_by_gid(gid)
       options = {}
       Asana::Resources::Section.new(parse(client.get("/sections/#{gid}", options: options)).first,
                                     client: client)
+    rescue Asana::Errors::NotFound => e
+      debug e
+      nil
+    end
+    cache_method :section_by_gid, SHORT_CACHE_TIME
+
+    # @return [Hash]
+    def as_cache_key
+      {}
     end
 
     private
 
+    include Logging
+
     # https://github.com/Asana/ruby-asana/blob/master/lib/asana/resource_includes/response_helper.rb#L7
     # @param response [Faraday::Response]
     #

data/lib/checkoff/tasks.rb

@@ -161,6 +161,9 @@ module Checkoff
       options[:fields] += extra_fields
       options[:completed_since] = '9999-12-01' if only_uncompleted
       client.tasks.find_by_id(task_gid, options: options)
+    rescue Asana::Errors::NotFound => e
+      debug e
+      nil
     end
     cache_method :task_by_gid, SHORT_CACHE_TIME
 

data/lib/checkoff/version.rb

@@ -3,5 +3,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.185.0'
+  VERSION = '0.186.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.185.0
+  version: 0.186.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -149,6 +149,7 @@ files:
 - lib/checkoff/create-entity.sh
 - lib/checkoff/custom_fields.rb
 - lib/checkoff/events.rb
+- lib/checkoff/internal/asana_event_enrichment.rb
 - lib/checkoff/internal/asana_event_filter.rb
 - lib/checkoff/internal/config_loader.rb
 - lib/checkoff/internal/create-class.sh