Module: ActiveRpc::Rpc::Concerns::ResourceController

Extended by:
ActiveSupport::Concern
Includes:
QueryBuilder, RequestProcessor
Included in:
BaseController
Defined in:
lib/active_rpc/rpc/concerns/resource_controller.rb

Overview

The ResourceController concern provides high-level methods for common CRUD operations in gRPC controllers.

Examples:

def get_user
  get_resource(User, request.message, transformer: :to_rpc_response)
end

def list_users
  list_resources(User, request.message,
    response_class: ::Core::UserListResponse,
    transformer: :to_rpc_response
  )
end

Instance Method Summary collapse

Methods included from QueryBuilder

#build_query, #execute_query, #paginated_response

Methods included from Sortable

#apply_sorting, #get_query_config

Methods included from Paginatable

#apply_pagination, #pagination_metadata

Methods included from Includable

#apply_includes, #get_query_config

Methods included from Scopable

#apply_scopes

Methods included from Ransackable

#apply_ransack

Methods included from RequestProcessor

#extract_params, #process_request

Instance Method Details

#create_resource(model_class, request_payload, options = {}) ⇒ Object

Create a resource



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/active_rpc/rpc/concerns/resource_controller.rb', line 53

def create_resource(model_class, request_payload, options = {})
  process_request do
    # Validate required parameters
    if options[:required_params].is_a?(Array)
      validate_required_params!(request_payload, *options[:required_params])
    end

    # Extract parameters
    params = if options[:param_extractor].is_a?(Proc)
               options[:param_extractor].call(request_payload)
    else
               extract_params(request_payload, *options[:param_names])
    end

    # Coerce JSONB columns from JSON string to Hash (schema-aware, generic)
    params = coerce_jsonb_params(model_class, params)

    # Create the resource
    resource = model_class.new(params.to_h.with_indifferent_access)

    # Apply before save hook if provided
    if options[:before_save].is_a?(Proc)
      hook_result = options[:before_save].call(resource, request_payload)
      # Check if the hook returned an error response
      return hook_result if hook_result.respond_to?(:success) && hook_result.success == false
    end

    # Save the resource
    if resource.save
      # Apply after save hook if provided
      if options[:after_save].is_a?(Proc)
        hook_result = options[:after_save].call(resource, request_payload)
        # Check if the hook returned an error response
        return hook_result if hook_result.respond_to?(:success) && hook_result.success == false
      end

      # Transform the resource with success metadata
      result = if options[:transformer].is_a?(Proc)
                 options[:transformer].call(resource)
      elsif options[:transformer] == :to_rpc_response
                 resource.reload.to_rpc_response
      else
                 resource.reload
      end

      # Ensure string fields in protobuf receive strings (stringify Hash/Array)
      coerce_string_fields_in_response!(result)

      # Add success metadata to the response
      result._metadata = create_success_metadata if result.respond_to?(:_metadata=)

      result
    else
      # Create response with validation error metadata
      result = if options[:transformer].is_a?(Proc)
                 options[:transformer].call(resource)
      elsif options[:transformer] == :to_rpc_response
                 resource.to_rpc_response
      else
                 # Create a basic response object for the resource type
                 resource_class_name = resource.class.name
                 response_class = "Core::#{resource_class_name}Response".constantize
                 response_class.new
      end

      # Add validation error metadata to the response
      result._metadata = create_validation_error_metadata(resource) if result.respond_to?(:_metadata=)

      # Ensure string fields in protobuf receive strings (stringify Hash/Array)
      coerce_string_fields_in_response!(result)

      result
    end
  end
end

#delete_resource(model_class, request_payload, options = {}) ⇒ Object

Delete a resource



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/active_rpc/rpc/concerns/resource_controller.rb', line 206

def delete_resource(model_class, request_payload, options = {})
  process_request do
    # Validate required parameters
    validate_required_params!(request_payload, :id)

    # Find the resource
    resource = find_record(model_class, request_payload.id)

    # Apply before destroy hook if provided
    options[:before_destroy].call(resource, request_payload) if options[:before_destroy].is_a?(Proc)

    # Destroy the resource
    resource.destroy!

    # Apply after destroy hook if provided
    options[:after_destroy].call(resource, request_payload) if options[:after_destroy].is_a?(Proc)

    # Return success response
    options[:success_response] || { success: true }
  end
end

#get_resource(model_class, request_payload, options = {}) ⇒ Object

Get a single resource



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/active_rpc/rpc/concerns/resource_controller.rb', line 25

def get_resource(model_class, request_payload, options = {})
  process_request do
    # Validate required parameters
    validate_required_params!(request_payload, :id)

    # Find the resource with includes if provided
    includes = options[:includes] || []
    resource = model_class.includes(includes).find(request_payload.id)

    # Transform the resource
    if options[:transformer].is_a?(Proc)
      options[:transformer].call(resource)
    elsif options[:transformer] == :to_rpc_response
      resource.to_rpc_response
    else
      resource
    end
  end
end

#list_resources(model_class, request_payload, options = {}) ⇒ Object

List resources



46
47
48
49
50
 
# File 'lib/active_rpc/rpc/concerns/resource_controller.rb', line 46

def list_resources(model_class, request_payload, options = {})
  process_request do
    execute_query(model_class, request_payload, options)
  end
end

#update_resource(model_class, request_payload, options = {}) ⇒ Object

Update a resource



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/active_rpc/rpc/concerns/resource_controller.rb', line 130

def update_resource(model_class, request_payload, options = {})
  process_request do
    # Validate required parameters
    validate_required_params!(request_payload, :id)

    # Find the resource
    resource = find_record(model_class, request_payload.id)

    # Extract parameters
    params = if options[:param_extractor].is_a?(Proc)
               options[:param_extractor].call(request_payload)
    else
               extract_params(request_payload, *options[:param_names])
    end

    # Coerce JSONB columns from JSON string to Hash (schema-aware, generic)
    params = coerce_jsonb_params(model_class, params)

    # Apply before save hook if provided
    if options[:before_save].is_a?(Proc)
      hook_result = options[:before_save].call(resource, request_payload)
      # Check if the hook returned an error response
      return hook_result if hook_result.respond_to?(:success) && hook_result.success == false
    end

    # Update the resource
    resource.assign_attributes(params.with_indifferent_access)
    if resource.save
      # Apply after save hook if provided
      if options[:after_save].is_a?(Proc)
        hook_result = options[:after_save].call(resource, request_payload)
        # Check if the hook returned an error response
        return hook_result if hook_result.respond_to?(:success) && hook_result.success == false
      end

      # Transform the resource with success metadata
      result = if options[:transformer].is_a?(Proc)
                 options[:transformer].call(resource)
      elsif options[:transformer] == :to_rpc_response
                 resource.reload.to_rpc_response
      else
                 resource.reload
      end

      # Ensure string fields in protobuf receive strings (stringify Hash/Array)
      coerce_string_fields_in_response!(result)

      # Add success metadata to the response
      result._metadata = create_success_metadata if result.respond_to?(:_metadata=)

      result
    else
      # Create response with validation error metadata
      result = if options[:transformer].is_a?(Proc)
                 options[:transformer].call(resource)
      elsif options[:transformer] == :to_rpc_response
                 resource.to_rpc_response
      else
                 # Create a basic response object for the resource type
                 resource_class_name = resource.class.name
                 response_class = "Core::#{resource_class_name}Response".constantize
                 response_class.new
      end

      # Add validation error metadata to the response
      result._metadata = create_validation_error_metadata(resource) if result.respond_to?(:_metadata=)

      # Ensure string fields in protobuf receive strings (stringify Hash/Array)
      coerce_string_fields_in_response!(result)

      result
    end
  end
end