krpc 0.3.1 → 0.3.2

data/lib/krpc/service.rb

@@ -1,31 +1,33 @@
 require 'krpc/gen'
 require 'krpc/attributes'
+require 'krpc/encoder'
+require 'krpc/types'
 require 'krpc/doc'
 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
         service_msg.classes.map(&:name).each do |sc_name|
           TypeStore["Class(#{service_name}.#{sc_name})"]
         end
-        
+
         # Create service' enums
         service_msg.enumerations.each do |enum|
           enum_type = TypeStore["Enum(#{service_name}.#{enum.name})"]
           enum_type.set_values(enum.values)
         end
-        
+
         # Create service' procedures
         service_msg.procedures.each do |proc|
           if Attributes.is_a_class_method_or_property_accessor(proc.attributes)
@@ -54,41 +56,74 @@ module KRPC
             Gen.add_rpc_method(service_class, proc.name, service_name, proc, :static)
           end
         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
-    
+
     ##
-    # Core kRPC service, e.g. for querying for the available services.
-    class KRPC < ServiceBase
+    # Hardcoded version of `krpc` service - The core kRPC service, e.g. for querying for the available services.
+    class Core < ServiceBase
       include Gen::RPCMethodGenerator
 
       def initialize(client)
         super(client)
         unless respond_to? :get_status
-          include_rpc_method("get_status", "KRPC", "GetStatus", return_type: "KRPC.Status", xmldoc: "<doc><summary>Gets a status message from the server containing information including the server’s version string and performance statistics.</summary></doc>", options: :no_stream)
-          include_rpc_method("get_services", "KRPC", "GetServices", return_type: "KRPC.Services", xmldoc: "<doc><summary>Gets available services and procedures.</summary></doc>", options: :no_stream)
-          include_rpc_method("add_stream", "KRPC", "AddStream", params: [PB::Parameter.new(name: "request", type: "KRPC.Request")], return_type: "uint32", xmldoc: "<doc><summary>Add a streaming request. Returns it's identifier.</summary></doc>", options: :no_stream)
-          include_rpc_method("remove_stream", "KRPC", "RemoveStream", params: [PB::Parameter.new(name: "id", type: "uint32")], xmldoc: "<doc><summary>Remove a streaming request</summary></doc>", options: :no_stream)
+          # Generate enumerations
+          TypeStore['Enum(Core.GameScene)'].set_values(
+            Encoder.hash_to_enumeration_values(
+              space_center: 0, flight: 1, tracking_station: 2, editor_vab: 3, editor_sph: 4
+            )
+          )
+
+          # Generate procedures
+          opts = {doc_service_name: 'Core'}
+
+          include_rpc_method 'get_status', 'KRPC', 'GetStatus',
+                             return_type: 'KRPC.Status',
+                             xmldoc: "<doc><summary>Gets a status message from the server containing information including the server’s version string and performance statistics.</summary></doc>",
+                             switches: [:static], options: opts
+          include_rpc_method 'get_services', 'KRPC', 'GetServices',
+                             return_type: 'KRPC.Services',
+                             xmldoc: "<doc><summary>Gets available services and procedures.</summary></doc>",
+                             switches: [:static, :no_stream], options: opts
+          include_rpc_method 'add_stream', 'KRPC', 'AddStream',
+                             params: [PB::Parameter.new(name: 'request', type: 'KRPC.Request')],
+                             return_type: 'uint32',
+                             xmldoc: "<doc><summary>Add a streaming request. Returns it's identifier.</summary></doc>",
+                             switches: [:static, :no_stream], options: opts
+          include_rpc_method 'remove_stream', 'KRPC', 'RemoveStream',
+                             params: [PB::Parameter.new(name: 'id', type: 'uint32')],
+                             xmldoc: "<doc><summary>Remove a streaming request</summary></doc>",
+                             switches: [:static, :no_stream], options: opts
+          include_rpc_method 'clients', 'KRPC', 'get_Clients',
+                             return_type: 'KRPC.List',
+                             attributes: ['Property.Get(Clients)', 'ReturnType.List(Tuple(bytes,string,string))'],
+                             xmldoc: "<doc><summary>A list of RPC clients that are currently connected to the server.\nEach entry in the list is a clients identifier, name and address.</summary></doc>",
+                             switches: [:static], options: opts
+          include_rpc_method 'current_game_scene', 'KRPC', 'get_CurrentGameScene',
+                             return_type: 'int32',
+                             attributes: ['Property.Get(CurrentGameScene)', 'ReturnType.Enum(Core.GameScene)'],
+                             xmldoc: "<doc><summary>Get the current game scene.</summary></doc>",
+                             switches: [:static], options: opts
         end
       end
     end
-    
+
   end
 end

data/lib/krpc/streaming.rb

@@ -6,19 +6,19 @@ module KRPC
 
     class StreamsManager
       attr_reader :client
-      
+
       def initialize(client)
         @client = client
         @streams = {}
         @streams_mutex = Mutex.new
         @streaming_thread = Thread.new {}
       end
-    
+
       # Send a 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(request, return_type, method, *args, **kwargs)
         raise RuntimeError("Cannot stream a property setter") if method.name.to_s.end_with? '='
-        id = client.krpc.add_stream(request)
+        id = client.core.add_stream(request)
         @streams_mutex.synchronize do
           if @streams.include? id
             @streams[id]
@@ -28,14 +28,14 @@ module KRPC
           end
         end
       end
-      
+
       # Remove a streaming request and deactivate the Stream object. Returns `true` if
       # streaming request is removed or `false` if passed Stream object is already inactive.
       def remove_stream(stream)
         return false unless stream.active?
         @streams_mutex.synchronize do
           return false unless @streams.include? stream.id
-          client.krpc.remove_stream stream.id
+          client.core.remove_stream stream.id
           @streams.delete stream.id
         end
         stream.value = RuntimeError.new("Stream has been removed")
@@ -47,7 +47,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
@@ -72,17 +72,17 @@ module KRPC
           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

data/lib/krpc/types.rb

@@ -21,14 +21,14 @@ module KRPC
       "bytes"  => Array
     }
     PROTOBUF_TO_MESSAGE_TYPE = ProtobufUtils.create_PB_to_PB_message_class_hash("KRPC")
-    
+
     class TypeStore
       @cache = {}
       class << self
-      
+
         def [](type_string)
           return @cache[type_string] if @cache.include? type_string
-          
+
           type =
             if PROTOBUF_VALUE_TYPES.include? type_string then ValueType.new(type_string)
             elsif type_string.start_with? "Class(" || type_string == "Class" then ClassType.new(type_string)
@@ -47,9 +47,9 @@ module KRPC
             end
 
           @cache[type_string] = type
-          type      
+          type
         end
-        
+
         def get_parameter_type(pos, type, attrs)
           type_attrs = Attributes.get_parameter_type_attrs(pos, attrs)
           type_attrs.each do |ta|
@@ -71,14 +71,14 @@ module KRPC
           end
           self[type]
         end
-        
+
         def coerce_to(value, type)
           return value if type.is_a?(EnumType) && value.class == Symbol # Enum handling
           return value if value.is_a?(type.ruby_type)
           # A NilClass can be coerced to a ClassType
           return nil if type.is_a?(ClassType) && value.nil?
           # Handle service' class instance
-          if type.is_a?(ClassType) && value.is_a?(Gen::ClassBase) && 
+          if type.is_a?(ClassType) && value.is_a?(Gen::ClassBase) &&
              type.ruby_type == value.class
             return value
           end
@@ -108,20 +108,20 @@ module KRPC
           end
           raise(ValueError, "Failed to coerce value #{value.to_s} of type #{value.class} to type #{type}")
         end
-      
+
       end
     end
-    
-    
+
+
     class TypeBase
       attr_reader :protobuf_type, :ruby_type
       def initialize(protobuf_type, ruby_type)
         @protobuf_type = protobuf_type
         @ruby_type = ruby_type
       end
-      
+
       protected
-      
+
       def parse_type_string(type)
         raise ValueError.new if type.nil?
         result = ""
@@ -138,14 +138,14 @@ module KRPC
         [result, type[(result.length+1)..-1]]
       end
     end
-    
+
     class ValueType < TypeBase
       def initialize(type_string)
         raise(ValueError, "\"#{type_string}\" is not a valid type string for a value type") unless PROTOBUF_TO_RUBY_VALUE_TYPE.has_key? type_string
         super(type_string, PROTOBUF_TO_RUBY_VALUE_TYPE[type_string])
       end
     end
-    
+
     class MessageType < TypeBase
       def initialize(type_string)
         if PROTOBUF_TO_MESSAGE_TYPE.has_key? type_string
@@ -155,7 +155,7 @@ module KRPC
         end
       end
     end
-    
+
     class ClassType < TypeBase
       attr_reader :service_name, :class_name
       def initialize(type_string)
@@ -165,7 +165,7 @@ module KRPC
         super(type_string, Gen.generate_class(service_name, class_name))
       end
     end
-    
+
     class EnumType < TypeBase
       attr_reader :service_name, :enum_name
       def initialize(type_string)
@@ -175,12 +175,12 @@ module KRPC
         # Sets ruby_type to nil, set_values must be called to set the ruby_type
         super(type_string, nil)
       end
-      
+
       def set_values(values)
         @ruby_type = Gen.generate_enum(service_name, enum_name, values)
       end
     end
-    
+
     class ListType < TypeBase
       attr_reader :value_type
       def initialize(type_string)
@@ -190,7 +190,7 @@ module KRPC
         super(type_string, Array)
       end
     end
-    
+
     class DictionaryType < TypeBase
       attr_reader :key_type, :value_type
       def initialize(type_string)
@@ -206,7 +206,7 @@ module KRPC
         super(type_string, Hash)
       end
     end
-    
+
     class SetType < TypeBase
       attr_reader :value_type
       def initialize(type_string)
@@ -216,25 +216,25 @@ module KRPC
         super(type_string, Set)
       end
     end
-    
+
     class TupleType < TypeBase
       attr_reader :value_types
       def initialize(type_string)
         m = /^Tuple\((.+)\)$/.match type_string
         raise(ValueError, "\"#{type_string}\" is not a valid type string for a tuple type") unless m
-        
+
         @value_types = []
         type = m[1]
         until type.nil?
           value_type, type = parse_type_string(type)
           @value_types << TypeStore[value_type]
         end
-        
+
         super(type_string, Array)
       end
     end
-        
+
   end
-  
+
   TypeStore = Types::TypeStore
 end

data/lib/krpc/version.rb

@@ -1,3 +1,3 @@
 module KRPC
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: krpc
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Tomasz Więch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-18 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -16,112 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.alpha.5
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.alpha.5
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: hanna-nouveau
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
+        version: '1.15'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: hanna-nouveau
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '1.0'
 description: kRPC-rb is a Ruby client library for kRPC, a Kerbal Space Program mod
   that allows you to control KSP from external scripts running outside of the game.
 email:
@@ -131,11 +131,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - krpc.gemspec
 - lib/krpc.rb
 - lib/krpc/attributes.rb
@@ -163,8 +161,6 @@ post_install_message:
 rdoc_options:
 - "--markup"
 - markdown
-- "--format"
-- hanna
 - "--title"
 - kRPC-rb API Docs
 - "--main"
@@ -183,9 +179,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Client library for kRPC
 test_files: []
-has_rdoc: