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

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

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?, #decorator_context, #encode, #find_pacticipant, #finish_request, #forbidden?, #handle_exception, #identifier_from_path, #initialize, #invalid_json?, #is_authorized?, #options, #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, #consumer_webhooks_url, #hal_browser_url, #label_url, #labels_url, #latest_pact_url, #latest_pacts_url, #latest_untagged_pact_url, #latest_verifications_for_consumer_version_url, #latest_version_url, #matrix_url_from_params, #new_verification_url, #pact_triggered_webhooks_url, #pact_url, #pact_url_from_params, #pact_version_url, #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 Services

#badge_service, #certificate_service, #group_service, #index_service, #label_service, #matrix_service, #pact_service, #pacticipant_service, #tag_service, #verification_service, #version_service, #webhook_service

Constructor Details

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

Instance Method Details

#allowed_methods ⇒ Object 



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

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

#content_types_provided ⇒ Object 



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

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

#links ⇒ Object 



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
 
# File 'lib/pact_broker/api/resources/index.rb', line 22

def links
  {
    '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: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: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:integrations' => {
      href: base_url + '/integrations',
      title: 'Integrations',
      templated: false
    },
    'beta:pending-provider-pacts' =>
    {
      href: base_url + '/pacts/provider/{provider}/pending',
      title: 'Pending pact versions for the specified provider',
      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
    }]
  }
end

#to_json ⇒ Object 



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

def to_json
  { _links: links }.to_json
end