gds-api-adapters 4.4.0 → 4.5.0

data/lib/gds_api/content_api/list_response.rb

@@ -80,7 +80,7 @@ class GdsApi::ContentApi < GdsApi::Base
 
   private
     def link_header
-      @link_header ||= LinkHeader.parse @net_http_response["Link"]
+      @link_header ||= LinkHeader.parse @http_response.headers[:link]
     end
 
     def page_link(rel)

data/lib/gds_api/json_client.rb

@@ -109,7 +109,7 @@ module GdsApi
 
       # If no custom response is given, just instantiate Response
       create_response ||= Proc.new { |r| Response.new(r) }
-      create_response.call(response.net_http_res)
+      create_response.call(response)
     end
 
     # Take a hash of parameters for Request#execute; return a hash of

data/lib/gds_api/mapit.rb

@@ -0,0 +1,43 @@
+require_relative 'base'
+require_relative 'exceptions'
+
+class GdsApi::Mapit < GdsApi::Base
+  include GdsApi::ExceptionHandling
+
+  def location_for_postcode(postcode)
+    response = get_json("#{base_url}/postcode/#{CGI.escape postcode}.json")
+    return Location.new(response) unless response.nil?
+  rescue GdsApi::HTTPErrorResponse => e
+    # allow 400 errors, as they can be invalid postcodes people have entered
+    raise GdsApi::HTTPErrorResponse.new(e.code) unless e.code == 400
+  end
+
+  class Location
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def lat
+      @response['wgs84_lat']
+    end
+
+    def lon
+      @response['wgs84_lon']
+    end
+
+    def areas
+      @response['areas'].map {|i, area| OpenStruct.new(area) }
+    end
+
+    def postcode
+      @response['postcode']
+    end
+  end
+
+  private
+    def base_url
+      endpoint
+    end
+end

data/lib/gds_api/response.rb

@@ -9,21 +9,21 @@ module GdsApi
 
     def_delegators :to_hash, :[], :"<=>", :each
 
-    def initialize(net_http_response)
-      @net_http_response = net_http_response
+    def initialize(http_response)
+      @http_response = http_response
     end
 
     def raw_response_body
-      @net_http_response.body
+      @http_response.body
     end
 
     def to_hash
-      @parsed ||= JSON.parse(@net_http_response.body)
+      @parsed ||= JSON.parse(@http_response.body)
     end
 
     def code
       # Return an integer code for consistency with HTTPErrorResponse
-      @net_http_response.code.to_i
+      @http_response.code
     end
 
     def to_ostruct
@@ -58,4 +58,4 @@ module GdsApi
       end
     end
   end
-end
+end

data/lib/gds_api/test_helpers/mapit.rb

@@ -0,0 +1,56 @@
+module GdsApi
+  module TestHelpers
+    module Mapit
+
+      MAPIT_ENDPOINT = Plek.current.find('mapit')
+
+      def mapit_has_a_postcode(postcode, coords)
+        response = {
+          "wgs84_lat" => coords.first,
+          "wgs84_lon" => coords.last,
+          "postcode"  => postcode
+        }
+
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.sub(' ','+') + ".json")
+          .to_return(:body => response.to_json, :status => 200)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(' ').first + ".json")
+          .to_return(:body => response.to_json, :status => 200)
+      end
+
+      def mapit_has_a_postcode_and_areas(postcode, coords, areas)
+        response = {
+          "wgs84_lat" => coords.first,
+          "wgs84_lon" => coords.last,
+          "postcode"  => postcode
+        }
+
+        area_response = Hash[areas.map.with_index {|area, i|
+          [i, {
+            'codes' => {
+              'ons' => area['ons'],
+              'gss' => area['gss']
+            },
+            'name' => area['name'],
+            'type' => area['type']
+          }]
+        }]
+
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.sub(' ','+') + ".json")
+          .to_return(:body => response.merge({'areas' => area_response}).to_json, :status => 200)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(' ').first + ".json")
+          .to_return(:body => response.to_json, :status => 200)
+      end
+
+      def mapit_does_not_have_a_postcode(postcode)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.sub(' ','+') + ".json")
+          .to_return(:body => { "code" => 404, "error" => "No Postcode matches the given query." }.to_json, :status => 404)
+      end
+
+      def mapit_does_not_have_a_bad_postcode(postcode)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.sub(' ','+') + ".json")
+          .to_return(:body => { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, :status => 400)
+      end
+
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '4.4.0'
+  VERSION = '4.5.0'
 end

data/test/json_client_test.rb

@@ -408,4 +408,13 @@ class JsonClientTest < MiniTest::Spec
     response = client.put_json("http://some.other.endpoint/some.json", {})
     assert_equal 2, response.a
   end
+
+  def test_client_can_decompress_gzip_responses
+    url = "http://some.endpoint/some.json"
+    # {"test": "hello"}
+    stub_request(:get, url).to_return(:body => "\u001F\x8B\b\u0000Q\u000F\u0019Q\u0000\u0003\xABVP*I-.Q\xB2RP\xCAH\xCD\xC9\xC9WR\xA8\u0005\u0000\xD1C\u0018\xFE\u0013\u0000\u0000\u0000", :status => 200, :headers => { 'Content-Encoding' => 'gzip' })
+    response = @client.get_json(url)
+
+    assert_equal "hello", response["test"]
+  end
 end

data/test/mapit_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+require 'gds_api/mapit'
+require 'gds_api/test_helpers/mapit'
+
+describe GdsApi::Mapit do
+  include GdsApi::TestHelpers::Mapit
+
+  before do
+    @base_api_url = Plek.current.find("mapit")
+    @api = GdsApi::Mapit.new(@base_api_url)
+  end
+
+  describe "postcodes" do
+    it "should return the coordinates" do
+      mapit_has_a_postcode("SW1A 1AA", [ 51.5010096, -0.1415870 ])
+
+      response = @api.location_for_postcode("SW1A 1AA")
+      assert_equal 51.5010096, response.lat
+      assert_equal -0.1415870, response.lon
+    end
+
+    it "should return the postcode" do
+      mapit_has_a_postcode("SW1A 1AA", [ 51.5010096, -0.1415870 ])
+
+      response = @api.location_for_postcode("SW1A 1AA")
+      assert_equal "SW1A 1AA", response.postcode
+    end
+
+    it "should return areas" do
+      mapit_has_a_postcode_and_areas("SW1A 1AA", [ 51.5010096, -0.1415870 ], [
+        { 'name' => 'Lancashire County Council', 'type' => 'CTY', 'ons' => '30', 'gss' => 'E10000017' },
+        { 'name' => 'South Ribble Borough Council', 'type' => 'DIS', 'ons' => '30UN', 'gss' => 'E07000126' }
+      ])
+
+      response = @api.location_for_postcode("SW1A 1AA")
+      assert_equal 2, response.areas.length
+
+      assert_equal "Lancashire County Council", response.areas.first.name
+      assert_equal "South Ribble Borough Council", response.areas.last.name
+
+      assert_equal "CTY", response.areas.first.type
+      assert_equal "DIS", response.areas.last.type
+
+      assert_equal "30", response.areas.first.codes['ons']
+      assert_equal "30UN", response.areas.last.codes['ons']
+    end
+
+    it "should return nil if a postcode doesn't exist" do
+      mapit_does_not_have_a_postcode("SW1A 1AA")
+
+      assert_nil @api.location_for_postcode("SW1A 1AA")
+    end
+
+    it "should return nil for an invalid postcode" do
+      mapit_does_not_have_a_bad_postcode("B4DP05TC0D3")
+
+      assert_nil @api.location_for_postcode("B4DP05TC0D3")
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-04 00:00:00 Z
+date: 2013-02-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -195,6 +195,7 @@ files:
 - lib/gds_api/imminence.rb
 - lib/gds_api/rummager.rb
 - lib/gds_api/content_api.rb
+- lib/gds_api/mapit.rb
 - lib/gds_api/exceptions.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/core-ext/openstruct.rb
@@ -204,6 +205,7 @@ files:
 - lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
 - lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/panopticon.rb
@@ -216,6 +218,7 @@ files:
 - test/rummager_test.rb
 - test/publisher_api_test.rb
 - test/licence_application_api_test.rb
+- test/mapit_test.rb
 - test/panopticon_api_test.rb
 - test/imminence_api_test.rb
 - test/json_client_test.rb
@@ -236,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 355718895235244126
+      hash: -3906045177861584672
       segments: 
       - 0
       version: "0"
@@ -245,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 355718895235244126
+      hash: -3906045177861584672
       segments: 
       - 0
       version: "0"
@@ -260,6 +263,7 @@ test_files:
 - test/rummager_test.rb
 - test/publisher_api_test.rb
 - test/licence_application_api_test.rb
+- test/mapit_test.rb
 - test/panopticon_api_test.rb
 - test/imminence_api_test.rb
 - test/json_client_test.rb