postcodeapi 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+-c -fd

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "bundle exec rspec spec/"
+rvm:
+  - 1.9.3
+
+

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 Ariejan de Vroom
+
+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,68 @@
+# Postcodeapi [![Build Status](https://travis-ci.org/ariejan/postcodeapi.png?branch=master)](https://travis-ci.org/ariejan/postcodeapi)
+
+This is a small Ruby wrapper around the postcodeapi.nu API, which allows you 
+to resolve Dutch postcodes to street and city names.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'postcodeapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postcodeapi
+
+## Usage
+
+Firstly, sign up for a free API key at http://postcodeapi.nu, then juse this gem:
+
+    api = Postcode::API.new("your-api-key")
+    result = api.postcode("5041EB")
+
+    result.resource.street
+    => "Wilhelminastraat"
+
+## Contributing
+
+Please make sure you add specs for your features. Pull requests without proper
+specs will not be merged.
+
+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
+
+## Contributors
+
+Original author: 
+
+ * Ariejan de Vroom, https://ariejan.net
+
+## LICENSE
+
+Copyright (c) 2013 Ariejan de Vroom
+
+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/Rakefile

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

data/lib/postcodeapi/api.rb

@@ -0,0 +1,18 @@
+module Postcode
+  # You're required to sign up for an api key at http://postcodeapi.nu
+  class API
+    include HTTParty
+
+    base_uri "http://api.postcodeapi.nu"
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def postcode(postcode, options = {})
+      options.merge!(:headers => { "Api-Key" => @api_key})
+      response = self.class.get("/#{postcode}", options)
+      Hashie::Mash.new(response.parsed_response)
+    end
+  end
+end

data/lib/postcodeapi/version.rb

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

data/lib/postcodeapi.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+
+require 'httparty'
+require 'hashie'
+
+require "postcodeapi/version"
+require "postcodeapi/api"
+
+module Postcode
+end

data/postcodeapi.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postcodeapi/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "postcodeapi"
+  gem.version       = Postcode::VERSION
+  gem.authors       = ["Ariejan de Vroom"]
+  gem.email         = ["ariejan@ariejan.net"]
+  gem.description   = %q{Wrapper around the postcodeapi.nu API for resolving Dutch postal codes}
+  gem.summary       = %q{Wrapper around the postcodeapi.nu API.}
+  gem.homepage      = "https://github.com/ariejan/postcodeapi"
+
+  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_dependency 'httparty', '~> 0.10.2'
+  gem.add_dependency 'hashie', '~> 1.2.0'
+
+  gem.add_development_dependency 'rake', '~> 10.0.3'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'webmock', '~> 1.9.0'
+end

data/spec/postcodeapi/api_spec.rb

@@ -0,0 +1,49 @@
+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'}).
+        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')
+
+      result.success.should be_false
+      result.error.code.should eq(401)
+    end
+  end
+
+  context "with a valid API key" 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"})
+    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)
+    end
+  end
+end
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'webmock/rspec'
+
+require File.expand_path('../../lib/postcodeapi', __FILE__)
+
+RSpec.configure do |config|
+  config.include WebMock::API
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: postcodeapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ariejan de Vroom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+description: Wrapper around the postcodeapi.nu API for resolving Dutch postal codes
+email:
+- ariejan@ariejan.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/postcodeapi.rb
+- lib/postcodeapi/api.rb
+- lib/postcodeapi/version.rb
+- postcodeapi.gemspec
+- spec/postcodeapi/api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ariejan/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'
+      segments:
+      - 0
+      hash: -20125056826090370
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -20125056826090370
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Wrapper around the postcodeapi.nu API.
+test_files:
+- spec/postcodeapi/api_spec.rb
+- spec/spec_helper.rb