checkoff 0.156.0 → 0.158.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7e1681e39cd8f9271a9314abcf687982bf375b762d3c64cf5e7c43f3b61b589
-  data.tar.gz: 2fe95b6c69f11f2b545afae74e8c7983773b229045cdcbdb7bb98557466f31c6
+  metadata.gz: 3411417f4aa2d4585bbffe2abbe5d035e6c87df952f7db9c13b1c0233800f65a
+  data.tar.gz: 84a4da9aa7cb6d34d5e3af3677372f16b7377aa373486ddc5db34fc7b29bb7c6
 SHA512:
-  metadata.gz: a6197bbbe0a690f572f2776111b0be018d26848a926c5d7b801d310c2101f6c2f96bd557b925f24de57990b7aed1a66630f7fbee9c52951514d95672cde3d811
-  data.tar.gz: e23898385246ac5ff3c2c331d2e87b76ba6d1e081d7adec40c8b26646bb9b42866de6ba84247e1ba2d4ca89a054be4fe44ea9494cce96a019d99e291fd6279f2
+  metadata.gz: d58a2d975ea40a4de969af0149a84b118efdf36f24d0c9bae40203bb535d032fc8b4d2a912185392d4bd7280d1e356df19f521ad14b6f089cdcc8de281548658
+  data.tar.gz: 8d6f4e1c7a7d0d09fcc84e1eb1c0a72f4ab4ed9ba30bdddff89c9239e8e60e882a5377de31846bec7d7a7938a951b27e8a23817c84e518a04abb20041e1096bf

data/Gemfile.lock

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

data/lib/checkoff/projects.rb

@@ -111,21 +111,39 @@ module Checkoff
       tasks.select { |task| task.completed_at.nil? }
     end
 
-    # pull task objects from a named project
+    # Pull task objects from a named project
+    #
     # @param [Asana::Resources::Project] project
     # @param [Boolean] only_uncompleted
     # @param [Array<String>] extra_fields
+    #
     # @return [Enumerable<Asana::Resources::Task>]
     def tasks_from_project(project,
                            only_uncompleted: true,
                            extra_fields: [])
+      tasks_from_project_gid(project.gid,
+                             only_uncompleted: only_uncompleted,
+                             extra_fields: extra_fields)
+    end
+    cache_method :tasks_from_project, SHORT_CACHE_TIME
+
+    # Pull task objects from a project identified by a gid
+    #
+    # @param [String] project_gid
+    # @param [Boolean] only_uncompleted
+    # @param [Array<String>] extra_fields
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
+    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[:project] = project.gid
+      options[:project] = project_gid
       options[:options][:fields] += extra_fields
       client.tasks.find_all(**options)
     end
-    cache_method :tasks_from_project, SHORT_CACHE_TIME
+    cache_method :tasks_from_project_gid, SHORT_CACHE_TIME
 
     # @param [String] workspace_name
     # @param [Array<String>] extra_fields

data/lib/checkoff/task_searches.rb

@@ -84,30 +84,29 @@ module Checkoff
     #
     # @param [Hash<Symbol, Object>] api_params
     # @param [String] workspace_gid
-    # @param [String] url
     # @param [Array<String>] extra_fields
     # @param [Array] task_selector
+    # @param [Boolean] fetch_all Ensure all results are provided by manually paginating
     #
     # @return [Enumerable<Asana::Resources::Task>]
-    def raw_task_search(api_params, workspace_gid:, extra_fields: [], task_selector: [])
+    def raw_task_search(api_params,
+                        workspace_gid:, extra_fields: [], task_selector: [],
+                        fetch_all: true)
       # @sg-ignore
