Class: PactBroker::Api::Resources::Pact

Inherits:
BaseResource
  • Object
show all
Includes:
PacticipantResourceMethods, WebhookExecutionMethods
Defined in:
lib/pact_broker/api/resources/pact.rb

Direct Known Subclasses

PactVersion

Instance Attribute Summary

Attributes inherited from BaseResource

#user

Instance Method Summary collapse

Methods included from WebhookExecutionMethods

#webhook_execution_configuration

Methods included from PacticipantResourceMethods

#potential_duplicate_pacticipants?

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, #pacticipant_name, #params, #params_with_string_keys, #provider, #provider_name, #request_body, #resource_url, #set_json_error_message, #set_json_validation_error_messages, #validation_errors?

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 



40
41
42
 
# File 'lib/pact_broker/api/resources/pact.rb', line 40

def allowed_methods
  ["GET", "PUT", "DELETE", "PATCH", "OPTIONS"]
end

#content_types_accepted ⇒ Object 



36
37
38
 
# File 'lib/pact_broker/api/resources/pact.rb', line 36

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

#content_types_provided ⇒ Object 



27
28
29
30
31
32
33
34
 
# File 'lib/pact_broker/api/resources/pact.rb', line 27

def content_types_provided
  [
    ["application/hal+json", :to_json],
    ["application/json", :to_json],
    ["text/html", :to_html],
    ["application/vnd.pactbrokerextended.v1+json", :to_extended_json]
  ]
end

#delete_resource ⇒ Object 



97
98
99
100
101
 
# File 'lib/pact_broker/api/resources/pact.rb', line 97

def delete_resource
  pact_service.delete(pact_params)
  set_post_deletion_response
  true
end

#from_json ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pact_broker/api/resources/pact.rb', line 68

def from_json
  response_code = pact ? 200 : 201

  if request.patch? && resource_exists?
    @pact = pact_service.merge_pact(pact_params, webhook_options)
  else
    @pact = pact_service.create_or_update_pact(pact_params, webhook_options)
  end

  response.body = to_json
  response_code
end

#is_conflict? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
51
52
53
 
# File 'lib/pact_broker/api/resources/pact.rb', line 48

def is_conflict?
  merge_conflict = request.patch? && resource_exists? &&
    Pacts::Merger.conflict?(pact.json_content, pact_params.json_content)

  potential_duplicate_pacticipants?(pact_params.pacticipant_names) || merge_conflict
end

#known_methods ⇒ Object 



44
45
46
 
# File 'lib/pact_broker/api/resources/pact.rb', line 44

def known_methods
  super + ['PATCH']
end

#malformed_request? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
58
59
60
61
62
 
# File 'lib/pact_broker/api/resources/pact.rb', line 55

def malformed_request?
  if request.patch? || request.put?
    invalid_json? ||
      contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params), pact_params)
  else
    false
  end
end

#resource_exists? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/pact_broker/api/resources/pact.rb', line 64

def resource_exists?
  !!pact
end

#to_extended_json ⇒ Object 



85
86
87
 
# File 'lib/pact_broker/api/resources/pact.rb', line 85

def to_extended_json
  PactBroker::Api::Decorators::ExtendedPactDecorator.new(pact).to_json(user_options: decorator_context(metadata: identifier_from_path[:metadata]))
end

#to_html ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/pact_broker/api/resources/pact.rb', line 89

def to_html
  PactBroker.configuration.html_pact_renderer.call(
    pact, {
      base_url: base_url,
      badge_url: badge_url_for_latest_pact(pact, base_url)
  })
end

#to_json ⇒ Object 



81
82
83
 
# File 'lib/pact_broker/api/resources/pact.rb', line 81

def to_json
  PactBroker::Api::Decorators::PactDecorator.new(pact).to_json(user_options: decorator_context(metadata: identifier_from_path[:metadata]))
end