gds-api-adapters 34.1.0 → 35.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43d2b87fd0e5761a6e0f58ba5cf043625d32ba1f
-  data.tar.gz: 2806a9f5c8d029e6f1de2dd040f6b2f437b68333
+  metadata.gz: 3de808a31aebeb02fcb1731a56452fac86864c84
+  data.tar.gz: 89d5c19db3a0a4c9558a2817bc01b77315fcf58f
 SHA512:
-  metadata.gz: 0a44f33186db19f7f1c30b11d1e9fb6bd1cf9bbd31dbe3209150c8b67650c6b681df303bec317775fb127b4b3690a6686a9b90748ebcdc91d65e3518d4dfcd37
-  data.tar.gz: 6289d4f548c633be92764965903deb86955921c971e29f9dc45e87f755090cf9978b2ec7ad9eecf1ca50a200ba18dde19940489259e576962a8f20291fc6574f
+  metadata.gz: 0aa623216d9876b2c935af07011504a32169b1199eb071bfd68090f43de2aaa1cbde4feeaf3288bae53e9e30485076ecf7b952ae5c73d882cef6be3f589ab546
+  data.tar.gz: 0048a9e7a5cd71b3d832c3d1cdae804b59557b06e835ae1efe4b12133a2e503d2975fc4fd5cebf28ef1124cd827e1f81f3e7380ea6758047d8a85ca3b6d5bf21

data/lib/gds_api/content_api.rb

@@ -60,28 +60,6 @@ class GdsApi::ContentApi < GdsApi::Base
     get_json(url)
   end
 
-  def with_tag(tag, tag_type=nil, options={})
-    tag_key = key_for_tag_type(tag_type)
-
-    url = "#{base_url}/with_tag.json?#{tag_key}=#{CGI.escape(tag)}"
-    url << "&group_by=#{CGI.escape(options[:group_by])}" if options.has_key?(:group_by)
-    url << "&draft=true" if options[:draft]
-
-    get_list!(url)
-  end
-
-  def curated_list(tag, tag_type=nil)
-    tag_key = key_for_tag_type(tag_type)
-
-    get_list("#{base_url}/with_tag.json?#{tag_key}=#{CGI.escape(tag)}&sort=curated")
-  end
-
-  def sorted_by(tag, sort_by, tag_type=nil)
-    tag_key = key_for_tag_type(tag_type)
-
-    get_list!("#{base_url}/with_tag.json?#{tag_key}=#{CGI.escape(tag)}&sort=#{sort_by}")
-  end
-
   def for_need(need_id)
     get_list("#{base_url}/for_need/#{CGI.escape(need_id.to_s)}.json")
   end

data/lib/gds_api/test_helpers/content_api.rb

@@ -29,10 +29,6 @@ module GdsApi
         content_api_has_child_tags("section", parent_slug_or_hash, subsection_slugs)
       end
 
-      def content_api_has_artefacts_in_a_section(slug, artefact_slugs=nil)
-        content_api_has_artefacts_with_a_tag("section", slug, artefact_slugs)
-      end
-
       def artefact_for_slug_in_a_section(slug, section_slug)
         artefact_for_slug_with_a_tag("section", slug, section_slug)
       end
@@ -41,7 +37,6 @@ module GdsApi
         artefact_for_slug_with_a_child_tag("section", slug, subsection_slug)
       end
 
-
       # Takes an array of slugs, or hashes with section details (including a slug).
       # Will stub out content_api calls for tags of type section to return these sections
       def content_api_has_root_tags(tag_type, slugs_or_tags)
@@ -154,106 +149,6 @@ module GdsApi
         stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
       end
 