-      path = "/workspaces/#{workspace_gid}/tasks/search"
-      options = calculate_api_options(extra_fields)
-      tasks = @asana_resources_collection_class.new(parse(client.get(path,
-                                                                     params: api_params,
-                                                                     options: options)),
-                                                    type: Asana::Resources::Task,
-                                                    client: client)
-
-      if tasks.length == 100
-        raise 'Too many results returned. ' \
-              'Please narrow your search in ways expressible through task search API: ' \
-              'https://developers.asana.com/reference/searchtasksforworkspace'
+      tasks = api_task_search_request(api_params, workspace_gid: workspace_gid, extra_fields: extra_fields)
+
+      if fetch_all && tasks.count == 100
+        # @sg-ignore
+        tasks = iterated_raw_task_search(api_params, workspace_gid: workspace_gid, extra_fields: extra_fields)
       end
 
-      debug { "#{tasks.length} raw tasks returned" }
+      debug { "#{tasks.count} raw tasks returned" }
+
+      return tasks if task_selector.empty?
 
-      tasks.select { |task| task_selectors.filter_via_task_selector(task, task_selector) }
+      tasks.select do |task|
+        task_selectors.filter_via_task_selector(task, task_selector)
+      end
     end
 
     # @return [Hash]
@@ -117,6 +116,79 @@ module Checkoff
 
     private
 
+    # Perform a search using the Asana Task Search API:
+    #
+    #   https://developers.asana.com/reference/searchtasksforworkspace
+    #
+    # @param [Hash<Symbol, Object>] api_params
+    # @param [String] workspace_gid
+    # @param [Array<String>] extra_fields
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
+    def api_task_search_request(api_params, workspace_gid:, extra_fields:)
+      path = "/workspaces/#{workspace_gid}/tasks/search"
+      options = calculate_api_options(extra_fields)
+      @asana_resources_collection_class.new(parse(client.get(path,
+                                                             params: api_params,
+                                                             options: options)),
+                                            type: Asana::Resources::Task,
+                                            client: client)
+    end
+
+    # Perform a search using the Asana Task Search API and use manual pagination to
+    # ensure all results are returned:
+    #
+    #   https://developers.asana.com/reference/searchtasksforworkspace
+    #
+    #     "However, you can paginate manually by sorting the search
+    #     results by their creation time and then modifying each
+    #     subsequent query to exclude data you have already seen." -
+    #     see sort_by field at
+    #     https://developers.asana.com/reference/searchtasksforworkspace
+    #
+    # @param [Hash<Symbol, Object>] api_params
+    # @param [String] workspace_gid
+    # @param [String] url
+    # @param [Array<String>] extra_fields
+    # @param [Boolean] fetch_all Ensure all results are provided by manually paginating
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
+    def iterated_raw_task_search(api_params, workspace_gid:, extra_fields:)
+      # https://developers.asana.com/reference/searchtasksforworkspace
+      tasks = []
+      new_api_params = api_params.dup
+      original_sort_by = new_api_params.delete('sort_by')
+      # defaults to false
+      original_sort_ascending = new_api_params.delete('sort_ascending')
+      original_created_at_before = new_api_params.delete('created_at.before')
+      raise 'Teach me how to handle original_created_at_before' unless original_created_at_before.nil?
+
+      new_api_params['sort_by'] = 'created_at'
+
+      Kernel.loop do
+        # Get the most recently created results, then iterate on until we're out of results
+
+        # @type [Array<Asana::Resources::Task>]
+        task_batch = raw_task_search(new_api_params,
+                                     workspace_gid: workspace_gid, extra_fields: extra_fields + ['created_appt'],
+                                     fetch_all: false).to_a
+        oldest = task_batch.to_a.last
+
+        break if oldest.nil?
+
+        new_api_params['created_at.before'] = oldest.created_at
+
+        tasks.concat(task_batch.to_a)
+      end
+      unless original_sort_by.nil? || original_sort_by == 'created_at'
+        raise "Teach me how to handle original_sort_by: #{original_sort_by.inspect}"
+      end
+
+      raise 'Teach me how to handle original_sort_ascending' unless original_sort_ascending.nil?
+
+      tasks
+    end
+
     # @param [Array<String>] extra_fields
     # @return [Hash<Symbol, Object>]
     def calculate_api_options(extra_fields)

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.156.0
+  version: 0.158.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2023-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport