costa_rica_address_utils 0.1.02 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7671d4fcae7c2b653dfc0e0a1c21efb653c6a50a2b23d156ec05b82780b4ef
-  data.tar.gz: 4302d34bd690087a8297e306d35358f0663191f80312dbd11e8a80624ef9a495
+  metadata.gz: 422b2acba3b514159146fc9acd6aae2d54727010a7700e5d29b93d3e9708acb2
+  data.tar.gz: d56d0dc179b963c7186bcd32c973a178498c23315e56a3201056d12c130cfc16
 SHA512:
-  metadata.gz: 330f3a0b91cf8259c330b6cc27dd2b03d08474b3d8bdec8b73a60e8ff6d52cc9a34b2e803311a228654fe175b894723f1655cad50e929740ab4df8e22c7507e8
-  data.tar.gz: 07f8abbfa8bd4e1d78f0f9cade46534ff517d8f870545c6dcb0066542562d5a369de9db6eb02d03d81f12e7af0e34d87afae1cc2951139324cfb394045cfce8f
+  metadata.gz: 1c540062083850af8a8dd1a18d73f8532e873babb23680c3f436d32347602d45e8e6475b515a6c086b0b2d2926fd08fd53eccc31f3bc98b3d46f62918d421c6e
+  data.tar.gz: 7f0cad040f239326935192decffd4c752d7849bc8444aef279d0cfdc9abe66c597def359e2b822e0ce4f24936d5ba949f7674f8743e21b5ff7a60915b3b8b4cd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    costa_rica_address_utils (0.1.02)
+    costa_rica_address_utils (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -42,6 +42,8 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+> Remember to execute `bundle exec rake release` on `main` branch
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/costa_rica_address_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/costa_rica_address_utils/blob/master/CODE_OF_CONDUCT.md).

data/lib/costa_rica_address_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CostaRicaAddressUtils
-  VERSION = "0.1.02"
+  VERSION = "0.2.1"
 end

data/lib/costa_rica_address_utils.rb

@@ -35,6 +35,33 @@ module CostaRicaAddressUtils
     }
   end
 
+  # Get one address information from a zip code
+  def self.fetch_address_from_zip(zip_code)
+    return nil unless zip_valid?(zip_code)
+    zip_code_s = zip_code.to_s
+    LOCATIONS_DATASET.each do |province, province_data|
+      province_data["cantons"].each do |canton, canton_data|
+        canton_data["districts"].each do |district, district_data|
+          if district_data["zip_code"] == zip_code_s
+            return {
+              province: province,
+              canton: canton,
+              district: district,
+              zip: zip_code_s,
+            }
+          end
+        end
+      end
+    end
+
+    return nil
+  end
+
+  def self.fetch_address_from_zip!(zip_code)
+    raise "Zip code provided #{zip_code} is invalid. Must be a 5 digits number" unless zip_valid?(zip_code)
+    fetch_address_from_zip(zip_code)
+  end
+
   def self.address_valid?(province:, canton:, district:)
     is_valid = true
     begin
@@ -47,6 +74,9 @@ module CostaRicaAddressUtils
     return is_valid
   end
 
+  def self.zip_valid?(zip_code)
+    !!zip_code && zip_code.to_s.length == 5
+  end
 
   # Build a Costa Rica address from an address of an external provider (Shopify, Brightpearl, etc)
   # https://shopify.dev/api/admin-graphql/2022-10/objects/mailingaddress
@@ -83,4 +113,6 @@ module CostaRicaAddressUtils
       raise InvalidData("Invalid provider, valid providers are: #{VAlID_PROVIDERS}")
     end
   end
+
+  private
 end # module CostaRicaAddressUtils

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: costa_rica_address_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.02
+  version: 0.2.1
 platform: ruby
 authors:
 - vicvans20
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Utils lib to work with Costa Rica addresses.