-      def content_api_has_artefacts_with_a_tag(tag_type, slug, artefact_slugs=[], options={tag: {}, artefact: {}})
-        if options.has_key?(:draft)
-          puts "Passing a key of :draft outside of the 'tag' options hash is being deprecated. Please use tag: { draft: bool }"
-        end
-
-        draft = options[:draft] || (options[:tag] && options[:tag][:draft])
-
-        body = plural_response_base.merge(
-          "results" => artefact_slugs.map do |artefact_slug|
-            artefact_for_slug(artefact_slug, options.fetch(:artefact, {}))
-          end
-        )
-
-        endpoint = "#{CONTENT_API_ENDPOINT}/with_tag.json"
-        resp = { status: 200, body: body.to_json, headers: {} }
-
-        unless draft
-          stub_request(:get, endpoint)
-            .with(:query => { tag_type => slug })
-            .to_return(resp)
-
-          if tag_type == "section"
-            stub_request(:get, endpoint)
-              .with(:query => { "tag" => slug })
-              .to_return(resp)
-          end
-        end
-
-        stub_request(:get, endpoint)
-          .with(:query => { tag_type => slug, "draft" => "true" })
-          .to_return(resp)
-
-        if tag_type == "section"
-          stub_request(:get, endpoint)
-            .with(:query => { "tag" => slug, "draft" => "true" })
-            .to_return(resp)
-        end
-
-        sort_orders = ["alphabetical", "curated"]
-        sort_orders.each do |order|
-          unless draft
-            stub_request(:get, endpoint)
-              .with(:query => { tag_type => slug, "sort" => order })
-              .to_return(resp)
-
-            if tag_type == "section"
-              stub_request(:get, endpoint)
-                .with(:query => { "tag" => slug, "sort" => order })
-                .to_return(resp)
-            end
-          end
-
-          stub_request(:get, endpoint)
-            .with(:query => { tag_type => slug, "sort" => order, "draft" => "true" })
-            .to_return(resp)
-
-          if tag_type == "section"
-            stub_request(:get, endpoint)
-              .with(:query => { "tag" => slug, "sort" => order, "draft" => "true" })
-              .to_return(resp)
-          end
-        end
-      end
-
-      def content_api_has_artefacts_with_a_draft_tag(tag_type, slug, artefact_slugs=[])
-        content_api_has_artefacts_with_a_tag(tag_type, slug, artefact_slugs, tag: {draft: true})
-      end
-
-      def content_api_has_sorted_artefacts_with_a_tag(tag_type, slug, sort_order, artefact_slugs=[])
-        body = plural_response_base.merge(
-          "results" => artefact_slugs.map do |artefact_slug|
-            artefact_for_slug(artefact_slug)
-          end
-        )
-
-        endpoint = "#{CONTENT_API_ENDPOINT}/with_tag.json"
-        stub_request(:get, endpoint)
-          .with(:query => { tag_type => slug, "sort" => sort_order })
-          .to_return(status: 200, body: body.to_json, headers: {})
-      end
-
-      def content_api_has_grouped_artefacts_with_a_tag(tag_type, tag_id, group_by, grouped_artefact_slugs={})
-        body = plural_response_base.merge(
-          "grouped_results" => grouped_artefact_slugs.map {|name,artefact_slugs|
-            {
-              "name" => name,
-              "formats" => [name.downcase],
-              "items" => artefact_slugs.map {|artefact_slug|
-                artefact_for_slug(artefact_slug)
-              }
-            }
-          }
-        )
-
-        endpoint = "#{CONTENT_API_ENDPOINT}/with_tag.json"
-        stub_request(:get, endpoint)
-          .with(:query => { tag_type => tag_id, "group_by" => group_by })
-          .to_return(status: 200, body: body.to_json, headers: {})
-      end
-
       def content_api_has_an_artefact(slug, body = artefact_for_slug(slug))
         ArtefactStub.new(slug).with_response_body(body).stub
       end

data/lib/gds_api/test_helpers/content_item_helpers.rb

@@ -18,6 +18,19 @@ module GdsApi
         }
       end
 
+      def gone_content_item_for_base_path(base_path)
+        {
+          "title" => nil,
+          "description" => nil,
+          "format" => "gone",
+          "schema_name" => "gone",
+          "public_updated_at" => nil,
+          "base_path" => base_path,
+          "withdrawn_notice" => {},
+          "details" => {}
+        }
+      end
+
       def titleize_base_path(base_path, options = {})
         if options[:title_case]
           base_path.gsub("-", " ").gsub(/\b./) {|m| m.upcase }

data/lib/gds_api/test_helpers/content_store.rb

@@ -43,6 +43,41 @@ module GdsApi
         stub_request(:get, url).to_return(status: 404, headers: {})
       end
 
