Class: PactBroker::Api::Decorators::EmbeddedErrorProblemJsonDecorator

Inherits:
BaseDecorator
  • Object
show all
Defined in:
lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb

Constant Summary

Constants included from FormatDateTime

FormatDateTime::DATE_TIME_CLASS

Constants included from Pacts::Metadata

Pacts::Metadata::MAPPINGS

Instance Method Summary collapse

Methods inherited from BaseDecorator

camelize_property_names, eager_load_associations, property

Methods included from FormatDateTime

call, #format_date_time

Methods included from PactBrokerUrls

#append_query_if_present, #badge_url_for_latest_pact, #branch_url, #branch_version_url, #branch_versions_url, #consumer_webhooks_url, #currently_deployed_versions_for_environment_url, #currently_supported_versions_for_environment_url, #dashboard_url_for_integration, #decode_pact_metadata, #deployed_version_url, #deployed_versions_for_version_and_environment_url, #encode_metadata, #environment_url, #environments_url, #group_url, #hal_browser_url, #integration_url, #label_url, #labels_url, #latest_pact_url, #latest_pacts_url, #latest_tagged_pact_url, #latest_untagged_pact_url, #latest_verification_for_pact_url, #latest_verifications_for_consumer_version_url, #latest_version_for_branch_url, #latest_version_url, #matrix_badge_url_for_selectors, #matrix_for_pact_url, #matrix_for_pacticipant_version_url, #matrix_url, #matrix_url_from_params, #new_verification_url, #pact_triggered_webhooks_url, #pact_url, #pact_url_from_params, #pact_version_url, #pact_version_url_with_metadata, #pact_version_url_with_webhook_metadata, #pact_version_with_consumer_version_metadata_url, #pact_versions_for_branch_url, #pact_versions_url, #pacticipant_branches_url, #pacticipant_url, #pacticipant_url_from_params, #pacticipants_url, #pacticipants_with_label_url, #previous_distinct_diff_url, #previous_distinct_pact_version_url, #provider_webhooks_url, #record_undeployment_url, #released_version_url, #released_versions_for_version_and_environment_url, #tag_url, #tagged_pact_versions_url, #tags_url, #templated_branch_version_url_for_pacticipant, #templated_can_i_deploy_badge_url, #templated_can_i_deploy_branch_to_environment_badge_url, #templated_can_i_deploy_url, #templated_diff_url, #templated_label_url_for_pacticipant, #templated_tag_url_for_pacticipant, #templated_version_url_for_pacticipant, #triggered_webhook_logs_url, #url_encode, #verification_publication_url, #verification_triggered_webhooks_url, #verification_url, #verification_url_from_params, #version_url, #version_url_from_params, #versions_url, #webhook_execution_url, #webhook_url, #webhooks_for_consumer_and_provider_url, #webhooks_for_pact_url, #webhooks_status_url, #webhooks_url

Methods included from Logging

included, #log_error, #log_with_tag, #measure_info

Methods included from Pacts::Metadata

#build_metadata_for_consumer_version_number, #build_metadata_for_latest_pact, #build_metadata_for_pact_for_verification, #build_metadata_for_webhook_triggered_by_pact_publication, #parse_hash, #parse_metadata, #parse_object

Instance Method Details

#body_type ⇒ Object 



68
69
70
71
72
73
74
75
76
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 68

def body_type
  if represented.text.include?("missing")
    "problems/missing-body-property"
  elsif represented.text.include?("format")
    "problems/invalid-body-property-format"
  else
    "problems/invalid-body-property-value"
  end
end

#is_path_error? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 78

def is_path_error?
  represented.path.first == :_path
end

#parameter ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 33

def parameter
  if is_path_error?
    represented.path.last.to_s
  else
    nil
  end
end

#path_type ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 58

def path_type
  if represented.text.include?("missing")
    "problems/missing-request-parameter"
  elsif represented.text.include?("format")
    "problems/invalid-request-parameter-format"
  else
    "problems/invalid-request-parameter-value"
  end
end

#pointer ⇒ Object

dry-validation doesn’t support validating a top level array, so we wrap the json patch operations array in a hash with the key :_ops to validate it. When we render the error, we have to remove the /_ops prefix from the pointer. For contracts where we validate the path and the body together using _path and _body we also need to remove the first key from the path. It’s possible the pointer should have a # at the start of it as per www.rfc-editor.org/rfc/rfc6901 :shrug:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 22

def pointer
  if is_path_error?
    nil
  # _ops, _path or _body for use when we need to hack the way dry-validation schemas work
  elsif represented.path.first.to_s.start_with?("_")
    "/" + represented.path[1..-1].join("/")
  else
    "/" + represented.path.join("/")
  end
end

#title ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 41

def title
  if is_path_error?
    "Invalid path segment"
  else
    "Invalid body parameter"
  end
end

#type(base_url) ⇒ Object

Parameters:

  • base_url (String) 


50
51
52
53
54
55
56
 
# File 'lib/pact_broker/api/decorators/embedded_error_problem_json_decorator.rb', line 50

def type(base_url)
  if is_path_error?
    "#{base_url}/#{path_type}"
  else
    "#{base_url}/#{body_type}"
  end
end