checkoff 0.193.0 → 0.195.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740a4435d472d0e2034b946c694abd1f40e91bcbf874380ca43de89e82bbdb8e
-  data.tar.gz: 7e41942a46e0dc7ad297a1ce4379fab954a2d3831c223c4a99801cd9567ecb70
+  metadata.gz: c777dc82cc51fd0ec445c1413fc6f33ed37e98b8a41026446cec61f800ec0417
+  data.tar.gz: bb7edb3ed4eb31a171cd4204a338ea56b6097a4cee8bf299e451ee7ecf342e59
 SHA512:
-  metadata.gz: c96bb1cc1df2d2874eecb23c8328bb48ea7b5401188dd072dfba815d908965316a9c8062879d61ce6a949b1adfd635db54c6d0a6b436678f0202ad1121072562
-  data.tar.gz: c3b68ef7459b67ccfa436788730b22e01139a12f05d8507b386d3813e0f172e0ff20109ddd2ae2355660c1fe51b9080344e264351a0d79eba1ff6967ece439f7
+  metadata.gz: 794bf6eba0270a4cb002421f2e0857b20268d348bec359dc5d1363f345a60f385d1dea1cf26f0530cabd015e1f06b4b037ca54b342174ac5415c1f93eed3afa7
+  data.tar.gz: c9263dd810014f080b6d52c6954dd86aca9f837b88e10c711be154c49f7652cdba92303d462bee08a1c25a2f34b3ef3b85a14557410892c052916ea82a7eb098

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.193.0)
+    checkoff (0.195.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -130,11 +130,11 @@ GEM
     multi_xml (0.6.0)
     multipart-post (2.3.0)
     mutex_m (0.2.0)
-    nokogiri (1.15.5-arm64-darwin)
+    nokogiri (1.16.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-darwin)
+    nokogiri (1.16.2-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-linux)
+    nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
     oauth2 (1.4.11)
       faraday (>= 0.17.3, < 3.0)

data/lib/checkoff/internal/asana_event_enrichment.rb

@@ -18,6 +18,7 @@ module Checkoff
       # @param tasks [Checkoff::Tasks]
       # @param sections [Checkoff::Sections]
       # @param projects [Checkoff::Projects]
+      # @param resources [Checkoff::Resources]
       # @param clients [Checkoff::Clients]
       # @param client [Asana::Client]
       # @param asana_event_enrichment [Checkoff::Internal::AsanaEventEnrichment]
@@ -26,12 +27,14 @@ module Checkoff
                      tasks: Checkoff::Tasks.new(config: config),
                      sections: Checkoff::Sections.new(config: config),
                      projects: Checkoff::Projects.new(config: config),
+                     resources: Checkoff::Resources.new(config: config),
                      clients: Checkoff::Clients.new(config: config),
                      client: clients.client)
         @workspaces = workspaces
         @tasks = tasks
         @sections = sections
         @projects = projects
+        @resources = resources
         @client = client
       end
 
@@ -86,13 +89,9 @@ module Checkoff
       #
       # @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]
+        # @sg-ignore
+        resource, resource_type = resources.resource_by_gid(gid, resource_type: resource_type)
+        [resource&.name, resource_type]
       end
 
       # @param filter [Hash{String => String}]
@@ -108,30 +107,6 @@ module Checkoff
         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]
@@ -151,7 +126,8 @@ module Checkoff
         section_gid = filter['checkoff:fetched.section.gid']
         return unless section_gid
 
-        name = enrich_section_gid(section_gid)
+        section = sections.section_by_gid(section_gid)
+        name = section&.name
         filter['checkoff:enriched:fetched.section.name'] = name if name
       end
 
@@ -208,6 +184,9 @@ module Checkoff
       # @return [Checkoff::Workspaces]
       attr_reader :workspaces
 
+      # @return [Checkoff::Resources]
+      attr_reader :resources
+
       # @return [Asana::Client]
       attr_reader :client
     end

data/lib/checkoff/projects.rb

@@ -52,17 +52,46 @@ module Checkoff
       @timing = timing
     end
 
+    # @param extra_fields [Array<String>]
+    #
+    # @return [Array<String>]
+    def task_fields(extra_fields: [])
+      (%w[name completed_at start_at start_on due_at due_on tags
+          memberships.project.gid memberships.project.name
+          memberships.section.name dependencies] + extra_fields).sort.uniq
+    end
+
     # Default options used in Asana API to pull tasks
+    #
+    # @param extra_fields [Array<String>]
+    # @param [Boolean] only_uncompleted
+    #
     # @return [Hash<Symbol, Object>]
-    def task_options
-      {
+    def task_options(extra_fields: [], only_uncompleted: false)
+      options = {
         per_page: 100,
         options: {
-          fields: %w[name completed_at start_at start_on due_at due_on tags
-                     memberships.project.gid memberships.project.name
-                     memberships.section.name dependencies],
+          fields: task_fields(extra_fields: extra_fields),
         },
       }
+      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options
+    end
+
+    # @param extra_project_fields [Array<String>]
+    #
+    # @return [Array<String>]
+    def project_fields(extra_project_fields: [])
+      (%w[name custom_fields] + extra_project_fields).sort.uniq
+    end
+
+    # Default options used in Asana API to pull projects
+    #
+    # @param extra_project_fields [Array<String>]
+    #
+    # @return [Hash<Symbol, Object>]
+    def project_options(extra_project_fields: [])
+      { fields: project_fields(extra_project_fields: extra_project_fields) }
     end
 
     # pulls an Asana API project class given a name
@@ -103,7 +132,7 @@ module Checkoff
     #
     # @return [Asana::Resources::Project,nil]
     def project_by_gid(gid, extra_fields: [])
-      projects.find_by_id(gid, options: { fields: %w[name] + extra_fields })
+      projects.find_by_id(gid, options: project_options(extra_project_fields: extra_fields))
     rescue Asana::Errors::NotFound => e
       debug e
       nil
@@ -142,10 +171,8 @@ module Checkoff
     def tasks_from_project_gid(project_gid,
                                only_uncompleted: true,
                                extra_fields: [])
-      options = task_options
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = task_options(extra_fields: extra_fields, only_uncompleted: only_uncompleted)
       options[:project] = project_gid
-      options[:options][:fields] += extra_fields
       # Note: 30 minute cache time on a raw Enumerable from SDK gives
       # 'Your pagination token has expired' errors.  So we go ahead
       # and eagerly evaluate here so we can enjoy the cache.
@@ -158,11 +185,12 @@ module Checkoff
     # @return [Enumerable<Asana::Resources::Project>]
     def projects_by_workspace_name(workspace_name, extra_fields: [])
       workspace = @workspaces.workspace_or_raise(workspace_name)
-      options = { fields: %w[name] + extra_fields }
       # 15 minute cache resulted in 'Your pagination token has
       # expired', so let's cache this a super long time and force
       # evaluation
-      projects.find_by_workspace(workspace: workspace.gid, per_page: 100, options: options).to_a
+      projects.find_by_workspace(workspace: workspace.gid,
+                                 per_page: 100,
+                                 options: project_options(extra_project_fields: extra_fields)).to_a
     end
     cache_method :projects_by_workspace_name, REALLY_LONG_CACHE_TIME
 

data/lib/checkoff/resources.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'workspaces'
+require_relative 'clients'
+
+# https://developers.asana.com/reference/resources
+
+module Checkoff
+  # Deal with Asana resources across different resource types
+  class Resources
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
+    MINUTE = 60
+    private_constant :MINUTE
+    HOUR = MINUTE * 60
+    private_constant :HOUR
+    DAY = 24 * HOUR
+    private_constant :DAY
+    REALLY_LONG_CACHE_TIME = HOUR * 1
+    private_constant :REALLY_LONG_CACHE_TIME
+    LONG_CACHE_TIME = MINUTE * 15
+    private_constant :LONG_CACHE_TIME
+    SHORT_CACHE_TIME = MINUTE
+    private_constant :SHORT_CACHE_TIME
+
+    # @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]
+    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
+
+    # Attempt to look up a GID, even in situations where we don't
+    # have a resource type provided.
+    #
+    # @param gid [String]
+    # @param resource_type [String,nil]
+    #
+    # @return [Array<([Asana::Resource, nil], [String,nil])>]
+    def resource_by_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)
+
+        resource = method(:"fetch_#{resource_type_to_try}_gid").call(gid)
+        return [resource, resource_type_to_try] if resource
+      end
+      [nil, nil]
+    end
+
+    private
+
+    # @param gid [String]
+    #
+    # @return [Asana::Resources::Task, nil]
+    def fetch_task_gid(gid)
+      tasks.task_by_gid(gid, only_uncompleted: false)
+    end
+
+    # @param section_gid [String]
+    #
+    # @return [Asana::Resources::Section, nil]
+    def fetch_section_gid(section_gid)
+      sections.section_by_gid(section_gid)
+    end
+
+    # @param project_gid [String]
+    #
+    # @return [Asana::Resources::Project, nil]
+    def fetch_project_gid(project_gid)
+      projects.project_by_gid(project_gid)
+    end
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+
+    # @return [Checkoff::Sections]
+    attr_reader :sections
+
+    # @return [Checkoff::Tasks]
+    attr_reader :tasks
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./resources.rb
+    # :nocov:
+    class << self
+      # @return [void]
+      def run
+        # # @sg-ignore
+        # # @type [String]
+        # workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
+        # # @sg-ignore
+        # # @type [String]
+        # resource_name = ARGV[1] || raise('Please pass resource name as second argument')
+        # resources = Checkoff::Resources.new
+        # resource = resources.resource_or_raise(workspace_name, resource_name)
+        # puts "Results: #{resource}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::Resources.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/sections.rb

