slk 0.7.0 → 0.9.0

data/lib/slk/services/deactivation_scanner.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Slk
+  module Services
+    # Slack has no "who left" endpoint. What it does have is users.list, which
+    # returns deactivated accounts with `deleted: true` and an `updated` epoch
+    # for the last change to the account — and for a deactivated account that
+    # change is nearly always the deactivation itself.
+    #
+    # The full roster is one API call per 1000 members, so the derived result
+    # (deactivated members plus headcounts, not the whole roster) is cached in
+    # the workspace meta cache with a TTL.
+    class DeactivationScanner
+      CACHE_KEY = 'deactivations_v1'
+      DEFAULT_TTL = 21_600 # 6 hours
+      REQUIRED_KEYS = %w[fetched_at member_count human_count active_count records].freeze
+
+      Report = Data.define(:records, :member_count, :human_count, :active_count, :fetched_at) do
+        def deactivated_count = records.size
+
+        def bots = records.count(&:bot)
+      end
+
+      def initialize(users_api:, workspace_name:, cache_store: nil, ttl: DEFAULT_TTL, on_debug: nil)
+        @users_api = users_api
+        @workspace_name = workspace_name
+        @cache = cache_store
+        @ttl = ttl
+        @on_debug = on_debug
+      end
+
+      # @return [Report] every deactivated account, newest deactivation first
+      def scan(refresh: false)
+        build_report(cached(refresh: refresh) || store(collect))
+      end
+
+      private
+
+      def cached(refresh:)
+        return nil if refresh
+
+        data = MetaCache.read(@cache, @workspace_name, CACHE_KEY, ttl: @ttl)
+        return data if usable?(data)
+
+        @on_debug&.call('deactivations cache is unusable; re-fetching the roster') if data
+        nil
+      end
+
+      # A truncated or older-shaped entry would otherwise be read field by
+      # field into a report of zero active members and zero departures — a
+      # confident, wrong answer. Missing anything required means refetch.
+      def usable?(data)
+        data.is_a?(Hash) && data['records'].is_a?(Array) && REQUIRED_KEYS.all? { |key| data[key] }
+      end
+
+      def store(data)
+        MetaCache.write(@cache, @workspace_name, CACHE_KEY, data)
+        data
+      end
+
+      def collect
+        members = fetch_members
+        deleted = members.select { |m| m['deleted'] }
+
+        counts(members).merge(
+          'fetched_at' => Time.now.to_i,
+          'records' => deleted.map { |m| Models::Deactivation.from_api(m).to_cache }
+        )
+      end
+
+      def counts(members)
+        humans = members.reject { |m| Models::Deactivation.bot?(m) }
+
+        {
+          'member_count' => members.size,
+          'human_count' => humans.size,
+          'active_count' => humans.count { |m| !m['deleted'] }
+        }
+      end
+
+      def fetch_members
+        @users_api.list_all do |total|
+          @on_debug&.call("users.list: #{total} members fetched")
+        end
+      end
+
+      def build_report(data)
+        Report.new(
+          records: sorted_records(data['records'] || []),
+          member_count: data['member_count'].to_i,
+          human_count: data['human_count'].to_i,
+          active_count: data['active_count'].to_i,
+          fetched_at: data['fetched_at']&.to_i
+        )
+      end
+
+      # Newest first; accounts with no usable timestamp sort to the bottom
+      # rather than pretending to be from 1970.
+      def sorted_records(raw)
+        raw.map { |hash| Models::Deactivation.from_cache(hash) }
+           .sort_by { |record| -(record.deactivated_at || 0) }
+      end
+    end
+  end
+end

data/lib/slk/version.rb

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

data/lib/slk.rb

@@ -67,11 +67,14 @@ module Slk
     autoload :Workspace, 'slk/models/workspace'
     autoload :Status, 'slk/models/status'
     autoload :ScheduledStatus, 'slk/models/scheduled_status'
+    autoload :DndState, 'slk/models/dnd_state'
+    autoload :StatusSnapshot, 'slk/models/status_snapshot'
     autoload :Message, 'slk/models/message'
     autoload :Reaction, 'slk/models/reaction'
     autoload :User, 'slk/models/user'
     autoload :Channel, 'slk/models/channel'
     autoload :Preset, 'slk/models/preset'
