Class: PactBroker::Api::Resources::PactWebhooks

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/pact_broker/api/resources/pact_webhooks.rb

Instance Attribute Summary

Attributes inherited from BaseResource

#user

Instance Method Summary collapse

Methods inherited from BaseResource

#base_url, #charsets_provided, #consumer, #consumer_name, #contract_validation_errors?, #database_connector, #decorator_context, #encode, #find_pacticipant, #finish_request, #forbidden?, #handle_exception, #identifier_from_path, #initialize, #invalid_json?, #is_authorized?, #options, #pact, #pact_params, #pacticipant_name, #params, #params_with_string_keys, #provider, #provider_name, #request_body, #resource_url, #set_json_error_message, #set_json_validation_error_messages, #update_matrix_after_request?

Methods included from Logging

included, #log_error

Methods included from Authentication

#authenticated?

Methods included from PactBrokerUrls

#badge_url_for_latest_pact, #build_webhook_metadata, #consumer_webhooks_url, #dashboard_url_for_integration, #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_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_versions_url, #pacticipant_url, #pacticipant_url_from_params, #pacticipants_url, #parse_webhook_metadata, #previous_distinct_diff_url, #previous_distinct_pact_version_url, #provider_webhooks_url, #tag_url, #tags_url, #templated_diff_url, #templated_label_url_for_pacticipant, #templated_tag_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 Services

#badge_service, #certificate_service, #group_service, #index_service, #integration_service, #label_service, #matrix_service, #metrics_service, #pact_service, #pacticipant_service, #tag_service, #verification_service, #version_service, #webhook_service, #webhook_trigger_service

Constructor Details

This class inherits a constructor from PactBroker::Api::Resources::BaseResource

Instance Method Details

#allowed_methods ⇒ Object 



13
14
15
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 13

def allowed_methods
  ["POST", "GET", "OPTIONS"]
end

#content_types_accepted ⇒ Object 



21
22
23
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 21

def content_types_accepted
  [["application/json", :from_json]]
end

#content_types_provided ⇒ Object 



17
18
19
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 17

def content_types_provided
  [["application/hal+json", :to_json]]
end

#create_path ⇒ Object 



48
49
50
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 48

def create_path
  webhook_url next_uuid, base_url
end

#from_json ⇒ Object 



56
57
58
59
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 56

def from_json
  saved_webhook = webhook_service.create next_uuid, webhook, consumer, provider
  response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(user_options: { base_url: base_url })
end

#malformed_request? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
34
35
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 30

def malformed_request?
  if request.post?
    return invalid_json? || validation_errors?(webhook)
  end
  false
end

#post_is_create? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 52

def post_is_create?
  true
end

#resource_exists? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
28
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 25

def resource_exists?
  (identifier_from_path[:consumer_name].nil? || consumer) &&
    (identifier_from_path[:provider_name].nil? || provider)
end

#to_json ⇒ Object 



61
62
63
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 61

def to_json
  Decorators::WebhooksDecorator.new(webhooks).to_json(user_options: decorator_context(resource_title: 'Pact webhooks'))
end

#validation_errors?(webhook) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
42
43
44
45
46
 
# File 'lib/pact_broker/api/resources/pact_webhooks.rb', line 37

def validation_errors? webhook
  errors = webhook_service.errors(webhook)

  unless errors.empty?
    response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
    response.body = { errors: errors.messages }.to_json
  end

  !errors.empty?
end