un_locode 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3793656f2e8a019e5f31026caac9967ec35946e5
-  data.tar.gz: 62959bd158236bde648d9a68a690adaf3d53ba20
+  metadata.gz: f843ce7d89a6836d813645eef8e25604b5e668a7
+  data.tar.gz: 9d4ef8ae89b500d2a5a6497a6b71beee39014100
 SHA512:
-  metadata.gz: c21c0b8702f0d0e70846d08cdc91c55340510c4d70ecb4780b74a8671d2640e6fe73c8a472a08f39bc89e4246bdb571544ec8f75404eb76be1192426366323e1
-  data.tar.gz: f6437cc441506e37f35987c02d7a4344b31adc4f9853b79a19d31bfedd5982341abe65771e8c6caa2b1d61058187333d2a06dfd49bf86635b73cded7f010b9c4
+  metadata.gz: 90090d9612bb9440bcf1d3c347edc025ac52dff7efb7497be3bccc9c420dde6e657a0d36a1f4119ed660c75fe79ebb957d1227b04e3e94caf15195837583329c
+  data.tar.gz: 55c0660472fb6dd682a06feff090d466bd1ee460d16a9b1b1ec6adf0e00a37e5e64f8f0ef9fd01d082721a28174457a3e1379947f4843fe2f2fe0e46bd8712ee

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+script: rspec spec

data/README.md

@@ -1,10 +1,12 @@
 # Locode
 
-The Locode gem gives you the ability to lookup UN/LOCODE codes. You can read more about the UN/LOCODE specifications here: [wiki](http://en.wikipedia.org/wiki/UN/LOCODE).
+The un_locode gem gives you the ability to lookup UN/LOCODE codes. You can read more about the UN/LOCODE specifications here: [wiki](http://en.wikipedia.org/wiki/UN/LOCODE) and [UNECE](http://www.unece.org/fileadmin/DAM/cefact/locode/Service/LocodeColumn.htm).
 
 All data used by this gem has been taken from the *UN Centre for Trade Facilitation and E-business* official website. **No guarantees for the accuracy or up-to-dateness are given.**
 
-`http://www.unece.org/cefact/locode/welcome.html` and `http://www.unece.org/cefact/codesfortrade/codes_index.html`
+`http://www.unece.org/cefact/locode/welcome.html` and `http://www.unece.org/cefact/codesfortrade/codes_index.html` and `http://www.unece.org/fileadmin/DAM/cefact/locode/Service/LocodeColumn.htm`
+
+Unlike the [locode gem](https://github.com/patrickdet/locode) by [patrickdet](https://github.com/patrickdet) our implementation uses a local sqlite DB to search for locodes instead of loading all the locodes(~90000) into memory. Therefore our gem only uses a fraction of the memory needed by the [locode gem](https://github.com/patrickdet/locode).  
 
 ## Installation
 
@@ -22,20 +24,41 @@ Or install it yourself as:
 
 ## Usage
 
-Find locations whose name is like the supplied search string. The search is case insensitive and also tries to match
+- **find_by_fuzzy_name**: Find locations whose name is like the supplied search string. The search is case insensitive and also tries to match
 location name without diacritics (and also alternative names when available). By default the amount of locations
 returned are 10 but you can override this value by passing a number as second argument.
 
-    UnLocode::Locode.find_by_fuzzy_name('Göte', 5)
-    #=> [#<UnLocode::Locode city_code: "GOT", name: "Göteborg", ...
-
+        UnLocode::Locode.find_by_fuzzy_name('Göte', 5)
+        #=> ActiveRecord::Relation [#<UnLocode::Locode city_code: "GOT", name: "Göteborg", ...
 
-Same search mechanisms as above but filter by function. You can find a list of possible functions @ UnLocode::FUNCTIONS.
+- **find_by_name_and_function**: Same search mechanisms as above but filter by function. You can find a list of possible functions @ UnLocode::FUNCTIONS.
 Like above you can limit the query result.
 
-    UnLocode::Locode.find_by_name_and_function('US', :port)
-    #=> [<UnLocode::Locode: city_code: "GOT", name: ">,>
-         <UnLocode::Locode: 'US LAX'>, ... ]
+        UnLocode::Locode.find_by_name_and_function('US', :port)
+        #=> ActiveRecord::Relation [#<UnLocode::Locode name: "Abu Musa", ... >, #<UnLocode::Locode name: "Mussafah",...>, ...
+    
+- **find_by_function**: Find all locations for a certain function.You can find a list of possible functions @ UnLocode::FUNCTIONS. Like all find methods, the default limit is 10 but can be specified to your own needs.
+
+        UnLocode::Locode.find_by_function(:port, 2)
+        #=> <UnLocode::Locode name: "Abu al Bukhoosh", port: true, ...>, #<UnLocode::Locode name: "Abu Dhabi", port: true>]>
+
+#### Available functions
+ - :port
+ - :rail_terminal
+ - :road_terminal
+ - :airport
+ - :postal_exchange_office
+ - :inland_clearance_depot
+ - :fixed_transport_functions
+ - :border_crossing_function
+ 
+ You can find more explaination of the functions over [here](http://www.unece.org/fileadmin/DAM/cefact/locode/Service/LocodeColumn.htm)
+ 
+## TODO
+- add locode method to location (also export with as_json)
+- add tests for limit's
+- add find_by_locode method
+- use connectionpool for connection management
 
 ## Contributing
 

data/lib/un_locode/locode.rb

@@ -12,16 +12,20 @@ module UnLocode
     belongs_to :country
 
     def self.find_by_fuzzy_name name, limit = 10
-      where('name like ? or
+      includes(:country).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
+    def self.find_by_function 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)
+      includes(:country).where(function => true).limit(limit)
+    end
+
+    def self.find_by_name_and_function name, function, limit = 10
+      find_by_fuzzy_name(name).find_by_function(function, limit)
     end
 
     def as_json options = {}

data/lib/un_locode/version.rb

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

data/spec/un_locode_spec.rb

@@ -42,7 +42,7 @@ describe UnLocode::Locode do
 
     end
 
-    context 'retrieving locodes by name and function' do
+    describe '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) }
 
@@ -60,6 +60,35 @@ describe UnLocode::Locode do
         end
       end
     end
+
+    describe 'retrieves locodes for' do
+      let!(:port) { UnLocode::Locode.create(name: 'Eindhoven', port: true) }
+      let!(:airport) { UnLocode::Locode.create(name: 'Eindhoven', airport: true) }
+
+      subject { UnLocode::Locode.find_by_function(function) }
+
+      context 'ports function' do
+        let(:function) { :port }
+
+        its(:first) { should eql(port) }
+        its(:count) { should eql(1) }
+        it { should_not include airport }
+      end
+
+      context 'airports function' do
+        let(:function) { :airport }
+
+        its(:first) { should eql(airport) }
+        its(:count) { should eql(1) }
+        it { should_not include port }
+      end
+
+      context 'unsupported function' do
+        it 'raises an error' do
+          expect { UnLocode::Locode.find_by_function(:derp) }.to raise_error
+        end
+      end
+    end
   end
 
   describe 'as_json' do
@@ -73,4 +102,3 @@ describe UnLocode::Locode do
     it { should_not have_key('id') }
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: un_locode
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michel de Graaf
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - .gitignore
 - .rspec
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md