dcentralized-api 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f55032b39a0672e4477ee78397ca1aa0b7f06bd
+  data.tar.gz: 4f70559bef2ae74f8b7712e5a1c9751eaf2a5685
+SHA512:
+  metadata.gz: f28fa5eb68206b4bd64bd88eb6b548f73cef9a4b81797d53dda17c7f84d34dcb268ca89839c3420d1000873b303f3a043ebd65abad78bda7da1dec8f4fc01707
+  data.tar.gz: 650e671349214731cced22dbe7dcfab15a5b96d0febc629c0df0cd21a83cad7bae87b6982c46f9af778e2b46b0ec5a3ea1c1d1f3ec0542614b1909ba39534e28

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+# Ignore RubyMine
+/.idea
+

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+ - 1.9.3
+script: rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dcentralized.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick den Engelsman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+[![Build Status](https://travis-ci.org/nicka/dcentralized.png?branch=develop)](https://travis-ci.org/nicka/dcentralized) [![Code Climate](https://codeclimate.com/github/nicka/dcentralized.png)](https://codeclimate.com/github/nicka/dcentralized) [![Gem Version](https://badge.fury.io/rb/dcentralized.png)](http://badge.fury.io/rb/dcentralized)
+
+# Dcentralized
+
+API wrapper for Pro6PP zipcode database(d-centralize.nl). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dcentralized'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dcentralized
+
+## Setup
+
+Add file `config/initializers/dcentralized.rb`.
+
+    require 'dcentralized'
+    Dcentralized.configure do |config|
+      config.api_key = "123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ"
+    end
+
+## Example usage
+
+High detailed zipcode result:
+
+    response = Dcentralized.auto_complete("2564AZ")
+    # => #<OpenStruct nl_sixpp="2564AZ", street="Laan van Meerdervoort", city="'s-Gravenhage", municipality="'s-Gravenhage", province="Zuid-Holland", streetnumbers="1096-1126", lat="52.06751", lng="4.24733", areacode="070">
+
+Low detailed zipcode result:
+
+    response = Dcentralized.auto_complete("2564")
+    # => #<OpenStruct nl_fourpp="2564", city="'s-Gravenhage", municipality="'s-Gravenhage", province="Zuid-Holland", areacode="070", lat="52.068", lng="4.25724">
+
+You can then use:
+
+    response.street
+    # => "Laan van Meerdervoort"
+    response.province
+    # => "Zuid-Holland"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dcentralized.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dcentralized/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dcentralized-api"
+  gem.version       = Dcentralized::VERSION
+  gem.authors       = ["Nick den Engelsman"]
+  gem.email         = ["nickdenengelsman@codedrops.nl"]
+  gem.description   = %q{API wrapper for d-centralize.nl}
+  gem.summary       = %q{Retreive data from the Pro6PP zipcode database}
+  gem.homepage      = "https://github.com/corklaassebos/dcentralized"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "rest-client", "~> 1.6"
+  gem.add_development_dependency "rspec", "~> 2.13"
+  gem.add_development_dependency "capybara", "~> 2.1"
+  gem.add_development_dependency "vcr", "~> 2.4"
+  gem.add_development_dependency "webmock", "~> 1.8"
+  gem.add_development_dependency "simplecov", "~> 0.7"
+end

data/lib/dcentralized.rb

@@ -0,0 +1,60 @@
+require "rest-client"
+require "ostruct"
+require "dcentralized/version"
+require 'dcentralized/invalid_postcode_exception'
+
+module Dcentralized
+  class << self
+    attr_accessor :api_url, :api_key
+    def configure(&blk); class_eval(&blk); end
+  end
+
+  def self.auto_complete(zipcode, house_number = nil)
+    # Format the zipcode
+    zipcode = format_zipcode(zipcode)
+    # Setup request
+    params  = {auth_key: @api_key}
+    zipcode.length == 6 ? params.merge!(nl_sixpp: zipcode) : params.merge!(nl_fourpp: zipcode)
+    params.merge!(format: 'json')
+    params.merge!(streetnumber: house_number) if house_number
+
+    # Perform request
+    response = JSON.parse(RestClient.get "#{@api_url}/autocomplete", {params: params})
+
+    if response["status"] == "ok"
+      return OpenStruct.new response["results"].first
+    elsif response["status"] == "error"
+      raise InvalidPostcodeException, response["error"]["message"]
+    else
+      raise Exception.new("Unknown exception in Pro6PP auto_complete response")
+    end
+  end
+
+  def self.format_zipcode(zipcode = nil)
+    if zipcode.nil? || zipcode == ""
+      raise InvalidPostcodeException.new("No zipcode provided")
+    elsif (zipcode =~ /^[0-9]{4}$|[0-9]{4}[\ ]{1}[a-zA-Z]{2}$|[0-9]{4}[a-zA-Z]{2}$/).nil?
+      raise InvalidPostcodeException.new("Wrong zipcode format (1234AB format expected)")
+    else
+      zipcode.gsub(" ", "").upcase
+    end
+  end
+
+  def self.stringify(obj)
+    if obj.is_a? Array
+      obj.join
+    elsif obj.is_a? Hash
+      obj.merge( obj ) {|k, val| stringify val }
+    end
+  end
+
+  def self.version_string
+    "Dcentralized version #{Dcentralized::VERSION}"
+  end
+end
+
+# Set default configuration
+Dcentralized.configure do
+  @api_url  = "http://api.pro6pp.nl/v1"
+  @api_key = "123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ"
+end

data/lib/dcentralized/invalid_postcode_exception.rb

@@ -0,0 +1,5 @@
+module Dcentralized
+  class InvalidPostcodeException < Exception
+
+  end
+end

data/lib/dcentralized/version.rb

@@ -0,0 +1,3 @@
+module Dcentralized
+  VERSION = "0.0.6"
+end

data/spec/lib/dcentralized_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Dcentralized do
+  it 'should remove spaces from zipcode' do
+    Dcentralized.format_zipcode("2564 AZ").should eq "2564AZ"
+  end
+
+  it 'should upcase the zipcode' do
+    Dcentralized.format_zipcode("2564az").should eq "2564AZ"
+  end
+
+  it 'should raise an exception' do
+    expect { Dcentralized.format_zipcode(nil) }.to raise_error
+    expect { Dcentralized.format_zipcode("") }.to raise_error
+    expect { Dcentralized.format_zipcode("111") }.to raise_error
+    expect { Dcentralized.format_zipcode("1111A") }.to raise_error
+    expect { Dcentralized.format_zipcode("11111A") }.to raise_error
+    expect { Dcentralized.format_zipcode("AAAA") }.to raise_error
+    expect { Dcentralized.format_zipcode("11AA") }.to raise_error
+  end
+
+  it 'should return high detailed result' do
+    VCR.use_cassette('auto_complete_high') do
+      xml_response_mock = {
+        :nl_sixpp => "2564AZ",
+        :street => "Laan van Meerdervoort",
+        :city => "'s-Gravenhage",
+        :municipality => "'s-Gravenhage",
+        :province => "Zuid-Holland",
+        :streetnumbers => "1096-1126",
+        :lat => "52.06751",
+        :lng => "4.24733",
+        :areacode => "070"
+      }
+      Dcentralized.auto_complete("2564AZ").should eq OpenStruct.new(xml_response_mock)
+      Dcentralized.auto_complete("2564AZ").street.should eq "Laan van Meerdervoort"
+    end
+  end
+
+  it 'should return low detailed result' do
+    VCR.use_cassette('auto_complete_low') do
+      xml_response_mock = {
+        :nl_fourpp => "2564",
+        :city => "'s-Gravenhage",
+        :municipality => "'s-Gravenhage",
+        :province => "Zuid-Holland",
+        :areacode => "070",
+        :lat => "52.068",
+        :lng => "4.25724"
+      }
+      Dcentralized.auto_complete("2564").should eq OpenStruct.new(xml_response_mock)
+      Dcentralized.auto_complete("2564").street.should eq nil
+    end
+  end
+
+  it 'should return correct version string' do
+    Dcentralized.version_string.should eq "Dcentralized version #{Dcentralized::VERSION}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'vcr'
+require 'webmock'
+require 'simplecov'
+SimpleCov.start
+require 'dcentralized'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/vcr'
+  config.hook_into :webmock
+end

data/spec/vcr/auto_complete_high.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.pro6pp.nl/v1/autocomplete?auth_key=123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ&format=xml&nl_sixpp=2564AZ&pretty=True
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/xml; charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Fri, 13 Sep 2013 15:02:48 GMT
+      Server:
+      - Google Frontend
+      Alternate-Protocol:
+      - 80:quic,80:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status>ok</status>\n
+        \ <results>\n    <result>\n      <nl_sixpp>2564AZ</nl_sixpp>\n      <street>Laan
+        van Meerdervoort</street>\n      <city>'s-Gravenhage</city>\n      <municipality>'s-Gravenhage</municipality>\n
+        \     <province>Zuid-Holland</province>\n      <streetnumbers>1096-1126</streetnumbers>\n
+        \     <lat>52.06751</lat>\n      <lng>4.24733</lng>\n      <areacode>070</areacode>\n
+        \   </result>\n  </results>\n</response>\n"
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 15:02:48 GMT
+- request:
+    method: get
+    uri: http://api.pro6pp.nl/v1/autocomplete?auth_key=123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ&format=xml&nl_sixpp=2564AZ&pretty=True
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/xml; charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Fri, 13 Sep 2013 15:02:48 GMT
+      Server:
+      - Google Frontend
+      Alternate-Protocol:
+      - 80:quic,80:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status>ok</status>\n
+        \ <results>\n    <result>\n      <nl_sixpp>2564AZ</nl_sixpp>\n      <street>Laan
+        van Meerdervoort</street>\n      <city>'s-Gravenhage</city>\n      <municipality>'s-Gravenhage</municipality>\n
+        \     <province>Zuid-Holland</province>\n      <streetnumbers>1096-1126</streetnumbers>\n
+        \     <lat>52.06751</lat>\n      <lng>4.24733</lng>\n      <areacode>070</areacode>\n
+        \   </result>\n  </results>\n</response>\n"
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 15:02:49 GMT
+recorded_with: VCR 2.4.0

data/spec/vcr/auto_complete_low.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.pro6pp.nl/v1/autocomplete?auth_key=123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ&format=xml&nl_fourpp=2564&pretty=True
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/xml; charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Fri, 13 Sep 2013 15:02:49 GMT
+      Server:
+      - Google Frontend
+      Alternate-Protocol:
+      - 80:quic,80:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status>ok</status>\n
+        \ <results>\n    <result>\n      <nl_fourpp>2564</nl_fourpp>\n      <city>'s-Gravenhage</city>\n
+        \     <municipality>'s-Gravenhage</municipality>\n      <province>Zuid-Holland</province>\n
+        \     <areacode>070</areacode>\n      <lat>52.068</lat>\n      <lng>4.25724</lng>\n
+        \   </result>\n  </results>\n</response>\n"
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 15:02:49 GMT
+- request:
+    method: get
+    uri: http://api.pro6pp.nl/v1/autocomplete?auth_key=123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ&format=xml&nl_fourpp=2564&pretty=True
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/xml; charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Date:
+      - Fri, 13 Sep 2013 15:02:49 GMT
+      Server:
+      - Google Frontend
+      Alternate-Protocol:
+      - 80:quic,80:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <status>ok</status>\n
+        \ <results>\n    <result>\n      <nl_fourpp>2564</nl_fourpp>\n      <city>'s-Gravenhage</city>\n
+        \     <municipality>'s-Gravenhage</municipality>\n      <province>Zuid-Holland</province>\n
+        \     <areacode>070</areacode>\n      <lat>52.068</lat>\n      <lng>4.25724</lng>\n
+        \   </result>\n  </results>\n</response>\n"
+    http_version: 
+  recorded_at: Fri, 13 Sep 2013 15:02:49 GMT
+recorded_with: VCR 2.4.0

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: dcentralized-api
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Nick den Engelsman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: API wrapper for d-centralize.nl
+email:
+- nickdenengelsman@codedrops.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dcentralized.gemspec
+- lib/dcentralized.rb
+- lib/dcentralized/invalid_postcode_exception.rb
+- lib/dcentralized/version.rb
+- spec/lib/dcentralized_spec.rb
+- spec/spec_helper.rb
+- spec/vcr/auto_complete_high.yml
+- spec/vcr/auto_complete_low.yml
+homepage: https://github.com/corklaassebos/dcentralized
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Retreive data from the Pro6PP zipcode database
+test_files:
+- spec/lib/dcentralized_spec.rb
+- spec/spec_helper.rb
+- spec/vcr/auto_complete_high.yml
+- spec/vcr/auto_complete_low.yml