gds-api-adapters 1.9.2 → 2.0.0

data/lib/gds_api/content_api.rb

@@ -16,6 +16,18 @@ class GdsApi::ContentApi < GdsApi::Base
     get_json!("#{base_url}/#{slug}.json")
   end
 
+  def local_authority(snac_code)
+    get_json("#{base_url}/local_authorities/#{CGI.escape(snac_code)}.json")
+  end
+
+  def local_authorities_by_name(name)
+    get_json!("#{base_url}/local_authorities.json?name=#{CGI.escape(name)}")
+  end
+
+  def local_authorities_by_snac_code(snac_code)
+    get_json!("#{base_url}/local_authorities.json?snac_code=#{CGI.escape(snac_code)}")
+  end
+
   private
     def base_url
       endpoint

data/lib/gds_api/exceptions.rb

@@ -16,6 +16,9 @@ module GdsApi
     end
   end
 
+  class HTTPNotFound < HTTPErrorResponse
+  end
+
   module ExceptionHandling
     def ignoring(exception, &block)
       yield

data/lib/gds_api/json_client.rb

@@ -39,7 +39,7 @@ module GdsApi
     end
 
     def get_json(url)
-      ignoring GdsApi::HTTPErrorResponse do
+      ignoring GdsApi::HTTPNotFound do
         get_json! url
       end
     end
@@ -49,7 +49,7 @@ module GdsApi
     end
 
     def post_json(url, params)
-      ignoring GdsApi::HTTPErrorResponse do
+      ignoring GdsApi::HTTPNotFound do
         post_json! url, params
       end
     end
@@ -59,7 +59,7 @@ module GdsApi
     end
 
     def put_json(url, params)
-      ignoring GdsApi::HTTPErrorResponse do
+      ignoring GdsApi::HTTPNotFound do
         put_json! url, params
       end
     end
@@ -84,6 +84,8 @@ module GdsApi
       if response.is_a?(Net::HTTPSuccess)
         logger.info loggable.merge(status: 'success', end_time: Time.now.to_f).to_json
         Response.new(response)
+      elsif response.is_a?(Net::HTTPNotFound)
+        raise GdsApi::HTTPNotFound.new(response.code.to_i)
       else
         body = begin
           JSON.parse(response.body.to_s)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '1.9.2'
+  VERSION = '2.0.0'
 end

data/test/content_api_test.rb

@@ -2,29 +2,167 @@ require 'test_helper'
 require 'gds_api/content_api'
 require 'gds_api/test_helpers/content_api'
 
-class ContentApiTest < MiniTest::Unit::TestCase
+describe GdsApi::ContentApi do
   include GdsApi::TestHelpers::ContentApi
 
-  def api
-    GdsApi::ContentApi.new('test')
+  before do
+    @base_api_url = "https://contentapi.test.alphagov.co.uk"
+    @api = GdsApi::ContentApi.new('test')
   end
 
-  def test_sections
-    content_api_has_root_sections(["crime"])
-    response = api.sections
-    first_section = response["results"][0]
-    assert_equal "http://contentapi.test.gov.uk/tags/crime.json", first_section["id"]
+  describe "sections" do
+    it "should show a list of sections" do
+      content_api_has_root_sections(["crime"])
+      response = @api.sections
+      first_section = response["results"][0]
+      assert_equal "http://contentapi.test.gov.uk/tags/crime.json", first_section["id"]
+    end
   end
 
-  def test_with_tag
-    tag = "crime-and-justice"
-    api_url = "https://contentapi.test.alphagov.co.uk/with_tag.json?tag=#{tag}&include_children=1"
-    json = {
-      results: [{title: "Complain about a claims company"}]
-    }.to_json
-    stub_request(:get, api_url).to_return(:status => 200, :body => json)
-    response = api.with_tag("crime-and-justice")
-    subsection = response["results"][0]
-    assert_equal "Complain about a claims company", subsection["title"]
+  describe "tags" do
+    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"
+      json = {
+        results: [{title: "Complain about a claims company"}]
+      }.to_json
+      stub_request(:get, api_url).to_return(:status => 200, :body => json)
+      response = @api.with_tag("crime-and-justice")
+      subsection = response["results"][0]
+      assert_equal "Complain about a claims company", subsection["title"]
+    end
   end
-end
+
+  describe "local authorities" do
+    it "should return nil if no local authority found" do
+      stub_request(:get, "#{@base_api_url}/local_authorities/does-not-exist.json").
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+        to_return(:status => 404,
+                  :body => {"_response_info" => {"status" => "ok"}}.to_json,
+                  :headers => {})
+
+      assert_nil @api.local_authority("does-not-exist")
+    end
+
+    it "should produce a LocalAuthority hash for an existing snac code" do
+      body_response = {
+        "name" => "Solihull Metropolitan Borough Council",
+        "snac_code" => "00CT",
+        "id" => "#{@base_api_url}/local_authorities/00CT.json",
+        "_response_info" => {"status" => "ok"}
+      }
+
+      stub_request(:get, "#{@base_api_url}/local_authorities/00CT.json").
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+        to_return(:status => 200,
+                  :body => body_response.to_json,
+                  :headers => {})
+
+      response = @api.local_authority("00CT").to_hash
+
+      assert_equal body_response, response
+    end
+
+    it "should return an empty result set if name not found" do
+      body_response = {
+        "_response_info" => {"status" => "ok"},
+        "description" => "Local Authorities",
+        "total" => 0,
+        "results" => []
+      }.to_json
+
+      stub_request(:get, "#{@base_api_url}/local_authorities.json?name=Swansalona").
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+        to_return(:status => 200,
+                  :body => body_response,
+                  :headers => {})
+
+      response = @api.local_authorities_by_name("Swansalona")
+
+      assert_equal 0, response["total"]
+      assert_equal [], response["results"]
+    end
+
+    it "should return an empty result set if snac code not found" do
+      body_response = {
+        "_response_info" => {"status" => "ok"},
+        "description" => "Local Authorities",
+        "total" => 0,
+        "results" => []
+      }.to_json
+
+      stub_request(:get, "#{@base_api_url}/local_authorities.json?snac_code=SNACKS").
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+        to_return(:status => 200,
+                  :body => body_response,
+                  :headers => {})
+
+      response = @api.local_authorities_by_snac_code("SNACKS")
+
+      assert_equal 0, response["total"]
+      assert_equal [], response["results"]
+    end
+
+    it "should have an array of results for a name search" do
+      body_response = {
+        "_response_info" => {"status" => "ok"},
+        "description" => "Local Authorities",
+        "total" => 2,
+        "results" => [{
+                        "name" => "Swansalona Council",
+                        "snac_code" => "00VT",
+                        "id" => "#{@base_api_url}/local_authorities/00VT.json"
+                      },
+                      {
+                        "name" => "Swansea Council",
+                        "snac_code" => "00CT",
+                        "id" => "#{@base_api_url}/local_authorities/00VT.json"
+                      }]
+      }.to_json
+
+      stub_request(:get, "#{@base_api_url}/local_authorities.json?name=Swans").
+        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+        to_return(:status => 200,
+                  :body => body_response,
+                  :headers => {})
+
+      response = @api.local_authorities_by_name("Swans")
+
+      assert_equal 2, response["total"]
+      assert_equal "Swansalona Council", response["results"][0]["name"]
+    end
+
+    it "should escape snac code when calling unique a local authority" do
+      stub_request(:get, "#{@base_api_url}/local_authorities/escape%21.json").
+        to_return(:status => 200,
+                  :body => {"test" => "ing"}.to_json,
+                  :headers => {})
+
+      @api.local_authority("escape!")
+
+      assert_requested :get, "#{@base_api_url}/local_authorities/escape%21.json"
+    end
+
+    it "should escape name when searching for local authorities" do
+      stub_request(:get, "#{@base_api_url}/local_authorities.json?name=name%21").
+        to_return(:status => 200,
+                  :body => {"test" => "ing"}.to_json,
+                  :headers => {})
+
+      @api.local_authorities_by_name("name!")
+
+      assert_requested :get, "#{@base_api_url}/local_authorities.json?name=name%21"
+    end
+
+    it "should escape snac code when searching for local authorities" do
+      stub_request(:get, "#{@base_api_url}/local_authorities.json?snac_code=snacks%21").
+        to_return(:status => 200,
+                  :body => {"test" => "ing"}.to_json,
+                  :headers => {})
+
+      @api.local_authorities_by_snac_code("snacks!")
+
+      assert_requested :get, "#{@base_api_url}/local_authorities.json?snac_code=snacks%21"
+    end
+  end
+end

data/test/json_client_test.rb

@@ -65,12 +65,56 @@ class JsonClientTest < MiniTest::Spec
     assert_equal response_a.object_id, response_b.object_id
   end
 
-  def test_should_return_nil_if_404_returned_from_endpoint
+  def test_should_raise_http_not_found_if_404_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 404)
+    assert_raises GdsApi::HTTPNotFound do
+      @client.get_json!(url)
+    end
+  end
+
+  def test_get_should_be_nil_if_404_returned_from_endpoint
     url = "http://some.endpoint/some.json"
     stub_request(:get, url).to_return(:body => "{}", :status => 404)
     assert_nil @client.get_json(url)
   end
 
+  def test_get_should_raise_error_if_non_404_error_code_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 500)
+    assert_raises GdsApi::HTTPErrorResponse do
+      @client.get_json(url)
+    end
+  end
+
+  def test_post_should_be_nil_if_404_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:post, url).to_return(:body => "{}", :status => 404)
+    assert_nil @client.post_json(url, {})
+  end
+
+  def test_post_should_raise_error_if_non_404_error_code_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:post, url).to_return(:body => "{}", :status => 500)
+    assert_raises GdsApi::HTTPErrorResponse do
+      @client.post_json(url, {})
+    end
+  end
+
+  def test_put_should_be_nil_if_404_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:put, url).to_return(:body => "{}", :status => 404)
+    assert_nil @client.put_json(url, {})
+  end
+
+  def test_put_should_raise_error_if_non_404_error_code_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:put, url).to_return(:body => "{}", :status => 500)
+    assert_raises GdsApi::HTTPErrorResponse do
+      @client.put_json(url, {})
+    end
+  end
+
   def empty_response
     net_http_response = stub(:body => '{}')
     GdsApi::Response.new(net_http_response)

data/test/publisher_api_test.rb

@@ -133,11 +133,13 @@ describe GdsApi::Publisher do
       assert_equal [], api.licences_for_ids([123,124])
     end
 
-    it "should return nil if publisher returns an error" do
+    it "should raise an error if publisher returns an error" do
       stub_request(:get, %r[\A#{PUBLISHER_ENDPOINT}/licences]).
         to_return(:status => [503, "Service temporarily unabailable"])
 
-      assert_equal nil, api.licences_for_ids([123,124])
+      assert_raises GdsApi::HTTPErrorResponse do
+        api.licences_for_ids([123,124])
+      end
     end
 
     it "should return nil if a council snac code is not found" do

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.9.2
+  version: 2.0.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-13 00:00:00 Z
+date: 2012-09-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -202,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2434091861084396613
+      hash: 3104708599933595868
       segments: 
       - 0
       version: "0"
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2434091861084396613
+      hash: 3104708599933595868
       segments: 
       - 0
       version: "0"