sockudo 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7a967b624337aaad0668a3c7fba48c18ca82dbcbf61f48d2637ab6c468a8932
-  data.tar.gz: 6fca4167728cd368e7e0dc93fb3c2986604e2fc35c8fa762c7e2e2606fc33a08
+  metadata.gz: df118e329c06d4ea98bd91c7c8bd83acb02d71e298b7ab9ae221951dfb13e5cc
+  data.tar.gz: 68c93f6cb05098c675aa8d5f2fef62073dbb8b3494084f49fc7e7cc4e1969cd7
 SHA512:
-  metadata.gz: 1211b8badb256617a74201e39d6c7579a9351cf575a2fd68ee3bbdbada7b877ce6ddcb1ddfb34c37253bd276d8db470e9340f6150c75c653cbf70622aff78fa3
-  data.tar.gz: bbe0e470d9c7cd52119693f250139eeac6ace3b0b54f01a293aed1db9003e5260ff9f7681cf0783fcbd64d967b68e431b75ab8e4783c1c31904838f002d7c54c
+  metadata.gz: 0fddc588e36a86757e096fa8fa632cdd250e581dc566b9d0b386ddb31d34fca047f132b49cdc341876da20227c57fb51e52879afef60612707156fb00fb73012
+  data.tar.gz: f2b7d1566c2f14b01b5b43071f0093b4bd50d0efa79a4b2f9426111eb3802de773e8aa03ff8ee2f0aad618b0e5b52b4a8a84b4d9524646496d8e42530f0b5a52

data/README.md

@@ -15,10 +15,12 @@ Add to your Gemfile:
 gem 'sockudo'
 ```
 
-Then run `bundle install`, or install directly:
+Then run `bundle install`.
 
-```bash
-gem install sockudo
+For local monorepo development, use:
+
+```ruby
+gem 'sockudo', path: '../sockudo/server-sdks/sockudo-http-ruby'
 ```
 
 ## Getting Started
@@ -200,6 +202,26 @@ user_count = info[:user_count]
 # List channels (optionally filtered)
 result = sockudo.channels(filter_by_prefix: 'presence-')
 
+# Read channel history with newest-first pagination
+page = sockudo.channel_history('my-channel', limit: 50, direction: 'newest_first')
+next_cursor = page[:next_cursor]
+
+# Continue pagination with an opaque cursor
+page_2 = sockudo.channel_history('my-channel', cursor: next_cursor)
+
+# Read presence history for a presence channel
+presence_page = sockudo.channel_presence_history(
+  'presence-my-channel',
+  limit: 50,
+  direction: 'newest_first'
+)
+
+# Reconstruct effective members at a point in time
+snapshot = sockudo.channel_presence_snapshot(
+  'presence-my-channel',
+  at_serial: 4
+)
+
 # Users in a presence channel
 result = sockudo.channel_users('presence-my-channel')
 ```

data/lib/sockudo/channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'multi_json'
 
@@ -5,7 +7,8 @@ module Sockudo
   # Delegates operations for a specific channel from a client
   class Channel
     attr_reader :name
-    INVALID_CHANNEL_REGEX = /[^A-Za-z0-9_\-=@,.;]/
+
+    INVALID_CHANNEL_REGEX = /[^A-Za-z0-9_\-=@,.;:]/.freeze
 
     def initialize(_, name, client = Sockudo)
       if Sockudo::Channel::INVALID_CHANNEL_REGEX.match(name)
@@ -13,6 +16,7 @@ module Sockudo
       elsif name.length > 200
         raise Sockudo::Error, "Channel name too long (limit 164 characters) '#{name}'"
       end
+
       @name = name
       @client = client
     end
@@ -95,7 +99,77 @@ module Sockudo
     # @raise [Sockudo::HTTPError] on any error raised inside http client - the original error is available in the original_error attribute
     #
     def info(attributes = [])
-      @client.channel_info(name, :info => attributes.join(','))
+      @client.channel_info(name, info: attributes.join(','))
+    end
+
+    # Request durable history for this channel.
+    #
+    # @param params [Hash] History API query params. Supported keys include:
+    #   :limit, :direction, :cursor, :start_serial, :end_serial, :start_time_ms, :end_time_ms
+    # @return [Hash] History page payload for this channel
+    #
+    def history(params = {})
+      @client.channel_history(name, params)
+    end
+
+    # Request presence history for a presence channel.
+    #
+    # @param params [Hash] Presence history API query params. Supported keys include:
+    #   :limit, :direction, :cursor, :start_serial, :end_serial, :start_time_ms, :end_time_ms
+    # @return [Hash] Presence history page payload for this channel
+    #
+    def presence_history(params = {})
+      @client.channel_presence_history(name, params)
+    end
+
+    # Request a reconstructed presence snapshot for a presence channel.
+    #
+    # @param params [Hash] Snapshot API query params. Supported keys include:
+    #   :at_time_ms, :at_serial
+    # @return [Hash] Presence snapshot payload for this channel
+    #
+    def presence_snapshot(params = {})
+      @client.channel_presence_snapshot(name, params)
+    end
+
+    # Fetch the latest visible version of a mutable message.
+    def get_message(message_serial)
+      @client.get_message(name, message_serial)
+    end
+
+    # Fetch preserved versions of a mutable message.
+    def get_message_versions(message_serial, params = {})
+      @client.get_message_versions(name, message_serial, params)
+    end
+
+    # Apply a mutable-message update.
+    def update_message(message_serial, params = {})
+      @client.update_message(name, message_serial, params)
+    end
+
+    # Apply a mutable-message delete.
+    def delete_message(message_serial, params = {})
+      @client.delete_message(name, message_serial, params)
+    end
+
+    # Apply a mutable-message append.
+    def append_message(message_serial, params = {})
+      @client.append_message(name, message_serial, params)
+    end
+
+    # Publish an annotation for a versioned message.
+    def publish_annotation(message_serial, params = {})
+      @client.publish_annotation(name, message_serial, params)
+    end
+
+    # Delete an annotation from a versioned message.
+    def delete_annotation(message_serial, annotation_serial, params = {})
+      @client.delete_annotation(name, message_serial, annotation_serial, params)
+    end
+
+    # List raw annotation events for a versioned message.
+    def list_annotations(message_serial, params = {})
+      @client.list_annotations(name, message_serial, params)
     end
 
     # Request users for a presence channel
@@ -126,7 +200,7 @@ module Sockudo
     # @raise [Sockudo::Error] if socket_id or custom_string invalid
     #
     def authentication_string(socket_id, custom_string = nil)
-      string_to_sign = [socket_id, name, custom_string].compact.map(&:to_s).join(':')
+      string_to_sign = [socket_id, name, custom_string].compact.join(':')
 
       _authentication_string(socket_id, string_to_sign, @client.authentication_token, custom_string)
     end
@@ -158,7 +232,7 @@ module Sockudo
     def authenticate(socket_id, custom_data = nil)
       custom_data = MultiJson.encode(custom_data) if custom_data
       auth = authentication_string(socket_id, custom_data)
-      r = {:auth => auth}
+      r = { auth: auth }
       r[:channel_data] = custom_data if custom_data
       r
     end
@@ -167,13 +241,11 @@ module Sockudo
       return unless encryption_master_key
 
       secret_string = @name + encryption_master_key
-      digest = OpenSSL::Digest::SHA256.new
+      digest = OpenSSL::Digest.new('SHA256')
       digest << secret_string
       digest.digest
     end
 
-    private
-
     include Sockudo::Utils
   end
 end