locode 0.1.0

data/lib/locode/version.rb

@@ -0,0 +1,6 @@
+module Locode
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
+end

data/locode.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'locode'
+  spec.version       = Locode::VERSION
+  spec.authors       = ['Patrick Detlefsen']
+  spec.email         = ['patrick.detlefsen@gmail.com']
+  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/patrickdet/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_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+end

data/test/lib/location_test.rb

@@ -0,0 +1,84 @@
+require_relative '../test_helper'
+
+describe Locode::Location do
+  describe '.new' do
+    it 'must return a valid Location for valid parameters' do
+      location_attributes = {
+          country_code: 'US',
+          city_code: 'NYC',
+          full_name: 'New York',
+          full_name_without_diacritics: 'New York',
+          subdivision: 'NY',
+          function_classifier: '12345---',
+          status: 'AI',
+          date: '0401',
+          iata_code: '',
+          coordinates: '4042N 07400W'
+      }
+      location = Locode::Location.new(location_attributes)
+
+      assert location.valid?
+    end
+
+    it 'returns an invalid Location object for invalid parameters' do
+      location_attributes = {
+          foo: 'bar'
+      }
+      location = Locode::Location.new(location_attributes)
+
+      refute location.valid?
+    end
+  end
+
+  describe 'to_json' do
+    let(:location) { Locode::Location.new({
+                                              country_code: 'US',
+                                              city_code: 'NYC',
+                                              full_name: 'New York',
+                                              full_name_without_diacritics: 'New York',
+                                              subdivision: 'NY',
+                                              function_classifier: '12345---',
+                                              status: 'AI',
+                                              date: '0401',
+                                              iata_code: '',
+                                              coordinates: '4042N 07400W'
+                                          }) }
+
+    it 'should return a json output' do
+      json = MultiJson.load(location.to_json)
+      json['country_code'].must_equal location.country_code
+      json['city_code'].must_equal location.city_code
+      json['full_name'].must_equal location.full_name
+      json['full_name_without_diacritics'].must_equal location.full_name_without_diacritics
+      json['subdivision'].must_equal location.subdivision
+      json['function_classifier'].must_equal location.function_classifier
+      json['status'].must_equal location.status.to_s
+      json['date'].must_equal location.date
+      json['iata_code'].must_equal location.iata_code
+      json['coordinates'].must_equal location.coordinates
+    end
+  end
+
+  describe 'to_h' do
+    let(:attributes) { {
+        country_code: 'US',
+        city_code: 'NYC',
+        full_name: 'New York',
+        full_name_without_diacritics: 'New York',
+        subdivision: 'NY',
+        function_classifier: '12345---',
+        status: 'AI',
+        date: '0401',
+        iata_code: '',
+        coordinates: '4042N 07400W'
+    } }
+    let(:location) { Locode::Location.new(attributes) }
+
+    it 'should return a hash' do
+      hash = location.to_h
+      hash.must_be_instance_of Hash
+      hash[:subdivision].must_equal location.subdivision
+      hash[:coordinates].must_equal location.coordinates
+    end
+  end
+end

data/test/lib/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../test_helper'
+ 
+describe Locode do
+  it "must have a defined version" do
+    Locode::VERSION.wont_be_nil
+  end
+end

data/test/locode_test.rb

@@ -0,0 +1,102 @@
+require_relative 'test_helper'
+
+describe Locode do
+  describe '.find_by_locode' do
+    it 'should return the correct location' do
+      locode = 'DE HAM'
+      location = Locode.find_by_locode(locode).first
+
+      location.locode.must_equal locode
+    end
+  end
+
+  describe '.find_by_name' do
+    it 'should find the location for a given name' do
+      name = 'Hamburg'
+      location = Locode.find_by_name(name).first
+
+      location.full_name.must_equal name
+    end
+  end
+
+  describe 'find locations by country for function' do
+
+    describe 'invalid calls' do
+      it 'returns an empty array when country code is empty' do
+        Locode.find_by_country_and_function(nil, 1).must_be_empty
+      end
+
+      it 'returns an empty array when country code is not a string' do
+        Locode.find_by_country_and_function(12, 1).must_be_empty
+      end
+
+      it 'returns an empty array when country code is not 2 chars long' do
+        Locode.find_by_country_and_function('ABC', 1).must_be_empty
+        Locode.find_by_country_and_function('A', 1).must_be_empty
+      end
+
+      it 'returns an empty array when country code is not in upper case' do
+        Locode.find_by_country_and_function('aa', 1).must_be_empty
+        Locode.find_by_country_and_function('a', 1).must_be_empty
+      end
+
+      it 'returns an empty array when function is not a possible function' do
+        Locode.find_by_country_and_function('AB', 9).must_be_empty
+        Locode.find_by_country_and_function('AB', 0).must_be_empty
+        Locode.find_by_country_and_function('AB', nil).must_be_empty
+        Locode.find_by_country_and_function('AB', ':C').must_be_empty
+        Locode.find_by_country_and_function('AB', ':b').must_be_empty
+      end
+    end
+
+    describe 'valid calls' do
+      let(:seaport) { Locode::Location.new country_code: 'BE', full_name: 'Antwerp', function_classifier: [1] }
+      let(:airport) { Locode::Location.new country_code: 'BE', full_name: 'Brussels', function_classifier: [4] }
+      let(:railstation) { Locode::Location.new country_code: 'NL', full_name: 'Venlo', function_classifier: [2] }
+      let(:locations) { [] }
+
+      before(:each) do
+        Locode.const_set :ALL_LOCATIONS, locations
+      end
+
+      describe 'without limit' do
+        before(:each) do
+          locations << seaport << airport << railstation
+        end
+
+        it 'excepts :B as a valid function' do
+          Locode.find_by_country_and_function('AB', ':B').must_be_empty
+        end
+
+        it 'finds all locations for Belgium as seaport' do
+          locations = Locode.find_by_country_and_function('BE', 1)
+          locations.count.must_equal 1
+          locations.must_include seaport
+          locations.wont_include airport
+          locations.wont_include railstation
+        end
+
+        it 'finds all railstations in the Netherlands' do
+          locations = Locode.find_by_country_and_function('NL', 2)
+          locations.count.must_equal 1
+          locations.must_include railstation
+          locations.wont_include airport
+          locations.wont_include seaport
+        end
+      end
+
+      describe 'with limit' do
+        before(:each) do
+          locations << railstation << railstation << railstation
+        end
+
+        [1, 2].each do |limit|
+          it "returns array with the #{limit} location" do
+            locations = Locode.find_by_country_and_function('NL', 2, limit)
+            locations.count.must_equal limit
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'pry'
+require File.expand_path('../../lib/locode.rb', __FILE__)

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: locode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patrick Detlefsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Locode gem gives you the ability to lookup UN/LOCODE codes.
+email:
+- patrick.detlefsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CONTRIBUTERS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/README.md
+- data/locode_data_update.rb
+- data/yaml/dump.yml
+- lib/locode.rb
+- lib/locode/location.rb
+- lib/locode/version.rb
+- locode.gemspec
+- test/lib/location_test.rb
+- test/lib/version_test.rb
+- test/locode_test.rb
+- test/test_helper.rb
+homepage: https://github.com/patrickdet/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.3
+signing_key: 
+specification_version: 4
+summary: The Locode gem gives you the ability to lookup UN/LOCODE codes.
+test_files:
+- test/lib/location_test.rb
+- test/lib/version_test.rb
+- test/locode_test.rb
+- test/test_helper.rb