locality 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc08ca579c909a36f517e55af8c15dbc8b3e7bf6
+  data.tar.gz: 5eb0d6c9e2e211110857db7fb3be22e4d22fb1f3
+SHA512:
+  metadata.gz: 5d1b4079773f7ec8b22c2687a9e10ca2861eba4f8bb48a9512a1ee0b016af10b5deee0e20c4ccb88d489d7eb5009fcdd203441a1106ddc6b2d867ff2d37c31bc
+  data.tar.gz: 1f3157cf23f35c5b8a221631dcc8fd5c717c92167013c1bfe67b2cc945d16eac5bd985c39669d45c233ed0573c5756bb3bfaaee96e7abb2f6574b074c86b099d

data/README.md

@@ -0,0 +1,80 @@
+# Locality
+
+## Swedish A-Region
+
+See https://sv.wikipedia.org/wiki/A-region
+
+### Installation
+
+```bash
+# Go and buy the rec2LK database from postnummerservice.se
+# Put it in the ./db directory
+```
+
+### Configuration
+
+```ruby
+Locality.configure do |config|
+
+  # By default, locality will look for the rec2LK database in
+  # these locations: `Locality.config.postnummerfilen_paths`
+  # You can add a custom location like so:
+  config.postnummerfilen_path = '/some/custom/rec2LK.csv'
+
+end
+
+```
+### Usage
+
+```ruby
+lookup = Locality::Aregion.new 21  # Gotland
+
+lookup.zip_codes  # => Array of Integers
+# More to come...
+```
+
+## IP Lookup
+
+### Installation
+
+```bash
+# Get the libmaxminddb, e.g. via homebrew on Mac OS
+brew install libmaxminddb
+# Tell bundler where to find it
+bundle config build.hive_geoip2 --with-opt-dir=$(brew --prefix)
+# Download and extract the MaxMind GeoIp2 database
+curl http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz -o ./db && gunzip ./db/GeoLite2-City.mmdb.gz
+```
+
+### Configuration
+
+```ruby
+Locality.configure do |config|
+
+  # By default, locality will look for the maxmind database in
+  # these locations: `Locality.config.maxmind_geoip2_path`
+  # You can add a custom location like so:
+  config.maxmind_geoip2_path = '/some/custom/maxmind_geolite2.mmdb'
+
+  # If you want, you can add custom lookups like so:
+  config.add_custom_ip_location '198.51.100.99/24', city_name: 'Main Office', country_name: 'Australia'
+end
+```
+
+### Usage
+
+```ruby
+lookup = Locality::IP.new '198.51.100.55'
+
+# All these attributes return either a String or nil.
+lookup.ip
+lookup.city_name
+lookup.province_name
+lookup.state_name
+lookup.country_name
+lookup.human_readable_name
+
+# Get them all combined in a Hash
+lookup.to_hash
+```
+

data/lib/locality/aregion.rb

@@ -0,0 +1,22 @@
+require 'locality/postnummerservice'
+
+module Locality
+  # See https://sv.wikipedia.org/wiki/A-region
+  class Aregion
+
+    def initialize(raw_code)
+      @raw_code = raw_code
+    end
+
+    def zip_codes
+      @zip_codes ||= backend.aregions[1].map(&:zip_code)
+    end
+
+    private
+
+    def backend
+      Locality::Postnummerservice
+    end
+
+  end
+end

data/lib/locality/configurable.rb

@@ -0,0 +1,25 @@
+require 'locality/configuration'
+
+module Locality
+  module Configurable
+
+    # Public: Returns the the configuration instance.
+    #
+    def config
+      @config ||= Configuration.new
+    end
+
+    # Public: Yields the configuration instance.
+    #
+    def configure(&block)
+      yield config
+    end
+
+    # Public: Reset the configuration (useful for testing)
+    #
+    def reset!
+      @config = nil
+    end
+
+  end
+end

data/lib/locality/configuration.rb

@@ -0,0 +1,68 @@
+require 'pathname'
+
+module Locality
+  class Configuration
+
+    # IP
+
+    attr_writer :maxmind_geoip2_path
+
+    def custom_ip_locations
+      @custom_ip_locations ||= {}
+    end
+
+    def add_custom_ip_location(ip, data)
+      custom_ip_locations[IPAddr.new(ip)] = data.to_hash
+    end
+
+    def maxmind_geoip2_path
+      maxmind_geoip2_paths.detect &:readable?
+    end
+
+    def maxmind_geoip2_paths
+      paths maxmind_geoip2_filename, custom_maxmind_geoip2_path
+    end
+
+    # Postnummerservice
+
+    attr_writer :postnummerfilen_path
+
+    def postnummerfilen_path
+      postnummerfilen_paths.detect &:readable?
+    end
+
+    def postnummerfilen_paths
+      paths postnummerfilen_filename, custom_postnummerfilen_path
+    end
+
+    private
+
+    def maxmind_geoip2_filename
+      'GeoLite2-City.mmdb'
+    end
+
+    def postnummerfilen_filename
+      'rec2LK.csv'
+    end
+
+    def custom_maxmind_geoip2_path
+      return unless @maxmind_geoip2_path
+      Pathname.new @maxmind_geoip2_path
+    end
+
+    def custom_postnummerfilen_path
+      return unless @postnummerfilen_path
+      Pathname.new @postnummerfilen_path
+    end
+
+    def paths(appendix = nil, additional = nil)
+      result = []
+      result << Rails.root.join('db', appendix) if defined?(Rails)
+      result << Pathname.new('/mnt').join('databases', appendix)
+      result << Pathname.new(Dir.pwd).join('db', appendix)
+      result << additional
+      result.compact
+    end
+
+  end
+end

data/lib/locality/ip.rb

@@ -0,0 +1,96 @@
+require 'active_support/core_ext/object/blank'
+require 'ipaddr'
+require 'operation'
+require 'trouble'
+require 'geocoder'
+
+require 'locality/configurable'
+
+module Locality
+  class IP
+
+    def initialize(raw_ip)
+      @raw_ip = raw_ip
+    end
+
+    def to_hash
+      {
+        ip: ip.to_s,
+        city_name: city_name,
+        province_name: province_name,
+        state_name: state_name,
+        country_name: country_name,
+        human_readable_location: human_readable_location,
+      }
+    end
+
+    def ip
+      @ip ||= ::IPAddr.new raw_ip
+    rescue => exception
+      nil
+    end
+
+    def human_readable_location
+      city_name || province_name || state_name || country_name
+    end
+
+    def city_name
+      return unless lookup
+      lookup.city.presence
+    end
+
+    def province_name
+      return unless lookup
+      lookup.province.presence
+    end
+
+    def state_name
+      return unless lookup
+      lookup.state.presence
+    end
+
+    def country_name
+      return unless lookup
+      lookup.country.presence
+    end
+
+    private
+
+    attr_reader :raw_ip
+
+    def lookup
+      @lookup ||= custom_lookup! || lookup!
+    end
+
+    def lookup!
+      return unless ip.present?
+      ensure_upstream_configuration
+      Geocoder::Lookup.get(:geoip2).search(ip.to_s).first
+
+    rescue IOError => exception
+      Trouble.notify exception
+      configure_upstream!  # Maybe the database file just moved somewhere else, repair by force-reconfiguring
+      nil
+    end
+
+    def custom_lookup!
+      ::Locality.config.custom_ip_locations.each do |key, value|
+        next unless key.include? ip
+        input = Hashie::Mash.new value
+        # Quacking like Geocoder::Result::GeoIP2
+        return Hashie::Mash.new(city: input.city_name, province: input.province_name, state: input.state_name, country: input.country_name)
+      end
+      nil
+    end
+
+    def ensure_upstream_configuration
+      return if Geocoder.config[:ip_lookup] == :geoip2
+      configure_upstream!
+    end
+
+    def configure_upstream!
+      Geocoder.configure ip_lookup: :geoip2, units: :km, geoip2: { cache: Hash.new, lib: 'hive_geoip2', file: ::Locality.config.maxmind_geoip2_path }
+    end
+
+  end
+end

data/lib/locality/postnummerservice/entry.rb

@@ -0,0 +1,35 @@
+module Locality
+  module Postnummerservice
+    class Entry < Array
+
+      def zip_code
+        self[0].to_i
+      end
+
+      def city_name
+        self[1]
+      end
+
+      def state_code
+        self[2]
+      end
+
+      def state_name
+        self[3]
+      end
+
+      def province_name
+        self[4]
+      end
+
+      def province_code
+        self[5]
+      end
+
+      def aregion
+        self[6].to_i
+      end
+
+    end
+  end
+end

data/lib/locality/postnummerservice.rb

@@ -0,0 +1,40 @@
+require 'csv'
+require 'locality/postnummerservice/entry'
+
+module Locality
+  module Postnummerservice
+
+    def self.aregions
+      load
+      @aregions
+    end
+
+    private
+
+    def self.load
+      load! unless loaded?
+    end
+
+    def self.loaded?
+      !!@loaded
+    end
+
+    def self.load!
+      @aregions = {}
+
+      ::CSV.foreach(::Locality.config.postnummerfilen_path, encoding: encoding) do |row|
+        next if row.blank?
+        entry = Entry.new(row)
+        @aregions[entry.aregion] ||= []
+        @aregions[entry.aregion] << entry
+      end
+
+      @loaded = true
+    end
+
+    def self.encoding
+      'ISO-8859-1:UTF-8'  # from:to
+    end
+
+  end
+end

data/lib/locality.rb

@@ -0,0 +1,8 @@
+require 'locality/aregion'
+require 'locality/configurable'
+require 'locality/ip'
+require 'locality/aregion'
+
+module Locality
+  extend Configurable
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: locality
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bukowskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hive_geoip2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: operation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trouble
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: See https://github.com/bukowskis/locality
+email: 
+executables: []
+extensions: []
+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/entry.rb
+homepage: https://github.com/bukowskis/locality
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapping databases provided by maxmind.com and postnummerservice.se
+test_files: []
+has_rdoc: