publishing_platform_api_adapters 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dadc8a7f07684d3fad45a0efcfaa222a0763dbebd20fe3e0d5b7fc551196f65d
-  data.tar.gz: ecfbc92e940928e42f4d7e09b0a211fb2ebf5edf94dd6c86f5156c533d104a54
+  metadata.gz: eb62fed6a72d2512d1f471e22d685569e135cf51778862f55144b232b2de6c60
+  data.tar.gz: ccd79815a040973a078ae707d4dfcf5d3b1f7b8c27347d3c8c190f2f651a022a
 SHA512:
-  metadata.gz: 0ed8d5992d01a25a5313d0e5f7beeb21ff4b46541abca773617adc6398bd33b4847303cc89f086fed0b355b9c896c78f7098e650f77605903b09cbfa78a349f1
-  data.tar.gz: 907d770b9ed8568d12e861a04a6b184e20ec5eba029450d27ff40f6349ac0bb249bd465a85056853ae7a23ad44fffec144d31166514a9f26b74a18e79f4eb27a
+  metadata.gz: f3266daeaf38ba3f4faef257188f1a4e8cb06dad0ec451aba60aa285eec5b380c1e247569c072de8b5394df39c67b5813288ab24f50cfa7635c381bc105c37b1
+  data.tar.gz: 91291529747a1d3f6b6182f633411e23c7df07214238f4fa44352666da0430c5451ac742c0f31575b3286dc9dc0f48e8745c2c3b846916f4d603f7f328df8e10

data/lib/publishing_platform_api/railtie.rb

@@ -3,27 +3,27 @@ require_relative "middleware/publishing_platform_header_sniffer"
 module PublishingPlatformApi
   class Railtie < Rails::Railtie
     initializer "publishing_platform_api.initialize_publishing_platform_request_id_sniffer" do |app|
-      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for PublishingPlatform-Request-Id header"
+      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for Publishing-Platform-Request-Id header"
       app.middleware.use PublishingPlatformApi::PublishingPlatformHeaderSniffer, "HTTP_PUBLISHING_PLATFORM_REQUEST_ID"
     end
 
     initializer "publishing_platform_api.initialize_publishing_platform_original_url_sniffer" do |app|
-      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for PublishingPlatform-Original-Url header"
+      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for Publishing-Platform-Original-Url header"
       app.middleware.use PublishingPlatformApi::PublishingPlatformHeaderSniffer, "HTTP_PUBLISHING_PLATFORM_ORIGINAL_URL"
     end
 
     initializer "publishing_platform_api.initialize_publishing_platform_authenticated_user_sniffer" do |app|
-      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for X-PublishingPlatform-Authenticated-User header"
+      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for X-Publishing-Platform-Authenticated-User header"
       app.middleware.use PublishingPlatformApi::PublishingPlatformHeaderSniffer, "HTTP_X_PUBLISHING_PLATFORM_AUTHENTICATED_USER"
     end
 
     initializer "publishing_platform_api.initialize_publishing_platform_authenticated_user_organisation_sniffer" do |app|
-      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for X-PublishingPlatform-Authenticated-User-Organisation header"
+      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for X-Publishing-Platform-Authenticated-User-Organisation header"
       app.middleware.use PublishingPlatformApi::PublishingPlatformHeaderSniffer, "HTTP_X_PUBLISHING_PLATFORM_AUTHENTICATED_USER_ORGANISATION"
     end
 
     initializer "publishing_platform_api.initialize_publishing_platform_content_id_sniffer" do |app|
-      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for PublishingPlatform-Auth-Bypass-Id header"
+      Rails.logger.debug "Using middleware PublishingPlatformApi::PublishingPlatformHeaderSniffer to sniff for Publishing-Platform-Auth-Bypass-Id header"
       app.middleware.use PublishingPlatformApi::PublishingPlatformHeaderSniffer, "HTTP_PUBLISHING_PLATFORM_AUTH_BYPASS_ID"
     end
   end

data/lib/publishing_platform_api/router.rb

@@ -0,0 +1,63 @@
+require_relative "base"
+
+class PublishingPlatformApi::Router < PublishingPlatformApi::Base
+  ### Backends
+
+  def get_backend(id)
+    get_json("#{endpoint}/backends/#{CGI.escape(id)}")
+  end
+
+  def add_backend(id, url)
+    put_json("#{endpoint}/backends/#{CGI.escape(id)}", backend: { backend_url: url })
+  end
+
+  def delete_backend(id)
+    delete_json("#{endpoint}/backends/#{CGI.escape(id)}")
+  end
+
+  ### Routes
+
+  def get_route(path)
+    get_json("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}")
+  end
+
+  def add_route(path, type, backend_id)
+    put_json(
+      "#{endpoint}/routes",
+      route: {
+        incoming_path: path,
+        route_type: type,
+        handler: "backend",
+        backend_id:,
+      },
+    )
+  end
+
+  def add_redirect_route(path, type, destination, redirect_type = "permanent", options = {})
+    put_json(
+      "#{endpoint}/routes",
+      route: {
+        incoming_path: path,
+        route_type: type,
+        handler: "redirect",
+        redirect_to: destination,
+        redirect_type:,
+        segments_mode: options[:segments_mode],
+      },
+    )
+  end
+
+  def add_gone_route(path, type)
+    put_json(
+      "#{endpoint}/routes",
+      route: { incoming_path: path, route_type: type, handler: "gone" },
+    )
+  end
+
+  def delete_route(path, hard_delete: false)
+    url = "#{endpoint}/routes?incoming_path=#{CGI.escape(path)}"
+    url += "&hard_delete=true" if hard_delete
+
+    delete_json(url)
+  end
+end

data/lib/publishing_platform_api/version.rb

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

data/lib/publishing_platform_api.rb

@@ -1,11 +1,25 @@
 require "addressable"
 require "publishing_platform_location"
 require "time"
-require "publishing_platform_api/publishing_api"
 require "publishing_platform_api/content_store"
+require "publishing_platform_api/publishing_api"
+require "publishing_platform_api/router"
 
 # @api documented
 module PublishingPlatformApi
+  # 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
+
   # Creates a PublishingPlatformApi::PublishingApi adapter
   #
   # This will set a bearer token if a PUBLISHING_API_BEARER_TOKEN environment
@@ -19,16 +33,16 @@ module PublishingPlatformApi
     )
   end
 
-  # Creates a PublishingPlatformApi::ContentStore adapter
+  # Creates a PublishingPlatformApi::Router adapter for communicating with Router API
   #
-  # This will set a bearer token if a CONTENT_STORE_BEARER_TOKEN environment
+  # This will set a bearer token if a ROUTER_API_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),
+  # @return [PublishingPlatformApi::Router]
+  def self.router(options = {})
+    PublishingPlatformApi::Router.new(
+      PublishingPlatformLocation.find("router-api"),
+      { bearer_token: ENV["ROUTER_API_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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Publishing Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -113,6 +113,7 @@ files:
 - 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: