checkoff 0.132.0 → 0.134.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a15de58445eeb2a8825341add1da6ab709ddd7f588e6d7dd7677e225143c9be
-  data.tar.gz: d1a927d6e93ab96e0057be99046ed237858b12b74ce858cdd7c76b6596a0108d
+  metadata.gz: 774ff63fdebd9187b4aedf1cad2ee5ba52c4d7f5d582747b0414e698c6c31d9d
+  data.tar.gz: de61ee88dc1e575702bbe15df6fcd0e70738a3b0f5ffb10654633260831c9923
 SHA512:
-  metadata.gz: 51ca950b44ff215eebf8cd7756b2a527952de5aba760f7e9bec5df6ba5d255cded0b67b00cac2add5b2f08a87955543b7ef9c9b83a0f7718d2e69599d85a9d4b
-  data.tar.gz: b75ec0c19e1464bff3373f6e87bab3da5f5d867e514db516b461590b1a4aa4f7a7a8b4d786fb140cb4e9fe1c800569070854cdbda75956bb0b212aaae6401f24
+  metadata.gz: 767386a4cb59daf9085a545e1e6bb8b76d01ac374785c2c574a285142b0531ebf1c3c7f930b3d104262452bdb1975b8158a2906d157cc88b46bce0852fd357e9
+  data.tar.gz: c3f95457b476ff66133dba010920db1feee0f27f98fa35ed92246b677dde95f17fd8347b91de6aa63f2777c2dcebef061a8d5aefaf85638e4c321009b68185d6

data/.circleci/config.yml

@@ -119,6 +119,8 @@ jobs:
       - run_with_languages:
           label: Make RubyGems release
           command: |
+            set -x
+
             # Coax overcommit into working
             git config --global user.email "test@test.test"
             git config --global user.name "Test Test"
@@ -127,6 +129,7 @@ jobs:
 
             git status
             bundle exec bump --commit-message ' [skip ci]' --tag --tag-prefix=v minor
+            bundle install
             # bundle exec needed for overcommit hooks
             #
             # if this step fails, check that

data/Gemfile

@@ -11,7 +11,7 @@ gem 'fakeweb'
 gem 'mdl'
 gem 'minitest-profile'
 gem 'minitest-reporters'
-gem 'mocha', ['~> 2.0.0.alpha.1']
+gem 'mocha', ['>= 2']
 # 0.58.0 and 0.57.0 don't seem super compatible with signatures, and
 # magit doesn't seem to want to use the bundled version at the moment,
 # so let's favor the more recent version...

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.132.0)
+    checkoff (0.134.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -22,7 +22,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    activesupport (7.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -37,7 +37,7 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     backport (1.2.0)
-    base64 (0.1.1)
+    base64 (0.2.0)
     benchmark (0.2.1)
     bigdecimal (3.1.4)
     builder (3.2.4)
@@ -56,7 +56,7 @@ GEM
     dalli (3.2.6)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    drb (2.1.1)
+    drb (2.2.0)
       ruby2_keywords
     e2mmap (0.1.0)
     fakeweb (1.3.0)
@@ -104,7 +104,7 @@ GEM
       mixlib-shellout
     method_source (1.0.0)
     mini_portile2 (2.8.2)
-    minitest (5.18.0)
+    minitest (5.20.0)
     minitest-profile (0.0.2)
     minitest-reporters (1.5.0)
       ansi
@@ -116,11 +116,12 @@ GEM
       tomlrb
     mixlib-shellout (3.2.7)
       chef-utils
-    mocha (2.0.0.alpha.1)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    mutex_m (0.1.2)
+    mutex_m (0.2.0)
     nokogiri (1.15.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
@@ -232,7 +233,7 @@ DEPENDENCIES
   mdl
   minitest-profile
   minitest-reporters
-  mocha (~> 2.0.0.alpha.1)
+  mocha (>= 2)
   overcommit (>= 0.60.0, < 0.61.0)
   pry
   punchlist

data/lib/checkoff/events.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'internal/asana_event_filter'
+require_relative 'workspaces'
+require_relative 'clients'
+
+# https://developers.asana.com/reference/events
+
+module Checkoff
+  # Methods related to the Asana events / webhooks APIs
+  class Events
+    # @!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 clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    # @param asana_event_filter_class [Class<Checkoff::Internal::AsanaEventFilter>]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client,
+                   asana_event_filter_class: Checkoff::Internal::AsanaEventFilter)
+      @workspaces = workspaces
+      @client = client
+      @asana_event_filter_class = asana_event_filter_class
+    end
+
+    # @param filters [Array<Hash>, nil] The filters to match against
+    # @param asana_events [Array<Hash>] The events that Asana sent
+    #
+    # @return [Array<Hash>] The events that should be acted on
+    def filter_asana_events(filters, asana_events)
+      asana_event_filter = @asana_event_filter_class.new(filters: filters)
+      asana_events.select { |event| asana_event_filter.matches?(event) }
+    end
+
+    private
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./events.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]
+        # event_name = ARGV[1] || raise('Please pass event name as second argument')
+        # events = Checkoff::Events.new
+        # event = events.event_or_raise(workspace_name, event_name)
+        # puts "Results: #{event}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::Events.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/internal/asana_event_filter.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative 'logging'
+
+module Checkoff
+  module Internal
+    # Uses an enhanced version of Asana event filter configuration
+    #
+    # See https://developers.asana.com/reference/createwebhook | body
+    # params | data | filters for a general description of the scheme.
+    #
+    # Additional supported filter keys:
+    #
+    # * 'checkoff:parent.gid' - requires that the 'gid' key in the 'parent' object
+    #   match the given value
+    class AsanaEventFilter
+      include Logging
+
+      # @param filters [Array<Hash>, nil] The filters to match against
+      def initialize(filters:)
+        @filters = filters
+      end
+
+      # @param asana_event [Hash] The event that Asana sent
+      def matches?(asana_event)
+        logger.debug { "Filtering using #{@filters.inspect}" }
+        return true if @filters.nil?
+
+        @filters.any? do |filter|
+          out = filter_matches_asana_event?(filter, asana_event)
+          logger.debug { "Filter #{filter.inspect} matched? #{out} against event #{asana_event.inspect}" }
+          out
+        end
+      end
+
+      private
+
+      # @param filter [Hash]
+      # @param asana_event [Hash]
+      #
+      # @sg-ignore
+      # @return [Boolean]
+      def filter_matches_asana_event?(filter, asana_event)
+        # @param key [String]
+        # @param value [String, Array<String>]
+        filter.all? do |key, value|
+          asana_event_matches_filter_item?(key, value, asana_event)
+        end
+      end
+
+      # @param key [String]
+      # @param value [String, Array<String>]
+      # @param asana_event [Hash]
+      #
+      # @sg-ignore
+      # @return [Boolean]
+      def asana_event_matches_filter_item?(key, value, asana_event)
+        case key
+        when 'resource_type'
+          asana_event.fetch('resource', {})['resource_type'] == value
+        when 'resource_subtype'
+          asana_event.fetch('resource', {})['resource_subtype'] == value
+        when 'action'
+          asana_event['action'] == value
+        when 'fields'
+          value.include? asana_event.fetch('change', {})['field']
+        when 'checkoff:parent.gid'
+          asana_event.fetch('parent', {})['gid'] == value
+        else
+          raise "Unknown filter key #{key}"
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/internal/logging.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# include this to add ability to log at different levels
+module Logging
+  # @return [::Logger]
+  def logger
+    # @sg-ignore
+    @logger ||= if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+                  # @sg-ignore
+                  Rails.logger
+                else
+                  ::Logger.new($stdout, level: log_level)
+                end
+  end
+
+  # @param message [String,nil]
+  #
+  # @return [void]
+  def error(message = nil, &block)
+    logger.error(message, &block)
+  end
+
+  # @param message [String,nil]
+  #
+  # @return [void]
+  def warn(message = nil, &block)
+    logger.warn(message, &block)
+  end
+
+  # @param message [String,nil]
+  #
+  # @return [void]
+  def info(message = nil, &block)
+    logger.info(message, &block)
+  end
+
+  # @param message [String,nil]
+  #
+  # @return [void]
+  def debug(message = nil, &block)
+    logger.debug(message, &block)
+  end
+
+  # @param message [String,nil]
+  #
+  # @return [void]
+  def finer(message = nil, &block)
+    # No such level by default
+    #
+    # logger.finer(message, &block)
+  end
+
+  private
+
+  # @sg-ignore
+  # @return [Symbol]
+  def log_level
+    # @sg-ignore
+    ENV.fetch('LOG_LEVEL', 'INFO').downcase.to_sym
+  end
+end

data/lib/checkoff/task_searches.rb

@@ -54,15 +54,41 @@ module Checkoff
       @asana_resources_collection_class = asana_resources_collection_class
     end
 
+    # Perform an equivalent search API to an Asana search URL in the
+    # web UI.  Not all URL parameters are supported; each one must be
+    # added here manually.  In addition, not all are supported in the
+    # Asana API in a compatible way, so they may result in more tasks
+    # being fetched than actually returned as filtering is done
+    # manually.
+    #
     # @param [String] workspace_name
     # @param [String] url
     # @param [Array<String>] extra_fields
+    #
     # @return [Enumerable<Asana::Resources::Task>]
     def task_search(workspace_name, url, extra_fields: [])
       workspace = workspaces.workspace_or_raise(workspace_name)
       # @sg-ignore
       api_params, task_selector = @search_url_parser.convert_params(url)
-      path = "/workspaces/#{workspace.gid}/tasks/search"
+      raw_task_search(api_params, workspace_gid: workspace.gid, task_selector: task_selector,
+                                  extra_fields: extra_fields)
+    end
+    cache_method :task_search, LONG_CACHE_TIME
+
+    # 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 [String] url
+    # @param [Array<String>] extra_fields
+    # @param [Array] task_selector
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
+    def raw_task_search(api_params, workspace_gid:, extra_fields: [], task_selector: [])
+      # @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,
@@ -71,7 +97,6 @@ module Checkoff
                                                     client: client)
       tasks.select { |task| task_selectors.filter_via_task_selector(task, task_selector) }
     end
-    cache_method :task_search, LONG_CACHE_TIME
 
     private
 

data/lib/checkoff/version.rb

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

data/lib/checkoff.rb

@@ -2,6 +2,7 @@
 
 require 'checkoff/version'
 require 'checkoff/clients'
+require 'checkoff/events'
 require 'checkoff/workspaces'
 require 'checkoff/portfolios'
 require 'checkoff/projects'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.132.0
+  version: 0.134.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -131,8 +131,11 @@ files:
 - lib/checkoff/clients.rb
 - lib/checkoff/create-entity.sh
 - lib/checkoff/custom_fields.rb
+- lib/checkoff/events.rb
+- lib/checkoff/internal/asana_event_filter.rb
 - lib/checkoff/internal/config_loader.rb
 - lib/checkoff/internal/create-class.sh
+- lib/checkoff/internal/logging.rb
 - lib/checkoff/internal/project_hashes.rb
 - lib/checkoff/internal/project_selector_evaluator.rb
 - lib/checkoff/internal/project_timing.rb