skyfall 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce06b8a7ef3783cd255621d6868a737735b782999a8cab76b70cf1f869e2cd1d
-  data.tar.gz: 9edea42903a17cb83ee717ea92c81e9a853b530a24f0bc803f70835b3bed1ba2
+  metadata.gz: 6e7396b9d5f8de50025ea41e80b17578607e40aab7bfce17ffd948aa428cdd0f
+  data.tar.gz: 8915e1d9cc0169c9c8bf0c3995f92fd36a14a49cab846c876a766afd92e31ab1
 SHA512:
-  metadata.gz: 1b04bb91b734fe84d984af3c6a8c78959230d5ef865109882d86c5f0b2537f0a8b25678dcace7f5d8c26e560f871edba4de07f38273e2e7cf17088fd125a08e2
-  data.tar.gz: 5dffcf8a308789995d16293a9b8caba848374ab80c147a0ef87f440cb2c98887b4d81f3eb447d74c2bfc608ae448b54d9ada90556eb6e55cf59cc1df37e15390
+  metadata.gz: 7fb7381a4fd818a6a9e956107dadb51e0a519898eb6b19f94d28cf3c41d2a25775460aace039b2b4713105e46ec5fef9bf9e5595a0170642f3d6cc59da56ca3f
+  data.tar.gz: db58dc53caacf3eda013732b9324bd03be5b93445500beac2b035d5e15273dd6f2f7b59f05887f3dab8518a95809126f31d7a6c79eac9c6760d268fc11cc5a19

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.2.2] - 2023-09-06
+
+- fixed image CIDs returned in the record JSON as CBOR tag objects (they are now returned decoded to the string form)
+
+## [0.2.1] - 2023-08-19
+
+- optimized `WebsocketMessage` parsing performance - lazy parsing of most properties (message decoding should be over 50% faster on average)
+- added separate subclasses of `WebsocketMessage` for different message types
+- added support for `#handle`, `#info` and `#tombstone` message types
+- `UnknownMessage` is returned for unrecognized message types
+
 ## [0.2.0] - 2023-07-24
 
 - switched the websocket library from `websocket-client-simple` to `faye-websocket`, which should make event parsing up to ~30× faster (!)

data/lib/skyfall/car_archive.rb

@@ -31,9 +31,39 @@ module Skyfall
       read_section(buffer) until buffer.eof?
     end
 
+    def section_with_cid(cid)
+      section = @sections.detect { |s| s.cid == cid }
+
+      if section
+        convert_cids(section.body)
+        section.body
+      end
+    end
 
     private
 
+    def convert_cids(object)
+      if object.is_a?(Hash)
+        object.each do |k, v|
+          if v.is_a?(Hash) || v.is_a?(Array)
+            convert_cids(v)
+          elsif v.is_a?(CBOR::Tagged)
+            object[k] = CID.from_cbor_tag(v)
+          end
+        end
+      elsif object.is_a?(Array)
+        object.each_with_index do |v, i|
+          if v.is_a?(Hash) || v.is_a?(Array)
+            convert_cids(v)
+          elsif v.is_a?(CBOR::Tagged)
+            object[i] = CID.from_cbor_tag(v)
+          end
+        end
+      else
+        raise DecodeError, "Unexpected value type in record: #{object}"
+      end
+    end
+
     def read_header(buffer)
       len = buffer.read_varint
 

data/lib/skyfall/messages/commit_message.rb

@@ -0,0 +1,23 @@
+require_relative '../car_archive'
+require_relative '../cid'
+require_relative '../operation'
+
+module Skyfall
+  class CommitMessage < WebsocketMessage
+    def commit
+      @commit ||= @data_object['commit'] && CID.from_cbor_tag(@data_object['commit'])
+    end
+
+    def prev
+      @prev ||= @data_object['prev'] && CID.from_cbor_tag(@data_object['prev'])
+    end
+
+    def blocks
+      @blocks ||= CarArchive.new(@data_object['blocks'])
+    end
+
+    def operations
+      @operations ||= @data_object['ops'].map { |op| Operation.new(self, op) }
+    end
+  end
+end

data/lib/skyfall/messages/handle_message.rb

@@ -0,0 +1,7 @@
+module Skyfall
+  class HandleMessage < WebsocketMessage
+    def handle
+      @data_object['handle']
+    end
+  end
+end

data/lib/skyfall/messages/info_message.rb

@@ -0,0 +1,22 @@
+module Skyfall
+  class InfoMessage < WebsocketMessage
+    attr_reader :name, :message
+
+    OUTDATED_CURSOR = "OutdatedCursor"
+
+    def initialize(type_object, data_object)
+      super
+
+      @name = @data_object['name']
+      @message = @data_object['message']
+    end
+
+    def to_s
+      (@name || "InfoMessage") + (@message ? ": #{@message}" : "")
+    end
+
+    def inspectable_variables
+      super - [:@did, :@seq]
+    end
+  end
+end

data/lib/skyfall/messages/tombstone_message.rb

@@ -0,0 +1,4 @@
+module Skyfall
+  class TombstoneMessage < WebsocketMessage
+  end
+end

data/lib/skyfall/messages/unknown_message.rb

@@ -0,0 +1,4 @@
+module Skyfall
+  class UnknownMessage < WebsocketMessage
+  end
+end

data/lib/skyfall/messages/websocket_message.rb

@@ -0,0 +1,90 @@
+require_relative '../errors'
+require_relative '../extensions'
+
+require 'cbor'
+require 'time'
+
+module Skyfall
+  class WebsocketMessage
+    using Skyfall::Extensions
+
+    require_relative 'commit_message'
+    require_relative 'handle_message'
+    require_relative 'info_message'
+    require_relative 'tombstone_message'
+    require_relative 'unknown_message'
+
+    attr_reader :type_object, :data_object
+    attr_reader :type, :did, :seq
+
+    alias repo did
+
+    def self.new(data)
+      type_object, data_object = decode_cbor_objects(data)
+
+      message_class = case type_object['t']
+        when '#commit' then CommitMessage
+        when '#handle' then HandleMessage
+        when '#info' then InfoMessage
+        when '#tombstone' then TombstoneMessage
+        else UnknownMessage
+      end
+
+      message = message_class.allocate
+      message.send(:initialize, type_object, data_object)
+      message
+    end
+
+    def initialize(type_object, data_object)
+      @type_object = type_object
+      @data_object = data_object
+
+      @type = @type_object['t'][1..-1].to_sym
+      @did = @data_object['repo'] || @data_object['did']
+      @seq = @data_object['seq']
+    end
+
+    def operations
+      []
+    end
+
+    def time
+      @time ||= @data_object['time'] && Time.parse(@data_object['time'])
+    end
+
+    def inspectable_variables
+      instance_variables - [:@type_object, :@data_object, :@blocks]
+    end
+
+    def inspect
+      vars = inspectable_variables.map { |v| "#{v}=#{instance_variable_get(v).inspect}" }.join(", ")
+      "#<#{self.class}:0x#{object_id} #{vars}>"
+    end
+
+    private
+
+    def self.decode_cbor_objects(data)
+      objects = CBOR.decode_sequence(data)
+
+      if objects.length < 2
+        raise DecodeError.new("Malformed message: #{objects.inspect}")
+      elsif objects.length > 2
+        raise DecodeError.new("Invalid number of objects: #{objects.length}")
+      end
+
+      type, data = objects
+
+      if data['error']
+        raise SubscriptionError.new(data['error'], data['message'])
+      end
+
+      raise DecodeError.new("Invalid object type: #{type}") unless type.is_a?(Hash)
+      raise UnsupportedError.new("Unexpected CBOR object: #{type}") unless type['op'] == 1
+      raise DecodeError.new("Missing data: #{type} #{objects.inspect}") unless type['op'] && type['t']
+      raise DecodeError.new("Invalid message type: #{type['t']}") unless type['t'].start_with?('#')
+      raise DecodeError.new("Invalid object type: #{data}") unless data.is_a?(Hash)
+
+      [type, data]
+    end
+  end
+end

data/lib/skyfall/operation.rb

@@ -2,30 +2,41 @@ require_relative 'collection'
 
 module Skyfall
   class Operation
-    attr_reader :repo, :path, :action, :cid
+    def initialize(message, json)
+      @message = message
+      @json = json
+    end
 
-    def initialize(repo, path, action, cid, record)
-      @repo = repo
-      @path = path
-      @action = action.to_sym
-      @cid = cid
-      @record = record
+    def repo
+      @message.repo
     end
 
-    def raw_record
-      @record
+    def path
+      @json['path']
     end
 
-    def uri
-      "at://#{repo}/#{path}"
+    def action
+      @json['action'].to_sym
     end
 
     def collection
-      path.split('/')[0]
+      @json['path'].split('/')[0]
     end
 
     def rkey
-      path.split('/')[1]
+      @json['path'].split('/')[1]
+    end
+
+    def uri
+      "at://#{repo}/#{path}"
+    end
+
+    def cid
+      @cid ||= @json['cid'] && CID.from_cbor_tag(@json['cid'])
+    end
+
+    def raw_record
+      @raw_record ||= cid && @message.blocks.section_with_cid(cid)
     end
 
     def type

data/lib/skyfall/stream.rb

@@ -1,4 +1,4 @@
-require_relative 'websocket_message'
+require_relative 'messages/websocket_message'
 
 require 'eventmachine'
 require 'faye/websocket'

data/lib/skyfall/version.rb

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

data/lib/skyfall.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 require_relative 'skyfall/stream'
-require_relative 'skyfall/websocket_message'
+require_relative 'skyfall/messages/websocket_message'
 require_relative 'skyfall/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
@@ -86,10 +86,15 @@ files:
 - lib/skyfall/collection.rb
 - lib/skyfall/errors.rb
 - lib/skyfall/extensions.rb
+- lib/skyfall/messages/commit_message.rb
+- lib/skyfall/messages/handle_message.rb
+- lib/skyfall/messages/info_message.rb
+- lib/skyfall/messages/tombstone_message.rb
+- lib/skyfall/messages/unknown_message.rb
+- lib/skyfall/messages/websocket_message.rb
 - lib/skyfall/operation.rb
 - lib/skyfall/stream.rb
 - lib/skyfall/version.rb
-- lib/skyfall/websocket_message.rb
 - sig/skyfall.rbs
 homepage: https://github.com/mackuba/skyfall
 licenses:

data/lib/skyfall/websocket_message.rb

@@ -1,77 +0,0 @@
-require_relative 'car_archive'
-require_relative 'cid'
-require_relative 'errors'
-require_relative 'extensions'
-require_relative 'operation'
-
-require 'cbor'
-require 'time'
-
-module Skyfall
-  class WebsocketMessage
-    using Skyfall::Extensions
-
-    attr_reader :type_object, :data_object
-    attr_reader :type, :repo, :time, :seq, :commit, :prev, :blocks, :operations
-
-    def initialize(data)
-      @type_object, @data_object = decode_cbor_objects(data)
-
-      @type = @type_object['t'][1..-1].to_sym
-      @operations = []
-
-      @repo = @data_object['repo']
-      @time = Time.parse(@data_object['time'])
-      @seq = @data_object['seq']
-
-      return unless @type == :commit
-
-      @commit = @data_object['commit'] && CID.from_cbor_tag(@data_object['commit'])
-      @prev = @data_object['prev'] && CID.from_cbor_tag(@data_object['prev'])
-
-      @blocks = CarArchive.new(@data_object['blocks'])
-
-      @operations = @data_object['ops'].map { |op|
-        cid = op['cid'] && CID.from_cbor_tag(op['cid'])
-        path = op['path']
-        action = op['action']
-        record = cid && @blocks.sections.detect { |s| s.cid == cid }.body
-
-        Operation.new(@repo, path, action, cid, record)
-      }
-    end
-
-    def inspect
-      keys = instance_variables - [:@type_object, :@data_object, :@blocks]
-      vars = keys.map { |v| "#{v}=#{instance_variable_get(v).inspect}" }.join(", ")
-      "#<#{self.class}:0x#{object_id} #{vars}>"
-    end
-
-    private
-
-    def decode_cbor_objects(data)
-      objects = CBOR.decode_sequence(data)
-
-      if objects.length < 2
-        raise DecodeError.new("Malformed message: #{objects.inspect}")
-      elsif objects.length > 2
-        raise DecodeError.new("Invalid number of objects: #{objects.length}")
-      end
-
-      type_object, data_object = objects
-
-      if data_object['error']
-        raise SubscriptionError.new(data_object['error'], data_object['message'])
-      end
-
-      raise DecodeError.new("Invalid object type: #{type_object}") unless type_object.is_a?(Hash)
-      raise UnsupportedError.new("Unexpected CBOR object: #{type_object}") unless type_object['op'] == 1
-      raise DecodeError.new("Missing data: #{type_object} #{objects.inspect}") unless type_object['op'] && type_object['t']
-      raise DecodeError.new("Invalid message type: #{type_object['t']}") unless type_object['t'].start_with?('#')
-
-      raise DecodeError.new("Invalid object type: #{data_object}") unless data_object.is_a?(Hash)
-
-      [type_object, data_object]
-    end
-  end
-end