publishing_platform_api_adapters 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ec8b5ba55f54de30a2717ff57716d1e121ca531cbcc86208e653dda3f2c675
-  data.tar.gz: 652114d6c57ea3550e48bd039ec2769617e9721e20a46ae069759ad8be072bfd
+  metadata.gz: 54dea58b3d1bcd3fe96e91cb75249bb29a240ba5ab41bba121292b695b8d160b
+  data.tar.gz: f345c52fbb488893dc130248ad994e80df33df0bd80d193cd757f05adaea9493
 SHA512:
-  metadata.gz: 3c19ef7a204e52ad5179dae74e62399a52ed2005c0b6020166f93ed083183ecb2a26bdc355a967a1b147eecb1666a758a09fb5c00e9ce2a328500a630134832d
-  data.tar.gz: 3e6f94598b557c5494a6399e0b6b9de732944ee7ed8dfc48037a53d31fc3d0905cbba7dc34d6e5b68ecde14a7c515b12a72baaab8b6af0dec90caf7d0e57b725
+  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/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/version.rb

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

data/lib/publishing_platform_api.rb

@@ -1,6 +1,7 @@
 require "addressable"
 require "publishing_platform_location"
 require "time"
+require "publishing_platform_api/asset_manager"
 require "publishing_platform_api/content_store"
 require "publishing_platform_api/publishing_api"
 require "publishing_platform_api/organisations"
@@ -8,6 +9,19 @@ require "publishing_platform_api/router"
 
 # @api documented
 module PublishingPlatformApi
+  # Creates a PublishingPlatformApi::AssetManager adapter
+  #
+  # This will set a bearer token if a ASSET_MANAGER_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [PublishingPlatformApi::AssetManager]
+  def self.asset_manager(options = {})
+    PublishingPlatformApi::AssetManager.new(
+      PublishingPlatformLocation.find("asset-manager"),
+      { bearer_token: ENV["ASSET_MANAGER_BEARER_TOKEN"] }.merge(options),
+    )
+  end
+
   # Creates a PublishingPlatformApi::ContentStore adapter
   #
   # This will set a bearer token if a CONTENT_STORE_BEARER_TOKEN environment

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_api_adapters
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Publishing Platform
@@ -185,6 +185,7 @@ files:
 - README.md
 - Rakefile
 - lib/publishing_platform_api.rb
+- lib/publishing_platform_api/asset_manager.rb
 - lib/publishing_platform_api/base.rb
 - lib/publishing_platform_api/content_store.rb
 - lib/publishing_platform_api/exceptions.rb
@@ -198,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/test_helpers/asset_manager.rb
 - lib/publishing_platform_api/test_helpers/common_responses.rb
 - lib/publishing_platform_api/test_helpers/content_item_helpers.rb
 - lib/publishing_platform_api/test_helpers/content_store.rb
@@ -223,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Adapters to work with Publishing Platform APIs
 test_files: []