gds-api-adapters 7.25.0 → 8.0.0

data/lib/gds_api/content_api.rb

@@ -16,31 +16,55 @@ class GdsApi::ContentApi < GdsApi::Base
   end
 
   def sections
-    get_list!("#{base_url}/tags.json?type=section")
+    tags("section")
   end
 
   def root_sections
-    get_list!("#{base_url}/tags.json?type=section&root_sections=true")
+    root_tags("section")
   end
 
   def sub_sections(parent_tag)
-    get_list!("#{base_url}/tags.json?type=section&parent_id=#{CGI.escape(parent_tag)}")
+    child_tags("section", parent_tag)
   end
 
-  def tag(tag)
-    get_json("#{base_url}/tags/#{CGI.escape(tag)}.json")
+  def tags(tag_type)
+    get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}")
   end
 
-  def with_tag(tag)
-    get_list!("#{base_url}/with_tag.json?tag=#{CGI.escape(tag)}&include_children=1")
+  def root_tags(tag_type)
+    get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}&root_sections=true")
   end
 
-  def curated_list(tag)
-    get_list("#{base_url}/with_tag.json?tag=#{CGI.escape(tag)}&sort=curated")
+  def child_tags(tag_type, parent_tag)
+    get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}&parent_id=#{CGI.escape(parent_tag)}")
   end
 
-  def sorted_by(tag, sort_by)
-    get_list!("#{base_url}/with_tag.json?tag=#{CGI.escape(tag)}&sort=#{sort_by}")
+  def tag(tag, tag_type=nil)
+    url = "#{base_url}/tags"
+
+    if tag_type
+      url << "/#{CGI.escape(tag_type)}"
+    end
+
+    get_json("#{url}/#{CGI.escape(tag)}.json")
+  end
+
+  def with_tag(tag, tag_type=nil)
+    tag_key = key_for_tag_type(tag_type)
+
+    get_list!("#{base_url}/with_tag.json?#{tag_key}=#{CGI.escape(tag)}&include_children=1")
+  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)
@@ -141,4 +165,8 @@ class GdsApi::ContentApi < GdsApi::Base
         batch_response
       end
     end
+
+    def key_for_tag_type(tag_type)
+      tag_type.nil? ? "tag" : CGI.escape(tag_type)
+    end
 end

data/lib/gds_api/test_helpers/content_api.rb

@@ -13,10 +13,22 @@ module GdsApi
       # 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_sections(slugs_or_sections)
+        content_api_has_root_tags("section", slugs_or_sections)
+      end
+
+      def content_api_has_section(slug_or_hash, parent_slug=nil)
+        content_api_has_tag("section", slug_or_hash, parent_slug)
+      end
+
+      def content_api_has_subsections(parent_slug_or_hash, subsection_slugs)
+        content_api_has_child_tags("section", parent_slug_or_hash, subsection_slugs)
+      end
+
+      def content_api_has_root_tags(tag_type, slugs_or_tags)
         body = plural_response_base.merge(
-          "results" => slugs_or_sections.map { |section| tag_result(section) }
+          "results" => slugs_or_tags.map { |tag| tag_result(tag, tag_type) }
         )
-        urls = ["type=section", "root_sections=true&type=section"].map { |q|
+        urls = ["type=#{tag_type}", "root_sections=true&type=#{tag_type}"].map { |q|
           "#{CONTENT_API_ENDPOINT}/tags.json?#{q}"
         }
         urls.each do |url|
@@ -24,10 +36,39 @@ module GdsApi
         end
       end
 
-      def content_api_has_section(slug_or_hash, parent_slug=nil)
-        section = tag_hash(slug_or_hash).merge(parent: parent_slug)
+      def content_api_has_tag(tag_type, slug_or_hash, parent_slug=nil)
+        section = tag_hash(slug_or_hash, tag_type).merge(parent: parent_slug)
         body = tag_result(section)
-        url = "#{CONTENT_API_ENDPOINT}/tags/#{CGI.escape(section[:slug])}.json"
+
+        urls = ["#{CONTENT_API_ENDPOINT}/tags/#{CGI.escape(tag_type)}/#{CGI.escape(section[:slug])}.json"]
+
+        if tag_type == "section"
+          urls << "#{CONTENT_API_ENDPOINT}/tags/#{CGI.escape(section[:slug])}.json"
+        end
+
+        urls.each do |url|
+          stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
+        end
+      end
+
+      def content_api_has_tags(tag_type, 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?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, subsection_slugs)
+        parent_section = tag_hash(parent_slug_or_hash, tag_type)
+        subsections = subsection_slugs.map { |s|
+          tag_hash(s, tag_type).merge(parent: parent_section)
+        }
+        body = plural_response_base.merge(
+          "results" => subsections.map { |s| tag_result(s, tag_type) }
+        )
+        url = "#{CONTENT_API_ENDPOINT}/tags.json?type=#{tag_type}&parent_id=#{CGI.escape(parent_section[:slug])}"
         stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
       end
 
@@ -44,18 +85,6 @@ module GdsApi
         end
       end
 
-      def content_api_has_subsections(parent_slug_or_hash, subsection_slugs)
-        parent_section = tag_hash(parent_slug_or_hash)
-        subsections = subsection_slugs.map { |s|
-          tag_hash(s).merge(parent: parent_section)
-        }
-        body = plural_response_base.merge(
-          "results" => subsections.map { |s| tag_result(s) }
-        )
-        url = "#{CONTENT_API_ENDPOINT}/tags.json?type=section&parent_id=#{CGI.escape(parent_section[:slug])}"
-        stub_request(:get, url).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
@@ -195,21 +224,22 @@ module GdsApi
       end
 
       # Construct a tag hash suitable for passing into tag_result
-      def tag_hash(slug_or_hash)
+      def tag_hash(slug_or_hash, tag_type = "section")
         if slug_or_hash.is_a?(Hash)
           slug_or_hash
         else
-          { slug: slug_or_hash, type: "section" }
+          { slug: slug_or_hash, type: tag_type }
         end
       end
 
-      def tag_result(slug_or_hash)
-        tag = tag_hash(slug_or_hash)
+      def tag_result(slug_or_hash, tag_type = nil)
+        tag = tag_hash(slug_or_hash, tag_type)
 
         parent = tag_result(tag[:parent]) if tag[:parent]
+        pluralized_tag_type = simple_tag_type_pluralizer(tag[:type])
 
         {
-          "id" => "#{CONTENT_API_ENDPOINT}/tags/#{CGI.escape(tag[:slug])}.json",
+          "id" => "#{CONTENT_API_ENDPOINT}/tags/#{CGI.escape(pluralized_tag_type)}/#{CGI.escape(tag[:slug])}.json",
           "web_url" => nil,
           "title" => tag[:title] || titleize_slug(tag[:slug].split("/").last),
           "details" => {
@@ -225,6 +255,19 @@ module GdsApi
         }
       end
 
+      # This is a nasty hack to get around the pluralized slugs in tag paths
+      # without having to require ActiveSupport
+      #
+      def simple_tag_type_pluralizer(s)
+        case s
+        when /o\Z/ then s.sub(/o\Z/, "es")
+        when /y\Z/ then s.sub(/y\Z/, "ies")
+        when /ss\Z/ then s.sub(/ss\Z/, "sses")
+        else
+          "#{s}s"
+        end
+      end
+
       def setup_content_api_business_support_schemes_stubs
         @stubbed_content_api_business_support_schemes = []
         stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/business_support_schemes\.json}).to_return do |request|
@@ -281,7 +324,7 @@ module GdsApi
             valid_licences = @stubbed_content_api_licences.select { |l| ids.include? l[:licence_identifier] }
             {
               :body => {
-                'results' => valid_licences.map { |licence| 
+                'results' => valid_licences.map { |licence|
                   content_api_licence_hash(licence[:licence_identifier], licence)
                 }
               }.to_json

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.25.0'
+  VERSION = '8.0.0'
 end

data/test/content_api_test.rb

@@ -81,11 +81,11 @@ describe GdsApi::ContentApi do
 
       # Old-style dictionary access
       first_section = response["results"][0]
-      assert_equal "#{@base_api_url}/tags/crime.json", first_section["id"]
+      assert_equal "#{@base_api_url}/tags/sections/crime.json", first_section["id"]
 
       # Also check attribute access
       first_section = response.first
-      assert_equal "#{@base_api_url}/tags/crime.json", first_section.id
+      assert_equal "#{@base_api_url}/tags/sections/crime.json", first_section.id
     end
 
     def section_page_url(page_parameter)
@@ -271,6 +271,45 @@ describe GdsApi::ContentApi do
   end
 
   describe "tags" do
+    it "returns a list of tags of a given type" do
+      content_api_has_tags("author", ["justin-thyme"])
+      response = @api.tags("author")
+
+      # Old-style dictionary access
+      first_section = response["results"][0]
+      assert_equal "#{@base_api_url}/tags/authors/justin-thyme.json", first_section["id"]
+
+      # Also check attribute access
+      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")
+
+      # Old-style dictionary access
+      first_section = response["results"][0]
+      assert_equal "#{@base_api_url}/tags/authors/oliver-sudden.json", first_section["id"]
+
+      # Also check attribute access
+      first_section = response.first
+      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
+      content_api_has_child_tags("genre", "indie", ["indie/indie-rock"])
+      response = @api.child_tags("genre", "indie")
+
+      # Old-style dictionary access
+      first_section = response["results"][0]
+      assert_equal "#{@base_api_url}/tags/genres/indie%2Findie-rock.json", first_section["id"]
+
+      # Also check attribute access
+      first_section = response.first
+      assert_equal "#{@base_api_url}/tags/genres/indie%2Findie-rock.json", first_section.id
+    end
+
     it "should produce an artefact with the provided tag" do
       tag = "crime-and-justice"
       api_url = "#{@base_api_url}/with_tag.json?tag=#{tag}&include_children=1"
@@ -288,6 +327,17 @@ describe GdsApi::ContentApi do
       assert_equal "Complain about a claims company", response.first.title
     end
 
+    it "returns artefacts given a tag and tag type" do
+      api_url = "#{@base_api_url}/with_tag.json?genre=reggae&include_children=1"
+      json = {
+        results: [{title: "Three Little Birds"}]
+      }
+      stub_request(:get, api_url).to_return(:status => 200, :body => json.to_json)
+      response = @api.with_tag("reggae", "genre")
+
+      assert_equal "Three Little Birds", response.first.title
+    end
+
     it "should return tag tree for a specific tag" do
       tag = "crime-and-justice"
       api_url = "#{@base_api_url}/tags/#{tag}.json"
@@ -299,6 +349,61 @@ describe GdsApi::ContentApi do
       title = response['title']
       assert_equal json[:title], title
     end
+
+    it "returns tag information given a tag and tag type" do
+      api_url = "#{@base_api_url}/tags/genre/reggae.json"
+      json = {
+        title: "Reggae"
+      }
+      stub_request(:get, api_url).to_return(:status => 200, :body => json.to_json)
+      response = @api.tag("reggae", "genre")
+
+      assert_equal "Reggae", response['title']
+    end
+
+    it "returns artefacts for a tag in curated list order" do
+      api_url = "#{@base_api_url}/with_tag.json?tag=crime-and-justice&sort=curated"
+      json = {
+        results: [{title: "Complain about a claims company"}]
+      }
+      stub_request(:get, api_url).to_return(:status => 200, :body => json.to_json)
+      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
+      api_url = "#{@base_api_url}/with_tag.json?genre=reggae&sort=curated"
+      json = {
+        results: [{title: "Buffalo Soldier"}]
+      }
+      stub_request(:get, api_url).to_return(:status => 200, :body => json.to_json)
+      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
+      api_url = "#{@base_api_url}/with_tag.json?tag=crime-and-justice&sort=foo"
+      json = {
+        results: [{title: "Complain about a claims company"}]
+      }
+      stub_request(:get, api_url).to_return(:status => 200, :body => json.to_json)
+      response = @api.sorted_by("crime-and-justice", "foo")
+
+      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
+      api_url = "#{@base_api_url}/with_tag.json?genre=reggae&sort=foo"
+      json = {
+        results: [{title: "Is This Love"}]
+      }
+      stub_request(:get, api_url).to_return(:status => 200, :body => json.to_json)
+      response = @api.sorted_by("reggae", "foo", "genre")
+
+      assert_equal "Is This Love", response.first.title
+    end
   end
 
   describe "licence" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 7.25.0
+  version: 8.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -343,7 +343,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1935104630694198771
+      hash: -2067444062740093796
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -352,7 +352,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1935104630694198771
+      hash: -2067444062740093796
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23