class GdsApi::PublishingApiV2
@see github.com/alphagov/publishing-api/blob/master/doc/object-model-explanation.md<br>@see github.com/alphagov/publishing-api/blob/master/doc/publishing-application-examples.md<br>@see github.com/alphagov/publishing-api<br><br>Adapter for the Publishing API.
def content_url(content_id, params = {})
def content_url(content_id, params = {}) validate_content_id(content_id) query = query_string(params) "#{endpoint}/v2/content/#{content_id}#{query}" end
def discard_draft(content_id, options = {})
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-v2contentcontent_iddiscard-draft -
Options Hash:
(**params)
-
previous_version
(Integer
) -- used to ensure the request is discarding the latest lock version of the draft -
locale
(String
) -- The language, defaults to 'en' in publishing-api.
Parameters:
-
params
(Hash
) --
def discard_draft(content_id, options = {}) optional_keys = [ :locale, :previous_version, ] params = merge_optional_keys({}, options, optional_keys) post_json!(discard_url(content_id), params) end
def discard_url(content_id)
def discard_url(content_id) validate_content_id(content_id) "#{endpoint}/v2/content/#{content_id}/discard-draft" end
def get_content(content_id, params = {})
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2contentcontent_id -
Returns:
-
(GdsApi::Response)
- a content item
Options Hash:
(**params)
-
locale
(String
) -- The language, defaults to 'en' in publishing-api.
Parameters:
-
params
(Hash
) -- -
content_id
(UUID
) --
def get_content(content_id, params = {}) get_json(content_url(content_id, params)) end
def get_content!(content_id, params = {})
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2contentcontent_id -
Raises:
-
(HTTPNotFound)
- when the content item is not found
Returns:
-
(GdsApi::Response)
- a content item
Options Hash:
(**params)
-
locale
(String
) -- The language, defaults to 'en' in publishing-api.
Parameters:
-
params
(Hash
) -- -
content_id
(UUID
) --
def get_content!(content_id, params = {}) get_json!(content_url(content_id, params)) end
def get_content_items(params)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2content -
def get_content_items(params) query = query_string(params) get_json("#{endpoint}/v2/content#{query}") end
def get_expanded_links(content_id)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2expanded-linkscontent_id -
Parameters:
-
content_id
(UUID
) --
def get_expanded_links(content_id) validate_content_id(content_id) url = "#{endpoint}/v2/expanded-links/#{content_id}" get_json(url) end
def get_linkables(document_type: nil, format: nil)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkables -
def get_linkables(document_type: nil, format: nil) if document_type.nil? if format.nil? raise ArgumentError.new("Please provide a `document_type`") else self.class.logger.warn( "Providing `format` to the `get_linkables` method is deprecated and will be removed in a " + "future release. Please use `document_type` instead." ) document_type = format end end get_json("#{endpoint}/v2/linkables?document_type=#{document_type}") end
def get_linked_items(content_id, params = {})
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkedcontent_id -
def get_linked_items(content_id, params = {}) query = query_string(params) validate_content_id(content_id) get_json("#{endpoint}/v2/linked/#{content_id}#{query}") end
def get_links(content_id)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkscontent_id -
def get_links(content_id) get_json(links_url(content_id)) end
def links_url(content_id)
def links_url(content_id) validate_content_id(content_id) "#{endpoint}/v2/links/#{content_id}" end
def lookup_content_id(base_path:)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-lookup-by-base-path -
Returns:
-
(UUID)
- the `content_id` for the `base_path`
Parameters:
-
base_path
(String
) --
def lookup_content_id(base_path:) lookups = lookup_content_ids(base_paths: [base_path]) lookups[base_path] end
def lookup_content_ids(base_paths:)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-lookup-by-base-path -
Returns:
-
(Hash)
- a hash, keyed by `base_path` with `content_id` as value
Parameters:
-
base_paths
(Array
) --
def lookup_content_ids(base_paths:) response = post_json!("#{endpoint}/lookup-by-base-path", base_paths: base_paths) response.to_hash end
def merge_optional_keys(params, options, optional_keys)
def merge_optional_keys(params, options, optional_keys) optional_keys.each_with_object(params) do |optional_key, hash| hash.merge!(optional_key => options[optional_key]) if options[optional_key] end end
def patch_links(content_id, params)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#patch-v2linkscontent_id -
Options Hash:
(**params)
-
bulk_publishing
(Boolean
) -- Set to true to indicate that this is part of a mass-republish. Allows the publishing-api to prioritise human-initiated publishing (optional, default false) -
previous_version
(Integer
) -- The previous version (returned by `get_links`). If this version is not the current version, the publishing-api will reject the change and return 409 Conflict. (optional) -
links
(Hash
) -- A "links hash"
Parameters:
-
params
(Hash
) -- -
content_id
(UUID
) --
def patch_links(content_id, params) payload = { links: params.fetch(:links) } payload = merge_optional_keys(payload, params, [:previous_version, :bulk_publishing]) patch_json!(links_url(content_id), payload) end
def publish(content_id, update_type, options = {})
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-v2contentcontent_idpublish -
Options Hash:
(**params)
-
locale
(String
) -- The language, defaults to 'en' in publishing-api.
Parameters:
-
params
(Hash
) -- -
update_type
(String
) -- Either 'major', 'minor' or 'republish' -
content_id
(UUID
) --
def publish(content_id, update_type, options = {}) params = { update_type: update_type } optional_keys = [ :locale, :previous_version, ] params = merge_optional_keys(params, options, optional_keys) post_json!(publish_url(content_id), params) end
def publish_url(content_id)
def publish_url(content_id) validate_content_id(content_id) "#{endpoint}/v2/content/#{content_id}/publish" end
def put_content(content_id, payload)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#put-v2contentcontent_id -
Parameters:
-
payload
(Hash
) -- A valid content item -
content_id
(UUID
) --
def put_content(content_id, payload) put_json!(content_url(content_id), payload) end
def unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, allow_draft: false, previous_version: nil, locale: nil)
- See: https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-v2contentcontent_idunpublish -
Parameters:
-
locale
(String
) -- (optional) The content item locale. -
previous_version
(Integer
) -- (optional) A lock version number for optimistic locking. -
discard_drafts
(Boolean
) -- (optional) Whether to discard drafts on that item. Defaults to false. -
alternative_path
(String
) -- (optional) Alternative path to show on the page or redirect to. -
explanation
(String
) -- (optional) Text to show on the page. -
type
(String
) -- Either 'withdrawal', 'gone' or 'redirect'. -
content_id
(UUID
) --
def unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, allow_draft: false, previous_version: nil, locale: nil) params = { type: type } params.merge!(explanation: explanation) if explanation params.merge!(alternative_path: alternative_path) if alternative_path params.merge!(previous_version: previous_version) if previous_version params.merge!(discard_drafts: discard_drafts) if discard_drafts params.merge!(allow_draft: allow_draft) if allow_draft params.merge!(locale: locale) if locale post_json!(unpublish_url(content_id), params) end
def unpublish_url(content_id)
def unpublish_url(content_id) validate_content_id(content_id) "#{endpoint}/v2/content/#{content_id}/unpublish" end
def validate_content_id(content_id)
def validate_content_id(content_id) raise ArgumentError, "content_id cannot be nil" unless content_id end