gds-api-adapters 10.2.1 → 10.3.0

data/lib/gds_api/base.rb

@@ -45,7 +45,7 @@ class GdsApi::Base
   end
 
   def url_for_slug(slug, options={})
-    base = "#{base_url}/#{slug}.json#{query_string(options)}"
+    "#{base_url}/#{slug}.json#{query_string(options)}"
   end
 
   def get_list!(url)
@@ -60,8 +60,17 @@ private
   def query_string(params)
     return "" if params.empty?
 
-    "?" << params.sort.map { |kv|
-      kv.map { |a| CGI.escape(a.to_s) }.join("=")
-    }.join("&")
+    param_pairs = params.sort.map { |key, value|
+      case value
+      when Array
+        value.map { |v|
+          "#{CGI.escape(key+'[]')}=#{CGI.escape(v.to_s)}"
+        }
+      else
+        "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+      end
+    }.flatten
+
+    "?#{param_pairs.join("&")}"
   end
 end

data/lib/gds_api/exceptions.rb

@@ -23,13 +23,19 @@ module GdsApi
   class HTTPNotFound < HTTPErrorResponse
   end
 
+  class HTTPGone < HTTPErrorResponse; end
+
   class NoBearerToken < BaseError; end
 
   module ExceptionHandling
-    def ignoring(exception, &block)
+    def ignoring(exception_or_exceptions, &block)
       yield
-    rescue exception
+    rescue *exception_or_exceptions
       # Discard the exception
     end
+
+    def ignoring_missing(&block)
+      ignoring([HTTPNotFound, HTTPGone], &block)
+    end
   end
 end

data/lib/gds_api/finder_api.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module GdsApi
+  class FinderApi < Base
+    def get_documents(finder_slug, options = {})
+      get_json(documents_url(finder_slug, options))
+    end
+
+  private
+    def documents_url(finder_slug, options = {})
+      finder_url(finder_slug, 'documents', options)
+    end
+
+    def finder_url(finder_slug, action, options = {})
+      "#{endpoint}/finders/#{CGI.escape(finder_slug)}/#{action}.json#{query_string(options)}"
+    end
+  end
+end

data/lib/gds_api/json_client.rb

@@ -57,7 +57,7 @@ module GdsApi
     end
 
     def get_raw(url)
-      ignoring GdsApi::HTTPNotFound do
+      ignoring_missing do
         get_raw!(url)
       end
     end
@@ -70,7 +70,7 @@ module GdsApi
     [:get, :post, :put, :delete].each do |http_method|
       method_name = "#{http_method}_json"
       define_method method_name do |url, *args, &block|
-        ignoring GdsApi::HTTPNotFound do
+        ignoring_missing do
           send (method_name + "!"), url, *args, &block
         end
       end
@@ -106,6 +106,9 @@ module GdsApi
     rescue RestClient::ResourceNotFound => e
       raise GdsApi::HTTPNotFound.new(e.http_code)
 
+    rescue RestClient::Gone => e
+      raise GdsApi::HTTPGone.new(e.http_code)
+
     rescue RestClient::Exception => e
       raise GdsApi::HTTPErrorResponse.new(e.response.code.to_i), e.response.body
     end
@@ -124,6 +127,9 @@ module GdsApi
       rescue RestClient::ResourceNotFound => e
         raise GdsApi::HTTPNotFound.new(e.http_code)
 
+      rescue RestClient::Gone => e
+        raise GdsApi::HTTPGone.new(e.http_code)
+
       rescue RestClient::Exception => e
         # Attempt to parse the body as JSON if possible
         error_details = begin

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '10.2.1'
+  VERSION = '10.3.0'
 end

