skyfall 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d272120c19a97451a6df364e1a7dbbb8191dc0247fd929129ecab0cf05902599
-  data.tar.gz: 242ebbbbf44aee36a883c2fc78be327d29c14fa27168fc1eac66ef38ad16cc16
+  metadata.gz: 17dd2389545a6bd5c9c3483a89f95e40a62cf2014e263f69d3590cf651920865
+  data.tar.gz: 9fe379e3d713c50e4a4700941660b529827e2329e200859ddea58b7113da1c3b
 SHA512:
-  metadata.gz: cebb5837133466638a7009d52be516af961644c55f91fe3f3e9a6fe120bc8875f614bbf849cea02fe23b81f3f1f4652226214d375adff12198faf3dd81c1bedd
-  data.tar.gz: f1c8c48d58c344a67f4df27afc792b6d38272ecb0aefdf7cf4336269290e36c788d356547c2af0520a9d11664e62fb872157da88951cb669f7081bb0414cc029
+  metadata.gz: e9f7c603360a483241cbd6b2af8b49b315149b308c2064332b42d9fa7b27fd302c1b181c6fc7a60871f1dfead09cc3621ed2b9106db2680e0919f12119af881d
+  data.tar.gz: e8c7da9dc57730ded46de52cc7e500d84129782bd534c2163205330143bb1a5ec0f24feb39a86e440c073972b1c4af3840ce688e9caf55177003d140267c6473

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.6.0] - 2025-06-25
+
+- significantly speeded up reading of events from the binary firehose (`Skyfall::Firehose`) - up to 4-5x faster than before
+- removed the `Skyfall::Stream.new` constructor deprecated in 0.5.0
+
+## [0.5.1] - 2025-05-18
+
+- added support for the new `#sync` message type
+- added `#unknown?` helper in `Skyfall::Firehose::Message` and `Skyfall::Jetstream::Message`, which returns true if the message type is `UnknownMessage`
+- added `:bsky_verification` and `:bsky_actor_status` lexicon type and shortcode
+- added one missing require
+
 ## [0.5.0] - 2024-11-15
 
 Jetstream support! You can now connect to [Jetstream](https://github.com/bluesky-social/jetstream) sources using `Skyfall::Jetstream` (see readme).

data/README.md

@@ -80,7 +80,7 @@ Alternatively, you can connect to a [Jetstream](https://github.com/bluesky-socia
 Jetstream connections are made using a `Skyfall::Jetstream` instance, which has more or less the same API as `Skyfall::Firehose`, so it should be possible to switch between those by just changing the line that creates the client instance:
 
 ```rb
-sky = Skyfall::Jetstream.new('jetstream1.us-east.bsky.network')
+sky = Skyfall::Jetstream.new('jetstream2.us-east.bsky.network')
 
 sky.on_message { |msg| ... }
 sky.on_error { |e| ... }
@@ -113,7 +113,7 @@ Jetstream has a similar mechanism, except the cursor is the event's timestamp in
 ```rb
 cursor = load_cursor
 
-sky = Skyfall::Jetstream.new('jetstream1.us-east.bsky.network', { cursor: cursor })
+sky = Skyfall::Jetstream.new('jetstream2.us-east.bsky.network', { cursor: cursor })
 sky.on_message do |msg|
   save_cursor(msg.seq)
   process_message(msg)
@@ -283,7 +283,7 @@ Jetstream allows you to specify [filters](https://github.com/bluesky-social/jets
 To use these filters, pass the "wantedCollections" and/or "wantedDids" parameters in the options hash when initializing `Skyfall::Jetstream`. You can use the original JavaScript param names, or a more Ruby-like snake_case form:
 
 ```rb
-sky = Skyfall::Jetstream.new('jetstream1.us-east.bsky.network', {
+sky = Skyfall::Jetstream.new('jetstream2.us-east.bsky.network', {
   wanted_collections: 'app.bsky.feed.post',
   wanted_dids: @dids
 })
@@ -292,7 +292,7 @@ sky = Skyfall::Jetstream.new('jetstream1.us-east.bsky.network', {
 For collections, you can also use the symbol codes used in `Operation#type`, e.g. `:bsky_post`:
 
 ```rb
-sky = Skyfall::Jetstream.new('jetstream1.us-east.bsky.network', {
+sky = Skyfall::Jetstream.new('jetstream2.us-east.bsky.network', {
   wanted_collections: [:bsky_post]
 })
 ```

data/example/jet_monitor_phrases.rb

@@ -18,7 +18,7 @@ if terms.empty?
 end
 
 # tell Jetstream to send us only post records
-sky = Skyfall::Jetstream.new('jetstream1.us-east.bsky.network', { wanted_collections: [:bsky_post] })
+sky = Skyfall::Jetstream.new('jetstream2.us-east.bsky.network', { wanted_collections: [:bsky_post] })
 
 sky.on_message do |msg|
   # we're only interested in repo commit messages

data/lib/skyfall/collection.rb

@@ -1,37 +1,41 @@
 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_POSTGATE    = "app.bsky.feed.postgate"
-    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_PROFILE      = "app.bsky.actor.profile"
+    BSKY_ACTOR_STATUS = "app.bsky.actor.status"
+    BSKY_FEED         = "app.bsky.feed.generator"
+    BSKY_LIKE         = "app.bsky.feed.like"
+    BSKY_POST         = "app.bsky.feed.post"
+    BSKY_POSTGATE     = "app.bsky.feed.postgate"
+    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_VERIFICATION = "app.bsky.graph.verification"
+    BSKY_LABELER      = "app.bsky.labeler.service"
 
     BSKY_CHAT_DECLARATION = "chat.bsky.actor.declaration"
 
     SHORT_CODES = {
-      BSKY_BLOCK       => :bsky_block,
-      BSKY_FEED        => :bsky_feed,
-      BSKY_FOLLOW      => :bsky_follow,
-      BSKY_LABELER     => :bsky_labeler,
-      BSKY_LIKE        => :bsky_like,
-      BSKY_LIST        => :bsky_list,
-      BSKY_LISTBLOCK   => :bsky_listblock,
-      BSKY_LISTITEM    => :bsky_listitem,
-      BSKY_POST        => :bsky_post,
-      BSKY_POSTGATE    => :bsky_postgate,
-      BSKY_PROFILE     => :bsky_profile,
-      BSKY_REPOST      => :bsky_repost,
-      BSKY_STARTERPACK => :bsky_starterpack,
-      BSKY_THREADGATE  => :bsky_threadgate,
+      BSKY_ACTOR_STATUS => :bsky_actor_status,
+      BSKY_BLOCK        => :bsky_block,
+      BSKY_FEED         => :bsky_feed,
+      BSKY_FOLLOW       => :bsky_follow,
+      BSKY_LABELER      => :bsky_labeler,
+      BSKY_LIKE         => :bsky_like,
+      BSKY_LIST         => :bsky_list,
+      BSKY_LISTBLOCK    => :bsky_listblock,
+      BSKY_LISTITEM     => :bsky_listitem,
+      BSKY_POST         => :bsky_post,
+      BSKY_POSTGATE     => :bsky_postgate,
+      BSKY_PROFILE      => :bsky_profile,
+      BSKY_REPOST       => :bsky_repost,
+      BSKY_STARTERPACK  => :bsky_starterpack,
+      BSKY_THREADGATE   => :bsky_threadgate,
+      BSKY_VERIFICATION => :bsky_verification,
       BSKY_CHAT_DECLARATION => :bsky_chat_declaration,
     }
 

data/lib/skyfall/firehose/message.rb

@@ -15,6 +15,7 @@ module Skyfall
     require_relative 'identity_message'
     require_relative 'info_message'
     require_relative 'labels_message'
+    require_relative 'sync_message'
     require_relative 'tombstone_message'
     require_relative 'unknown_message'
 
@@ -34,6 +35,7 @@ module Skyfall
         when '#identity'  then Firehose::IdentityMessage
         when '#info'      then Firehose::InfoMessage
         when '#labels'    then Firehose::LabelsMessage
+        when '#sync'      then Firehose::SyncMessage
         when '#tombstone' then Firehose::TombstoneMessage
         else Firehose::UnknownMessage
       end
@@ -56,6 +58,10 @@ module Skyfall
       []
     end
 
+    def unknown?
+      self.is_a?(Firehose::UnknownMessage)
+    end
+
     def time
       @time ||= @data_object['time'] && Time.parse(@data_object['time'])
     end

data/lib/skyfall/firehose/sync_message.rb

@@ -0,0 +1,9 @@
+require_relative '../firehose'
+
+module Skyfall
+  class Firehose::SyncMessage < Firehose::Message
+    def rev
+      @rev ||= @data_object['rev']
+    end
+  end
+end

data/lib/skyfall/firehose.rb

@@ -13,13 +13,6 @@ module Skyfall
 
     attr_accessor :cursor
 
-    def self.new(server, endpoint, cursor = nil)
-      # to be removed in 0.6
-      instance = self.allocate
-      instance.send(:initialize, server, endpoint, cursor)
-      instance
-    end
-
     def initialize(server, endpoint, cursor = nil)
       require_relative 'firehose/message'
       super(server)
@@ -34,7 +27,7 @@ module Skyfall
     end
 
     def handle_message(msg)
-      data = msg.data.pack('C*')
+      data = msg.data
       @handlers[:raw_message]&.call(data)
 
       if @handlers[:message]

data/lib/skyfall/jetstream/message.rb

@@ -39,6 +39,10 @@ module Skyfall
       @time_us = @json['time_us']
     end
 
+    def unknown?
+      self.is_a?(Jetstream::UnknownMessage)
+    end
+
     def operations
       []
     end

data/lib/skyfall/jetstream.rb

@@ -6,13 +6,6 @@ require 'uri'
 
 module Skyfall
   class Jetstream < Stream
-    def self.new(server, params = {})
-      # to be removed in 0.6
-      instance = self.allocate
-      instance.send(:initialize, server, params)
-      instance
-    end
-
     attr_accessor :cursor
 
     def initialize(server, params = {})

data/lib/skyfall/stream.rb

@@ -2,6 +2,8 @@ require 'eventmachine'
 require 'faye/websocket'
 require 'uri'
 
+require_relative 'version'
+
 module Skyfall
   class Stream
     EVENTS = %w(message raw_message connecting connect disconnect reconnect error timeout)
@@ -10,18 +12,6 @@ module Skyfall
     attr_accessor :auto_reconnect, :last_update, :user_agent
     attr_accessor :heartbeat_timeout, :heartbeat_interval, :check_heartbeat
 
-    def self.new(server, endpoint = nil, cursor = nil)
-      # to be removed in 0.6
-      if endpoint || cursor
-        STDERR.puts "Warning: Skyfall::Stream has been renamed to Skyfall::Firehose. This initializer will be removed in the next version."
-        Firehose.new(server, endpoint, cursor)
-      else
-        instance = self.allocate
-        instance.send(:initialize, server)
-        instance
-      end
-    end
-
     def initialize(service)
       @root_url = build_root_url(service)
 
@@ -53,7 +43,7 @@ module Skyfall
           @handlers[:error]&.call(e)
         end
 
-        @ws = Faye::WebSocket::Client.new(url, nil, { headers: { 'User-Agent' => user_agent }})
+        @ws = build_websocket_client(url)
 
         @ws.on(:open) do |e|
           @handlers[:connect]&.call
@@ -183,6 +173,10 @@ module Skyfall
       end
     end
 
+    def build_websocket_client(url)
+      Faye::WebSocket::Client.new(url, nil, { headers: { 'User-Agent' => user_agent }})
+    end
+
     def build_websocket_url
       @root_url
     end

data/lib/skyfall/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kuba Suder
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -90,14 +89,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 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
@@ -132,6 +131,7 @@ files:
 - lib/skyfall/firehose/labels_message.rb
 - lib/skyfall/firehose/message.rb
 - lib/skyfall/firehose/operation.rb
+- lib/skyfall/firehose/sync_message.rb
 - lib/skyfall/firehose/tombstone_message.rb
 - lib/skyfall/firehose/unknown_message.rb
 - lib/skyfall/jetstream.rb
@@ -152,7 +152,6 @@ metadata:
   bug_tracker_uri: https://github.com/mackuba/skyfall/issues
   changelog_uri: https://github.com/mackuba/skyfall/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/mackuba/skyfall
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby gem for streaming data from the Bluesky/AtProto firehose
 test_files: []