locality 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87a063187c95946e77731cd381e1e196949c0d35
-  data.tar.gz: d74e6d3a5e2b944300e0b544fcac90c545be590d
+  metadata.gz: 077ebf8169cc453fe48969651bf6d44a768c03a7
+  data.tar.gz: c2d9bc0b1be7aea098354a617936ea1daa2e0a8f
 SHA512:
-  metadata.gz: fe91e20cf92950d82ea82692d0ed76aa89c44f368ae74ebf404ca5e0945f8ebd6dd9c8e4aa15eb4dfb2172a98044ef8f4dec3d54d6ecc58778a2bc61c5999b15
-  data.tar.gz: d02ca7ca25fd003eb0419c3d745e2674096bb3516e8f4a938139dfb60ae3f281aa6809a4c26866039ea2fea4c84ac7d0baae1e5b0fcccef1b15754ddec796983
+  metadata.gz: a98c24bb1cd79948676672a1c9cf17497e898dda753a68bd8c7ea79824c205528da8286ed9e50f65ddd4d2c33a88df1b7d8205e2491b2a1ec38580fed7a11c4e
+  data.tar.gz: eae62edc70069c41d951a3d998ab4ce191f67f2101ab7c688617d737c5c438fdc1cd586a266a014f15238db978b058caadf68e4345d3a271c7fc920f04b416c3

data/README.md

@@ -1,8 +1,6 @@
 # Locality
 
-## Swedish A-Region
-
-See https://sv.wikipedia.org/wiki/A-region
+## Postnummerservice
 
 ### Installation
 
@@ -27,9 +25,32 @@ end
 ### Usage
 
 ```ruby
-lookup = Locality::Aregion.new 21  # Gotland
+# A-Regions
+# See https://sv.wikipedia.org/wiki/A-region
+available_codes = Locality::Postnummerservice::Aregion.codes
+lookup = Locality::Postnummerservice::Aregion.new 21  # Gotland
+
+# States
+# See https://sv.wikipedia.org/wiki/Sveriges_l%C3%A4n
+available_codes = Locality::Postnummerservice::State.codes
+lookup = Locality::Postnummerservice::State.new 7  # Kronoberg
+
+# Provinces
+# See https://sv.wikipedia.org/wiki/Sveriges_l%C3%A4n
+available_codes = Locality::Postnummerservice::Province.codes
+lookup = Locality::Postnummerservice::Province.new '0182'  # Nacka
+
+# On all of the above lookups you have the following attributes
+lookup.code
+lookup.name
+lookup.zip_codes
+lookup.city_names
+lookup.state_codes
+lookup.state_names
+lookup.province_code
+lookup.province_names
+lookup.aregion_codes
 
-lookup.zip_codes  # => Array of Integers
 # More to come...
 ```
 
@@ -52,7 +73,7 @@ curl http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz -o
 Locality.configure do |config|
 
   # By default, locality will look for the maxmind database in
-  # these locations: `Locality.config.maxmind_geoip2_path`
+  # these locations: `Locality.config.maxmind_geoip2_paths`
   # You can add a custom location like so:
   config.maxmind_geoip2_path = '/some/custom/maxmind_geolite2.mmdb'
 

data/lib/locality/postnummerservice/aregion.rb

@@ -0,0 +1,101 @@
+require 'locality/postnummerservice'
+require 'locality/postnummerservice/collection'
+
+module Locality
+  module Postnummerservice
+    class Aregion
+      include Postnummerservice::Collection
+
+      # See https://sv.wikipedia.org/wiki/A-region
+      def self.codes
+        {
+          1 => 'Stockholm/Södertälje',
+          2 => 'Norrtälje',
+          3 => 'Enköping',
+          4 => 'Uppsala',
+          5 => 'Nyköping',
+          6 => 'Katrineholm',
+          7 => 'Eskilstuna',
+          8 => 'Mjölby/Motala',
+          9 => 'Linköping',
+          10 => 'Norrköping',
+          11 => 'Jönköping',
+          12 => 'Tranås',
+          13 => 'Eksjö/Nässjö/Vetlanda',
+          14 => 'Värnamo',
+          15 => 'Ljungby',
+          16 => 'Växjö',
+          17 => 'Västervik',
+          18 => 'Hultsfred/Vimmerby',
+          19 => 'Oskarshamn',
+          20 => 'Kalmar/Nybro',
+          21 => 'Visby',
+          22 => 'Karlskrona',
+          23 => 'Karlshamn',
+          24 => 'Kristianstad',
+          25 => 'Hässleholm',
+          26 => 'Ängelholm',
+          27 => 'Helsingborg/Landskrona',
+          28 => 'Malmö/Lund/Trelleborg',
+          29 => 'Ystad/Simrishamn',
+          30 => 'Eslöv',
+          31 => 'Halmstad',
+          32 => 'Falkenberg/Varberg',
+          33 => 'Göteborg/Alingsås',
+          34 => 'Uddevalla',
+          35 => 'Trollhättan/Vänersborg',
+          36 => 'Borås',
+          37 => 'Lidköping/Skara',
+          38 => 'Falköping',
+          39 => 'Skövde',
+          40 => 'Mariestad',
+          41 => 'Kristinehamn/Filipstad',
+          42 => 'Karlstad',
+          43 => 'Säffle/Åmål',
+          44 => 'Arvika',
+          45 => 'Örebro',
+          46 => 'Karlskoga',
+          47 => 'Lindesberg',
+          48 => 'Västerås',
+          49 => 'Köping',
+          50 => 'Fagersta',
+          51 => 'Sala',
+          52 => 'Borlänge/Falun',
+          53 => 'Avesta/Hedemora',
+          54 => 'Ludvika',
+          55 => 'Mora',
+          56 => 'Gävle/Sandviken',
+          57 => 'Bollnäs/Söderhamn',
+          58 => 'Hudiksvall/Ljusdal',
+          59 => 'Sundsvall',
+          60 => 'Härnösand/Kramfors',
+          61 => 'Sollefteå',
+          62 => 'Örnsköldsvik',
+          63 => 'Östersund',
+          64 => 'Umeå',
+          65 => 'Skellefteå',
+          66 => 'Lycksele',
+          67 => 'Piteå',
+          68 => 'Luleå/Boden',
+          69 => 'Haparanda/Kalix',
+          70 => 'Kiruna/Gällivare',
+        }
+      end
+
+      def code
+        raw_code.to_i
+      end
+
+      def name
+        self.class.codes[code]
+      end
+
+      private
+
+      def self.backend
+        Postnummerservice.aregions
+      end
+
+    end
+  end
+end

data/lib/locality/postnummerservice/collection.rb

@@ -5,6 +5,12 @@ module Locality
     module Collection
       extend ActiveSupport::Concern
 
+      module ClassMethods
+        def backend
+          fail NotImplementedError
+        end
+      end
+
       def initialize(raw_code)
         @raw_code = raw_code
       end
@@ -38,8 +44,8 @@ module Locality
         @province_codes ||= entities.map(&:province_code).uniq.sort
       end
 
-      def aregions
-        @aregions ||= entities.map(&:aregion).uniq.sort
+      def aregion_codes
+        @aregions ||= entities.map(&:aregion_code).uniq.sort
       end
 
       private
@@ -51,7 +57,7 @@ module Locality
       end
 
       def backend
-        fail NotImplementedError
+        self.class.backend
       end
 
     end

data/lib/locality/postnummerservice/entry.rb

@@ -9,7 +9,7 @@ module Locality
       end
 
       def city_name
-        self[1]
+        self[1].to_s.mb_chars.downcase.titleize.to_s
       end
 
       def state_code
@@ -17,18 +17,18 @@ module Locality
       end
 
       def state_name
-        self[3].humanize
+        self[3].to_s.mb_chars.downcase.titleize.to_s
       end
 
-      def province_name
+      def province_code
         self[4]
       end
 
-      def province_code
-        self[5]
+      def province_name
+        self[5].to_s.mb_chars.downcase.titleize.to_s
       end
 
-      def aregion
+      def aregion_code
         self[6].to_i
       end
 

data/lib/locality/postnummerservice/province.rb

@@ -0,0 +1,30 @@
+require 'locality/postnummerservice'
+require 'locality/postnummerservice/collection'
+
+module Locality
+  module Postnummerservice
+    class Province
+      include Postnummerservice::Collection
+
+      # See http://www.scb.se/Pages/List____257281.aspx
+      def self.codes
+        Hash[backend.map { |code, entries| [code, entries.first.province_name] }]
+      end
+
+      def code
+        raw_code.to_s.strip
+      end
+
+      def name
+        province_names.first
+      end
+
+      private
+
+      def self.backend
+        Postnummerservice.provinces
+      end
+
+    end
+  end
+end

data/lib/locality/postnummerservice/state.rb

@@ -0,0 +1,30 @@
+require 'locality/postnummerservice'
+require 'locality/postnummerservice/collection'
+
+module Locality
+  module Postnummerservice
+    class State
+      include Postnummerservice::Collection
+
+      # See http://www.scb.se/Pages/List____257281.aspx
+      def self.codes
+        Hash[backend.map { |code, entries| [code, entries.first.state_name] }]
+      end
+
+      def code
+        raw_code.to_i
+      end
+
+      def name
+        state_names.first
+      end
+
+      private
+
+      def self.backend
+        Postnummerservice.states
+      end
+
+    end
+  end
+end

data/lib/locality/postnummerservice.rb

@@ -1,5 +1,8 @@
 require 'csv'
 require 'locality/postnummerservice/entry'
+require 'locality/postnummerservice/aregion'
+require 'locality/postnummerservice/province'
+require 'locality/postnummerservice/state'
 
 module Locality
   module Postnummerservice
@@ -9,6 +12,16 @@ module Locality
       @aregions
     end
 
+    def self.states
+      load
+      @states
+    end
+
+    def self.provinces
+      load
+      @provinces
+    end
+
     private
 
     def self.load
@@ -21,10 +34,16 @@ module Locality
 
     def self.load!
       @aregions = {}
+      @states = {}
+      @provinces = {}
 
       entries do |entry|
-        @aregions[entry.aregion] ||= []
-        @aregions[entry.aregion] << entry
+        @aregions[entry.aregion_code] ||= []
+        @aregions[entry.aregion_code] << entry
+        @states[entry.state_code] ||= []
+        @states[entry.state_code] << entry
+        @provinces[entry.province_code] ||= []
+        @provinces[entry.province_code] << entry
       end
 
       @loaded = true

data/lib/locality.rb

@@ -1,7 +1,6 @@
-require 'locality/aregion'
 require 'locality/configurable'
 require 'locality/ip'
-require 'locality/aregion'
+require 'locality/postnummerservice'
 
 module Locality
   extend Configurable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locality
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - bukowskis
@@ -172,13 +172,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/locality.rb
-- lib/locality/aregion.rb
 - lib/locality/configurable.rb
 - lib/locality/configuration.rb
 - lib/locality/ip.rb
 - lib/locality/postnummerservice.rb
+- lib/locality/postnummerservice/aregion.rb
 - lib/locality/postnummerservice/collection.rb
 - lib/locality/postnummerservice/entry.rb
+- lib/locality/postnummerservice/province.rb
+- lib/locality/postnummerservice/state.rb
 homepage: https://github.com/bukowskis/locality
 licenses: []
 metadata: {}

data/lib/locality/aregion.rb

@@ -1,24 +0,0 @@
-require 'locality/postnummerservice'
-require 'locality/postnummerservice/collection'
-
-module Locality
-  # See https://sv.wikipedia.org/wiki/A-region
-  class Aregion
-    include Postnummerservice::Collection
-
-    def code
-      raw_code.to_i
-    end
-
-    def state_name
-      state_names.first
-    end
-
-    private
-
-    def backend
-      Locality::Postnummerservice.aregions
-    end
-
-  end
-end