gds-api-adapters 49.1.0 → 49.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd7e95cb6fffdf2c4ad62152dfac55e06bdf5cb9
-  data.tar.gz: 938c0cbe2f84b5df4b44fceee7aa31efb660a000
+  metadata.gz: 004eb0ac42b4214aa361b0f6c67c305a2501f96d
+  data.tar.gz: 404379041f33115af011520407c01947a7142f8b
 SHA512:
-  metadata.gz: 4471d073f9666568ab8f908d7b7979d7b61e2fb6acbea3e7c6f06287051703712b3fa53cb89399a57214940de5353b2aa83cf956b0f21e4fd968533aaeb36af0
-  data.tar.gz: bca813b66cdcfdda9d13f89a2c0188ad12d9065d678dffbbb716bfbb0f89b22c439201d858ce62ee7a53121963b2e8178648469555b73c16a8f8d56ea68712c7
+  metadata.gz: 38791a6ff09cb11db3237b038cd4a66ed682e8657fa6c9dcd99ab217a92dc817ce2e74c5c4e26904ec574aabfc6549295dea4f4ffde12e892d2eb2bcb3af1f4d
+  data.tar.gz: 696ec0fb37e345ef8f779c312a9610fb4c0c9bd4f1f15796b064949429b4847378f57ff6411215aaa24e228a0348669aaa7bbd3f616372d3f9cf819aaebf5424

data/lib/gds_api/asset_manager.rb

@@ -47,6 +47,76 @@ 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+
+  # 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.
+  #
+  # 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+. 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
+
   # Updates an asset given a hash with one +file+ attribute
   #
   # Makes a +PUT+ request to the asset manager api to update an asset.

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '49.1.0'.freeze
+  VERSION = '49.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 49.1.0
+  version: 49.2.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek