publishing_platform_api_adapters 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4cbccea8ae641f826ce2961ac0cc15f43276023f7626fa5ef069bf879989cdf
-  data.tar.gz: 18d958e5143484a040340649c1709e59f43bf1fb6d92a6881c00066637affa64
+  metadata.gz: ba00f3fd59ac75e1c672ed3478d9db8503fbaa56ee682a4358620ff226e3cf6b
+  data.tar.gz: 190d8d347832fb1cab2df63a2b4dd49198e1c8fb147f4b593696755c31ae8490
 SHA512:
-  metadata.gz: 6ecc55e99bf9b3940e3a9f58fa0068fcc121511e8e680e1dafeab3516c9cd8f8ac330b54d47c8e1264478cf689379e1a09abe755f2678b74efc4fc4a9eef5f5e
-  data.tar.gz: 4533f2ff437bd7cda8d2c6d04b4e15dc0a40581e327ad62ffe2352cd1a14bb239db165ac9b4549fce10a4e5767c4e31202f3afaade3c2de9b48681a4d230f995
+  metadata.gz: a9996d745a94433034e222944d6c30cd76d70a3fff86cbe36ab6ec69ebf945f04defbf18a8d9df9e812006f73c5502dc3c01102ade2eb20bcbff576be5577585
+  data.tar.gz: 9ea06ebd27980708823a44525c22221fe18e9eaea4eadcf5a23cd43a46b20d6cd2176b87667bbf182e20e024eb133629225506e9729a6de30ac1c520367af032

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/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

@@ -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.1"
 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.1
 platform: ruby
 authors:
 - Publishing Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-11-29 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: 
@@ -127,14 +128,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
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs