postal-codes-search 1.0.1 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c255a854ed08b36121a42cd9a4030fcd3c7abd8b462c09184f7792ee77ac601
-  data.tar.gz: 2c56351624b73fc227fabe6c422867f9797ea29ccb46d77838d6421fcd7c2f6f
+  metadata.gz: 6bd751b4eee9200e347095667456ba49196eff2fac841c621a5c284624ab9d57
+  data.tar.gz: 456bd07c8efeb450690454c0ccc82eba0ca280e9f370f82e7061aa4f7c00f359
 SHA512:
-  metadata.gz: 139034cbcfda628349fa991bdb03e60eaa46bd2d2d7e4ad85335f356bb4b3d2cf42e1d428b4266e6182f767e6dd40abc7c2d82218c30e74c511cc6e7db234d7a
-  data.tar.gz: eb6c0f08447e16601ebb8fa3399c380cb3b7ce211ce8ceeb721bea163525448419f1165218bed9235fc12bfc9f111d2eb67a45e3cd3ab2ed01e7b8fb9d2103ed
+  metadata.gz: 3a3e76304a6008031bb4861d2454804b30e6172a1cbea59ea94b179805ef28016046a16e6dd5cd93bc47b168649e3c4d8435883d048b4d89aebf45a49b93716f
+  data.tar.gz: 16d1a3eff69ae8110c41d219fd65f4f39b2143858c5ee9dc1b55965bc3156a09e5414aae48abf6844d441e719e4bd02d436df37d9be503734a85a41dcef86505

data/README.md

@@ -6,7 +6,7 @@ Gem to obtain postal codes for US and CA only.
 
 Add this line to your application's Gemfile:
 
-    gem 'postal-codes-search'
+    gem 'postal-codes-search', '~> 1.0', '>= 1.0.1'
 
 And then execute:
 
@@ -18,15 +18,47 @@ Or install it yourself as:
 
 ## Usage
 
+You can search generally by any keyword like country, county, postal code, state and or city like this
 ```ruby
 PostalCodesSearch.find('Y1A')
 # => [{"country"=>"CA", "postal_code"=>"Y1A", "city"=>"Whitehorse", "state"=>"Yukon", "county"=>nil}]
-# First run will take a while, as the yaml has to be loaded
+# This will return an array. If you put an incomplete postal code, it will return the most similar results
+```
+You can use more specific search depending on the attribute you want to use
+
+### By code
+```ruby
+PostalCodesSearch.find_by(code: 'Y1A')
+# => [{"country"=>"CA", "postal_code"=>"Y1A", "city"=>"Whitehorse", "state"=>"Yukon", "county"=>nil}]
+```
+
+### By country
+```ruby
+PostalCodesSearch.find_by(country: 'US').count
+# => 41469
+```
+
+### By county
+```ruby
+PostalCodesSearch.find_by(county: 'Yukon-Koyukuk').first
+# => {"country"=>"US", "postal_code"=>99558, "city"=>"Anvik", "state"=>"Alaska", "county"=>"Yukon-Koyukuk (CA)"}
+```
+
+### By state
+```ruby
+PostalCodesSearch.find_by(state: 'Alaska').count
+# => 273
+```
+
+### By city
+```ruby
+PostalCodesSearch.find_by(city: 'Venetie')
+# => [{"country"=>"US", "postal_code"=>99781, "city"=>"Venetie", "state"=>"Alaska", "county"=>"Yukon-Koyukuk (CA)"}]
 ```
 
 Using rails, you can load all the values in a initializer
 ```ruby
-# config/initializers/load_zip_codes.rb
+# config/initializers/postal_codes.rb
 PostalCodesSearch.load unless Rails.env.development?
 ```
 

data/lib/postal-codes-search.rb

@@ -4,7 +4,7 @@ require 'yaml'
 
 # Class module that handles all searching methods for postal codes
 module PostalCodesSearch
-  VERSION = '1.0.1'
+  VERSION = '1.1'
 
   class << self
     SUPPORTED_COUNTRIES = %i[us ca].freeze
@@ -13,13 +13,17 @@ module PostalCodesSearch
       !(attr.nil? || attr.empty?)
     end
 
-    def find_by(code: nil, country:  nil, county: nil, city: nil, state: nil)
+    def selectable?(term, value)
+      attribute_present(term) && value && value.to_s.downcase.include?(term.to_s.downcase)
+    end
+
+    def find_by(code: nil, country: nil, county: nil, city: nil, state: nil)
       data_source.select do |postal_code|
-        (attribute_present(code) && postal_code['postal_code'] && postal_code['postal_code'].to_s.include?(code)) ||
-          (attribute_present(country) && postal_code['country'] && postal_code['country'].to_s.include?(country)) ||
-          (attribute_present(county) && postal_code['county'] && postal_code['county'].to_s.include?(county)) ||
-          (attribute_present(city) && postal_code['city'] && postal_code['city'].to_s.include?(city)) ||
-          (attribute_present(state) && postal_code['state'] && postal_code['state'].to_s.include?(state))
+        selectable?(code, postal_code['postal_code']) ||
+          selectable?(country, postal_code['country']) ||
+          selectable?(county, postal_code['county']) ||
+          selectable?(city, postal_code['city']) ||
+          selectable?(state, postal_code['state'])
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postal-codes-search
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '1.1'
 platform: ruby
 authors:
 - Jefferson Alvarez Alvarez