krpc 0.4.0.beta2 → 0.4.0.beta3

data/lib/krpc/encoder.rb

@@ -4,7 +4,7 @@ require 'krpc/types'
 module KRPC
   module Encoder
     class << self
-      
+
       # Given a type object, and ruby object, encode the ruby object
       def encode(obj, type)
         if type.is_a?(Types::MessageType) then type.ruby_type.encode(obj)
@@ -38,12 +38,12 @@ module KRPC
         else raise(RuntimeError, "Cannot encode object #{obj} of type #{type}")
         end
       end
-      
+
       def encode_value(value, type)
         type_string = type.is_a?(String) ? type : type.protobuf_type.code.to_s.downcase
         ProtobufUtils::Encoder.encode(value, type_string)
       end
-      
+
       def encode_message_with_size(msg)
         data = msg.class.encode(msg)
         length = ProtobufUtils::Encoder.encode_nonnegative_varint(data.length)

data/lib/krpc/error.rb

@@ -2,14 +2,9 @@
 module KRPC
 
   class Error < Exception; end
-  class UTF8MessageError < Error
-    def initialize(msg = nil)
-      super(msg.nil? ? msg : msg.encode(Encoding::UTF_8, invalid: :replace, undef: :replace))
-    end
-  end
 
-  class ConnectionError < UTF8MessageError; end
-  class RPCError < UTF8MessageError; end
+  class ConnectionError < Error; end
+  class RPCError < Error; end
   class ValueError < Error; end
   class ProcedureNameParserError < Error; end
 
@@ -40,7 +35,7 @@ module KRPC
     def with_arguments_count_incremented_by(args_count_increment)
       self.class.new(args_count + args_count_increment, (valid_params_count_range.min + args_count_increment)..(valid_params_count_range.max + args_count_increment), signature)
     end
-    
+
     def with_signature(sig)
       self.class.new(args_count, valid_params_count_range, sig)
     end

data/lib/krpc/gen.rb

@@ -6,10 +6,10 @@ require 'colorize'
 module KRPC
   module Gen
     class << self
-      def service_gen_module(service_name) 
+      def service_gen_module(service_name)
         const_get_or_create(service_name, Module.new)
       end
-    
+
       def generate_class(service_name, class_name)
         mod = service_gen_module(service_name)
         mod.const_get_or_create(class_name) do
@@ -19,7 +19,7 @@ module KRPC
           end
         end
       end
-      
+
       def generate_enum(service_name, enum_name, values)
         mod = service_gen_module(service_name)
         mod.const_get_or_create(enum_name) do
@@ -54,9 +54,9 @@ module KRPC
           raise err.with_signature(Doc.docstring_for_method(method_owner, method_name, false))
         end
       end
-      
+
       private #----------------------------------
-      
+
       def define_static_rpc_method(cls, method_name, param_default, param_names, param_types, prepend_self_to_args, proc, return_type, service_name)
         cls.instance_eval do
           define_singleton_method method_name do |*args|
@@ -92,7 +92,7 @@ module KRPC
           end
         end
       end
-      
+
       def parse_procedure(proc)
         param_names = proc.parameters.map{|p| p.name.underscore }
         param_types = proc.parameters.map{|p| TypeStore[p.type] }
@@ -107,29 +107,29 @@ module KRPC
         [param_names, param_types, param_default, return_type]
       end
     end
-    
+
     module RPCMethodGenerator
       def include_rpc_method(service_name, procedure_name, params: [], return_type: nil, xmldoc: "", **options)
         Gen.add_rpc_method(self.class, service_name, PB::Procedure.new(name: procedure_name, parameters: params, return_type: return_type, documentation: xmldoc), **options)
       end
     end
-    
+
     ##
     # Base class for service-defined class types.
     class ClassBase
       include Doc::SuffixMethods
       include Streaming::StreamConstructors
-      
+
       attr_reader :client, :remote_oid
-      
+
       def self.krpc_name
         name[11..-1]
       end
-      
+
       def initialize(client, remote_oid)
         @client, @remote_oid = client, remote_oid
       end
-      
+
       alias_method :eql?, :==
       def ==(other)
         other.class == self.class and other.remote_oid == remote_oid
@@ -137,15 +137,15 @@ module KRPC
       def hash
         remote_oid.hash
       end
-      
+
       def to_s
         "#<#{self.class} @remote_oid=#{remote_oid}>"
       end
-      
+
       def inspect
         "#<#{self.class} ".green + "@remote_oid" + "=".green + remote_oid.to_s.bold.blue + ">".green
       end
     end
-    
-  end    
+
+  end
 end

data/lib/krpc/krpc.pb.rb

@@ -37,13 +37,19 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :value, :bytes, 2
   end
   add_message "krpc.schema.Response" do
-    optional :error, :string, 1
+    optional :error, :message, 1, "krpc.schema.Error"
     repeated :results, :message, 2, "krpc.schema.ProcedureResult"
   end
   add_message "krpc.schema.ProcedureResult" do
-    optional :error, :string, 1
+    optional :error, :message, 1, "krpc.schema.Error"
     optional :value, :bytes, 2
   end
+  add_message "krpc.schema.Error" do
+    optional :service, :string, 1
+    optional :name, :string, 2
+    optional :description, :string, 3
+    optional :stack_trace, :string, 4
+  end
   add_message "krpc.schema.StreamUpdate" do
     repeated :results, :message, 1, "krpc.schema.StreamResult"
   end
@@ -59,13 +65,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :procedures, :message, 2, "krpc.schema.Procedure"
     repeated :classes, :message, 3, "krpc.schema.Class"
     repeated :enumerations, :message, 4, "krpc.schema.Enumeration"
-    optional :documentation, :string, 5
+    repeated :exceptions, :message, 5, "krpc.schema.Exception"
+    optional :documentation, :string, 6
   end
   add_message "krpc.schema.Procedure" do
     optional :name, :string, 1
     repeated :parameters, :message, 2, "krpc.schema.Parameter"
     optional :return_type, :message, 3, "krpc.schema.Type"
-    optional :documentation, :string, 4
+    optional :return_is_nullable, :bool, 4
+    optional :documentation, :string, 5
   end
   add_message "krpc.schema.Parameter" do
     optional :name, :string, 1
@@ -86,6 +94,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :value, :int32, 2
     optional :documentation, :string, 3
   end
+  add_message "krpc.schema.Exception" do
+    optional :name, :string, 1
+    optional :documentation, :string, 2
+  end
   add_message "krpc.schema.Type" do
     optional :code, :enum, 1, "krpc.schema.Type.TypeCode"
     optional :service, :string, 2
@@ -167,6 +179,7 @@ module KRPC
     Argument = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Argument").msgclass
     Response = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Response").msgclass
     ProcedureResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.ProcedureResult").msgclass
+    Error = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Error").msgclass
     StreamUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.StreamUpdate").msgclass
     StreamResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.StreamResult").msgclass
     Services = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Services").msgclass
@@ -176,6 +189,7 @@ module KRPC
     Class = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Class").msgclass
     Enumeration = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Enumeration").msgclass
     EnumerationValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.EnumerationValue").msgclass
+    Exception = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Exception").msgclass
     Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Type").msgclass
     Type::TypeCode = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Type.TypeCode").enummodule
     Tuple = Google::Protobuf::DescriptorPool.generated_pool.lookup("krpc.schema.Tuple").msgclass

data/lib/krpc/protobuf_utils.rb

@@ -4,14 +4,14 @@ module KRPC
   module ProtobufUtils
     module Decoder
       class << self
-      
+
         def decode(bytes, type)
           meth_name = "decode_" + type
           raise RuntimeError.new("Unsupported type #{type}") unless respond_to?(meth_name)
           send(meth_name, bytes)
         end
 
-        # based on: https://developers.google.com/protocol-buffers/docs/encoding#varints  &  http://www.rubydoc.info/gems/ruby-protocol-buffers/1.0.1/ProtocolBuffers/Varint#decode-class_method  &  https://github.com/google/protobuf/blob/master/python/google/protobuf/internal/decoder.py#L136  
+        # based on: https://developers.google.com/protocol-buffers/docs/encoding#varints  &  http://www.rubydoc.info/gems/ruby-protocol-buffers/1.0.1/ProtocolBuffers/Varint#decode-class_method  &  https://github.com/google/protobuf/blob/master/python/google/protobuf/internal/decoder.py#L136
         def decode_varint(bytes)
           decode_varint_pos(bytes)[0]
         end
@@ -33,12 +33,12 @@ module KRPC
           zigzaged = decode_varint(bytes)
           (zigzaged >> 1) ^ -(zigzaged & 1)
         end
-        
+
         alias_method :decode_sint32, :decode_zigzaged_varint
         alias_method :decode_sint64, :decode_zigzaged_varint
         alias_method :decode_uint32, :decode_varint
         alias_method :decode_uint64, :decode_varint
-        
+
         # based on: https://github.com/ruby-protobuf/protobuf/search?q=pack
         def decode_float(bytes)
           bytes.unpack('e').first
@@ -57,19 +57,19 @@ module KRPC
           size, pos = decode_varint_pos(bytes)
           bytes[pos..(pos+size)].bytes
         end
-        
+
       end
     end
-    
+
     module Encoder
       class << self
-      
+
         def encode(value, type)
           meth_name = "encode_" + type
           raise(RuntimeError, "Unsupported type #{type}") unless respond_to?(meth_name)
           send(meth_name, value)
         end
-        
+
         # based on: http://www.rubydoc.info/gems/ruby-protocol-buffers/1.0.1/ProtocolBuffers/Varint#decode-class_method  &  https://github.com/google/protobuf/blob/master/python/google/protobuf/internal/encoder.py#L390
         def encode_varint(value)
           return [value].pack('C') if value < 0b1000_0000
@@ -96,12 +96,12 @@ module KRPC
           zigzaged = (value << 1) ^ (value >> 63)
           encode_varint(zigzaged)
         end
-        
+
         alias_method :encode_sint32, :encode_zigzaged_varint_32
         alias_method :encode_sint64, :encode_zigzaged_varint_64
         alias_method :encode_uint32, :encode_nonnegative_varint
         alias_method :encode_uint64, :encode_nonnegative_varint
-        
+
         def encode_float(value)
           [value].pack('e')
         end
@@ -112,16 +112,17 @@ module KRPC
           encode_varint(value ? 1 : 0)
         end
         def encode_string(value)
-          size = encode_varint(value.bytesize)
-          size + value.bytes.map(&:chr).join.b
+          data = value.encode(Encoding::UTF_8).b
+          size = encode_varint(data.bytesize)
+          size + data
         end
         def encode_bytes(value)
           size = encode_varint(value.size)
           size + value.map(&:chr).join.b
         end
-        
+
       end
     end
-    
+
   end
 end

data/lib/krpc/service.rb

@@ -5,27 +5,27 @@ require 'krpc/streaming'
 module KRPC
   module Services
     class << self
-    
+
       # Generate classes and methods for the service - see documentation for Client#generate_services_api!
       def create_service(service_msg)
         service_name = service_msg.name
-        
+
         # Create service class
         service_class = Class.new(ServiceBase)
         const_set(service_name, service_class)
-        
+
         # Create service' classes
         class_types_by_name = Hash.new do |h,k|
           TypeStore[PB::Type.new(code: :CLASS, service: service_name, name: k)]
         end
         service_msg.classes.map(&:name).each {|cn| class_types_by_name[cn] }
-        
+
         # Create service' enums
         service_msg.enumerations.each do |enum|
           enum_type = TypeStore[PB::Type.new(code: :ENUMERATION, service: service_name, name: enum.name)]
           enum_type.set_values(enum.values)
         end
-        
+
         # Create service' procedures
         service_msg.procedures.each do |proc|
           cls = if proc.class_member?
@@ -35,26 +35,26 @@ module KRPC
                 end
           Gen.add_rpc_method(cls, service_name, proc)
         end
-        
+
         # Return service class
         service_class
       end
-      
+
     end
-    
+
     ##
     # Base class for service objects, created at runtime using information received from the server.
     class ServiceBase
       include Doc::SuffixMethods
       include Streaming::StreamConstructors
-      
+
       attr_reader :client
-  
+
       def initialize(client)
         @client = client
       end
     end
-    
+
     ##
     # Hardcoded version of `krpc` service - The core kRPC service, e.g. for querying for the available services.
     class Core < ServiceBase
@@ -98,6 +98,14 @@ module KRPC
                              return_type: PB::Type.new(code: :ENUMERATION, service: 'Core', name: 'GameScene'),
                              xmldoc: "<doc><summary>Get the current game scene.</summary></doc>",
                              **opts
+          include_rpc_method 'KRPC', 'GetClientID',
+                             return_type: PB::Type.new(code: :BYTES),
+                             xmldoc: "<doc>\n<summary>\nReturns the identifier for the current client.\n</summary>\n</doc>",
+                             **opts
+          include_rpc_method 'KRPC', 'GetClientName',
+                             return_type: PB::Type.new(code: :STRING),
+                             xmldoc: "<doc>\n<summary>\nReturns the name of the current client.\nThis is an empty string if the client has no name.\n</summary>\n</doc>",
+                             **opts
         end
       end
     end

data/lib/krpc/streaming.rb

@@ -6,14 +6,14 @@ module KRPC
 
     class StreamsManager
       attr_reader :client
-      
+
       def initialize(client)
         @client = client
         @streams = {}
         @streams_mutex = Mutex.new
         @streaming_thread = Thread.new {}
       end
-    
+
       # Send the streaming request, create related Stream object and return it. If identical Stream
       # already exists, doesn't create new Stream and return the existing one.
       def create_stream(call, return_type, method, *args, **kwargs)
@@ -29,7 +29,7 @@ module KRPC
           end
         end
       end
-      
+
       # Remove the streaming request and deactivate the Stream object. Returns `true` if the
       # streaming request has been removed or `false` if passed Stream object is already inactive.
       def remove_stream(stream)
@@ -48,7 +48,7 @@ module KRPC
       def remove_all_streams
         @streams.each {|_,stream| remove_stream(stream)}
       end
-      
+
       # Start streaming thread. It receives stream data, and updates Stream object's `value` attribute.
       def start_streaming_thread
         stop_streaming_thread
@@ -65,24 +65,24 @@ module KRPC
                 if result.result.field_empty? :error
                   stream.value = Decoder.decode(result.result.value, stream.return_type, client)
                 else
-                  stream.value = RPCError.new(result.result.error)
+                  stream.value = client.build_exception(result.result.error)
                 end
               end
             end
           end
         end
       end
-      
+
       # Stop streaming thread.
       def stop_streaming_thread
         @streaming_thread.terminate
       end
     end
-    
+
     class Stream
       attr_reader :id, :method, :args, :kwargs, :return_type, :manager
       attr_writer :value
-      
+
       def initialize(manager, id, return_type, value, method, *args, **kwargs)
         @manager = manager
         @id = id
@@ -90,7 +90,7 @@ module KRPC
         @method, @args, @kwargs = method, args, kwargs
         @active = true
       end
-      
+
       # Get the current stream value. Has alias method `value`.
       def get
         raise @value if @value.is_a?(Exception)
@@ -103,18 +103,18 @@ module KRPC
         manager.remove_stream self
       end
       alias_method :close, :remove
-      
+
       # Check if stream is active (i.e. not removed).
       def active?; @active end
 
       # Mark stream as inactive.
       # WARNING: This method does not remove the stream. To remove the stream call Stream#remove instead.
       def mark_as_inactive; @active = false end
-      
+
       def to_s
         inspect.gsub(/\n|\t/," ").squeeze(" ").uncolorize
       end
-      
+
       def inspect
         def coderay(x)
           require 'coderay'
@@ -134,11 +134,11 @@ module KRPC
             ">".green
       end
     end
-  
+
     module StreamConstructors
       STREAM_METHOD_SUFFIX = "_stream"
       STREAM_METHOD_REGEX = /^(.+)(?:#{STREAM_METHOD_SUFFIX})$/
-      
+
       module ClassMethods
         def stream_constructors
           @stream_constructors ||= {}
@@ -149,7 +149,7 @@ module KRPC
         base.extend ClassMethods
         base.extend self
       end
-      
+
       def method_missing(method, *args, **kwargs, &block)
         if STREAM_METHOD_REGEX =~ method.to_s
           if respond_to? $1.to_sym
@@ -159,7 +159,7 @@ module KRPC
         end
         super
       end
-      
+
       def respond_to_missing?(method, *)
         if STREAM_METHOD_REGEX =~ method.to_s
           if respond_to? $1.to_sym
@@ -169,8 +169,8 @@ module KRPC
         end
         super
       end
-      
+
     end
-    
+
   end
 end