+      # Content store has gone item
+      #
+      # Stubs a content item in the content store to respond with 410 HTTP Status Code and response body with 'format' set to 'gone'.
+      #
+      # @param base_path [String]
+      # @param body [Hash]
+      # @param options [Hash]
+      # @option options [String] draft Will point to the draft content store if set to true
+      #
+      # @example
+      #
+      #   content_store.content_store_has_gone_item('/sample-slug')
+      #
+      #   # Will return HTTP Status Code 410 and the following response body:
+      #   {
+      #     "title" => nil,
+      #     "description" => nil,
+      #     "format" => "gone",
+      #     "schema_name" => "gone",
+      #     "public_updated_at" => nil,
+      #     "base_path" => "/sample-slug",
+      #     "withdrawn_notice" => {},
+      #     "details" => {}
+      #   }
+      def content_store_has_gone_item(base_path, body = gone_content_item_for_base_path(base_path), options = {})
+        url = content_store_endpoint(options[:draft]) + "/content" + base_path
+        body = body.to_json unless body.is_a?(String)
+
+        stub_request(:get, url).to_return(
+          status: 410,
+          body: body,
+          headers: {}
+        )
+      end
+
       def content_store_isnt_available
         stub_request(:any, /#{content_store_endpoint}\/.*/).to_return(:status => 503)
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '34.1.0'
+  VERSION = '35.0.0'
 end

data/test/content_api_test.rb

@@ -343,25 +343,6 @@ describe GdsApi::ContentApi do
       assert_equal "#{@base_api_url}/tags/genres/indie%2Findie-rock.json", first_section.id
     end
 
-    it "returns artefacts given a section" do
-      content_api_has_artefacts_in_a_section("crime-and-justice", ["complain-about-a-claims-company"])
-      response = @api.with_tag("crime-and-justice")
-
-      # Old dictionary-style access
-      subsection = response["results"][0]
-      assert_equal "Complain about a claims company", subsection["title"]
-
-      # Attribute access
-      assert_equal "Complain about a claims company", response.first.title
-    end
-
-    it "returns artefacts given a tag and tag type" do
-      content_api_has_artefacts_with_a_tag("genre", "reggae", ["three-little-birds"])
-      response = @api.with_tag("reggae", "genre")
-
-      assert_equal "Three little birds", response.first.title
-    end
-
     it "returns tag information for a section" do
       content_api_has_section("crime-and-justice")
       response = @api.tag("crime-and-justice", "section")
@@ -376,58 +357,6 @@ describe GdsApi::ContentApi do
       assert_equal "Reggae", response['title']
     end
 
-    it "returns artefacts in curated list order for a section" do
-      content_api_has_artefacts_in_a_section("crime-and-justice", ["complain-about-a-claims-company"])
-      response = @api.curated_list("crime-and-justice")
-
-      assert_equal "Complain about a claims company", response.first.title
-    end
-
-    it "returns artefacts in curated list order for a tag and tag type" do
-      content_api_has_artefacts_with_a_tag("genre", "reggae", ["buffalo-soldier"])
-      response = @api.curated_list("reggae", "genre")
-
-      assert_equal "Buffalo soldier", response.first.title
-    end
-
-    it "returns artefacts for a tag in a given sort order" do
-      content_api_has_artefacts_in_a_section("crime-and-justice", ["complain-about-a-claims-company"])
-      response = @api.sorted_by("crime-and-justice", "alphabetical")
-
-      assert_equal "Complain about a claims company", response.first.title
-    end
-
-    it "returns artefacts in a given sort order for a tag and tag type" do
-      content_api_has_sorted_artefacts_with_a_tag("genre", "reggae", "foo", ["is-this-love"])
-      response = @api.sorted_by("reggae", "foo", "genre")
-
-      assert_equal "Is this love", response.first.title
-    end
-
-    it "returns artefacts in groups for a tag and tag type" do
-      content_api_has_grouped_artefacts_with_a_tag(
-        "genre",
-        "reggae",
-        "format",
-        {
-          "Tracks" => ["is-this-love", "three-little-birds"],
-          "Albums" => ["kaya", "exodus"],
-        }
-      )
-      response = @api.with_tag("reggae", "genre", group_by: "format")
-
-      # expect two groups to be returned
-      assert_equal 2, response.results.size
-
-      assert_equal 2, response.results[0].items.size
-      assert_equal "Is this love", response.results[0].items[0].title
-      assert_equal "Three little birds", response.results[0].items[1].title
-
-      assert_equal 2, response.results[1].items.size
-      assert_equal "Kaya", response.results[1].items[0].title
-      assert_equal "Exodus", response.results[1].items[1].title
-    end
-
     it "permits cache busting" do
       content_api_has_tags("specialist_sector", ["oil-and-gas/licensing"])
 

data/test/content_store_test.rb

@@ -41,6 +41,28 @@ describe GdsApi::ContentStore do
         config.always_raise_for_not_found = false
       end
     end
+
+    it "returns nil if the item is gone" do
+      content_store_has_gone_item("/it-is-gone")
+
+      assert_nil @api.content_item("/it-is-gone")
+    end
+
+    it "raises if the item is gone and `always_raise_for_not_found` enabled" do
+      GdsApi.configure do |config|
+        config.always_raise_for_not_found = true
+      end
+
+      content_store_has_gone_item("/it-is-gone")
+
+      assert_raises GdsApi::HTTPGone do
+        @api.content_item("/it-is-gone")
+      end
+
+      GdsApi.configure do |config|
+        config.always_raise_for_not_found = false
+      end
+    end
   end
 
   describe "#content_item!" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 34.1.0
+  version: 35.0.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek