publishing_platform_api_adapters 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb62fed6a72d2512d1f471e22d685569e135cf51778862f55144b232b2de6c60
-  data.tar.gz: ccd79815a040973a078ae707d4dfcf5d3b1f7b8c27347d3c8c190f2f651a022a
+  metadata.gz: 546721a4d7c247b0de3d3aed7767d8c355b79628b77248fb3624889f751a3f26
+  data.tar.gz: 664183ea7606c204354531ffb4a69b392e6475a01477af2256074c7608aeeeee
 SHA512:
-  metadata.gz: f3266daeaf38ba3f4faef257188f1a4e8cb06dad0ec451aba60aa285eec5b380c1e247569c072de8b5394df39c67b5813288ab24f50cfa7635c381bc105c37b1
-  data.tar.gz: 91291529747a1d3f6b6182f633411e23c7df07214238f4fa44352666da0430c5451ac742c0f31575b3286dc9dc0f48e8745c2c3b846916f4d603f7f328df8e10
+  metadata.gz: 89072fe076a7b666ca0b661e2f1ae3c51402c163d1c7a6d91fd80fecfa6bcd8e2fa23a3fe02342156af2389f1b3c5475e37333133f0dca6ba6e22c74b1ac74bf
+  data.tar.gz: cf14d5aaed20522dea8ebe2d83c1dd87a70fcdb035ea7182181049c9093a8bbbe4bdf7f5dc2a6d18de50322ac9950830deb25806537a2b575cdd271ba22900e4

data/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/lib/publishing_platform_api/json_client.rb

@@ -198,4 +198,4 @@ module PublishingPlatformApi
       raise PublishingPlatformApi::SocketErrorException, e.message
     end
   end
-end
+end

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/publishing_api.rb

@@ -10,7 +10,7 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
   # Put a content item
   #
   # @param content_id [UUID]
-  # @param payload [Hash] A valid content item  
+  # @param payload [Hash] A valid content item
   def put_content(content_id, payload)
     put_json(content_url(content_id), payload)
   end
@@ -123,13 +123,13 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
   #   }
   def get_links(content_id)
     get_json(links_url(content_id))
-  end  
+  end
 
   # Get expanded links
   #
   # Return the expanded links of the item.
   #
-  # @param content_id [UUID]  
+  # @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`.
   #
@@ -155,14 +155,14 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
     query = query_string(params)
     validate_content_id(content_id)
     get_json("#{endpoint}/expanded-links/#{content_id}#{query}")
-  end  
+  end
 
   # Patch the links of a content item
   #
   # @param content_id [UUID]
   # @param params [Hash]
   # @option params [Hash] links A "links hash"
-  # @option params [Integer] previous_version 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)  
+  # @option params [Integer] previous_version 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)
   # @example
   #
   #   publishing_api.patch_links(
@@ -214,7 +214,7 @@ class PublishingPlatformApi::PublishingApi < PublishingPlatformApi::Base
     end
 
     get_json("#{endpoint}/linkables?document_type=#{document_type}")
-  end  
+  end
 
   # Reserves a path for a publishing application
   #
@@ -278,4 +278,4 @@ private
   def validate_content_id(content_id)
     raise ArgumentError, "content_id cannot be nil" unless content_id
   end
-end
+end

data/lib/publishing_platform_api/router.rb

@@ -60,4 +60,4 @@ class PublishingPlatformApi::Router < PublishingPlatformApi::Base
 
     delete_json(url)
   end
-end
+end

data/lib/publishing_platform_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformApi
-  VERSION = "0.6.0"
+  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.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-28 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
@@ -128,15 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs
 test_files: []