geoip_whois_asn_country 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cecafa6e6059a81d3f208c39aca786852eabedaa77e21fdef3f9b4e1904af2c
+  data.tar.gz: 3b2920f165960fb295c102fea0d4128d3d62151e3a8462c44a5c672017769498
+SHA512:
+  metadata.gz: 9089baf7322337e7671abdb35558f01a02b0333a385917c14db6c4249191aa1ec24d61e2d4e23ce34b743e9c53a565e6896a891f687e3b3b26ed7d3597c75651
+  data.tar.gz: '01857dec38fb490b811aaf5670ac29c0d3d686a80cc9cb02927def150bc2607d576f771f1afbad63946fde13a5500f34f13449d3b720dfc4047936157ff1be91'

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in geoip_whois_asn_country.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem 'pry'
+gem 'steep'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Stefan Wienert
+
+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,59 @@
+# GeoipWhoisAsnCountry
+
+Uses the node package "@ip-location-db/geo-whois-asn-country" to build a ruby structure for efficient lookup of IP -> country both for IPv4 and IPv6.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add geoip_whois_asn_country
+yarn add @ip-location-db/geo-whois-asn-country
+```
+
+
+## Usage
+
+
+
+```ruby
+require 'geoip_whois_asn_country'
+
+# First run will take a couple of seconds and build the ruby strucutre
+# and cache it into tmp/cache/geoip-country-cache
+country_code = GeoIpCountry.lookup('1.2.3.4')
+=> :CN
+
+country_code = GeoIpCountry.lookup('2001:db8::')
+=> :FI
+
+
+GeoipWhoisAsnCountry.configure do |config|
+  config.cache_path = "tmp/cache/geoip-country-cache"
+  config.ipv4_num_csv_path = "./node_modules/@ip-location-db/geo-whois-asn-country/geo-whois-asn-country-ipv4-num.csv"
+  config.ipv6_num_csv_path = "./node_modules/@ip-location-db/geo-whois-asn-country/geo-whois-asn-country-ipv6-num.csv"
+end
+```
+
+
+## Resource consumption
+
+On a MacBook M2 I get the following results:
+
+```bash
+GeoIP-Whois-ASN-Country: first load + cache
+ Took:   3.812936   0.039471   3.852407 (  3.852622)
+ Residual Memory consumption: 17.94025993347168 MB
+Starting: Cached load from Marshalled Data
+ Took:   0.340433   0.040012   0.380445 (  0.380435)
+ Residual Memory consumption: 17.76226043701172 MB
+Starting: Lookup of 10,000 random Ips
+ Took:   0.041649   0.000000   0.041649 (  0.041644)
+ Residual Memory consumption: 0.00020599365234375 MB
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/Steepfile

@@ -0,0 +1,14 @@
+D = Steep::Diagnostic
+target :lib do
+  signature 'sig'
+
+  check 'test/benchmark.rb'
+
+  library 'singleton'
+  library 'ipaddr'
+  library 'socket'
+  library 'objspace'
+  library 'benchmark'
+
+  configure_code_diagnostics(D::Ruby.strict)
+end

data/lib/geoip_whois_asn_country/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GeoipWhoisAsnCountry
+  VERSION = "0.2.0"
+end

data/lib/geoip_whois_asn_country.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "geoip_whois_asn_country/version"
+require 'singleton'
+
+module GeoipWhoisAsnCountry
+  def self.lookup(ip_address)
+    GeoIpCountry._lookup(ip_address)
+  end
+
+  def self.configure(&block)
+    block.call(GeoIpCountry)
+    Singleton.__init__(GeoIpCountry)
+    nil
+  end
+
+  class GeoIpCountry
+    include Singleton
+
+    class << self
+      attr_accessor :ipv4_num_csv_path, :ipv6_num_csv_path, :cache_path
+    end
+    self.ipv4_num_csv_path = "./node_modules/@ip-location-db/geo-whois-asn-country/geo-whois-asn-country-ipv4-num.csv"
+    self.ipv6_num_csv_path = "./node_modules/@ip-location-db/geo-whois-asn-country/geo-whois-asn-country-ipv6-num.csv"
+    self.cache_path = "tmp/cache/geoip-country-cache"
+    self.cache_time = 60 * 60 * 24
+
+    def self._lookup(ip)
+      if !@singleton__instance__ || @singleton__instance__.instance_variables.length == 0
+        if File.exist?(cache_path) && File.mtime(cache_path) > Time.now - cache_time
+          @singleton__instance__ = load_from_cache
+        else
+          # puts "GeoIP-Whois-ASN-Country: first load + cache"
+          instance.load_csvs
+          cache!
+        end
+      end
+      instance._lookup(ip)
+    end
+
+    def _dump(depth)
+      Marshal.dump({
+        ipv4_map: @ipv4_map,
+        ipv4_sorted_keys: @ipv4_sorted_keys,
+        ipv6_map: @ipv6_map,
+        ipv6_sorted_keys: @ipv6_sorted_keys,
+      }, depth)
+    end
+
+    def self._load(map_str)
+      map = Marshal.load(map_str)
+      instance.instance_variable_set(:@ipv4_map, map[:ipv4_map])
+      instance.instance_variable_set(:@ipv4_sorted_keys, map[:ipv4_sorted_keys])
+      instance.instance_variable_set(:@ipv6_map, map[:ipv6_map])
+      instance.instance_variable_set(:@ipv6_sorted_keys, map[:ipv6_sorted_keys])
+      instance
+    end
+
+    def self.cache!
+      File.open(cache_path, "wb+") { |f| f.write Marshal.dump(instance) }
+    end
+
+    def self.load_from_cache
+      Marshal.load(File.read(cache_path))
+    end
+
+    def load_csvs
+      require 'csv'
+      @ipv4_map = {}
+      File.open(self.class.ipv4_num_csv_path) do |file|
+        CSV.foreach(file, headers: false) do |row|
+          from, _, country = row
+          @ipv4_map[from.to_i] = country.to_sym
+        end
+      end
+      @ipv4_sorted_keys = @ipv4_map.keys.sort.freeze
+
+      @ipv6_map = {}
+      File.open(self.class.ipv6_num_csv_path) do |file|
+        CSV.foreach(file, headers: false) do |row|
+          from, _, country = row
+          @ipv6_map[from.to_i] = country.to_sym
+        end
+      end
+      @ipv6_sorted_keys = @ipv6_map.keys.sort.freeze
+      nil
+    end
+
+    def _lookup(ip)
+      ip = IPAddr.new(ip) if ip.is_a?(String)
+      ip_i = ip.to_i
+      if ip.ipv4?
+        @ipv4_map[@ipv4_sorted_keys.bsearch { |x| x >= ip_i }]
+      else
+        @ipv6_map[@ipv6_sorted_keys.bsearch { |x| x >= ip_i }]
+      end
+    end
+  end
+end

data/sig/benchmark.rbs

@@ -0,0 +1,15 @@
+class BenchmarkTest
+  include GeoipWhoisAsnCountry
+
+  def lookup: (untyped ip) -> untyped
+
+  def benchmark_load: () -> untyped
+
+  def cached_load: () -> untyped
+
+  def measure: (untyped title) { () -> untyped } -> untyped
+
+  def test_function: () -> untyped
+
+  def test_benchmark: () -> untyped
+end

data/sig/geoip_whois_asn_country.rbs

@@ -0,0 +1,39 @@
+# TypeProf 0.21.3
+
+# Classes
+module GeoipWhoisAsnCountry
+  VERSION: String
+
+  def self.lookup: (String | IPAddr ip_address) -> Symbol?
+  def self.configure: () { ( singleton(GeoIpCountry) ) -> untyped } -> nil
+
+  class GeoIpCountry
+    include Singleton
+
+    self.@singleton__instance__: untyped
+    @ipv4_map: Hash[Integer, Symbol]
+    @ipv4_sorted_keys: Array[Integer]
+    @ipv6_map: Hash[Integer, Symbol]
+    @ipv6_sorted_keys: Array[Integer]
+
+    def self.cache_path: -> String
+    def self.cache_path=: (String path) -> String
+
+    def self.ipv6_num_csv_path: -> String
+    def self.ipv6_num_csv_path=: (String path) -> String
+
+    def self.ipv4_num_csv_path: -> String
+    def self.ipv4_num_csv_path=: (String path) -> String
+
+    def self.instance: -> GeoIpCountry
+
+
+    def self._lookup: (String | IPAddr ip) -> Symbol?
+    def _dump: (untyped depth) -> String
+    def self._load: (untyped map_str) -> GeoIpCountry
+    def self.cache!: -> Integer
+    def self.load_from_cache: -> GeoIpCountry
+    def load_csvs: -> nil
+    def _lookup: (String | IPAddr ip) -> Symbol?
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: geoip_whois_asn_country
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-21 00:00:00.000000000 Z
+dependencies: []
+description: Efficient lookup of ipv4/ipv6 to country using the node-modules's geo-whois-asn-country
+  CSVs.
+email:
+- info@stefanwienert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/geoip_whois_asn_country.rb
+- lib/geoip_whois_asn_country/version.rb
+- sig/benchmark.rbs
+- sig/geoip_whois_asn_country.rbs
+homepage: https://github.com/pludoni/ruby-geoip_whois_asn_country
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pludoni/ruby-geoip_whois_asn_country
+  source_code_uri: https://github.com/pludoni/ruby-geoip_whois_asn_country
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Efficient lookup of ipv4/ipv6 to country using the node-modules's geo-whois-asn-country
+  CSVs.
+test_files: []