gds-api-adapters 31.1.0 → 31.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3958ad60a4dd784913638e24174ec1cbaa6bf5bf
-  data.tar.gz: 472556864dd1a993b30ac799f92d00f103323929
+  metadata.gz: c42cb1e42bd86839f165b478625dd26da0565661
+  data.tar.gz: 001a349f35443aba6650d824d4302295bbb485cf
 SHA512:
-  metadata.gz: d7fe0d40e473efb738e009106cb05bf5fba2b93661c32696ad7ec5ee53840c92a45acf43e2ecc05d104088d5ab6eee0cf2da06ef6241316fb4b29dc7e63c1529
-  data.tar.gz: 67310a8f8a8b02a4779d372d9dc8b7416de404af60c66411c217149899051b6bc036592ff6eb6ff34982244fa00aab3f9f6c17ee5c3cce13788b99b5352e4af8
+  metadata.gz: 85c6c6760862684095f99dd1e4e1496852c408f0e9158cf4794cd5ca2394bed546d783c05043ed540a5b810a44c1946c32a41ea0028ca2bf91020846c1d859fa
+  data.tar.gz: 97e59749dbd70fc76ea10682ba87a863d460a9c3664044c3afc4dd889f95a3018c10b67e99e6e4d969e3bd53180813c164af26ec789f31ba6e227071bfe592c5

data/lib/gds_api/asset_manager.rb

@@ -3,42 +3,88 @@ require_relative 'exceptions'
 
 class GdsApi::AssetManager < GdsApi::Base
 
-  # Creates an asset given attributes
+  # Creates an asset given a hash with one +file+ attribute
   #
-  # Makes a `POST` request to the asset manager api to create an asset. The api accepts
-  #   the following attributes:
+  # Makes a +POST+ request to the asset manager api to create an asset.
   #
-  # * `file` - a File object
+  # The asset must be provided as a +Hash+ with a single +file+ attribute that
+  # behaves like a +File+ object. 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.
   #
-  # @param asset [Hash] The attributes for the asset to send to the api.
-  # @return [Net::HTTPResponse] The raw http response from the api.
+  # @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 [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 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 => asset })
   end
 
-  # Updates an asset given attributes
+  # Updates an asset given a hash with one +file+ attribute
   #
-  # Makes a `PUT` request to the asset manager api to update an asset.
-  # The api accepts the following attributes:
+  # Makes a +PUT+ request to the asset manager api to update an asset.
   #
-  # * `file` - a File object
+  # The asset must be provided as a +Hash+ with a single +file+ attribute that
+  # behaves like a +File+ object. 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.
   #
-  # @param id [String] The asset identifier
-  # @param asset [Hash] The attributes for the asset to send to the api.
-  # @return [Net::HTTPResponse] The raw http response from the api.
+  # @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 [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 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 => asset })
   end
 
   # Fetches an asset given the id
   #
-  # @param id [String] The asset identifier
-  # @return [Response, nil] A response object containing the parsed JSON response. If
-  #   the asset cannot be found, nil wil be returned.
+  # @param id [String] The asset identifier (a UUID).
+  # @return [GdsApi::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)

data/lib/gds_api/mapit.rb

@@ -12,6 +12,10 @@ class GdsApi::Mapit < GdsApi::Base
     get_json("#{base_url}/areas/#{type}.json")
   end
 
+  def area_for_code(code_type, code)
+    get_json("#{base_url}/code/#{code_type}/#{code}.json")
+  end
+
   class Location
     attr_reader :response
 

data/lib/gds_api/test_helpers/mapit.rb

@@ -28,7 +28,8 @@ module GdsApi
           [i, {
             'codes' => {
               'ons' => area['ons'],
-              'gss' => area['gss']
+              'gss' => area['gss'],
+              'govuk_slug' => area['govuk_slug']
             },
             'name' => area['name'],
             'type' => area['type']
@@ -60,6 +61,16 @@ module GdsApi
         stub_request(:get, "#{MAPIT_ENDPOINT}/areas/" + area_type + ".json")
           .to_return(:body => [].to_json, :status => 200)
       end
+
+      def mapit_has_area_for_code(code_type, code, area)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
+          .to_return(:body => area.to_json, :status => 200)
+      end
+
+      def mapit_does_not_have_area_for_code(code_type, code)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
+        .to_return(:body => { "code" => 404, "error" => "No areas were found that matched code #{code_type} = #{code}." }.to_json, :status => 404)
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '31.1.0'
+  VERSION = '31.2.0'
 end

data/test/mapit_test.rb

@@ -59,6 +59,7 @@ describe GdsApi::Mapit do
       end
     end
   end
+
   describe "areas_for_type" do
     before do
        mapit_has_areas('EUR', {
@@ -85,4 +86,30 @@ describe GdsApi::Mapit do
       assert_empty response
     end
   end
+
+  describe "area_for_code" do
+    before do
+      south_ribble_area = {
+        name: "South Ribble Borough Council",
+        codes: {
+          ons: "30UN",
+          gss: "E07000126",
+          unit_id: "4834"
+        },
+        type: "DIS"
+      }
+      mapit_has_area_for_code('ons', '30UN', south_ribble_area)
+      mapit_does_not_have_area_for_code('govuk_slug', 'neverland')
+    end
+
+    it "should return area for a code type" do
+      area = @api.area_for_code('ons', '30UN')
+
+      assert_equal "South Ribble Borough Council", area["name"]
+    end
+
+    it "should return 404 for a missing area of a certain code type" do
+      assert_nil @api.area_for_code('govuk_slug', 'neverland')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 31.1.0
+  version: 31.2.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -471,55 +471,55 @@ signing_key:
 specification_version: 4
 summary: Adapters to work with GDS APIs
 test_files:
-- test/support_api_test.rb
-- test/mapit_test.rb
+- test/content_api_test.rb
+- test/json_client_test.rb
+- test/content_store_test.rb
 - test/publishing_api_test.rb
-- test/publishing_api_v2/lookup_test.rb
-- test/publishing_api_v2/get_links_test.rb
-- test/publishing_api_v2/get_expanded_links_test.rb
+- test/business_support_api_test.rb
+- test/middleware/govuk_header_sniffer_test.rb
 - test/whitehall_admin_api_test.rb
-- test/pp_data_in_test.rb
-- test/publishing_api/special_route_publisher_test.rb
-- test/need_api_test.rb
-- test/publisher_api_test.rb
-- test/rummager_helpers_test.rb
+- test/list_response_test.rb
+- test/maslow_test.rb
+- test/panopticon_registerer_test.rb
 - test/support_test.rb
-- test/test_helpers/publishing_api_test.rb
-- test/test_helpers/pact_helper.rb
-- test/test_helpers/panopticon_test.rb
-- test/test_helpers/email_alert_api_test.rb
-- test/test_helpers/publishing_api_v2_test.rb
+- test/asset_manager_test.rb
+- test/helpers_test.rb
 - test/licence_application_api_test.rb
-- test/gov_uk_delivery_test.rb
-- test/maslow_test.rb
+- test/test_helper.rb
 - test/govuk_headers_test.rb
-- test/helpers_test.rb
-- test/panopticon_registerer_test.rb
-- test/panopticon_test.rb
-- test/middleware/govuk_header_sniffer_test.rb
-- test/rummager_test.rb
-- test/json_client_test.rb
-- test/email_alert_api_test.rb
-- test/content_api_test.rb
-- test/response_test.rb
+- test/publisher_api_test.rb
+- test/mapit_test.rb
+- test/rummager_helpers_test.rb
+- test/publishing_api_v2_test.rb
+- test/publishing_api_v2/lookup_test.rb
+- test/publishing_api_v2/get_expanded_links_test.rb
+- test/publishing_api_v2/get_links_test.rb
+- test/support_api_test.rb
 - test/organisations_api_test.rb
-- test/imminence_api_test.rb
-- test/content_store_test.rb
-- test/asset_manager_test.rb
+- test/gds_api_base_test.rb
+- test/router_test.rb
+- test/publishing_api/special_route_publisher_test.rb
+- test/external_link_tracker_test.rb
+- test/need_api_test.rb
+- test/panopticon_test.rb
+- test/pp_data_in_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/new_policies_for_dwp.json
-- test/fixtures/world_organisations_australia.json
 - test/fixtures/no_services_and_info_data_found_fixture.json
-- test/fixtures/old_policies_for_dwp.json
 - test/fixtures/services_and_info_fixture.json
+- test/fixtures/old_policies_for_dwp.json
+- test/fixtures/world_organisations_australia.json
 - test/fixtures/sub_sector_organisations.json
 - test/fixtures/finder_api/cma-case-schema.json
-- test/router_test.rb
-- test/list_response_test.rb
-- test/external_link_tracker_test.rb
-- test/gds_api_base_test.rb
 - test/worldwide_api_test.rb
-- test/test_helper.rb
-- test/publishing_api_v2_test.rb
-- test/business_support_api_test.rb
+- test/test_helpers/publishing_api_test.rb
+- test/test_helpers/publishing_api_v2_test.rb
+- test/test_helpers/pact_helper.rb
+- test/test_helpers/panopticon_test.rb
+- test/test_helpers/email_alert_api_test.rb
+- test/gov_uk_delivery_test.rb
+- test/imminence_api_test.rb
+- test/email_alert_api_test.rb
+- test/response_test.rb
+- test/rummager_test.rb
 has_rdoc: