gds-api-adapters 11.5.0 → 11.6.0

data/lib/gds_api/content_api.rb

@@ -26,16 +26,27 @@ class GdsApi::ContentApi < GdsApi::Base
     child_tags("section", parent_tag)
   end
 
-  def tags(tag_type)
-    get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}")
+  def tags(tag_type, options={})
+    params = [
+      "type=#{CGI.escape(tag_type)}"
+    ]
+    params << "sort=#{options[:sort]}" if options.has_key?(:sort)
+
+    get_list!("#{base_url}/tags.json?#{params.join('&')}")
   end
 
   def root_tags(tag_type)
     get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}&root_sections=true")
   end
 
-  def child_tags(tag_type, parent_tag)
-    get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}&parent_id=#{CGI.escape(parent_tag)}")
+  def child_tags(tag_type, parent_tag, options={})
+    params = [
+      "type=#{CGI.escape(tag_type)}",
+      "parent_id=#{CGI.escape(parent_tag)}",
+    ]
+    params << "sort=#{options[:sort]}" if options.has_key?(:sort)
+
+    get_list!("#{base_url}/tags.json?#{params.join('&')}")
   end
 
   def tag(tag, tag_type=nil)

data/lib/gds_api/test_helpers/content_api.rb

@@ -80,6 +80,15 @@ module GdsApi
         stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
       end
 
+      def content_api_has_sorted_tags(tag_type, sort_order, slugs_or_tags)
+        body = plural_response_base.merge(
+          "results" => slugs_or_tags.map { |tag| tag_result(tag, tag_type) }
+        )
+
+        url = "#{CONTENT_API_ENDPOINT}/tags.json?sort=#{sort_order}&type=#{tag_type}"
+        stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
+      end
+
       def content_api_has_child_tags(tag_type, parent_slug_or_hash, child_tag_ids)
         parent_tag = tag_hash(parent_slug_or_hash, tag_type)
         child_tags = child_tag_ids.map { |id|
@@ -92,6 +101,19 @@ module GdsApi
         stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
       end
 
+      def content_api_has_sorted_child_tags(tag_type, parent_slug_or_hash, sort_order, child_tag_ids)
+        parent_tag = tag_hash(parent_slug_or_hash, tag_type)
+        child_tags = child_tag_ids.map { |id|
+          tag_hash(id, tag_type).merge(parent: parent_tag)
+        }
+        body = plural_response_base.merge(
+          "results" => child_tags.map { |s| tag_result(s, tag_type) }
+        )
+
+        url = "#{CONTENT_API_ENDPOINT}/tags.json?parent_id=#{CGI.escape(parent_tag[:slug])}&sort=#{sort_order}&type=#{tag_type}"
+        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=[])
         body = plural_response_base.merge(
           "results" => artefact_slugs.map do |artefact_slug|

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '11.5.0'
+  VERSION = '11.6.0'
 end

data/test/content_api_test.rb

@@ -291,6 +291,14 @@ describe GdsApi::ContentApi do
       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
+      content_api_has_sorted_tags("author", "alphabetical", ["justin-thyme"])
+      response = @api.tags("author", sort: "alphabetical")
+
+      first_section = response.first
+      assert_equal "#{@base_api_url}/tags/authors/justin-thyme.json", first_section.id
+    end
+
     it "returns a list of root tags of a given type" do
       content_api_has_root_tags("author", ["oliver-sudden", "percy-vere"])
       response = @api.root_tags("author")
@@ -317,6 +325,14 @@ describe GdsApi::ContentApi do
       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
+      content_api_has_sorted_child_tags("genre", "indie", "alphabetical", ["indie/indie-rock"])
+      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
+    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")

data/test/rummager_test.rb

@@ -167,6 +167,16 @@ describe GdsApi::Rummager do
     end
   end
 
+  it "#unified_search should raise an exception if the service at the unified search URI returns a 422" do
+    stub_request(:get, /example.com\/unified_search/).to_return(
+      status: [422, "Bad Request"],
+      body: %q("error":"Filtering by \"coffee\" is not allowed"),
+    )
+    assert_raises(GdsApi::HTTPErrorResponse) do
+      GdsApi::Rummager.new("http://example.com").unified_search(q: "query", filter_coffee: "tea")
+    end
+  end
+
   it "#unified_search should raise an exception if the service at the search URI times out" do
     stub_request(:get, /example.com\/unified_search/).to_timeout
     assert_raises(GdsApi::TimedOutException) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 11.5.0
+  version: 11.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -385,7 +385,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -724725384917283612
+      hash: 713806713155441280
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -394,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -724725384917283612
+      hash: 713806713155441280
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23