urbit-api 0.3.0 → 0.4.0

data/lib/urbit/settings.rb

@@ -0,0 +1,103 @@
+# 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
+
+  class Settings < Set
+    class << self
+      def load(ship:)
+        ship.subscribe(app: 'settings-store', path: '/all')
+        scry = ship.scry(app: "settings-store", path: "/all", mark: "json")
+        # scry = self.scry(app: "settings-store", path: "/desk/#{desk}", mark: "json")
+        s = Settings.new
+        if scry[:body]
+          body = JSON.parse scry[:body]
+          body["all"].each do |k, v|  # At this level the keys are the desks and the values are the buckets
+            s << Setting.new(ship: ship, desk: k, buckets: v)
+          end
+        end
+        s
+      end
+    end
+
+    def initialize
+      @hash    = {}
+    end
+
+    def [](desk:)
+      self.select {|s| desk == s.desk}.first
+    end
+
+    def list
+      self.each {|s| puts s.to_string}
+      nil
+    end
+  end
+
+end

data/lib/urbit/ship.rb

@@ -3,19 +3,21 @@ require 'faraday'
 require 'urbit/channel'
 require 'urbit/config'
 require 'urbit/graph'
-require 'urbit/setting'
+require 'urbit/group_manager'
+require 'urbit/settings'
 
 module Urbit
   class Ship
     attr_accessor :logged_in
-    attr_reader :auth_cookie, :channels, :config
+    attr_reader :auth_cookie, :channels, :config, :group_mgr
 
     def initialize(config: Config.new)
       @auth_cookie = nil
       @channels    = []
       @config      = config
       @graphs      = []
-      @settings    = []
+      @group_mgr   = GroupManager.new ship: self
+      @settings    = nil                         # Use lazy initialization here
       @logged_in   = false
     end
 
@@ -62,12 +64,28 @@ 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
+    end
+
     def login
       return self if logged_in?
 
       ensure_connections_closed
       response = Faraday.post(login_url, "password=#{config.code}")
       parse_cookie(response)
+      @group_mgr.load
       self
     end
 
@@ -75,6 +93,24 @@ module Urbit
       config.name
     end
 
+    def open_channels
+      @channels.select {|c| c.open?}
+    end
+
+    def pat_p
+      config.name
+    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 remove_graph(desk: 'landscape', graph:)
       delete_json = %Q({
         "delete": {
@@ -92,66 +128,10 @@ module Urbit
       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
-
-    def pat_p
-      config.name
-    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}"
+      scry_url = "#{self.url}/~/scry/#{app}#{path}#{mark}"
 
       response = Faraday.get(scry_url) do |req|
         req.headers['Accept'] = 'application/json'
@@ -161,9 +141,20 @@ module Urbit
       {status: response.status, code: response.reason_phrase, body: response.body}
     end
 
+    #
+    # Answers the object managing the Settings on this ship.
+    # This object provides all the helper methods to list, update, and remove a Setting
+    #
+    def settings
+      if self.logged_in?
+        @settings = Settings.load(ship: self) if @settings.nil?
+      end
+      @settings
+    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"
+      url = "#{self.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
@@ -211,6 +202,14 @@ module Urbit
       "a Ship(#{self.to_h})"
     end
 
+    def untilded_name
+      name.gsub('~', '')
+    end
+
+    def url
+      self.config.api_base_url
+    end
+
     private
 
     def add_channel
@@ -229,7 +228,7 @@ module Urbit
     end
 
     def login_url
-      "#{config.api_base_url}/~/login"
+      "#{self.url}/~/login"
     end
 
     def parse_cookie(resp)

data/lib/urbit/version.rb

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

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

@@ -1,5 +1,6 @@
-require_relative './config'
-require_relative './ship'
+require "urbit/config"
+require "urbit/ship"
+require "urbit/version"
 
 # This is the main namespace for Urbit.
 #

data/urbit-api.gemspec

@@ -1,8 +1,8 @@
-require_relative 'lib/urbit/api/version'
+require_relative 'lib/urbit/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "urbit-api"
-  spec.version       = Urbit::Api::VERSION
+  spec.version       = Urbit::VERSION
   spec.authors       = ["Daryl Richter"]
   spec.email         = ["daryl@ngzax.com"]
 
@@ -18,17 +18,16 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"]   = "https://github.com/Zaxonomy/urbit-ruby/CHANGELOG.md"
 
   # 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(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files =  Dir.glob("lib{.rb,/**/*}", File::FNM_DOTMATCH).reject {|f| File.directory?(f) }
+  spec.files += %w[urbit-api.gemspec]    # include the gemspec itself because warbler breaks w/o it
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday",        "~> 1.3.0"
-  spec.add_dependency "ld-eventsource", "~> 2.0.0"
+  spec.add_dependency "faraday",        "~> 2.2.0"
+  spec.add_dependency "ld-eventsource", "~> 2.2.0"
+  spec.add_dependency "uri",            "0.10.0"        # Pinning this for now b/c 0.11 is broken. :(
 
   spec.add_development_dependency "pry",   "~> 0.13"
   spec.add_development_dependency "rspec", "~> 3.10"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbit-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Daryl Richter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: ld-eventsource
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -73,45 +87,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- CHANGELOG.md
-- Gemfile
-- LICENSE.txt
-- README.gem.md
-- README.md
-- Rakefile
-- _config.yml
-- bin/console
-- bin/setup
-- bin/test
+- lib/urbit.rb
 - lib/urbit/ack_message.rb
 - lib/urbit/api.rb
-- lib/urbit/api/version.rb
+- lib/urbit/bucket.rb
 - lib/urbit/channel.rb
 - lib/urbit/chat_channel.rb
 - lib/urbit/close_message.rb
 - lib/urbit/config.rb
 - lib/urbit/fact.rb
+- lib/urbit/fact/base_fact.rb
+- lib/urbit/fact/graph_fact.rb
+- lib/urbit/fact/group_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/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
-- lib/urbit/urbit.rb
-- misc/graph-store_graph
-- misc/graph-store_keys
-- misc/graph-store_node
-- misc/graph-store_update
-- misc/graph-update_add-graph
-- misc/graph-update_add-nodes
-- misc/post
-- misc/settings-store.json
+- lib/urbit/version.rb
 - urbit-api.gemspec
 homepage: https://www.ngzax.com
 licenses:

data/.gitignore

@@ -1,25 +0,0 @@
-_config-*.yml
-*.gem
-*.rbc
-/coverage/
-/pkg/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-# .ruby-gemset

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/.ruby-version

@@ -1,2 +0,0 @@
-2.7.4
-

data/CHANGELOG.md

@@ -1 +0,0 @@
-Nothing to see here.

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in urbit-api.gemspec
-gemspec
-
-gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Daryl Richter
-
-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.gem.md

@@ -1,4 +0,0 @@
-
-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/urbit/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem