checkoff 0.138.0 → 0.145.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725b9dacf6d77fcbf82da1f222e121a18c9ea9a689fa77f3013a8875b9229c23
-  data.tar.gz: e42423592c5aa8e34f27d1e616e1b6ccf60b5f5575d46d1a1515df1a4ad72b7d
+  metadata.gz: 4c59aedc40fa2bbf1ad37259d1a19cc1e3677268e4d150690ea6f417f8deacc1
+  data.tar.gz: 19d9b9a77195016972c0b636549c8a808b2308885a100e264d73f1d4c65ec8b7
 SHA512:
-  metadata.gz: e1e5ac1ec0223672681d984c3ec081811bb651f0b3cb48bb557f8924968ad82d37cc6cadca5c67d5a19f531d9c1dbe1a960cac73f98a643e1063287955123596
-  data.tar.gz: d43024f89975c216f429b7c12f9ccde0d1bc87f13c2d48d25ff52d519bdb2b80515ea8aaa5750d0f43a526982e4404b77fe304e64c766de3d79c0f7e294d875c
+  metadata.gz: 005b9771d276e6f870e99210458c68a7002514b4304c79f5902aea8844a9a3bbead76119c8e109cdec1380883b92de517d7786914e5358154795c2c9375ee860
+  data.tar.gz: ec1d850413b2e0e9460adaa5860c3e093ef9ec99fc28819502c08d792639dbc351e7076f702552611db964390c4c247621ef08a8ca7efdd7a6e471c3d3a1b6c7

data/.rubocop.yml

@@ -1,4 +1,8 @@
 ---
+Gemspec/RequireMFA:
+  # We publish via CI/CD, so MFA is not possible.
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 

data/Gemfile.lock

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

data/checkoff.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'gli'
 
   spec.metadata = {
-    'rubygems_mfa_required' => 'true',
+    'rubygems_mfa_required' => 'false',
   }
 end

data/lib/checkoff/internal/search_url/date_param_converter.rb

@@ -51,6 +51,8 @@ module Checkoff
                   handle_between(prefix)
                 when 'within_last'
                   handle_within_last(prefix)
+                when 'within_next'
+                  handle_within_next(prefix)
                 else
                   raise "Teach me how to handle date mode: #{operator.inspect}."
                 end
@@ -115,6 +117,20 @@ module Checkoff
           [{ "#{API_PREFIX.fetch(prefix)}.after" => after.to_s }, []]
         end
 
+        # @param prefix [String]
+        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)] See https://developers.asana.com/docs/search-tasks-in-a-workspace
+        def handle_within_next(prefix)
+          value = get_single_param("#{prefix}.value").to_i
+
+          validate_unit_is_day!(prefix)
+
+          # @sg-ignore
+          # @type [Date]
+          before = Date.today + value + 1
+
+          [{ "#{API_PREFIX.fetch(prefix)}.before" => before.to_s }, []]
+        end
+
         # @param param_key [String]
         # @return [String]
         def get_single_param(param_key)

data/lib/checkoff/projects.rb

@@ -65,7 +65,7 @@ module Checkoff
 
     # pulls an Asana API project class given a name
     # @param [String] workspace_name
-    # @param [String] project_name
+    # @param [String,Symbol<:my_tasks>] project_name
     # @param [Array<String>] extra_fields
     #
     # @return [Asana::Resources::Project, nil]
@@ -83,7 +83,7 @@ module Checkoff
     cache_method :project, LONG_CACHE_TIME
 
     # @param workspace_name [String]
-    # @param project_name [String]
+    # @param project_name [String,Symbol<:my_tasks>]
     # @param [Array<String>] extra_fields
     #
     # @return [Asana::Resources::Project]

data/lib/checkoff/sections.rb

@@ -147,13 +147,16 @@ module Checkoff
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil]
+    # @param extra_section_fields [Array<String>]
     #
     # @sg-ignore
     # @return [Asana::Resources::Section]
-    def section_or_raise(workspace_name, project_name, section_name)
-      s = section(workspace_name, project_name, section_name)
+    def section_or_raise(workspace_name, project_name, section_name, extra_section_fields: [])
+      s = section(workspace_name, project_name, section_name,
+                  extra_section_fields: extra_section_fields)
       if s.nil?
-        valid_sections = sections_or_raise(workspace_name, project_name).map(&:name)
+        valid_sections = sections_or_raise(workspace_name, project_name,
+                                           extra_fields: extra_section_fields).map(&:name)
 
         raise "Could not find section #{section_name.inspect} under project #{project_name.inspect} " \
               "under workspace #{workspace_name.inspect}.  Valid sections: #{valid_sections.inspect}"
@@ -279,9 +282,12 @@ module Checkoff
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil]
+    # @param extra_section_fields [Array<String>]
+    #
     # @return [Asana::Resources::Section, nil]
-    def section(workspace_name, project_name, section_name)
-      sections = sections_or_raise(workspace_name, project_name)
+    def section(workspace_name, project_name, section_name, extra_section_fields: [])
+      sections = sections_or_raise(workspace_name, project_name,
+                                   extra_fields: extra_section_fields)
       sections.find { |section| section_key(section.name)&.chomp(':') == section_name&.chomp(':') }
     end
   end

data/lib/checkoff/task_searches.rb

@@ -13,6 +13,7 @@ require 'asana/resource_includes/collection'
 require 'asana/resource_includes/response_helper'
 
 require 'checkoff/internal/search_url'
+require 'checkoff/internal/logging'
 
 # https://developers.asana.com/reference/searchtasksforworkspace
 module Checkoff
@@ -25,6 +26,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
+    include Logging
     include Asana::Resources::ResponseHelper
 
     # @!parse
@@ -70,6 +72,7 @@ module Checkoff
       workspace = workspaces.workspace_or_raise(workspace_name)
       # @sg-ignore
       api_params, task_selector = @search_url_parser.convert_params(url)
+      debug { "Task search params: api_params=#{api_params}, task_selector=#{task_selector}" }
       raw_task_search(api_params, workspace_gid: workspace.gid, task_selector: task_selector,
                                   extra_fields: extra_fields)
     end
@@ -95,9 +98,23 @@ module Checkoff
                                                                      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'
+      end
+
+      debug { "#{tasks.length} raw tasks returned" }
+
       tasks.select { |task| task_selectors.filter_via_task_selector(task, task_selector) }
     end
 
+    # @return [Hash]
+    def as_cache_key
+      {}
+    end
+
     private
 
     # @param [Array<String>] 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.138.0'
+  VERSION = '0.145.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.138.0
+  version: 0.145.0
 platform: ruby
 authors:
 - Vince Broz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-26 00:00:00.000000000 Z
+date: 2023-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - vince@broz.cc
 executables:
@@ -214,8 +214,8 @@ homepage: https://github.com/apiology/checkoff
 licenses:
 - MIT license
 metadata:
-  rubygems_mfa_required: 'true'
-post_install_message: 
+  rubygems_mfa_required: 'false'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Command-line and gem client for Asana (unofficial)
 test_files: []