skyfall 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3e987d12df25109508c0f673894e9a334a81d60d02f57c118e699de5e68dc4d
-  data.tar.gz: 152dfdced7c5fc6414f8cbf04d7cff6d184c592a0ed42463f0b156b373c8c8ac
+  metadata.gz: c52f2f3c63530b1e032666c7bfb71ba0b0279bfe0128c7432b8e267f1e2f9e95
+  data.tar.gz: 1c7e2e5cac7ec4f421be5c291a311dede53221150901a44418f01f7a6cdeae9e
 SHA512:
-  metadata.gz: 59c9da3c3d60b953f3963c16a86c56bb9e75561696ea47d0b8ce5a3274c00a8d831529f22aacace27df0d1dba55b5dc7db58301f1baa7aa19528756d77eb7ccd
-  data.tar.gz: 0575c825184297417f40a5f7248e2560fc24f19913631c23371b1f535feea3d3b38b62b76c0a4c610dafc2e52783ba58521eaf1f3407aa59699d26640fb0f94c
+  metadata.gz: 1eb9556cbc363f6a9c2ae42d27dc9a4471a24f8e08f0b1b8046c131fe320b63de73498d839367f0fd89c3841b27877c53bc0a937b9eeed41ea486f05b55a38c3
+  data.tar.gz: 9b61caf5cc63834efd8185622c435a9102b4a310f890a988fd029e9e691e80acf7527e0afc5e5fecde967c4f2de538559168d07a72a2af4dd9d5ef06cc16ab50

data/CHANGELOG.md

@@ -1,6 +1,11 @@
+## [0.7.1] - 2026-08-05
+
+- extracted `CID` and `CarArchive` to a new gem "oxygene"
+- added `CommitMessage#cid` as alias of `#commit`
+
 ## [0.7.0] - 2026-02-13
 
-The main change in this version is that inline YARD documentation has been added. This was also a good opportunity to review some APIs and tweak some things in order to get Skyfall a bit closer to 1.0.
+The main change in this version is that inline [YARD documentation](https://rubydoc.info/gems/skyfall/) has been added. This was also a good opportunity to review some APIs and tweak some things in order to get Skyfall a bit closer to 1.0.
 
 New APIs:
 

data/README.md

@@ -1,5 +1,7 @@
 # Skyfall
 
+[![Gem Version](https://badge.fury.io/rb/skyfall.svg?icon=si%3Arubygems&icon_color=%23ff6251)](https://rubygems.org/gems/skyfall) [![YARD Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/gems/skyfall)
+
 A Ruby gem for streaming data from the Bluesky/ATProto firehose 🦋
 
 > [!NOTE]
@@ -15,7 +17,7 @@ Since version 0.5, Skyfall also supports connecting to [Jetstream](https://githu
 
 ## Installation
 
-To use Skyfall, you need a reasonably new version of Ruby – it should run on Ruby 2.6 and above, although it's recommended to use a version that's still getting maintainance updates, i.e. currently 3.2+. A compatible version should be preinstalled on macOS Big Sur and above and on many Linux systems. Otherwise, you can install one using tools such as [RVM](https://rvm.io), [asdf](https://asdf-vm.com), [ruby-install](https://github.com/postmodern/ruby-install) or [ruby-build](https://github.com/rbenv/ruby-build), or `rpm` or `apt-get` on Linux (see more installation options on [ruby-lang.org](https://www.ruby-lang.org/en/downloads/)).
+To use Skyfall, you need a reasonably new version of Ruby – it should run on Ruby 2.6 and above, although it's recommended to use a version that's still getting maintainance updates, i.e. currently 3.3+. A compatible version should be preinstalled on macOS Big Sur and above and on many Linux systems. Otherwise, you can install one using tools such as [RVM](https://rvm.io), [asdf](https://asdf-vm.com), [ruby-install](https://github.com/postmodern/ruby-install) or [ruby-build](https://github.com/rbenv/ruby-build), or `rpm` or `apt-get` on Linux (see more installation options on [ruby-lang.org](https://www.ruby-lang.org/en/downloads/)).
 
 To install the gem, run the command:
 
@@ -38,7 +40,7 @@ require 'skyfall'
 sky = Skyfall::Firehose.new('bsky.network', :subscribe_repos)
 ```
 
-The server name can be just a hostname, or a full URL with a `ws:` or `wss:` scheme, which is useful if you want to use a non-encrypted websocket connection, e.g. `"ws://localhost:8000"`. The endpoint can be either a full NSID string like `"com.atproto.sync.subscribeRepos"`, or one of the defined symbol shortcuts - you will almost always want to pass `:subscribe_repos` here.
+The server name can be just a hostname, or a full URL with a `ws:` or `wss:` scheme, which is useful if you want to use a non-encrypted websocket connection, e.g. `"ws://localhost:8000"`. The endpoint can be either a full NSID string like `"com.atproto.sync.subscribeRepos"`, or one of the defined symbol shortcuts – you will almost always want to pass `:subscribe_repos` here.
 
 Next, set up event listeners to handle incoming messages and get notified of errors. Here are all the available listeners (you will need at least either `on_message` or `on_raw_message`):
 
@@ -60,7 +62,7 @@ sky.on_timeout { puts "Connection stalled, triggering a reconnect..." }
 sky.on_error { |e| puts "ERROR: #{e}" }
 ```
 
-You can also call these as setters accepting a `Proc` - e.g. to disable default error handling, you can do:
+You can also call these as setters accepting a `Proc` – e.g. to disable default error handling, you can do:
 
 ```rb
 sky.on_error = nil
@@ -94,7 +96,7 @@ sky.connect
 
 ### Cursors
 
-ATProto websocket endpoints implement a "*cursor*" feature to help you make sure that you don't miss anything if your connection is down for a bit (because of a network issue, server restart, deploy etc.). Each message includes a `seq` field, which is the sequence number of the event. You can keep track of the last seq you've seen, and when you reconnect, you pass that number as a cursor parameter - the server will then "replay" all events you might have missed since that last one. (The `bsky.network` Relay firehose currently has a buffer of about 72 hours, though that's not something required by specification.)
+ATProto websocket endpoints implement a "*cursor*" feature to help you make sure that you don't miss anything if your connection is down for a bit (because of a network issue, server restart, deploy etc.). Each message includes a `seq` field, which is the sequence number of the event. You can keep track of the last seq you've seen, and when you reconnect, you pass that number as a cursor parameter – the server will then "replay" all events you might have missed since that last one. (The `bsky.network` Relay firehose currently has a buffer of about 72 hours, though that's not something required by specification.)
 
 To use a cursor when connecting to the firehose, pass it as the third parameter to `Skyfall::Firehose`. You should then regularly save the `seq` of the last event to some permanent storage, and then load it from there when reconnecting.
 
@@ -127,57 +129,57 @@ end
 
 Each message passed to `on_message` is an instance of a subclass of either `Skyfall::Firehose::Message` or `Skyfall::Jetstream::Message`, depending on the selected source. The supported message types are:
 
-- `CommitMessage` (`#commit`) - represents a change in a user's repo; most messages are of this type
-- `IdentityMessage` (`#identity`) - notifies about a change in user's DID document, e.g. a handle change or a migration to a new PDS
-- `AccountMessage` (`#account`) - notifies about a change of an account's status (de/activation, suspension, deletion)
-- `SyncMessage` (`#sync`) - updates repository state, can be used to trigger account resynchronization
-- `LabelsMessage` (`#labels`) - only used in `subscribe_labels` endpoint
-- `InfoMessage` (`#info`) - a protocol error message, e.g. about an invalid cursor parameter
+- `CommitMessage` (`#commit`) – represents a change in a user's repo; most messages are of this type
+- `IdentityMessage` (`#identity`) – notifies about a change in user's DID document, e.g. a handle change or a migration to a new PDS
+- `AccountMessage` (`#account`) – notifies about a change of an account's status (de/activation, suspension, deletion)
+- `SyncMessage` (`#sync`) – updates repository state, can be used to trigger account resynchronization
+- `LabelsMessage` (`#labels`) – only used in `subscribe_labels` endpoint
+- `InfoMessage` (`#info`) – a protocol error message, e.g. about an invalid cursor parameter
 - `UnknownMessage` is used for other unrecognized message types
 
 `Skyfall::Firehose::Message` and `Skyfall::Jetstream::Message` variants of message classes should have more or less the same interface, except when a given field is not included in one of the formats.
 
 All message objects have the following shared properties:
 
-- `type` (symbol) - the message type identifier, e.g. `:commit`
-- `seq` (integer) - a sequential index of the message; Jetstream messages instead have a `time_us` value, which is a Unix timestamp in microseconds (also aliased as `seq` for compatibility)
-- `repo` or `did` (string) - DID of the repository (user account)
-- `time` (Time) - timestamp of the described action
+- `type` (symbol) – the message type identifier, e.g. `:commit`
+- `seq` (integer) – a sequential index of the message; Jetstream messages instead have a `time_us` value, which is a Unix timestamp in microseconds (also aliased as `seq` for compatibility)
+- `repo` or `did` (string) – DID of the repository (user account)
+- `time` (Time) – timestamp of the described action
 
 All properties except `type` may be nil for some message types that aren't related to a specific user, like `#info`.
 
 Commit messages additionally have:
 
-- `commit` - CID of the commit
-- `operations` - list of operations (usually one)
+- `commit` – CID of the commit
+- `operations` – list of operations (usually one)
 
 Handle and Identity messages additionally have:
 
-- `handle` - the new handle assigned to the DID
+- `handle` – the new handle assigned to the DID
 
 Account messages additionally have:
 
-- `active?` - whether the account is active, or inactive for any reason
-- `status` - if not active, shows the status of the account (`:deactivated`, `:deleted`, `:takendown`)
+- `active?` – whether the account is active, or inactive for any reason
+- `status` – if not active, shows the status of the account (`:deactivated`, `:deleted`, `:takendown`)
 
 Info messages additionally have:
 
-- `name` - identifier of the message/error
-- `message` - a human-readable description
+- `name` – identifier of the message/error
+- `message` – a human-readable description
 
 
 ### Commit operations
 
 Operations are objects of type `Skyfall::Firehose::Operation` or `Skyfall::Jetstream::Operation` and have such properties:
 
-- `repo` or `did` (string) - DID of the repository (user account)
-- `collection` (string) - name of the relevant collection in the repository, e.g. `app.bsky.feed.post` for posts
-- `type` (symbol) - short name of the collection, e.g. `:bsky_post`
-- `rkey` (string) - identifier of a record in a collection
-- `path` (string) - the path part of the at:// URI - collection name + ID (rkey) of the item
-- `uri` (string) - the complete at:// URI
-- `action` (symbol) - `:create`, `:update` or `:delete`
-- `cid` (CID) - CID of the operation/record (`nil` for delete operations)
+- `repo` or `did` (string) – DID of the repository (user account)
+- `collection` (string) – name of the relevant collection in the repository, e.g. `app.bsky.feed.post` for posts
+- `type` (symbol) – short name of the collection, e.g. `:bsky_post`
+- `rkey` (string) – identifier of a record in a collection
+- `path` (string) – the path part of the at:// URI – collection name + ID (rkey) of the item
+- `uri` (string) – the complete at:// URI
+- `action` (symbol) – `:create`, `:update` or `:delete`
+- `cid` (CID) – CID of the operation/record (`nil` for delete operations)
 
 Create and update operations will also have an attached record (JSON object) with details of the post, like etc. The record data is currently available as a Ruby hash via `raw_record` property (custom types will be added in future).
 
@@ -206,7 +208,7 @@ Note that the `Operation` objects have two properties that tell you the kind of
 
 When Skyfall receives a message about a record type that's not on the list, whether in the `app.bsky` namespace or not, the operation `type` will be `:unknown`, while the `collection` will be the original string. So if an app like e.g. "Skygram" appears with a `zz.skygram.*` namespace that lets you share photos on ATProto, the operations will have a type `:unknown` and collection names like `zz.skygram.feed.photo`, and you can check the `collection` field for record types known to you and process them in some appropriate way, even if Skyfall doesn't recognize the record type.
 
-Do not however check if such operations have a `type` equal to `:unknown` first - just ignore the type and only check the `collection` string. The reason is that some next version of Skyfall might start recognizing those records and add a new `type` value for them like e.g. `:skygram_photo`, and then they won't match your condition anymore.
+Do not however check if such operations have a `type` equal to `:unknown` first – just ignore the type and only check the `collection` string. The reason is that some next version of Skyfall might start recognizing those records and add a new `type` value for them like e.g. `:skygram_photo`, and then they won't match your condition anymore.
 
 
 ## Reconnection logic
@@ -260,7 +262,7 @@ sky.on_message do |msg|
 end
 ```
 
-See [ATProto label docs](https://atproto.com/specs/label) for info on what fields are included with each label - `Skyfall::Label` includes properties with these original names, and also more friendly aliases for each (e.g. `value` instead of `val`).
+See [ATProto label docs](https://atproto.com/specs/label) for info on what fields are included with each label – `Skyfall::Label` includes properties with these original names, and also more friendly aliases for each (e.g. `value` instead of `val`).
 
 
 ## Other configuration
@@ -302,6 +304,13 @@ See [Jetstream docs](https://github.com/bluesky-social/jetstream?tab=readme-ov-f
 > The `compress` and `requireHello` options (and zstd compression) are not available at the moment. Also the "subscriber sourced messages" aren't implemented yet.
 
 
+## Other resources
+
+- [YARD API documentation](https://rubydoc.info/gems/skyfall) at rubydoc.info
+- [ruby.sdk.blue](https://ruby.sdk.blue)
+- [Example scripts](https://ruby.sdk.blue/examples/)
+- [bluesky-feeds-rb](https://tangled.org/mackuba.eu/bluesky-feeds-rb) – feed generator template project
+
 ## Credits
 
 Copyright © 2026 Kuba Suder ([@mackuba.eu](https://bsky.app/profile/did:plc:oio4hkxaop4ao4wz2pp3f4cr)).

data/lib/skyfall/firehose/commit_message.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../car_archive'
-require_relative '../cid'
 require_relative '../firehose'
 require_relative 'message'
 require_relative 'operation'
+require 'oxygene'
 
 module Skyfall
 
@@ -39,19 +38,21 @@ module Skyfall
       @data_object['since']
     end
 
-    # @return [CID, nil] CID (Content Identifier) of data of the previous commit in the repo
+    # @return [Oxygene::CID, nil] CID (Content Identifier) of data of the previous commit in the repo
     def prev_data
-      @prev_data ||= CID.from_cbor_tag(@data_object['prevData'])
+      @prev_data ||= Oxygene::CID.from_cbor_tag(@data_object['prevData'])
     end
 
-    # @return [CID] CID (Content Identifier) of the commit
+    # @return [Oxygene::CID] CID (Content Identifier) of the commit
     def commit
-      @commit ||= CID.from_cbor_tag(@data_object['commit'])
+      @commit ||= Oxygene::CID.from_cbor_tag(@data_object['commit'])
     end
 
-    # @return [Skyfall::CarArchive] commit data in the form of a parsed CAR archive
+    alias cid commit
+
+    # @return [Oxygene::CARArchive] commit data in the form of a parsed CAR archive
     def blocks
-      @blocks ||= CarArchive.new(@data_object['blocks'])
+      @blocks ||= Oxygene::CARArchive.new(@data_object['blocks'])
     end
 
     # @return [Array<Firehose::Operation>] record operations (usually one) included in the commit

data/lib/skyfall/firehose/message.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative '../errors'
-require_relative '../extensions'
 require_relative '../firehose'
 
 require 'cbor'
+require 'oxygene'
 require 'time'
 
 module Skyfall
@@ -24,7 +24,7 @@ module Skyfall
   # the {Skyfall::Stream#on_raw_message} event handler.
 
   class Firehose::Message
-    using Skyfall::Extensions
+    using Oxygene::Extensions
 
     # Type of the message (e.g. `:commit`, `:identity` etc.)
     # @return [Symbol]

data/lib/skyfall/firehose/operation.rb

@@ -2,6 +2,7 @@
 
 require_relative '../collection'
 require_relative '../firehose'
+require 'oxygene'
 
 module Skyfall
 
@@ -73,9 +74,9 @@ module Skyfall
       "at://#{repo}/#{@json['path']}"
     end
 
-    # @return [CID, nil] CID (Content Identifier) of the record (nil for delete operations)
+    # @return [Oxygene::CID, nil] CID (Content Identifier) of the record (nil for delete operations)
     def cid
-      @cid ||= @json['cid'] && CID.from_cbor_tag(@json['cid'])
+      @cid ||= @json['cid'] && Oxygene::CID.from_cbor_tag(@json['cid'])
     end
 
     # @return [Hash, nil] record data as a plain Ruby Hash (nil for delete operations)

data/lib/skyfall/firehose/sync_message.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../car_archive'
 require_relative '../firehose'
 require_relative 'message'
+require 'oxygene'
 
 module Skyfall
 
@@ -32,9 +32,9 @@ module Skyfall
       @rev ||= @data_object['rev']
     end
 
-    # @return [Skyfall::CarArchive] commit data in the form of a parsed CAR archive
+    # @return [Oxygene::CARArchive] commit data in the form of a parsed CAR archive
     def blocks
-      @blocks ||= CarArchive.new(@data_object['blocks'])
+      @blocks ||= Oxygene::CARArchive.new(@data_object['blocks'])
     end
   end
 end

data/lib/skyfall/jetstream/operation.rb

@@ -2,6 +2,7 @@
 
 require_relative '../collection'
 require_relative '../jetstream'
+require 'oxygene'
 
 module Skyfall
 
@@ -73,9 +74,9 @@ module Skyfall
       "at://#{repo}/#{collection}/#{rkey}"
     end
 
-    # @return [CID, nil] CID (Content Identifier) of the record (nil for delete operations)
+    # @return [Oxygene::CID, nil] CID (Content Identifier) of the record (nil for delete operations)
     def cid
-      @cid ||= @json['cid'] && CID.from_json(@json['cid'])
+      @cid ||= @json['cid'] && Oxygene::CID.from_json(@json['cid'])
     end
 
     # @return [Hash, nil] record data as a plain Ruby Hash (nil for delete operations)

data/lib/skyfall/label.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'errors'
+require 'oxygene'
 require 'time'
 
 module Skyfall
@@ -60,9 +61,9 @@ module Skyfall
       @data['uri']
     end
 
-    # @return [CID, nil] CID of the specific version of the subject that this label applies to
+    # @return [Oxygene::CID, nil] CID of the specific version of the subject that this label applies to
     def cid
-      @cid ||= @data['cid'] && CID.from_json(@data['cid'])
+      @cid ||= @data['cid'] && Oxygene::CID.from_json(@data['cid'])
     end
 
     # @return [String] label value

data/lib/skyfall/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skyfall
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Kuba Suder
@@ -10,99 +10,60 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: base32
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 1.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.2'
     - - ">="
       - !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'
+        version: 1.2.7
 - !ruby/object:Gem::Dependency
-  name: cbor
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.9.6
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.9.6
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: oxygene
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 0.0.1
   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.12'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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
-  to the\n    websocket endpoint, decodes the messages which are encoded in some binary
-  formats, and returns the data as Ruby\n    objects, which you can filter and save
-  to some kind of database (e.g. in order to create a custom feed).\n  "
+        version: 0.0.1
+description: "\n    Skyfall is a Ruby gem for connecting to the \"firehose\" of the
+  AT Protocol network that Bluesky is built on,\n    i.e. a websocket which streams
+  all new posts and everything else happening on the network in real time. The code\n
+  \   connects to the websocket endpoint, decodes the messages which are encoded in
+  some binary formats, and returns\n    the data as Ruby objects and hashes, which
+  you can filter and save to some kind of database (e.g. in order\n    to create a
+  custom feed).\n  "
 email:
 - jakub.suder@gmail.com
 executables: []
@@ -113,12 +74,9 @@ files:
 - LICENSE.txt
 - README.md
 - lib/skyfall.rb
-- lib/skyfall/car_archive.rb
-- lib/skyfall/cid.rb
 - lib/skyfall/collection.rb
 - lib/skyfall/errors.rb
 - lib/skyfall/events.rb
-- lib/skyfall/extensions.rb
 - lib/skyfall/firehose.rb
 - lib/skyfall/firehose/account_message.rb
 - lib/skyfall/firehose/commit_message.rb
@@ -161,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Ruby gem for streaming data from the Bluesky/ATProto firehose
 test_files: []

data/lib/skyfall/car_archive.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'cid'
-require_relative 'errors'
-require_relative 'extensions'
-
-require 'base64'
-require 'cbor'
-require 'stringio'
-
-# CAR v1: https://ipld.io/specs/transport/car/carv1/
-# multicodec codes: https://github.com/multiformats/multicodec/blob/master/table.csv
-
-module Skyfall
-  class CarSection
-    attr_reader :cid
-
-    def initialize(cid, body_data)
-      @cid = cid
-      @body_data = body_data
-    end
-
-    def body
-      @body ||= CarArchive.convert_data(CBOR.decode(@body_data))
-    end
-  end
-
-  class CarArchive
-    using Skyfall::Extensions
-
-    attr_reader :roots, :sections
-
-    def initialize(data)
-      @sections = []
-      @buffer = StringIO.new(data)
-
-      read_header(@buffer)
-    end
-
-    def section_with_cid(cid)
-      if section = @sections.detect { |s| s.cid == cid }
-        return section.body
-      end
-
-      if @buffer
-        while !@buffer.eof?
-          section = read_section(@buffer)
-          return section.body if section.cid == cid
-        end
-      end
-
-      @buffer = nil
-      nil
-    end
-
-    def sections
-      if @buffer
-        read_section(@buffer) while !@buffer.eof?
-        @buffer = nil
-      end
-
-      @sections
-    end
-
-    def self.convert_data(object)
-      if object.is_a?(Hash)
-        object.each do |k, v|
-          if v.is_a?(Hash) || v.is_a?(Array)
-            convert_data(v)
-          elsif v.is_a?(CBOR::Tagged)
-            object[k] = make_cid_link(v)
-          elsif v.is_a?(String) && v.encoding == Encoding::ASCII_8BIT
-            object[k] = make_bytes(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_data(v)
-          elsif v.is_a?(CBOR::Tagged)
-            object[i] = make_cid_link(v)
-          elsif v.is_a?(String) && v.encoding == Encoding::ASCII_8BIT
-            object[i] = make_bytes(v)
-          end
-        end
-      else
-        raise DecodeError, "Unexpected value type in record: #{object}"
-      end
-    end
-
-    def self.make_cid_link(cid)
-      { '$link' => CID.from_cbor_tag(cid) }
-    end
-
-    def self.make_bytes(data)
-      { '$bytes' => Base64.encode64(data).chomp.gsub(/=+$/, '') }
-    end
-
-    def inspect
-      vars = instance_variables.map { |v|
-        if v == :@sections && @buffer
-          "#{v}=[...]"
-        else
-          "#{v}=#{instance_variable_get(v).inspect}"
-        end
-      }
-
-      "#<#{self.class}:0x#{object_id} #{vars.join(", ")}>"
-    end
-
-    private
-
-    def read_header(buffer)
-      len = buffer.read_varint
-
-      header_data = buffer.read(len)
-      raise DecodeError.new("Header too short: #{header_data}") unless header_data.length == len
-
-      header = CBOR.decode(header_data)
-      raise UnsupportedError.new("Unexpected CAR version: #{header['version']}") unless header['version'] == 1
-      @roots = header['roots'].map { |x| CID.from_cbor_tag(x) }
-    end
-
-    def read_section(buffer)
-      len = buffer.read_varint
-
-      section_data = buffer.read(len)
-      raise DecodeError.new("Section too short: #{section_data}") unless section_data.length == len
-
-      sbuffer = StringIO.new(section_data)
-
-      version = sbuffer.read_varint
-      raise UnsupportedError.new("Unexpected CID version: #{version}") unless version == 1
-
-      codec = sbuffer.read_varint
-      raise UnsupportedError.new("Unexpected CID codec: #{codec}") unless codec == 0x71  # dag-cbor
-
-      hash = sbuffer.read_varint
-      raise UnsupportedError.new("Unexpected CID hash: #{hash}") unless hash == 0x12  # sha2-256
-
-      clen = sbuffer.read_varint
-      raise UnsupportedError.new("Unexpected CID length: #{clen}") unless clen == 32
-
-      prefix = section_data[0...sbuffer.pos]
-
-      cid_data = sbuffer.read(clen)
-      raise DecodeError.new("CID too short: #{cid_data}") unless cid_data.length == clen
-
-      cid = CID.new(prefix + cid_data)
-
-      body_data = sbuffer.read
-      new_section = CarSection.new(cid, body_data)
-
-      @sections << new_section
-      new_section
-    end
-  end
-end

data/lib/skyfall/cid.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'errors'
-
-require 'base32'
-
-# CIDs in DAG-CBOR: https://ipld.io/specs/codecs/dag-cbor/spec/
-# CIDs in JSON: https://ipld.io/specs/codecs/dag-json/spec/
-# multibase: https://github.com/multiformats/multibase
-
-module Skyfall
-  class CID
-    attr_reader :data
-
-    def self.from_cbor_tag(tag)
-      data = tag.value
-      raise DecodeError.new("Unexpected first byte of CID: #{data[0]}") unless data[0] == "\x00"
-      CID.new(data[1..-1])
-    end
-
-    def self.from_json(string)
-      raise DecodeError.new("Unexpected CID length") unless string.length == 59
-      raise DecodeError.new("Unexpected CID prefix") unless string[0] == 'b'
-
-      data = Base32.decode(string[1..-1].upcase)
-      CID.new(data)
-    end
-
-    def initialize(data)
-      @data = data
-    end
-
-    def to_s
-      'b' + Base32.encode(@data).downcase.gsub(/=+$/, '')
-    end
-
-    def inspect
-      "CID(\"#{to_s}\")"
-    end
-
-    def ==(other)
-      other.is_a?(CID) && @data == other.data
-    end
-  end
-end

data/lib/skyfall/extensions.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'cbor'
-require 'stringio'
-
-module Skyfall
-
-  # @private
-  module Extensions
-
-    refine StringIO do
-      # https://en.wikipedia.org/wiki/LEB128
-      def read_varint
-        shift = 1
-        value = 0
-
-        loop do
-          byte = self.readbyte
-          value += byte % 128 * shift
-          break if byte < 128
-          shift *= 128
-        end
-
-        value
-      end
-    end
-
-    refine CBOR.singleton_class do
-      def decode_sequence(data)
-        unpacker = CBOR::Unpacker.new(StringIO.new(data))
-        unpacker.each.to_a
-      end
-    end
-
-  end
-end