checkoff 0.44.2 → 0.44.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d924c906eed129ad1c57bdbfdd8cdcc61b572e296a09721195b7c1a10d78dbe5
-  data.tar.gz: 79e71aac6289b18a448288a601c62a02cee6583bcbbc966e64a71003c8e73e89
+  metadata.gz: 37638fcbc55eff5ef89c7335ba3841e39376d9055c7995ecbf5e17446f3f641e
+  data.tar.gz: 97e451ca7abae2f8cc5a6f70af6fa9779131c69361452b87ace3c631e0a6d8aa
 SHA512:
-  metadata.gz: 8bc265211c02ebf11e7c7f35ce79aae7517c6b86cf023c8d0b41713a24df2365954f9757bfe9b44a85573187af7fb355f84e7d6b1bad9e8b32fc9b8b9ed6891d
-  data.tar.gz: 5de92894cb1f12d633667b87f426f4460d63a54d84cb1a9f2e8e38c529c45d41efdd9097cb9a2dd6f73691669a4a070ba87aedc55a5d8ec7780fa9cec5e2d13a
+  metadata.gz: 2fbdeb108ae04b165077972937931f3889c1e4b72c647cedb45ac176de303d80ce47bb08fe4d0b50b2433fc522db9ebec5ca703b5e27cc7e1f52b38721af1e45
+  data.tar.gz: fa3f9c267cb2d750ef04382023ab691114239d6b359379ac1951ecfc31e9cb9750fff03211bb53a82e3f2c8ab6a5f160a23e7c92e5fc6c3c02426e02a8fcd288

data/Gemfile.lock

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

data/config/definitions.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 #
+# rubocop:disable Layout/LineLength
 # @!parse
 #   class Time
 #     class << self
@@ -16,7 +17,12 @@
 #       def workspaces; end
 #       # @return [Asana::ProxiedResourceClasses::Section]
 #       def sections; end
+#       # @return [Asana::ProxiedResourceClasses::Project]
+#       def projects; end
+#       # @return [Asana::ProxiedResourceClasses::UserTaskList]
+#       def user_task_lists; end
 #     end
+#     class Collection < Asana::Resources::Collection; end
 #     module Resources
 #       class Task
 #         # @return [String, nil]
@@ -45,9 +51,45 @@
 #         # @param options [Hash] the request I/O options.
 #         # @return [Asana::Resources::Task]
 #         def find_by_id(id, options: {}); end
+#         # Returns the compact task records for some filtered set of tasks. Use one
+#         # or more of the parameters provided to filter the tasks returned. You must
+#         # specify a `project`, `section`, `tag`, or `user_task_list` if you do not
+#         # specify `assignee` and `workspace`.
+#         #
+#         # @param assignee [String] The assignee to filter tasks on.
+#         # @param workspace [String] The workspace or organization to filter tasks on.
+#         # @param project [String] The project to filter tasks on.
+#         # @param section [Gid] The section to filter tasks on.
+#         # @param tag [Gid] The tag to filter tasks on.
+#         # @param user_task_list [Gid] The user task list to filter tasks on.
+#         # @param completed_since [String] Only return tasks that are either incomplete or that have been
+#         # completed since this time.
+#         #
+#         # @param modified_since [String] Only return tasks that have been modified since the given time.
+#         #
+#         # @param per_page [Integer] the number of records to fetch per page.
+#         # @param options [Hash] the request I/O options.
+#         # Notes:
+#         #
+#         # If you specify `assignee`, you must also specify the `workspace` to filter on.
+#         #
+#         # If you specify `workspace`, you must also specify the `assignee` to filter on.
+#         #
+#         # Currently, this is only supported in board views.
+#         #
+#         # A task is considered "modified" if any of its properties change,
+#         # or associations between it and other objects are modified (e.g.
+#         # a task being added to a project). A task is not considered modified
+#         # just because another object it is associated with (e.g. a subtask)
+#         # is modified. Actions that count as modifying the task include
+#         # assigning, renaming, completing, and adding stories.
+#         # @return [Asana::Collection<Asana::Resources::Task>]
+#         def find_all(assignee: nil, workspace: nil, project: nil, section: nil,
+#                      tag: nil, user_task_list: nil, completed_since: nil,
+#                      modified_since: nil, per_page: 20, options: {}); end
 #         # @param section [Asana::Resources::section]
 #         # @param options [Hash] the request I/O options.
