Class: PublishingPlatformApi::PublishingApi

Inherits:
Base
  • Object
show all
Defined in:
lib/publishing_platform_api/publishing_api.rb,
lib/publishing_platform_api/publishing_api/special_route_publisher.rb

Overview

Adapter for the Publishing API.

Defined Under Namespace

Classes: NoLiveVersion, SpecialRoutePublisher

Instance Attribute Summary

Attributes inherited from Base

#options

Instance Method Summary collapse

Methods inherited from Base

#client, #create_client, #get_list, #initialize, #url_for_slug

Constructor Details

This class inherits a constructor from PublishingPlatformApi::Base

Instance Method Details

#discard_draft(content_id, options = {}) ⇒ Object

Discard a draft

Deletes the draft content item.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • previous_version (Integer) —

    used to ensure the request is discarding the latest lock version of the draft



143
144
145
146
147
148
149
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 143

def discard_draft(content_id, options = {})
  optional_keys = %i[previous_version]

  params = merge_optional_keys({}, options, optional_keys)

  post_json(discard_url(content_id), params)
end

#get_content(content_id, params = {}) ⇒ PublishingPlatformApi::Response

Return a content item

Raises exception if the item doesn’t exist.

Parameters:

  • content_id (UUID)
  • params (Hash) (defaults to: {})

Returns:

Raises:



28
29
30
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 28

def get_content(content_id, params = {})
  get_json(content_url(content_id, params))
end

#get_content_items(params) ⇒ Object

Get a list of content items from the Publishing API.

The only required key in the params hash is ‘document_type`. These will be used to filter down the content items being returned by the API. Other allowed options can be seen from the link below.

Examples:


publishing_api.get_content_items(
  document_type: 'taxon',
  q: 'Driving',
  page: 1,
  per_page: 50,
  publishing_app: 'content-tagger',
  fields: ['title', 'description', 'public_updated_at'],
  order: '-public_updated_at'
)

Parameters:

  • params (Hash) —

    At minimum, this hash has to include the ‘document_type` of the content items we wish to see. All other optional keys are documented above.



251
252
253
254
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 251

def get_content_items(params)
  query = query_string(params)
  get_json("#{endpoint}/content#{query}")
end

#get_expanded_links(content_id, with_drafts: true, generate: false) ⇒ Object

Get expanded links

Return the expanded links of the item.

Examples:


publishing_api.get_expanded_links("8157589b-65e2-4df6-92ba-2c91d80006c0", with_drafts: false).to_h

#=> {
  "generated" => "2017-08-01T10:42:49Z",
  "expanded_links" => {
    "organisations" => [
      {
        "content_id" => "21aa83a2-a47f-4189-a252-b02f8c322012",
        ... (and more attributes)
      }
    ]
  }
}

Parameters:

  • content_id (UUID)
  • with_drafts (Bool) (defaults to: true) —

    Whether links to draft-only editions are returned, defaulting to ‘true`.

  • generate (Bool) (defaults to: false) —

    Whether to require publishing-api to generate the expanded links, which may be slow. Defaults to ‘false`.



197
198
199
200
201
202
203
204
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 197

def get_expanded_links(content_id, with_drafts: true, generate: false)
  params = {}
  params[:with_drafts] = "false" unless with_drafts
  params[:generate] = "true" if generate
  query = query_string(params)
  validate_content_id(content_id)
  get_json("#{endpoint}/expanded-links/#{content_id}#{query}")
end

#get_linkables(document_type: nil) ⇒ Object

FIXME: Add documentation



257
258
259
260
261
262
263
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 257

def get_linkables(document_type: nil)
  if document_type.nil?
    raise ArgumentError, "Please provide a `document_type`"
  end

  get_json("#{endpoint}/linkables?document_type=#{document_type}")
end

#get_links(content_id) ⇒ PublishingPlatformApi::Response

Get the link set for the given content_id.

Given a Content ID, it fetchs the existing link set and their version.

Examples:


publishing_api.get_links("a-content-id")
# => {
  "content_id" => "a-content-id",
  "links" => [
    "organisation" => "organisation-content-id",
    "document_collection" => "document-collection-content-id"
  ],
  "version" => 17
}

Parameters:

  • content_id (String)

Returns:



170
171
172
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 170

def get_links(content_id)
  get_json(links_url(content_id))
end

#lookup_content_id(base_path:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false) ⇒ UUID

Find the content_id for a base_path.

Convenience method if you only need to look up one content_id for a base_path. For multiple base_paths, use #lookup_content_ids.

Examples:


publishing_api.lookup_content_id(base_path: '/foo')
# => "51ac4247-fd92-470a-a207-6b852a97f2db"

Parameters:

  • base_path (String)
  • exclude_document_types (Array) (defaults to: nil) —

    (optional)

  • exclude_unpublishing_types (Array) (defaults to: nil) —

    (optional)

  • with_drafts (Boolean) (defaults to: false) —

    (optional)

Returns:

  • (UUID) —

    the ‘content_id` for the `base_path`



68
69
70
71
72
73
74
75
76
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 68

def lookup_content_id(base_path:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false)
  lookups = lookup_content_ids(
    base_paths: [base_path],
    exclude_document_types:,
    exclude_unpublishing_types:,
    with_drafts:,
  )
  lookups[base_path]
end

#lookup_content_ids(base_paths:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false) ⇒ Hash

Find the content_ids for a list of base_paths.

Examples:


publishing_api.lookup_content_ids(base_paths: ['/foo', '/bar'])
# => { "/foo" => "51ac4247-fd92-470a-a207-6b852a97f2db", "/bar" => "261bd281-f16c-48d5-82d2-9544019ad9ca" }

Parameters:

  • base_paths (Array)
  • exclude_document_types (Array) (defaults to: nil) —

    (optional)

  • exclude_unpublishing_types (Array) (defaults to: nil) —

    (optional)

  • with_drafts (Boolean) (defaults to: false) —

    (optional)

Returns:

  • (Hash) —

    a hash, keyed by ‘base_path` with `content_id` as value



43
44
45
46
47
48
49
50
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 43

def lookup_content_ids(base_paths:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false)
  options = { base_paths: }
  options[:exclude_document_types] = exclude_document_types if exclude_document_types
  options[:exclude_unpublishing_types] = exclude_unpublishing_types if exclude_unpublishing_types
  options[:with_drafts] = with_drafts if with_drafts
  response = post_json("#{endpoint}/lookup-by-base-path", options)
  response.to_hash
end

#patch_links(content_id, params) ⇒ Object

Patch the links of a content item

Examples:


publishing_api.patch_links(
  '86963c13-1f57-4005-b119-e7cf3cb92ecf',
  links: {
    topics: ['d6e1527d-d0c0-40d5-9603-b9f3e6866b8a'],
    mainstream_browse_pages: ['d6e1527d-d0c0-40d5-9603-b9f3e6866b8a'],
  },
  previous_version: 10,
  bulk_publishing: true
)

Parameters:

  • content_id (UUID)
  • params (Hash)

Options Hash (params):

  • links (Hash) —

    A “links hash”

  • 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)



224
225
226
227
228
229
230
231
232
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 224

def patch_links(content_id, params)
  payload = {
    links: params.fetch(:links),
  }

  payload = merge_optional_keys(payload, params, %i[previous_version bulk_publishing])

  patch_json(links_url(content_id), payload)
end

#publish(content_id, options = {}) ⇒ Object

Publish a content item

The publishing-api will “publish” a draft item, so that it will be visible on the public site.

Parameters:

  • content_id (UUID)
  • options (Hash) (defaults to: {}) 


85
86
87
88
89
90
91
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 85

def publish(content_id, options = {})
  optional_keys = %i[previous_version]

  params = merge_optional_keys({}, options, optional_keys)

  post_json(publish_url(content_id), params)
end

#put_content(content_id, payload) ⇒ Object

Put a content item

Parameters:

  • content_id (UUID)
  • payload (Hash) —

    A valid content item



14
15
16
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 14

def put_content(content_id, payload)
  put_json(content_url(content_id), payload)
end

#put_path(base_path, payload) ⇒ Object

Reserves a path for a publishing application

Returns success or failure only.

Parameters:

  • payload (Hash)

Options Hash (payload):

  • publishing_app (Hash) —

    The publishing application, like ‘content-tagger`



271
272
273
274
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 271

def put_path(base_path, payload)
  url = "#{endpoint}/paths#{base_path}"
  put_json(url, payload)
end

#republish(content_id, options = {}) ⇒ Object

Republish a content item

The publishing-api will “republish” a live edition. This can be used to remove an unpublishing or to re-send a published edition downstream

Parameters:

  • content_id (UUID)
  • options (Hash) (defaults to: {}) 


100
101
102
103
104
105
106
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 100

def republish(content_id, options = {})
  optional_keys = %i[previous_version]

  params = merge_optional_keys({}, options, optional_keys)

  post_json(republish_url(content_id), params)
end

#unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, allow_draft: false, previous_version: nil, unpublished_at: nil, redirects: nil) ⇒ Object

Unpublish a content item

The publishing API will “unpublish” a live item, to remove it from the public site, or update an existing unpublishing.

Parameters:

  • content_id (UUID)
  • type (String) —

    Either ‘withdrawal’, ‘gone’ or ‘redirect’.

  • explanation (String) (defaults to: nil) —

    (optional) Text to show on the page.

  • alternative_path (String) (defaults to: nil) —

    (optional) Alternative path to show on the page or redirect to.

  • discard_drafts (Boolean) (defaults to: false) —

    (optional) Whether to discard drafts on that item. Defaults to false.

  • previous_version (Integer) (defaults to: nil) —

    (optional) A lock version number for optimistic locking.

  • unpublished_at (Time) (defaults to: nil) —

    (optional) The time the content was withdrawn. Ignored for types other than withdrawn

  • redirects (Array) (defaults to: nil) —

    (optional) Required if no alternative_path is given. An array of redirect values, ie: { path:, type:, destination: }



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 121

def unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, allow_draft: false, previous_version: nil, unpublished_at: nil, redirects: nil)
  params = {
    type:,
  }

  params[:explanation] = explanation if explanation
  params[:alternative_path] = alternative_path if alternative_path
  params[:previous_version] = previous_version if previous_version
  params[:discard_drafts] = discard_drafts if discard_drafts
  params[:allow_draft] = allow_draft if allow_draft
  params[:unpublished_at] = unpublished_at.utc.iso8601 if unpublished_at
  params[:redirects] = redirects if redirects

  post_json(unpublish_url(content_id), params)
end

#unreserve_path(base_path, publishing_app) ⇒ Object 



276
277
278
279
 
# File 'lib/publishing_platform_api/publishing_api.rb', line 276

def unreserve_path(base_path, publishing_app)
  payload = { publishing_app: }
  delete_json(unreserve_url(base_path), payload)
end