publishing_platform_api_adapters 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba00f3fd59ac75e1c672ed3478d9db8503fbaa56ee682a4358620ff226e3cf6b
-  data.tar.gz: 190d8d347832fb1cab2df63a2b4dd49198e1c8fb147f4b593696755c31ae8490
+  metadata.gz: 546721a4d7c247b0de3d3aed7767d8c355b79628b77248fb3624889f751a3f26
+  data.tar.gz: 664183ea7606c204354531ffb4a69b392e6475a01477af2256074c7608aeeeee
 SHA512:
-  metadata.gz: a9996d745a94433034e222944d6c30cd76d70a3fff86cbe36ab6ec69ebf945f04defbf18a8d9df9e812006f73c5502dc3c01102ade2eb20bcbff576be5577585
-  data.tar.gz: 9ea06ebd27980708823a44525c22221fe18e9eaea4eadcf5a23cd43a46b20d6cd2176b87667bbf182e20e024eb133629225506e9729a6de30ac1c520367af032
+  metadata.gz: 89072fe076a7b666ca0b661e2f1ae3c51402c163d1c7a6d91fd80fecfa6bcd8e2fa23a3fe02342156af2389f1b3c5475e37333133f0dca6ba6e22c74b1ac74bf
+  data.tar.gz: cf14d5aaed20522dea8ebe2d83c1dd87a70fcdb035ea7182181049c9093a8bbbe4bdf7f5dc2a6d18de50322ac9950830deb25806537a2b575cdd271ba22900e4

data/lib/publishing_platform_api/organisations.rb

@@ -0,0 +1,17 @@
+require_relative "base"
+
+class PublishingPlatformApi::Organisations < PublishingPlatformApi::Base
+  def organisations
+    get_list "#{base_url}/organisations"
+  end
+
+  def organisation(organisation_slug)
+    get_json "#{base_url}/organisations/#{organisation_slug}"
+  end
+
+private
+
+  def base_url
+    "#{endpoint}/api"
+  end
+end

data/lib/publishing_platform_api/publishing_api/special_route_publisher.rb

@@ -0,0 +1,51 @@
+require "publishing_platform_api/publishing_api"
+require "time"
+
+module PublishingPlatformApi
+  class PublishingApi < PublishingPlatformApi::Base
+    class SpecialRoutePublisher
+      def initialize(options = {})
+        @logger = options[:logger] || PublishingPlatformApi::Base.logger
+        @publishing_api = options[:publishing_api] || PublishingPlatformApi::PublishingApi.new(PublishingPlatformLocation.find("publishing-api"))
+      end
+
+      def publish(options)
+        logger.info("Publishing #{options.fetch(:type)} route #{options.fetch(:base_path)}, routing to #{options.fetch(:rendering_app)}")
+
+        update_type = options.fetch(:update_type, "major")
+
+        put_content_response = publishing_api.put_content(
+          options.fetch(:content_id),
+          base_path: options.fetch(:base_path),
+          document_type: options.fetch(:document_type, "special_route"),
+          schema_name: options.fetch(:schema_name, "special_route"),
+          title: options.fetch(:title),
+          description: options.fetch(:description, ""),
+          details: {},
+          routes: [
+            {
+              path: options.fetch(:base_path),
+              type: options.fetch(:type),
+            },
+          ],
+          publishing_app: options.fetch(:publishing_app),
+          rendering_app: options.fetch(:rendering_app),
+          public_updated_at: time.now.iso8601,
+          update_type:,
+        )
+
+        publishing_api.patch_links(options.fetch(:content_id), links: options[:links]) if options[:links]
+        publishing_api.publish(options.fetch(:content_id))
+        put_content_response
+      end
+
+    private
+
+      attr_reader :logger, :publishing_api
+
+      def time
+        (Time.respond_to?(:zone) && Time.zone) || Time
+      end
+    end
+  end
+end

data/lib/publishing_platform_api/version.rb

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

data/lib/publishing_platform_api.rb

@@ -20,6 +20,18 @@ module PublishingPlatformApi
     )
   end
 
+  # Creates a PublishingPlatformApi::Organisations adapter for accessing
+  # APIs through the origin, where the requests will be handled by
+  # Collections frontend.
+  #
+  # @return [PublishingPlatformApi::Organisations]
+  def self.organisations(options = {})
+    PublishingPlatformApi::Organisations.new(
+      PublishingPlatformLocation.new.website_root,
+      options,
+    )
+  end
+
   # Creates a PublishingPlatformApi::PublishingApi adapter
   #
   # This will set a bearer token if a PUBLISHING_API_BEARER_TOKEN environment

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -95,7 +94,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Adapters to work with Publishing Platform APIs
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,18 +107,18 @@ files:
 - lib/publishing_platform_api/json_client.rb
 - lib/publishing_platform_api/list_response.rb
 - lib/publishing_platform_api/middleware/publishing_platform_header_sniffer.rb
+- lib/publishing_platform_api/organisations.rb
 - lib/publishing_platform_api/publishing_api.rb
+- lib/publishing_platform_api/publishing_api/special_route_publisher.rb
 - lib/publishing_platform_api/publishing_platform_headers.rb
 - lib/publishing_platform_api/railtie.rb
 - lib/publishing_platform_api/response.rb
 - lib/publishing_platform_api/router.rb
 - lib/publishing_platform_api/version.rb
 - lib/publishing_platform_api_adapters.rb
-homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs
 test_files: []