conreality 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df892d6caf11ad3f9fcb527807a7cf78c718eed71e71e18c6a7c12798577604d
+  data.tar.gz: 8ebee26f5b26f9345081ab9fb1fc96b410feaac46ab3ea134974ed2d88707a16
+SHA512:
+  metadata.gz: ef4941aff380f0e717a2f7ae685ec51938a2bc0f064950b6c38d4955fe6486e7dafdb31e1a7c529942caa030d29cc537a869a77c1727345924dbd2cdf6057948
+  data.tar.gz: 29cbab1eafee83fa1b1ab7f4bba8363c703b5c1be7433fa94f8fa162a86d276115e6707c2077691556bd8567b641cc46fb4108c29919d83d91c4091d146f6118

data/AUTHORS

@@ -0,0 +1 @@
+* Arto Bendiken <arto@conreality.org>

data/CREDITS.rst

@@ -0,0 +1,3 @@
+*******
+Credits
+*******

data/README

@@ -0,0 +1,6 @@
+Conreality Software Development Kit (SDK) for Ruby
+==================================================
+
+See <https://sdk.conreality.org/ruby/> for documentation.
+
+Use <https://github.com/conreality/conreality.rb/issues> for bug reports.

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/conreality.rb

@@ -0,0 +1,18 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'conreality/version'
+
+#require_relative 'conreality/object'
+#require_relative 'conreality/asset'
+#require_relative 'conreality/camera'
+#require_relative 'conreality/player'
+
+#require_relative 'conreality/binary'
+require_relative 'conreality/event'
+require_relative 'conreality/message'
+#require_relative 'conreality/theater'
+
+#require_relative 'conreality/action'
+require_relative 'conreality/client'
+require_relative 'conreality/game'
+require_relative 'conreality/session'

data/lib/conreality/action.rb

@@ -0,0 +1,62 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # A transaction-scoped action.
+  class Action
+    ##
+    # The client session this actions belongs to.
+    #
+    # @return [Session]
+    attr_reader :session
+
+    ##
+    # @param session [Session]
+    def initialize(session)
+      @session = session
+    end
+
+    ##
+    # Returns a developer-friendly representation of this action.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x>", self.class.name, self.__id__)
+    end
+
+    # @!group Events
+
+    ##
+    # @param  predicate [String] a predicate string
+    # @param  subject   [Object, UUID] the source object
+    # @param  object    [Object, UUID, nil] the target object, if any
+    # @return [Event]   the sent event
+    def send_event(predicate, subject, object = nil)
+      predicate = predicate.to_s
+      subject   = (subject.respond_to?(:uuid) ? subject.uuid : subject).to_s
+      object    = object ? (object.respond_to?(:uuid) ? object.uuid : object).to_s : nil
+
+      result = @session.client.call_proc_with_result(:event_send, args: [predicate, subject, object])
+      result ? Conreality::Event.new(@session, result.to_i) : nil
+    end
+
+    # @!endgroup
+
+    # @!group Messaging
+
+    ##
+    # @param  sender    [Object, UUID] the sending asset or player
+    # @param  text      [String] the message contents as text
+    # @return [Message] the sent message
+    # @todo   Support for audio messages.
+    def send_message(sender, text)
+      sender = (sender.respond_to?(:uuid) ? sender.uuid : sender).to_s
+      text = text.to_s
+
+      result = @session.client.call_proc_with_result(:message_send, args: [sender, text])
+      result ? Conreality::Message.new(@session, result.to_i) : nil
+    end
+
+    # @!endgroup
+  end # Action
+end # Conreality

data/lib/conreality/asset.rb

@@ -0,0 +1,48 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality asset.
+  class Asset < Object
+    TABLE = :object_asset
+    KEY   = :uuid
+
+    ##
+    # The asset's nickname.
+    #
+    # @return [String]
+    attr_accessor :nick
+
+    ##
+    # The asset's full name.
+    #
+    # @return [String]
+    attr_accessor :name
+
+    ##
+    # The asset's IPv4/IPv6 address.
+    #
+    # @return [String]
+    attr_accessor :ip_addr
+
+    ##
+    # The asset's avatar image.
+    #
+    # @return [Binary]
+    attr_accessor :avatar
+    attr_wrapper :avatar, :Binary
+
+    ##
+    # The asset's deployed software version.
+    #
+    # @return [String]
+    attr_accessor :version
+
+    ##
+    # @param session [Session]
+    # @param uuid    [#to_s]
+    def initialize(session, uuid)
+      super(session, uuid)
+    end
+  end # Asset
+end # Conreality

data/lib/conreality/binary.rb

@@ -0,0 +1,50 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality binary.
+  class Binary #< Database::Row
+    TABLE = :binary
+    KEY   = :id
+
+    ##
+    # The binary's sequential identifier.
+    #
+    # @return [Integer]
+    attr_reader :id
+
+    ##
+    # The binary's unique identifier (SHA-256 fingerprint).
+    #
+    # @return [String]
+    attr_reader :sha256
+
+    ##
+    # The binary's MIME content type.
+    #
+    # @return [String]
+    attr_accessor :type
+
+    ##
+    # The binary data.
+    #
+    # @return [String]
+    attr_reader :data
+
+    ##
+    # @param session [Session]
+    # @param id      [#to_i]
+    def initialize(session, id)
+      super(session)
+      @id = id.to_i
+    end
+
+    ##
+    # Returns a developer-friendly representation of this binary.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(id: %s)>", self.class.name, self.__id__, @id)
+    end
+  end # Binary
+end # Conreality

data/lib/conreality/camera.rb

@@ -0,0 +1,41 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality camera.
+  class Camera < Object
+    TABLE = :object_camera
+    KEY   = :uuid
+
+    ##
+    # The camera's resolution (in 2D pixels).
+    #
+    # @return [Array(Integer, Integer)]
+    attr_accessor :resolution
+
+    ##
+    # The camera's image format.
+    #
+    # @return [String]
+    attr_accessor :format
+
+    ##
+    # The camera's frame rate (per second).
+    #
+    # @return [Integer]
+    attr_accessor :fps
+
+    ##
+    # The camera's f-number (the f/N focal ratio).
+    #
+    # @return [Integer]
+    attr_accessor :fnumber
+
+    ##
+    # @param session [Session]
+    # @param uuid    [#to_s]
+    def initialize(session, uuid)
+      super(session, uuid)
+    end
+  end # Camera
+end # Conreality

data/lib/conreality/client.rb

@@ -0,0 +1,105 @@
+# This is free and unencumbered software released into the public domain.
+
+require 'uuid'
+
+require_relative 'rpc'
+require_relative 'session'
+require_relative 'version'
+
+module Conreality
+  ##
+  # Client for accessing a Conreality master server.
+  class Client
+    attr_reader :rpc_public
+    attr_reader :rpc_session
+
+    ##
+    # @param master_host [String]
+    def self.connect(master_host, *args)
+      self.new(master_host, *args).connect
+    end
+
+    ##
+    # @param master_host [String]
+    def initialize(master_host)
+      channel_creds = :this_channel_is_insecure
+      @channel      = RPC::Session::Stub.setup_channel(nil, master_host, channel_creds)
+      @rpc_public   = RPC::Public::Stub.new(master_host, channel_creds, channel_override: @channel)
+      @rpc_session  = RPC::Session::Stub.new(master_host, channel_creds, channel_override: @channel)
+    end
+
+    ##
+    # Returns a developer-friendly representation of this client.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x>", self.class.name, self.__id__)
+    end
+
+    # @!group Connection management
+
+    ##
+    # Connects to the server.
+    #
+    # @return [Client] `self`
+    def connect
+      self
+    end
+
+    ##
+    # Disconnects from the server.
+    #
+    # @return [void]
+    def disconnect!
+      @channel = @rpc_public = @rpc_session = nil
+    end
+
+    # @!endgroup
+
+    # @!group Public interface
+
+    ##
+    # Invokes the public `Authenticate` method on the server.
+    #
+    # @param  agent_uuid [String]
+    # @param  secret [String]
+    # @return [Session]
+    def authenticate(agent_uuid, secret = nil)
+      Session.new(self, 1) # TODO
+    end
+
+    ##
+    # Invokes the public `Bye` method on the server.
+    #
+    # @return [void]
+    def bye
+      @rpc_public.bye(RPC::EmptyRequest.new)
+    end
+
+    ##
+    # Invokes the public `Hello` method on the server.
+    #
+    # @return [Hash]
+    def hello
+      {version: @rpc_public.hello(RPC::HelloRequest.new(version: Conreality::VERSION.to_s)).version}.freeze
+    end
+
+    ##
+    # Invokes the public `Ping` method on the server.
+    #
+    # @return [void]
+    def ping
+      @rpc_public.ping(RPC::PingRequest.new)
+    end
+
+    # @!endgroup
+
+    # @!group Session interface
+
+    # @!endgroup
+
+  private
+
+    # TODO
+  end # Client
+end # Conreality

data/lib/conreality/event.rb

@@ -0,0 +1,57 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality event.
+  class Event
+    TABLE = :event
+    KEY   = :id
+
+    ##
+    # The event's sequential identifier.
+    #
+    # @return [Integer]
+    attr_reader :id
+
+    ##
+    # The event's timestamp (in Zulu time).
+    #
+    # @return [Time]
+    attr_reader :timestamp
+
+    ##
+    # The event's predicate (an action or verb).
+    #
+    # @return [Symbol]
+    attr_reader :predicate
+
+    ##
+    # The subject (i.e., source) of the predicate.
+    #
+    # @return [Object]
+    attr_reader :subject
+    #attr_wrapper :subject, :Object
+
+    ##
+    # The object (i.e., target) of the predicate.
+    #
+    # @return [Object]
+    attr_reader :object
+    #attr_wrapper :object, :Object
+
+    ##
+    # @param session [Session]
+    # @param id      [#to_i]
+    def initialize(session, id)
+      @session, @id = session, id.to_i
+    end
+
+    ##
+    # Returns a developer-friendly representation of this event.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(id: %s)>", self.class.name, self.__id__, @id)
+    end
+  end # Event
+end # Conreality

data/lib/conreality/game.rb

@@ -0,0 +1,81 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # The game database.
+  class Game
+    ##
+    # @param session [Session]
+    def initialize(session)
+      @session = session
+    end
+
+    ##
+    # Returns a developer-friendly representation of this action.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x>", self.class.name, self.__id__)
+    end
+
+    # @!group Theaters
+
+    ##
+    # Returns the theater identified by the given UUID.
+    #
+    # @param  uuid [String] the theater's UUID
+    # @return [Theater] the theater
+    def find_theater(uuid)
+      Conreality::Theater.new(@session, uuid)
+    end
+
+    ##
+    # @todo
+    def each_theater(&block)
+      # TODO
+    end
+
+    # @!endgroup
+
+    # @!group Objects
+
+    ##
+    # Returns the object identified by the given UUID.
+    #
+    # @param  uuid [String] the object's UUID
+    # @return [Object] the object
+    def find_object(uuid)
+      Conreality::Object.new(@session, uuid)
+    end
+
+    ##
+    # @todo
+    def each_object(&block)
+      # TODO
+    end
+
+    # @!endgroup
+
+    # @!group Events
+
+    ##
+    # @todo
+    # @return [Event] the event
+    def find_event(id)
+      # TODO
+    end
+
+    # @!endgroup
+
+    # @!group Messaging
+
+    ##
+    # @todo
+    # @return [Message] the message
+    def find_message(id)
+      # TODO
+    end
+
+    # @!endgroup
+  end # Game
+end # Conreality

data/lib/conreality/message.rb

@@ -0,0 +1,57 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality message.
+  class Message
+    TABLE = :message
+    KEY   = :id
+
+    ##
+    # The message's sequential identifier.
+    #
+    # @return [Integer]
+    attr_reader :id
+
+    ##
+    # The message's timestamp (in Zulu time).
+    #
+    # @return [Time]
+    attr_reader :timestamp
+
+    ##
+    # The sender of the message.
+    #
+    # @return [Player, Asset]
+    attr_reader :sender
+    #attr_wrapper :sender, :Object
+
+    ##
+    # The message's contents as text.
+    #
+    # @return [String]
+    attr_reader :text
+
+    ##
+    # The message's contents as audio.
+    #
+    # @return [Binary]
+    attr_reader :audio
+    #attr_wrapper :audio, :Binary
+
+    ##
+    # @param session [Session]
+    # @param id      [#to_i]
+    def initialize(session, id)
+      @session, @id = session, id.to_i
+    end
+
+    ##
+    # Returns a developer-friendly representation of this message.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(id: %s)>", self.class.name, self.__id__, @id)
+    end
+  end # Message
+end # Conreality

data/lib/conreality/object.rb

@@ -0,0 +1,163 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality object.
+  class Object #< Database::Row
+    TABLE = :object
+    KEY   = :uuid
+
+    ##
+    # The object's unique identifier.
+    #
+    # @return [String]
+    attr_reader :uuid
+
+    ##
+    # The object's type.
+    #
+    # @return [Symbol]
+    attr_reader :type
+
+    ##
+    # The theater that the object is located in.
+    #
+    # @return [Theater]
+    attr_accessor :theater
+
+    ##
+    # The group, if any, that the object belongs to.
+    #
+    # @return [Group]
+    attr_accessor :group
+
+    ##
+    # The object's designated label.
+    #
+    # @return [String]
+    attr_accessor :label
+
+    ##
+    # The object's current position (as 3D coordinates relative to its theater).
+    #
+    # @return [?]
+    attr_accessor :position
+
+    ##
+    # The object's current orientation (in radians relative to north).
+    #
+    # @return [Float]
+    attr_accessor :orientation
+
+    ##
+    # The object's estimated mass (in kilograms).
+    #
+    # @return [Float]
+    attr_accessor :mass
+
+    ##
+    # The object's determined radius (in meters).
+    #
+    # @return [Float]
+    attr_accessor :radius
+
+    ##
+    # The object's estimated color (as a 24-bit RGB value).
+    #
+    # @return [Integer]
+    attr_accessor :color
+
+    ##
+    # @param session [Session]
+    # @param uuid   [#to_s]
+    def initialize(session, uuid)
+      super(session)
+      @uuid = uuid.to_s.freeze
+    end
+
+    ##
+    # Returns a developer-friendly representation of this object.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(uuid: %s)>", self.class.name, self.__id__, @uuid)
+    end
+
+    # @!group Casts
+
+    ##
+    # Returns this object cast to an asset.
+    #
+    # @return [Asset]
+    def as_asset
+      Asset.new(@session, @uuid)
+    end
+
+    ##
+    # Returns this object cast to a camera.
+    #
+    # @return [Camera]
+    def as_camera
+      Camera.new(@session, @uuid)
+    end
+
+    ##
+    # Returns this object cast to a player.
+    #
+    # @return [Player]
+    def as_player
+      Player.new(@session, @uuid)
+    end
+
+    # @!endgroup
+
+    # @!group Predicates
+
+    ##
+    # Checks whether this object is an asset.
+    #
+    # @return [Boolean]
+    def is_asset?
+      nil # TODO
+    end
+
+    ##
+    # Checks whether this object is a camera.
+    #
+    # @return [Boolean]
+    def is_camera?
+      nil # TODO
+    end
+
+    ##
+    # Checks whether this object is a player.
+    #
+    # @return [Boolean]
+    def is_player?
+      nil # TODO
+    end
+
+    ##
+    # Checks whether this object is a target.
+    #
+    # @return [Boolean]
+    def is_target?
+      nil # TODO
+    end
+
+    # @!endgroup
+
+    # @!group Messaging
+
+    ##
+    # @param  text      [String] the message contents as text
+    # @return [Message] the sent message
+    def send_message(text)
+      @session.execute do |action| # FIXME
+        action.send_message(self, text)
+      end
+    end
+
+    # @!endgroup
+  end # Object
+end # Conreality

data/lib/conreality/player.rb

@@ -0,0 +1,74 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality player.
+  class Player < Object
+    TABLE = :object_player
+    KEY   = :uuid
+
+    ##
+    # The player's nickname.
+    #
+    # @return [String]
+    attr_accessor :nick
+
+    ##
+    # The player's full name.
+    #
+    # @return [String]
+    attr_accessor :name
+
+    ##
+    # The player's IPv4/IPv6 address.
+    #
+    # @return [String]
+    attr_accessor :ip_addr
+
+    ##
+    # The player's avatar image.
+    #
+    # @return [Binary]
+    attr_accessor :avatar
+    attr_wrapper :avatar, :Binary
+
+    ##
+    # The player's primary language.
+    #
+    # @return [String]
+    attr_accessor :language
+
+    ##
+    # @param session [Session]
+    # @param uuid    [#to_s]
+    def initialize(session, uuid)
+      super(session, uuid)
+    end
+
+    ##
+    # Checks whether this player has a bodycam.
+    #
+    # @return [Boolean]
+    def has_camera?
+      @session.client.exec_with_params("SELECT COUNT(*) FROM #{q(Database::SCHEMA)}.#{q(:camera)} WHERE #{q(:uuid)} = $1 LIMIT 1", self.key) do |result|
+        !!result.num_tuples.nonzero?
+      end
+    end
+
+    ##
+    # Returns the bodycam, if any, of this player.
+    #
+    # @return [Camera, nil]
+    def camera
+      self.has_camera? ? self.as_camera : nil
+    end
+
+    ##
+    # Deregisters this player from the game.
+    #
+    # @return [void]
+    def deregister!
+      # TODO
+    end
+  end # Player
+end # Conreality

data/lib/conreality/rpc.rb

@@ -0,0 +1,6 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'rpc/common_pb'
+require_relative 'rpc/model_pb'
+require_relative 'rpc/master_pb'
+require_relative 'rpc/master_services_pb'

data/lib/conreality/rpc/common_pb.rb

@@ -0,0 +1,36 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: conreality/rpc/common.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "Conreality.RPC.EmptyRequest" do
+  end
+  add_message "Conreality.RPC.EmptyResponse" do
+  end
+  add_message "Conreality.RPC.IDResponse" do
+    optional :id, :uint64, 1
+  end
+  add_message "Conreality.RPC.PingRequest" do
+  end
+  add_message "Conreality.RPC.PongResponse" do
+  end
+  add_message "Conreality.RPC.HelloRequest" do
+    optional :version, :string, 1
+  end
+  add_message "Conreality.RPC.HelloResponse" do
+    optional :version, :string, 1
+  end
+end
+
+module Conreality
+  module RPC
+    EmptyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.EmptyRequest").msgclass
+    EmptyResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.EmptyResponse").msgclass
+    IDResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.IDResponse").msgclass
+    PingRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.PingRequest").msgclass
+    PongResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.PongResponse").msgclass
+    HelloRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.HelloRequest").msgclass
+    HelloResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.HelloResponse").msgclass
+  end
+end

data/lib/conreality/rpc/master_pb.rb

@@ -0,0 +1,39 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: conreality/rpc/master.proto
+
+require 'google/protobuf'
+
+require 'conreality/rpc/model_pb'
+require 'conreality/rpc/common_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "Conreality.RPC.AuthRequest" do
+    optional :player_nick, :string, 1
+  end
+  add_message "Conreality.RPC.AuthResponse" do
+    optional :session_id, :uint64, 1
+  end
+  add_message "Conreality.RPC.SendEventRequest" do
+    optional :session_id, :uint64, 1
+    optional :predicate, :string, 2
+    optional :subject_uuid, :string, 3
+    optional :object_uuid, :string, 4
+  end
+  add_message "Conreality.RPC.SendMessageRequest" do
+    optional :session_id, :uint64, 1
+    optional :text, :string, 2
+  end
+  add_message "Conreality.RPC.UpdatePlayerRequest" do
+    optional :session_id, :uint64, 1
+    optional :heartbeat, :uint32, 2
+  end
+end
+
+module Conreality
+  module RPC
+    AuthRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.AuthRequest").msgclass
+    AuthResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.AuthResponse").msgclass
+    SendEventRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.SendEventRequest").msgclass
+    SendMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.SendMessageRequest").msgclass
+    UpdatePlayerRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("Conreality.RPC.UpdatePlayerRequest").msgclass
+  end
+end

data/lib/conreality/rpc/master_services_pb.rb

@@ -0,0 +1,47 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: conreality/rpc/master.proto for package 'Conreality.RPC'
+# Original file comments:
+# This is free and unencumbered software released into the public domain. 
+#
+
+require 'grpc'
+require 'conreality/rpc/master_pb'
+
+module Conreality
+  module RPC
+    module Public
+      class Service
+
+        include GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'Conreality.RPC.Public'
+
+        rpc :Authenticate, AuthRequest, AuthResponse
+        rpc :Bye, EmptyRequest, EmptyResponse
+        rpc :Hello, HelloRequest, HelloResponse
+        rpc :Ping, PingRequest, PongResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+    module Session
+      class Service
+
+        include GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'Conreality.RPC.Session'
+
+        rpc :Ping, PingRequest, PongResponse
+        rpc :SendEvent, SendEventRequest, IDResponse
+        rpc :SendMessage, SendMessageRequest, IDResponse
+        rpc :UpdatePlayer, UpdatePlayerRequest, EmptyResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+  end
+end

data/lib/conreality/rpc/model_pb.rb

@@ -0,0 +1,12 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: conreality/rpc/model.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+end
+
+module Conreality
+  module RPC
+  end
+end

data/lib/conreality/session.rb

@@ -0,0 +1,129 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'event'
+require_relative 'game'
+require_relative 'message'
+
+module Conreality
+  ##
+  # An authenticated session.
+  class Session
+    ##
+    # The client connection this session belongs to.
+    #
+    # @return [Client]
+    attr_reader :client
+
+    ##
+    # The session ID.
+    #
+    # @return [Integer]
+    attr_reader :id
+
+    ##
+    # @param client [Client]
+    # @param id [Integer]
+    def initialize(client, id)
+      @client, @id = client, id.to_i
+    end
+
+    ##
+    # Returns a developer-friendly representation of this session.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x>", self.class.name, self.__id__)
+    end
+
+    ##
+    # Invokes the session-scoped `Ping` method on the server.
+    #
+    # @return [void]
+    def ping
+      @client.rpc_session.ping(RPC::PingRequest.new)
+    end
+
+    ##
+    # Invokes the session-scoped `SendEvent` method on the server.
+    #
+    # @param  [String, #to_s] predicate
+    # @param  [Object] subject
+    # @param  [Object] object
+    # @return [Event]
+    def send_event(predicate, subject, object)
+      response = @client.rpc_session.send_event(
+        RPC::SendEventRequest.new(
+          session_id: @id,
+          predicate: predicate,
+          subject: subject,
+          object: object,
+        )
+      )
+      Event.new(self, response.id)
+    end
+
+    ##
+    # Invokes the session-scoped `SendMessage` method on the server.
+    #
+    # @param  [String, #to_s] text
+    # @return [Message]
+    def send_message(text)
+      response = @client.rpc_session.send_message(
+        RPC::SendMessageRequest.new(
+          session_id: @id,
+          text: text.to_s,
+        )
+      )
+      Message.new(self, response.id)
+    end
+
+    ##
+    # Invokes the session-scoped `UpdatePlayer` method on the server.
+    #
+    # @return [void]
+    def update_player()
+      @client.rpc_session.update_player(
+        RPC::UpdatePlayerRequest.new(
+          session_id: @id,
+        )
+      )
+    end
+
+    ##
+    # Terminates this session.
+    #
+    # @return [void]
+    def logout!
+      # TODO
+      @client = nil
+    end
+
+    ##
+    # TODO
+    #
+    # @return [Game]
+    def game
+      Game.new(self)
+    end
+
+    # @!group Action execution
+
+    ##
+    # @yield  [action]
+    # @yieldparam  action [Action]
+    # @yieldreturn [void]
+    # @return [void]
+    def _execute(&block)
+      action = Action.new(self)
+      if @client.connection.transaction_status.zero?
+        # not yet in transaction scope
+        @client.connection.transaction { |_| block.call(action) }
+      else
+        # already in transaction scope
+        block.call(action)
+      end
+    end
+
+    # @!endgroup
+  end # Session
+end # Conreality

data/lib/conreality/theater.rb

@@ -0,0 +1,74 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  ##
+  # Represents a Conreality theater of operations.
+  class Theater #< Database::Row
+    TABLE = :theater
+    KEY   = :uuid
+
+    ##
+    # The theater's unique identifier.
+    #
+    # @return [String]
+    attr_reader :uuid
+
+    ##
+    # The theater's designated label.
+    #
+    # @return [String]
+    attr_accessor :label
+
+    ##
+    # The theater's origin location (as GPS coordinates).
+    #
+    # @return [?]
+    attr_accessor :location
+
+    ##
+    # @param session [Session]
+    # @param uuid    [#to_s]
+    def initialize(session, uuid)
+      super(session)
+      @uuid = uuid.to_s
+    end
+
+    ##
+    # Returns a developer-friendly representation of this theater.
+    #
+    # @return [String]
+    def inspect
+      sprintf("#<%s:%#0x(uuid: %s)>", self.class.name, self.__id__, @uuid)
+    end
+
+    ##
+    # @todo
+    def each_object(&block)
+      # TODO
+    end
+
+    ##
+    # @todo
+    def each_asset(&block)
+      # TODO
+    end
+
+    ##
+    # @todo
+    def each_camera(&block)
+      # TODO
+    end
+
+    ##
+    # @todo
+    def each_player(&block)
+      # TODO
+    end
+
+    ##
+    # @todo
+    def each_target(&block)
+      # TODO
+    end
+  end # Theater
+end # Conreality

data/lib/conreality/version.rb

@@ -0,0 +1,21 @@
+# This is free and unencumbered software released into the public domain.
+
+module Conreality
+  module VERSION
+    FILE = File.expand_path('../../VERSION', __dir__).freeze
+    STRING = File.read(FILE).chomp.freeze
+    MAJOR, MINOR, TINY, EXTRA = STRING.split('.').map(&:to_i).freeze
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY].freeze end
+  end # VERSION
+end # Conreality

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: conreality
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Conreality.org
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: drylib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+description: Conreality Software Development Kit (SDK) for Ruby.
+email: conreality@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- CREDITS.rst
+- README
+- UNLICENSE
+- VERSION
+- lib/conreality.rb
+- lib/conreality/action.rb
+- lib/conreality/asset.rb
+- lib/conreality/binary.rb
+- lib/conreality/camera.rb
+- lib/conreality/client.rb
+- lib/conreality/event.rb
+- lib/conreality/game.rb
+- lib/conreality/message.rb
+- lib/conreality/object.rb
+- lib/conreality/player.rb
+- lib/conreality/rpc.rb
+- lib/conreality/rpc/common_pb.rb
+- lib/conreality/rpc/master_pb.rb
+- lib/conreality/rpc/master_services_pb.rb
+- lib/conreality/rpc/model_pb.rb
+- lib/conreality/session.rb
+- lib/conreality/theater.rb
+- lib/conreality/version.rb
+homepage: https://sdk.conreality.org/ruby/
+licenses:
+- Unlicense
+metadata:
+  bug_tracker_uri: https://github.com/conreality/conreality.rb/issues
+  changelog_uri: https://github.com/conreality/conreality.rb/blob/master/CHANGES.rst
+  documentation_uri: https://www.rubydoc.info/github/conreality/conreality.rb/master
+  homepage_uri: https://sdk.conreality.org/ruby/
+  mailing_list_uri: https://groups.google.com/forum/#!forum/conreality
+  source_code_uri: https://github.com/conreality/conreality.rb
+  wiki_uri: https://wiki.conreality.org/Ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Conreality Software Development Kit (SDK) for Ruby.
+test_files: []