gds-api-adapters 91.0.0 → 92.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e7999151bc881b78197b10d558183acae7e152fa24ab094fe6ffc7b1f3ba04
-  data.tar.gz: b49490f10d7a25df53c0e9ad1794ae86f5539ec0da7439c8b2e9e0cdd49b3188
+  metadata.gz: fa430c81b388aeac9ba84ad16f9749119037eb12a189c80004c7c789f813f158
+  data.tar.gz: e01b6cd9c760f72f8c542206de12770e44b75bc18252480b10d84fb046d5ac0d
 SHA512:
-  metadata.gz: b54654c80ed4e66aef36108340a56705d98be773f2c8f3f68c2de337fec44c9ac694c616664b3caf23a9969c92f89bffef7fd8f08ac98c32281abf4b4e25fa53
-  data.tar.gz: 2204c601e2524af9c848fcd35faae39088c0a8f7716091b21ac59ffd7b5022455dbe39e32722204167449a583a203785b7d1046b5bfae91755057f237c4c7e1a
+  metadata.gz: 2cd5ab36cbac5f9b4854ce5658b6f41a8e43780d2b0a9e6ed08d59b2e1fccbf95950d259c7e344ea48b09986ff8a205cfea0caf19890ec780fcba50a25e2d472
+  data.tar.gz: 314e8b47ec5457681aa8e0048331340d24bef56c7c7221f6308015c75cf878579ac41615d80e855fc96350322d7b6fc03921455caffef887873ea3f11b42721b

data/lib/gds_api/asset_manager.rb

@@ -48,98 +48,6 @@ class GdsApi::AssetManager < GdsApi::Base
     post_multipart("#{base_url}/assets", asset: asset)
   end
 
-  # Creates a Whitehall asset given a hash with +file+ & +legacy_url_path+
-  # (required) and +legacy_etag+ & +legacy_last_modified+ (optional) attributes
-  #
-  # Makes a +POST+ request to the asset manager api to create a Whitehall asset.
-  #
-  # The asset must be provided as a +Hash+ with a +file+ attribute that behaves
-  # like a +File+ object and a +legacy_url_path+ attribute. The +content-type+
-  # that the asset manager will subsequently serve will be based *only* 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.
-  #
-  # The +legacy_url_path+ attribute is used to specify the public URL path at
-  # which the asset should be served by the Asset Manager. This differs from
-  # `#create_asset` where Asset Manager itself determines the public URL path to
-  # be used and returns that to the publishing app in the response. This
-  # endpoint is intended to be an interim measure which will help us migrate
-  # assets from Whitehall into Asset Manager without needing to change the URLs.
-  # The end goal is for Asset Manager to determine the public URL path for all
-  # assets including Whitehall assets. At that point this endpoint will become
-  # redundant and should be removed.
-  #
-  # There may be restrictions on the format of the `legacy_url_path`. If the
-  # supplied path is not valid, a `GdsApi::HTTPUnprocessableEntity` exception
-  # will be raised.
-  #
-  # The optional +legacy_etag+ & +legacy_last_modified+ attributes allow the
-  # client to specify the values that should be used in the `ETag` &
-  # `Last-Modified` response headers when the asset is requested via its public
-  # URL. They are only intended to be used for migrating existing Whitehall
-  # assets to Asset Manager so that we can avoid wholesale cache invalidation.
-  # New Whitehall assets should not specify values for these attributes; Asset
-  # Manager will generate suitable values.
-  #
-  # Note: this endpoint should only be used by the Whitehall Admin app and not
-  # by any other publishing apps.
-  #
-  # @param asset [Hash] The attributes for the asset to send to the api. Must
-  #   contain +file+, which behaves like a +File+, and +legacy_url_path+, a
-  #   +String+. May contain +legacy_etag+, a +String+, and
-  #   +legacy_last_modified+, a +Time+ object. All other attributes will be
-  #   ignored.
-  #
-  # @return [GdsApi::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 redirect to a
-  #                   placeholder
-  #
-  # @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'),
-  #     legacy_url_path: '/government/uploads/path/to/image.jpg'
-  #   )
-  #   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]
-  #      legacy_url_path: '/government/uploads/path/to/cma_case_image.jpg'
-  #    )
-  #    response['content_type'] #=> "image/jpeg"
-  def create_whitehall_asset(asset)
-    post_multipart("#{base_url}/whitehall_assets", asset: asset)
-  end
-
-  # Fetches a Whitehall asset's metadata given the legacy URL path
-  #
-  # @param legacy_url_path [String] The Whitehall asset identifier.
-  # @return [GdsApi::Response] A response object containing the parsed JSON
-  #   response. If the asset cannot be found, +GdsApi::HTTPNotFound+ will be
-  #   raised.
-  #
-  # @raise [HTTPErrorResponse] if the request returns an error
-  def whitehall_asset(legacy_url_path)
-    get_json("#{base_url}/whitehall_assets/#{uri_encode(legacy_url_path)}")
-  end
-
   # Updates an asset given a hash with one +file+ attribute
   #
   # Makes a +PUT+ request to the asset manager api to update an asset.
@@ -239,6 +147,18 @@ class GdsApi::AssetManager < GdsApi::Base
     get_raw("#{base_url}/#{uri_encode(legacy_url_path)}")
   end
 
+  # Fetches an asset given the id and filename
+  #
+  # @param id [String] The asset identifier.
+  # @param filename [String] Filename of the asset.
+  # @return [GdsApi::Response] A response object containing the raw asset.
+  #   If the asset cannot be found, +GdsApi::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

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -21,21 +21,19 @@ module GdsApi
           .to_return(body: body.to_json, status: 200)
       end
 
-      def stub_asset_manager_has_an_asset(id, atts)
+      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)
-      end
-
-      def stub_asset_manager_has_a_whitehall_asset(legacy_url_path, atts)
-        response = atts.merge("_response_info" => { "status" => "ok" })
 
-        stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/whitehall_assets/#{legacy_url_path}")
-          .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_has_a_whitehall_media_asset(legacy_url_path, content)
         stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/#{legacy_url_path}")
-          .to_return(body: "Some file content", status: 200)
+          .to_return(body: content, status: 200)
       end
 
       def stub_asset_manager_does_not_have_an_asset(id)
@@ -47,15 +45,6 @@ module GdsApi
           .to_return(body: response.to_json, status: 404)
       end
 
-      def stub_asset_manager_does_not_have_a_whitehall_asset(legacy_url_path)
-        response = {
-          "_response_info" => { "status" => "not found" },
-        }
-
-        stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/whitehall_assets/#{legacy_url_path}")
-          .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:

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "91.0.0".freeze
+  VERSION = "92.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 91.0.0
+  version: 92.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -417,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs