publishing_platform_api_adapters 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dc1965a7fe4e5b519636780d4a6cbd07b0475259d44b49f89128aa80ec3fd13
-  data.tar.gz: ef68c7200b15791b97df9da45a7a7264d7b5071d112fda4370308b8ce35285f5
+  metadata.gz: dadc8a7f07684d3fad45a0efcfaa222a0763dbebd20fe3e0d5b7fc551196f65d
+  data.tar.gz: ecfbc92e940928e42f4d7e09b0a211fb2ebf5edf94dd6c86f5156c533d104a54
 SHA512:
-  metadata.gz: 5b16bac63f4f8b91c3574789095996c39eeac770fe15e7cddc057466067d94e3bd5c07ee4b7116a63da6322a2ecb00f1149771bd6c62728deda7acbb7054566e
-  data.tar.gz: 1f381f2e20bc0ca385d9f7fc291d8ed00924a124a35ebe272169149be4a41a95245dd4258cb501bc198637ed0c42caf841fa1535abfb671840a6cecfa50ff512
+  metadata.gz: 0ed8d5992d01a25a5313d0e5f7beeb21ff4b46541abca773617adc6398bd33b4847303cc89f086fed0b355b9c896c78f7098e650f77605903b09cbfa78a349f1
+  data.tar.gz: 907d770b9ed8568d12e861a04a6b184e20ec5eba029450d27ff40f6349ac0bb249bd465a85056853ae7a23ad44fffec144d31166514a9f26b74a18e79f4eb27a

data/lib/publishing_platform_api/content_store.rb

@@ -0,0 +1,24 @@
+require "publishing_platform_location"
+
+require_relative "base"
+require_relative "exceptions"
+
+class PublishingPlatformApi::ContentStore < PublishingPlatformApi::Base
+  class ItemNotFound < PublishingPlatformApi::HTTPNotFound
+    def self.build_from(http_error)
+      new(http_error.code, http_error.message, http_error.error_details)
+    end
+  end
+
+  def content_item(base_path)
+    get_json(content_item_url(base_path))
+  rescue PublishingPlatformApi::HTTPNotFound => e
+    raise ItemNotFound.build_from(e)
+  end
+
+private
+
+  def content_item_url(base_path)
+    "#{endpoint}/content#{base_path}"
+  end
+end

data/lib/publishing_platform_api/publishing_api.rb

@@ -102,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]
@@ -152,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.3.0"
+  VERSION = "0.5.0"
 end

data/lib/publishing_platform_api.rb

@@ -2,6 +2,7 @@ require "addressable"
 require "publishing_platform_location"
 require "time"
 require "publishing_platform_api/publishing_api"
+require "publishing_platform_api/content_store"
 
 # @api documented
 module PublishingPlatformApi
@@ -17,4 +18,17 @@ module PublishingPlatformApi
       { bearer_token: ENV["PUBLISHING_API_BEARER_TOKEN"] }.merge(options),
     )
   end
+
+  # Creates a PublishingPlatformApi::ContentStore adapter
+  #
+  # This will set a bearer token if a CONTENT_STORE_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [PublishingPlatformApi::ContentStore]
+  def self.content_store(options = {})
+    PublishingPlatformApi::ContentStore.new(
+      PublishingPlatformLocation.find("content-store"),
+      { bearer_token: ENV["CONTENT_STORE_BEARER_TOKEN"] }.merge(options),
+    )
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Publishing Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -104,6 +104,7 @@ files:
 - Rakefile
 - lib/publishing_platform_api.rb
 - lib/publishing_platform_api/base.rb
+- lib/publishing_platform_api/content_store.rb
 - lib/publishing_platform_api/exceptions.rb
 - lib/publishing_platform_api/json_client.rb
 - lib/publishing_platform_api/list_response.rb