Class: Gruf::Controllers::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/gruf/controllers/request.rb

Overview

Encapsulates a request for a controller

Defined Under Namespace

Classes: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method_key:, service:, rpc_desc:, active_call:, message:) ⇒ Request

Initialize an inbound controller request object

Parameters:

  • method_key (Symbol) —

    The method symbol of the RPC method being executed

  • service (Class) —

    The class of the service being executed against

  • rpc_desc (GRPC::RpcDesc) —

    The RPC descriptor of the call

  • active_call (GRPC::ActiveCall) —

    The restricted view of the call

  • message (Object) —

    The protobuf message (or messages) of the request



63
64
65
66
67
68
69
70
 
# File 'lib/gruf/controllers/request.rb', line 63

def initialize(method_key:, service:, rpc_desc:, active_call:, message:)
  @method_key = method_key
  @service = service
  @active_call = active_call
  @message = message
  @rpc_desc = rpc_desc
  @type = Type.new(rpc_desc)
end

Instance Attribute Details

#active_call ⇒ Object (readonly)

Returns the value of attribute active_call.



27
28
29
 
# File 'lib/gruf/controllers/request.rb', line 27

def active_call
  @active_call
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



25
26
27
 
# File 'lib/gruf/controllers/request.rb', line 25

def message
  @message
end

#method_key ⇒ Object (readonly)

Returns the value of attribute method_key.



29
30
31
 
# File 'lib/gruf/controllers/request.rb', line 29

def method_key
  @method_key
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



33
34
35
 
# File 'lib/gruf/controllers/request.rb', line 33

def service
  @service
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



31
32
33
 
# File 'lib/gruf/controllers/request.rb', line 31

def type
  @type
end

Instance Method Details

#messages ⇒ Object

Return all messages for this request, properly handling different request types



110
111
112
113
114
115
116
117
118
 
# File 'lib/gruf/controllers/request.rb', line 110

def messages
  if client_streamer?
    message.call { |msg| yield msg }
  elsif bidi_streamer?
    message
  else
    [message]
  end
end

#method_name ⇒ String

Parse the method signature into a service.method name format

Returns:

  • (String) —

    The parsed service method name



101
102
103
 
# File 'lib/gruf/controllers/request.rb', line 101

def method_name
  "#{service_key}.#{method_key}"
end

#request_class ⇒ Class

Returns The class of the request message.

Returns:

  • (Class) —

    The class of the request message



92
93
94
 
# File 'lib/gruf/controllers/request.rb', line 92

def request_class
  @rpc_desc.input
end

#response_class ⇒ Class

Returns The class of the response message.

Returns:

  • (Class) —

    The class of the response message



85
86
87
 
# File 'lib/gruf/controllers/request.rb', line 85

def response_class
  @rpc_desc.output
end

#service_key ⇒ String

Returns the service name as a translated name separated by periods. Strips the superfluous “Service” suffix from the name

Returns:

  • (String) —

    The mapped service key



78
79
80
 
# File 'lib/gruf/controllers/request.rb', line 78

def service_key
  @service.name.underscore.tr('/', '.').gsub('.service', '')
end