geo_states 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d0aedae067e7276a505d4a23c6bf594c9db0cf9f1e23d3713b0a82923512b65
+  data.tar.gz: 9f4a6960b3e6334a579af5f5d4e7a2da36c284d4753625a87288ded90eb5e54e
+SHA512:
+  metadata.gz: 22945f22f63d71c653d2a900bdf5ea4396cb763c07ca8046d39823ec1915e01a7229f6b69bffe2b61380860ba4612f03a7341e26231454b975dfe246538e9732
+  data.tar.gz: 3cffe4fa3fe31b687956a6008ffbb133f305194a9fd56dfad3e2d5149407741bee62dbfad358b309e0eb70b4967f5bdb08657ca97344da120f07f9c2773acf2b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Albert Osbal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# GeoStates
+
+Ruby gem that lists countries and their states (or provinces, regions) from **bundled data**. No external services at runtime.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "geo_states"
+```
+
+Or install directly:
+
+```bash
+gem install geo_states
+```
+
+## Usage
+
+```ruby
+require "geo_states"
+
+# List all countries
+GeoStates.all_countries
+# => [{:country=>"Mexico", :iso2=>"MX", :iso3=>"MEX", :states=>[...]}, ...]
+
+# Find country by ISO 3166-1 alpha-2 code
+GeoStates.find_country("MX")
+# => {:country=>"Mexico", :m49=>nil, :iso3=>"MEX", :iso2=>"MX", :currency=>"MXN", ...}
+
+# Find by ISO3, M49, or name
+GeoStates.find_country_by_iso3("MEX")
+GeoStates.find_country_by_m49("484")   # Mexico
+GeoStates.find_country_by_name("Mexico")
+
+# Get states for a country (by iso2, iso3, m49, or name)
+GeoStates.states_for("MX")
+# => [{:name=>"Aguascalientes", :state_code=>"AGU", :iso3=>"AGU", :iso2=>"AG"}, ...]
+```
+
+### Country format
+
+Each country is a Hash with:
+
+- `:country` — country name
+- `:m49` — UN M49 numeric code (optional, nil if not in source)
+- `:iso3` — ISO 3166-1 alpha-3
+- `:iso2` — ISO 3166-1 alpha-2
+- `:currency`, `:currency_symbol`, `:phone_code`, `:flag` — optional
+- `:states` — array of states
+
+Each state has:
+
+- `:name` — name
+- `:state_code` — code (e.g. "AGU")
+- `:iso3` — same as state_code if not provided
+- `:iso2` — derived from state_code if not provided
+
+## Data sources
+
+The bundled data in `lib/geo_states/data/countries.json` is the single source. It includes:
+
+- **Countries and subdivisions** — names and codes (ISO 3166-1 alpha-2/alpha-3, UN M49).
+- **Flag URLs** — point to [Wikimedia Commons](https://commons.wikimedia.org/) (the gem does not fetch them; they are stored as strings).
+
+No external APIs are called at runtime.
+
+## Development
+
+```bash
+bin/setup     # install dependencies
+rake spec     # run tests
+bin/console   # interactive console
+```
+
+## Author
+
+Created by [@elosnaya](https://github.com/elosnaya).
+
+## License
+
+MIT.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Dir.glob("lib/tasks/**/*.rake").each { |r| load r }
+
+task default: :spec