urbit-api 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466e396f78dad90e05ab4b1010f8c6638ab79468f9adf47f6704ab91f39c4a29
-  data.tar.gz: cf2ca6d9f02d70f0a2cd421cc3b1a28d95ba612842ee5a8b6faea6738d3e8e1c
+  metadata.gz: a306b64d165415e7a680fd82a20b75de6840ca80d9482be6ceacbd13fd2b4a9f
+  data.tar.gz: 81ce508aee55fd9cdee15bb56774adf5f226b7f5620d9430f4be8de73cb307f9
 SHA512:
-  metadata.gz: c8012c2739134932ec79654cd9a33edb993dcb88304195574d890bad04bc82e2c6e47ca0f46cae5e3fc288deae7766f173ed7ee25c5f9f9e86fad6a66588cdae
-  data.tar.gz: 402992b7ee1782c62025f75d9c1c537ad267db4397346bb04961988c2cfde0d1dc6f233a44f3c8067e0023c22b07c215f9a633d0f33d5325fea4dc6a9650c7dd
+  metadata.gz: 1cfffd8c6a8f82d701ace0b49266036f17bc481ea75d799d871e7d785899771686d6682a5444a1a20d3b167d7b5415ef4d05b18baa2dc1553000719055b5ca58
+  data.tar.gz: 561e7976cf6d5b5c07e224079e53f6a6102214d317050fd16d1eb5639befb41b020f88ff50b18a94ffda31eaf85515408e5e85bbf38b3610d59e141c02dfb3de

data/lib/urbit/bucket.rb

@@ -0,0 +1,45 @@
+
+module Urbit
+  class Bucket
+    attr_accessor :entries, :name, :setting
+
+    def initialize(setting:, name:, entries:)
+      @setting = setting
+      @name = name
+      @entries = Hash.new.replace(entries)
+    end
+
+    def [](key:)
+      self.entries[key]
+    end
+
+    def []=(key, val)
+      msg = {"put-entry": {"desk": "#{@setting.desk}", "bucket-key": "#{self.name}", "entry-key": "#{key[:key]}", "value": val}}
+      self.ship.poke(app: 'settings-store', mark: 'settings-event', message: msg)
+      nil
+    end
+
+    def remove_entry(key:)
+      msg = {"del-entry": {"desk": "#{@setting.desk}", "bucket-key": "#{self.name}", "entry-key": "#{key}"}}
+      self.ship.poke(app: 'settings-store', mark: 'settings-event', message: msg)
+      nil
+    end
+
+    def ship
+      self.setting.ship
+    end
+
+    def to_h
+      {name: @name, entries: @entries}
+    end
+
+    def to_s
+      "a Bucket(#{self.to_h})"
+    end
+
+    def to_string
+      "#{self.name}: #{self.entries.count} entries"
+    end
+
+  end
+end

data/lib/urbit/channel.rb

@@ -21,7 +21,6 @@ module Urbit
     end
 
     def close
-      # puts "closing #{name}"
       m = Urbit::CloseMessage.new(channel: self)
       @is_open = !self.send(message: m)
     end
@@ -35,11 +34,11 @@ module Urbit
     end
 
     #
-    # One way to open a channel by "poking" an urbit app with a mark and a (json) message.
-    # A typical example of this is poking the 'hood' app using the mark 'helm-hi' to start a DM chat.
+    # Poke an app with a message using a mark.
+    # The message must be a Ruby Hash, not a String.
     #
     def poke(app:, mark:, message:)
-      @is_open = self.send(message: (Urbit::PokeMessage.new(channel: self, app: app, mark: mark, a_string: message)))
+      @is_open = self.send(message: (Urbit::PokeMessage.new(channel: self, app: app, mark: mark, a_message_hash: message)))
       @receiver = Urbit::Receiver.new(channel: self)
       self
     end
@@ -84,7 +83,7 @@ module Urbit
     end
 
     def url
