urbit-api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466e396f78dad90e05ab4b1010f8c6638ab79468f9adf47f6704ab91f39c4a29
-  data.tar.gz: cf2ca6d9f02d70f0a2cd421cc3b1a28d95ba612842ee5a8b6faea6738d3e8e1c
+  metadata.gz: 2cef1b4e2c8a8a7ef8ba203f66e92e516e563c7b32119e98ee55366983e72dd3
+  data.tar.gz: dc6267d7c21e034c6725309a15678b09b4e0d8713990b5e975c94ef25475caed
 SHA512:
-  metadata.gz: c8012c2739134932ec79654cd9a33edb993dcb88304195574d890bad04bc82e2c6e47ca0f46cae5e3fc288deae7766f173ed7ee25c5f9f9e86fad6a66588cdae
-  data.tar.gz: 402992b7ee1782c62025f75d9c1c537ad267db4397346bb04961988c2cfde0d1dc6f233a44f3c8067e0023c22b07c215f9a633d0f33d5325fea4dc6a9650c7dd
+  metadata.gz: 9b19087253b1b6864e0941b94513f530aee01856357d590468e670273412a273a8ad4e514bc21c21ea86bc24877e4cc72b9ce475cbf218c2f53efafd462e2cb7
+  data.tar.gz: 1443c08a0370fd78bf33dca3c701aba09669421d434b10a475544a0828fe1eaae3ac1a222aa963654e29e800b3f7ab019efd73bbd2d9dbb6b00f4c775f52e63c

data/README.md

@@ -187,6 +187,32 @@ a Node({:index=>"170.141.184.505.209.627.337.970.761.265.544.429.568", :author=>
 "170.141.184.505.209.375.247.350.471.711.992.578.048"
 "170.141.184.505.209.545.972.004.310.065.795.301.376"
 "170.141.184.505.209.627.337.970.761.265.544.429.568"
+
+#
+# --------------------------------------------------------------------
+# %settings-store
+# --------------------------------------------------------------------
+#
+> ship.setting(desk: 'landscape', bucket: 'calm').each {|e| p e};nil
+["hideUtilities", false]
+["hideGroups", false]
+["hideAvatars", true]
+["hideUnreads", true]
+["hideNicknames", true]
+
+> ship.subscribe(app: 'settings-store', path: '/all')
+=> a Channel (Open) on ~barsyr-latreb(name: 'Channel-0', key: '164375139513eacb')
+
+# We are now listening for changes in any settings on the ship. Go to Landscape and toggle the "Hide Groups" button...
+Received a Fact for [a Channel (Open) on ~barsyr-latreb(name: 'Channel-0', key: '164375139513eacb')] -- [message] -- [{"json":{"settings-event":{"put-entry":{"bucket-key":"calm","desk":"landscape","entry-key":"hideGroups","value":true}}},"id":1,"response":"diff"}]
+
+> ship.setting(desk: 'landscape', bucket: 'calm').each {|e| p e};nil
+["hideUtilities", false]
+**["hideGroups", true]**
+["hideAvatars", true]
+["hideUnreads", true]
+["hideNicknames", true]
+
 ```
 ### Configuration
 

data/lib/urbit/api/version.rb

@@ -1,5 +1,5 @@
 module Urbit
   module Api
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/urbit/fact.rb

@@ -10,39 +10,48 @@ module Urbit
       @channel = channel
       @data = event.data
       @type = event.type
+      puts "Received a Fact for [#{channel}] -- [#{@type}] -- [#{@data}]"
+    end
 
-      # 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
-      end
+    #
+    # This is a Facotry method to make the proper Fact subclass from
+    # a Channel Event.
+    #
+    def self.collect(channel:, event:)
+      contents = JSON.parse(event.data)
+      return Fact.new(channel: channel, event: event)              if contents["json"].nil?
+      return SettingsEventFact.new(channel: channel, event: event) if contents["json"]["settings-event"]
+
+      return Fact.new(channel: channel, event: event)              if contents["json"]["graph-update"].nil?
+      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"]
+
+      return Fact.new(channel: channel, event: event)
     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 for_this_ship?
+      self.ship == @channel.ship
+    end
+
     def graph_update?
-      !self.contents["json"].nil? && !self.contents["json"]["graph-update"].nil?
+      false
     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"]}"
+    def raw_json
+      nil
     end
 
     def ship
@@ -52,15 +61,146 @@ module Urbit
     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})"
+      "a #{self.class.name}(#{self.to_h})"
+    end
+  end
+
+  class GraphUpdateFact < Fact
+    def initialize(channel:, event:)
+      super channel: channel, event: event
+    end
+
+    #
+    # 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
+
+    def create_parser
+      nil
+    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: 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: 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: 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
+
+  class SettingsEventFact < Fact
+    def initialize(channel:, event:)
+      super channel: channel, event: event
+
+      if self.for_this_ship?
+        # See if we already have this setting, if no add it, if yes update it.
+        if (entries = channel.ship.setting(bucket: self.bucket))
+          entries[self.entry] = self.value
+        end
+      end
+    end
+
+    def bucket
+      self.contents["bucket-key"]
+    end
+
+    def contents
+      JSON.parse(@data)["json"]["settings-event"]["put-entry"]
+    end
+
+    def desk
+      self.contents["desk"]
+    end
+
+    def entry
+      self.contents["entry-key"]
+    end
+
+    def to_h
+      super.merge!({
+        bucket: self.bucket,
+        desk:   self.desk,
+        entry:  self.entry,
+        value:  self.value
+      })
+    end
+
+    def value
+      self.contents["value"]
     end
   end
 end

data/lib/urbit/parser.rb

@@ -38,6 +38,9 @@ module Urbit
       @j["graph"]
     end
 
+    def resource_hash
+      @j["resource"]
+    end
   end
 
   class AddNodesParser < Parser
@@ -45,4 +48,15 @@ module Urbit
       @j["nodes"]
     end
   end
+
+  class RemoveGraphParser < Parser
+    def nodes_hash
+      nil
+    end
+
+    def resource_hash
+      @j["resource"]
+    end
+  end
+
 end

data/lib/urbit/receiver.rb

@@ -13,7 +13,7 @@ module Urbit
         # We are now listening on a socket for SSE::Events. This block will be called for each one.
         rec.on_event do |event|
           # Wrap the returned event in a Fact.
-          @facts << (f = Fact.new(channel: channel, event: event))
+          @facts << (f = Fact.collect(channel: channel, event: event))
 
           # We need to acknowlege each message or urbit will eventually disconnect us.
           # We record the ack with the Fact itself.

data/lib/urbit/setting.rb

@@ -0,0 +1,30 @@
+
+module Urbit
+  class Setting
+     attr_reader :bucket
+
+    def initialize(ship:, desk:, setting:)
+      @ship = ship
+      @desk = desk
+      @bucket = setting.first
+      @entries = setting.last
+    end
+
+    def entries(bucket: nil)
+      return @entries if (bucket.nil? || @bucket == bucket)
+      {}
+    end
+
+    def to_h
+      {
+        desk:    @desk,
+        bucket:  self.bucket,
+        entries: self.entries
+      }
+    end
+
+    def to_s
+      "a Setting(#{self.to_h})"
+    end
+  end
+end

data/lib/urbit/ship.rb

@@ -3,6 +3,7 @@ require 'faraday'
 require 'urbit/channel'
 require 'urbit/config'
 require 'urbit/graph'
+require 'urbit/setting'
 
 module Urbit
   class Ship
@@ -14,6 +15,7 @@ module Urbit
       @channels    = []
       @config      = config
       @graphs      = []
+      @settings    = []
       @logged_in   = false
     end
 
@@ -73,7 +75,7 @@ module Urbit
       config.name
     end
 
-    def remove_graph(graph:)
+    def remove_graph(desk: 'landscape', graph:)
       delete_json = %Q({
         "delete": {
           "resource": {
@@ -83,13 +85,47 @@ module Urbit
         }
       })
 
-      spider = self.spider(mark_in: 'graph-view-action', mark_out: 'json', thread: 'graph-delete', data: delete_json, args: ["NO_RESPONSE"])
+      spider = self.spider(desk: desk, mark_in: 'graph-view-action', mark_out: 'json', thread: 'graph-delete', data: delete_json, args: ["NO_RESPONSE"])
       if (retcode = (200 == spider[:status]))
         self.graphs.delete graph
       end
       retcode
     end
 
+    #
+    # Answers the entries for the specified desk and bucket.
+    #
+    def setting(desk: 'landscape', bucket:)
+      if (settings = self.settings(desk: desk))
+        settings.each do |setting|
+          if (entries = setting.entries(bucket: bucket))
+            return entries
+          end
+        end
+      end
+      {}
+    end
+
+    #
+    # Answers a collection of all the settings for this ship.
+    # This collection is cached and will need to be invalidated to discover new settings.
+    #
+    def settings(desk: 'landscape', flush_cache: false)
+      @settings = [] if flush_cache
+      if @settings.empty?
+        if self.logged_in?
+          scry = self.scry(app: "settings-store", path: "/desk/#{desk}", mark: "json")
+          if scry[:body]
+            body = JSON.parse scry[:body]
+            body["desk"].each do |k|
+              @settings << Setting.new(ship: self, desk: desk, setting: k)
+            end
+          end
+        end
+      end
+      @settings
+    end
+
     def untilded_name
       name.gsub('~', '')
     end
@@ -125,9 +161,9 @@ module Urbit
       {status: response.status, code: response.reason_phrase, body: response.body}
     end
 
-    def spider(mark_in:, mark_out:, thread:, data:, args: [])
+    def spider(desk: 'landscape', mark_in:, mark_out:, thread:, data:, args: [])
       self.login
-      url = "#{self.config.api_base_url}/spider/#{mark_in}/#{thread}/#{mark_out}.json"
+      url = "#{self.config.api_base_url}/spider/#{desk}/#{mark_in}/#{thread}/#{mark_out}.json"
 
       # TODO: This is a huge hack due to the fact that certain spider operations are known to
       #       not return when they should. Instead I just set the timeout low and catch the

data/misc/settings-store.json

@@ -0,0 +1,52 @@
+ship.scry(app: 'settings-store', path: '/desk/landscape', mark: 'json')
+
+{
+  :status => 200,
+  :code   => "ok",
+  :body   => {
+    "desk": {
+      "calm": {
+        "hideAvatars": true,
+        "hideNicknames": true
+      },
+      "urbit-visor-permissions": {
+        "https://urbitdashboard.com": [
+          "shipName", "shipURL", "scry", "subscribe", "poke", "thread"
+        ]
+      }
+    }
+  }
+}
+
+
+pry(main)> ship.subscribe(app: 'settings-store', path: '/all')
+=> a Channel (Open) on ~barsyr-latreb(name: 'Channel-0', key: '164192001782807f')
+
+pry(main)> Received a Fact for [a Channel (Open) on ~barsyr-latreb(name: 'Channel-0', key: '164192001782807f')
+] -- [message
+] -- [
+  {
+    "ok": "ok",
+    "id": 1,
+    "response": "subscribe"
+  }
+]
+
+pry(main)> Received a Fact for [a Channel (Open) on ~barsyr-latreb(name: 'Channel-0', key: '164192001782807f')
+] -- [message
+] -- [
+  {
+    "json": {
+      "settings-event": {
+        "put-entry": {
+          "bucket-key": "calm",
+          "desk": "landscape",
+          "entry-key": "hideUnreads",
+          "value": true
+        }
+      }
+    },
+    "id": 1,
+    "response": "diff"
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbit-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daryl Richter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,6 +100,7 @@ files:
 - lib/urbit/parser.rb
 - lib/urbit/poke_message.rb
 - lib/urbit/receiver.rb
+- lib/urbit/setting.rb
 - lib/urbit/ship.rb
 - lib/urbit/subscribe_message.rb
 - lib/urbit/urbit.rb
@@ -110,6 +111,7 @@ files:
 - misc/graph-update_add-graph
 - misc/graph-update_add-nodes
 - misc/post
+- misc/settings-store.json
 - urbit-api.gemspec
 homepage: https://www.ngzax.com
 licenses: