Class: PactBroker::Api::Resources::BaseResource

Inherits:
Webmachine::Resource
  • Object
show all
Includes:
PactBrokerUrls, Authentication, Authorization, Logging, Services
Defined in:
lib/pact_broker/api/resources/base_resource.rb

Constant Summary

Constants included from Pacts::Metadata

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

Methods included from Authorization

#action, #create_methods, #delete_methods, #read_methods, #update_methods

Methods included from Authentication

#authenticated?

Methods included from PactBrokerUrls

#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_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 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

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

#initializeBaseResource

Returns a new instance of BaseResource.



29
30
31
32
# File 'lib/pact_broker/api/resources/base_resource.rb', line 29

def initialize
  PactBroker.configuration.before_resource.call(self)
  application_context.before_resource&.call(self)
end

Instance Attribute Details

#userObject

Returns the value of attribute user.



27
28
29
# File 'lib/pact_broker/api/resources/base_resource.rb', line 27

def user
  @user
end

Instance Method Details

#any_request_body?Boolean

Returns:

  • (Boolean)


155
156
157
# File 'lib/pact_broker/api/resources/base_resource.rb', line 155

def any_request_body?
  request_body && request_body.size > 0
end

#api_contract_class(name) ⇒ Object



262
263
264
# File 'lib/pact_broker/api/resources/base_resource.rb', line 262

def api_contract_class(name)
  application_context.api_contract_configuration.class_for(name)
end

#application_contextObject



254
255
256
# File 'lib/pact_broker/api/resources/base_resource.rb', line 254

def application_context
  request.path_info[:application_context]
end

#base_urlObject



74
75
76
77
78
79
80
81
# File 'lib/pact_broker/api/resources/base_resource.rb', line 74

def base_url
  # Have to use something for the base URL here - we can't use an empty string as we can in the UI.
  # Can't work out if cache poisoning is a vulnerability for APIs or not.
  # Using the request base URI as a fallback if the base_url is not configured may be a vulnerability,
  # but the documentation recommends that the
  # base_url should be set in the configuration to mitigate this.
  request.env["pactbroker.base_url"] || request.base_uri.to_s.chomp("/")
end

#charsets_providedObject



88
89
90
# File 'lib/pact_broker/api/resources/base_resource.rb', line 88

def charsets_provided
  [["utf-8", :encode]]
end

#consumerObject



225
226
227
# File 'lib/pact_broker/api/resources/base_resource.rb', line 225

def consumer
  @consumer ||= identifier_from_path[:consumer_name] && find_pacticipant(identifier_from_path[:consumer_name], "consumer")
end

#consumer_nameObject



159
160
161
# File 'lib/pact_broker/api/resources/base_resource.rb', line 159

def consumer_name
  identifier_from_path[:consumer_name]
end

#consumer_specified?Boolean

Returns:

  • (Boolean)


171
172
173
# File 'lib/pact_broker/api/resources/base_resource.rb', line 171

def consumer_specified?
  identifier_from_path.key?(:consumer_name)
end

#consumer_version_numberObject



163
164
165
# File 'lib/pact_broker/api/resources/base_resource.rb', line 163

def consumer_version_number
  identifier_from_path[:consumer_version_number]
end

#contract_validation_errors?(contract, params) ⇒ Boolean

Returns:

  • (Boolean)


212
213
214
215
216
217
# File 'lib/pact_broker/api/resources/base_resource.rb', line 212

def contract_validation_errors? contract, params
  if (invalid = !contract.validate(params))
    set_json_validation_error_messages contract.errors.messages
  end
  invalid
end

#database_connectorObject



250
251
252
# File 'lib/pact_broker/api/resources/base_resource.rb', line 250

def database_connector
  request.env["pactbroker.database_connector"]
end

#decorator_class(name) ⇒ Object



258
259
260
# File 'lib/pact_broker/api/resources/base_resource.rb', line 258

def decorator_class(name)
  application_context.decorator_configuration.class_for(name)
end

#decorator_context(options = {}) ⇒ Object



101
102
103
# File 'lib/pact_broker/api/resources/base_resource.rb', line 101

def decorator_context options = {}
  application_context.decorator_context_creator.call(self, options)
end

#decorator_options(options = {}) ⇒ Object



105
106
107
# File 'lib/pact_broker/api/resources/base_resource.rb', line 105

def decorator_options options = {}
  { user_options: decorator_context(options) }
end

#encode(body) ⇒ Object

We only use utf-8 so leave encoding as it is



93
94
95
# File 'lib/pact_broker/api/resources/base_resource.rb', line 93

def encode(body)
  body
end

#find_pacticipant(name, role) ⇒ Object



219
220
221
222
223
# File 'lib/pact_broker/api/resources/base_resource.rb', line 219

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_requestObject



42
43
44
45
# File 'lib/pact_broker/api/resources/base_resource.rb', line 42

def finish_request
  application_context.after_resource&.call(self)
  PactBroker.configuration.after_resource.call(self)
end

#forbidden?Boolean

Returns:

  • (Boolean)


51
52
53
54
55
56
57
58
59
# File 'lib/pact_broker/api/resources/base_resource.rb', line 51

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



109
110
111
112
113
114
115
116
# File 'lib/pact_broker/api/resources/base_resource.rb', line 109

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_pathObject Also known as: path_info

The path_info segments aren’t URL decoded



62
63
64
65
66
67
68
69
70
# File 'lib/pact_broker/api/resources/base_resource.rb', line 62

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

#integrationObject

Not necessarily an existing integration



242
243
244
245
246
247
248
# File 'lib/pact_broker/api/resources/base_resource.rb', line 242

def integration
  if consumer_specified? && provider_specified?
    OpenStruct.new(consumer: consumer, provider: provider)
  else
    nil
  end
end

#invalid_json?Boolean

Returns:

  • (Boolean)


191
192
193
194
195
196
197
198
199
200
201
# File 'lib/pact_broker/api/resources/base_resource.rb', line 191

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.headers["Content-Type"] = "application/hal+json;charset=utf-8"
    true
  end
end

#is_authorized?(authorization_header) ⇒ Boolean

Returns:

  • (Boolean)


47
48
49
# File 'lib/pact_broker/api/resources/base_resource.rb', line 47

def is_authorized?(authorization_header)
  authenticated?(self, authorization_header)
end

#known_methodsObject



38
39
40
# File 'lib/pact_broker/api/resources/base_resource.rb', line 38

def known_methods
  super + ["PATCH"]
end

#malformed_request_for_json_with_schema?(schema_to_use = schema, params_to_validate = params) ⇒ Boolean

Returns:

  • (Boolean)


279
280
281
# File 'lib/pact_broker/api/resources/base_resource.rb', line 279

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

#optionsObject



34
35
36
# File 'lib/pact_broker/api/resources/base_resource.rb', line 34

def options
  { "Access-Control-Allow-Methods" => allowed_methods.join(", ")}
end

#pactObject



237
238
239
# File 'lib/pact_broker/api/resources/base_resource.rb', line 237

def pact
  @pact ||= pact_service.find_pact(pact_params)
end

#pact_paramsObject



137
138
139
# File 'lib/pact_broker/api/resources/base_resource.rb', line 137

def pact_params
  @pact_params ||= PactBroker::Pacts::PactParams.from_request request, identifier_from_path
end

#pacticipantObject



233
234
235
# File 'lib/pact_broker/api/resources/base_resource.rb', line 233

def pacticipant
  @pacticipant ||= identifier_from_path[:pacticipant_name] && find_pacticipant(identifier_from_path[:pacticipant_name], "pacticipant")
end

#pacticipant_nameObject



183
184
185
# File 'lib/pact_broker/api/resources/base_resource.rb', line 183

def pacticipant_name
  identifier_from_path[:pacticipant_name]
end

#pacticipant_specified?Boolean

Returns:

  • (Boolean)


187
188
189
# File 'lib/pact_broker/api/resources/base_resource.rb', line 187

def pacticipant_specified?
  identifier_from_path.key?(:pacticipant_name)
end

#pacticipant_version_numberObject



167
168
169
# File 'lib/pact_broker/api/resources/base_resource.rb', line 167

def pacticipant_version_number
  identifier_from_path[:pacticipant_version_number]
end

#params(options = {}) ⇒ Object

rubocop: disable Metrics/CyclomaticComplexity



119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/pact_broker/api/resources/base_resource.rb', line 119

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)) #Not load! Otherwise it will try to load Ruby classes.
  else
    @params_with_string_keys ||= JSON.parse(request_body, { symbolize_names: false }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
  end
rescue JSON::JSONError => e
  raise InvalidJsonError.new("Error parsing JSON - #{e.message}")
end

#params_with_string_keysObject

rubocop: enable Metrics/CyclomaticComplexity



133
134
135
# File 'lib/pact_broker/api/resources/base_resource.rb', line 133

def params_with_string_keys
  params(symbolize_names: false)
end

#providerObject



229
230
231
# File 'lib/pact_broker/api/resources/base_resource.rb', line 229

def provider
  @provider ||= identifier_from_path[:provider_name] && find_pacticipant(identifier_from_path[:provider_name], "provider")
end

#provider_nameObject



179
180
181
# File 'lib/pact_broker/api/resources/base_resource.rb', line 179

def provider_name
  identifier_from_path[:provider_name]
end

#provider_specified?Boolean

Returns:

  • (Boolean)


175
176
177
# File 'lib/pact_broker/api/resources/base_resource.rb', line 175

def provider_specified?
  identifier_from_path.key?(:provider_name)
end

#request_bodyObject



151
152
153
# File 'lib/pact_broker/api/resources/base_resource.rb', line 151

def request_body
  @request_body ||= request.body.to_s
end

#resource_urlObject



97
98
99
# File 'lib/pact_broker/api/resources/base_resource.rb', line 97

def resource_url
  request.uri.to_s.gsub(/\?.*/, "").chomp("/")
end

#schemaObject



266
267
268
# File 'lib/pact_broker/api/resources/base_resource.rb', line 266

def schema
  nil
end

#set_json_error_message(message) ⇒ Object



141
142
143
144
# File 'lib/pact_broker/api/resources/base_resource.rb', line 141

def set_json_error_message message
  response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
  response.body = { error: message }.to_json
end

#set_json_validation_error_messages(errors) ⇒ Object



146
147
148
149
# File 'lib/pact_broker/api/resources/base_resource.rb', line 146

def set_json_validation_error_messages errors
  response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
  response.body = { errors: errors }.to_json
end

#ui_base_urlObject

See comments for base_url in lib/pact_broker/doc/controllers/app.rb



84
85
86
# File 'lib/pact_broker/api/resources/base_resource.rb', line 84

def ui_base_url
  request.env["pactbroker.base_url"] || ""
end

#validation_errors?(model) ⇒ Boolean

Returns:

  • (Boolean)


203
204
205
206
207
208
209
210
# File 'lib/pact_broker/api/resources/base_resource.rb', line 203

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

Returns:

  • (Boolean)


270
271
272
273
274
275
276
277
# File 'lib/pact_broker/api/resources/base_resource.rb', line 270

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