Class: NonCrudEndpoints

Inherits:
Object
  • Object
show all
Defined in:
lib/non_crud_endpoints.rb

Direct Known Subclasses

Endpoints::TestApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(m, params) ⇒ NonCrudEndpoints

Add a validation method which will be inherited by all the instances, and automatically run before any method call

Raises:

  • (NoMethodError) 


4
5
6
7
8
9
10
 
# File 'lib/non_crud_endpoints.rb', line 4

def initialize(m, params)
    # Check if self hase the m method, if not, raise a NoMethodError
    raise NoMethodError, "The method #{m} does not exist in #{self.class}" unless self.respond_to? m
    definition = self.send(m, { explain: true }) rescue []
    validate_request(definition.first.presence || {}, params)
    @result = self.send(m, params)
end

Instance Attribute Details

#result ⇒ Object

Returns the value of attribute result.



2
3
4
 
# File 'lib/non_crud_endpoints.rb', line 2

def result
  @result
end

Instance Method Details

#validate_request(definition, params) ⇒ Object

Raises:



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/non_crud_endpoints.rb', line 12

def validate_request(definition, params)
    # If there is no definition, return
    return if definition.blank?
    # puts "Called Class is: #{self.class}"
    # puts "Which is son of: #{self.class.superclass}"
    body_mandatory_keys = definition[:body].select { |k, v| v[:optional] == false }.keys
    query_mandatory_keys = definition[:query].select { |k, v| v[:optional] == false }.keys
    # Raise a ValidationError if the request does not match the definition
    raise EndpointValidationError, "The verb \"#{params[:request_verb].presence || "No Verb Provided"}\" is not present in #{definition[:verbs].join(", ")}." if definition[:verbs].exclude? params[:request_verb]
    # Raise an exception if the verb is put or post and the body keys in definition are not all present as params keys, both params and definition[:body] can have nested objects
    raise EndpointValidationError, "The request body does not match the definition: in #{params[:request_verb]} requests all of the params must be present in definition. The body definition is #{definition[:body]}." if params[:request_verb] != "GET" && (body_mandatory_keys & params.keys) != body_mandatory_keys
    # Raise an exception if the verb is put or post and the body keys in definition are not all present as params keys, both params and definition[:body] can have nested objects
    raise EndpointValidationError, "The request query does not match the definition. The query definition is: #{definition[:query]}." if (query_mandatory_keys & params.keys) != query_mandatory_keys
    # Rais if the type of the param is not the same as the definition
    definition[:body].each do |k, v|
        next if params[k].nil?
        computed_type = get_type(params[k])
        raise EndpointValidationError, "The type of the param #{k} is not the same as the definition. The definition is #{v[:type]} and the param is #{computed_type}." if v[:type] != computed_type
    end
end