urbit-api 0.1.0 → 0.3.0

data/lib/urbit/ship.rb

@@ -2,6 +2,8 @@ require 'faraday'
 
 require 'urbit/channel'
 require 'urbit/config'
+require 'urbit/graph'
+require 'urbit/setting'
 
 module Urbit
   class Ship
@@ -12,6 +14,8 @@ module Urbit
       @auth_cookie = nil
       @channels    = []
       @config      = config
+      @graphs      = []
+      @settings    = []
       @logged_in   = false
     end
 
@@ -27,6 +31,37 @@ module Urbit
       auth_cookie
     end
 
+    def graph(resource:)
+      self.graphs.find {|g| g.resource == resource}
+    end
+
+    #
+    # 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)
+      @graphs = [] if flush_cache
+      if @graphs.empty?
+        if self.logged_in?
+          r = self.scry(app: 'graph-store', path: '/keys')
+          if r[:body]
+            body = JSON.parse r[:body]
+            body["graph-update"]["keys"].each do |k|
+              @graphs << Graph.new(ship: self, graph_name: k["name"], host_ship_name: k["ship"])
+            end
+          end
+        end
+      end
+      @graphs
+    end
+
+    #
+    # A helper method to just print out the descriptive names of all the ship's graphs.
+    #
+    def graph_names
+      self.graphs.collect {|g| g.resource}
+    end
+
     def login
       return self if logged_in?
 
@@ -40,6 +75,57 @@ module Urbit
       config.name
     end
 
+    def remove_graph(desk: 'landscape', graph:)
+      delete_json = %Q({
+        "delete": {
+          "resource": {
+            "ship": "#{self.name}",
+            "name": "#{graph.name}"
+          }
+        }
+      })
+
+      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
@@ -48,31 +134,104 @@ module Urbit
       config.name
     end
 
-    # Opening a channel always creates a new channel which will
-    # remain open until this ship is disconnected at which point it
-    # will be closed.
-    def open_channel(a_name)
-      login
-      (c = Channel.new self, a_name).open("Opening Airlock")
-      self.channels << c
-      c
-    end
-
     def open_channels
       @channels.select {|c| c.open?}
     end
 
+    #
+    # Poke an app with a message using a mark.
+    #
+    # Returns a Channel which has been created and opened and will begin
+    #   to get back a stream of facts via its Receiver.
+    #
+    def poke(app:, mark:, message:)
+      (self.add_channel).poke(app: app, mark: mark, message: message)
+    end
+
+    def scry(app:, path:, mark: 'json')
+      self.login
+      mark = ".#{mark}" unless mark.empty?
+      scry_url = "#{self.config.api_base_url}/~/scry/#{app}#{path}#{mark}"
+
+      response = Faraday.get(scry_url) do |req|
+        req.headers['Accept'] = 'application/json'
+        req.headers['Cookie'] = self.cookie
+      end
+
+      {status: response.status, code: response.reason_phrase, body: response.body}
+    end
+
+    def spider(desk: 'landscape', mark_in:, mark_out:, thread:, data:, args: [])
+      self.login
+      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
+      #       error and act like everything is ok.
+      if args.include?("NO_RESPONSE")
+        conn = Faraday::Connection.new()
+        conn.options.timeout = 1
+        conn.options.open_timeout = 1
+
+        begin
+          response = conn.post(url) do |req|
+            req.headers['Accept'] = 'application/json'
+            req.headers['Cookie'] = self.cookie
+            req.body = data
+          end
+        rescue Faraday::TimeoutError
+          return {status: 200, code: "ok", body: "null"}
+        end
+      end
+
+      response = Faraday.post(url) do |req|
+        req.headers['Accept'] = 'application/json'
+        req.headers['Cookie'] = self.cookie
+        req.body = data
+      end
+
+      {status: response.status, code: response.reason_phrase, body: response.body}
+    end
+
+    #
+    # Subscribe to an app at a path.
+    #
+    # Returns a Channel which has been created and opened and will begin
+    #   to get back a stream of facts via its Receiver.
+    #
+    def subscribe(app:, path:)
+      (self.add_channel).subscribe(app: app, path: path)
+    end
+
+    def to_h
+      {name: "#{self.pat_p}", host: "#{self.config.host}", port: "#{self.config.port}"}
+    end
+
     def to_s
-      "a Ship(name: '#{self.pat_p}', host: '#{self.config.host}', port: '#{self.config.port}')"
+      "a Ship(#{self.to_h})"
     end
 
     private
 
+    def add_channel
+      self.login
+      self.channels << (c = Channel.new(ship: self, name: self.make_channel_name))
+      c
+    end
+
+    def make_channel_name
+      "Channel-#{self.open_channels.count}"
+    end
+
     def ensure_connections_closed
       # Make sure all our created channels are closed by the GC
       ObjectSpace.define_finalizer( self, self.class.finalize(channels) )
     end
 
+    def login_url
+      "#{config.api_base_url}/~/login"
+    end
+
     def parse_cookie(resp)
       cookie = resp.headers['set-cookie']
       return unless cookie
@@ -80,9 +239,5 @@ module Urbit
       @auth_cookie, @path, @max_age = cookie.split(';')
       self.logged_in = true if @auth_cookie
     end
-
-    def login_url
-      "#{config.api_base_url}/~/login"
-    end
   end
 end

data/lib/urbit/subscribe_message.rb

@@ -1,19 +1,18 @@
-require 'json'
-
 module Urbit
   class SubscribeMessage < Message
     attr_reader :path
 
-    def initialize(channel, app, path)
-      @action  = 'subscribe'
-      @app     = app
-      @channel = channel
-      @id      = 0
-      @path    = path
+    def initialize(channel:, app:, path:)
+      super(channel: channel, app: app)
+      @path = path
+    end
+
+    def action
+      "subscribe"
     end
 
     def to_h
-      {action: action, app: app, id: id, path: path, ship: ship.untilded_name}
+      {action: self.action, app: self.app, id: self.id, path: self.path, ship: self.ship.untilded_name}
     end
   end
 end

data/misc/graph-store_graph

@@ -0,0 +1,51 @@
+{
+  :status => 200,
+  :code   => "ok",
+  :body   =>" {
+    "graph-update": {
+      "add-graph": {
+        "graph":{},
+        "resource" : {
+          "name": "dec74689ad",
+          "ship": "zod"
+        },
+        "mark" : "graph-validator-chat",
+        "overwrite":true
+      }
+    }
+  }
+}
+
+
+{
+  "status": 200,
+  "code": "ok",
+  "body": {
+    "graph-update": {
+      "add-graph": {
+        "graph": {
+          "170141184505196673936784618510385938432": {
+            "post" : {
+              "index": "/170141184505196673936784618510385938432",
+              "author": "zod",
+              "time-sent": 1628715932642,
+              "signatures": [
+                {"signature": "0x2.7d8e.58d0.ee70.c720.e0c7.0fbe.40be.f68c.0401.950e.1bb8.9eda.cb66.3726.8995.3ca2.2d51.aa34.fcc8.ea00.1193.9145.38c9.7fea.8285.bd4e.d390.a195.f7e6.0870.5f7c.c73b.67a7.d19c.375b.fc29.aac7.6879.04fa.6a0f.cb7f.9001", "life": 1 ,"ship": "zod\}
+              ],
+              "contents": [
+                {"text" : "test?"}
+              ],
+              "hash": "0x9f63.9634.3b9c.31c8.3831.c3ef.902f.bda3"},
+              "children":null
+          }
+        },
+        "resource" : {
+          "name": "dec74689ad",
+          "ship": "zod"
+        },
+        "mark": "graph-validator-chat",
+        "overwrite": true
+      }
+    }
+  }
+}

data/misc/graph-store_keys

@@ -0,0 +1,15 @@
+{
+  :status => 200,
+  :code   => "ok",
+  :body   => {
+    "graph-update": {
+      "keys": [
+        {"name": "announce", "ship": "darlur"},
+        {"name": "test0-996", "ship": "barsyr-latreb"},
+        {"name": "test1-4287", "ship": "barsyr-latreb"},
+        {"name": "welcome-to-urbit-community", "ship": "darrux-landes"},
+        {"name": "help-desk-4556", "ship": "darlur"}
+      ]
+    }
+  }
+}

data/misc/graph-store_node

@@ -0,0 +1,34 @@
+[1] pry(main)> ship = Urbit.connect(config_file: '_config-barsyr-latreb.yml')
+=> a Ship(name: '~barsyr-latreb', host: 'http://localhost', port: '8080')
+
+[2] pry(main)> ship.scry('graph-store', "/graph/~darlur/announce/node/siblings/newest/lone/1")
+=>
+  :status => 200,
+  :code   => "ok",
+  :body   => {
+    "graph-update": {
+      "add-nodes": {
+        "resource": {
+          "name": "announce",
+          "ship": "darlur"
+        },
+        "nodes" : {
+          "/170141184505036957608427254348286787584": {
+            "post" : {
+              "index": "/170141184505036957608427254348286787584",
+              "author": "darlur",
+              "time-sent": 1620057693019,
+              "signatures": [
+                {"signature": "0x5468.e5ec.1955.3e10.14a6.5fc0.054e.0e1b.fe01.1272.0a2c.e3c8.37a5.6717.ed7d.4b0c.3102.3966.4caa.edeb.e89e.3194.be17.f6a7.0622.4775.5e8f.7e92.16d2.c552.5ecd.d28b.17a6.aad5.089b.3623.eb8b.1b62.1525.0571.2d9f.9001", "life ": 3, "ship": "darlur"}
+              ],
+              "contents": [
+                {\"text\":\"We are now running urbit v1.5."}
+              ],
+              "hash": "0x5468.e5ec.1955.3e10.14a6.5fc0.054e.0e1b"
+            },
+          "children":null
+        }
+      }
+    }
+  }
+}

data/misc/graph-store_update

@@ -0,0 +1,76 @@
+[8] pry(main)> channel.receiver.facts.each {|f| puts f};nil
+{:message => {
+  "ok" => "ok",
+  "id" => 1,
+  "response" => "subscribe"}
+}
+{:message => {
+  "json" => {
+    "graph-update" => {
+      "add-nodes" => {
+        "resource" => {
+          "name" => "top-shelf-6391",
+          "ship" => "winter-paches"
+        },
+        "nodes" => {
+          "/170141184505207442993270453156437819392" => {
+            "post" => {
+              "index"=>"/170141184505207442993270453156437819392",
+              "author"=>"winter-paches",
+              "time-sent"=>1629299723410,
+              "signatures"=>[{"signature"=>"0x1.5003.94a6.2a10.7baf.ba44.a4d9.0353.e61a.0200.fdb2.fccf.f760.e1a0.bd20.dafa.f17e.e759.c8ab.f3b2.bb03.ccfa.1f10.c060.b063.cf32.48f6.ce27.4cae.462a.a228.47e9.5642.6476.5664.a918.839b.4053.91fe.b08c.f18c.525f.7001", "life"=>3, "ship"=>"winter-paches"}],
+              "contents"=>[{"text"=>"i will be really sad if hockey goes even more the way of the other sports."}],
+              "hash"=>"0xa801.ca53.1508.3dd7.dd22.526c.81a9.f30d"},
+              "children"=>nil
+            }
+          }
+        }
+      }
+    }, "id"=>1, "response"=>"diff"}}
+{:message => {
+  "json" => {
+    "graph-update"=>{"add-nodes"=>{"resource"=>{"name"=>"top-shelf-6391", "ship"=>"winter-paches"}, "nodes"=>{"/170141184505207446323799471187231244288"=>{"post"=>{"index"=>"/170141184505207446323799471187231244288", "author"=>"rivlyt-dotnet", "time-sent"=>1629299904766, "signatures"=>[{"signature"=>"0x668d.5edb.31d1.18ee.fb3a.7bd0.e6e6.6582.fe01.d7c0.61a7.aadf.c1b0.7e9c.26ad.8412.c3a5.6221.eff0.d25f.f505.18d9.693c.a888.debd.635d.c692.b138.9f5e.d52d.513d.291f.326b.2261.4a08.7680.58d0.e654.3556.bbd5.d43f.9001", "life"=>1, "ship"=>"rivlyt-dotnet"}], "contents"=>[{"url"=>"http://www.hockeyworldblog.com/wp-content/uploads/2009/07/SamiKapanenKalPa.jpg"}, {"text"=>""}], "hash"=>"0x668d.5edb.31d1.18ee.fb3a.7bd0.e6e6.6582"}, "children"=>nil}}}}}, "id"=>1, "response"=>"diff"}}
+{:message => {
+  "json" => {
+    "graph-update" => {
+      "add-nodes" => {
+        "resource" => {
+          "name" => "dm-inbox",
+          "ship" => "barsyr-latreb"
+        },
+        "nodes" => {
+          "/3830645248/170141184505207462626569476439992696832" => {
+            "post" => {
+              "index" => "/3830645248/170141184505207462626569476439992696832",
+              "author" => "winter-paches",
+              "time-sent" => 1629300788090,
+              "signatures" => [
+                {"signature" => "0x8b2.4b04.d55d.38fb.3561.6840.7312.2c5d.3e80.6494.9c69.0c8c.5480.21d8.87e1.93d4.79ca.e299.8482.17d6.b1d5.075f.837e.e1c9.9776.1a10.1710.f62a.6f68.8415.e85f.62c9.ff0f.b5b7.e605.bb8f.ee6e.d856.8505.08eb.901f.5001",
+                                "life"=>3,
+                                "ship"=>"winter-paches"}
+              ],
+              "contents"=>[
+                {"text"=>"still there?"}
+              ],
+              "hash"     => "0x22c9.2c13.5574.e3ec.d585.a101.cc48.b174"
+            },
+            "children" => {
+                "170141184505210800341365283904498434048" :{
+                  "post" : {
+                    "index": "/3830645248/170141184505210800341365283904498434048",
+                    "author": "winter-paches",
+                    "time-sent\":1629481725905,
+                    "signatures\":[{\"signature\":\"0x2cbc.3fa5.5e05.1851.0bc0.c139.7356.86dc.fa01.24bf.82c7.078d.59b7.7365.de54.87de.6043.7cca.1bcc.5746.cb4e.6585.f81e.ab97.edf4.9b5e.e499.1df3.486f.965b.0247.6cdd.8ed8.2a70.37f1.f9ec.97dd.6d55.19f5.0b0d.e17f.9001\",\"life\":3,\"ship\":\"winter-paches\"}],
+                    "contents\":[{\"text\":\"two\"}],
+                    "hash\":\"0x2cbc.3fa5.5e05.1851.0bc0.c139.7356.86dc\"
+                  },
+                  "children": null
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "id"=>1,
+    "response"=>"diff"}}

data/misc/graph-update_add-graph

@@ -0,0 +1,20 @@
+{
+  :message=> {
+    "json"=> {
+      "graph-update"=> {
+        "add-graph"=> {
+          "graph" => {
+          },
+          "resource" => {
+            "name" => "test1-4287",
+            "ship" => "barsyr-latreb"
+          },
+          "mark" => "graph-validator-publish",
+          "overwrite" => true
+        }
+      }
+    },
+    "id" => 2,
+    "response" => "diff"
+  }
+}

data/misc/graph-update_add-nodes

@@ -0,0 +1,75 @@
+{
+  :message => {
+    "json" => {
+      "graph-update" => {
+        "add-nodes" => {
+          "resource" => {
+            "name" => "test1-4287",
+            "ship" => "barsyr-latreb"
+          },
+          "nodes" => {
+            "/170141184505020984719232265951207489536/2" => {
+              "post" => {
+                "index" => "/170141184505020984719232265951207489536/2",
+                "author" => "barsyr-latreb",
+                "time-sent" => 1619191801085,
+                "signatures"=> [
+                  {
+                    "signature" => "0x1.284d.9ddd.b0ca.3b77.ce22.bea4.4fad.1018.0200.fb46.de9e.541a.7c0d.c680.20a3.986c.ce0f.944b.4f48.cdb1.64aa.bc8a.ce34.c7ee.bcc4.47ce.7dd2.8b98.12b8.c69b.98ae.73e3.3a40.592e.11b2.1445.6cbf.bfbc.6e60.6815.e1bf.7001",
+                    "life"=>3,
+                    "ship"=>"barsyr-latreb"
+                  }
+                ],
+                "contents" => [],
+                "hash"     =>"0x9426.ceee.d865.1dbb.e711.5f52.27d6.880c"
+              },
+              "children" => nil
+            },
+            "/170141184505020984719232265951207489536/1/1" => {
+              "post" => {
+                "index" => "/170141184505020984719232265951207489536/1/1",
+                "author" => "barsyr-latreb",
+                "time-sent" =>1619191801085,
+                "signatures" => [
+                  {
+                    "signature" => "0x4abf.c85f.4db6.bda6.a5ca.155c.f479.c1ee.0080.36c0.7fc4.fc07.5492.fba6.0eac.bcd1.6cde.3f05.46cb.7654.cb78.8baa.f398.37d6.5098.a7ce.6a07.6cfe.5f99.6ee2.b3a1.6717.ac2d.c396.6a86.5495.d88e.fc55.cbbf.0e1e.70ff.3001",
+                    "life" =>3,
+                    "ship" => "barsyr-latreb"
+                  }
+                ],
+                "contents" => [
+                  {"text" => "Post 1"},
+                  {"text" => "First post of the graph store portion of the airlock implementation."}
+                ],
+                "hash" => "0x957f.90be.9b6d.7b4d.4b94.2ab9.e8f3.83dc"
+              },
+              "children" => nil
+            },
+           "/170141184505020984719232265951207489536"=>
+            {"post"=>
+              {"index"=>"/170141184505020984719232265951207489536",
+               "author"=>"barsyr-latreb",
+               "time-sent"=>1619191801085,
+               "signatures"=>
+                [{"signature"=>
+                   "0x6401.1904.eca5.c18c.d9a4.cf52.d00d.6bc5.8080.247c.6a06.3709.44ce.ad7e.fd14.bccb.c982.3df6.dba3.c727.cccd.f433.47b5.2342.780c.0b27.4fd8.85eb.4c67.5466.565c.3fc6.66c5.1832.72da.2557.940b.3549.14a7.66ab.e1df.3001",
+                  "life"=>3,
+                  "ship"=>"barsyr-latreb"}],
+               "contents"=>[],
+               "hash"=>"0xc802.3209.d94b.8319.b349.9ea5.a01a.d78b"},
+             "children"=>nil},
+           "/170141184505020984719232265951207489536/1"=>
+            {"post"=>
+              {"index"=>"/170141184505020984719232265951207489536/1",
+               "author"=>"barsyr-latreb",
+               "time-sent"=>1619191801085,
+               "signatures"=>
+                [{"signature"=>
+                   "0x1.284d.9ddd.b0ca.3b77.ce22.bea4.4fad.1018.0200.fb46.de9e.541a.7c0d.c680.20a3.986c.ce0f.944b.4f48.cdb1.64aa.bc8a.ce34.c7ee.bcc4.47ce.7dd2.8b98.12b8.c69b.98ae.73e3.3a40.592e.11b2.1445.6cbf.bfbc.6e60.6815.e1bf.7001",
+                  "life"=>3,
+                  "ship"=>"barsyr-latreb"}],
+               "contents"=>[],
+               "hash"=>"0x9426.ceee.d865.1dbb.e711.5f52.27d6.880c"},
+             "children"=>nil}}}}},
+   "id"=>2,
+   "response"=>"diff"}}

data/misc/post

@@ -0,0 +1,12 @@
+"post" => {
+  "index"      => "/170141184504863525594513045663867817951",
+  "author"     => "barsyr-latreb",
+  "time-sent"  => 1610655924876,
+  "signatures" => [],
+  "contents"   => [
+    {"text" => "~all : another new planet has coalesced..."},
+    {"mention"=> "barsyr-latreb"},
+    {"text" => "."}
+  ],
+  "hash"       => nil
+},

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"
+  }
+]

data/urbit-api.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name          = "urbit-api"
   spec.version       = Urbit::Api::VERSION
   spec.authors       = ["Daryl Richter"]
-  spec.email         = ["daryl@deliverycircle.com"]
+  spec.email         = ["daryl@ngzax.com"]
 
   spec.summary       = %q{The Ruby interface to the Urbit HTTP API}
   spec.description   = %q{Access your urbit ship the ruby way. It's a Martian gem.}
@@ -13,8 +13,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.2")
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
   spec.metadata["homepage_uri"]    = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Zaxonomy/urbit-ruby"
   spec.metadata["changelog_uri"]   = "https://github.com/Zaxonomy/urbit-ruby/CHANGELOG.md"