publishing_platform_api_adapters 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4cbccea8ae641f826ce2961ac0cc15f43276023f7626fa5ef069bf879989cdf
-  data.tar.gz: 18d958e5143484a040340649c1709e59f43bf1fb6d92a6881c00066637affa64
+  metadata.gz: eb62fed6a72d2512d1f471e22d685569e135cf51778862f55144b232b2de6c60
+  data.tar.gz: ccd79815a040973a078ae707d4dfcf5d3b1f7b8c27347d3c8c190f2f651a022a
 SHA512:
-  metadata.gz: 6ecc55e99bf9b3940e3a9f58fa0068fcc121511e8e680e1dafeab3516c9cd8f8ac330b54d47c8e1264478cf689379e1a09abe755f2678b74efc4fc4a9eef5f5e
-  data.tar.gz: 4533f2ff437bd7cda8d2c6d04b4e15dc0a40581e327ad62ffe2352cd1a14bb239db165ac9b4549fce10a4e5767c4e31202f3afaade3c2de9b48681a4d230f995
+  metadata.gz: f3266daeaf38ba3f4faef257188f1a4e8cb06dad0ec451aba60aa285eec5b380c1e247569c072de8b5394df39c67b5813288ab24f50cfa7635c381bc105c37b1
+  data.tar.gz: 91291529747a1d3f6b6182f633411e23c7df07214238f4fa44352666da0430c5451ac742c0f31575b3286dc9dc0f48e8745c2c3b846916f4d603f7f328df8e10

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.1"
+  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.1
+  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: