publishing_platform_api_adapters 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ecd9f3eb97245e845c73fc3ff0c2328e1ffb836bdccb89bd6b8334642dd4c20
-  data.tar.gz: 525e15f6248bc90427bd82be0b5e8f2373d20ab3fc0d39c3f127e68a5840b452
+  metadata.gz: 54dea58b3d1bcd3fe96e91cb75249bb29a240ba5ab41bba121292b695b8d160b
+  data.tar.gz: f345c52fbb488893dc130248ad994e80df33df0bd80d193cd757f05adaea9493
 SHA512:
-  metadata.gz: ea0ce9e7e2db339d7d7cfd74345c0fb85a831cfbe0ab3178c4e0ea9dfc9b59132f8b61df51732d9d43785acab96c9882f3d715d283d4109fce3036f1a2453a22
-  data.tar.gz: 497e045eb4399485d38db4fe80433f761f61b9c9c6f47179ae0d7f045edc9bbd558957d778c1392550adbb354b35ecf17a081982993e7aee2fddbe66cc8f2c38
+  metadata.gz: b0e418637bbe6e824c3e31e4334d69862e37c1eaddfaa56fc6e1c9caa4c57d7cf0f464878fbce80901664b9d563300156e1a0e268be14ab75d650046d164a4aa
+  data.tar.gz: 3133b2aa1676a494fe27c5593acdb1b0bc10d1b4933638cbbc4b14262cced73f4651149f1f7bd12151e8618ec7e2f7ffc856f953e663f82c5c64300f95d0f9ff

data/lib/publishing_platform_api/asset_manager.rb

@@ -0,0 +1,156 @@
+require_relative "base"
+require_relative "exceptions"
+
+# @api documented
+class PublishingPlatformApi::AssetManager < PublishingPlatformApi::Base
+  # Creates an asset given a hash with one +file+ attribute
+  #
+  # Makes a +POST+ request to the asset manager api to create an asset.
+  #
+  # The asset must be provided as a +Hash+ with a +file+ attribute that
+  # behaves like a +File+ object. The +content-type+ that the asset manager will
+  # subsequently serve will be based on the file's extension (derived from
+  # +#path+). If you supply a +content-type+ via, for example
+  # +ActionDispatch::Http::UploadedFile+ or another multipart wrapper, it will
+  # be ignored. To provide a +content-type+ directly you must be specify it
+  # as a +content_type+ attribute of the hash.
+  #
+  # @param asset [Hash] The attributes for the asset to send to the api. Must
+  #   contain +file+, which behaves like a +File+. All other attributes will be
+  #   ignored.
+  # @return [PublishingPlatformApi::Response] The wrapped http response from the api. Behaves
+  #   both as a +Hash+ and an +OpenStruct+, and responds to the following:
+  #     :id           the URL of the asset
+  #     :name         the filename of the asset that will be served
+  #     :content_type the content_type of the asset
+  #     :file_url     the URL from which the asset will be served when it has
+  #                   passed a virus scan
+  #     :state        One of 'unscanned', 'clean', or 'infected'. Unless the state is
+  #                   'clean' the asset at the :file_url will 404
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  #
+  # @example Upload a file from disk
+  #   response = asset_manager.create_asset(file: File.new('image.jpg', 'r'))
+  #   response['id']           #=> "http://asset-manager.dev.gov.uk/assets/576bbc52759b74196b000012"
+  #   response['content_type'] #=> "image/jpeg"
+  # @example Upload a file from a Rails param, (typically a multipart wrapper)
+  #    params[:file] #=> #<ActionDispatch::Http::UploadedFile:0x007fc60b43c5c8
+  #                      # @content_type="application/foofle",
+  #                      # @original_filename="cma_case_image.jpg",
+  #                      # @tempfile="spec/support/images/cma_case_image.jpg">
+  #
+  #    # Though we sent a file with a +content_type+ of 'application/foofle',
+  #    # this was ignored
+  #    response = asset_manager.create_asset(file: params[:file])
+  #    response['content_type'] #=> "image/jpeg"
+  def create_asset(asset)
+    post_multipart("#{base_url}/assets", asset:)
+  end
+
+  # Updates an asset given a hash with one +file+ attribute
+  #
+  # Makes a +PUT+ request to the asset manager api to update an asset.
+  #
+  # The asset must be provided as a +Hash+ with a +file+ attribute that
+  # behaves like a +File+ object. The +content-type+ of the file will be based
+  # on the files extension unless you specify a +content_type+ attribute of
+  # the hash to set it.
+  #
+  # @param id [String] The asset identifier (a UUID).
+  # @param asset [Hash] The attributes for the asset to send to the api. Must
+  #   contain +file+, which behaves like a +File+. All other attributes will be
+  #   ignored.
+  # @return [PublishingPlatformApi::Response] The wrapped http response from the api. Behaves
+  #   both as a +Hash+ and an +OpenStruct+, and responds to the following:
+  #     :id           the URL of the asset
+  #     :name         the filename of the asset that will be served
+  #     :content_type the content_type of the asset
+  #     :file_url     the URL from which the asset will be served when it has
+  #                   passed a virus scan
+  #     :state        One of 'unscanned', 'clean', or 'infected'. Unless the state is
+  #                   'clean' the asset at the :file_url will 404
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  # @example Update a file from disk
+  #   uuid = '594602dd-75b3-4e6f-b5d1-cacf8c4d4164'
+  #   asset_manager.update_asset(uuid, file: File.new('image.jpg', 'r'))
+  def update_asset(id, asset)
+    put_multipart("#{base_url}/assets/#{id}", asset:)
+  end
+
+  # Fetches an asset's metadata given the id
+  #
+  # @param id [String] The asset identifier (a UUID).
+  # @return [PublishingPlatformApi::Response, nil] A response object containing the parsed JSON response. If
+  #   the asset cannot be found, +nil+ wil be returned.
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def asset(id)
+    get_json("#{base_url}/assets/#{id}")
+  end
+
+  # Deletes an asset given an id
+  #
+  # Makes a +DELETE+ request to the asset manager api to delete an asset.
+  #
+  # @param id [String] The asset identifier (a UUID).
+  # @return [PublishingPlatformApi::Response] The wrapped http response from the api. Behaves
+  #   both as a +Hash+ and an +OpenStruct+, and responds to the following:
+  #     :id           the URL of the asset
+  #     :name         the filename of the asset that will be served
+  #     :content_type the content_type of the asset
+  #     :file_url     the URL from which the asset will be served when it has
+  #                   passed a virus scan
+  #     :state        One of 'unscanned', 'clean', or 'infected'. Unless the state is
+  #                   'clean' the asset at the :file_url will 404
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  # @example Delete a file from disk
+  #   uuid = '594602dd-75b3-4e6f-b5d1-cacf8c4d4164'
+  #   asset_manager.delete_asset(uuid)
+  def delete_asset(id)
+    delete_json("#{base_url}/assets/#{id}")
+  end
+
+  # Restores an asset given an id
+  #
+  # Makes a +POST+ request to the asset manager api to restore an asset.
+  #
+  # @param id [String] The asset identifier (a UUID).
+  # @return [PublishingPlatformApi::Response] The wrapped http response from the api. Behaves
+  #   both as a +Hash+ and an +OpenStruct+, and responds to the following:
+  #     :id           the URL of the asset
+  #     :name         the filename of the asset that will be served
+  #     :content_type the content_type of the asset
+  #     :file_url     the URL from which the asset will be served when it has
+  #                   passed a virus scan
+  #     :state        One of 'unscanned', 'clean', or 'infected'. Unless the state is
+  #                   'clean' the asset at the :file_url will 404
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  # @example Restore a deleted file
+  #   uuid = '594602dd-75b3-4e6f-b5d1-cacf8c4d4164'
+  #   asset_manager.restore_asset(uuid)
+  def restore_asset(id)
+    post_json("#{base_url}/assets/#{id}/restore")
+  end
+
+  # Fetches an asset given the id and filename
+  #
+  # @param id [String] The asset identifier.
+  # @param filename [String] Filename of the asset.
+  # @return [PublishingPlatformApi::Response] A response object containing the raw asset.
+  #   If the asset cannot be found, +PublishingPlatformApi::HTTPNotFound+ will be raised.
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def media(id, filename)
+    get_raw("#{base_url}/media/#{id}/#{filename}")
+  end
+
+private
+
+  def base_url
+    endpoint
+  end
+end

data/lib/publishing_platform_api/response.rb

@@ -61,7 +61,7 @@ module PublishingPlatformApi
       alias_method :r_maxage, :reverse_max_age
 
       def shared_max_age
-        self["s-maxage"].to_i if key?("r-maxage")
+        self["s-maxage"].to_i if key?("s-maxage")
       end
       alias_method :s_maxage, :shared_max_age
 

data/lib/publishing_platform_api/router.rb

@@ -1,20 +1,6 @@
 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)

data/lib/publishing_platform_api/test_helpers/asset_manager.rb

@@ -0,0 +1,100 @@
+module PublishingPlatformApi
+  module TestHelpers
+    module AssetManager
+      ASSET_MANAGER_ENDPOINT = PublishingPlatformLocation.find("asset-manager")
+
+      def stub_any_asset_manager_call
+        stub_request(:any, %r{\A#{ASSET_MANAGER_ENDPOINT}}).to_return(status: 200)
+      end
+
+      def stub_asset_manager_isnt_available
+        stub_request(:any, %r{\A#{ASSET_MANAGER_ENDPOINT}}).to_return(status: 503)
+      end
+
+      def stub_asset_manager_updates_any_asset(body = {})
+        stub_request(:put, %r{\A#{ASSET_MANAGER_ENDPOINT}/assets})
+          .to_return(body: body.to_json, status: 200)
+      end
+
+      def stub_asset_manager_deletes_any_asset(body = {})
+        stub_request(:delete, %r{\A#{ASSET_MANAGER_ENDPOINT}/assets})
+          .to_return(body: body.to_json, status: 200)
+      end
+
+      def stub_asset_manager_has_an_asset(id, atts, filename = "")
+        response = atts.merge("_response_info" => { "status" => "ok" })
+
+        stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/assets/#{id}")
+          .to_return(body: response.to_json, status: 200)
+
+        stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/media/#{id}/#{filename}")
+          .to_return(body: "Some file content", status: 200)
+      end
+
+      def stub_asset_manager_does_not_have_an_asset(id)
+        response = {
+          "_response_info" => { "status" => "not found" },
+        }
+
+        stub_request(:any, "#{ASSET_MANAGER_ENDPOINT}/assets/#{id}")
+          .to_return(body: response.to_json, status: 404)
+      end
+
+      # This can take a string of an exact url or a hash of options
+      #
+      # with a string:
+      # `stub_asset_manager_receives_an_asset("https://asset-manager/media/619ce797-b415-42e5-b2b1-2ffa0df52302/file.jpg")`
+      #
+      # with a hash:
+      # `stub_asset_manager_receives_an_asset(id: "20d04259-e3ae-4f71-8157-e6c843096e96", filename: "file.jpg")`
+      # which would return a file url of "https://asset-manager/media/20d04259-e3ae-4f71-8157-e6c843096e96/file.jpg"
+      #
+      # with no argument
+      #
+      # `stub_asset_manager_receives_an_asset`
+      # which would return a file url of "https://asset-manager/media/0053adbf-0737-4923-9d8a-8180f2c723af/0d19136c4a94f07"
+      def stub_asset_manager_receives_an_asset(response_url = {})
+        stub_request(:post, "#{ASSET_MANAGER_ENDPOINT}/assets").to_return do
+          if response_url.is_a?(String)
+            file_url = response_url
+          else
+            options = {
+              id: SecureRandom.uuid,
+              filename: SecureRandom.hex(8),
+            }.merge(response_url)
+
+            file_url = "#{ASSET_MANAGER_ENDPOINT}/media/#{options[:id]}/#{options[:filename]}"
+          end
+          { body: { file_url: }.to_json, status: 200 }
+        end
+      end
+
+      def stub_asset_manager_upload_failure
+        stub_request(:post, "#{ASSET_MANAGER_ENDPOINT}/assets").to_return(status: 500)
+      end
+
+      def stub_asset_manager_update_asset(asset_id, body = {})
+        stub_request(:put, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}")
+          .to_return(body: body.to_json, status: 200)
+      end
+
+      def stub_asset_manager_update_asset_failure(asset_id)
+        stub_request(:put, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}").to_return(status: 500)
+      end
+
+      def stub_asset_manager_delete_asset(asset_id, body = {})
+        stub_request(:delete, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}")
+          .to_return(body: body.to_json, status: 200)
+      end
+
+      def stub_asset_manager_delete_asset_missing(asset_id)
+        stub_request(:delete, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}")
+          .to_return(status: 404)
+      end
+
+      def stub_asset_manager_delete_asset_failure(asset_id)
+        stub_request(:delete, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}").to_return(status: 500)
+      end
+    end
+  end
+end

data/lib/publishing_platform_api/test_helpers/common_responses.rb

@@ -0,0 +1,41 @@
+module PublishingPlatformApi
+  module TestHelpers
+    module CommonResponses
+      def titleize_slug(slug, options = {})
+        if options[:title_case]
+          slug.tr("-", " ").gsub(/\b./, &:upcase)
+        else
+          slug.tr("-", " ").capitalize
+        end
+      end
+
+      # expects a slug like "ministry-of-funk"
+      # returns an acronym like "MOF"
+      def acronymize_slug(slug)
+        initials = slug.gsub(/\b\w+/) { |m| m[0] }.delete("-")
+        initials.upcase
+      end
+
+      def response_base
+        {
+          "_response_info" => {
+            "status" => "ok",
+          },
+        }
+      end
+      alias_method :singular_response_base, :response_base
+
+      def plural_response_base
+        response_base.merge(
+          "description" => "Tags!",
+          "total" => 100,
+          "start_index" => 1,
+          "page_size" => 100,
+          "current_page" => 1,
+          "pages" => 1,
+          "results" => [],
+        )
+      end
+    end
+  end
+end

data/lib/publishing_platform_api/test_helpers/organisations.rb

@@ -0,0 +1,103 @@
+# require "gds_api/test_helpers/json_client_helper"
+require "publishing_platform_api/test_helpers/common_responses"
+# require "plek"
+# require "securerandom"
+
+module PublishingPlatformApi
+  module TestHelpers
+    module Organisations
+      include PublishingPlatformApi::TestHelpers::CommonResponses
+
+      WEBSITE_ROOT = PublishingPlatformLocation.new.website_root
+
+      def stub_organisations_api_has_organisations(organisation_slugs)
+        bodies = organisation_slugs.map { |slug| organisation_for_slug(slug) }
+        stub_organisations_api_has_organisations_with_bodies(bodies)
+      end
+
+      # Sets up the index endpoints for the given organisation slugs
+      # The stubs are setup to paginate in chunks of 20
+      #
+      # This also sets up the individual endpoints for each slug
+      # by calling organisations_api_has_organisation below
+      def stub_organisations_api_has_organisations_with_bodies(organisation_bodies)
+        # Stub API call to the endpoint for an individual organisation
+        organisation_bodies.each do |body|
+          slug = body["details"]["slug"]
+          stub_organisations_api_has_organisation(slug, body)
+        end
+
+        pages = []
+        organisation_bodies.each_slice(20) do |bodies|
+          pages << bodies
+        end
+
+        pages.each_with_index do |page, i|
+          page_details = plural_response_base.merge(
+            "results" => page,
+            "total" => organisation_bodies.size,
+            "pages" => pages.size,
+            "current_page" => i + 1,
+            "page_size" => 20,
+            "start_index" => i * 20 + 1,
+          )
+
+          links = { self: "#{WEBSITE_ROOT}/api/organisations?page=#{i + 1}" }
+          links[:next] = "#{WEBSITE_ROOT}/api/organisations?page=#{i + 2}" if pages[i + 1]
+          links[:previous] = "#{WEBSITE_ROOT}/api/organisations?page=#{i}" unless i.zero?
+          page_details["_response_info"]["links"] = []
+          link_headers = []
+          links.each do |rel, href|
+            page_details["_response_info"]["links"] << { "rel" => rel, "href" => href }
+            link_headers << "<#{href}>; rel=\"#{rel}\""
+          end
+
+          stub_request(:get, links[:self])
+            .to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
+
+          next unless i.zero?
+
+          # First page exists at URL with and without page param
+          stub_request(:get, links[:self].sub(/\?page=1/, ""))
+            .to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
+        end
+
+        if pages.empty?
+          # If there are no pages - and so no organisations specified - then stub /api/organisations.
+          stub_request(:get, "#{WEBSITE_ROOT}/api/organisations").to_return(status: 200, body: plural_response_base.to_json, headers: {})
+        end
+      end
+
+      def stub_organisations_api_has_organisation(organisation_slug, details = nil)
+        details ||= organisation_for_slug(organisation_slug)
+        stub_request(:get, "#{WEBSITE_ROOT}/api/organisations/#{organisation_slug}")
+          .to_return(status: 200, body: details.to_json)
+      end
+
+      def stub_organisations_api_does_not_have_organisation(organisation_slug)
+        stub_request(:get, "#{WEBSITE_ROOT}/api/organisations/#{organisation_slug}").to_return(status: 404)
+      end
+
+      def organisation_for_slug(slug)
+        singular_response_base.merge(organisation_details_for_slug(slug))
+      end
+
+      # Constructs a sample organisation
+      def organisation_details_for_slug(slug, content_id = SecureRandom.uuid)
+        {
+          "id" => "#{WEBSITE_ROOT}/api/organisations/#{slug}",
+          "title" => titleize_slug(slug, title_case: true),
+          "format" => "Department",
+          "updated_at" => "2013-03-25T13:06:42+00:00",
+          "web_url" => "#{WEBSITE_ROOT}/government/organisations/#{slug}",
+          "details" => {
+            "slug" => slug,
+            "abbreviation" => acronymize_slug(slug),
+            "status" => "live",
+            "content_id" => content_id,
+          },
+        }
+      end
+    end
+  end
+end