-#         # @return [Array<Asana::Resources::Task>]
+#         # @return [Enumerable<Asana::Resources::Task>]
 #         def get_tasks(assignee: nil,
 #                       project: nil,
 #                       section: nil,
@@ -58,13 +100,43 @@
 #                       options: {}); end
 #       end
 #       class Workspace
-#         # @return [Array<Asana::Resources::Workspace>]
+#         # @return [Enumerable<Asana::Resources::Workspace>]
 #         def find_all; end
 #       end
 #       class Section
 #         # @param project_gid [String]
-#         # @return [Array<Asana::Resources::Section>]
+#         # @return [Enumerable<Asana::Resources::Section>]
 #         def get_sections_for_project(client, project_gid:, options: {}); end
 #       end
+#       class Project
+#         # Returns the compact project records for all projects in the workspace.
+#         #
+#         # @param workspace [Strin] The workspace or organization to find projects in.
+#         # @param is_template [Boolean] **Note: This parameter can only be included if a team is also defined, or the workspace is not an organization**
+#         # Filters results to include only template projects.
+#         #
+#         # @param archived [Boolean] Only return projects whose `archived` field takes on the value of
+#         # this parameter.
+#         #
+#         # @param per_page [Integer] the number of records to fetch per page.
+#         # @param options [Hash] the request I/O options.
+#         # @return [Asana::Collection<Asana::Resources::Project>]
+#         def find_by_workspace(client, workspace: required("workspace"), is_template: nil, archived: nil, per_page: 20, options: {}); end
+#         # Returns the complete project record for a single project.
+#         #
+#         # @param id [String] The project to get.
+#         # @param options [Hash] the request I/O options.
+#         # @return [Asana::Resources::Project]
+#         def find_by_id(id, options: {}); end
+#       end
+#       class UserTaskList
+#         # @param user_gid [String]  (required) A string identifying a user. This can either be the string \"me\", an email, or the gid of a user.
+#         # @param workspace [String]  (required) The workspace in which to get the user task list.
+#         # @param options [Hash] the request I/O options
+#         # @return [Asana::Resources::UserTaskList]
+#         def get_user_task_list_for_user(client, user_gid:,
+#             workspace: nil, options: {}); end
+#       end
 #     end
 #   end
+# rubocop:enable Layout/LineLength

data/lib/checkoff/projects.rb

@@ -17,19 +17,18 @@ module Checkoff
   # Work with projects in Asana
   class Projects
     MINUTE = 60
-    # @sg-ignore
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
-    # @sg-ignore
     REALLY_LONG_CACHE_TIME = HOUR * 1
-    # @sg-ignore
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
     # @!parse
     #   extend CacheMethod::ClassMethods
 
+    # @param config [Hash<Symbol, Object>]
     # @param client [Asana::Client]
+    # @param workspaces [Checkoff::Workspaces]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    workspaces: Checkoff::Workspaces.new(config: config,
@@ -59,8 +58,9 @@ module Checkoff
       if project_name.is_a?(Symbol) && project_name.to_s.start_with?('my_tasks')
         my_tasks(workspace_name)
       else
-        projects = projects_by_workspace_name(workspace_name)
-        projects.find do |project|
+        # @type [Asana::Collection<Asana::Resources::Project>]
+        ps = projects_by_workspace_name(workspace_name)
+        ps.find do |project|
           project.name == project_name
         end
       end
@@ -79,18 +79,17 @@ module Checkoff
     cache_method :project_or_raise, LONG_CACHE_TIME
 
     # find uncompleted tasks in a list
-    # @param [Array<Asana::Resources::Task>] tasks
-    # @return [Array<Asana::Resources::Task>]
+    # @param [Enumerable<Asana::Resources::Task>] tasks
+    # @return [Enumerable<Asana::Resources::Task>]
     def active_tasks(tasks)
       tasks.select { |task| task.completed_at.nil? }
     end
 
     # pull task objects from a named project
-    # @sg-ignore
     # @param [Asana::Resources::Project] project
     # @param [Boolean] only_uncompleted
     # @param [Array<String>] extra_fields
-    # @return [Array<Asana::Resources::Task>]
+    # @return [Enumerable<Asana::Resources::Task>]
     def tasks_from_project(project, only_uncompleted: true, extra_fields: [])
       options = task_options
       options[:completed_since] = '9999-12-01' if only_uncompleted
@@ -102,31 +101,30 @@ module Checkoff
 
     private
 
+    # @return [Asana::Client]
     attr_reader :client
 
-    # @sg-ignore
+    # @return [Asana::ProxiedResourceClasses::Project]
     def projects
       client.projects
     end
     cache_method :projects, LONG_CACHE_TIME
 
-    # @sg-ignore
     # @param [String] workspace_name
-    # @return [Array<Asana::Resources::Project>]
+    # @return [Asana::Collection<Asana::Resources::Project>]
     def projects_by_workspace_name(workspace_name)
       workspace = @workspaces.workspace_or_raise(workspace_name)
       raise "Could not find workspace named #{workspace_name}" unless workspace
 
-      projects.find_by_workspace(workspace: workspace.gid)
+      projects.find_by_workspace(workspace: workspace.gid, per_page: 100)
     end
+    cache_method :projects_by_workspace_name, LONG_CACHE_TIME
 
-    # @sg-ignore
     # @param [String] workspace_name
     # @return [Asana::Resources::Project]
     def my_tasks(workspace_name)
       workspace = @workspaces.workspace_or_raise(workspace_name)
       # @sg-ignore
-      # @type [Asana::Resources::UserTaskList]
       result = client.user_task_lists.get_user_task_list_for_user(user_gid: 'me',
                                                                   workspace: workspace.gid)
       gid = result.gid

data/lib/checkoff/sections.rb

@@ -53,19 +53,20 @@ module Checkoff
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
     #
-    # @return [Array<Asana::Resources::Section>]
+    # @return [Enumerable<Asana::Resources::Section>]
     def sections_or_raise(workspace_name, project_name)
       project = project_or_raise(workspace_name, project_name)
       # @sg-ignore
       client.sections.get_sections_for_project(project_gid: project.gid)
     end
+    cache_method :sections_or_raise, SHORT_CACHE_TIME
 
     # Given a workspace name and project name, then provide a Hash of
     # tasks with section name -> task list of the uncompleted tasks
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
     # @param extra_fields [Array<String>]
-    # @return [Hash{[String, nil] => Array<Asana::Resources::Task>}]
+    # @return [Hash{[String, nil] => Enumerable<Asana::Resources::Task>}]
     def tasks_by_section(workspace_name, project_name, extra_fields: [])
       raise ArgumentError, 'Provided nil workspace name' if workspace_name.nil?
       raise ArgumentError, 'Provided nil project name' if project_name.nil?
@@ -88,7 +89,7 @@ module Checkoff
     # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
     #
-    # @return [Array<Asana::Resources::Task>]
+    # @return [Enumerable<Asana::Resources::Task>]
     def tasks(workspace_name, project_name, section_name,
               only_uncompleted: true,
               extra_fields: [])
@@ -140,7 +141,7 @@ module Checkoff
     # tasks with section name -> task list of the uncompleted tasks
     # @param project [Asana::Resources::Project]
     # @param extra_fields [Array<String>]
-    # @return [Hash<[String,nil], Array<Asana::Resources::Task>>]
+    # @return [Hash<[String,nil], Enumerable<Asana::Resources::Task>>]
     def tasks_by_section_for_project(project, extra_fields: [])
       raw_tasks = projects.tasks_from_project(project, extra_fields: extra_fields)
       active_tasks = projects.active_tasks(raw_tasks)
