json-rpc-objects 0.1.0

data/lib/json-rpc-objects/v11/wd/procedure-parameter-description.rb

@@ -0,0 +1,179 @@
+# encoding: utf-8
+require "multitype-introspection"
+require "json-rpc-objects/v11/generic-types"
+require "json-rpc-objects/generic"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Description of one procedure parameter.
+            #
+            
+            class ProcedureParameterDescription < JsonRpcObjects::Generic::Object
+            
+                ##
+                # Holds link to its version module.
+                #
+                
+                VERSION = JsonRpcObjects::V11::WD
+                
+                ##
+                # Maps type to object (class).
+                #
+                
+                TYPE_TO_OBJECT = Hash::define({
+                    :num => Integer,
+                    :str => String,
+                    :arr => Array,
+                    :obj => Object,
+                    :bit => GenericTypes::Boolean,
+                    :nil => GenericTypes::Nil,
+                    :any => GenericTypes::Any
+                }, GenericTypes::Any)
+                
+                ##
+                # Maps object (class) to type.
+                #
+                
+                OBJECT_TO_TYPE = Hash::define({
+                    Integer => :num,
+                    String => :str,
+                    Array => :arr,
+                    Object => :obj,
+                    GenericTypes::Boolean => :bit,
+                    GenericTypes::Nil => :nil,
+                    GenericTypes::Any => :any
+                }, :any)
+            
+                ##
+                # Holds parameter name.
+                #
+                
+                @name
+                attr_accessor :name
+                
+                ##
+                # Holds parameter type.
+                #
+                
+                @type
+                attr_accessor :type
+
+                ##
+                # Creates new one.
+                #
+                # @param [Symbol] name name of the parameter
+                # @return [V11:ProcedureParameterDescription] new description object
+                #
+                
+                def self.create(name, opts = { })
+                    data = { :name => name }
+                    data.merge! opts
+                    return self::new(data)
+                end
+                
+                ##
+                # Checks correctness of the data.
+                #
+                
+                def check!
+                    self.normalize!
+                    
+                    if not @name.kind_of? Symbol
+                        raise Exception::new("Parameter name must be Symbol or convertable to Symbol.")
+                    end
+                    
+                    if (not @type.nil?) and (not @type.kind_of_any? [GenericTypes::Any, GenericTypes::Nil, GenericTypes::Boolean, Integer, String, Array, Object])
+                        raise Exception::new("Type if defined can be only Any, Nil, Boolean, Integer, String, Array or Object.")
+                    end
+                end
+                
+                ##
+                # Renders data to output hash.
+                # @return [Hash] with data of description
+                #
+                
+                def output
+                    self.check!
+                    data = { :name => @name.to_s }
+                    
+                    if not @type.nil?
+                        data[:type] = __object_to_type
+                    end
+                    
+                    return data
+                end
+                    
+                    
+                protected
+                
+                ##
+                # Assigns request data.
+                #
+                
+                def data=(value, mode = nil)
+                    data = __convert_data(value, mode)
+                    
+                    @name = data[:name]
+                    @type = data[:type]
+                end
+                
+                ##
+                # Converts request data to standard (defined) format.
+                #
+                
+                def normalize!
+                    if @name.kind_of? String
+                        @name = @name.to_sym
+                    end
+
+                    if @type.kind_of_any? [String, Symbol]
+                        @type = __normalize_type
+                    end
+                end
+                
+                ##
+                # Normalizes type definition.
+                #
+                
+                def __normalize_type
+                    __type_to_object
+                end
+                
+                ##
+                # Converts type definition to appropriate object.
+                #
+                
+                def __type_to_object
+                    self.class::TYPE_TO_OBJECT[@type.to_sym]
+                end
+                
+                ## 
+                # Converts type object to type definition.
+                #
+                
+                def __object_to_type
+                    self.class::OBJECT_TO_TYPE[@type]
+                end
+                
+            end
+        end
+    end
+end

data/lib/json-rpc-objects/v11/wd/procedure-return.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+require "json-rpc-objects/v10/response"
+require "json-rpc-objects/v11/wd/error"
+require "json-rpc-objects/v11/wd/extensions"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Procedure return (response) class.
+            #
+            
+            class ProcedureReturn < JsonRpcObjects::V10::Response
+            
+                include Extensions
+
+                ##
+                # Holds link to its version module.
+                #
+                
+                VERSION = JsonRpcObjects::V11::WD
+                
+                ##
+                # Holds JSON-RPC version specification.
+                #
+                
+                VERSION_NUMBER = :"1.1"
+                
+                ##
+                # Holds JSON-RPC version member identification.
+                #
+                
+                VERSION_MEMBER = :version
+                
+                ##
+                # Identifies the error object class.
+                #
+                
+                ERROR_CLASS = JsonRpcObjects::V11::WD::Error
+                
+                ##
+                # Checks correctness of the request data.
+                #
+                
+                def check!
+                    self.normalize!
+                    
+                    __check_coherency
+                    __check_error
+                end
+                                            
+                ##
+                # Renders data to output hash.
+                # @return [Hash] with data of return
+                #
+                
+                def output
+                    self.check!
+                    
+                    data = { }
+                    __assign_version(data)
+                    
+                    if not @result.nil?
+                        data[:result] = @result
+                    end
+                    
+                    if not @error.nil?
+                        data[:error] = @error
+                    end
+
+                    if not @id.nil?
+                        data[:id] = @id
+                    end
+                
+                    data.merge! @extensions
+                    return data
+                end
+
+
+                protected
+                
+                ##
+                # Assigns request data.
+                #
+
+                def data=(value, mode = nil)  
+                    data = __convert_data(value, mode)
+                    super(data, :converted)
+                    
+                    data.delete(:result)
+                    data.delete(:error)
+                    data.delete(:id)
+                    
+                    __delete_version(data)
+                    
+                    # Extensions
+                    @extensions = data
+                end
+                
+                ##
+                # Converts request data to standard (defined) format.
+                #
+                
+                def normalize!
+                    if @extensions.nil?
+                        @extensions = { }
+                    end
+                end
+                
+                ##
+                # Creates error object.
+                #
+                
+                def __create_error
+                    if @error.kind_of? Hash
+                        @error = self.class::ERROR_CLASS::new(@error)
+                    end
+                end
+                
+                ##
+                # Assignes the version specification.
+                #
+                
+                def __assign_version(data)
+                    data[self.class::VERSION_MEMBER] = self.class::VERSION_NUMBER
+                end
+                
+                ##
+                # Removes the version specification.
+                #
+                
+                def __delete_version(data)
+                    data.delete(self.class::VERSION_MEMBER)
+                end
+                
+            end
+        end
+    end
+end

data/lib/json-rpc-objects/v11/wd/request.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "json-rpc-objects/v11/wd/fakes/request"

data/lib/json-rpc-objects/v11/wd/response.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "json-rpc-objects/v11/wd/fakes/response"

data/lib/json-rpc-objects/v11/wd/service-description.rb

@@ -0,0 +1,251 @@
+# encoding: utf-8
+require "version"
+require "addressable/uri"
+require "json-rpc-objects/v11/wd/service-procedure-description"
+require "json-rpc-objects/generic"
+require "hash-utils/array"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Service description object class.
+            #
+            
+            class ServiceDescription < JsonRpcObjects::Generic::Object
+            
+                ##
+                # Holds link to its version module.
+                #
+                
+                VERSION = JsonRpcObjects::V11::WD
+                            
+                ##
+                # Indicates the service procedure description class.
+                #
+                
+                PROCEDURE_DESCRIPTION_CLASS = JsonRpcObjects::V11::WD::ServiceProcedureDescription
+            
+                ##
+                # Holds service name.
+                #
+                
+                @name
+                attr_accessor :name
+                
+                ##
+                # Holds service identifier.
+                #
+                
+                @id
+                attr_accessor :id
+                
+                ##
+                # Holds service version.
+                #
+                
+                @version
+                attr_accessor :version
+                
+                ##
+                # Holds service summary.
+                #
+                
+                @summary
+                attr_accessor :summary
+                
+                ##
+                # Holds service help URL.
+                #
+                
+                @help
+                attr_accessor :url
+                
+                ##
+                # Holds service address.
+                #
+                
+                @address
+                attr_accessor :address
+                
+                ##
+                # Holds procedure descriptions.
+                #
+                
+                @procs
+                attr_accessor :procs
+            
+                ##
+                # Creates new one.
+                #
+                # @param [Symbol] name name of the service
+                # @param [String] id ID of the service (according 
+                #   to specification it should be valid URI)
+                # @param [Hash] opts additional options
+                # @return [V11:ServiceDescription] new description object
+                #
+                
+                def self.create(name, id, opts = { })
+                    data = {
+                        :name => name,
+                        :id => id
+                    }
+                    
+                    data.merge! opts
+                    return self::new(data)
+                end
+                
+                ##
+                # Checks correctness of the data.
+                #
+                
+                def check!
+                    self.normalize!
+                    
+                    if not @name.kind_of? Symbol
+                        raise Exception::new("Service name must be Symbol or convertable to Symbol.")
+                    end
+                    
+                    if not (@version.nil?) and ((@version.to_a.length < 2) or @version.prerelease?)
+                        raise Exception::new("Version must be at least in <major>.<minor> format and must contain numbers only.")
+                    end
+                    
+                    if (not @procs.nil?) 
+                        if (not @procs.kind_of? Array) or (not @procs.all? { |v| v.kind_of? self.class::PROCEDURE_DESCRIPTION_CLASS })
+                            raise Exception::new("If procs is defined, must be an Array of " << self.class::PROCEDURE_DESCRIPTION_CLASS.name << " objects.")
+                        end
+                        
+                        if @procs.kind_of? Array
+                            @procs.each { |proc| proc.check! }
+                        end
+                    end
+                end
+                
+                ##
+                # Renders data to output hash.
+                # @return [Hash] with data of description
+                #
+                
+                def output
+                    self.check!
+                    
+                    data = {
+                        :sdversion => :"1.0",
+                        :name => @name.to_s,
+                        :id => @id.to_s
+                    }
+                    
+                    if not @version.nil?
+                        data[:version] = @version.to_s
+                    end
+                    
+                    if not @summary.nil?
+                        data[:summary] = @summary
+                    end
+                    
+                    if not @help.nil?
+                        data[:help] = @help.to_s
+                    end
+                    
+                    if not @address.nil?
+                        data[:address] = @address.to_s
+                    end
+                    
+                    if not @procs.nil?
+                        data[:procs] = @procs
+                    end
+                    
+                    return data
+                end
+                
+                ##
+                # Receives service procedure description objects.
+                # @param [ServiceProcedureDescription] new service procedure description
+                #
+                
+                def <<(value)
+                    if not value.kind_of? self.class::PROCEDURE_DESCRIPTION_CLASS
+                        raise Exception::new(self.class::PROCEDURE_DESCRIPTION_CLASS.name.dup << " object expected.")
+                    end
+                    
+                    if @procs.nil?
+                        @procs = [ ]
+                    end
+                    
+                    @procs << value
+                end
+                    
+                    
+                    
+                protected
+                
+                ##
+                # Assigns request data.
+                #
+                
+                def data=(value, mode = nil)            
+                    data = __convert_data(value, mode)
+                    
+                    @name = data[:name]
+                    @id = data[:id]
+                    @version = data[:version]
+                    @summary = data[:summary]
+                    @help = data[:help]
+                    @address = data[:address]
+                    @procs = data[:procs]
+                    
+                    if @procs.kind_of? Array
+                        @procs = @procs.map { |v| self.class::PROCEDURE_DESCRIPTION_CLASS::new(v) }
+                    end
+                end
+                
+                ##
+                # Converts request data to standard (defined) format.
+                #
+                
+                def normalize!
+                    if @name.kind_of? String
+                        @name = @name.to_sym
+                    end
+
+                    if not @id.kind_of? Addressable::URI
+                        @id = Addressable::URI::parse(@id.to_s)
+                    end
+                    
+                    if (not @version.nil?) and (not @version.kind_of? Version)
+                        @version = @version.to_s.to_version
+                    end
+                    
+                    if not @summary.nil?
+                        @summary = @summary.to_s
+                    end
+                    
+                    if (not @help.nil?) and (not @help.kind_of? Addressable::URI)
+                        @help = Addressable::URI::parse(@help.to_s)
+                    end
+                    
+                    if (not @address.nil?) and (not @address.kind_of? Addressable::URI)
+                        @address = Addressable::URI::parse(@address.to_s)
+                    end
+                end
+                      
+            end
+        end
+    end
+end