postcodeapi 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 086780903cb3fcc7b346d4b7590f8fa4248ace1e
-  data.tar.gz: c2856c4476339f2ca47b347d19ac3b888b7d6a3d
+  metadata.gz: 6d9305b21a4a58981374007ece910c95a7745438
+  data.tar.gz: 0a0f19fc7c6169503fcc94bfe3c4a7f9143ce488
 SHA512:
-  metadata.gz: 94393668ff6c3db3b09b6b3a56f96448eac1d74d49878f9a8655b0140f895050802e57c0e62b9d88bb091e9748d3acddc90c9b7bb68d7ae37835d61f2d218769
-  data.tar.gz: 23c03337847c5d51492d7a20ecbf677b510c637586a8dd2c86e5a5d852b44eedcfad4cfe15bf5588ccae45365bff268985964a8c5b2643151326a50182e96947
+  metadata.gz: f5305cf890fd8c6b5c51c054ccb0a7e896748847a6fa37686278e7b36ab60735ca9081cd02041c23138626de9ef976996d70abbc2d2d42ff5577835142dd4d1f
+  data.tar.gz: 976d41b69eff97e5956b670ab64a43c6e3167af9f9d4a45111d9ae36a70e3ad7d91eb1e1d1b02fa62e899a18c6e9b2554bdad892a907f0c5f5ea0f2aab4633c0

data/.travis.yml

@@ -2,10 +2,14 @@ language: ruby
 script: "bundle exec rspec spec/"
 
 rvm:
-  - 2.1.6
-  - 2.2.2
+  - 2.1
+  - 2.2
   - ruby-head
 
+before_install:
+  - gem update --system
+  - gem update bundler
+
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.txt

@@ -1,3 +1,15 @@
+# 2.0.0 - 2016-01-27
+
+* Migrate to PostcodeAPI v2, see http://www.postcodeapi.nu for details.
+
+# 1.1.0 - 2015-05-18
+
+* Normalize input before calling API
+
+# 1.0.0 - 2014-01-29
+
+* Allow hashie version flexibility
+
 # 0.0.2 - 2013-03-14
 
 * Use plain old net/http instead of pulling in httparty [martijn]

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/README.md

@@ -3,6 +3,9 @@
 This is a small Ruby wrapper around the postcodeapi.nu API, which allows you 
 to resolve Dutch postcodes to street and city names.
 
+**postcodeapi-2.x is only compatible with PostcodeAPI v2. PostcodeAPI v1 is 
+deprecated and will be taken offline on 2016-03-01.**
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,13 +22,58 @@ Or install it yourself as:
 
 ## Usage
 
-Firstly, sign up for a free API key at http://postcodeapi.nu, then juse this gem:
+Firstly, sign up for a free API key at http://postcodeapi.nu, then use this gem like this:
+
+    require 'pp'
+    require 'postcodeapi'
 
     api = Postcode::API.new("your-api-key")
-    result = api.postcode("5041EB")
 
-    result.resource.street
-    => "Wilhelminastraat"
+    irb> pp api.addresses("5694AJ", 1)
+    {"addresses"=>
+      [{"city"=>{"id"=>"3520", "label"=>"Son en Breugel"},
+        "letter"=>nil,
+        "id"=>"0848200000005576",
+        "purpose"=>"woonfunctie",
+        "postcode"=>"5694AJ",
+        "municipality"=>{"id"=>"0848", "label"=>"Son en Breugel"},
+        "nen5825"=>{"street"=>"SINT CATHARINASTRAAT", "postcode"=>"5694 AJ"},
+        "street"=>"Sint Catharinastraat",
+        "number"=>1,
+        "province"=>{"id"=>"30", "label"=>"Noord-Brabant"},
+        "addition"=>nil,
+        "geo"=>
+         {"center"=>
+           {"wgs84"=>
+             {"crs"=>
+               {"properties"=>{"name"=>"urn:ogc:def:crs:OGC:1.3:CRS84"},
+                "type"=>"name"},
+              "type"=>"Point",
+              "coordinates"=>[5.50767699298, 51.5131728171]},
+            "rd"=>
+             {"crs"=>
+               {"properties"=>{"name"=>"urn:ogc:def:crs:EPSG::28992"},
+                "type"=>"name"},
+              "type"=>"Point",
+              "coordinates"=>[163363, 391581]}}},
+        "type"=>"Verblijfsobject",
+        "_links"=>
+         {"self"=>
+           {"href"=>
+             "https://postcode-api.apiwise.nl/v2/addresses/0848200000005576/"}}}]}
+               
+There is also `#simple_addresses` to retrieve a minimal set of data:
+
+     irb> pp api.simple_addresses("5694AJ", 1)
+	 {"addresses"=>
+       [{"latitude"=>51.5131728171,
+         "longitude"=>5.50767699298,
+         "municipality"=>"Son en Breugel",
+         "postcode"=>"5694AJ",
+         "province"=>"Noord-Brabant",
+         "street"=>"Sint Catharinastraat"}]}
+
+Please note that the house number is optional. 
 
 ## Contributing
 
@@ -44,9 +92,15 @@ Original author:
 
  * Ariejan de Vroom, https://ariejan.net
 
+Github contributors
+
+ * pedrocatalao
+ * martijn
+ * WvanLelyveld
+
 ## LICENSE
 
-Copyright (c) 2013 Ariejan de Vroom
+Copyright (c) 2013-2016 Ariejan de Vroom
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/postcodeapi/api.rb

@@ -1,28 +1,60 @@
 module Postcode
-  # You're required to sign up for an api key at http://postcodeapi.nu
+  # You're required to sign up for an api key at http://www.postcodeapi.nu/
   class API
-    BASE_URI = "http://api.postcodeapi.nu"
+    BASE_URI = 'https://postcode-api.apiwise.nl'
 
     def initialize(api_key)
       @api_key = api_key
     end
 
-    def postcode(postcode, house_number = nil, options = {})
+    # Returns an address list for a given postcode with all raw data that the api disposes
+    def addresses(postcode, house_number = nil, options = {})
       postcode = sanitize(postcode)
-      uri = URI.parse([BASE_URI, postcode, house_number].compact.join('/'))
+      uri = URI.parse([BASE_URI, 'v2', 'addresses'].compact.join('/'))
+      uri.query = URI.encode_www_form( {'postcode' => postcode, 'number' => house_number} )
 
-      req = Net::HTTP::Get.new(uri.path)
-      req.add_field('Api-Key', @api_key)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
-      res = Net::HTTP.new(uri.host, uri.port).start do |http|
-        http.request(req)
-      end
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.add_field('X-Api-Key', @api_key)
+      response = http.request(request)
+
+      content = Hashie::Mash.new(JSON.parse(response.body))
+
+      return content if content.error
+      content._embedded
+    end
+
+    # Returns simplified addresses for a given postcode with only essential filtered data
+    def simple_addresses(postcode, house_number = nil, options = {})
+      content = addresses(postcode, house_number, options)
 
-      Hashie::Mash.new(JSON.parse(res.body))
+      return content if content.error
+      simplify(content)
+    end
+
+    private
+
+    def simplify(content)
+      addresses = []
+      content.addresses.each do |entry|
+        addresses << Hashie::Mash.new(
+              { latitude: entry.geo.center.wgs84.coordinates.last,
+                longitude: entry.geo.center.wgs84.coordinates.first,
+                municipality: entry.municipality.label,
+                postcode: entry.postcode,
+                province: entry.province.label,
+                street: entry.street
+              } )
+      end
+      Hashie::Mash.new({addresses: addresses})
     end
 
     def sanitize(postcode)
       postcode.gsub(/\s+/, '').upcase
     end
+
   end
 end

data/lib/postcodeapi/version.rb

@@ -1,3 +1,3 @@
 module Postcode
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/postcodeapi.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'hashie', '>= 1.2.0'
+  gem.add_dependency 'hashie', '>= 3.4.3'
 
-  gem.add_development_dependency 'rake', '~> 10.0.3'
-  gem.add_development_dependency 'rspec', '~> 2.12.0'
-  gem.add_development_dependency 'webmock', '~> 1.9.0'
+  gem.add_development_dependency 'rake', '~> 10.5.0'
+  gem.add_development_dependency 'rspec', '~> 3.4.0'
+  gem.add_development_dependency 'webmock', '~> 1.22.6'
 end

data/spec/postcodeapi/api_spec.rb

@@ -3,71 +3,95 @@ require File.expand_path('../../spec_helper', __FILE__)
 describe Postcode::API do
   context "without a valid API key" do
     before do
-      body = '{"success":false,"error":{"code":401,"message":"A valid \'Api-Key\' needs to be provided in the \'Headers\' in order to use this API."}}'
-      stub_request(:get, "http://api.postcodeapi.nu/5041EB").
-        with(:headers => {'Api-Key'=>'invalid'}).
+      body = '{"error":"API key is invalid."}'
+      stub_request(:get, "https://postcode-api.apiwise.nl/v2/addresses?number&postcode=5041EB").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby', 'X-Api-Key'=>'invalid'}).
         to_return(:status => 401, :body => body, :headers => {"Content-Type" => "application/json"})
     end
 
     subject(:api) { Postcode::API.new("invalid") }
 
-    it 'returns an error response' do
-      result = api.postcode('5041EB')
+    context "for raw data request" do
+      it 'returns an error response' do
+        result = api.addresses('5041EB')
 
-      result.success.should be_false
-      result.error.code.should eq(401)
+        expect(result.error).to eq("API key is invalid.")
+      end
+    end
+
+    context "for simplified data request" do
+      it 'also returns an error response' do
+        result = api.simple_addresses('5041EB')
+
+        expect(result.error).to eq("API key is invalid.")
+      end
     end
   end
 
   context "with a valid API key" do
     context "with postcode only" do
       before do
-        body = '{"success":true,"resource":{"street":"Wilhelminapark","postcode":"5041EB","town":"Tilburg","latitude":51.9401,"longitude":5.61531}}'
-        stub_request(:get, "http://api.postcodeapi.nu/5041EB").
-          with(:headers => {'Api-Key'=>'valid'}).
-          to_return(:status => 401, :body => body, :headers => {"Content-Type" => "application/json"})
+        body = '{"_embedded":{"addresses":[{"city":{"id":"1043","label":"Tilburg"},"letter":"a","id":"0855200000066230","purpose":"kantoorfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":17,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07699118186,51.5666652242]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133491.678,397570.947]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000066230/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000060997","purpose":"kantoorfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":17,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07703198051,51.5666742042]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133494.511,397571.934]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000060997/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000060998","purpose":"kantoorfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":18,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07706422938,51.5666172658]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133496.72,397565.59]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000060998/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":"b","id":"0855200000061000","purpose":"industriefunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":19,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07709246364,51.5665293687]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133498.636,397555.803]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061000/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":"a","id":"0855200000060999","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":19,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07708494827,51.5665443149]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133498.122,397557.468]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000060999/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000061001","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":21,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07717893166,51.566414786]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133504.577,397543.03]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061001/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":"b","id":"0855200000061004","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":22,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07720777743,51.566283727]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133506.515,397528.441]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061004/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000110606","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":22,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07724882372,51.5662923031]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133509.365,397529.383]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000110606/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000061005","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":23,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07728036245,51.5662336728]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133511.524,397522.851]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061005/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000061006","purpose":"winkelfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":24,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07731653182,51.5661664347]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133514,397515.36]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061006/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000061007","purpose":"kantoorfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":25,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07738142047,51.5660457722]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133518.442,397501.917]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061007/"}}},{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000061008","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":27,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07745550693,51.5659044692]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133523.512,397486.175]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061008/"}}}]},"_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/?postcode=5041EB"}}}'
+        stub_request(:get, "https://postcode-api.apiwise.nl/v2/addresses?number&postcode=5041EB").
+          with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby', 'X-Api-Key'=>'valid'}).
+          to_return(:status => 200, :body => body, :headers => {"Content-Type" => "application/json"})
       end
 
       subject(:api) { Postcode::API.new("valid") }
 
-      it 'returns an error response' do
-        result = api.postcode('5041EB')
-
-        result.success.should be_true
-        result.resource.street.should eq("Wilhelminapark")
-        result.resource.postcode.should eq("5041EB")
-        result.resource.town.should eq("Tilburg")
-        result.resource.latitude.should eq(51.9401)
-        result.resource.longitude.should eq(5.61531)
+      context "for raw data request" do
+        it 'returns an success response with correct format' do
+          result = api.addresses('5041EB')
+
+          expect(result.addresses).to_not be_empty
+          expect(result.addresses.first.street).to eq("Wilhelminapark")
+          expect(result.addresses.first.postcode).to eq("5041EB")
+          expect(result.addresses.first.municipality.label).to eq("Tilburg")
+          expect(result.addresses.first.geo.center.wgs84.coordinates.last).to eq(51.5666652242)
+          expect(result.addresses.first.geo.center.wgs84.coordinates.first).to eq(5.07699118186)
+        end
+      end
+
+      context "for simplified data request" do
+        it 'returns an success response' do
+          result = api.simple_addresses('5041EB')
+
+          expect(result.addresses).not_to be_empty
+          expect(result.addresses.first.street).to eq("Wilhelminapark")
+          expect(result.addresses.first.postcode).to eq("5041EB")
+          expect(result.addresses.first.municipality).to eq("Tilburg")
+          expect(result.addresses.first.latitude).to eq(51.5666652242)
+          expect(result.addresses.first.longitude).to eq(5.07699118186)
+        end
       end
 
       it 'sanitizes input before lookup' do
-        result = api.postcode('5041 eb')
+        result = api.simple_addresses('5041 eb')
 
-        result.success.should be_true
-        result.resource.postcode.should eq("5041EB")
+        expect(result.addresses).to_not be_empty
+        expect(result.addresses.first.postcode).to eq("5041EB")
       end
     end
 
     context "with postcode and house number" do
       before do
-        body = '{"success":true,"resource":{"street":"Wilhelminapark","postcode":"5041EB","town":"Tilburg","latitude":51.9401,"longitude":5.61531}}'
-        stub_request(:get, "http://api.postcodeapi.nu/5041EB/21").
-          with(:headers => {'Api-Key'=>'valid'}).
-          to_return(:status => 401, :body => body, :headers => {"Content-Type" => "application/json"})
+        body = '{"_embedded":{"addresses":[{"city":{"id":"1043","label":"Tilburg"},"letter":null,"id":"0855200000061001","purpose":"woonfunctie","postcode":"5041EB","municipality":{"id":"0855","label":"Tilburg"},"nen5825":{"street":"WILHELMINAPARK","postcode":"5041 EB"},"street":"Wilhelminapark","number":21,"province":{"id":"30","label":"Noord-Brabant"},"addition":null,"geo":{"center":{"wgs84":{"crs":{"properties":{"name":"urn:ogc:def:crs:OGC:1.3:CRS84"},"type":"name"},"type":"Point","coordinates":[5.07717893166,51.566414786]},"rd":{"crs":{"properties":{"name":"urn:ogc:def:crs:EPSG::28992"},"type":"name"},"type":"Point","coordinates":[133504.577,397543.03]}}},"type":"Verblijfsobject","_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/0855200000061001/"}}}]},"_links":{"self":{"href":"https://postcode-api.apiwise.nl/v2/addresses/?postcode=5041EB&number=21"}}}'
+        stub_request(:get, "https://postcode-api.apiwise.nl/v2/addresses?number=21&postcode=5041EB").
+          with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby', 'X-Api-Key'=>'valid'}).
+          to_return(:status => 200, :body => body, :headers => {"Content-Type" => "application/json"})
       end
 
       subject(:api) { Postcode::API.new("valid") }
 
       it 'returns an error response' do
-        result = api.postcode('5041EB', 21)
-
-        result.success.should be_true
-        result.resource.street.should eq("Wilhelminapark")
-        result.resource.postcode.should eq("5041EB")
-        result.resource.town.should eq("Tilburg")
-        result.resource.latitude.should eq(51.9401)
-        result.resource.longitude.should eq(5.61531)
+        result = api.simple_addresses('5041EB', 21)
+
+        expect(result.addresses).to_not be_empty
+        expect(result.addresses.first.street).to eq("Wilhelminapark")
+        expect(result.addresses.first.postcode).to eq("5041EB")
+        expect(result.addresses.first.municipality).to eq("Tilburg")
+        expect(result.addresses.first.latitude).to eq(51.566414786)
+        expect(result.addresses.first.longitude).to eq(5.07717893166)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postcodeapi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ariejan de Vroom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 3.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 3.4.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: 10.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.22.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.22.6
 description: Wrapper around the postcodeapi.nu API for resolving Dutch postal codes
 email:
 - ariejan@ariejan.net
@@ -77,6 +77,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.txt
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Wrapper around the postcodeapi.nu API.