Class: OpenC3::JsonRpcRequest

Inherits:

JsonRpc

• Object
• JsonRpc
• OpenC3::JsonRpcRequest

Defined in:

lib/openc3/io/json_rpc.rb

Overview

Represents a JSON Remote Procedure Call Request

Constant Summary

DANGEROUS_METHODS =

Class Method Summary

• .from_hash(hash) ⇒ JsonRpcRequest

  Creates a JsonRpcRequest object from a Hash.

• .from_json(request_data, request_headers) ⇒ JsonRpcRequest

  Creates a JsonRpcRequest object from a JSON encoded String.

Instance Method Summary

• #id ⇒ Integer

  The request identifier.

• #initialize(method_name, method_params, keyword_params, id) ⇒ JsonRpcRequest constructor

  A new instance of JsonRpcRequest.

• #keyword_params ⇒ Hash<String, Variable>

  Hash which represents the keyword parameters to send to the method.

• #method ⇒ String

  The method to call.

• #params ⇒ Array<String>

  Array of strings which represent the parameters to send to the method.

Methods inherited from JsonRpc

#<=>, #as_json, #to_json

Constructor Details

#initialize(method_name, method_params, keyword_params, id) ⇒ JsonRpcRequest

Returns a new instance of JsonRpcRequest.

Parameters:

• method_name (String) —

  The name of the method to call

• method_params (Array<String>) —

  Array of strings which represent the parameters to send to the method

• keyword_params (Hash<String, Variable>) —

  Hash of key value keyword params

• id (Integer) —

  The identifier which will be matched to the response

# File 'lib/openc3/io/json_rpc.rb', line 237

def initialize(method_name, method_params, keyword_params, id)
  super()
  @hash['jsonrpc'.freeze] = '2.0'.freeze
  @hash['method'.freeze] = method_name.to_s
  if method_params and method_params.length != 0
    @hash['params'.freeze] = method_params
  end
  if keyword_params and keyword_params.length != 0
    symbolized = {}
    keyword_params.each do |key, value|
      symbolized[key.intern] = value
    end
    @hash['keyword_params'.freeze] = symbolized
  end
  @hash['id'.freeze] = id.to_i
end

Class Method Details

.from_hash(hash) ⇒ JsonRpcRequest

Creates a JsonRpcRequest object from a Hash

Parameters:

• hash (Hash) —

  Hash containing the following keys: method, params, and id

Returns:

• (JsonRpcRequest)

# File 'lib/openc3/io/json_rpc.rb', line 299

def self.from_hash(hash)
  self.new(hash['method'.freeze], hash['params'.freeze], hash['keyword_params'.freeze], hash['id'.freeze])
end

.from_json(request_data, request_headers) ⇒ JsonRpcRequest

Creates a JsonRpcRequest object from a JSON encoded String. The version must be 2.0 and the JSON must include the method and id members.

Parameters:

• request_data (String) —

  JSON encoded string representing the request

• request_headers (Hash) —

  Request Header to include the auth token

Returns:

• (JsonRpcRequest)

# File 'lib/openc3/io/json_rpc.rb', line 282

def self.from_json(request_data, request_headers)
  hash = JSON.parse(request_data, allow_nan: true, create_additions: true)
  hash['keyword_params']['token'] = request_headers['HTTP_AUTHORIZATION'] if request_headers['HTTP_AUTHORIZATION']
  hash['keyword_params']['manual'] = request_headers['HTTP_MANUAL'] if request_headers['HTTP_MANUAL']
  # Verify the jsonrpc version is correct and there is a method and id
  raise unless hash['jsonrpc'.freeze] == "2.0".freeze && hash['method'.freeze] && hash['id'.freeze]

  self.from_hash(hash)
rescue
  raise "Invalid JSON-RPC 2.0 Request\n#{request_data.inspect}\n"
end

Instance Method Details

#id ⇒ Integer

Returns The request identifier.

Returns:

• (Integer) —

  The request identifier

# File 'lib/openc3/io/json_rpc.rb', line 272

def id
  @hash['id'.freeze]
end

#keyword_params ⇒ Hash<String, Variable>

Returns Hash which represents the keyword parameters to send to the method.

Returns:

• (Hash<String, Variable>) —

  Hash which represents the keyword parameters to send to the method

# File 'lib/openc3/io/json_rpc.rb', line 267

def keyword_params
  @hash['keyword_params'.freeze]
end

#method ⇒ String

Returns The method to call.

Returns:

• (String) —

  The method to call

# File 'lib/openc3/io/json_rpc.rb', line 255

def method
  @hash['method'.freeze]
end

#params ⇒ Array<String>

Returns Array of strings which represent the parameters to send to the method.

Returns:

• (Array<String>) —

  Array of strings which represent the parameters to send to the method

# File 'lib/openc3/io/json_rpc.rb', line 261

def params
  @hash['params'.freeze] || []
end