e621stream 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b16a81259148bd2d44ea56a857d2aeefbf15029660f8bd79d219198e3231711e
-  data.tar.gz: d24d99e59eb909cbf80f39108c9d90835022f2d886b4f89060245e8c6ceb86c7
+  metadata.gz: d44d1f8f30f4f8d3931eb4a5b1f428413191a84297dbf9f879bef61307205b88
+  data.tar.gz: 7524d28a0ec987855de8e63c9c5efae8c2bd0bd0d3d07d846d03bcd16eaa8402
 SHA512:
-  metadata.gz: d8b860f937490e74e90af663866c043b9923321ef85a6d2a84a7a8ba57571605079c71fcaf9153f28343262583647ceb1bd4b3c659cb1aa0346e8d2581c1cd47
-  data.tar.gz: aa52fe6a7af0ac4f3bf7e0adff246b800b16b8350a12ea27feb55c4d389c06bdacd54e17c03e62f84d11bc40cbb7c2d49b5b1b62dd9df16b894b5e82fcabd83c
+  metadata.gz: f6d4fae99737f6f2b1b57ffe083662ba32b0a64ca6bacf9bc048ced7afe8da4216d0ebe70515757667a1d6ed86fac452310acb2ef500170fea921f91f28ea690
+  data.tar.gz: d276a848290525a9ca77d3a5c432ca2d8baf17a34142b1d52f756d07688e69d608a6a47d9da4c3a33a7bed99e9bc6d932c5b2ad571ddca5fec3cd1ff843ffa7b

data/README.md

@@ -1,13 +1,13 @@
 # e621stream
 
-A Ruby client for [E621Stream](https://e621.stream), a live WebSocket stream of e621 activity. It's built on [async-websocket](https://github.com/socketry/async-websocket) and typed with Sorbet.
+A client for [E621Stream](https://e621.stream), using [async-websocket](https://github.com/socketry/async-websocket) and typed with sorbet.
 
-```bash
+```sh
 gem install e621stream
 ```
 
 ```ruby
-require "e621stream"
+require("e621stream")
 
 client = E621Stream::Client.new(
   username:      "your_name",
@@ -22,14 +22,12 @@ client.on(:error) { |error| warn(error.message) }
 client.run
 ```
 
-- **Events:** `on("<event type>")` for one type, or `on(:dispatch)` for everything. Each is an `E621Stream::Event` with `id`, `type`, `time` and `data`, which is the record as e621's api returns it. See [Events](https://e621.stream/events/) for what each one is.
-- **Running:** `run` blocks. Inside a reactor already, it runs as a task, so `client.close` from another task stops it.
-- **Reconnecting:** the connection is reopened with backoff when it drops, and resumes from the last event it got. It isn't reopened after a close retrying won't fix, like bad credentials. `reconnect: false` turns it off.
-- **Resuming:** pass `cursor:` (an event id, or a millisecond timestamp) to replay from there. `client.cursor` is the last event received.
-- **Changing subscriptions:** `client.subscribe([...])`.
-- **Private events:** like `dmail.create`, these are polled with your own credentials and have to be subscribed to by name.
-- **Other events:** `:ready`, `:replay_complete`, `:subscribed`, `:reconnecting`, `:close` and `:error`.
+`run` blocks, unless you're already in a reactor, then it runs as a task and `client.close` stops it.
 
-```bash
-bundle exec rake    # rubocop, zeitwerk, tests and sorbet
+`on("post.create")` listens for one type, `on(:dispatch)` for everything. Events have `id`, `type`, `time` and `data` (the record as the api returns it), see [Events](https://e621.stream/events/). There's also `:ready`, `:replay_complete`, `:subscribed`, `:reconnecting`, `:close` and `:error`.
+
+It reconnects when the connection drops (`reconnect: false` turns that off), and picks up from `client.cursor`. Pass `cursor:` to replay from an event id or ms timestamp. `client.subscribe([...])` changes subscriptions. Private events like `dmail.create` have to be subscribed to by name.
+
+```sh
+bundle exec rake # rubocop, zeitwerk, tests & sorbet
 ```

data/lib/e621stream/client.rb

@@ -18,7 +18,7 @@ module E621Stream
     # An event type, `<resource>.*`, `*`, or `{ "type" => ..., "filter" => { ... } }`.
     Subscription = T.type_alias { T.any(String, T::Hash[T.any(String, Symbol), T.untyped]) }
 
-    # Opens the real connection, tests swap it for a fake one.
+    # Tests swap this out.
     class Connector
       extend(T::Sig)
 
@@ -30,7 +30,6 @@ module E621Stream
     end
 
     HEARTBEAT_SECONDS = 30
-    # The server answers heartbeats and pings, nothing for this long means the connection is gone without having closed.
     SILENT_SECONDS = 75
     MAX_DELAY_SECONDS = 60
 
@@ -89,9 +88,8 @@ module E621Stream
           break unless reconnecting
 
           @attempt += 1
-          # a server that's rate limiting this connection wants a longer break
-          base = code == CloseCodes::RATE_LIMITED ? 30 : 1
-          delay = [base * (2**(@attempt - 1)), MAX_DELAY_SECONDS].min * rand(0.75..1.25)
+          delay = code == CloseCodes::RATE_LIMITED ? 30 : [@attempt**2, MAX_DELAY_SECONDS].min
+          delay += rand
           emit("reconnecting", { attempt: @attempt, delay: delay })
           sleep(delay)
         end
@@ -114,10 +112,8 @@ module E621Stream
 
     private
 
-    # resolves to the close code and reason
     sig { returns([Integer, String]) }
     def connect_once
-      result = T.let([1000, ""], [Integer, String])
       @connector.connect(options.url) do |connection|
         @connection = connection
         @last_message = now
@@ -132,11 +128,11 @@ module E621Stream
           @connection = nil
         end
       end
-      result
+      # anything but a normal close raises out of read
+      [1000, ""]
     rescue Protocol::WebSocket::ClosedError => e
       [e.code || 1006, e.message]
     rescue StandardError => e
-      # closing tears the connection down under the read, which isn't worth reporting
       return [1000, "closed by client"] if closing?
 
       emit("error", e)
@@ -148,7 +144,7 @@ module E621Stream
       loop do
         sleep(HEARTBEAT_SECONDS)
         if now - @last_message > SILENT_SECONDS
-          connection.close(4999, "no response from the server")
+          connection.close(1001, "timed out")
           break
         end
         send_message({ op: "heartbeat" })
@@ -170,7 +166,6 @@ module E621Stream
         emit("ready", data)
       when "dispatch"
         event = Event.new(id: message["id"], type: message["type"], time: message["time"], data: message["data"], private: message["private"] == true)
-        # private events aren't in the stream, so they can't be resumed from
         @cursor = event.id unless event.private?
         emit("dispatch", event)
         emit(event.type, event)
@@ -197,7 +192,7 @@ module E621Stream
       @listeners[name]&.each { |listener| listener.call(value) }
     end
 
-    # read through a method, since #close changes it from another fiber while #run is waiting
+    # #close changes this from another fiber
     sig { returns(T::Boolean) }
     def closing?
       @closing

data/lib/e621stream/close_codes.rb

@@ -16,8 +16,10 @@ module E621Stream
     SLOW_CONSUMER = 4009
     TOO_MANY_CONNECTIONS = 4010
     AUTHENTICATION_EXPIRED = 4011
+    DISCONNECTED = 4012
+    BANNED = 4013
 
     # Closing for any of these again would just get the same result, so they aren't reconnected from.
-    FATAL = T.let([UNKNOWN_OP, DECODE_ERROR, AUTHENTICATION_FAILED, ALREADY_IDENTIFIED, INVALID_SUBSCRIPTION, INVALID_CURSOR, AUTHENTICATION_EXPIRED].freeze, T::Array[Integer])
+    FATAL = T.let([UNKNOWN_OP, DECODE_ERROR, AUTHENTICATION_FAILED, ALREADY_IDENTIFIED, INVALID_SUBSCRIPTION, INVALID_CURSOR, AUTHENTICATION_EXPIRED, DISCONNECTED, BANNED].freeze, T::Array[Integer])
   end
 end

data/lib/e621stream/events.rb

@@ -3,7 +3,7 @@
 
 module E621Stream
   module Events
-    # Kept identical to the server's src/events.ts, the repository's tests check it.
+    # Generated by scripts/clientTypes.ts in the E621Stream repository, from the server's src/events.ts.
     EVENT_TYPES = %w[
       artist.create artist.delete artist.update artist_url.create artist_version.create avoid_posting.create
       avoid_posting.delete avoid_posting.destroy avoid_posting.undelete avoid_posting.update
@@ -12,18 +12,18 @@ module E621Stream
       forum_post.create forum_post.delete forum_post.hide forum_post.unhide forum_post.update forum_topic.create
       forum_topic.delete forum_topic.hide forum_topic.unhide forum_topic.update help_page.create help_page.update
       mod_action.create news_update.create news_update.update note.create note.update note_version.create
-      pool.add_posts pool.create pool.delete pool.remove_posts pool.update pool_version.create post.create post.update
-      post_approval.create post_event.create post_flag.create post_flag.update post_replacement.create
-      post_set.add_posts post_set.create post_set.delete post_set.remove_posts post_set.update post_version.create
-      post_version.hide post_version.unhide tag.create tag.delete tag.update tag_alias.create tag_alias.update
-      tag_implication.create tag_implication.update tag_type_version.create takedown.create takedown.delete
-      takedown.update upload_karma_event.create user.create user.delete user.update user_feedback.create
-      user_feedback.delete user_feedback.destroy user_feedback.undelete user_feedback.update wiki_page.create
-      wiki_page.delete wiki_page.update wiki_page_version.create
+      pool.add_posts pool.create pool.delete pool.remove_posts pool.update pool_version.create post.create
+      post.destroy post.stats post.update post_approval.create post_event.create post_flag.create post_flag.update
+      post_replacement.create post_replacement.destroy post_replacement.update post_set.add_posts post_set.create
+      post_set.delete post_set.remove_posts post_set.update post_version.create post_version.hide post_version.unhide
+      tag.create tag.delete tag.update tag_alias.create tag_alias.update tag_implication.create tag_implication.update
+      tag_type_version.create takedown.create takedown.delete takedown.update upload_karma_event.create user.create
+      user.delete user.update user_feedback.create user_feedback.delete user_feedback.destroy user_feedback.undelete
+      user_feedback.update wiki_page.create wiki_page.delete wiki_page.update wiki_page_version.create
     ].freeze
 
     # Polled with your own credentials and only sent to you. They have to be subscribed to by name, `*` doesn't include
     # them.
-    PRIVATE_EVENT_TYPES = %w[dmail.create].freeze
+    PRIVATE_EVENT_TYPES = %w[dmail.create private_post_set.add_posts private_post_set.remove_posts].freeze
   end
 end

data/lib/e621stream/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module E621Stream
-  VERSION = "0.0.0"
+  VERSION = "0.0.2"
 end

data/lib/e621stream.rb

@@ -4,8 +4,7 @@ require("json")
 require("zeitwerk")
 require("sorbet-runtime")
 
-# Loaded eagerly (rather than left to Zeitwerk) because the gemspec already requires version.rb to read the version,
-# which defines E621Stream before Zeitwerk::Loader#setup runs.
+# required here since the gemspec loads version.rb before zeitwerk is set up
 require_relative("e621stream/version")
 
 loader = Zeitwerk::Loader.for_gem

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: e621stream
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Donovan_DMC
 bindir: bin
 cert_chain: []
-date: 2026-11-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A client for E621Stream, a live WebSocket stream of e621 activity.
 test_files: []