ww-postcodeapi 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 1.9.3
+script: rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 martijnschouwe
+
+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,51 @@
+# Postcodeapi
+
+[![Build Status](https://travis-ci.org/martijnschouwe/postcodeapi.png)](https://travis-ci.org/martijnschouwe/postcodeapi) [![Code Climate](https://codeclimate.com/github/martijnschouwe/postcodeapi.png)](https://codeclimate.com/github/martijnschouwe/postcodeapi) [![Gem Version](https://badge.fury.io/rb/postcodeapi.png)](http://badge.fury.io/rb/postcodeapi)
+
+API wrapper for postcodeapi.nu zipcode api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ww-postcodeapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postcodeapi
+
+## Setup
+
+Add file `config/initializers/postcodeapi.rb`.
+
+    require 'postcodeapi'
+    Postcodeapi.configure do |config|
+      config.api_key = "1234567890abcdefghizjklmnopqrstuvwxyz"
+    end
+
+## Example usage
+
+Get an address for a zipcode:
+
+    response = Postcodeapi.get_street("5041EB")
+    # => #<OpenStruct street="Wilhelminapark", postcode="5041EB", town="Tilburg", latitude=51.9401, longitude=5.61531, x=133505, y=397537>
+
+
+You can then use:
+
+    response.street
+    # => "Wilhelminapark"
+    response.town
+    # => "Tilburg"
+
+## 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/lib/postcodeapi.rb

@@ -0,0 +1,51 @@
+require "postcodeapi/version"
+require "rest-client"
+require "ostruct"
+require 'json'
+
+module Postcodeapi
+
+  class << self
+    attr_accessor :api_url, :api_key
+    def configure(&blk); class_eval(&blk); end
+  end
+
+  def self.get_street(zipcode)
+    # Format the zipcode
+    zipcode = format_zipcode(zipcode)
+    # Perform request
+    response = RestClient.get "#{@api_url}/#{zipcode}", {:content_type => :json, :accept => :json, :'Api-Key' => @api_key}
+    # Return openstruct output
+    res = JSON.parse(response.to_str,{symbolize_names: true})
+    OpenStruct.new res[:resource]
+  end
+
+  def self.format_zipcode(zipcode = nil)
+    if zipcode.nil? || zipcode == ""
+      raise Exception.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 Exception.new("Incorrect 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
+    "Postcodeapi version #{Postcodeapi::VERSION}"
+  end
+end
+
+# Set default configuration
+Postcodeapi.configure do
+  @api_url  = 'http://api.postcodeapi.nu'
+  @api_key = '1234567890abcdefghizjklmnopqrstuvwxyz'
+end
+

data/lib/postcodeapi/version.rb

@@ -0,0 +1,3 @@
+module Postcodeapi
+  VERSION = "0.0.1"
+end

data/postcodeapi.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postcodeapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ww-postcodeapi"
+  spec.version       = Postcodeapi::VERSION
+  spec.authors       = ["martijnschouwe"]
+  spec.email         = ["martijnschouwe@hotmail.com"]
+  spec.description   = %q{API wrapper for postcodeapi.nu zipcode api}
+  spec.summary       = %q{Get address details from the postcodeapi.nu api}
+  spec.homepage      = "https://github.com/martijnschouwe/postcodeapi"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "capybara", "~> 2.1.0"
+  spec.add_development_dependency "vcr", "~> 2.4.0"
+  spec.add_development_dependency "webmock", "~> 1.8.0"
+  spec.add_runtime_dependency "rest-client"
+end

data/spec/lib/postcode_api_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Postcodeapi do
+  it 'should remove spaces from zipcode' do
+    Postcodeapi.format_zipcode("1234 AB").should eq "1234AB"
+  end
+
+  it 'should upcase the zipcode' do
+    Postcodeapi.format_zipcode("1234ab").should eq "1234AB"
+  end
+
+  it 'should raise an exception' do
+    expect { Postcodeapi.format_zipcode(nil) }.to raise_error
+    expect { Postcodeapi.format_zipcode("") }.to raise_error
+    expect { Postcodeapi.format_zipcode("111") }.to raise_error
+    expect { Postcodeapi.format_zipcode("1111A") }.to raise_error
+    expect { Postcodeapi.format_zipcode("11111A") }.to raise_error
+    expect { Postcodeapi.format_zipcode("AAAA") }.to raise_error
+    expect { Postcodeapi.format_zipcode("11AA") }.to raise_error
+  end
+
+  it 'should return an address result' do
+    VCR.use_cassette('get_street', :allow_playback_repeats => true) do
+      json_response_mock = '{
+          "success": true,
+          "resource": {
+              "street": "Wilhelminapark",
+              "postcode": "5041EB",
+              "town": "Tilburg",
+              "latitude": 51.9401,
+              "longitude": 5.61531,
+              "x": 133505,
+              "y": 397537
+          }
+      }'
+      res = JSON.parse(json_response_mock.to_str,{symbolize_names: true})
+      Postcodeapi.get_street("5041EB").should eq OpenStruct.new(res[:resource])
+      Postcodeapi.get_street("5041EB").street.should eq "Wilhelminapark"
+    end
+  end
+
+
+  it 'should return correct version string' do
+    Postcodeapi.version_string.should eq "Postcodeapi version #{Postcodeapi::VERSION}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'vcr'
+require 'webmock'
+
+require 'postcodeapi'
+
+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/get_street.yml

@@ -0,0 +1,42 @@
+--- 
+http_interactions: 
+  - 
+    recorded_at: "Mon, 09 Dec 2013 15:02:48 GMT"
+    request: 
+      body: 
+        encoding: UTF-8
+        string: ""
+      headers: 
+        Accept: 
+          - "*/*; q=0.5, application/json"
+        Accept-Encoding: 
+          - "gzip, deflate"
+        Api-Key: 
+          - 1234567890abcdefghizjklmnopqrstuvwxyz
+        User-Agent: 
+          - Ruby
+      method: get
+      uri: "http://api.postcodeapi.nu/5041EB"
+    response: 
+      body: 
+        encoding: UTF-8
+        string: "{ \"success\": true, \"resource\": { \"street\": \"Wilhelminapark\", \"postcode\": \"5041EB\", \"town\": \"Tilburg\", \"latitude\": 51.9401, \"longitude\": 5.61531, \"x\": 133505, \"y\": 397537 } }"
+      headers: 
+        Alternate-Protocol: 
+          - "80:quic,80:quic"
+        Cache-Control: 
+          - no-cache
+        Content-Type: 
+          - "application/json; charset=utf-8"
+        Date: 
+          - "Mon, 09 Dec 2013 15:02:48 GMT"
+        Server: 
+          - "Google Frontend"
+        Transfer-Encoding: 
+          - chunked
+        Vary: 
+          - Accept-Encoding
+      http_version: ~
+      status: 
+        code: 200
+        message: OK

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ww-postcodeapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- martijnschouwe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API wrapper for postcodeapi.nu zipcode api
+email:
+- martijnschouwe@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/postcodeapi.rb
+- lib/postcodeapi/version.rb
+- postcodeapi.gemspec
+- spec/lib/postcode_api_spec.rb
+- spec/spec_helper.rb
+- spec/vcr/get_street.yml
+homepage: https://github.com/martijnschouwe/postcodeapi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Get address details from the postcodeapi.nu api
+test_files:
+- spec/lib/postcode_api_spec.rb
+- spec/spec_helper.rb
+- spec/vcr/get_street.yml