gds-api-adapters 14.10.0 → 14.11.0

data/lib/gds_api/json_client.rb

@@ -20,6 +20,13 @@ module GdsApi
       @cache ||= LRUCache.new(max_size: size, ttl: ttl)
     end
 
+    # Set the caching implementation. Default is LRUCache. Can be Anything
+    # which responds to:
+    #
+    #   [](key)
+    #   []=(key, value)
+    #   store(key, value, expiry_time=nil) - or a Ruby Time object
+    #
     def self.cache=(c)
       @cache = c
     end

data/lib/gds_api/null_cache.rb

@@ -7,7 +7,7 @@ module GdsApi
     def []=(k, v)
     end
 
-    def store(k, v, args={})
+    def store(k, v, expiry_time=nil)
     end
   end
 end

data/lib/gds_api/panopticon.rb

@@ -49,8 +49,32 @@ class GdsApi::Panopticon < GdsApi::Base
     delete_json!("#{base_url}/#{id_or_slug}.json")
   end
 
+  def create_tag(attributes)
+    post_json!("#{endpoint}/tags.json", attributes)
+  end
+
+  def put_tag(tag_type, tag_id, attributes)
+    put_json!(
+      tag_url(tag_type, tag_id),
+      attributes
+    )
+  end
+
+  def publish_tag(tag_type, tag_id)
+    post_json!(
+      tag_url(tag_type, tag_id, '/publish'),
+      # we don't need to send any more data along with the publish request,
+      # but a body is still required, so sending an empty JSON hash instead
+      { }
+    )
+  end
+
 private
   def base_url
     "#{endpoint}/artefacts"
   end
+
+  def tag_url(tag_type, tag_id, action='')
+    "#{endpoint}/tags/#{tag_type}/#{tag_id}#{action}.json"
+  end
 end

data/lib/gds_api/test_helpers/panopticon.rb

@@ -50,6 +50,27 @@ module GdsApi
 
         stub.to_return(:status => 201)
       end
+
+      def stub_panopticon_tag_creation(attributes)
+        url = "#{PANOPTICON_ENDPOINT}/tags.json"
+        stub_request(:post, url)
+                .with(body: attributes.to_json)
+                .to_return(status: 201, body: attributes.to_json)
+      end
+
+      def stub_panopticon_tag_update(tag_type, tag_id, attributes)
+        url = "#{PANOPTICON_ENDPOINT}/tags/#{tag_type}/#{tag_id}.json"
+        stub_request(:put, url)
+                .with(body: attributes.to_json)
+                .to_return(status: 200)
+      end
+
+      def stub_panopticon_tag_publish(tag_type, tag_id)
+        url = "#{PANOPTICON_ENDPOINT}/tags/#{tag_type}/#{tag_id}/publish.json"
+        stub_request(:post, url)
+                .with(body: {}.to_json)
+                .to_return(status: 200)
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '14.10.0'
+  VERSION = '14.11.0'
 end

data/test/panopticon_registerer_test.rb

@@ -1,5 +1,6 @@
 require_relative 'test_helper'
 require 'gds_api/panopticon'
+require 'gds_api/test_helpers/panopticon'
 require 'ostruct'
 
 describe GdsApi::Panopticon::Registerer do

data/test/{panopticon_api_test.rb → panopticon_test.rb}

@@ -2,17 +2,19 @@ require 'test_helper'
 require 'gds_api/panopticon'
 require 'gds_api/test_helpers/panopticon'
 
-class PanopticonApiTest < MiniTest::Unit::TestCase
+describe GdsApi::Panopticon do
   include GdsApi::TestHelpers::Panopticon
 
-  def basic_artefact
+  let(:base_api_endpoint) { GdsApi::TestHelpers::Panopticon::PANOPTICON_ENDPOINT }
+  let(:api) { GdsApi::Panopticon.new(base_api_endpoint) }
+
+  let(:basic_artefact) {
     {
       name: 'An artefact',
       slug: 'a-basic-artefact'
     }
-  end
-
-  def artefact_with_contact
+  }
+  let(:artefact_with_contact) {
     {
       name: 'An artefact',
       slug: 'an-artefact-with-contact',
@@ -21,9 +23,8 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
         email_address: 'helpline@defra.gsi.gov.uk'
       }
     }
-  end
-
-  def registerable_artefact
+  }
+  let(:registerable_artefact) {
     {
       slug: 'foo',
       owning_app: 'my-app',
@@ -32,44 +33,40 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
       description: 'A custom foo of great customness.',
       state: 'live'
     }
-  end
-
-  def api
-    GdsApi::Panopticon.new(PANOPTICON_ENDPOINT)
-  end
+  }
 
-  def test_given_a_slug__should_fetch_artefact_from_panopticon
+  it 'fetches an artefact given a slug' do
     panopticon_has_metadata(basic_artefact)
 
     artefact = api.artefact_for_slug(basic_artefact[:slug])
     assert_equal 'An artefact', artefact.name
   end
 
-  def test_given_a_slug_can_fetch_artefact_as_hash
+  it 'fetches an artefact as a hash given a slug' do
     panopticon_has_metadata(basic_artefact)
     artefact = api.artefact_for_slug(basic_artefact[:slug], :as_hash => true)
     assert_equal basic_artefact[:name], artefact['name']
   end
 
-  def should_fetch_and_parse_JSON_into_hash
-    url = "#{PANOPTICON_ENDPOINT}/some.json"
+  it 'fetches and parses JSON into a hash' do
+    url = "#{base_api_endpoint}/some.json"
     stub_request(:get, url).to_return(body: {a:1}.to_json)
-  
+
     assert_equal 1, api.get_json(url)['a']
   end
 
-  def test_should_return_nil_if_404_returned_from_endpoint
-    url = "#{PANOPTICON_ENDPOINT}/some.json"
+  it 'returns nil if the endpoint returns 404' do
+    url = "#{base_api_endpoint}/some.json"
     stub_request(:get, url).to_return(status: Rack::Utils.status_code(:not_found))
 
     assert_nil api.get_json(url)
   end
 
-  def test_should_construct_correct_url_for_a_slug
-    assert_equal "#{PANOPTICON_ENDPOINT}/artefacts/slug.json", api.url_for_slug('slug')
+  it 'constructs the correct URL for a slug' do
+    assert_equal "#{base_api_endpoint}/artefacts/slug.json", api.url_for_slug('slug')
   end
 
-  def test_contacts_should_be_deserialised_into_whole_objects
+  it 'deserialises contacts into whole objects' do
     panopticon_has_metadata(artefact_with_contact)
 
     artefact = api.artefact_for_slug(artefact_with_contact[:slug])
@@ -77,8 +74,8 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     assert_equal 'helpline@defra.gsi.gov.uk', artefact.contact.email_address
   end
 
-  def test_can_create_a_new_artefact
-    url = "#{PANOPTICON_ENDPOINT}/artefacts.json"
+  it 'creates a new artefact' do
+    url = "#{base_api_endpoint}/artefacts.json"
     stub_request(:post, url)
       .with(body: basic_artefact.to_json)
       .to_return(body: basic_artefact.merge(id: 1).to_json)
@@ -86,8 +83,8 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     api.create_artefact(basic_artefact)
   end
 
-  def test_can_update_existing_artefact
-    url = "#{PANOPTICON_ENDPOINT}/artefacts/1.json"
+  it 'updates an existing artefact' do
+    url = "#{base_api_endpoint}/artefacts/1.json"
     stub_request(:put, url)
       .with(body: basic_artefact.to_json)
       .to_return(status: 200, body: '{}')
@@ -95,8 +92,8 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     api.update_artefact(1, basic_artefact)
   end
 
-  def test_can_delete_an_artefact
-    url = "#{PANOPTICON_ENDPOINT}/artefacts/1.json"
+  it 'deletes an artefact' do
+    url = "#{base_api_endpoint}/artefacts/1.json"
     stub_request(:delete, url)
       .with(body: "")
       .to_return(status: 200, body: '{}')
@@ -104,7 +101,7 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     api.delete_artefact!(1)
   end
 
-  def test_can_use_basic_auth
+  it 'uses basic auth' do
     credentials = {user: 'fred', password: 'secret'}
     api = GdsApi::Panopticon.new('http://some.url', basic_auth: credentials)
     url = "http://#{credentials[:user]}:#{credentials[:password]}@some.url/artefacts/1.json"
@@ -114,16 +111,16 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     api.update_artefact(1, basic_artefact)
   end
 
-  def test_can_register_new_artefacts_en_masse
-    r = GdsApi::Panopticon::Registerer.new(endpoint_url: PANOPTICON_ENDPOINT, owning_app: 'my-app')
+  it 'registers new artefacts en masse' do
+    r = GdsApi::Panopticon::Registerer.new(endpoint_url: base_api_endpoint, owning_app: 'my-app')
     artefact = registerable_artefact()
     panopticon_has_no_metadata_for('foo')
 
-    stub_request(:put, "#{PANOPTICON_ENDPOINT}/artefacts/foo.json")
+    stub_request(:put, "#{base_api_endpoint}/artefacts/foo.json")
       .with(body: artefact.to_json)
       .to_return(body: artefact.merge(id: 1).to_json)
 
-    url = "#{PANOPTICON_ENDPOINT}/artefacts.json"
+    url = "#{base_api_endpoint}/artefacts.json"
     stub_request(:post, url)
       .with(body: artefact.to_json)
       .to_return(body: artefact.merge(id: 1).to_json)
@@ -132,12 +129,12 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     r.register(record)
   end
 
-  def test_can_register_existing_artefacts_en_masse
+  it 'registers existing artefacts en masse' do
     artefact = registerable_artefact()
-    r = GdsApi::Panopticon::Registerer.new(endpoint_url: PANOPTICON_ENDPOINT, owning_app: 'my-app')
+    r = GdsApi::Panopticon::Registerer.new(endpoint_url: base_api_endpoint, owning_app: 'my-app')
 
     panopticon_has_metadata(artefact)
-    url = "#{PANOPTICON_ENDPOINT}/artefacts/foo.json"
+    url = "#{base_api_endpoint}/artefacts/foo.json"
     stub_request(:put, url)
       .with(body: artefact.to_json)
       .to_return(status: 200, body: '{}')
@@ -145,4 +142,41 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     record = OpenStruct.new(artefact.merge(title: artefact[:name]))
     r.register(record)
   end
+
+  describe 'tags' do
+    let(:tag) {
+      { tag_type: 'section', tag_id: 'housing', title: 'Housing', description: 'Housing', parent_id: nil }
+    }
+
+    it 'creates a tag' do
+      url = "#{base_api_endpoint}/tags.json"
+      req = stub_request(:post, url)
+              .with(body: tag.to_json)
+              .to_return(status: 201, body: tag.to_json)
+
+      api.create_tag(tag)
+      assert_requested(req)
+    end
+
+    it 'updates a tag' do
+      url = "#{base_api_endpoint}/tags/section/citizenship/passports.json"
+      fields_to_update = { title: 'Passports' }
+
+      req = stub_request(:put, url)
+              .with(body: fields_to_update.to_json)
+              .to_return(status: 200)
+
+      api.put_tag('section', 'citizenship/passports', fields_to_update)
+      assert_requested(req)
+    end
+
+    it 'publishes a tag' do
+      url = "#{base_api_endpoint}/tags/section/citizenship/passports/publish.json"
+      req = stub_request(:post, url).with(body: {}.to_json)
+                                    .to_return(status: 200)
+
+      api.publish_tag('section', 'citizenship/passports')
+      assert_requested(req)
+    end
+  end
 end

data/test/test_helpers/panopticon_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+require 'gds_api/panopticon'
+require 'gds_api/test_helpers/panopticon'
+
+describe GdsApi::TestHelpers::Panopticon do
+  include GdsApi::TestHelpers::Panopticon
+
+  def assert_stub_exists(*args)
+    expected_signature = WebMock::RequestSignature.new(*args)
+
+    assert(
+      WebMock::StubRegistry.instance.registered_request?(expected_signature),
+      "Stub is not registered:\n\t#{expected_signature.to_s}"
+    )
+  end
+
+  let(:base_api_endpoint) { GdsApi::TestHelpers::Panopticon::PANOPTICON_ENDPOINT }
+
+  it 'stubs the tag creation request' do
+    atts = { tag_id: 'foo' }
+    stub_panopticon_tag_creation(atts)
+
+    assert_stub_exists(:post, "#{base_api_endpoint}/tags.json", body: atts.to_json)
+  end
+
+  it 'stubs the tag update request' do
+    atts = { title: 'Foo' }
+    stub_panopticon_tag_update('section', 'foo/bar', atts)
+
+    assert_stub_exists(:put,
+      "#{base_api_endpoint}/tags/section/foo/bar.json",
+      body: atts.to_json
+    )
+  end
+
+  it 'stubs the tag publish request' do
+    stub_panopticon_tag_publish('section', 'foo/bar')
+
+    assert_stub_exists(:post,
+      "#{base_api_endpoint}/tags/section/foo/bar/publish.json",
+      body: {}.to_json
+    )
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 14.10.0
+  version: 14.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
-  requirement: &19203660 !ruby/object:Gem::Requirement
+  requirement: &12741120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19203660
+  version_requirements: *12741120
 - !ruby/object:Gem::Dependency
   name: null_logger
-  requirement: &19202160 !ruby/object:Gem::Requirement
+  requirement: &12740260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19202160
+  version_requirements: *12740260
 - !ruby/object:Gem::Dependency
   name: link_header
-  requirement: &19200200 !ruby/object:Gem::Requirement
+  requirement: &12739520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19200200
+  version_requirements: *12739520
 - !ruby/object:Gem::Dependency
   name: lrucache
-  requirement: &19216200 !ruby/object:Gem::Requirement
+  requirement: &12738700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *19216200
+  version_requirements: *12738700
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &19213000 !ruby/object:Gem::Requirement
+  requirement: &12754080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *19213000
+  version_requirements: *12754080
 - !ruby/object:Gem::Dependency
   name: rack-cache
-  requirement: &19210600 !ruby/object:Gem::Requirement
+  requirement: &12753400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19210600
+  version_requirements: *12753400
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &19226440 !ruby/object:Gem::Requirement
+  requirement: &12752600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -87,10 +87,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *19226440
+  version_requirements: *12752600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19224200 !ruby/object:Gem::Requirement
+  requirement: &12751560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *19224200
+  version_requirements: *12751560
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &19221840 !ruby/object:Gem::Requirement
+  requirement: &12750880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: '1.19'
   type: :development
   prerelease: false
-  version_requirements: *19221840
+  version_requirements: *12750880
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &19249960 !ruby/object:Gem::Requirement
+  requirement: &12750080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 0.12.4
   type: :development
   prerelease: false
-  version_requirements: *19249960
+  version_requirements: *12750080
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &19247260 !ruby/object:Gem::Requirement
+  requirement: &12749120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 3.4.0
   type: :development
   prerelease: false
-  version_requirements: *19247260
+  version_requirements: *12749120
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &19263240 !ruby/object:Gem::Requirement
+  requirement: &12748360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19263240
+  version_requirements: *12748360
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &19289900 !ruby/object:Gem::Requirement
+  requirement: &12747380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19289900
+  version_requirements: *12747380
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &19284340 !ruby/object:Gem::Requirement
+  requirement: &12762600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -164,10 +164,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *19284340
+  version_requirements: *12762600
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
-  requirement: &19298140 !ruby/object:Gem::Requirement
+  requirement: &12761140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19298140
+  version_requirements: *12761140
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &19293840 !ruby/object:Gem::Requirement
+  requirement: &12760160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -186,10 +186,10 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *19293840
+  version_requirements: *12760160
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &19291900 !ruby/object:Gem::Requirement
+  requirement: &12758120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -197,10 +197,10 @@ dependencies:
         version: 0.5.1
   type: :development
   prerelease: false
-  version_requirements: *19291900
+  version_requirements: *12758120
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &19309860 !ruby/object:Gem::Requirement
+  requirement: &12756420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -208,7 +208,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19309860
+  version_requirements: *12756420
 description: A set of adapters providing easy access to the GDS GOV.UK APIs
 email:
 - jystewart@gmail.com
@@ -298,12 +298,13 @@ files:
 - test/rummager_helpers_test.rb
 - test/support_test.rb
 - test/fact_cave_test.rb
+- test/test_helpers/panopticon_test.rb
 - test/finder_api_test.rb
 - test/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb
-- test/panopticon_api_test.rb
 - test/maslow_test.rb
 - test/panopticon_registerer_test.rb
+- test/panopticon_test.rb
 - test/middleware/govuk_request_id_sniffer_test.rb
 - test/rummager_test.rb
 - test/json_client_test.rb
@@ -342,7 +343,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 305882728721763385
+      hash: -3839776880550840993
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -351,7 +352,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 305882728721763385
+      hash: -3839776880550840993
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -369,12 +370,13 @@ test_files:
 - test/rummager_helpers_test.rb
 - test/support_test.rb
 - test/fact_cave_test.rb
+- test/test_helpers/panopticon_test.rb
 - test/finder_api_test.rb
 - test/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb
-- test/panopticon_api_test.rb
 - test/maslow_test.rb
 - test/panopticon_registerer_test.rb
+- test/panopticon_test.rb
 - test/middleware/govuk_request_id_sniffer_test.rb
 - test/rummager_test.rb
 - test/json_client_test.rb