skyfall 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965eb9da488c1af0a4ea4573de3677572f6acdfab64497ce65bf0f3ba11ac015
-  data.tar.gz: 0fa130b4da079e253de127813e245a5851eaa9c83651e955099b070a65a7396e
+  metadata.gz: 1002b9dbaf48b9158f4b37d314e7f72d0990bf8290a5ad5d172af5aec9c48e38
+  data.tar.gz: 2a7cf444f30a13135e0848cbf0ad6c1900d9210e0799117e0612d5c52a93b2a4
 SHA512:
-  metadata.gz: c0a2f258e2a96d0fb6e9f1206df3dadcad9543bf5898fdc3702e74e097c3f5758b7a6c33d8b3dbfaa437b4718122e2a4c199b70d2e9c12ea5686645cbcd414b7
-  data.tar.gz: 417f34ff64333390397a91e6cbc9364b858b015a000759a6beccfed3bf81b448b8261c4fdfeed7ae3ebadaa995f380837b6cc543aceec83342884e8ff8e48b11
+  metadata.gz: 600eaf8dd34c393b592a6490848d9e981c9ff0fa17fab629d2d640162eecda1248a49944e49d4bb679f732551e75ac209fd09bac85b7a087f81e8b13153c3446
+  data.tar.gz: e8d2c63b039aa7918337b67b77e8d0b511aba81b98d21862cf75a8561d42e72e71214fe16b11f884082fdd8b646e917b840b0369911d07afb32aedc42badc38a

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [Unreleased]
+
+- added heartbeat timer
+
+## [0.3.1] - 2024-06-28
+
+- added `app.bsky.graph.starterpack` and `chat.bsky.actor.declaration` record types
+- added `#account` event type (`AccountMessage`)
+- added `handle` field to `IdentityMessage`
+- fixed param validation on `Stream` initialization
+- reverted the change that added Ruby stdlib dependencies explicitly to the gemspec, since this causes more problems than it's worth - only `base64` is left there, since it's the one now required to be listed
+
+## [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/README.md

@@ -1,6 +1,9 @@
 # Skyfall
 
-🌤 A Ruby gem for streaming data from the Bluesky/AtProto firehose 🦋
+A Ruby gem for streaming data from the Bluesky/AtProto firehose 🦋
+
+> [!NOTE]
+> ATProto Ruby gems collection: [skyfall](https://github.com/mackuba/skyfall) | [blue_factory](https://github.com/mackuba/blue_factory) | [minisky](https://github.com/mackuba/minisky) | [didkit](https://github.com/mackuba/didkit)
 
 
 ## What does it do

data/lib/skyfall/collection.rb

@@ -1,16 +1,19 @@
 module Skyfall
   module Collection
-    BSKY_PROFILE    = "app.bsky.actor.profile"
-    BSKY_FEED       = "app.bsky.feed.generator"
-    BSKY_LIKE       = "app.bsky.feed.like"
-    BSKY_POST       = "app.bsky.feed.post"
-    BSKY_REPOST     = "app.bsky.feed.repost"
-    BSKY_THREADGATE = "app.bsky.feed.threadgate"
-    BSKY_BLOCK      = "app.bsky.graph.block"
-    BSKY_FOLLOW     = "app.bsky.graph.follow"
-    BSKY_LIST       = "app.bsky.graph.list"
-    BSKY_LISTBLOCK  = "app.bsky.graph.listblock"
-    BSKY_LISTITEM   = "app.bsky.graph.listitem"
-    BSKY_LABELER    = "app.bsky.labeler.service"
+    BSKY_PROFILE     = "app.bsky.actor.profile"
+    BSKY_FEED        = "app.bsky.feed.generator"
+    BSKY_LIKE        = "app.bsky.feed.like"
+    BSKY_POST        = "app.bsky.feed.post"
+    BSKY_REPOST      = "app.bsky.feed.repost"
+    BSKY_THREADGATE  = "app.bsky.feed.threadgate"
+    BSKY_BLOCK       = "app.bsky.graph.block"
+    BSKY_FOLLOW      = "app.bsky.graph.follow"
+    BSKY_LIST        = "app.bsky.graph.list"
+    BSKY_LISTBLOCK   = "app.bsky.graph.listblock"
+    BSKY_LISTITEM    = "app.bsky.graph.listitem"
+    BSKY_STARTERPACK = "app.bsky.graph.starterpack"
+    BSKY_LABELER     = "app.bsky.labeler.service"
+
+    BSKY_CHAT_DECLARATION = "chat.bsky.actor.declaration"
   end
 end

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/account_message.rb

@@ -0,0 +1,11 @@
+module Skyfall
+  class AccountMessage < WebsocketMessage
+    def active?
+      @data_object['active']
+    end
+
+    def status
+      @data_object['status']&.to_sym
+    end
+  end
+end

data/lib/skyfall/messages/handle_message.rb

@@ -1,4 +1,9 @@
 module Skyfall
+
+  #
+  # Note: this event type is deprecated and will stop being emitted at some point.
+  # You should instead listen for 'identity' events (Skyfall::IdentityMessage).
+  #
   class HandleMessage < WebsocketMessage
     def handle
       @data_object['handle']

data/lib/skyfall/messages/identity_message.rb

@@ -1,4 +1,7 @@
 module Skyfall
   class IdentityMessage < WebsocketMessage
+    def handle
+      @data_object['handle']
+    end
   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/tombstone_message.rb

@@ -1,4 +1,9 @@
 module Skyfall
+
+  #
+  # Note: this event type is deprecated and will stop being emitted at some point.
+  # You should instead listen for 'account' events (Skyfall::AccountMessage).
+  #
   class TombstoneMessage < WebsocketMessage
   end
 end

data/lib/skyfall/messages/websocket_message.rb

@@ -8,10 +8,12 @@ module Skyfall
   class WebsocketMessage
     using Skyfall::Extensions
 
+    require_relative 'account_message'
     require_relative 'commit_message'
     require_relative 'handle_message'
     require_relative 'identity_message'
     require_relative 'info_message'
+    require_relative 'labels_message'
     require_relative 'tombstone_message'
     require_relative 'unknown_message'
 
@@ -24,10 +26,12 @@ module Skyfall
       type_object, data_object = decode_cbor_objects(data)
 
       message_class = case type_object['t']
+        when '#account' then AccountMessage
         when '#commit' then CommitMessage
         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/operation.rb

@@ -43,18 +43,20 @@ module Skyfall
 
     def type
       case collection
-      when Collection::BSKY_BLOCK      then :bsky_block
-      when Collection::BSKY_FEED       then :bsky_feed
-      when Collection::BSKY_FOLLOW     then :bsky_follow
-      when Collection::BSKY_LABELER    then :bsky_labeler
-      when Collection::BSKY_LIKE       then :bsky_like
-      when Collection::BSKY_LIST       then :bsky_list
-      when Collection::BSKY_LISTBLOCK  then :bsky_listblock
-      when Collection::BSKY_LISTITEM   then :bsky_listitem
-      when Collection::BSKY_POST       then :bsky_post
-      when Collection::BSKY_PROFILE    then :bsky_profile
-      when Collection::BSKY_REPOST     then :bsky_repost
-      when Collection::BSKY_THREADGATE then :bsky_threadgate
+      when Collection::BSKY_BLOCK       then :bsky_block
+      when Collection::BSKY_FEED        then :bsky_feed
+      when Collection::BSKY_FOLLOW      then :bsky_follow
+      when Collection::BSKY_LABELER     then :bsky_labeler
+      when Collection::BSKY_LIKE        then :bsky_like
+      when Collection::BSKY_LIST        then :bsky_list
+      when Collection::BSKY_LISTBLOCK   then :bsky_listblock
+      when Collection::BSKY_LISTITEM    then :bsky_listitem
+      when Collection::BSKY_POST        then :bsky_post
+      when Collection::BSKY_PROFILE     then :bsky_profile
+      when Collection::BSKY_REPOST      then :bsky_repost
+      when Collection::BSKY_STARTERPACK then :bsky_starterpack
+      when Collection::BSKY_THREADGATE  then :bsky_threadgate
+      when Collection::BSKY_CHAT_DECLARATION then :bsky_chat_declaration
       else :unknown
       end
     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.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.4
+- !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: cbor
   requirement: !ruby/object:Gem::Requirement
@@ -50,20 +64,40 @@ 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.2
+        version: '0.11'
 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 +123,13 @@ files:
 - lib/skyfall/collection.rb
 - lib/skyfall/errors.rb
 - lib/skyfall/extensions.rb
+- lib/skyfall/label.rb
+- lib/skyfall/messages/account_message.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