+    autoload :Deactivation, 'slk/models/deactivation'
     autoload :SearchResult, 'slk/models/search_result'
     autoload :SavedItem, 'slk/models/saved_item'
     autoload :Profile, 'slk/models/profile'
@@ -105,6 +108,7 @@ module Slk
     autoload :ProfileBuilder, 'slk/services/profile_builder'
     autoload :ProfileResolver, 'slk/services/profile_resolver'
     autoload :MetaCache, 'slk/services/meta_cache'
+    autoload :DeactivationScanner, 'slk/services/deactivation_scanner'
   end
 
   # Output formatters for messages, durations, and emoji
@@ -117,6 +121,7 @@ module Slk
     autoload :MessageFormatter, 'slk/formatters/message_formatter'
     autoload :ReactionFormatter, 'slk/formatters/reaction_formatter'
     autoload :JsonMessageFormatter, 'slk/formatters/json_message_formatter'
+    autoload :JsonStatusFormatter, 'slk/formatters/json_status_formatter'
     autoload :ActivityFormatter, 'slk/formatters/activity_formatter'
     autoload :AttachmentFormatter, 'slk/formatters/attachment_formatter'
     autoload :BlockFormatter, 'slk/formatters/block_formatter'
@@ -126,6 +131,7 @@ module Slk
     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'
   end
 
   # CLI commands implementing user-facing functionality
@@ -150,6 +156,7 @@ module Slk
     autoload :Debug, 'slk/commands/debug'
     autoload :Who, 'slk/commands/who'
     autoload :Org, 'slk/commands/org'
+    autoload :Deactivations, 'slk/commands/deactivations'
   end
 
   # Thin wrappers around Slack API endpoints

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slk
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Eric Boehs
@@ -45,6 +45,7 @@ files:
 - lib/slk/commands/cache.rb
 - lib/slk/commands/catchup.rb
 - lib/slk/commands/config.rb
+- lib/slk/commands/deactivations.rb
 - lib/slk/commands/debug.rb
 - lib/slk/commands/dnd.rb
 - lib/slk/commands/emoji.rb
@@ -64,9 +65,11 @@ files:
 - lib/slk/formatters/activity_formatter.rb
 - lib/slk/formatters/attachment_formatter.rb
 - lib/slk/formatters/block_formatter.rb
+- lib/slk/formatters/deactivation_formatter.rb
 - lib/slk/formatters/duration_formatter.rb
 - lib/slk/formatters/emoji_replacer.rb
 - lib/slk/formatters/json_message_formatter.rb
+- lib/slk/formatters/json_status_formatter.rb
 - lib/slk/formatters/markdown_output.rb
 - lib/slk/formatters/mention_replacer.rb
 - lib/slk/formatters/message_formatter.rb
@@ -79,6 +82,8 @@ files:
 - lib/slk/formatters/search_formatter.rb
 - lib/slk/formatters/text_processor.rb
 - lib/slk/models/channel.rb
+- lib/slk/models/deactivation.rb
+- lib/slk/models/dnd_state.rb
 - lib/slk/models/duration.rb
 - lib/slk/models/message.rb
 - lib/slk/models/preset.rb
@@ -89,6 +94,7 @@ files:
 - lib/slk/models/scheduled_status.rb
 - lib/slk/models/search_result.rb
 - lib/slk/models/status.rb
+- lib/slk/models/status_snapshot.rb
 - lib/slk/models/user.rb
 - lib/slk/models/workspace.rb
 - lib/slk/runner.rb
@@ -96,6 +102,7 @@ files:
 - lib/slk/services/api_client.rb
 - lib/slk/services/cache_store.rb
 - lib/slk/services/configuration.rb
+- lib/slk/services/deactivation_scanner.rb
 - lib/slk/services/emoji_downloader.rb
 - lib/slk/services/emoji_searcher.rb
 - lib/slk/services/encryption.rb
@@ -152,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.13
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A command-line interface for Slack
 test_files: []