Class: PactBroker::Api::Resources::Index

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/pact_broker/api/resources/index.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?, #known_methods, #malformed_request?, #malformed_request_for_json_with_schema?, #options, #pact, #pact_params, #pacticipant, #pacticipant_name, #pacticipant_specified?, #pacticipant_version_number, #params, #params_with_string_keys, #patch_can_create?, #provider, #provider_name, #provider_specified?, #put_can_create?, #request_body, #request_body_required?, #resource_url, #schema, #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 



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

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

#content_types_provided ⇒ Object 



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

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

#links ⇒ Object

rubocop: disable Metrics/MethodLength



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/pact_broker/api/resources/index.rb', line 22

def links
  links_hash = {
    "self" =>
    {
      href: base_url,
      title: "Index",
      templated: false
    },
    "pb:publish-pact" => {
      href: base_url + "/pacts/provider/{provider}/consumer/{consumer}/version/{consumerApplicationVersion}",
      title: "Publish a pact",
      templated: true
    },
    "pb:publish-contracts" => {
      href: base_url + "/contracts/publish",
      title: "Publish contracts",
      templated: false
    },
    "pb:latest-pact-versions" =>
    {
      href: base_url + "/pacts/latest",
      title: "Latest pact versions",
      templated: false
    },
    "pb:tagged-pact-versions" =>
    {
      href: base_url + "/pacts/provider/{provider}/consumer/{consumer}/tag/{tag}",
      title: "All versions of a pact for a given consumer, provider and consumer version tag",
      templated: false
    },
    "pb:pacticipants" =>
    {
      href: base_url + "/pacticipants",
      title: "Pacticipants",
      templated: false
    },
    "pb:pacticipant" =>
    {
      href: base_url + "/pacticipants/{pacticipant}",
      title: "Fetch pacticipant by name",
      templated: true
    },
    "pb:latest-provider-pacts" =>
    {
      href: base_url + "/pacts/provider/{provider}/latest",
      title: "Latest pacts by provider",
      templated: true
    },
    "pb:latest-provider-pacts-with-tag" =>
    {
      href: base_url + "/pacts/provider/{provider}/latest/{tag}",
      title: "Latest pacts for provider with the specified tag",
      templated: true
    },
    "pb:provider-pacts-with-tag" =>
    {
      href: base_url + "/pacts/provider/{provider}/tag/{tag}",
      title: "All pact versions for the provider with the specified consumer version tag",
      templated: true
    },
    "pb:provider-pacts" =>
    {
      href: base_url + "/pacts/provider/{provider}",
      title: "All pact versions for the specified provider",
      templated: true
    },
    "pb:latest-version" => {
      href: base_url + "/pacticipants/{pacticipant}/latest-version",
      title: "Latest pacticipant version",
      templated: true
    },
    "pb:latest-tagged-version" => {
      href: base_url + "/pacticipants/{pacticipant}/latest-version/{tag}",
      title: "Latest pacticipant version with the specified tag",
      templated: true
    },
    "pb:webhooks" => {
      href: base_url + "/webhooks",
      title: "Webhooks",
      templated: false
    },
    "pb:webhook" => {
      href: base_url + "/webhooks/{uuid}",
      title: "Webhook",
      templated: true
    },
    "pb:integrations" => {
      href: base_url + "/integrations",
      title: "Integrations",
      templated: false
    },
    "pb:pacticipant-version-tag" =>
    {
      href: base_url + "/pacticipants/{pacticipant}/versions/{version}/tags/{tag}",
      title: "Get, create or delete a tag for a pacticipant version",
      templated: true
    },
    "pb:pacticipant-branch" =>
    {
      href: base_url + "/pacticipants/{pacticipant}/branches/{branch}",
      title: "Get or delete a pacticipant branch",
      templated: true
    },
    "pb:pacticipant-branch-version" =>
    {
      href: base_url + "/pacticipants/{pacticipant}/branches/{branch}/versions/{version}",
      title: "Get or add/create a pacticipant version for a branch",
      templated: true
    },
    "pb:pacticipant-version" =>
    {
      href: base_url + "/pacticipants/{pacticipant}/versions/{version}",
      title: "Get, create or delete a pacticipant version",
      templated: true
    },
    "pb:metrics" =>
    {
      href: base_url + "/metrics",
      title: "Get Pact Broker metrics",
    },
    "pb:can-i-deploy-pacticipant-version-to-tag" =>
    {
      href: base_url + "/can-i-deploy?pacticipant={pacticipant}&version={version}&to={tag}",
      title: "Determine if an application version can be safely deployed to an environment identified by the given tag",
      templated: true
    },
    "pb:can-i-deploy-pacticipant-version-to-environment" =>
    {
      href: base_url + "/can-i-deploy?pacticipant={pacticipant}&version={version}&environment={environment}",
      title: "Determine if an application version can be safely deployed to an environment",
      templated: true
    },
    "pb:provider-pacts-for-verification" => {
      href: base_url + "/pacts/provider/{provider}/for-verification",
      title: "Pact versions to be verified for the specified provider",
      templated: true
    },
    "beta:provider-pacts-for-verification" => {
      name: "beta",
      href: base_url + "/pacts/provider/{provider}/for-verification",
      title: "DEPRECATED - please use pb:provider-pacts-for-verification",
      templated: true
    },
    "curies" =>
    [{
      name: "pb",
      href: base_url + "/doc/{rel}?context=index",
      templated: true
    },{
      name: "beta",
      href: base_url + "/doc/{rel}?context=index",
      templated: true
    }]
  }

  links_hash["pb:environments"] = {
    title: "Environments",
    href: environments_url(base_url),
    templated: false
  }

  links_hash["pb:environment"] = {
    title: "Environment",
    href: environments_url(base_url) + "/{uuid}",
    templated: true
  }

  if PactBroker.feature_enabled?("disable_pacts_for_verification", true)
    links_hash.delete("pb:provider-pacts-for-verification")
    links_hash.delete("beta:provider-pacts-for-verification")
  end

  links_hash
end

#policy_name ⇒ Object

rubocop: enable Metrics/MethodLength



198
199
200
 
# File 'lib/pact_broker/api/resources/index.rb', line 198

def policy_name
  :'index::index'
end

#to_json ⇒ Object 



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

def to_json
  { _links: links }.to_json
end