govuk_taxonomy_helpers 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 145e8e7f48e099c7854d619770ef6d05183c44ed
-  data.tar.gz: 71505d56dc561f034407a03eea998e8d2f7b375b
+  metadata.gz: f5914eebd6bd1d3dea7a0d464950ad850baf9c6e
+  data.tar.gz: 222098a1b3402e73f9d2cb6d4ab96310812fdaa4
 SHA512:
-  metadata.gz: d8200cd1c85991d6f978183c593ff2812c5c3db909c29228993047eb7235759e0ee4d182779fe0d8040794ec9fab6289d3f225b562fb0590d9781d85b88515f6
-  data.tar.gz: ecbd204b86e4a97f47d5580c98a17b721ca7a262d37e2521153a59bb26c502086157c0f8e44ecbfa3740da9a9cc69434fc13056ac7ee3e1a6b83e771392b6500
+  metadata.gz: 253c283e3e433a2f8d6d154ef2535d04989737c2f0ec7b40a2448503838a61952efd9e8c0dacac864c8d1fbd0004acbb94ed10ef6f9e0921f0c0bfbc6624897f
+  data.tar.gz: 6d53adbc9c998dc3fa7333b689bc3c218f7b53e0eaba71df8787be7f01e53bfd56113fcf8f91f04d759e79ab9aea82ef12330012a3647f16d55a5b47eee8ebbc

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.0
+
+* Merges from_content_id and from_publishing_api into one builder method contained
+in LinkedContentItem. The homepage can now have it's links expanded through
+it's level_one_taxons by using the content_id of the homepage to form a nested tree from
+the root.
+
 ## 0.1.1
 
 * Adds the from_content_id builder method to LinkedContentItem

data/Jenkinsfile

@@ -1,9 +1,10 @@
 #!/usr/bin/env groovy
 
+library("govuk")
+
 REPOSITORY = 'govuk_taxonomy_helpers'
 
 node {
-  def govuk = load '/var/lib/jenkins/groovy_scripts/govuk_jenkinslib.groovy'
 
   try {
     stage('Checkout') {

data/README.md

@@ -22,17 +22,14 @@ Or install it yourself as:
 
 The API is provisional and is likely to change for versions < 1.0.0.
 
-To access the taxonomy, first request the content from the [publishing api](https://github.com/alphagov/publishing-api), then parse it to get a `LinkedContentItem` object.
+To access the taxonomy, first get the content_id of the piece of content you want the taxonomy for, then parse it to get a `LinkedContentItem` object.
 
 ```ruby
 require 'govuk_taxonomy_helpers'
 
-content_item = Services.publishing_api.get_content("c75c541-403f-4cb1-9b34-4ddde816a80d")
-expanded_links = Services.publishing_api.get_expanded_links("c75c541-403f-4cb1-9b34-4ddde816a80d")
-
-taxonomy = GovukTaxonomyHelpers::LinkedContentItem.from_publishing_api(
-  content_item: content_item,
-  expanded_links: expanded_links
+taxonomy = GovukTaxonomyHelpers::LinkedContentItem.from_content_id(
+  content_id: "c75c541-403f-4cb1-9b34-4ddde816a80d",
+  publishing_api: Services.publishing_api
 )
 ```
 

data/lib/govuk_taxonomy_helpers/publishing_api_response.rb

@@ -1,29 +1,16 @@
 module GovukTaxonomyHelpers
   class LinkedContentItem
-    # Extract a LinkedContentItem from publishing api response data.
-    #
-    # @param content_item [Hash] Publishing API `get_content` response hash
-    # @param expanded_links [Hash] Publishing API `get_expanded_links` response hash
-    # @return [LinkedContentItem]
-    # @see http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/PublishingApiV2#get_content-instance_method
-    # @see http://www.rubydoc.info/gems/gds-api-adapters/GdsApi%2FPublishingApiV2:get_expanded_links
-    def self.from_publishing_api(content_item:, expanded_links:)
-      PublishingApiResponse.new(
-        content_item: content_item,
-        expanded_links: expanded_links,
-      ).linked_content_item
-    end
-
     # Use the publishing API service to fetch and extract a LinkedContentItem
     #
     # @param content_id [String] id of the content
     # @param publishing_api [PublishingApiV2] Publishing API service
     # @return [LinkedContentItem]
     def self.from_content_id(content_id:, publishing_api:)
-      GovukTaxonomyHelpers::LinkedContentItem.from_publishing_api(
+      PublishingApiResponse.new(
         content_item: publishing_api.get_content(content_id).to_h,
-        expanded_links: publishing_api.get_expanded_links(content_id).to_h
-      )
+        expanded_links: publishing_api.get_expanded_links(content_id).to_h,
+        publishing_api: publishing_api
+      ).linked_content_item
     end
   end
 
@@ -32,7 +19,8 @@ module GovukTaxonomyHelpers
 
     # @param content_item [Hash] Publishing API `get_content` response hash
     # @param expanded_links [Hash] Publishing API `get_expanded_links` response hash
-    def initialize(content_item:, expanded_links:)
+    # @param publishing_api [PublishingApiV2] Publishing API service
+    def initialize(content_item:, expanded_links:, publishing_api:)
       details = content_item["details"] || {}
 
       @linked_content_item = LinkedContentItem.new(
@@ -42,30 +30,39 @@ module GovukTaxonomyHelpers
         base_path: content_item["base_path"]
       )
 
-      add_expanded_links(expanded_links)
+      add_expanded_links(expanded_links, publishing_api)
     end
 
   private
 
-    def add_expanded_links(expanded_links_response)
+    def add_expanded_links(expanded_links_response, publishing_api)
+      level_one_taxons = expanded_links_response["expanded_links"]["level_one_taxons"]
       child_taxons = expanded_links_response["expanded_links"]["child_taxons"]
       parent_taxons = expanded_links_response["expanded_links"]["parent_taxons"]
       taxons = expanded_links_response["expanded_links"]["taxons"]
 
-      if !child_taxons.nil?
+      if level_one_taxons
+        level_one_taxons.each do |taxon|
+          expanded = publishing_api.get_expanded_links(taxon['content_id'])
+          taxon['links'] = expanded['expanded_links']
+          linked_content_item << parse_nested_child(taxon)
+        end
+      end
+
+      if child_taxons
         child_taxons.each do |child|
           linked_content_item << parse_nested_child(child)
         end
       end
 
-      if !parent_taxons.nil?
+      if parent_taxons
         # Assume no taxon has multiple parents
         single_parent = parent_taxons.first
 
         parse_nested_parent(single_parent) << linked_content_item
       end
 
-      if !taxons.nil?
+      if taxons
         taxons.each do |taxon|
           taxon_node = parse_nested_parent(taxon)
           linked_content_item.add_taxon(taxon_node)

data/lib/govuk_taxonomy_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukTaxonomyHelpers
-  VERSION = "0.1.1".freeze
+  VERSION = "1.0.0".freeze
 end

data/spec/publishing_api_response_spec.rb

@@ -13,30 +13,42 @@ RSpec.describe GovukTaxonomyHelpers::PublishingApiResponse do
     }
   end
 
-  describe '#from_content_id - simple one child case' do
-    let(:expanded_links) do
-      child = {
-        "content_id" => "74aadc14-9bca-40d9-abb4-4f21f9792a05",
-        "base_path" => "/child",
-        "title" => "Child",
-        "details" => {
-          "internal_name" => "C",
-        },
-        "links" => {}
-      }
+  let(:expanded_links) do
+    child = {
+      "content_id" => "74aadc14-9bca-40d9-abb4-4f21f9792a05",
+      "base_path" => "/child",
+      "title" => "Child",
+      "details" => {
+        "internal_name" => "C",
+      },
+      "links" => {}
+    }
 
-      {
-        "content_id" => "64aadc14-9bca-40d9-abb4-4f21f9792a05",
-        "expanded_links" => {
-          "child_taxons" => [child]
-        }
+    {
+      "content_id" => "64aadc14-9bca-40d9-abb4-4f21f9792a05",
+      "expanded_links" => {
+        "child_taxons" => [child]
       }
-    end
-    before :each do
-      @publishing_api = double('publishing_api')
-      allow(@publishing_api).to receive(:get_content).with('64aadc14-9bca-40d9-abb4-4f21f9792a05').and_return(content_item)
-      allow(@publishing_api).to receive(:get_expanded_links).with('64aadc14-9bca-40d9-abb4-4f21f9792a05').and_return(expanded_links)
-    end
+    }
+  end
+
+  let(:publishing_api) do
+    double('publishing_api')
+  end
+
+  before do
+    allow(publishing_api).to receive(:get_content).with('64aadc14-9bca-40d9-abb4-4f21f9792a05').and_return(content_item)
+    allow(publishing_api).to receive(:get_expanded_links).with('64aadc14-9bca-40d9-abb4-4f21f9792a05').and_return(expanded_links)
+  end
+
+  let(:linked_content_item) do
+    GovukTaxonomyHelpers::LinkedContentItem.from_content_id(
+      content_id: content_item['content_id'],
+      publishing_api: publishing_api
+    )
+  end
+
+  describe '#from_content_id - simple one child case' do
     it 'loads the taxon' do
       expect(linked_content_item.title).to eq("Taxon")
       expect(linked_content_item.children.map(&:title)).to eq(["Child"])
@@ -44,13 +56,6 @@ RSpec.describe GovukTaxonomyHelpers::PublishingApiResponse do
     end
   end
 
-  let(:linked_content_item) do
-    GovukTaxonomyHelpers::LinkedContentItem.from_publishing_api(
-      content_item: content_item,
-      expanded_links: expanded_links
-    )
-  end
-
   context "content item with multiple levels of descendants" do
     let(:expanded_links) do
       grandchild_1 = {
@@ -372,8 +377,69 @@ RSpec.describe GovukTaxonomyHelpers::PublishingApiResponse do
     end
   end
 
+  context "homepage content item with a level_one_taxon and a child" do
+    it "parses each level of taxons from home page" do
+      root_taxon = {
+        "content_id" => "f3bbdec2-0e62-4520-a7fd-6ffd5d36e03a",
+        "base_path" => "/",
+        "title" => "GOV.UK homepage",
+        "details" => {}
+      }
+
+      child_for_level_one_taxon = {
+        "content_id" => "84aadc14-9bca-40d9-abb4-4f21f9792a05",
+        "base_path" => "/transport_child",
+        "title" => "Transport child",
+        "details" => {
+          "internal_name" => "TC 1",
+        },
+        "links" => {}
+      }
+
+      level_one_taxon = {
+        "content_id" => "a4038b29-b332-4f13-98b1-1c9709e216bc",
+        "base_path" => "/transport/all",
+        "title" => "Transport",
+        "details" => {
+          "internal_name" => "Transport",
+        },
+        "links" => {
+          "child_taxons" => [child_for_level_one_taxon],
+          "root_taxon" => [root_taxon]
+        }
+      }
+
+      expanded_links = {
+        "expanded_links" => {
+          "level_one_taxons" => [level_one_taxon],
+        }
+      }
+
+      expanded_links_2 = {
+        "expanded_links" => {
+          "child_taxons" => [child_for_level_one_taxon]
+        }
+      }
+
+      allow(publishing_api).to receive(:get_content).with('f3bbdec2-0e62-4520-a7fd-6ffd5d36e03a').and_return(root_taxon)
+      allow(publishing_api).to receive(:get_expanded_links).with('f3bbdec2-0e62-4520-a7fd-6ffd5d36e03a').and_return(expanded_links)
+      allow(publishing_api).to receive(:get_expanded_links).with('a4038b29-b332-4f13-98b1-1c9709e216bc').and_return(expanded_links_2)
+
+      homepage_taxon = GovukTaxonomyHelpers::LinkedContentItem.from_content_id(
+        content_id: root_taxon['content_id'],
+        publishing_api: publishing_api
+      )
+
+      expect(homepage_taxon.title).to eq("GOV.UK homepage")
+      expect(homepage_taxon.parent).to eq(nil)
+      expect(homepage_taxon.children.map(&:title)).to eq(["Transport"])
+      expect(homepage_taxon.descendants.map(&:title)).to eq(["Transport", "Transport child"])
+      expect(homepage_taxon.children.first.children.first.title).to eq("Transport child")
+    end
+  end
+
   context "minimal responses with missing links and details hashes" do
-    let(:minimal_taxon) do
+    it "parses taxons with nil internal names" do
       grandchild_1 = {
         "content_id" => "84aadc14-9bca-40d9-abb4-4f21f9792a05",
         "base_path" => "/grandchild-1",
@@ -418,13 +484,14 @@ RSpec.describe GovukTaxonomyHelpers::PublishingApiResponse do
         }
       }
 
-      GovukTaxonomyHelpers::LinkedContentItem.from_publishing_api(
-        content_item: content_item,
-        expanded_links: expanded_links
+      allow(publishing_api).to receive(:get_content).with('aaaaaa14-9bca-40d9-abb4-4f21f9792a05').and_return(content_item)
+      allow(publishing_api).to receive(:get_expanded_links).with('aaaaaa14-9bca-40d9-abb4-4f21f9792a05').and_return(expanded_links)
+
+      minimal_taxon = GovukTaxonomyHelpers::LinkedContentItem.from_content_id(
+        content_id: content_item['content_id'],
+        publishing_api: publishing_api
       )
-    end
 
-    it "parses taxons with nil internal names" do
       expect(minimal_taxon.title).to eq("Minimal Taxon")
       expect(minimal_taxon.internal_name).to be_nil
       expect(minimal_taxon.parent.title).to eq("Parent Taxon")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_taxonomy_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler