json-rpc-objects 0.1.0

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

@@ -0,0 +1,234 @@
+# encoding: utf-8
+require "addressable/uri"
+require "multitype-introspection"
+require "types"
+require "hash-utils/array"
+require "json-rpc-objects/v11/wd/procedure-parameter-description"
+require "json-rpc-objects/generic"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of JSON-RPC 1.1 Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Description of one procedure of the service.
+            #
+            
+            class ServiceProcedureDescription < JsonRpcObjects::Generic::Object
+            
+                ##
+                # Holds link to its version module.
+                #
+                
+                VERSION = JsonRpcObjects::V11::WD
+                
+                ##
+                # Indicates the procedure parameter description class.
+                #
+                
+                PARAMETER_DESCRIPTION_CLASS = JsonRpcObjects::V11::WD::ProcedureParameterDescription
+                
+                ##
+                # Holds procedure name.
+                #
+                
+                @name
+                attr_accessor :name
+                
+                ##
+                # Holds procedure summary.
+                #
+                
+                @summary
+                attr_accessor :summary
+                
+                ##
+                # Holds procedure help URL.
+                #
+                
+                @help
+                attr_accessor :url
+                
+                ##
+                # Indicates procedure idempotency.
+                #
+                
+                @idempotent
+                attr_accessor :idempotent
+                
+                ##
+                # Holds procedure params specification.
+                #
+                
+                @params
+                attr_accessor :params
+                
+                ##
+                # Holds procedure return value specification.
+                #
+                
+                @return
+                attr_accessor :return
+
+                ##
+                # Creates new one.
+                #
+                # @param [Symbol] name name of the procedure
+                # @param [Hash] opts additional options
+                # @return [V11:ServiceProcedureDescription] 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("Procedure name must be Symbol or convertable to Symbol.")
+                    end
+
+                    if not @params.nil? 
+                        if (not @params.kind_of? Array) or (not @params.all? { |v| v.kind_of? self.class::PARAMETER_DESCRIPTION_CLASS })
+                            raise Exception::new("If params is defined, must be an Array of " << self.class::PARAMETER_DESCRIPTION_CLASS.name << " objects.")
+                        end
+                        
+                        if @params.kind_of? Array
+                            @params.each { |param| param.check! }
+                        end
+                    end
+                    
+                    if not @return.nil?
+                        if not @return.kind_of? self.class::PARAMETER_DESCRIPTION_CLASS
+                            raise Exception::new("If return is defined, must be set to " << self.class::PARAMETER_DESCRIPTION_CLASS.name << " object.")
+                        end
+                        
+                        @return.check!
+                    end
+
+                    if (not @idempotent.nil?) and (not @idempotent.type_of? Boolean)
+                        raise Exception::new("If idempotent is defined, must be boolean.")
+                    end
+                end
+                
+                ##
+                # Renders data to output hash.
+                # @return [Hash] with data of description
+                #
+                
+                def output
+                    self.check!
+                    data = { :name => @name.to_s }
+                    
+                    if not @summary.nil?
+                        data[:summary] = @summary
+                    end
+                    
+                    if not @help.nil?
+                        data[:help] = @help.to_s
+                    end
+                    
+                    if not @idempotent.nil?
+                        data[:idempotent] = @idempotent
+                    end
+                    
+                    if not @params.nil?
+                        data[:params] = @params
+                    end
+
+                    if not @return.nil?
+                        data[:return] = @return
+                    end
+                    
+                    return data
+                end
+                
+                ##
+                # Receives service procedure description objects.
+                #
+                # @param [ProcedureParameterDescription] value with new 
+                #   service procedure descriptor
+                #
+                
+                def <<(value)
+                    if not value.kind_of? self.class::PARAMETER_DESCRIPTION_CLASS
+                        raise Exception::new(self.class::PARAMETER_DESCRIPTION_CLASS.name.dup << " object expected.")
+                    end
+                    
+                    if @params.nil?
+                        @params = [ ]
+                    end
+                    
+                    @params << value
+                end
+                                    
+                    
+                protected
+                
+                ##
+                # Assigns request data.
+                #
+                
+                def data=(value, mode = nil)            
+                    data = __convert_data(value, mode)
+                    
+                    @name = data[:name]
+                    @summary = data[:summary]
+                    @help = data[:help]
+                    @idempotent = data[:idempotent]
+                    @params = data[:params]
+                    @return = data[:return]
+                    
+                    if @params.kind_of? Array
+                        @params = @params.map { |v| self.class::PARAMETER_DESCRIPTION_CLASS::new(v) }
+                    end
+                    
+                    if @return.kind_of? Hash
+                        @return = self.class::PARAMETER_DESCRIPTION_CLASS::new(@return)
+                    end
+                end
+                
+                ##
+                # Converts request data to standard (defined) format.
+                #
+                
+                def normalize!
+                    if @name.kind_of? String
+                        @name = @name.to_sym
+                    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
+                end
+
+            end
+        end
+    end
+end

data/lib/json-rpc-objects/v11/wd/tests/test.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+$:.push("../../../..")
+
+require "../procedure-call"
+req = JsonRpcObjects::V11::WD::ProcedureCall::create(:alfa, {"0" => :beta, "something" => :alfa}, :id => 12345, :"$whatever" => false)
+puts req.to_json
+
+require "../error"
+err = JsonRpcObjects::V11::WD::Error::create(200, "some problem")
+
+require "../procedure-return"
+res = JsonRpcObjects::V11::WD::ProcedureReturn::create(nil, err, :id => 12345)
+puts res.to_json
+res = JsonRpcObjects::V11::WD::ProcedureReturn::create(true, nil, :id => 12345)
+puts res.to_json
+
+require "../service-description"
+sdesc = JsonRpcObjects::V11::WD::ServiceDescription::create(:alfa, 100)
+puts sdesc.to_json
+
+require "../service-procedure-description"
+sproc = JsonRpcObjects::V11::WD::ServiceProcedureDescription::create(:some_proc)
+sdesc << sproc
+puts sdesc.to_json
+
+require "../procedure-parameter-description"
+sparam1 = JsonRpcObjects::V11::WD::ProcedureParameterDescription::create(:param1, :type => :str)
+sparam2 = JsonRpcObjects::V11::WD::ProcedureParameterDescription::create(:param2, :type => JsonRpcObjects)
+sproc << sparam1
+sproc << sparam2
+puts sdesc.to_json
+
+
+require "../../../request"
+puts JsonRpcObjects::Request::parse(req.to_json).inspect
+require "../../../response"
+puts JsonRpcObjects::Response::parse(res.to_json).inspect
+
+puts req.class::version.response::create(25)

data/lib/json-rpc-objects/v20/error.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require "hash-utils/numeric"
+require "json-rpc-objects/v11/alt/error"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Module of JSON-RPC 2.0.
+    # @see http://groups.google.com/group/json-rpc/web/json-rpc-2-0
+    #
+
+    module V20
+
+        ##
+        # Error description object class for Response.
+        #
+        
+        class Error < JsonRpcObjects::V11::Alt::Error
+        
+            ##
+            # Holds link to its version module.
+            #
+            
+            VERSION = JsonRpcObjects::V20
+
+            ##
+            # Indicates data member name.
+            #
+            
+            DATA_MEMBER_NAME = :data
+            
+            ##
+            # Checks correctness of the data.
+            #
+            
+            def check!
+                self.normalize!
+
+                if (@code.in? -32768..-32000) and not ((@code == -32700) or (@code.in? -32603..-32600) or (@code.in? -32099..-32000))
+                    raise Exception::new("Code is invalid because of reserved space.")
+                end
+            end
+
+            ##
+            # Renders data to output hash.
+            # @return [Hash] with data of error
+            #
+            
+            def output
+                result = super()
+                
+                if result.include? :error
+                    result[:data] = result[:error]
+                    result.delete(:error)
+                end
+            
+                return result
+            end
+            
+            
+            protected
+            
+            ##
+            # Assigns error data.
+            #
+            
+            def __assign_data(data)
+                @data = data[:data]
+                data.delete(:data)
+            end            
+                  
+        end
+    end
+end

data/lib/json-rpc-objects/v20/request.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+require "multitype-introspection"
+require "hash-utils/hash"
+require "json-rpc-objects/v11/alt/procedure-call"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Module of JSON-RPC 2.0.
+    # @see http://groups.google.com/group/json-rpc/web/json-rpc-2-0
+    #
+
+    module V20
+    
+        ##
+        # Request object class.
+        #
+        
+        class Request < JsonRpcObjects::V11::Alt::ProcedureCall
+
+            ##
+            # Holds link to its version module.
+            #
+            
+            VERSION = JsonRpcObjects::V20
+            
+            ##
+            # Holds JSON-RPC version specification.
+            #
+            
+            VERSION_NUMBER = :"2.0"
+            
+            ##
+            # Holds JSON-RPC version member identification.
+            #
+            
+            VERSION_MEMBER = :jsonrpc
+                        
+            ##
+            # Indicates ID has been set.
+            #
+            
+            @_id_set
+        
+            ##
+            # Checks correctness of the request data.
+            #
+            
+            def check!
+                super()
+                
+                if not @id.kind_of_any? [String, Integer, NilClass]
+                    raise Exception::new("ID must contain String, Number or nil if included.")
+                end
+            end
+            
+            ##
+            # Renders data to output hash.
+            # @return [Hash] with data of error
+            #
+            
+            def output
+                result = super()
+                
+                if @_id_set and @id.nil?
+                    result[:id] = nil
+                end
+                
+                return result
+            end
+
+            ##
+            # Indicates, it's notification.
+            # @return [Boolean] true if it is, otherwise false
+            #
+
+            def notification?
+                not @_id_set
+            end
+            
+           
+            
+            protected
+            
+            ##
+            # Assigns request data.
+            #
+
+            def data=(value, mode = nil)
+                data = __convert_data(value, mode)
+                
+                # Indicates, ID has been explicitly assigned
+                @_id_set = data.include? :id
+                
+                super(data, :converted)
+            end          
+            
+            ##
+            # Gets params from input.
+            #
+            
+            def __get_params(data)
+                if @params.kind_of? Hash
+                    @keyword_params = @params.keys_to_sym
+                    @params = nil
+                end
+            end
+
+            ##
+            # Assigns the parameters settings.
+            #
+            
+            def __assign_params(data, version = nil)
+                if not @params.nil? and not @params.empty?
+                    data[:params] = @params
+                elsif not @keyword_params.nil? and not @keyword_params.empty?
+                    data[:params] = @keyword_params
+                end
+            end
+            
+        end
+    end
+end