Class: PactBroker::Api::Resources::Badge

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

Direct Known Subclasses

MatrixBadge

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, #handle_exception, #identifier_from_path, #initialize, #invalid_json?, #options, #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, #decode_webhook_metadata, #encode_webhook_metadata, #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_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_versions_url, #pacticipant_url, #pacticipant_url_from_params, #pacticipants_url, #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 Pacts::Metadata

#build_metadata_for_latest_pact, #build_metadata_for_webhook_triggered_by_pact_publication

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 



10
11
12
 
# File 'lib/pact_broker/api/resources/badge.rb', line 10

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

#content_types_provided ⇒ Object 



14
15
16
 
# File 'lib/pact_broker/api/resources/badge.rb', line 14

def content_types_provided
  [['image/svg+xml', :to_svg]]
end

#forbidden? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/pact_broker/api/resources/badge.rb', line 31

def forbidden?
  false
end

#is_authorized?(authorization_header) ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_authorized?(authorization_header)
  super || PactBroker.configuration.enable_public_badge_access
end

#moved_temporarily? ⇒ Boolean

Returns:

  • (Boolean) 


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

def moved_temporarily?
  response.headers['Cache-Control'] = 'no-cache'
  badge_service.pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status)
end

#previously_existed? ⇒ Boolean

Only called if resource_exists? returns false

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/pact_broker/api/resources/badge.rb', line 23

def previously_existed?
  true
end

#resource_exists? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/pact_broker/api/resources/badge.rb', line 18

def resource_exists?
  !badge_service.can_provide_badge_using_redirect?
end

#to_svg ⇒ Object 



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

def to_svg
  response.headers['Cache-Control'] = 'no-cache'
  comment + badge_service.pact_verification_badge(pact, label, initials, pseudo_branch_verification_status)
end