publishing_platform_api_adapters 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c27ed233993ab4172ab605d12f5b0f3d9a8186c2f5195c51e787fbee896e1ae7
-  data.tar.gz: 1e1bcf222b956010f9df064385d5c4f66184fea3452cc0cb4b86d8341c7484b8
+  metadata.gz: 6d5184264eb9e2b1bb5c025980563ad23348940805a21fae7f1f43018f1e1b19
+  data.tar.gz: b2c57528a81f4e8dc7b5e615ac1c596f6a2035d04f1a47926ac28bd234035e6b
 SHA512:
-  metadata.gz: 306199b8e21a09fc9f86edbdc4050e304d92e3ca4598284ba8f0e05a80f214f16eed64b011145f25cee4c242c59eaf81975ebb0899724b93f298ecf6a48b3ff0
-  data.tar.gz: d13b2599f10934a2e104f6084598bc8481ff7988550ebd8b8e949141782025353d81b2463ff35f1413d87e2529e3f1a6fdc1ebca2203cccbc0c51e5824937fc9
+  metadata.gz: f9de58b5a14da0ee00752bf7cb940f97d9ef9bcb1301a12e380bae23ad50e6ccef56e66387cd89e197d047c92de576676623d9a970ed9475638e66c8d6a10252
+  data.tar.gz: 268df30f6a6806f315d92fe1fc00a8a46c4c52b75b505988756b460b5bf2a00912656113c855ef987cea611f9187e0ca2be7154c44e75ee17db63f6bbc301e63

data/lib/publishing_platform_api/publishing_api.rb

@@ -35,16 +35,11 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
   # on the public site.
   #
   # @param content_id [UUID]
-  # @param update_type [String] Either 'major', 'minor' or 'republish'
   # @param options [Hash]
-  def publish(content_id, update_type = nil, options = {})
-    params = {
-      update_type:,
-    }
-
+  def publish(content_id, options = {})
     optional_keys = %i[previous_version]
 
-    params = merge_optional_keys(params, options, optional_keys)
+    params = merge_optional_keys({}, options, optional_keys)
 
     post_json(publish_url(content_id), params)
   end
@@ -107,6 +102,61 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
     post_json(discard_url(content_id), params)
   end
 
+  # Get the link set for the given content_id.
+  #
+  # Given a Content ID, it fetchs the existing link set and their version.
+  #
+  # @param content_id [String]
+  #
+  # @return [PublishingPlatformApi::Response] A response containing `links` and `version`.
+  #
+  # @example
+  #
+  #   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
+  #   }
+  def get_links(content_id)
+    get_json(links_url(content_id))
+  end  
+
+  # Get expanded links
+  #
+  # Return the expanded links of the item.
+  #
+  # @param content_id [UUID]  
+  # @param with_drafts [Bool] Whether links to draft-only editions are returned, defaulting to `true`.
+  # @param generate [Bool] Whether to require publishing-api to generate the expanded links, which may be slow. Defaults to `false`.
+  #
+  # @example
+  #
+  #   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)
+  #         }
+  #       ]
+  #     }
+  #   }
+  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  
+
   # Patch the links of a content item
   #
   # @param content_id [UUID]
@@ -157,6 +207,15 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
     get_json("#{endpoint}/content#{query}")
   end
 
+  # FIXME: Add documentation
+  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  
+
   # Reserves a path for a publishing application
   #
   # Returns success or failure only.

data/lib/publishing_platform_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformApi
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Publishing Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable