publishing_platform_api_adapters 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d98513bb44934332a9fe5a7e64933d721d2978aae2244b3f482ce8940ee81fe
-  data.tar.gz: 9472ad4033345b101e7e39291b7658f1d3c9d7abb9e436f99ad94411e4c6c651
+  metadata.gz: 14cea6f36c1e38e0abcddbf7d173847e6981e22c98381b45ffeba213a982e45c
+  data.tar.gz: 84363cb367d0b5a275f54f8413ce8ce38b463d213de1bd21b4ba4cb672266597
 SHA512:
-  metadata.gz: c0eccb8a41e6b80059a13c772f9943b4a1989df6e36e4e47abfe71db925c8402758dea35db9ce35709b80de34ec29ef2ae30377a3ef2e5ecf080c4b9c36ed7d5
-  data.tar.gz: 98294ca2cf9e577ccd4a3708268d584dbdb20385eb7b8c182a31bf8ee87da7b4f1c24eddb967ce1766da847d362ba258e1ac110aa41eceadab35a3c4361baea5
+  metadata.gz: 6388d75747f5ec861a932782994d259b8eaa80bb954d1575368f7ca4ea6c46a9d8bebeb2556c912996127eac32a762a1ac073e275cc070a13d51a83b7d90329e
+  data.tar.gz: 6e5a5a42b40950bf04dbc74038759c3837ce4b08e11f66108212513a76a338a13eb2119f573218c9a69e7098daada2b4aa9408cf5d429453bca6956f40a65ae9

data/lib/publishing_platform_api/search.rb

@@ -0,0 +1,15 @@
+require_relative "base"
+require "rack/utils"
+
+module PublishingPlatformApi
+  # @api documented
+  class Search < Base
+    # Perform a search.
+    #
+    # @param args [Hash] A valid search query. See search-api documentation for options.
+    def search(args, additional_headers = {})
+      request_url = "#{endpoint}/search.json?#{Rack::Utils.build_nested_query(args)}"
+      get_json(request_url, additional_headers)
+    end
+  end
+end

data/lib/publishing_platform_api/test_helpers/search.rb

@@ -0,0 +1,15 @@
+module PublishingPlatformApi
+  module TestHelpers
+    module Search
+      SEARCH_ENDPOINT = PublishingPlatformLocation.find("search-api")
+
+      def stub_any_search
+        stub_request(:get, %r{#{SEARCH_ENDPOINT}/search.json})
+      end
+
+      def stub_any_search_to_return_no_results
+        stub_any_search.to_return(body: { results: [] }.to_json)
+      end
+    end
+  end
+end

data/lib/publishing_platform_api/version.rb

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

data/lib/publishing_platform_api.rb

@@ -6,6 +6,7 @@ require "publishing_platform_api/content_store"
 require "publishing_platform_api/publishing_api"
 require "publishing_platform_api/organisations"
 require "publishing_platform_api/router"
+require "publishing_platform_api/search"
 
 # @api documented
 module PublishingPlatformApi
@@ -72,4 +73,14 @@ module PublishingPlatformApi
       { bearer_token: ENV["ROUTER_API_BEARER_TOKEN"] }.merge(options),
     )
   end
+
+  # Creates a PublishingPlatformApi::Search adapter to access via a search.* hostname
+  #
+  # @return [PublishingPlatformApi::Search]
+  def self.search(options = {})
+    PublishingPlatformApi::Search.new(
+      PublishingPlatformLocation.find("search-api"),
+      options,
+    )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Publishing Platform
@@ -199,6 +199,7 @@ files:
 - lib/publishing_platform_api/railtie.rb
 - lib/publishing_platform_api/response.rb
 - lib/publishing_platform_api/router.rb
+- lib/publishing_platform_api/search.rb
 - lib/publishing_platform_api/test_helpers/asset_manager.rb
 - lib/publishing_platform_api/test_helpers/common_responses.rb
 - lib/publishing_platform_api/test_helpers/content_item_helpers.rb
@@ -206,6 +207,7 @@ files:
 - lib/publishing_platform_api/test_helpers/organisations.rb
 - lib/publishing_platform_api/test_helpers/publishing_api.rb
 - lib/publishing_platform_api/test_helpers/router.rb
+- lib/publishing_platform_api/test_helpers/search.rb
 - lib/publishing_platform_api/version.rb
 - lib/publishing_platform_api_adapters.rb
 licenses:
@@ -225,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs
 test_files: []