skyfall 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965eb9da488c1af0a4ea4573de3677572f6acdfab64497ce65bf0f3ba11ac015
-  data.tar.gz: 0fa130b4da079e253de127813e245a5851eaa9c83651e955099b070a65a7396e
+  metadata.gz: 34e2166dc123a74140ce5cae67d3c000c1f88972d15cbe8a2550bde11ba4034d
+  data.tar.gz: 334f4b8b0ddce03b2258a0266e01e08cac9528924ac13380e91b66a0bb1217b8
 SHA512:
-  metadata.gz: c0a2f258e2a96d0fb6e9f1206df3dadcad9543bf5898fdc3702e74e097c3f5758b7a6c33d8b3dbfaa437b4718122e2a4c199b70d2e9c12ea5686645cbcd414b7
-  data.tar.gz: 417f34ff64333390397a91e6cbc9364b858b015a000759a6beccfed3bf81b448b8261c4fdfeed7ae3ebadaa995f380837b6cc543aceec83342884e8ff8e48b11
+  metadata.gz: f56ab132941d80a577e5f3ba630b58d6f99548d0cde398fdb4f15e7c24d9557c3b0243d64a3940c18bf370afb219df3282c935300fc0359b6b0e00915b7002ca
+  data.tar.gz: 4bd7672a9450d8b1ec80ec679b69e6ba4242c4a6554865e296e7a347769795239b99a95539fe0b637407c2736b0716dfc8d1c3a9dea2d8d7a9654b47158262c9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.3.0] - 2024-03-21
+
+- added support for labeller firehose, served by labeller services at the `com.atproto.label.subscribeLabels` endpoint (aliased as `:subscribe_labels`)
+- the `#labels` messages from the labeller firehose are parsed into a `LabelsMessage`, which includes a `labels` array of `Label` objects
+- `Stream` callbacks can now also be assigned via setters, e.g. `stream.on_message = proc { ... }`
+- added default error handler to `Stream` which logs the error to `$stdout` - set `stream.on_error = nil` to disable
+- added Ruby stdlib dependencies explicitly to the gemspec - fixes a warning in Ruby 3.3 when requiring `base64`, which will be extracted as an optional gem in 3.4
+
 ## [0.2.5] - 2024-03-14
 
 - added `:bsky_labeler` record type symbol & collection constant

data/lib/skyfall/label.rb

@@ -0,0 +1,63 @@
+require_relative 'errors'
+require 'time'
+
+module Skyfall
+  class Label
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+
+      raise DecodeError.new("Missing version: #{data}") unless data.has_key?('ver')
+      raise DecodeError.new("Invalid version: #{ver}") unless ver.is_a?(Integer) && ver >= 1
+      raise UnsupportedError.new("Unsupported version: #{ver}") unless ver == 1
+
+      raise DecodeError.new("Missing source: #{data}") unless data.has_key?('src')
+      raise DecodeError.new("Invalid source: #{src}") unless src.is_a?(String) && src.start_with?('did:')
+
+      raise DecodeError.new("Missing uri: #{data}") unless data.has_key?('uri')
+      raise DecodeError.new("Invalid uri: #{uri}") unless uri.is_a?(String)
+      raise DecodeError.new("Invalid uri: #{uri}") unless uri.start_with?('at://') || uri.start_with?('did:')
+    end
+
+    def version
+      @data['ver']
+    end
+
+    def authority
+      @data['src']
+    end
+
+    def subject
+      @data['uri']
+    end
+
+    def cid
+      @cid ||= @data['cid'] && CID.from_json(@data['cid'])
+    end
+
+    def value
+      @data['val']
+    end
+
+    def negation?
+      !!@data['neg']
+    end
+
+    def created_at
+      @created_at ||= Time.parse(@data['cts'])
+    end
+
+    def expires_at
+      @expires_at ||= @data['exp'] && Time.parse(@data['exp'])
+    end
+
+    alias ver version
+    alias src authority
+    alias uri subject
+    alias val value
+    alias neg negation?
+    alias cts created_at
+    alias exp expires_at
+  end
+end

data/lib/skyfall/messages/labels_message.rb

@@ -0,0 +1,23 @@
+require_relative 'websocket_message'
+require_relative '../label'
+
+module Skyfall
+  class LabelsMessage
+    using Skyfall::Extensions
+
+    attr_reader :type_object, :data_object
+    attr_reader :type, :seq
+
+    def initialize(type_object, data_object)
+      @type_object = type_object
+      @data_object = data_object
+
+      @type = @type_object['t'][1..-1].to_sym
+      @seq = @data_object['seq']
+    end
+
+    def labels
+      @labels ||= @data_object['labels'].map { |x| Label.new(x) }
+    end
+  end
+end

data/lib/skyfall/messages/websocket_message.rb

@@ -12,6 +12,7 @@ module Skyfall
     require_relative 'handle_message'
     require_relative 'identity_message'
     require_relative 'info_message'
+    require_relative 'labels_message'
     require_relative 'tombstone_message'
     require_relative 'unknown_message'
 
@@ -28,6 +29,7 @@ module Skyfall
         when '#handle' then HandleMessage
         when '#identity' then IdentityMessage
         when '#info' then InfoMessage
+        when '#labels' then LabelsMessage
         when '#tombstone' then TombstoneMessage
         else UnknownMessage
       end

data/lib/skyfall/stream.rb

@@ -7,11 +7,15 @@ require 'uri'
 module Skyfall
   class Stream
     SUBSCRIBE_REPOS = "com.atproto.sync.subscribeRepos"
+    SUBSCRIBE_LABELS = "com.atproto.label.subscribeLabels"
 
     NAMED_ENDPOINTS = {
-      :subscribe_repos => SUBSCRIBE_REPOS
+      :subscribe_repos => SUBSCRIBE_REPOS,
+      :subscribe_labels => SUBSCRIBE_LABELS
     }
 
+    EVENTS = %w(message raw_message connecting connect disconnect reconnect error)
+
     MAX_RECONNECT_INTERVAL = 300
 
     attr_accessor :heartbeat_timeout, :heartbeat_interval, :cursor, :auto_reconnect
@@ -23,6 +27,8 @@ module Skyfall
       @handlers = {}
       @auto_reconnect = true
       @connection_attempts = 0
+
+      @handlers[:error] = proc { |e| puts "ERROR: #{e}" }
     end
 
     def connect
@@ -104,32 +110,14 @@ module Skyfall
 
     alias close disconnect
 
-    def on_message(&block)
-      @handlers[:message] = block
-    end
-
-    def on_raw_message(&block)
-      @handlers[:raw_message] = block
-    end
-
-    def on_connecting(&block)
-      @handlers[:connecting] = block
-    end
-
-    def on_connect(&block)
-      @handlers[:connect] = block
-    end
-
-    def on_disconnect(&block)
-      @handlers[:disconnect] = block
-    end
-
-    def on_error(&block)
-      @handlers[:error] = block
-    end
+    EVENTS.each do |event|
+      define_method "on_#{event}" do |&block|
+        @handlers[event.to_sym] = block
+      end
 
-    def on_reconnect(&block)
-      @handlers[:reconnect] = block
+      define_method "on_#{event}=" do |block|
+        @handlers[event.to_sym] = block
+      end
     end
 
     def inspectable_variables

data/lib/skyfall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skyfall
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -50,20 +50,96 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.9.6
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: time
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '0.13'
 description: "\n    Skyfall is a Ruby library for connecting to the \"firehose\" of
   the Bluesky social network, i.e. a websocket which\n    streams all new posts and
   everything else happening on the Bluesky network in real time. The code connects
@@ -89,10 +165,12 @@ files:
 - lib/skyfall/collection.rb
 - lib/skyfall/errors.rb
 - lib/skyfall/extensions.rb
+- lib/skyfall/label.rb
 - lib/skyfall/messages/commit_message.rb
 - lib/skyfall/messages/handle_message.rb
 - lib/skyfall/messages/identity_message.rb
 - lib/skyfall/messages/info_message.rb
+- lib/skyfall/messages/labels_message.rb
 - lib/skyfall/messages/tombstone_message.rb
 - lib/skyfall/messages/unknown_message.rb
 - lib/skyfall/messages/websocket_message.rb