urbit-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d45d05923c175955a85dfb0676a63eafc0eed277b656b7d045f8675f586cee7e
-  data.tar.gz: e2bc0d8d71d02629b9b3f335ff1672f20686c178e1584540ff1724943d82158c
+  metadata.gz: a306b64d165415e7a680fd82a20b75de6840ca80d9482be6ceacbd13fd2b4a9f
+  data.tar.gz: 81ce508aee55fd9cdee15bb56774adf5f226b7f5620d9430f4be8de73cb307f9
 SHA512:
-  metadata.gz: 86e48b8bae4f5cedfbe9ca0fcb4ac327185973ce73e29c8a26f7644fadb2e8f78850b9f1cca9d62802d22c45afdeb025b8d495e14d54bf642f123f66f986a1c5
-  data.tar.gz: 20968fc224c1e4fd6105922a4ddc30b16f45f25a12f2c5e4294eaec33f7d379db8180720b062a3d274755853468c7e61af823401ec2a4f5b3e800be3f1de497f
+  metadata.gz: 1cfffd8c6a8f82d701ace0b49266036f17bc481ea75d799d871e7d785899771686d6682a5444a1a20d3b167d7b5415ef4d05b18baa2dc1553000719055b5ca58
+  data.tar.gz: 561e7976cf6d5b5c07e224079e53f6a6102214d317050fd16d1eb5639befb41b020f88ff50b18a94ffda31eaf85515408e5e85bbf38b3610d59e141c02dfb3de

data/lib/urbit/fact/base_fact.rb

@@ -9,8 +9,6 @@ module Urbit
         @channel = channel
         @data = event.data
         @type = event.type
-        # TODO: Remove this debugging once Facts are finalized. DJR 2/3/2022
-        # puts "Received a #{self.class.name.split('::').last} for [#{channel}] -- [#{@type}] -- [#{@data}]"
       end
 
       def add_ack(ack:)

data/lib/urbit/fact/graph_fact.rb

@@ -11,9 +11,7 @@ module Urbit
       # Attach this new fact as a node to its Graph.
       #
       def attach_parser
-        # puts "Received a graph update for [#{self.ship.graph(resource: self.resource)}]"
         if self.incoming_graph
-          # puts "Received an add_graph event: #{self.raw_json} on #{self.resource}"
           self.create_parser
         end
       end
@@ -49,7 +47,7 @@ module Urbit
       end
 
       def create_parser
-        Urbit::AddGraphParser.new(for_graph: incoming_graph,  with_json: self.raw_json).add_nodes
+        Urbit::AddGraphParser.new(for_graph: self.incoming_graph,  with_json: self.raw_json).add_nodes
       end
 
       def raw_json
@@ -63,7 +61,7 @@ module Urbit
       end
 
       def create_parser
-        Urbit::AddNodesParser.new(for_graph: incoming_graph,  with_json: self.raw_json).add_nodes
+        Urbit::AddNodesParser.new(for_graph: self.incoming_graph,  with_json: self.raw_json).add_nodes
       end
 
       def raw_json
@@ -77,7 +75,7 @@ module Urbit
       end
 
       def create_parser
-        Urbit::RemoveGraphParser.new(for_graph: incoming_graph,  with_json: self.raw_json)
+        Urbit::RemoveGraphParser.new(for_graph: self.incoming_graph,  with_json: self.raw_json)
       end
 
       def raw_json

data/lib/urbit/fact/metadata_fact.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../link.rb'
+
+module Urbit
+  module Fact
+    class MetadataUpdateFact < BaseFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        unless self.is_remove
+          self.accept if self.for_this_ship?
+        end
+        # TODO: Remove this debugging once Facts are finalized. DJR 2/3/2022
+        # puts "Received a #{self.class.name.split('::').last} for [#{channel}] -- [#{@type}] -- [#{@data}]"
+      end
+
+      def accept
+        links = self.channel.ship.links
+        if self.add_root.nil?
+          # This is an new incoming Link, add it. If its a dupe, the Links Set will filter it.
+          self.associations.each do |k, v|
+            links << Link.new(chain: links, path: k, data: v)
+          end
+        else
+          g = self.add_root["group"]
+          links << Link.new(chain: links, path: "#{g}/groups#{g}", data: self.add_root)
+        end
+        nil
+      end
+
+      def add_root
+        self.root_h["add"]
+      end
+
+      def associations
+        # An ugly hacks around the fact that when you first join a group there is another
+        # useless "initial-update" enclosing hash.
+        unless (a = self.root_h["associations"])
+          return self.root_h["initial-group"]["associations"]
+        end
+        a
+      end
+
+      def is_remove
+        self.root_h["remove"]
+      end
+
+      def root_h
+        self.contents["json"]["metadata-update"]
+      end
+
+      def to_h
+        super.merge!(resource: self.resource)
+      end
+    end
+  end
+end

data/lib/urbit/fact.rb

@@ -3,6 +3,7 @@
 require_relative 'fact/base_fact'
 require_relative 'fact/graph_fact'
 require_relative 'fact/group_fact'
+require_relative 'fact/metadata_fact'
 require_relative 'fact/settings_fact'
 
 module Urbit
@@ -36,6 +37,10 @@ module Urbit
           return RemoveTagFact.new(channel: channel, event: event)         if c["removeTag"]
         end
 
+        if (c = contents["json"]["metadata-update"])
+          return MetadataUpdateFact.new(channel: channel, event: event) if contents["json"]["metadata-update"]
+        end
+
         if (c = contents["json"]["settings-event"])
           return SettingsEventDelBucketFact.new(channel: channel, event: event) if c["del-bucket"]
           return SettingsEventDelEntryFact.new(channel: channel, event: event)  if c["del-entry"]

data/lib/urbit/graph.rb

@@ -4,12 +4,13 @@ require 'urbit/parser'
 
 module Urbit
   class Graph
-    attr_reader :host_ship_name, :name, :ship
+    attr_reader   :host_ship_name, :name, :ship
 
     def initialize(ship:, graph_name:, host_ship_name:)
       @ship           = ship
-      @name           = graph_name
+      @group          = nil
       @host_ship_name = host_ship_name
+      @name           = graph_name
       @nodes          = SortedSet.new
     end
 
@@ -17,6 +18,28 @@ module Urbit
       @nodes << node unless node.deleted?
     end
 
+    def creator
+      self.fetch_link if @creator.nil?
+      @creator
+    end
+
+    def description
+      self.fetch_link if @description.nil?
+      @description
+    end
+
+    def group
+      if @group.nil?
+        @link = self.fetch_link
+        @group = @link.group unless @link.nil?
+      end
+      @group
+    end
+
+    def group=(a_group)
+      @group = a_group
+    end
+
     def host_ship
       "~#{@host_ship_name}"
     end
@@ -84,6 +107,16 @@ module Urbit
       self.fetch_sibling_nodes(node, :older, count)[0..(count - 1)]
     end
 
+    def title
+      self.fetch_link if @title.nil?
+      @title
+    end
+
+    def type
+      self.fetch_link if @type.nil?
+      @type
+    end
+
     #
     # the canonical printed representation of a Graph
     def to_s
@@ -98,6 +131,15 @@ module Urbit
                        "add-graph")
     end
 
+    def fetch_link
+      @link  = self.ship.links.find_graph(resource: self.resource)
+      @creator     = @link.metadata['creator']
+      @description = @link.metadata['description']
+      @title       = @link.metadata['title']
+      @type        = @link.metadata['config']['graph']
+      @link
+    end
+
     def fetch_newest_nodes(count)
       self.fetch_nodes("#{self.graph_resource}/node/siblings/newest/kith/#{count}/",
                        AddNodesParser,

data/lib/urbit/group.rb

@@ -2,10 +2,11 @@
 
 module Urbit
   class Group
-     attr_accessor :manager, :members, :tags
+     attr_accessor :graphs, :manager, :members, :tags, :title
      attr_reader :hidden, :path, :policy
 
     def initialize(path:, members:, policy:, tags:, hidden:)
+      @graphs  = Set.new
       @hidden  = hidden
       @manager = nil
       @members = Set.new(members)
@@ -22,6 +23,16 @@ module Urbit
       self.path <=> another_group.path
     end
 
+    def creator
+      self.fetch_link if @creator.nil?
+      @creator
+    end
+
+    def description
+      self.fetch_link if @description.nil?
+      @description
+    end
+
     #
     # This is the action labeled as "Archive" in the Landscape UI.
     # As of now, you can only do this to groups on your own ship.
@@ -39,6 +50,13 @@ module Urbit
       another_group.path == self.path
     end
 
+    def graphs
+      if @graphs.empty?
+        self.graph_links.each {|gl| @graphs << gl.graph}
+      end
+      @graphs
+    end
+
     def host
       self.path_tokens[0]
     end
@@ -82,8 +100,20 @@ module Urbit
       '?'
     end
 
+    def picture
+      self.fetch_link if @picture.nil?
+      @picture
+    end
+
+    def title
+      self.fetch_link if @title.nil?
+      @title
+    end
+
     def to_h
     {
+        title:           self.title,
+        description:     self.description,
         host:            self.host,
         key:             self.key,
         member_count:    self.members.count,
@@ -92,12 +122,37 @@ module Urbit
       }
     end
 
+    def to_list
+      self.title || "Untitled - #{self.path}"
+    end
+
     def to_s
       "a Group(#{self.to_h})"
     end
 
     private
 
+    def fetch_link
+      @group_link = self.manager.ship.links.find_group(path: self.path)
+      unless @group_link.nil?
+        @creator     = @group_link.metadata['creator']
+        @description = @group_link.metadata['description']
+        @picture     = @group_link.metadata['picture']
+        @title       = @group_link.metadata['title']
+      end
+    end
+
+    def graph_links
+      self.group_link.graph_links
+    end
+
+    def group_link
+      if @group_link.nil?
+        self.fetch_link
+      end
+      @group_link
+    end
+
     def parse_tags(tags)
       h = {}
       return h if tags.empty?

data/lib/urbit/{group_manager.rb → groups.rb}

@@ -1,29 +1,45 @@
 # frozen_string_literal: true
 
 module Urbit
-  class GroupManager
-    attr_accessor :groups, :ship
+  class Groups < Set
+    attr_accessor :ship
 
     def initialize(ship:)
       @ship   = ship
-      @groups = []
+      @hash = {}
+    end
+
+    def [](path: nil, title: nil)
+      if title.nil?
+        if (g = self.select {|g| g.path == path}.first)
+          g.manager = self
+          return g
+        end
+      else
+        if (g = self.select {|g| g.title == title}.first)
+          g.manager = self
+          return g
+        end
+      end
+      nil
     end
 
     #
     # Adds a Group to this Manager's groups collection
     #
     def add(a_group)
-      @groups << a_group
+      a_group.manager = self
+      self << a_group
     end
 
     def add_members(group_path:, ships:)
-      if (group = self.find(path: group_path))
+      if (group = self[path: group_path])
         group.members += ships
       end
     end
 
     def add_tag(group_path:, ships:, tag:)
-      if (group = self.find(path: group_path))
+      if (group = self[path: group_path])
         if (group.tags.include? tag)
           group.tags[tag] += ships
         end
@@ -35,23 +51,7 @@ module Urbit
     end
 
     def empty?
-      self.groups.empty?
-    end
-
-    #
-    # Answers the Group uniquely keyed by path:, if it exists
-    #
-    def find(path:)
-      if (g = self.groups.select {|g| g.path == path}.first)
-        g.manager = self
-        g
-      end
-    end
-
-    def first
-      g = self.groups.first
-      g.manager = self
-      g
+      self.empty?
     end
 
     def join(host:, name:, share_contact: false, auto_join: false)
@@ -61,21 +61,21 @@ module Urbit
     end
 
     def list
-      self.groups.map {|g| g.path}.join("\n")
+      self.map {|g| g.to_list}.join("\n")
     end
 
     def remove(group)
-      @groups = self.groups.filter {|g| g != group}
+      self.delete(group)
     end
 
     def remove_members(group_path:, ships:)
-      if (group = self.find(path: group_path))
+      if (group = self[path: group_path])
         group.members -= ships
       end
     end
 
     def remove_tag(group_path:, ships:, tag:)
-      if (group = self.find(path: group_path))
+      if (group = self[path: group_path])
         if (group.tags.include? tag)
           group.tags[tag] -= ships
         end
@@ -94,7 +94,7 @@ module Urbit
     end
 
     def to_s
-      self.groups.sort.each {|g| puts g}
+      self.sort.each {|g| puts g}
     end
   end
 end

data/lib/urbit/link.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Urbit
+  class Link
+    attr_reader :path, :data
+
+    def initialize(chain:, path:, data:)
+      @chain = chain
+      @graph = nil
+      @group = nil
+      @path  = path
+      @data  = data
+    end
+
+    def ==(another)
+      another.path == self.path
+    end
+
+    def <=>(another)
+      self.path <=> another.path
+    end
+
+    def eql?(another)
+      another.path == self.path
+    end
+
+    def graph
+      if @graph.nil?
+        @graph = self.ship.graph(resource: self.graph_resource)
+      end
+      @graph
+    end
+
+    def graph_links
+      @chain.find_graph_links_for_group(path: self.group_path)
+    end
+
+    def graph_resource
+      @data['resource'].sub('/ship/', '')
+    end
+
+    def group
+      if @group.nil?
+        @group = self.ship.groups[path: self.group_path]
+      end
+      @group
+    end
+
+    def group_path
+      @data['group'].sub('/ship/', '')
+    end
+
+    def metadata
+      @data['metadata']
+    end
+
+    def ship
+      @chain.ship
+    end
+
+    def to_list
+      @path
+    end
+
+    def type
+      @data['app-name']
+    end
+  end
+end

data/lib/urbit/links.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Urbit
+  class Links < Set
+    attr_reader :ship
+
+    def initialize
+      @hash = {}
+      @ship = nil
+    end
+
+    def [](path:)
+      self.select {|l| path == l.path}.first
+    end
+
+    def find_graph(resource:)
+      self.select{|l| l.type == 'graph' && resource == l.graph_resource}.first
+    end
+
+    def find_graph_links_for_group(path:)
+      self.select{|l| l.type == 'graph' && path == l.group_path}
+    end
+
+    def find_group(path:)
+      self.select{|l| l.type == 'groups' && path == l.group_path}.first
+    end
+
+    def list
+      self.sort.each {|l| puts l.to_list}
+      nil
+    end
+
+    def load(ship:)
+      ship.subscribe(app: 'metadata-store', path: '/all')
+      @ship = ship
+      nil
+    end
+  end
+end

data/lib/urbit/setting.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'urbit/bucket'
+
+module Urbit
+  class Setting
+    attr_accessor :buckets
+    attr_reader :desk, :ship
+
+    def initialize(ship:, desk:, buckets:)
+      @ship    = ship
+      @desk    = desk
+      @buckets = Set.new
+      buckets.each {|k, v| @buckets << Bucket.new(setting: self, name: k, entries: v)}
+    end
+
+    def ==(another_group)
+      another_setting.desk == self.desk
+    end
+
+    def <=>(another_group)
+      self.desk <=> another_group.desk
+    end
+
+    def [](bucket:)
+      self.buckets.select {|b| bucket == b.name}.first
+    end
+
+    def add_bucket(name:, entries:)
+      msg = {
+        "put-bucket": {
+          "bucket-key": "#{name}",
+          "desk":       "#{self.desk}",
+          "bucket":     entries
+        }
+      }
+      self.ship.poke(app: 'settings-store', mark: 'settings-event', message: msg)
+      nil
+    end
+
+    def entries(bucket:)
+      self[bucket: bucket].entries
+    end
+
+    def remove_bucket(name:)
+      msg = {
+        "del-bucket": {
+          "bucket-key": "#{name}",
+          "desk":       "#{self.desk}"
+        }
+      }
+      self.ship.poke(app: 'settings-store', mark: 'settings-event', message: msg)
+      nil
+    end
+
+    def to_h
+      {
+        desk:    @desk,
+        buckets: self.buckets,
+      }
+    end
+
+    def to_s
+      "a Setting(#{self.to_h})"
+    end
+
+    def to_string
+      "desk: #{self.desk}\n  buckets: #{self.buckets.collect {|b| b.to_string}}"
+    end
+  end
+end

data/lib/urbit/settings.rb

@@ -1,74 +1,8 @@
 # frozen_string_literal: true
 
-require 'urbit/bucket'
+require 'urbit/setting'
 
 module Urbit
-  class Setting
-    attr_accessor :buckets
-    attr_reader :desk, :ship
-
-    def initialize(ship:, desk:, buckets:)
-      @ship    = ship
-      @desk    = desk
-      @buckets = Set.new
-      buckets.each {|k, v| @buckets << Bucket.new(setting: self, name: k, entries: v)}
-    end
-
-    def ==(another_group)
-      another_setting.desk == self.desk
-    end
-
-    def <=>(another_group)
-      self.desk <=> another_group.desk
-    end
-
-    def [](bucket:)
-      self.buckets.select {|b| bucket == b.name}.first
-    end
-
-    def add_bucket(name:, entries:)
-      msg = {
-        "put-bucket": {
-          "bucket-key": "#{name}",
-          "desk":       "#{self.desk}",
-          "bucket":     entries
-        }
-      }
-      self.ship.poke(app: 'settings-store', mark: 'settings-event', message: msg)
-      nil
-    end
-
-    def entries(bucket:)
-      self[bucket: bucket].entries
-    end
-
-    def remove_bucket(name:)
-      msg = {
-        "del-bucket": {
-          "bucket-key": "#{name}",
-          "desk":       "#{self.desk}"
-        }
-      }
-      self.ship.poke(app: 'settings-store', mark: 'settings-event', message: msg)
-      nil
-    end
-
-    def to_h
-      {
-        desk:    @desk,
-        buckets: self.buckets,
-      }
-    end
-
-    def to_s
-      "a Setting(#{self.to_h})"
-    end
-
-    def to_string
-      "desk: #{self.desk}\n  buckets: #{self.buckets.collect {|b| b.to_string}}"
-    end
-  end
-
   class Settings < Set
     class << self
       def load(ship:)
@@ -99,5 +33,4 @@ module Urbit
       nil
     end
   end
-
 end

data/lib/urbit/ship.rb

@@ -3,20 +3,22 @@ require 'faraday'
 require 'urbit/channel'
 require 'urbit/config'
 require 'urbit/graph'
-require 'urbit/group_manager'
+require 'urbit/groups'
+require 'urbit/links'
 require 'urbit/settings'
 
 module Urbit
   class Ship
     attr_accessor :logged_in
-    attr_reader :auth_cookie, :channels, :config, :group_mgr
+    attr_reader :auth_cookie, :channels, :config
 
     def initialize(config: Config.new)
       @auth_cookie = nil
       @channels    = []
       @config      = config
       @graphs      = []
-      @group_mgr   = GroupManager.new ship: self
+      @groups      = Groups.new ship: self
+      @links       = Links.new
       @settings    = nil                         # Use lazy initialization here
       @logged_in   = false
     end
@@ -41,7 +43,7 @@ module Urbit
     # Answers a collection of all the top-level graphs on this ship.
     # This collection is cached and will need to be invalidated to discover new graphs.
     #
-    def graphs(flush_cache: false)
+    def graphs(flush_cache: true)
       @graphs = [] if flush_cache
       if @graphs.empty?
         if self.logged_in?
@@ -64,19 +66,16 @@ module Urbit
       self.graphs.collect {|g| g.resource}
     end
 
-    #
-    # Answers the Group uniquely keyed by path:, if it exists
-    #
-    def group(path:)
-      @group_mgr.find_by_path(path)
-    end
-
     #
     # Answers the object managing the Groups on this ship.
     # This object provides all the helper methods to list, join, leave, &c. a Group
     #
     def groups
-      @group_mgr
+      @groups
+    end
+
+    def links
+      @links
     end
 
     def login
@@ -85,7 +84,14 @@ module Urbit
       ensure_connections_closed
       response = Faraday.post(login_url, "password=#{config.code}")
       parse_cookie(response)
-      @group_mgr.load
+      @groups.load
+
+      # For now we will require a subscription to all metadata. it's the glue between %graphs and %groups.
+      # A key issue that arose is that these are both async %subscribe calls and so there are sync issues
+      #   if we try to directly link the groups and the graphs. Instead we need to just store the links
+      #   and lazy-instatiate the metadata _if_ we have received it.
+      @links.load ship: self
+
       self
     end
 

data/lib/urbit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Urbit
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbit-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daryl Richter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,16 +99,20 @@ files:
 - lib/urbit/fact/base_fact.rb
 - lib/urbit/fact/graph_fact.rb
 - lib/urbit/fact/group_fact.rb
+- lib/urbit/fact/metadata_fact.rb
 - lib/urbit/fact/settings_fact.rb
 - lib/urbit/graph.rb
 - lib/urbit/group.rb
-- lib/urbit/group_manager.rb
 - lib/urbit/group_parser.rb
+- lib/urbit/groups.rb
+- lib/urbit/link.rb
+- lib/urbit/links.rb
 - lib/urbit/message.rb
 - lib/urbit/node.rb
 - lib/urbit/parser.rb
 - lib/urbit/poke_message.rb
 - lib/urbit/receiver.rb
+- lib/urbit/setting.rb
 - lib/urbit/settings.rb
 - lib/urbit/ship.rb
 - lib/urbit/subscribe_message.rb