Class: PactBroker::Api::Resources::Pacticipant

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

Constant Summary

Constants included from Pacts::Metadata

Pacts::Metadata::MAPPINGS

Constants included from Services

Services::SERVICE_FACTORIES

Instance Attribute Summary

Attributes inherited from BaseResource

#user

Instance Method Summary collapse

Methods inherited from BaseResource

#any_request_body?, #api_contract_class, #application_context, #base_url, #charsets_provided, #consumer, #consumer_name, #consumer_specified?, #consumer_version_number, #content_type_is_json_but_invalid_json_provided?, #content_type_json?, #database_connector, #decorator_class, #decorator_context, #decorator_options, #encode, #find_pacticipant, #finish_request, #forbidden?, #identifier_from_path, #initialize, #integration, #invalid_json?, #is_authorized?, #malformed_request_for_json_with_schema?, #options, #pact, #pact_params, #pacticipant, #pacticipant_name, #pacticipant_specified?, #pacticipant_version_number, #params, #params_with_string_keys, #provider, #provider_name, #provider_specified?, #request_body, #request_body_required?, #resource_url, #ui_base_url, #validation_errors_for_schema?

Methods included from Logging

included, #log_error, #log_with_tag, #measure_info

Methods included from Messages

#message, #pluralize, #validation_message, #validation_message_at_index

Methods included from Contracts::UTF8Validation

#fragment_before_invalid_utf_8_char

Methods included from ErrorHandlingMethods

#decorator_options_for_error, #error_response_body, #error_response_content_type, #handle_exception, #log_and_report_error, #problem_json_error_content_type?, #set_json_error_message, #set_json_validation_error_messages, #validation_errors_decorator_class, #validation_errors_response_body

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

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

Instance Method Details

#allowed_methods ⇒ Object 



20
21
22
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 20

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

#content_types_accepted ⇒ Object 



13
14
15
16
17
18
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 13

def content_types_accepted
  [
    ["application/json", :from_json],
    ["application/merge-patch+json", :from_merge_patch_json]
  ]
end

#content_types_provided ⇒ Object 



9
10
11
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 9

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

#create_new_pacticipant ⇒ Object 



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

def create_new_pacticipant
  pacticipant_service.create parsed_pacticipant(OpenStruct.new).to_h.merge(:name => pacticipant_name)
end

#delete_resource ⇒ Object 



68
69
70
71
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 68

def delete_resource
  pacticipant_service.delete(pacticipant_name)
  true
end

#from_json ⇒ Object

PUT or PATCH with content-type application/json



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 41

def from_json
  if pacticipant
    @pacticipant = update_existing_pacticipant
  else
    if request.patch? # for backwards compatibility, wish I hadn't done this
      @pacticipant = create_new_pacticipant
      response.headers["Location"] = pacticipant_url(base_url, pacticipant)
    else
      return 404
    end
  end
  response.body = to_json
end

#from_merge_patch_json ⇒ Object

PUT or PATCH with content-type application/merge-patch+json



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

def from_merge_patch_json
  if request.patch?
    from_json
  else
    415
  end
end

#known_methods ⇒ Object 



32
33
34
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 32

def known_methods
  super + ["PATCH"]
end

#malformed_request? ⇒ Boolean

Returns:

  • (Boolean) 


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

def malformed_request?
  super || ((request.patch? || request.really_put?) && any_request_body? && validation_errors_for_schema?)
end

#parsed_pacticipant(pacticipant) ⇒ Object 



77
78
79
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 77

def parsed_pacticipant(pacticipant)
  decorator_class(:pacticipant_decorator).new(pacticipant).from_json(request_body)
end

#patch_can_create? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 28

def patch_can_create?
  true
end

#policy_name ⇒ Object 



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

def policy_name
  :'pacticipants::pacticipant'
end

#put_can_create? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 24

def put_can_create?
  false
end

#resource_exists? ⇒ Boolean

Returns:

  • (Boolean) 


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

def resource_exists?
  !!pacticipant
end

#schema ⇒ Object 



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

def schema
  PactBroker::Api::Contracts::PacticipantSchema
end

#to_json ⇒ Object 



73
74
75
 
# File 'lib/pact_broker/api/resources/pacticipant.rb', line 73

def to_json
  decorator_class(:pacticipant_decorator).new(pacticipant).to_json(**decorator_options)
end

#update_existing_pacticipant ⇒ Object 



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

def update_existing_pacticipant
  if request.really_put?
    @pacticipant = pacticipant_service.replace(pacticipant_name, parsed_pacticipant(OpenStruct.new))
  else
    @pacticipant = pacticipant_service.update(pacticipant_name, parsed_pacticipant(pacticipant))
  end
end