data/test/finder_api_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+require 'gds_api/finder_api'
+
+describe GdsApi::FinderApi do
+  before do
+    @base_api_url = Plek.current.find('finder-api')
+    @api = GdsApi::FinderApi.new(@base_api_url)
+  end
+
+  describe "get_documents" do
+    it "should return all documents" do
+      documents_hash = {
+        'documents' => [
+          {
+            'title' => 'A document',
+            'date' => '2014-01-24 00:00:00 +0000',
+            'case_type' => 'market-investigations'
+          },
+          {
+            'title' => 'Blah blah',
+            'date' => '2014-01-25 00:00:00 +0000',
+            'case_type' => 'merger-inquiries'
+          }
+        ]
+      }
+
+      req = WebMock.stub_request(:get, "#{@base_api_url}/finders/some-finder-slug/documents.json").
+        to_return(:body => documents_hash.to_json,
+                  :headers => {"Content-type" => "application/json"})
+
+      response = @api.get_documents("some-finder-slug")
+      assert_equal 200, response.code
+      assert_equal documents_hash, response.to_hash
+
+      assert_requested(req)
+    end
+
+    it "should forward query parameters" do
+      documents_hash = {
+        'documents' => [
+          {
+            'title' => 'A document',
+            'date' => '2014-01-24 00:00:00 +0000',
+            'case_type' => 'market-investigations'
+          }
+        ]
+      }
+
+      req = WebMock.stub_request(:get, "#{@base_api_url}/finders/some-finder-slug/documents.json").
+        with(query: {case_type: 'market-investigations'}).
+        to_return(:body => documents_hash.to_json,
+                  :headers => {"Content-type" => "application/json"})
+
+      response = @api.get_documents("some-finder-slug", case_type: 'market-investigations')
+      assert_equal 200, response.code
+      assert_equal documents_hash, response.to_hash
+
+      assert_requested(req)
+    end
+  end
+end

data/test/gds_api_base_test.rb

@@ -25,6 +25,18 @@ class GdsApiBaseTest < MiniTest::Unit::TestCase
     assert_equal "a=+&b=%2F", u.query
   end
 
+  def test_should_construct_escaped_query_string_for_rails
+    api = ConcreteApi.new('http://foo')
+
+    url = api.url_for_slug("slug", "b" => ['123'])
+    u = URI.parse(url)
+    assert_equal "b%5B%5D=123", u.query
+
+    url = api.url_for_slug("slug", "b" => ['123', '456'])
+    u = URI.parse(url)
+    assert_equal "b%5B%5D=123&b%5B%5D=456", u.query
+  end
+
   def test_should_not_add_a_question_mark_if_there_are_no_parameters
     api = ConcreteApi.new('http://foo')
     url = api.url_for_slug("slug")

data/test/json_client_test.rb

@@ -310,7 +310,7 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
-  def test_should_raise_http_not_found_if_404_returned_from_endpoint
+  def test_get_bang_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
@@ -318,13 +318,27 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
+  def test_get_bang_should_raise_http_gone_if_410_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 410)
+    assert_raises GdsApi::HTTPGone 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
+  def test_get_should_be_nil_if_410_returned_from_endpoint
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 410)
+    assert_nil @client.get_json(url)
+  end
+
+  def test_get_should_raise_error_if_non_404_non_410_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 10.2.1
+  version: 10.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -279,6 +279,7 @@ files:
 - lib/gds_api/rummager.rb
 - lib/gds_api/part_methods.rb
 - lib/gds_api/need_api.rb
+- lib/gds_api/finder_api.rb
 - lib/gds_api/railtie.rb
 - lib/gds_api/exceptions.rb
 - lib/gds_api/performance_platform/data_in.rb
@@ -335,6 +336,7 @@ files:
 - test/need_api_test.rb
 - test/publisher_api_test.rb
 - test/fact_cave_test.rb
+- test/finder_api_test.rb
 - test/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb
 - test/panopticon_api_test.rb
@@ -370,7 +372,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1654531338748998219
+      hash: 988974832367169730
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -379,7 +381,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1654531338748998219
+      hash: 988974832367169730
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -393,6 +395,7 @@ test_files:
 - test/need_api_test.rb
 - test/publisher_api_test.rb
 - test/fact_cave_test.rb
+- test/finder_api_test.rb
 - test/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb
 - test/panopticon_api_test.rb