Module: CS
- Defined in:
- lib/city-state.rb,
lib/city-state/version.rb
Constant Summary collapse
- MAXMIND_ZIPPED_URL =
CS constants
"http://geolite.maxmind.com/download/geoip/database/GeoLite2-City-CSV.zip"
- FILES_FOLDER =
File.('../db', __FILE__)
- MAXMIND_DB_FN =
File.join(FILES_FOLDER, "GeoLite2-City-Locations-en.csv")
- COUNTRIES_FN =
File.join(FILES_FOLDER, "countries.yml")
- ID =
constants: CVS position
0
- COUNTRY =
4
- COUNTRY_LONG =
5
- STATE =
6
- STATE_LONG =
7
- CITY =
10
- VERSION =
"0.0.11"
Class Method Summary collapse
- .cities(state, country = nil) ⇒ Object
-
.countries ⇒ Object
list of all countries of the world (countries.yml).
- .current_country ⇒ Object
- .current_country=(country) ⇒ Object
-
.get(country = nil, state = nil) ⇒ Object
get is a method to simplify the use of city-state get = countries, get(country) = states(country), get(country, state) = cities(state, country).
- .install(country) ⇒ Object
- .states(country) ⇒ Object
- .update ⇒ Object
- .update_maxmind ⇒ Object
Class Method Details
.cities(state, country = nil) ⇒ Object
133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/city-state.rb', line 133 def self.cities(state, country = nil) self.current_country = country if country.present? # set as current_country country = self.current_country # load the country file if @cities[country].blank? cities_fn = File.join(FILES_FOLDER, "cities.#{country.to_s.downcase}") self.install(country) if ! File.exists? cities_fn @cities[country] = YAML::load_file(cities_fn).symbolize_keys end @cities[country][state.to_s.upcase.to_sym] || [] end |
.countries ⇒ Object
list of all countries of the world (countries.yml)
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/city-state.rb', line 162 def self.countries if ! File.exists? COUNTRIES_FN # countries.yml doesn't exists, extract from MAXMIND_DB update_maxmind unless File.exists? MAXMIND_DB_FN # reads CSV line by line File.foreach(MAXMIND_DB_FN) do |line| rec = line.split(",") next if rec[COUNTRY].blank? || rec[COUNTRY_LONG].blank? # jump empty records country = rec[COUNTRY].to_s.upcase.to_sym # normalize to something like :US, :BR if @countries[country].blank? long = rec[COUNTRY_LONG].gsub(/\"/, "") # sometimes names come with a "\" char @countries[country] = long end end # sort and save to "countries.yml" @countries = Hash[@countries.sort] File.open(COUNTRIES_FN, "w") { |f| f.write @countries.to_yaml } else # countries.yml exists, just read it @countries = YAML::load_file(COUNTRIES_FN).symbolize_keys end @countries end |
.current_country ⇒ Object
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/city-state.rb', line 109 def self.current_country return @current_country if @current_country.present? # we don't have used this method yet: discover by the file extension fn = Dir[File.join(FILES_FOLDER, "cities.*")].last @current_country = fn.blank? ? nil : fn.split(".").last # there's no files: we'll install and use :US if @current_country.blank? @current_country = :US self.install(@current_country) # we find a file: normalize the extension to something like :US else @current_country = @current_country.to_s.upcase.to_sym end @current_country end |
.current_country=(country) ⇒ Object
129 130 131 |
# File 'lib/city-state.rb', line 129 def self.current_country=(country) @current_country = country.to_s.upcase.to_sym end |
.get(country = nil, state = nil) ⇒ Object
get is a method to simplify the use of city-state get = countries, get(country) = states(country), get(country, state) = cities(state, country)
190 191 192 193 194 |
# File 'lib/city-state.rb', line 190 def self.get(country = nil, state = nil) return self.countries if country.nil? return self.states(country) if state.nil? return self.cities(state, country) end |
.install(country) ⇒ Object
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/city-state.rb', line 52 def self.install(country) # get CSV if doesn't exists update_maxmind unless File.exists? MAXMIND_DB_FN # normalize "country" country = country.to_s.upcase # some state codes are empty: we'll use "states-replace" in these cases states_replace_fn = File.join(FILES_FOLDER, "states-replace.yml") states_replace = YAML::load_file(states_replace_fn).symbolize_keys states_replace = states_replace[country.to_sym] || {} # we need just this country states_replace_inv = states_replace.invert # invert key with value, to ease the search # read CSV line by line cities = {} states = {} File.foreach(MAXMIND_DB_FN) do |line| rec = line.split(",") next if rec[COUNTRY] != country next if (rec[STATE].blank? && rec[STATE_LONG].blank?) || rec[CITY].blank? # some state codes are empty: we'll use "states-replace" in these cases rec[STATE] = states_replace_inv[rec[STATE_LONG]] if rec[STATE].blank? rec[STATE] = rec[STATE_LONG] if rec[STATE].blank? # there's no correspondent in states-replace: we'll use the long name as code # some long names are empty: we'll use "states-replace" to get the code rec[STATE_LONG] = states_replace[rec[STATE]] if rec[STATE_LONG].blank? # normalize rec[STATE] = rec[STATE].to_sym rec[CITY].gsub!(/\"/, "") # sometimes names come with a "\" char rec[STATE_LONG].gsub!(/\"/, "") # sometimes names come with a "\" char # cities list: {TX: ["Texas City", "Another", "Another 2"]} cities.merge!({rec[STATE] => []}) if ! states.has_key?(rec[STATE]) cities[rec[STATE]] << rec[CITY] # states list: {TX: "Texas", CA: "California"} if ! states.has_key?(rec[STATE]) state = {rec[STATE] => rec[STATE_LONG]} states.merge!(state) end end # sort cities = Hash[cities.sort] states = Hash[states.sort] cities.each { |k, v| cities[k].sort! } # save to states.us and cities.us states_fn = File.join(FILES_FOLDER, "states.#{country.downcase}") cities_fn = File.join(FILES_FOLDER, "cities.#{country.downcase}") File.open(states_fn, "w") { |f| f.write states.to_yaml } File.open(cities_fn, "w") { |f| f.write cities.to_yaml } true end |
.states(country) ⇒ Object
147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/city-state.rb', line 147 def self.states(country) self.current_country = country # set as current_country country = self.current_country # normalized # load the country file if @states[country].blank? states_fn = File.join(FILES_FOLDER, "states.#{country.to_s.downcase}") self.install(country) if ! File.exists? states_fn @states[country] = YAML::load_file(states_fn).symbolize_keys end @states[country] || {} end |
.update ⇒ Object
34 35 36 37 38 39 40 41 42 |
# File 'lib/city-state.rb', line 34 def self.update self.update_maxmind # update via internet Dir[File.join(FILES_FOLDER, "states.*")].each do |state_fn| self.install(state_fn.split(".").last.upcase.to_sym) # reinstall country end @countries = @cities = @states = {} # invalidades cache File.delete COUNTRIES_FN # force countries.yml to be generated at next call of CS.countries true end |
.update_maxmind ⇒ Object
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/city-state.rb', line 13 def self.update_maxmind require "open-uri" require "zip" # get zipped file f_zipped = open(MAXMIND_ZIPPED_URL) # unzip file: # recursively searches for "GeoLite2-City-Locations-en" Zip::File.open(f_zipped) do |zip_file| zip_file.each do |entry| if entry.name["GeoLite2-City-Locations-en"].present? fn = entry.name.split("/").last entry.extract(File.join(FILES_FOLDER, fn)) { true } # { true } is to overwrite break end end end true end |