gds-api-adapters 36.4.1 → 37.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06df600e92d5e29ebcc9d2d1011169f25ed806d3
-  data.tar.gz: 61a8846b1ce2833f1c72124435c154f5246439e5
+  metadata.gz: 80e428cbf9fbbf1cc956c99fdab6135b912b0eb7
+  data.tar.gz: 2f3522bb16213e2fa76e8fad6786b65f1c4150f7
 SHA512:
-  metadata.gz: 66e7c5af97fc0c0f6766be3b134757b96b3e448b231f4898d284d7b53b49bed2521903c7a9621e27bfde9c657bee2febc3b3ab38ad469901cde1f469d5fee6b9
-  data.tar.gz: 972920cf66478a2134769bcb57958dd70ea58278162d40671940c0c0604552cddc620b33f7293ed295a51cd11fae9896c4a1bb7cb15ff52bca945dac51a0f9fe
+  metadata.gz: ba103489e0af11e87a3c3712043a27fd192e96f7242faa40b0e1e85a109337ea26e4ed08ed3ae1e3a474490c975063db7f91251e213d480c09fc14a1d1c959b5
+  data.tar.gz: aa8e0fe34d8960d43bb68bd4facb7208459c64545be952414d945f0b35c2eaa20a38fb5376b0725efa422170ed442ccb3eefb8d1e21d745a7970c00c5d392747

data/README.md

@@ -18,19 +18,14 @@ Example adapters for frequently used applications:
 
 ## Configuration
 
-We're currently deprecating some behaviour of this gem. You can opt-in to the
-new behaviour now by adding configuration like this:
+From December 1st, 2016 it won't be possible to use the following configuration
+options:
 
-```ruby
-# config/initializers/gds_api_adapters.rb
-GdsApi.configure do |config|
-  # Never return nil when a server responds with 404 or 410.
-  config.always_raise_for_not_found = true
-
-  # Return a hash, not an OpenStruct from a request.
-  config.hash_response_for_requests = true
-end
-```
+- `always_raise_for_not_found`
+- `hash_response_for_requests`
+
+Please remove these configuration options from your client application and
+migrate to the new behaviour as soon as possible.
 
 ## Logging
 

data/Rakefile

@@ -36,6 +36,11 @@ PactBroker::Client::PublicationTask.new("released_version") do | task |
   configure_pact_broker_location(task)
 end
 
+desc "Run the linter against changed files"
+task :lint do
+  sh "bundle exec govuk-lint-ruby --diff --cached --format clang"
+end
+
 require "gem_publisher"
 desc "Publish gem to rubygems.org if necessary"
 task :publish_gem do |t|

data/lib/gds_api/asset_manager.rb

@@ -31,8 +31,8 @@ class GdsApi::AssetManager < GdsApi::Base
   #
   # @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"
+  #   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",
@@ -42,7 +42,7 @@ class GdsApi::AssetManager < GdsApi::Base
   #    # 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"
+  #    response['content_type'] #=> "image/jpeg"
   def create_asset(asset)
     post_multipart("#{base_url}/assets", { :asset => asset })
   end

data/lib/gds_api/config.rb

@@ -8,22 +8,69 @@ module GdsApi
   end
 
   class Config
-    # Always raise a `HTTPNotFound` exception when the server returns 404 or
-    # 410. This avoids nil-errors in your code and makes debugging easier.
+    # Always raise an `HTTPNotFound` exception when the server returns 404 or an
+    # `HTTPGone` when the server returns 410. This avoids nil-errors in your
+    # code and makes debugging easier.
     #
-    # Currently defaults to false.
+    # Currently defaults to true.
     #
-    # This configuration allows some time to upgrade - you should opt-in to this
-    # behaviour now. We'll change this to default to true on October 1st, 2016
-    # and remove the option entirely on December 1st, 2016.
-    attr_accessor :always_raise_for_not_found
+    # This configuration will be removed on December 1st, 2016. Please make sure
+    # you upgrade gds-api-adapters to the latest version and avoid configuring
+    # it on your client application.
+    def always_raise_for_not_found
+      return true if @always_raise_for_not_found.nil?
+
+      @always_raise_for_not_found
+    end
+
+    def always_raise_for_not_found=(value)
+      warn <<-doc
+
+DEPRECATION NOTICE: Please delete any instances of
+`GdsApi.config.always_raise_for_not_found=` from your codebase to make
+sure all 404 or 410 responses raise an exception.
+
+This configuration option will be be removed. Raising exceptions is now
+the default behaviour and it won't be possible to opt-out from December
+1st, 2016.
+
+Called from: #{caller[2]}
+
+      doc
+
+      @always_raise_for_not_found = value
+    end
 
     # Set to true to make `GdsApi::Response` behave like a simple hash, instead
     # of an OpenStruct. This will prevent nil-errors.
     #
-    # This configuration allows some time to upgrade - you should opt-in to this
-    # behaviour now. We'll change this to default to true on October 1st, 2016
-    # and remove the option entirely on December 1st, 2016.
-    attr_accessor :hash_response_for_requests
+    # Currently defaults to true.
+    #
+    # This configuration will be removed on December 1st, 2016. Please make sure
+    # you upgrade gds-api-adapters to the latest version and avoid configuring
+    # it on your client application.
+    def hash_response_for_requests
+      return true if @hash_response_for_requests.nil?
+
+      @hash_response_for_requests
+    end
+
+    def hash_response_for_requests=(value)
+      warn <<-doc
+
+DEPRECATION NOTICE: Please delete any instances of
+`GdsApi.config.hash_response_for_requests=` from your codebase to make
+sure responses behave like a Hash instead of an OpenStruct.
+
+This configuration option will be be removed. Returning responses that
+behave like a Hash is the default behaviour and it won't be possible to
+opt-out from December 1st, 2016.
+
+Called from: #{caller[2]}
+
+      doc
+
+      @hash_response_for_requests = value
+    end
   end
 end

data/lib/gds_api/gov_uk_delivery.rb

@@ -22,7 +22,7 @@ class GdsApi::GovUkDelivery < GdsApi::Base
 
   def signup_url(feed_url)
     if response = get_json("#{base_url}/list-url?feed_url=#{CGI.escape(feed_url)}")
-      response.list_url
+      response['list_url']
     end
   end
 

data/lib/gds_api/json_client.rb

@@ -78,16 +78,6 @@ module GdsApi
       if GdsApi.config.always_raise_for_not_found
         get_raw!(url)
       else
-        warn <<-doc
-          DEPRECATION NOTICE: You are making requests that will potentially
-          return nil. Please set `GdsApi.config.always_raise_for_not_found = true`
-          to make sure all responses with 404 or 410 raise an exception.
-
-          Raising exceptions will be the default behaviour from October 1st, 2016.
-
-          Called from: #{caller[2]}
-        doc
-
         ignoring_missing do
           get_raw!(url)
         end
@@ -105,16 +95,6 @@ module GdsApi
         if GdsApi.config.always_raise_for_not_found
           send (method_name + "!"), url, *args, &block
         else
-          warn <<-doc
-            DEPRECATION NOTICE: You are making requests that will potentially
-            return nil. Please set `GdsApi.config.always_raise_for_not_found = true`
-            to make sure all responses with 404 or 410 raise an exception.
-
-            Raising exceptions will be the default behaviour from October 1st, 2016.
-
-            Called from: #{caller[2]}
-          doc
-
           ignoring_missing do
             send (method_name + "!"), url, *args, &block
           end

data/lib/gds_api/part_methods.rb

@@ -1,12 +1,12 @@
 module GdsApi::PartMethods
 
   def part_index(slug)
-    parts.index { |p| p.slug == slug }
+    parsed_content['parts'].index { |p| p['slug'] == slug }
   end
 
   def find_part(slug)
     return nil unless index = part_index(slug)
-    parts[index]
+    parsed_content['parts'][index]
   end
 
   def has_parts?(part)
@@ -14,13 +14,13 @@ module GdsApi::PartMethods
   end
 
   def has_previous_part?(part)
-    index = part_index(part.slug)
+    index = part_index(part['slug'])
     !! (index && index > 0)
   end
 
   def has_next_part?(part)
-    index = part_index(part.slug)
-    !! (index && (index + 1) < parts.length)
+    index = part_index(part['slug'])
+    !! (index && (index + 1) < parsed_content['parts'].length)
   end
 
   def part_after(part)
@@ -33,9 +33,12 @@ module GdsApi::PartMethods
 
 private
   def part_at(part, relative_offset)
-    return nil unless current_index = part_index(part.slug)
+    current_index = part_index(part['slug'])
+    return nil unless current_index
+
     other_index = current_index + relative_offset
-    return nil unless (0 ... parts.length).include?(other_index)
-    parts[other_index]
+    return nil unless (0...parsed_content['parts'].length).cover?(other_index)
+
+    parsed_content['parts'][other_index]
   end
 end

data/lib/gds_api/publisher.rb

@@ -7,8 +7,8 @@ class GdsApi::Publisher < GdsApi::Base
 
     response = get_json(url_for_slug(slug, options))
     if response
-      container = response.to_ostruct
-      container.extend(GdsApi::PartMethods) if container.parts
+      container = response.dup
+      container.extend(GdsApi::PartMethods) if container['parts']
       convert_updated_date(container)
       container
     else
@@ -39,8 +39,9 @@ class GdsApi::Publisher < GdsApi::Base
 
 private
   def convert_updated_date(container)
-    if container.updated_at && container.updated_at.class == String
-      container.updated_at = Time.parse(container.updated_at)
+    if container['updated_at'] && container['updated_at'].is_a?(String)
+      container.parsed_content['updated_at'] =
+        Time.parse(container['updated_at'])
     end
   end
 

data/lib/gds_api/publishing_api_v2.rb

@@ -241,7 +241,24 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     patch_json!(links_url(content_id), payload)
   end
 
-  # FIXME: Add documentation
+  # Get a list of content items from the Publishing API.
+  #
+  # The only required key in the params hash is `document_type`. These will be used to filter down the content items being returned by the API. Other allowed options can be seen from the link below.
+  #
+  # @param params [Hash] At minimum, this hash has to include the `document_type` of the content items we wish to see. All other optional keys are documented above.
+  #
+  # @example
+  #
+  #   publishing_api.get_content_items(
+  #     document_type: 'taxon',
+  #     q: 'Driving',
+  #     page: 1,
+  #     per_page: 50,
+  #     publishing_app: 'content-tagger',
+  #     fields: ['title', 'description', 'public_updated_at'],
+  #     locale: 'en',
+  #     order: '-public_updated_at'
+  #   )
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2content
   def get_content_items(params)

data/lib/gds_api/response.rb

@@ -19,7 +19,7 @@ module GdsApi
   # Example:
   #
   #   r = Response.new(response, web_urls_relative_to: "https://www.gov.uk")
-  #   r.results[0].web_url
+  #   r['results'][0]['web_url']
   #   => "/bank-holidays"
   class Response
     extend Forwardable
@@ -71,12 +71,16 @@ module GdsApi
     end
 
     def to_hash
-      @parsed ||= transform_parsed(JSON.parse(@http_response.body))
+      parsed_content
+    end
+
+    def parsed_content
+      @parsed_content ||= transform_parsed(JSON.parse(@http_response.body))
     end
 
     def to_ostruct
       raise NoMethodError if GdsApi.config.hash_response_for_requests
-      @ostruct ||= self.class.build_ostruct_recursively(to_hash)
+      @ostruct ||= self.class.build_ostruct_recursively(parsed_content)
     end
 
     def method_missing(method_sym, *arguments, &block)

data/lib/gds_api/test_helpers/rummager.rb

@@ -38,6 +38,18 @@ module GdsApi
         end
       end
 
+      def stub_any_rummager_search
+        stub_request(:get, %r{#{RUMMAGER_ENDPOINT}/search.json})
+      end
+
+      def stub_any_rummager_search_to_return_no_results
+        stub_any_rummager_search.to_return(body: { results: [] }.to_json)
+      end
+
+      def assert_rummager_search(options)
+        assert_requested :get, "#{RUMMAGER_ENDPOINT}/search.json", **options
+      end
+
       def stub_any_rummager_delete(index: nil)
         if index
           stub_request(:delete, %r{#{RUMMAGER_ENDPOINT}/#{index}/documents/.*})

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '36.4.1'
+  VERSION = '37.0.0'.freeze
 end

data/test/asset_manager_test.rb

@@ -22,14 +22,6 @@ describe GdsApi::AssetManager do
     }
   }
 
-  before do
-    GdsApi.config.always_raise_for_not_found = true
-  end
-
-  after do
-    GdsApi.config.always_raise_for_not_found = false
-  end
-
   it "creates an asset with a file" do
     req = stub_request(:post, "#{base_api_url}/assets").
       with(:body => %r{Content\-Disposition: form\-data; name="asset\[file\]"; filename="hello\.txt"\r\nContent\-Type: text/plain}).
@@ -37,7 +29,7 @@ describe GdsApi::AssetManager do
 
     response = api.create_asset(:file => file_fixture)
 
-    assert_equal asset_url, response.asset.id
+    assert_equal asset_url, response['asset']['id']
     assert_requested(req)
   end
 
@@ -67,16 +59,16 @@ describe GdsApi::AssetManager do
 
       response = api.update_asset(asset_id, :file => file_fixture)
 
-      assert_equal "#{base_api_url}/assets/#{asset_id}", response.asset.id
+      assert_equal "#{base_api_url}/assets/#{asset_id}", response['asset']['id']
       assert_requested(req)
     end
 
     it "retrieves an asset" do
       asset = api.asset(asset_id)
 
-      assert_equal "photo.jpg", asset.name
-      assert_equal "image/jpeg", asset.content_type
-      assert_equal "http://fooey.gov.uk/media/photo.jpg", asset.file_url
+      assert_equal "photo.jpg", asset['name']
+      assert_equal "image/jpeg", asset['content_type']
+      assert_equal "http://fooey.gov.uk/media/photo.jpg", asset['file_url']
     end
   end
 
@@ -86,7 +78,7 @@ describe GdsApi::AssetManager do
 
     response = api.delete_asset(asset_id)
 
-    assert_equal "#{base_api_url}/assets/#{asset_id}", response.asset.id
+    assert_equal "#{base_api_url}/assets/#{asset_id}", response['asset']['id']
     assert_requested(req)
   end
 end

data/test/content_api_test.rb

@@ -32,10 +32,13 @@ describe GdsApi::ContentApi do
       content_api_has_an_artefact("bank-holidays", artefact_response)
       artefact = @api.artefact("bank-holidays")
 
-      assert_equal "Bank holidays", artefact.title
-      assert_equal "/bank-holidays", artefact.web_url
+      assert_equal "Bank holidays", artefact['title']
+      assert_equal "/bank-holidays", artefact['web_url']
 
-      assert_equal "/browse/cheese", artefact.tags[0].content_with_tag.web_url
+      assert_equal(
+        "/browse/cheese",
+        artefact['tags'][0]['content_with_tag']['web_url']
+      )
     end
 
     it "should use relative URLs for tag listings" do
@@ -44,7 +47,7 @@ describe GdsApi::ContentApi do
 
       assert_equal 3, tags.count
       tags.each do |tag|
-        web_url = tag.content_with_tag.web_url
+        web_url = tag['content_with_tag']['web_url']
         assert web_url.start_with?("/browse/"), web_url
       end
     end
@@ -60,12 +63,15 @@ describe GdsApi::ContentApi do
         artefact_response["web_url"] = "http://www.test.gov.uk/bank-holidays"
         content_api_has_an_artefact("bank-holidays", artefact_response)
 
-        assert_equal "/bank-holidays", @api.artefact("bank-holidays").web_url
+        assert_equal "/bank-holidays", @api.artefact("bank-holidays")['web_url']
 
         clean_api = GdsApi::ContentApi.new(@base_api_url)
         clean_artefact = clean_api.artefact("bank-holidays")
 
-        assert_equal "http://www.test.gov.uk/bank-holidays", clean_artefact.web_url
+        assert_equal(
+          "http://www.test.gov.uk/bank-holidays",
+          clean_artefact['web_url']
+        )
       end
 
       after do
@@ -85,7 +91,10 @@ describe GdsApi::ContentApi do
 
       # Also check attribute access
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/sections/crime.json", first_section.id
+      assert_equal(
+        "#{@base_api_url}/tags/sections/crime.json",
+        first_section['id']
+      )
     end
 
     def section_page_url(page_parameter)
@@ -134,7 +143,10 @@ describe GdsApi::ContentApi do
 
       sections = @api.sections
       assert_equal 20, sections.with_subsequent_pages.count
-      assert_equal "Section 20", sections.with_subsequent_pages.to_a.last.title
+      assert_equal(
+        "Section 20",
+        sections.with_subsequent_pages.to_a.last['title']
+      )
     end
 
     it "should iterate across three or more pages" do
@@ -144,7 +156,10 @@ describe GdsApi::ContentApi do
 
       sections = @api.sections
       assert_equal 30, sections.with_subsequent_pages.count
-      assert_equal "Section 30", sections.with_subsequent_pages.to_a.last.title
+      assert_equal(
+        "Section 30",
+        sections.with_subsequent_pages.to_a.last['title']
+      )
     end
 
     it "should not load a page multiple times" do
@@ -225,7 +240,10 @@ describe GdsApi::ContentApi do
 
       response = @api.artefacts
       assert_equal 4, response.count
-      assert_equal %w(answer local_transaction place guide), response.map(&:format)
+      assert_equal(
+        %w(answer local_transaction place guide),
+        response.map { |item| item['format'] }
+      )
     end
 
     it "should work with a paginated response" do
@@ -257,7 +275,10 @@ describe GdsApi::ContentApi do
         )
       response = @api.artefacts
       assert_equal 7, response.with_subsequent_pages.count
-      assert_equal "http://www.test.gov.uk/vat2", response.with_subsequent_pages.to_a.last.web_url
+      assert_equal(
+        "http://www.test.gov.uk/vat2",
+        response.with_subsequent_pages.to_a.last['web_url']
+      )
     end
   end
 
@@ -272,8 +293,18 @@ describe GdsApi::ContentApi do
       response = @api.for_need(100123)
 
       assert_equal 3, response.count
-      assert_equal ["http://www.gov.uk/burrito", "http://www.gov.uk/burrito-standard", "http://www.gov.uk/local-burrito-place" ], response.map(&:web_url)
-      assert_equal ["answer", "guide", "transaction" ], response.map(&:format)
+      assert_equal(
+        [
+          "http://www.gov.uk/burrito",
+          "http://www.gov.uk/burrito-standard",
+          "http://www.gov.uk/local-burrito-place"
+        ],
+        response.map { |item| item['web_url'] }
+      )
+      assert_equal(
+        %w(answer guide transaction),
+        response.map { |item| item['format'] }
+      )
     end
   end
 
@@ -288,7 +319,10 @@ describe GdsApi::ContentApi do
 
       # Also check attribute access
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/authors/justin-thyme.json", first_section.id
+      assert_equal(
+        "#{@base_api_url}/tags/authors/justin-thyme.json",
+        first_section['id']
+      )
     end
 
     it "returns a sorted list of tags of a given type" do
@@ -296,17 +330,29 @@ describe GdsApi::ContentApi do
       response = @api.tags("author", sort: "alphabetical")
 
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/authors/justin-thyme.json", first_section.id
+      assert_equal(
+        "#{@base_api_url}/tags/authors/justin-thyme.json",
+        first_section['id']
+      )
     end
 
     it "returns draft tags if requested" do
       content_api_has_draft_and_live_tags(type: "specialist", draft: ["draft-tag-1"], live: ["live-tag-1"])
 
       all_tags = @api.tags("specialist", draft: true)
-      assert_equal [["draft-tag-1", "draft"], ["live-tag-1", "live"]].to_set, all_tags.map {|t| [t.slug, t.state] }.to_set
+      assert_equal(
+        [
+          ["draft-tag-1", "draft"],
+          ["live-tag-1", "live"]
+        ].to_set,
+        all_tags.map { |t| [t['slug'], t['state']] }.to_set
+      )
 
       live_tags = @api.tags("specialist")
-      assert_equal [["live-tag-1", "live"]], live_tags.map {|t| [t.slug, t.state] }
+      assert_equal(
+        [["live-tag-1", "live"]],
+        live_tags.map { |t| [t['slug'], t['state']] }
+      )
     end
 
     it "returns a list of root tags of a given type" do
@@ -319,7 +365,10 @@ describe GdsApi::ContentApi do
 
       # Also check attribute access
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/authors/oliver-sudden.json", first_section.id
+      assert_equal(
+        "#{@base_api_url}/tags/authors/oliver-sudden.json",
+        first_section['id']
+      )
     end
 
     it "returns a list of child tags of a given type" do
@@ -332,7 +381,10 @@ describe GdsApi::ContentApi do
 
       # Also check attribute access
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/genres/indie%2Findie-rock.json", first_section.id
+      assert_equal(
+        "#{@base_api_url}/tags/genres/indie%2Findie-rock.json",
+        first_section['id']
+      )
     end
 
     it "returns a sorted list of child tags of a given type" do
@@ -340,7 +392,10 @@ describe GdsApi::ContentApi do
       response = @api.child_tags("genre", "indie", sort: "alphabetical")
 
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/genres/indie%2Findie-rock.json", first_section.id
+      assert_equal(
+        "#{@base_api_url}/tags/genres/indie%2Findie-rock.json",
+        first_section['id']
+      )
     end
 
     it "returns tag information for a section" do
@@ -411,14 +466,16 @@ describe GdsApi::ContentApi do
   end
 
   describe "local authorities" do
-    it "should return nil if no local authority found" do
+    it "should raise if no local authority found" do
       stub_request(:get, "#{@base_api_url}/local_authorities/does-not-exist.json").
         with(:headers => GdsApi::JsonClient.default_request_headers).
         to_return(:status => 404,
                   :body => {"_response_info" => {"status" => "ok"}}.to_json,
                   :headers => {})
 
-      assert_nil @api.local_authority("does-not-exist")
+      assert_raises(GdsApi::HTTPNotFound) do
+        @api.local_authority("does-not-exist")
+      end
     end
 
     it "should produce a LocalAuthority hash for an existing snac code" do
@@ -602,19 +659,37 @@ describe GdsApi::ContentApi do
       content_api_has_licence :licence_identifier => "AB1234", :title => 'Test Licence 3', :slug => 'test-licence-3',
         :licence_short_description => 'A short description'
 
-      results = @api.licences_for_ids([1234, 'AB1234', 'something']).to_ostruct.results
+      results = @api.licences_for_ids([1234, 'AB1234', 'something'])['results']
       assert_equal 2, results.size
-      assert_equal ['1234', 'AB1234'], results.map { |r| r.details.licence_identifier }
-      assert_equal ['Test Licence 1', 'Test Licence 3'], results.map(&:title).sort
-      assert_equal ['http://www.test.gov.uk/test-licence-1', 'http://www.test.gov.uk/test-licence-3'], results.map(&:web_url).sort
-      assert_equal 'A short description', results[0].details.licence_short_description
-      assert_equal 'A short description', results[1].details.licence_short_description
+      assert_equal(
+        %w(1234 AB1234),
+        results.map { |r| r['details']['licence_identifier'] }
+      )
+      assert_equal(
+        ['Test Licence 1', 'Test Licence 3'],
+        results.map { |item| item['title'] }.sort
+      )
+      assert_equal(
+        [
+          'http://www.test.gov.uk/test-licence-1',
+          'http://www.test.gov.uk/test-licence-3'
+        ],
+        results.map { |item| item['web_url'] }.sort
+      )
+      assert_equal(
+        'A short description',
+        results[0]['details']['licence_short_description']
+      )
+      assert_equal(
+        'A short description',
+        results[1]['details']['licence_short_description']
+      )
     end
 
     it "should return empty array with no licences" do
       setup_content_api_licences_stubs
 
-      assert_equal [], @api.licences_for_ids([123,124]).to_ostruct.results
+      assert_equal [], @api.licences_for_ids([123, 124])['results']
     end
 
     it "should raise an error if publisher returns an error" do
@@ -622,7 +697,7 @@ describe GdsApi::ContentApi do
         to_return(:status => [503, "Service temporarily unabailable"])
 
       assert_raises GdsApi::HTTPServerError do
-        @api.licences_for_ids([123,124])
+        @api.licences_for_ids([123, 124])
       end
     end
   end