skyfall 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 677e5fd4ee93debfd3495c7c3504642c603eeda97ddba4273d1848d3240892f6
+  data.tar.gz: 0db72ec396022df1fb970a614bf217c2f20a04d843e6558eabc39dd74ddb8979
+SHA512:
+  metadata.gz: dc9c6ea0447c1f4310c1772ee093e88f98666ee925f6b81219c60b09a8a761f6c05a9a56449af57d270109148c3fd1a4d1420ceb8cd9a39f27d74d21c430e9cf
+  data.tar.gz: db9097d342156c20e043b59da778fc11cb2d9281fa2c3c432744b6b4fa81e0a505dda6a4670357bdbfb435f87e7436a77fb80953a74bb0c40a7a3df457a5259e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-31
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in skyfall.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    skyfall (0.1.0)
+      base32 (>= 0.3.4)
+      cbor (>= 0.5.9.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base32 (0.3.4)
+    cbor (0.5.9.6)
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  skyfall!
+
+BUNDLED WITH
+   2.4.13

data/MIT-LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kuba Suder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Skyfall
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/skyfall`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/skyfall.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/skyfall/car_archive.rb

@@ -0,0 +1,81 @@
+require_relative 'cid'
+require_relative 'errors'
+require_relative 'extensions'
+
+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, :body
+
+    def initialize(cid, body)
+      @cid = cid
+      @body = body
+    end
+  end
+
+  class CarArchive
+    using Skyfall::Extensions
+
+    attr_reader :roots, :sections
+
+    def initialize(data)
+      @sections = []
+
+      buffer = StringIO.new(data)
+      read_header(buffer)
+      read_section(buffer) until buffer.eof?
+    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
+      body = CBOR.decode(body_data)
+
+      @sections << CarSection.new(cid, body)
+    end
+  end
+end

data/lib/skyfall/cid.rb

@@ -0,0 +1,35 @@
+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 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/collection.rb

@@ -0,0 +1,11 @@
+module Skyfall
+  module Collection
+    BSKY_POST = "app.bsky.feed.post"
+    BSKY_LIKE = "app.bsky.feed.like"
+    BSKY_FOLLOW = "app.bsky.graph.follow"
+    BSKY_REPOST = "app.bsky.feed.repost"
+    BSKY_BLOCK = "app.bsky.graph.block"
+    BSKY_PROFILE = "app.bsky.actor.profile"
+    BSKY_LISTITEM = "app.bsky.graph.listitem"
+  end
+end

data/lib/skyfall/errors.rb

@@ -0,0 +1,7 @@
+module Skyfall
+  class DecodeError < StandardError
+  end
+
+  class UnsupportedError < StandardError
+  end
+end

data/lib/skyfall/extensions.rb

@@ -0,0 +1,32 @@
+require 'cbor'
+require 'stringio'
+
+module Skyfall
+  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

data/lib/skyfall/operation.rb

@@ -0,0 +1,36 @@
+require_relative 'collection'
+
+module Skyfall
+  class Operation
+    attr_reader :repo, :path, :action, :cid, :record
+
+    def initialize(repo, path, action, cid, record)
+      @repo = repo
+      @path = path
+      @action = action.to_sym
+      @cid = cid
+      @record = record
+    end
+
+    def uri
+      "at://#{repo}/#{path}"
+    end
+
+    def collection
+      path.split('/').first
+    end
+
+    def type
+      case collection
+      when Collection::BSKY_POST then :bsky_post
+      when Collection::BSKY_LIKE then :bsky_like
+      when Collection::BSKY_FOLLOW then :bsky_follow
+      when Collection::BSKY_REPOST then :bsky_repost
+      when Collection::BSKY_BLOCK then :bsky_block
+      when Collection::BSKY_PROFILE then :bsky_profile
+      when Collection::BSKY_LISTITEM then :bsky_listitem
+      else :unknown
+      end
+    end
+  end
+end

data/lib/skyfall/version.rb

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

data/lib/skyfall/websocket_message.rb

@@ -0,0 +1,48 @@
+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, :repo, :time, :seq, :commit, :blocks, :operations
+
+    def initialize(data)
+      objects = CBOR.decode_sequence(data)
+      raise DecodeError.new("Invalid number of objects: #{objects.length}") unless objects.length == 2
+
+      @type_object, @data_object = objects
+      raise DecodeError.new("Invalid object type: #{@type_object}") unless @type_object.is_a?(Hash)
+      raise DecodeError.new("Invalid object type: #{@data_object}") unless @data_object.is_a?(Hash)
+      raise DecodeError.new("Missing data: #{@type_object}") unless @type_object['op'] && @type_object['t']
+      raise DecodeError.new("Invalid message type: #{@type_object['t']}") unless @type_object['t'].start_with?('#')
+      raise UnsupportedError.new("Unexpected CBOR object: #{@type_object}") unless @type_object['op'] == 1
+
+      @type = @type_object['t'][1..-1].to_sym
+
+      @repo = @data_object['repo']
+      @time = Time.parse(@data_object['time'])
+      @seq = @data_object['seq']
+
+      return unless @type == :commit
+
+      @commit = CID.from_cbor_tag(@data_object['commit'])
+      @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
+  end
+end

data/lib/skyfall.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'skyfall/websocket_message'
+require_relative 'skyfall/version'

data/sig/skyfall.rbs

@@ -0,0 +1,4 @@
+module Skyfall
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/skyfall.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/skyfall/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "skyfall"
+  spec.version = Skyfall::VERSION
+  spec.authors = ["Kuba Suder"]
+  spec.email = ["jakub.suder@gmail.com"]
+
+  spec.summary = "A Ruby gem for streaming data from the Bluesky/AtProto firehose"
+  spec.homepage = "https://github.com/mackuba/skyfall"
+
+  # spec.description = "TODO: Write a longer description or delete this line."
+
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'cbor', '>= 0.5.9.6'
+  spec.add_dependency 'base32', '>= 0.3.4'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: skyfall
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kuba Suder
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.9.6
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+description:
+email:
+- jakub.suder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- lib/skyfall.rb
+- lib/skyfall/car_archive.rb
+- lib/skyfall/cid.rb
+- lib/skyfall/collection.rb
+- lib/skyfall/errors.rb
+- lib/skyfall/extensions.rb
+- lib/skyfall/operation.rb
+- lib/skyfall/version.rb
+- lib/skyfall/websocket_message.rb
+- sig/skyfall.rbs
+- skyfall.gemspec
+homepage: https://github.com/mackuba/skyfall
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby gem for streaming data from the Bluesky/AtProto firehose
+test_files: []