ratproto 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6ecf6b20c9235a6f792aedbe3d555e8387d788dbe1bb7e8ae65850a8de34b6
-  data.tar.gz: 9f6b2dd26064ae1bc1ed8e854c2f0fd1c193672556e99c3ec78df5eab9ba50e9
+  metadata.gz: a098c33a93bc8b33f32631f733fb3b5d3d1f3b233035d1cdbf8d397071a8d566
+  data.tar.gz: ae846bf49bca35fa4ee7fe748e8d0a05eeaf60a44f6cd687d7a0d66f61c4254f
 SHA512:
-  metadata.gz: 0e0326c6bba6787261b88668a0a5877f0a68eaff5146bdfd769a404271f050f200decf652546855cadd2f9f8040190f4d26ff65e867fcb1e1bacbd3148237db8
-  data.tar.gz: fee5cf28d9a8cf5a64dcf06fae08db2f467832c0ed56327010c31a3bb71c2e0159e2ec8cda2f14aa6df4848eba76751d67563d3f3a83e71f38a36cdac9c92c87
+  metadata.gz: 9abf0ae89949e3e20b9f89c6b0ed9d09275a4fe55b68104c0579f6c85b6f10b7901c0dc9c884c022b8f269cf28bcfe6e07e00db9519266ab4e00bc5fab5e8b35
+  data.tar.gz: 0dfd41610d6faf493475041b065b8e688bae795bdb14c85238945ec0498a80d9ea530e7ce9e1e8fe81d7938f106c9467d100859404925000a4e58927c60a480a

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.3.3] - 2026-08-17
+
+- `stream`: added `--print-time` mode, bug fixes, unified timestamp formats
+- added `status` command that prints account status
+
+## [0.3.2] - 2026-07-30
+
+- `stream`: filter by record operation type using `-o`
+- `stream`: disable all commit messages and leave account messages by passing `-c -`
+- `stream` & `stream-labels`: disable status messages using `-q`
+
 ## [0.3.1] - 2026-07-30
 
 - added polyfill of `Hash#except` for Ruby 2.6

data/lib/ratproto/cli.rb

@@ -5,6 +5,7 @@ require 'clamp'
 require_relative 'version'
 require_relative 'ext'
 require_relative 'commands/base'
+require_relative 'commands/account_status'
 require_relative 'commands/fetch'
 require_relative 'commands/resolve'
 require_relative 'commands/stream'
@@ -51,6 +52,7 @@ module RatProto
     end
 
     subcommand 'fetch', 'fetch a single record given its at:// URI', Commands::Fetch
+    subcommand 'status', 'print account status', Commands::AccountStatus
     subcommand 'stream', 'stream events from a relay or PDS firehose', Commands::Stream
     subcommand 'stream-labels', 'stream labels a labeller firehose', Commands::StreamLabels
     subcommand 'resolve', 'resolve a DID or @handle', Commands::Resolve

data/lib/ratproto/commands/account_status.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'didkit'
+
+require_relative 'base'
+
+module RatProto
+  module Commands
+    class AccountStatus < Base
+      banner 'Print status of an account on its PDS'
+
+      parameter 'TARGET', 'DID or handle'
+
+      option ['-s', '--status'], :flag, 'print only the status without a full message'
+
+      def execute
+        begin
+          resolved_did = DID.resolve_handle(target)
+        rescue StandardError => e
+          signal_error "resolving #{target.inspect}: #{e.class}: #{e.message}"
+        end
+
+        if resolved_did.nil?
+          signal_error "couldn't resolve #{target}"
+        end
+
+        result = resolved_did.account_status
+
+        if status?
+          puts (result&.to_s || 'deleted')
+          return
+        end
+
+        case result
+        when :active
+          puts "#{resolved_did} at #{resolved_did.document.pds_host}: account active"
+        when nil
+          puts "#{resolved_did} at #{resolved_did.document.pds_host}: account not found"
+        else
+          puts "#{resolved_did} at #{resolved_did.document.pds_host}: account inactive (status = #{result})"
+        end
+      end
+    end
+  end
+end

data/lib/ratproto/commands/stream.rb

@@ -9,6 +9,8 @@ require_relative 'base'
 module RatProto
   module Commands
     class Stream < Base
+      OPERATION_TYPES = %w[create update delete].freeze
+
       banner 'Stream events from a relay or PDS firehose'
 
       parameter 'SERVICE', 'relay, PDS or Jetstream hostname'
@@ -26,31 +28,37 @@ module RatProto
       option ['-d', '--did'], 'DID[,DID...]', 'filter events by DID (comma-separated or repeated)',
              multivalued: true, attribute_name: :did_values
 
-      option ['-c', '--collection'], 'NSID[,NSID...]', 'filter events by collection (comma-separated or repeated)',
+      option ['-c', '--collection'], 'NSID[,NSID...]',
+             "filter events by collection (comma-separated or repeated; pass '-' to skip all and only print account events)",
              multivalued: true, attribute_name: :collection_values
 
-      option ['-a', '--[no-]account'], :flag, 'print account status events (default: enabled unless filtering by collection)'
-      option ['-s', '--print-cursor'], :flag, 'only print current cursor (seq)'
+      option ['-o', '--operation'], 'ACTION[,ACTION...]',
+             'filter events by operation (create, update or delete; comma-separated or repeated)',
+             multivalued: true, attribute_name: :operation_values
+
+      option ['-a', '--[no-]account'], :flag,
+             'print account status events (default: enabled unless filtering by collection or operation)'
+
+      option ['-q', '--quiet'], :flag, 'disable status messages'
+      option ['-s', '--print-cursor'], :flag, 'only print cursor (seq) of first event and disconnect'
+      option ['--print-time'], :flag, 'only print timestamp of first event and disconnect'
 
 
       def execute
         require 'skyfall'
 
-        @dids = comma_separated(did_values, '-d/--did')
-        @collections = comma_separated(collection_values, '-c/--collection')
-
-        @dids = (@dids.length > 0) ? @dids.map { |did| map_argument_to_did(did) } : nil
-        @collections = (@collections.length > 0) ? @collections.map { |collection| validate_nsid(collection) } : nil
+        prepare_filters
 
         @sky = build_stream
         configure_interrupt_handler
 
-        if print_cursor?
+        if print_cursor? || print_time?
           @sky.on_message do |msg|
             print_cursor_and_stop(msg)
             next
           end
 
+          @sky.on_error { |e| report_error(e) }
           @sky.connect
         else
           configure_callbacks
@@ -63,6 +71,40 @@ module RatProto
 
       private
 
+      def prepare_filters
+        @dids = comma_separated(did_values, '-d/--did')
+        @collections = comma_separated(collection_values, '-c/--collection')
+        @operations = comma_separated(operation_values, '-o/--operation')
+
+        if @collections.include?('-')
+          if @collections.any? { |collection| collection != '-' }
+            signal_usage_error("'-' cannot be combined with collection names")
+          end
+
+          if @operations.length > 0
+            signal_usage_error("'-c -' cannot be combined with -o/--operation")
+          end
+
+          @no_collections = true
+          @collections = nil
+        elsif @collections.length > 0
+          @collections = @collections.map { |collection| validate_nsid(collection) }
+        else
+          @collections = nil
+        end
+
+        @dids = (@dids.length > 0) ? @dids.map { |did| map_argument_to_did(did) } : nil
+        @operations = (@operations.length > 0) ? @operations.map { |operation| validate_operation(operation) } : nil
+      end
+
+      def validate_operation(operation)
+        if OPERATION_TYPES.include?(operation)
+          operation.to_sym
+        else
+          signal_usage_error("#{operation.inspect} is not a valid operation (expected create, update or delete)")
+        end
+      end
+
       def build_stream
         if jetstream?
           options = {}
@@ -90,10 +132,10 @@ module RatProto
       end
 
       def report_error(error)
-        log "ERROR: #{error.message}"
+        log "ERROR: #{error.message}", true
 
         if !jetstream? && error.message.include?('Unexpected response code')
-          log "If this is a Jetstream server, retry with -j / --jetstream."
+          log "If this is a Jetstream server, retry with -j / --jetstream.", true
         end
       end
 
@@ -107,13 +149,15 @@ module RatProto
       end
 
       def print_commit_message(msg)
-        return if @dids && !@dids.include?(msg.repo)
-
-        time = msg.time.getlocal.iso8601
+        time = msg.time.getlocal
         @last_timestamp = time
 
+        return if @no_collections
+        return if @dids && !@dids.include?(msg.repo)
+
         msg.operations.each do |op|
           next if @collections && !@collections.include?(op.collection)
+          next if @operations && !@operations.include?(op.action)
 
           json = op.raw_record && JSON.generate(op.raw_record.except('$type'))
           puts "[#{time}] (#{msg.seq}) #{msg.repo} #{op.action.inspect} #{op.collection} #{op.rkey} #{json}"
@@ -121,11 +165,11 @@ module RatProto
       end
 
       def print_account_message(msg)
-        return if @dids && !@dids.include?(msg.repo)
-
-        time = msg.time.getlocal.iso8601
+        time = msg.time.getlocal
         @last_timestamp = time
 
+        return if @dids && !@dids.include?(msg.repo)
+
         status = (msg.active?) ? :active : msg.status
 
         puts "[#{time}] (#{msg.seq}) #{msg.repo} #account (status = #{status.inspect})"
@@ -133,8 +177,8 @@ module RatProto
 
       def show_account_messages?
         if account? == nil
-          # enabled by default if -c is not used
-          @collections.nil?
+          # enabled by default if -c or -o is not used, or if commits were explicitly disabled
+          @no_collections || (@collections.nil? && @operations.nil?)
         else
           # if enabled/disabled explicitly, follow user's choice
           account?
@@ -143,16 +187,21 @@ module RatProto
 
       def configure_interrupt_handler
         trap('SIGINT') do
-          log
+          log nil, true
           log 'Disconnecting...'
           @sky.disconnect
         end
       end
 
+      def log(text = nil, force = false)
+        super(text) unless quiet? && !force
+      end
+
       def print_cursor_and_stop(msg)
         return if @disconnecting
 
-        puts msg.seq
+        puts (print_time?) ? msg.time.getlocal : msg.seq
+
         @sky.disconnect
         @disconnecting = true
       end

data/lib/ratproto/commands/stream_labels.rb

@@ -24,7 +24,9 @@ module RatProto
       option ['-t', '--target'], 'PATTERN', "filter by labelled DID/URI (can be a pattern with '*' as a wildcard; repeatable)",
              multivalued: true, attribute_name: :target_patterns
 
-      option ['-s', '--print-cursor'], :flag, 'only print current cursor (seq)'
+      option ['-q', '--quiet'], :flag, 'disable status messages'
+      option ['-s', '--print-cursor'], :flag, 'only print cursor (seq) of first event and disconnect'
+      option ['--print-time'], :flag, 'only print timestamp of first event and disconnect'
 
 
       def execute
@@ -37,12 +39,13 @@ module RatProto
         @sky = Skyfall::Firehose.new(@service, :subscribe_labels, cursor)
         configure_interrupt_handler
 
-        if print_cursor?
+        if print_cursor? || print_time?
           @sky.on_message do |msg|
             print_cursor_and_stop(msg)
             next
           end
 
+          @sky.on_error { |e| log "ERROR: #{e.message}" }
           @sky.connect
         else
           configure_callbacks
@@ -90,35 +93,41 @@ module RatProto
         @sky.on_disconnect { log "Disconnected" }
         @sky.on_reconnect  { log "Connection lost, trying to reconnect..." }
         @sky.on_timeout    { log "Connection stalled, triggering a reconnect..." }
-        @sky.on_error      { |e| log "ERROR: #{e}" }
+        @sky.on_error      { |e| log "ERROR: #{e.message}" }
 
         @sky.on_message do |msg|
           next unless msg.type == :labels
 
           msg.labels.each do |label|
+            time = label.created_at.getlocal
+            @last_timestamp = time
+
             next if @labels && !@labels.include?(label.value)
             next if @targets && @targets.none? { |pattern| pattern.match?(label.subject) }
 
-            @last_timestamp = label.created_at
-
             json = JSON.generate(label.data.except('cid', 'cts', 'sig', 'src', 'ver'))
-            puts "[#{label.created_at}] (#{msg.seq}) #{json}"
+            puts "[#{time}] (#{msg.seq}) #{json}"
           end
         end
       end
 
       def configure_interrupt_handler
         trap('SIGINT') do
-          log
+          log nil, true
           log 'Disconnecting...'
           @sky.disconnect
         end
       end
 
+      def log(text = nil, force = false)
+        super(text) unless quiet? && !force
+      end
+
       def print_cursor_and_stop(msg)
         return if @disconnecting
 
-        puts msg.seq
+        puts (print_time?) ? msg.labels.first.created_at.getlocal : msg.seq
+
         @sky.disconnect
         @disconnecting = true
       end

data/lib/ratproto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RatProto
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratproto
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Kuba Suder
@@ -102,6 +102,7 @@ files:
 - exe/rat
 - lib/ratproto.rb
 - lib/ratproto/cli.rb
+- lib/ratproto/commands/account_status.rb
 - lib/ratproto/commands/base.rb
 - lib/ratproto/commands/fetch.rb
 - lib/ratproto/commands/resolve.rb
@@ -117,6 +118,7 @@ metadata:
   bug_tracker_uri: https://tangled.org/mackuba.eu/ratproto/issues
   changelog_uri: https://tangled.org/mackuba.eu/ratproto/blob/master/CHANGELOG.md
   source_code_uri: https://tangled.org/mackuba.eu/ratproto
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib