Class: PactBroker::Api::Resources::Matrix

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

Direct Known Subclasses

CanIDeploy

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, #invalid_json?, #is_authorized?, #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?, #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

#initializeMatrix

Returns a new instance of Matrix.



11
12
13
# File 'lib/pact_broker/api/resources/matrix.rb', line 11

def initialize
  @selectors, @options = PactBroker::Matrix::ParseQuery.call(request.uri.query)
end

Instance Method Details

#allowed_methodsObject



22
23
24
# File 'lib/pact_broker/api/resources/matrix.rb', line 22

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

#content_types_providedObject



15
16
17
18
19
20
# File 'lib/pact_broker/api/resources/matrix.rb', line 15

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

#linesObject



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

def lines
  @lines ||= matrix_service.find(selectors, options)
end

#malformed_request?Boolean

Returns:

  • (Boolean)


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

def malformed_request?
  error_messages = matrix_service.validate_selectors(selectors)
  if error_messages.any?
    set_json_validation_error_messages error_messages
    true
  else
    false
  end
end

#optionsObject



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

def options
  @options
end

#selectorsObject



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

def selectors
  @selectors
end

#to_jsonObject



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

def to_json
  PactBroker::Api::Decorators::MatrixDecorator.new(lines).to_json(user_options: { base_url: base_url })
end

#to_textObject



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

def to_text
  PactBroker::Api::Decorators::MatrixTextDecorator.new(lines).to_text(user_options: { base_url: base_url })
end