-      "http://localhost:8080/~/channel/#{self.key}"
+      "#{self.ship.url}/~/channel/#{self.key}"
     end
   end
 end

data/lib/urbit/fact/base_fact.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Urbit
+  module Fact
+    class BaseFact
+      attr_reader :ack, :channel, :data, :type
+
+      def initialize(channel:, event:)
+        @channel = channel
+        @data = event.data
+        @type = event.type
+      end
+
+      def add_ack(ack:)
+        @ack = :ack
+      end
+
+      def contents
+        JSON.parse(@data)
+      end
+
+      def create_parser
+        nil
+      end
+
+      def for_this_ship?
+        self.ship == @channel.ship
+      end
+
+      def graph_update?
+        false
+      end
+
+      def is_acknowledged?
+        !@ack.nil?
+      end
+
+      def raw_json
+        nil
+      end
+
+      def ship
+        @channel.ship
+      end
+
+      def to_h
+        {
+          ship:            self.ship.to_h,
+          acknowleged:     self.is_acknowledged?,
+          is_graph_update: self.graph_update?
+        }
+      end
+
+      def to_s
+        "a #{self.class.name}(#{self.to_h})"
+      end
+    end
+
+    class EmptyFact < BaseFact
+    end
+
+    class ErrorFact < BaseFact
+      def error
+        self.contents["err"]
+      end
+
+      def response
+        self.contents["response"]
+      end
+
+      def to_h
+        super.merge!({
+          error:    self.error,
+          response: self.response,
+        })
+      end
+    end
+
+    class SuccessFact < BaseFact
+      def code
+        self.contents["ok"]
+      end
+
+      def response
+        self.contents["response"]
+      end
+
+      def to_h
+        super.merge!({
+          code:     self.code,
+          response: self.response,
+        })
+      end
+
+    end
+  end
+end

data/lib/urbit/fact/graph_fact.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Urbit
+  module Fact
+    class GraphUpdateFact < BaseFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+      end
+
+      #
+      # Attach this new fact as a node to its Graph.
+      #
+      def attach_parser
+        if self.incoming_graph
+          self.create_parser
+        end
+      end
+
+      def graph_update?
+        true
+      end
+
+      def incoming_graph
+        self.ship.graph(resource: self.resource)
+      end
+
+      def resource
+        return "~#{self.resource_h["ship"]}/#{self.resource_h["name"]}" unless self.resource_h.nil?
+      end
+
+      def resource_h
+        self.raw_json["resource"]
+      end
+
+      def root_h
+        self.contents["json"]["graph-update"]
+      end
+
+      def to_h
+        super.merge!(resource: self.resource)
+      end
+    end
+
+    class AddGraphFact < GraphUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+      end
+
+      def create_parser
+        Urbit::AddGraphParser.new(for_graph: self.incoming_graph,  with_json: self.raw_json).add_nodes
+      end
+
+      def raw_json
+        self.root_h["add-graph"]
+      end
+    end
+
+    class AddNodesFact < GraphUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+      end
+
+      def create_parser
+        Urbit::AddNodesParser.new(for_graph: self.incoming_graph,  with_json: self.raw_json).add_nodes
+      end
+
+      def raw_json
+        self.root_h["add-nodes"]
+      end
+    end
+
+    class RemoveGraphFact < GraphUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+      end
+
+      def create_parser
+        Urbit::RemoveGraphParser.new(for_graph: self.incoming_graph,  with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["remove-graph"]
+      end
+
+      def resource_h
+        self.raw_json
+      end
+    end
+  end
+end

data/lib/urbit/fact/group_fact.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'urbit/group'
+require 'urbit/group_parser'
+
+module Urbit
+  module Fact
+    class GroupUpdateFact < BaseFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+      end
+
+      def root_h
+        self.contents["json"]["groupUpdate"]
+      end
+    end
+
+    class AddGroupFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.channel.ship.groups.add(self.parser.group)
+      end
+
+      def parser
+        Urbit::AddGroupParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["addGroup"]
+      end
+    end
+
+    class AddGroupMemberFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.channel.ship.groups.add_members group_path: self.parser.resource, ships: self.parser.ships
+      end
+
+      def parser
+        Urbit::ChangeMemberParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["addMembers"]
+      end
+    end
+
+    class AddTagFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.channel.ship.groups.add_tag group_path: self.parser.resource, ships: self.parser.ships, tag: self.parser.tag
+      end
+
+      def parser
+        Urbit::ChangeTagParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["addTag"]
+      end
+    end
+
+    class InitialGroupFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.parser.groups.each {|g| self.channel.ship.groups.add(g)}
+      end
+
+      def parser
+        Urbit::InitialGroupParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["initial"]
+      end
+    end
+
+    class InitialGroupGroupFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.channel.ship.groups.add(self.parser.group)
+      end
+
+      def parser
+        Urbit::InitialGroupGroupParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["initialGroup"]
+      end
+    end
+
+    class RemoveGroupMemberFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.channel.ship.groups.remove_members group_path: self.parser.resource, ships: self.parser.ships
+      end
+
+      def parser
+        Urbit::ChangeMemberParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["removeMembers"]
+      end
+    end
+
+    class RemoveTagFact < GroupUpdateFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.channel.ship.groups.remove_tag group_path: self.parser.resource, ships: self.parser.ships, tag: self.parser.tag
+      end
+
+      def parser
+        Urbit::ChangeTagParser.new(with_json: self.raw_json)
+      end
+
+      def raw_json
+        self.root_h["removeTag"]
+      end
+    end
+
+  end # Module Fact
+end # Module Urbit

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/settings_fact.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Urbit
+  module Fact
+
+    class SettingsEventFact < BaseFact
+      def initialize(channel:, event:)
+        super channel: channel, event: event
+        self.accept if self.for_this_ship?
+      end
+
+      def accept
+        nil
+      end
+
+      def base_contents
+        JSON.parse(@data)["json"]["settings-event"]
+      end
+
+      def bucket
+        self.desk[bucket: self.bucket_key]
+      end
+
+      def bucket_key
+        self.contents["bucket-key"]
+      end
+
+      def desk
+        self.ship.settings[desk: self.desk_name]
+      end
+
+      def desk_name
+        self.contents["desk"]
+      end
+
+      def to_h
+        super.merge!({
+          bucket: self.bucket_key,
+          desk:   self.desk_name,
+        })
+      end
+    end
+
+    class SettingsEventDelBucketFact < SettingsEventFact
+      def accept
+        self.desk.buckets.delete(self.bucket)
+      end
+
+      def contents
+        self.base_contents["del-bucket"]
+      end
+    end
+
+    class SettingsEventDelEntryFact < SettingsEventFact
+      def accept
+        self.bucket.entries.delete(self.entry)
+      end
+
+      def contents
+        self.base_contents["del-entry"]
+      end
+
+      def entry
+        self.contents["entry-key"]
+      end
+    end
+
+    class SettingsEventPutBucketFact < SettingsEventFact
+      def accept
+        # This is a new bucket, add it.
+        s = channel.ship.settings[desk: self.desk_name]
+        s.buckets << Bucket.new(setting: s, name: self.bucket_key, entries: self.entries)
+        nil
+      end
+
+      def contents
+        self.base_contents["put-bucket"]
+      end
+
+      def entries
+        self.contents["bucket"]
+      end
+
+      def to_h
+        super.merge!({
+          entries: self.entries
+        })
+      end
+    end
+
+    class SettingsEventPutEntryFact < SettingsEventFact
+      def accept
+        # See if we already have this setting, if no add it, if yes update it.
+        if (entries = channel.ship.settings[desk: self.desk_name].entries(bucket: self.bucket_key))
+          entries[self.entry] = self.value
+        end
+      end
+
+      def contents
+        self.base_contents["put-entry"]
+      end
+
+      def entry
+        self.contents["entry-key"]
+      end
+
+      def to_h
+        super.merge!({
+          entry:  self.entry,
+          value:  self.value
+        })
+      end
+
+      def value
+        self.contents["value"]
+      end
+    end
+
+  end
+end

data/lib/urbit/fact.rb

@@ -1,66 +1,55 @@
-require 'urbit/graph'
-require 'urbit/node'
-require 'urbit/parser'
+# frozen_string_literal: true
 
-module Urbit
-  class Fact
-    attr_reader :ack
-
-    def initialize(channel:, event:)
-      @channel = channel
-      @data = event.data
-      @type = event.type
+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'
 
-      # Attach this new fact as a node to its Graph.
-      if self.graph_update?
-        puts self.add_nodes_json
-        Urbit::AddNodesParser.new(for_graph: (self.ship.graph(resource: self.resource)),  with_json: self.add_nodes_json).add_nodes
+module Urbit
+  module Fact
+    class << self
+      #
+      # This is a Factory method to make the proper Fact subclass from a Channel Event.
+      #
+      def collect(channel:, event:)
+        contents = JSON.parse(event.data)
+
+        if contents["json"].nil?
+          return SuccessFact.new(channel: channel, event: event) if contents["ok"]
+          return ErrorFact.new(channel: channel, event: event)   if contents["err"]
+          return EmptyFact.new(channel: channel, event: event)
+        end
+
+        if contents["json"]["graph-update"]
+          return AddGraphFact.new(channel: channel, event: event)      if contents["json"]["graph-update"]["add-graph"]
+          return AddNodesFact.new(channel: channel, event: event)      if contents["json"]["graph-update"]["add-nodes"]
+          return RemoveGraphFact.new(channel: channel, event: event)   if contents["json"]["graph-update"]["remove-graph"]
+        end
+
+        if (c = contents["json"]["groupUpdate"])
+          return AddGroupFact.new(channel: channel, event: event)          if c["addGroup"]
+          return AddGroupMemberFact.new(channel: channel, event: event)    if c["addMembers"]
+          return AddTagFact.new(channel: channel, event: event)            if c["addTag"]
+          return InitialGroupFact.new(channel: channel, event: event)      if c["initial"]
+          return InitialGroupGroupFact.new(channel: channel, event: event) if c["initialGroup"]
+          return RemoveGroupMemberFact.new(channel: channel, event: event) if c["removeMembers"]
+          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"]
+          return SettingsEventPutBucketFact.new(channel: channel, event: event) if c["put-bucket"]
+          return SettingsEventPutEntryFact.new(channel: channel, event: event)  if c["put-entry"]
+        end
+
+        return BaseFact.new(channel: channel, event: event)
       end
     end
-
-    def add_ack(ack:)
-      @ack = :ack
-    end
-
-    def add_nodes_json
-      return nil unless self.graph_update?
-      self.contents["json"]["graph-update"]["add-nodes"]
-    end
-
-    def contents
-      JSON.parse(@data)
-    end
-
-    def graph_update?
-      !self.contents["json"].nil? && !self.contents["json"]["graph-update"].nil?
-    end
-
-    def is_acknowledged?
-      !@ack.nil?
-    end
-
-    def resource
-      return nil unless self.graph_update?
-      r = self.contents["json"]["graph-update"]["add-nodes"]["resource"]
-      "~#{r["ship"]}/#{r["name"]}"
-    end
-
-    def ship
-      @channel.ship
-    end
-
-    def to_h
-      {
-        ship:            self.ship.to_h,
-        resource:        self.resource,
-        acknowleged:     self.is_acknowledged?,
-        is_graph_update: self.graph_update?
-        # contents:        self.contents
-      }
-    end
-
-    def to_s
-      "a Fact(#{self.to_h})"
-    end
   end
 end