@@ -106,9 +106,8 @@ module Checkoff
     def tasks_by_section_gid(section_gid,
                              only_uncompleted: true,
                              extra_fields: [])
-      options = projects.task_options
-      options[:options][:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = projects.task_options(extra_fields: extra_fields,
+                                      only_uncompleted: only_uncompleted)
       client.tasks.get_tasks(section: section_gid, **options)
     end
 
@@ -127,9 +126,8 @@ module Checkoff
               only_uncompleted: true,
               extra_fields: [])
       section = section_or_raise(workspace_name, project_name, section_name)
-      options = projects.task_options
-      options[:options][:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = projects.task_options(extra_fields: extra_fields,
+                                      only_uncompleted: only_uncompleted)
       # Note: 30 minute cache time on a raw Enumerable from SDK gives
       # 'Your pagination token has expired' errors.  So we go ahead
       # and eagerly evaluate here so we can enjoy the cache.

data/lib/checkoff/subtasks.rb

@@ -73,12 +73,9 @@ module Checkoff
                         extra_fields: [],
                         only_uncompleted: true)
       # @type [Hash]
-      options = projects.task_options.fetch(:options, {})
-      options[:fields] += extra_fields
-      options[:fields] += %w[is_rendered_as_separator]
-      options[:fields].uniq!
-
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      all_options = projects.task_options(extra_fields: extra_fields + %w[is_rendered_as_separator],
+                                          only_uncompleted: only_uncompleted)
+      options = all_options.fetch(:options, {})
       client.tasks.get_subtasks_for_task(task_gid: task_gid,
                                          # per_page: 100, # stub doesn't have this arg available
                                          options: options)

data/lib/checkoff/tags.rb

@@ -36,7 +36,8 @@ module Checkoff
               extra_fields: [])
       tag = tag_or_raise(workspace_name, tag_name)
 
-      options = build_task_options(projects.task_options, extra_fields, only_uncompleted)
+      options = projects.task_options(extra_fields: extra_fields,
+                                      only_uncompleted: only_uncompleted)
 
       params = build_params(options)
 
@@ -65,12 +66,6 @@ module Checkoff
 
     attr_reader :workspaces, :projects, :client
 
-    def build_task_options(task_options, extra_fields, only_uncompleted)
-      task_options[:options][:fields] += extra_fields
-      task_options[:completed_since] = '9999-12-01' if only_uncompleted
-      task_options
-    end
-
     def build_params(options)
       { limit: options[:per_page], completed_since: options[:completed_since] }.reject do |_, v|
         v.nil? || Array(v).empty?

data/lib/checkoff/task_searches.rb

@@ -193,10 +193,8 @@ module Checkoff
     # @return [Hash<Symbol, Object>]
     def calculate_api_options(extra_fields)
       # @type [Hash<Symbol, Object>]
-      options = projects.task_options[:options]
-      options[:fields] += ['custom_fields']
-      options[:fields] += extra_fields
-      options
+      all_options = projects.task_options(extra_fields: ['custom_fields'] + extra_fields)
+      all_options[:options]
     end
 
     # bundle exec ./task_searches.rb

data/lib/checkoff/tasks.rb

@@ -156,10 +156,12 @@ module Checkoff
     def task_by_gid(task_gid,
                     extra_fields: [],
                     only_uncompleted: true)
+      # @type [Hash{Symbol => Object}]
+      all_options = projects.task_options(extra_fields: extra_fields,
+                                          only_uncompleted: only_uncompleted)
       # @type [Hash]
-      options = projects.task_options.fetch(:options, {})
-      options[:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = all_options.fetch(:options, {})
+      options[:completed_since] = all_options[:completed_since] unless all_options[:completed_since].nil?
       client.tasks.find_by_id(task_gid, options: options)
     rescue Asana::Errors::NotFound => e
       debug e

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.193.0
+  version: 0.195.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,7 @@ files:
 - lib/checkoff/portfolios.rb
 - lib/checkoff/project_selectors.rb
 - lib/checkoff/projects.rb
+- lib/checkoff/resources.rb
 - lib/checkoff/section_selectors.rb
 - lib/checkoff/sections.rb
 - lib/checkoff/subtasks.rb