postcodes-norway 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e3861331f84d0c758a22530aecf954efe4cbbf1
+  data.tar.gz: 3e2491f1ddef57901818350aac11281dfd1ff033
+SHA512:
+  metadata.gz: 23606f575671ddd6d4df7763aef77bf514bcdc011c21e55c1c328e88aa44a8c7536e0ea11e36ac8376124ecd28de806bd076ad17af9424ae307cfd8913677e90
+  data.tar.gz: 931f601d6acf5841bcc4d0cdec1b68d348706e49ef6d6e448ec48e1bf9520fcb6906387090165070a67125152ab864321628478a8665d6c677b6b4d034198a8c

data/Rakefile

@@ -0,0 +1,8 @@
+load 'lib/tasks/norwegian-postcodes.rake'
+
+task :default => %w[test]
+
+desc "Run unit tests"
+task "test" do
+    sh 'ruby -Itest/ test/*.rb'
+end

data/lib/postcodes-norway.rb

@@ -0,0 +1,117 @@
+module PostCodes
+
+  require 'norwegian-postcodes/railtie' if defined?(Rails)
+
+  # Correspond to the Norwegian 'Fylke'
+  Counties = [
+    "ØSTFOLD",
+    "AKERSHUS",
+    "OSLO",
+    "HEDMARK",
+    "OPPLAND",
+    "BUSKERUD",
+    "VESTFOLD",
+    "TELEMARK",
+    "AUST-AGDER",
+    "VEST-AGDER",
+    "ROGALAND",
+    "HORDALAND",
+    "(BERGEN)",
+    "SOGN OG FJORDANE",
+    "MØRE OG ROMSDAL",
+    "SØR-TRØNDELAG",
+    "NORD-TRØNDELAG",
+    "NORDLAND",
+    "TROMS",
+    "FINNMARK",
+    "SVALBARD",
+    "JAN MAYEN",
+    "KONTINENTALSOKKELEN"
+  ]
+
+  # Class for holding postcode data
+  class PostCode
+    # Four digit post code
+    attr_reader :postcode
+
+    # Name of city
+    attr_reader :city
+
+    # Four digit municipality ('kommune') id
+    attr_reader :municipality
+
+    # Name of municipality ('kommune')
+    attr_reader :municipality_name
+
+    # Category
+    # * 'G' = street address
+    # * 'P' = Postboxes
+    # * 'B' = Both street addresses and postboxes
+    # * 'S' = Service addresses
+    # * 'K' = Customer with its own post code
+    # * 'F' = Multiple uses
+    attr_reader :cat
+
+    # Create a new post code.
+    # This method should generally not be used by users of the library.
+    def initialize(postcode, city, muni, muni_name, cat)
+      @postcode, @city, @municipality, @municipality_name, @cat = postcode, city, muni, muni_name, cat
+    end
+
+    # Return the County ('kommune') from the postcode data.
+    # The returned format is `[county_id, county_name]`
+    def county
+      code = @municipality[0..1].to_i
+      [code, PostCodes.county(code)]
+    end
+
+    # Output postcode data in the same format as in the original postcode database.
+    def to_s
+      [@postcode, @city, @municipality, @municipality_name, @cat].join("\t")
+    end
+  end
+
+  class << self
+
+    # Load the postcode data into memory.
+    #
+    # +file+ is a file name or IO object to read the data from.
+    def load(file)
+      @postcodes = []
+      if file.is_a?(String)
+        f = File.open(file, :encoding => Encoding::ISO_8859_15)
+      else
+        f = file
+      end
+
+      f.each_line do |l|
+        a = l.chomp().split("\t").map{|s| s.encode(Encoding::UTF_8)}
+        @postcodes << PostCode.new(*a)
+      end
+    end
+
+    # Search for a given postcode.
+    #
+    # Takes a 4 digit postcode as a string, and returns an object of
+    # type PostCodes::PostCode, or +nil+ if the postcode was not found.
+    #
+    def search(postcode)
+      res = @postcodes.bsearch {|x| x.postcode.to_i >= postcode.to_i}
+      unless res.nil?
+        res.postcode.to_i == postcode.to_i ? res : nil
+      end
+    end
+
+    # Return the county by number.
+    #
+    # Takes a number between 1 and 23 as input. This corresponds to the
+    # first two digits in the municipality number.
+    #
+    # The county name as a string is returned.
+    #
+    def county(index)
+      return nil unless index > 0 && index <= Counties.size
+      Counties[index - 1]
+    end
+  end
+end

data/lib/postcodes-norway/railtie.rb

@@ -0,0 +1,11 @@
+require 'norwegian-postcodes'
+require 'rails'
+
+module PostCodes
+  class Railtie < Rails::Railtie
+    railtie_name :norwegian_postcodes
+    rake_tasks do
+      load 'tasks/norwegian-postcodes.rake'
+    end
+  end
+end

data/lib/tasks/postcodes-norway.rake

@@ -0,0 +1,13 @@
+require 'uri'
+require 'open-uri'
+
+namespace :postcodes do
+  desc "Fetch postcode database from Bring"
+  task :fetch, [:data_path] do |t, args|
+    args.with_defaults(:data_path => 'data')
+    uri = URI.parse('http://www.bring.no/hele-bring/forside/_attachment/159761')
+    filename = File.join(args.data_path, 'Postnummerregister_ansi.txt')
+    puts "Downloading postcodes to: #{filename}..."
+    IO.write(filename, uri.read)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: postcodes-norway
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harald Eilertsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies: []
+description: Parses the Norwegian postcode database as published by Bring, and lets
+  you search and use the data from Ruby.
+email: haraldei@anduin.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/postcodes-norway.rb
+- lib/postcodes-norway/railtie.rb
+- lib/tasks/postcodes-norway.rake
+homepage: https://github.com/snake66/postcodes-norway
+licenses:
+- GPLv3
+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.5
+signing_key: 
+specification_version: 4
+summary: A simple interface to the Norwegian postcode database.
+test_files: []