international_postcode_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebc490944a9cf04410b96b757011f1a846967225fb62b25a04b45eed04bc83e2
+  data.tar.gz: a0e33a8c2be7a8710b3fb5f151081567802f2cc748f51a153c6e96019a124b34
+SHA512:
+  metadata.gz: 3f1a8e95a734875d01d86408ec103ff3757fe9c74d400fabebe2eac0da7fce186ad5aa79fcc156beb40d7bc7c0feaf0bdc5ac292273ed5647e6f11ef08f89941
+  data.tar.gz: f972286ea123866175b197e399495d0dc24d74994d4e1ed04e1a52ff78c61bf7a657b9d5968868031db45b80b4e9ab8089df8bedf3803f6e3c9ae765969e0318

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Added
+- initial release 0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+
+group :test do
+  gem 'byebug'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    international_postcode_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    webmock (3.11.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  international_postcode_api!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -0,0 +1,60 @@
+# Ruby wrapper for the postcode.eu endpoints
+https://www.postcode.nl/en/services/adresdata/international
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'international_postcode_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install international_postcode_api
+
+## Usage
+
+Create an initializer (config/intializers/international_postcode_api.rb)
+
+```ruby
+InternationalPostcodeApi.configure do |config|
+  config.api_key      = 'your-API-key'
+  config.secret_key   = 'your-secret-key'
+
+  # set new base_uri if new versions are released
+  # config.base_uri = 'https://api.postcode.eu/international/v1'
+
+  # Do not switch to Dutch endpoint for Dutch requests will dynamicly switch by default
+  # config.dynamic_endpoints = false
+end
+```
+
+## Methods
+
+All methods can be called from the client object:
+```ruby
+  InternationalPostcodeApi::Client.autocomplete('Amsterdam', 'nld')
+  required: term
+  optional: country_code, default: 'nld'
+
+  InternationalPostcodeApi::Client.details('$1234...')
+  required: context
+
+  InternationalPostcodeApi::Client.dutch_postcode('1000AB', '50', 'A')
+  required: zipcode, house_number
+  optional: house_number_addition, default: nil
+
+  # important!! #postcode only returns a hash with :street and :city dynamicly depending on
+  # which endpoint you are using, if you need access to the raw response use #dutch_postcode or #autocomplete + #details
+
+  InternationalPostcodeApi::Client.postcode('1000AB', '50', 'DE')
+  required: zipcode, house_number
+  optional: country_code, default: 'NL'
+
+  InternationalPostcodeApi::Client.supported_countries
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "international_postcode_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/international_postcode_api.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/international_postcode_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "international_postcode_api"
+  spec.version       = InternationalPostcodeApi::VERSION
+  spec.authors       = ["Dennis de Vulder"]
+  spec.email         = ["dennisdevulder@gmail.com"]
+
+  spec.summary       = %q{A ruby wrapper for the api.postcode.eu endpoints.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/advalley/international_postcode_api'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = 'https://github.com/advalley/international_postcode_api/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/international_postcode_api.rb

@@ -0,0 +1,26 @@
+require 'international_postcode_api/version'
+require 'international_postcode_api/client'
+require 'securerandom'
+require 'byebug'
+
+module InternationalPostcodeApi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key, :secret_key, :base_uri, :dynamic_endpoints
+    attr_reader :session_token
+
+    def initialize
+      @base_uri = 'https://api.postcode.eu/international/v1/'
+      @session_token = SecureRandom.hex(8)
+      @dynamic_endpoints = true
+    end
+  end
+end

data/lib/international_postcode_api/client.rb

@@ -0,0 +1,61 @@
+require 'net/https'
+require 'json'
+
+module InternationalPostcodeApi
+  class Client
+    def self.autocomplete(term, context = 'nld')
+      uri = generate_uri(:autocomplete, context, term)
+      fetch(uri)
+    end
+
+    def self.details(context)
+      uri = generate_uri(:address, context)
+      fetch(uri)
+    end
+
+    def self.dutch_postcode(postcode, house_number, house_number_addition = nil)
+      encoded_uri = URI.encode(['https://api.postcode.eu/nl/v1/addresses/postcode', postcode, house_number, house_number_addition].join('/'))
+      fetch URI.parse(encoded_uri)
+    end
+
+    def self.supported_countries
+      uri = generate_uri('supported-countries')
+      fetch(uri)
+    end
+
+    def self.postcode(postcode, house_number, lang = 'NL')
+      if lang == 'NL' && InternationalPostcodeApi.configuration.dynamic_endpoints
+        response = dutch_postcode(postcode, house_number)
+        return { street: response.dig('street'), city: response.dig('city') }
+      else
+        query = autocomplete [postcode, house_number].join(' ')
+        context = query['matches'][0].dig('context')
+        if context
+          response = details(context)
+          return { street: response.dig('address').dig('street'), city: response.dig('address').dig('locality')}
+        end
+      end
+    end
+
+    private
+
+    def self.generate_uri(*path)
+      encoded_uri = URI.encode(InternationalPostcodeApi.configuration.base_uri + path.join('/'))
+      URI.parse encoded_uri
+    end
+
+    def self.fetch(uri)
+      config = InternationalPostcodeApi.configuration
+
+      req = Net::HTTP::Get.new(uri)
+      req['X-Autocomplete-Session'] = config.session_token
+      req.basic_auth config.api_key, config.secret_key
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request req
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/international_postcode_api/version.rb

@@ -0,0 +1,3 @@
+module InternationalPostcodeApi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: international_postcode_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis de Vulder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-23 00:00:00.000000000 Z
+dependencies: []
+description: A ruby wrapper for the api.postcode.eu endpoints.
+email:
+- dennisdevulder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- international_postcode_api.gemspec
+- lib/international_postcode_api.rb
+- lib/international_postcode_api/client.rb
+- lib/international_postcode_api/version.rb
+homepage: https://github.com/advalley/international_postcode_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/advalley/international_postcode_api
+  source_code_uri: https://github.com/advalley/international_postcode_api
+  changelog_uri: https://github.com/advalley/international_postcode_api/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the api.postcode.eu endpoints.
+test_files: []