slk 0.9.0 → 0.11.0

data/lib/slk/services/start_date_lookup.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Slk
+  module Services
+    # Start dates live in a workspace custom profile field, which `users.list`
+    # does not return — they cost one `users.profile.get` per person, and Slack
+    # rate-limits that endpoint hard enough that a screenful takes minutes
+    # rather than seconds.
+    #
+    # So every answer is cached, and cached the moment it arrives rather than
+    # at the end: interrupting a long lookup keeps the work already paid for.
+    # Accounts with no start date on file are cached too, otherwise every run
+    # would pay again to learn the same nothing.
+    #
+    # The cache holds for 30 days. A departed account's start date rarely
+    # changes, but an admin correcting a typo in one is exactly the case the
+    # expiry exists for; `slk cache clear` forces the issue sooner.
+    class StartDateLookup
+      CACHE_KEY = 'start_dates_v1'
+      TTL = 2_592_000 # 30 days
+
+      class MissingFieldError < Slk::Error; end
+
+      # Set when the cache could not be written. The lookup carries on — the
+      # cache is an optimisation, and the answers are worth more than it.
+      attr_reader :cache_error
+
+      def initialize(users_api:, field:, workspace_name:, cache_store: nil, on_progress: nil)
+        @users_api = users_api
+        @field = field
+        @workspace_name = workspace_name
+        @cache = cache_store
+        @on_progress = on_progress
+      end
+
+      # @return [Hash{String => String, nil}] user ID => ISO date, or nil for
+      #   an account with no start date recorded
+      def fetch(user_ids)
+        # Checked even for an empty list: "this workspace cannot do tenure" is
+        # the same fact whether or not anyone matched the filter, and finding
+        # out only when someone matches makes it look intermittent.
+        raise MissingFieldError, @field.missing_message if @field.id.to_s.empty?
+        return {} if user_ids.empty?
+
+        known = cached
+        user_ids.each_with_index { |id, index| resolve(known, id, index, user_ids.size) }
+        known.slice(*user_ids)
+      end
+
+      # How many of these would cost an API call, so a caller can warn about
+      # the wait before making someone sit through it.
+      def uncached_count(user_ids)
+        known = cached
+        user_ids.count { |id| !known.key?(id) }
+      end
+
+      private
+
+      def resolve(known, user_id, index, total)
+        return if known.key?(user_id)
+
+        @on_progress&.call(index + 1, total)
+        known[user_id] = start_date_for(user_id)
+        remember(known)
+      end
+
+      # A full or read-only disk must not throw away a lookup that cost
+      # minutes of rate-limited calls. MetaCache.write hands back the failure
+      # instead of raising; the caller reports it once at the end.
+      def remember(known)
+        failure = MetaCache.write(@cache, @workspace_name, CACHE_KEY, known)
+        # First failure only: the same unwritable disk will fail every row.
+        @cache_error = failure.message if failure && @cache_error.nil?
+      end
+
+      # Which account failed matters when the answer arrives twenty rows into
+      # a run that has already taken three minutes.
+      def start_date_for(user_id)
+        fields = @users_api.profile_for(user_id).dig('profile', 'fields')
+        value = fields.is_a?(Hash) ? fields.dig(@field.id, 'value') : nil
+        value.to_s.empty? ? nil : value
+      rescue ApiError => e
+        # Only the plain kind: re-wrapping a RateLimitError would drop its
+        # retry_after and the class the retry logic looks for.
+        raise unless e.instance_of?(ApiError)
+
+        raise ApiError.new("#{e.message} (looking up #{user_id})", code: e.code)
+      end
+
+      def cached
+        @cached ||= begin
+          data = MetaCache.read(@cache, @workspace_name, CACHE_KEY, ttl: TTL)
+          data.is_a?(Hash) ? data : {}
+        end
+      end
+    end
+  end
+end

data/lib/slk/support/check_in_time.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'date'
+require 'time'
+
+module Slk
+  module Support
+    # A stateless, exact timestamp for sent-conversation change detection.
+    class CheckInTime
+      RELATIVE = /\A(\d+)([mhd])\z/i
+      CLOCK = /\A(\d{1,2}):(\d{2})\z/
+      EPOCH = /\A\d{9,12}(?:\.\d{1,6})?\z/
+      ISO = /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2})?(?:Z|[+-]\d{2}:\d{2})?\z/
+
+      def self.parse(value, now: Time.now)
+        time = case value
+               when RELATIVE then relative(Regexp.last_match, now)
+               when CLOCK then clock(Regexp.last_match, now)
+               when EPOCH then epoch_time(value)
+               when ISO then iso_time(value)
+               else raise UsageError, 'Invalid --changed-since time. Use H:MM or HH:MM, ISO, epoch, 90m, 2h, or 1d.'
+               end
+        raise UsageError, '--changed-since must not be in the future.' if time > now
+
+        time
+      end
+
+      def self.timestamp(time)
+        format('%<seconds>d.%<micros>06d', seconds: time.to_i, micros: time.usec)
+      end
+
+      def self.epoch_time(value)
+        Time.at(BigDecimal(value).to_r)
+      rescue ArgumentError
+        raise UsageError, "Invalid --changed-since time: #{value.inspect}."
+      end
+
+      def self.iso_time(value)
+        Date.iso8601(value[0, 10])
+        with_seconds = value.sub(/(T\d{2}:\d{2})(?=Z|[+-]\d{2}:\d{2}|\z)/, '\\1:00')
+        Time.iso8601(with_seconds)
+      rescue ArgumentError
+        raise UsageError, "Invalid --changed-since time: #{value.inspect}."
+      end
+
+      def self.relative(match, now)
+        amount = match[1].to_i
+        raise UsageError, '--changed-since duration must be positive.' if amount.zero?
+
+        seconds = { 'm' => 60, 'h' => 3600, 'd' => 86_400 }.fetch(match[2].downcase)
+        now - (amount * seconds)
+      end
+
+      def self.clock(match, now)
+        hour, minute = match.captures.map(&:to_i)
+        raise UsageError, 'Invalid --changed-since clock time.' unless hour < 24 && minute < 60
+
+        day = now.to_date
+        time = local_clock(day, hour, minute)
+        return time if time <= now
+
+        local_clock(day - 1, hour, minute)
+      end
+
+      def self.local_clock(day, hour, minute)
+        Time.local(day.year, day.month, day.day, hour, minute)
+      rescue ArgumentError
+        raise UsageError, 'Invalid --changed-since clock time.'
+      end
+    end
+  end
+end

data/lib/slk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slk
-  VERSION = '0.9.0'
+  VERSION = '0.11.0'
 end

data/lib/slk.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'fileutils'
 require 'optparse'
 require 'time'
+require 'date'
 require 'io/console'
 
 # Slack CLI - A command-line interface for Slack
@@ -75,6 +76,7 @@ module Slk
     autoload :Channel, 'slk/models/channel'
     autoload :Preset, 'slk/models/preset'
     autoload :Deactivation, 'slk/models/deactivation'
+    autoload :Tenure, 'slk/models/tenure'
     autoload :SearchResult, 'slk/models/search_result'
     autoload :SavedItem, 'slk/models/saved_item'
     autoload :Profile, 'slk/models/profile'
@@ -109,6 +111,12 @@ module Slk
     autoload :ProfileResolver, 'slk/services/profile_resolver'
     autoload :MetaCache, 'slk/services/meta_cache'
     autoload :DeactivationScanner, 'slk/services/deactivation_scanner'
+    autoload :StartDateLookup, 'slk/services/start_date_lookup'
+    autoload :StartDateField, 'slk/services/start_date_field'
+    autoload :SearchPages, 'slk/services/search_pages'
+    autoload :SentConversations, 'slk/services/sent_conversations'
+    autoload :SentChanges, 'slk/services/sent_changes'
+    autoload :SentChannelLabel, 'slk/services/sent_channel_label'
   end
 
   # Output formatters for messages, durations, and emoji
@@ -126,12 +134,15 @@ module Slk
     autoload :AttachmentFormatter, 'slk/formatters/attachment_formatter'
     autoload :BlockFormatter, 'slk/formatters/block_formatter'
     autoload :SearchFormatter, 'slk/formatters/search_formatter'
+    autoload :SentFormatter, 'slk/formatters/sent_formatter'
     autoload :SavedItemFormatter, 'slk/formatters/saved_item_formatter'
     autoload :TextProcessor, 'slk/formatters/text_processor'
     autoload :ProfileFormatter, 'slk/formatters/profile_formatter'
     autoload :ProfileFieldRenderer, 'slk/formatters/profile_field_renderer'
     autoload :ProfileRows, 'slk/formatters/profile_rows'
     autoload :DeactivationFormatter, 'slk/formatters/deactivation_formatter'
+    autoload :DeactivationCsv, 'slk/formatters/deactivation_csv'
+    autoload :CsvWriter, 'slk/formatters/csv_writer'
   end
 
   # CLI commands implementing user-facing functionality
@@ -146,6 +157,7 @@ module Slk
     autoload :Catchup, 'slk/commands/catchup'
     autoload :Activity, 'slk/commands/activity'
     autoload :Search, 'slk/commands/search'
+    autoload :Sent, 'slk/commands/sent'
     autoload :Preset, 'slk/commands/preset'
     autoload :Workspaces, 'slk/commands/workspaces'
     autoload :Cache, 'slk/commands/cache'
@@ -187,6 +199,7 @@ module Slk
     autoload :TextWrapper, 'slk/support/text_wrapper'
     autoload :InteractivePrompt, 'slk/support/interactive_prompt'
     autoload :DateParser, 'slk/support/date_parser'
+    autoload :CheckInTime, 'slk/support/check_in_time'
     autoload :TimeParser, 'slk/support/time_parser'
     autoload :TimeRangeParser, 'slk/support/time_range_parser'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slk
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Eric Boehs
@@ -56,6 +56,7 @@ files:
 - lib/slk/commands/presence.rb
 - lib/slk/commands/preset.rb
 - lib/slk/commands/search.rb
+- lib/slk/commands/sent.rb
 - lib/slk/commands/ssh_key_manager.rb
 - lib/slk/commands/status.rb
 - lib/slk/commands/thread.rb
@@ -65,6 +66,8 @@ files:
 - lib/slk/formatters/activity_formatter.rb
 - lib/slk/formatters/attachment_formatter.rb
 - lib/slk/formatters/block_formatter.rb
+- lib/slk/formatters/csv_writer.rb
+- lib/slk/formatters/deactivation_csv.rb
 - lib/slk/formatters/deactivation_formatter.rb
 - lib/slk/formatters/duration_formatter.rb
 - lib/slk/formatters/emoji_replacer.rb
@@ -80,6 +83,7 @@ files:
 - lib/slk/formatters/reaction_formatter.rb
 - lib/slk/formatters/saved_item_formatter.rb
 - lib/slk/formatters/search_formatter.rb
+- lib/slk/formatters/sent_formatter.rb
 - lib/slk/formatters/text_processor.rb
 - lib/slk/models/channel.rb
 - lib/slk/models/deactivation.rb
@@ -95,6 +99,7 @@ files:
 - lib/slk/models/search_result.rb
 - lib/slk/models/status.rb
 - lib/slk/models/status_snapshot.rb
+- lib/slk/models/tenure.rb
 - lib/slk/models/user.rb
 - lib/slk/models/workspace.rb
 - lib/slk/runner.rb
@@ -114,7 +119,13 @@ files:
 - lib/slk/services/profile_builder.rb
 - lib/slk/services/profile_resolver.rb
 - lib/slk/services/reaction_enricher.rb
+- lib/slk/services/search_pages.rb
+- lib/slk/services/sent_changes.rb
+- lib/slk/services/sent_channel_label.rb
+- lib/slk/services/sent_conversations.rb
 - lib/slk/services/setup_wizard.rb
+- lib/slk/services/start_date_field.rb
+- lib/slk/services/start_date_lookup.rb
 - lib/slk/services/target_resolver.rb
 - lib/slk/services/token_loader.rb
 - lib/slk/services/token_saver.rb
@@ -124,6 +135,7 @@ files:
 - lib/slk/services/user_matcher.rb
 - lib/slk/services/user_picker.rb
 - lib/slk/services/who_target_resolver.rb
+- lib/slk/support/check_in_time.rb
 - lib/slk/support/date_parser.rb
 - lib/slk/support/error_logger.rb
 - lib/slk/support/help_formatter.rb
@@ -159,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A command-line interface for Slack
 test_files: []