un_locode 0.0.1

data/data/db.rb

@@ -0,0 +1,32 @@
+require_relative 'schema.rb'
+
+module UnLocode
+  class DB
+    def initialize(name = 'db.sqlite')
+      @database_name = File.expand_path(name.downcase, File.dirname(__FILE__))
+    end
+
+    def reset
+      File.delete(@database_name) if File.exists?(@database_name)
+      connect_to_db
+      Schema.new.change
+    end
+
+    def connect_to_db
+      ActiveRecord::Base.configurations.merge!(config)
+
+      @connection ||= ActiveRecord::Base.establish_connection('un_locode')
+    end
+
+    private
+
+    def config
+      {
+        'un_locode' => {
+          'adapter' => 'sqlite3',
+          'database' => @database_name
+        }
+      }
+    end
+  end
+end

data/data/locode_data_update.rb

@@ -0,0 +1,106 @@
+require 'csv'
+require 'pry'
+require 'yaml'
+require_relative 'db'
+require_relative '../lib/un_locode'
+
+class LocodeDataUpdate
+
+  def self.parse
+    UnLocode::DB.new.reset
+    parse_locodes
+  end
+
+  private
+
+  def self.parse_locodes
+    Dir.glob('./data/csv/*.csv') do |file|
+      CSV.parse(File.open(file, 'r:ISO-8859-1')) do |row|
+        if country_row?(row)
+          parse_country(row)
+        else locode_row?(row)
+          parse_locode(row)
+        end
+      end
+    end
+  end
+
+  def self.parse_country row
+    country_code = row[1]
+    country_name = row[3].gsub('.', '')
+
+    UnLocode::Country.create(code: country_code, name: country_name)
+  end
+
+  # sample input: "--34-6--"
+  def self.parse_function_attributes str_function
+    function_array = str_function.split(//)
+    {
+      port: function_array[0] == '1',
+      rail_terminal: function_array[1] == '2',
+      road_terminal: function_array[2] == '3',
+      airport: function_array[3] == '4',
+      postal_exchange_office: function_array[4] == '5',
+      inland_clearance_depot: function_array[5] == '6',
+      fixed_transport_functions: function_array[6] == '7',
+      border_crossing_function: function_array[7].try(:upcase) == 'B'
+    }
+  end
+
+  def self.parse_name_attr name, name_wo_diacritics
+    {
+      name:               name.strip,
+      name_wo_diacritics: name_wo_diacritics.strip,
+    }
+  end
+
+  #As a service to users, names that have been changed may be included for reference. Such alternative
+  #name versions are included as a transitional measure after a name change; they are followed by an
+  #equal sign (=), e.g.:
+  #
+  #Peking = Beijing
+  #Leningrad = St Petersburg
+  #
+  #The code element will be shown only under the new name.
+  def self.parse_name_attr_with_alternatives name, name_wo_diacritics
+    {
+      name:                           name.split('=').last.strip,
+      name_wo_diacritics:             name_wo_diacritics.split('=').last.strip,
+      alternative_name:               name.split('=').first.strip,
+      alternative_name_wo_diacritics: name_wo_diacritics.split('=').first.strip
+    }
+  end
+
+  def self.has_alternatives? changes
+    changes == '='
+  end
+
+  def self.parse_locode row
+    country = UnLocode::Country.find_by_code(row[1])
+    function_attr = parse_function_attributes(row[6])
+    name_attr = has_alternatives?(row[0]) ? parse_name_attr_with_alternatives(row[3], row[4]) : parse_name_attr(row[3], row[4])
+
+    location_attributes = {
+      change_marker:      row[0],
+      country:            country,
+      city_code:          row[2],
+      sub_div:            row[5],
+      status:             row[7],
+      date:               row[8],
+      iata:               row[9],
+      coordinates:        row[10],
+      remarks:            row[11]
+    }
+    location_attributes.merge!(function_attr).merge!(name_attr)
+
+    UnLocode::Locode.create(location_attributes)
+  end
+
+  def self.country_row?(row)
+    !!row[1] && !!row[3] && row[3][0] == '.'
+  end
+
+  def self.locode_row?(row)
+    !row[2].nil?
+  end
+end

data/data/schema.rb

@@ -0,0 +1,36 @@
+class Schema < ActiveRecord::Migration
+
+  def change
+    create_table :countries do |t|
+      t.string :code
+      t.string :name
+    end
+
+    create_table :locodes do |t|
+      t.string :change_marker
+      t.integer :country_id
+      t.string :city_code
+      t.string :name
+      t.string :name_wo_diacritics
+      t.string :alternative_name
+      t.string :alternative_name_wo_diacritics
+      t.string :sub_div
+      t.boolean :port
+      t.boolean :rail_terminal
+      t.boolean :road_terminal
+      t.boolean :airport
+      t.boolean :postal_exchange_office
+      t.boolean :inland_clearance_depot
+      t.boolean :fixed_transport_functions
+      t.boolean :border_crossing_function
+      t.string :status
+      t.date :date
+      t.string :iata
+      t.string :coordinates
+      t.string :remarks
+    end
+
+    add_index(:locodes, [:country_id, :city_code, :change_marker])
+  end
+end
+

data/debug.log

@@ -0,0 +1,4 @@
+# Logfile created on 2013-11-12 14:10:48 +0100 by logger.rb/36483
+D, [2013-11-12T14:18:24.946578 #12430] DEBUG -- :    (1.1ms)  CREATE TABLE "countries" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "country_code" varchar(255)) 
+D, [2013-11-12T14:18:24.948119 #12430] DEBUG -- :    (0.9ms)  CREATE TABLE "cities" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "city_code" varchar(255), "full_name" varchar(255), "full_name_without_diacritics" varchar(255), "subdivision" varchar(255), "function_classifier" varchar(255), "status" varchar(255), "date" date, "iata_code" varchar(255), "coordinates" varchar(255), "country_id" integer) 
+D, [2013-11-12T14:18:24.949447 #12430] DEBUG -- :    (0.8ms)  CREATE TABLE "functions" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "funciton_id" varchar(255)) 

data/lib/un_locode/base_record.rb

@@ -0,0 +1,6 @@
+module UnLocode
+  class BaseRecord < ActiveRecord::Base
+    self.abstract_class = true
+    establish_connection 'un_locode'
+  end
+end

data/lib/un_locode/country.rb

@@ -0,0 +1,9 @@
+module UnLocode
+  class Country < BaseRecord
+    has_many :locodes
+
+    def as_json options = {}
+      super options.merge(except: [:id])
+    end
+  end
+end

data/lib/un_locode/locode.rb

@@ -0,0 +1,31 @@
+module UnLocode
+  FUNCTIONS = [:port,
+               :rail_terminal,
+               :road_terminal,
+               :airport,
+               :postal_exchange_office,
+               :inland_clearance_depot,
+               :fixed_transport_functions,
+               :border_crossing_function].freeze
+
+  class Locode < BaseRecord
+    belongs_to :country
+
+    def self.find_by_fuzzy_name name, limit = 10
+      where('name like ? or
+             name_wo_diacritics like ? or
+             alternative_name like ? or
+             alternative_name_wo_diacritics like ?',
+            "%#{name}%", "%#{name}%", "%#{name}%", "%#{name}%").limit(limit)
+    end
+
+    def self.find_by_name_and_function name, function, limit = 10
+      raise "Unsupported Locode Function! Should be one of #{UnLocode::FUNCTIONS.join(' ')}." unless UnLocode::FUNCTIONS.include?(function)
+      find_by_fuzzy_name(name).where(function => true).limit(limit)
+    end
+
+    def as_json options = {}
+      super(options.merge!(except: [:id, :country_id])).merge('country' => country.as_json)
+    end
+  end
+end

data/lib/un_locode/version.rb

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

data/lib/un_locode.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require_relative '../data/db'
+
+module UnLocode
+  UnLocode::DB.new().connect_to_db unless ENV['ENV'] == 'test'
+end
+
+require 'un_locode/base_record'
+require 'un_locode/version'
+require 'un_locode/country'
+require 'un_locode/locode'

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+ENV['ENV'] ||= 'test'
+
+require 'pry'
+require 'active_record'
+require_relative '../data/db'
+
+db = UnLocode::DB.new('../tmp/test_db.sqlite')
+db.reset
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.after(:each) do
+    UnLocode::Locode.destroy_all
+  end
+end

data/spec/un_locode_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'un_locode'
+
+describe UnLocode::Locode do
+
+  describe 'scopes' do
+
+    describe 'retrieving locodes by name' do
+
+      let!(:city) { UnLocode::Locode.create(name: 'Eindhoven', name_wo_diacritics: 'Eeindhoven') }
+      let!(:other_city) { UnLocode::Locode.create(name: 'Weert') }
+
+      subject { UnLocode::Locode.find_by_fuzzy_name(search_term) }
+
+      context 'exact match' do
+        let(:search_term) { city.name }
+        its(:first) { should eql(city) }
+        its(:count) { should eql(1) }
+      end
+
+      context 'fuzzy match' do
+        let(:search_term) { city.name[1..4] }
+        its(:first) { should eql(city) }
+        its(:count) { should eql(1) }
+      end
+
+      [:name, :name_wo_diacritics, :alternative_name, :alternative_name_wo_diacritics].each do |attr|
+        context "matches against the #{attr} name fields" do
+          let!(:city) { UnLocode::Locode.create(attr => 'Eindhoven') }
+          let(:search_term) { 'Eindhoven' }
+          its(:first) { should eql(city) }
+          its(:count) { should eql(1) }
+        end
+      end
+
+      context 'case insensitive names' do
+        let(:search_term) { city.name.downcase }
+
+        its(:first) { should eql(city) }
+        its(:count) { should eql(1) }
+      end
+
+    end
+
+    context 'retrieving locodes by name and function' do
+      let!(:port) { UnLocode::Locode.create(name: 'Eindhoven', port: true) }
+      let!(:rail_terminal) { UnLocode::Locode.create(name: 'Eindhoven', rail_terminal: true) }
+
+      context 'with supported functions' do
+        subject { UnLocode::Locode.find_by_name_and_function(search_term, :port) }
+        let(:search_term) { port.name }
+
+        its(:first) { should eql(port) }
+        its(:count) { should eql(1) }
+      end
+
+      context 'with unsupported function' do
+        it 'raises an error' do
+          expect { UnLocode::Locode.find_by_name_and_function(search_term, :derp) }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe 'as_json' do
+    let!(:country) { UnLocode::Country.create name: 'Belgium', code: 'BE' }
+    let!(:location) { UnLocode::Locode.create name: 'Eindhoven', port: true, country: country }
+
+    subject { location.as_json }
+
+    its(['country']) { should eql({'code' => 'BE', 'name' => 'Belgium'}) }
+    it { should_not have_key('country_id') }
+    it { should_not have_key('id') }
+  end
+end
+

data/un_locode.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'un_locode/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'un_locode'
+  spec.version = UnLocode::VERSION
+  spec.authors = ['Michel de Graaf', 'Rui Salgado', 'Niels Stevens']
+  spec.email = ['michel@kabisa.nl', 'rui.salgado@kabisa.nl', 'niels@kabisa.nl']
+  spec.description = %q{The Locode gem gives you the ability to lookup UN/LOCODE codes.}
+  spec.summary = %q{The Locode gem gives you the ability to lookup UN/LOCODE codes.}
+  spec.homepage = 'https://github.com/kabisaict/un_locode'
+  spec.license = 'MIT'
+
+  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.5'
+  spec.add_development_dependency 'rake', '~> 10.1.0'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'pry', '~> 0.9.12.3'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_dependency 'activerecord', '~> 4.0.0'
+  spec.add_dependency 'sqlite3', '~> 1.3.8'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: un_locode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel de Graaf
+- Rui Salgado
+- Niels Stevens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+description: The Locode gem gives you the ability to lookup UN/LOCODE codes.
+email:
+- michel@kabisa.nl
+- rui.salgado@kabisa.nl
+- niels@kabisa.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/csv/2013-1 UNLOCODE CodeListPart1.csv
+- data/csv/2013-1 UNLOCODE CodeListPart2.csv
+- data/csv/2013-1 UNLOCODE CodeListPart3.csv
+- data/db.rb
+- data/db.sqlite
+- data/locode_data_update.rb
+- data/schema.rb
+- debug.log
+- lib/.DS_Store
+- lib/un_locode.rb
+- lib/un_locode/.DS_Store
+- lib/un_locode/base_record.rb
+- lib/un_locode/country.rb
+- lib/un_locode/locode.rb
+- lib/un_locode/version.rb
+- spec/spec_helper.rb
+- spec/un_locode_spec.rb
+- un_locode.gemspec
+homepage: https://github.com/kabisaict/un_locode
+licenses:
+- MIT
+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.0.6
+signing_key: 
+specification_version: 4
+summary: The Locode gem gives you the ability to lookup UN/LOCODE codes.
+test_files:
+- spec/spec_helper.rb
+- spec/un_locode_spec.rb
+has_rdoc: