Class: PactBroker::Api::Resources::DefaultBaseResource
Constant Summary
Pacts::Metadata::MAPPINGS
Constants included
from Services
Services::FACTORIES
Instance Attribute Summary collapse
Instance Method Summary
collapse
Methods included from Logging
included, #log_error, #log_with_tag
#action, #create_methods, #delete_methods, #read_methods, #update_methods
#authenticated?
#append_query_if_present, #badge_url_for_latest_pact, #branch_version_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_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_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_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
#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
Methods included from Services
#badge_service, #branch_service, #certificate_service, #contract_service, #deployed_version_service, #environment_service, #get, #group_service, #index_service, #integration_service, #label_service, #matrix_service, #metrics_service, #pact_service, #pacticipant_service, #register_default_services, #register_service, #released_version_service, #tag_service, #verification_service, #version_service, #webhook_service, #webhook_trigger_service
Constructor Details
Returns a new instance of DefaultBaseResource.
28
29
30
31
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 28
def initialize
PactBroker.configuration.before_resource.call(self)
application_context.before_resource&.call(self)
end
|
Instance Attribute Details
#user ⇒ Object
Returns the value of attribute user.
26
27
28
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 26
def user
@user
end
|
Instance Method Details
#api_contract_class(name) ⇒ Object
257
258
259
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 257
def api_contract_class(name)
application_context.api_contract_configuration.class_for(name)
end
|
#application_context ⇒ Object
249
250
251
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 249
def application_context
request.path_info[:application_context]
end
|
#base_url ⇒ Object
73
74
75
76
77
78
79
80
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 73
def base_url
request.env["pactbroker.base_url"] || request.base_uri.to_s.chomp("/")
end
|
#charsets_provided ⇒ Object
87
88
89
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 87
def charsets_provided
[["utf-8", :encode]]
end
|
#consumer ⇒ Object
220
221
222
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 220
def consumer
@consumer ||= identifier_from_path[:consumer_name] && find_pacticipant(identifier_from_path[:consumer_name], "consumer")
end
|
#consumer_name ⇒ Object
154
155
156
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 154
def consumer_name
identifier_from_path[:consumer_name]
end
|
#consumer_specified? ⇒ Boolean
166
167
168
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 166
def consumer_specified?
identifier_from_path.key?(:consumer_name)
end
|
#consumer_version_number ⇒ Object
158
159
160
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 158
def consumer_version_number
identifier_from_path[:consumer_version_number]
end
|
#contract_validation_errors?(contract, params) ⇒ Boolean
207
208
209
210
211
212
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 207
def contract_validation_errors? contract, params
if (invalid = !contract.validate(params))
set_json_validation_error_messages contract.errors.messages
end
invalid
end
|
#database_connector ⇒ Object
245
246
247
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 245
def database_connector
request.env["pactbroker.database_connector"]
end
|
#decorator_class(name) ⇒ Object
253
254
255
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 253
def decorator_class(name)
application_context.decorator_configuration.class_for(name)
end
|
#decorator_context(options = {}) ⇒ Object
100
101
102
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 100
def decorator_context options = {}
application_context.decorator_context_creator.call(self, options)
end
|
#decorator_options(options = {}) ⇒ Object
104
105
106
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 104
def decorator_options options = {}
{ user_options: decorator_context(options) }
end
|
#encode(body) ⇒ Object
We only use utf-8 so leave encoding as it is
92
93
94
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 92
def encode(body)
body
end
|
#find_pacticipant(name, role) ⇒ Object
214
215
216
217
218
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 214
def find_pacticipant name, role
pacticipant_service.find_pacticipant_by_name(name).tap do | pacticipant |
set_json_error_message("No #{role} with name '#{name}' found") if pacticipant.nil?
end
end
|
#finish_request ⇒ Object
41
42
43
44
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 41
def finish_request
application_context.after_resource&.call(self)
PactBroker.configuration.after_resource.call(self)
end
|
#forbidden? ⇒ Boolean
50
51
52
53
54
55
56
57
58
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 50
def forbidden?
if application_context.resource_authorizer
!application_context.resource_authorizer.call(self)
elsif PactBroker.configuration.authorize
!PactBroker.configuration.authorize.call(self, {})
else
false
end
end
|
#handle_exception(error) ⇒ Object
108
109
110
111
112
113
114
115
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 108
def handle_exception(error)
error_reference = PactBroker::Errors.generate_error_reference
application_context.error_logger.call(error, error_reference, request.env)
if PactBroker::Errors.reportable_error?(error)
PactBroker::Errors.report(error, error_reference, request.env)
end
response.body = application_context.error_response_body_generator.call(error, error_reference, request.env)
end
|
#identifier_from_path ⇒ Object
Also known as:
path_info
The path_info segments aren’t URL decoded
61
62
63
64
65
66
67
68
69
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 61
def identifier_from_path
@identifier_from_path ||= request.path_info.each_with_object({}) do | (key, value), hash|
if value.is_a?(String)
hash[key] = URI.decode(value)
elsif value.is_a?(Symbol) || value.is_a?(Numeric)
hash[key] = value
end
end
end
|
#integration ⇒ Object
Not necessarily an existing integration
237
238
239
240
241
242
243
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 237
def integration
if consumer_specified? && provider_specified?
OpenStruct.new(consumer: consumer, provider: provider)
else
nil
end
end
|
#invalid_json? ⇒ Boolean
186
187
188
189
190
191
192
193
194
195
196
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 186
def invalid_json?
begin
params
false
rescue StandardError => e
logger.info "Error parsing JSON #{e} - #{request_body}"
set_json_error_message "Error parsing JSON - #{e.message}"
response.["Content-Type"] = "application/hal+json;charset=utf-8"
true
end
end
|
#is_authorized?(authorization_header) ⇒ Boolean
46
47
48
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 46
def is_authorized?()
authenticated?(self, )
end
|
#known_methods ⇒ Object
37
38
39
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 37
def known_methods
super + ["PATCH"]
end
|
274
275
276
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 274
def malformed_request_for_json_with_schema?(schema_to_use = schema, params_to_validate = params)
invalid_json? || validation_errors_for_schema?(schema_to_use, params_to_validate)
end
|
#options ⇒ Object
33
34
35
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 33
def options
{ "Access-Control-Allow-Methods" => allowed_methods.join(", ")}
end
|
#pact ⇒ Object
232
233
234
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 232
def pact
@pact ||= pact_service.find_pact(pact_params)
end
|
#pact_params ⇒ Object
136
137
138
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 136
def pact_params
@pact_params ||= PactBroker::Pacts::PactParams.from_request request, identifier_from_path
end
|
#pacticipant ⇒ Object
228
229
230
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 228
def pacticipant
@pacticipant ||= identifier_from_path[:pacticipant_name] && find_pacticipant(identifier_from_path[:pacticipant_name], "pacticipant")
end
|
#pacticipant_name ⇒ Object
178
179
180
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 178
def pacticipant_name
identifier_from_path[:pacticipant_name]
end
|
#pacticipant_specified? ⇒ Boolean
182
183
184
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 182
def pacticipant_specified?
identifier_from_path.key?(:pacticipant_name)
end
|
#pacticipant_version_number ⇒ Object
162
163
164
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 162
def pacticipant_version_number
identifier_from_path[:pacticipant_version_number]
end
|
#params(options = {}) ⇒ Object
rubocop: disable Metrics/CyclomaticComplexity
118
119
120
121
122
123
124
125
126
127
128
129
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 118
def params(options = {})
return options[:default] if options.key?(:default) && request_body.empty?
symbolize_names = !options.key?(:symbolize_names) || options[:symbolize_names]
if symbolize_names
@params_with_symbol_keys ||= JSON.parse(request_body, { symbolize_names: true }.merge(PACT_PARSING_OPTIONS)) else
@params_with_string_keys ||= JSON.parse(request_body, { symbolize_names: false }.merge(PACT_PARSING_OPTIONS)) end
rescue JSON::JSONError => e
raise InvalidJsonError.new("Error parsing JSON - #{e.message}")
end
|
#params_with_string_keys ⇒ Object
rubocop: enable Metrics/CyclomaticComplexity
132
133
134
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 132
def params_with_string_keys
params(symbolize_names: false)
end
|
#provider ⇒ Object
224
225
226
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 224
def provider
@provider ||= identifier_from_path[:provider_name] && find_pacticipant(identifier_from_path[:provider_name], "provider")
end
|
#provider_name ⇒ Object
174
175
176
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 174
def provider_name
identifier_from_path[:provider_name]
end
|
#provider_specified? ⇒ Boolean
170
171
172
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 170
def provider_specified?
identifier_from_path.key?(:provider_name)
end
|
#request_body ⇒ Object
150
151
152
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 150
def request_body
@request_body ||= request.body.to_s
end
|
#resource_url ⇒ Object
96
97
98
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 96
def resource_url
request.uri.to_s.gsub(/\?.*/, "").chomp("/")
end
|
#schema ⇒ Object
261
262
263
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 261
def schema
nil
end
|
#set_json_error_message(message) ⇒ Object
140
141
142
143
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 140
def set_json_error_message message
response.["Content-Type"] = "application/hal+json;charset=utf-8"
response.body = { error: message }.to_json
end
|
#set_json_validation_error_messages(errors) ⇒ Object
145
146
147
148
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 145
def set_json_validation_error_messages errors
response.["Content-Type"] = "application/hal+json;charset=utf-8"
response.body = { errors: errors }.to_json
end
|
#ui_base_url ⇒ Object
See comments for base_url in lib/pact_broker/doc/controllers/app.rb
83
84
85
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 83
def ui_base_url
request.env["pactbroker.base_url"] || ""
end
|
#validation_errors?(model) ⇒ Boolean
198
199
200
201
202
203
204
205
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 198
def validation_errors? model
if (errors = model.validate).any?
set_json_validation_error_messages errors
true
else
false
end
end
|
#validation_errors_for_schema?(schema_to_use = schema, params_to_validate = params) ⇒ Boolean
265
266
267
268
269
270
271
272
|
# File 'lib/pact_broker/api/resources/default_base_resource.rb', line 265
def validation_errors_for_schema?(schema_to_use = schema, params_to_validate = params)
if (errors = schema_to_use.call(params_to_validate)).any?
set_json_validation_error_messages(errors)
true
else
false
end
end
|