@@ -150,16 +151,16 @@ module Checkoff
     # @param name [String]
     # @return [String, nil]
     def section_key(name)
-      inbox_section_names = ['(no section)', 'Untitled section', 'Inbox']
+      inbox_section_names = ['(no section)', 'Untitled section', 'Inbox', 'Recently assigned']
       return nil if inbox_section_names.include?(name)
 
       name
     end
 
     # Given a list of tasks, pull a Hash of tasks with section name -> task list
-    # @param tasks [Array<Asana::Resources::Task>]
+    # @param tasks [Enumerable<Asana::Resources::Task>]
     # @param project_gid [String]
-    # @return [Hash<[String,nil], Array<Asana::Resources::Task>>]
+    # @return [Hash<[String,nil], Enumerable<Asana::Resources::Task>>]
     def by_section(tasks, project_gid)
       by_section = {}
       # @sg-ignore
@@ -170,7 +171,7 @@ module Checkoff
     end
     cache_method :by_section, LONG_CACHE_TIME
 
-    # @param by_section [Hash{[String, nil] => Array<Asana::Resources::Task>}]
+    # @param by_section [Hash{[String, nil] => Enumerable<Asana::Resources::Task>}]
     # @param task [Asana::Resources::Task]
     # @param project_gid [String]
     # @return [void]

data/lib/checkoff/subtasks.rb

@@ -27,8 +27,8 @@ module Checkoff
     end
 
     # pulls a Hash of subtasks broken out by section
-    # @param tasks [Array<Asana::Resources::Task>]
-    # @return [Hash<[nil,String], Array<Asana::Resources::Task>>]
+    # @param tasks [Enumerable<Asana::Resources::Task>]
+    # @return [Hash<[nil,String], Enumerable<Asana::Resources::Task>>]
     def by_section(tasks)
       current_section = nil
       by_section = { nil => [] }

data/lib/checkoff/tags.rb

@@ -30,7 +30,7 @@ module Checkoff
       @client = client
     end
 
-    # @return [Array<Asana::Resources::Task>]
+    # @return [Enumerable<Asana::Resources::Task>]
     def tasks(workspace_name, tag_name,
               only_uncompleted: true,
               extra_fields: [])

data/lib/checkoff/task_searches.rb

@@ -57,7 +57,7 @@ module Checkoff
     # @param [String] workspace_name
     # @param [String] url
     # @param [Array<String>] extra_fields
-    # @return [Array<Asana::Resources::Task>]
+    # @return [Enumerable<Asana::Resources::Task>]
     def task_search(workspace_name, url, extra_fields: [])
       workspace = workspaces.workspace_or_raise(workspace_name)
       # @sg-ignore

data/lib/checkoff/tasks.rb

@@ -109,7 +109,7 @@ module Checkoff
     # @param section_name [String, nil, :unspecified]
     # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
-    # @return [Array<Asana::Resources::Task>]
+    # @return [Enumerable<Asana::Resources::Task>]
     def tasks_from_section(workspace_name, project_name,
                            section_name:,
                            only_uncompleted:,
@@ -160,7 +160,7 @@ module Checkoff
       # https://github.com/Asana/ruby-asana/issues/125
 
       # @sg-ignore
-      # @type [Array<Asana::Resources::Task>, nil]
+      # @type [Enumerable<Asana::Resources::Task>, nil]
       dependencies = task.instance_variable_get(:@dependencies)
       dependencies = task.dependencies.map { |task| { 'gid' => task.gid } } if dependencies.nil?
 

data/lib/checkoff/version.rb

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

data/lib/checkoff/workspaces.rb

@@ -41,6 +41,7 @@ module Checkoff
         workspace.name == workspace_name
       end
     end
+    cache_method :workspace, LONG_CACHE_TIME
 
     # @return [Asana::Resources::Workspace]
     def default_workspace

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.44.2
+  version: 0.44.4
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport