iparty 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f040fd93232947aa2be967cac0ad59617cc24e4751c14908466e221d4830fc6
-  data.tar.gz: 4b34b52ee226d40b306da7d8dcf7f576ceb37c98d2695c1e2a78db43703ba40a
+  metadata.gz: 61224732c6f0206d4525d1a238e76106646a14efdd76cbb3dc4e989a6a41b1a5
+  data.tar.gz: da8851962434b85c846b378e9332380101f22fc3bc10037a3d2b787b52bda003
 SHA512:
-  metadata.gz: 1f319c5dbfcad4f51192b750a973f1de60dbee54db84f176aa67ed921f883770eaf61fb82f1b32a837e93072eb0a10f562bed4e2743cf5df3a4936e957bcf1b1
-  data.tar.gz: 67f50c5df51c1c1e06266c780d5b27163b9ee5a7bb45c22f8c846c4de8baa6c8f083db174d09690211780b8edcbc13bb0196acc7355e6e8f24ee18f75d0b7e4a
+  metadata.gz: a387ddb5bc240ec0c81f358da1f1696f398bfb7371e81e8d84f78c7dcc05ea6a440f42965df619df5f642321a62a6d5e7453ff33f5c1162bb4bac626b5c2704e
+  data.tar.gz: 3e7e52dac937e4610957b2145f639ca6bc82c6a4503a495db03f9f17cb89df456431b005e19a416079754fe57ef0aa36c054b3b8d6693b58f820dcc444a77328

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [0.1.3] - 2026-05-29
+
+* Fix: Correctly re-normalize insignificant ipv6 IParty::Address
+* Fix: `significant: true` option on insignificant ipv6 IParty::Address#to_s
+* Add `IParty.normalize_family` to allow all of Socket constant, 4/6 or :ipv4/:ipv6
+* Add `IParty.insignificant(long)` and `IParty::Address.from_insignificant(long)` to get address from insignificant ipv6-long
+* `IParty.normalize`, when given an integer as address, will accept as family: 4 6 :ipv4 :ipv6 (also Socket::AF_INET Socket::AF_INET6 as before)
+* `IParty.config.singletons = true` will no longer cause immediate init of database objects. Use `IParty.config.init_singletons!` after you've set all options if you want "true behaviour".
+  If the value is set to true `init_singletons!` will be called the first time a database object is initialized.
+* Compact input to expand_hostnames
+* Add dev script to test performance with rbspy
+* [doc] Add CurrentAttribute example for AS<8
+* [cli] Add cookbook helper
+* [cli] Show dispatchable actions in verbose appinfo
+
+
+
 ## [0.1.2] - 2026-05-27
 
 * Include documentation in gem package

data/README.md

@@ -123,7 +123,7 @@ ip.country.name(:es, fallback_locale: :fr) == "Germany"
 ip.country.dig(:names, :en) == "Germany"
 ```
 
-You should definitely take a quick look at the documentation, specifically about the [MaxMine::Result](docs/maxmind_result.md) object.
+You should definitely take a quick look at the documentation, specifically about the [MaxMind::Result](docs/maxmind_result.md) object.
 It should be intuitive magic but you may scratch your head if you "don't get it".
 
 

data/docs/benchmark.md

@@ -5,31 +5,31 @@
 This is the result of `script/benchmark.rb` on my M1.
 
 ```
-RSS-before[uncached]: 30.31 MB
+RSS-before[uncached]: 28.98 MB
 ruby 3.3.6 (2024-11-05 revision 75015d4c1f) [arm64-darwin21]
 Warming up --------------------------------------
             uncached   145.000 i/100ms
 Calculating -------------------------------------
-            uncached      1.448k (± 1.9%) i/s  (690.59 μs/i) -     14.500k in  10.017464s
-RSS-after[uncached]: 48.75 MB
+            uncached      1.454k (± 2.1%) i/s  (687.88 μs/i) -     87.290k in  60.075809s
+RSS-after[uncached]: 49.45 MB
 
 
-RSS-before[singletons]: 29.77 MB
+RSS-before[singletons]: 30.17 MB
 ruby 3.3.6 (2024-11-05 revision 75015d4c1f) [arm64-darwin21]
 Warming up --------------------------------------
-          singletons   162.000 i/100ms
+          singletons   163.000 i/100ms
 Calculating -------------------------------------
-          singletons      1.565k (± 8.0%) i/s  (638.87 μs/i) -     15.552k in  10.006033s
-RSS-after[singletons]: 31.27 MB
+          singletons      1.633k (± 1.3%) i/s  (612.35 μs/i) -     98.126k in  60.097790s
+RSS-after[singletons]: 31.28 MB
 
 
-RSS-before[eager_load]: 30.20 MB
+RSS-before[eager_load]: 30.62 MB
 ruby 3.3.6 (2024-11-05 revision 75015d4c1f) [arm64-darwin21]
 Warming up --------------------------------------
-          eager_load   500.000 i/100ms
+          eager_load   449.000 i/100ms
 Calculating -------------------------------------
-          eager_load      4.940k (± 4.1%) i/s  (202.43 μs/i) -     49.500k in  10.038651s
-RSS-after[eager_load]: 112.73 MB
+          eager_load      4.566k (± 1.3%) i/s  (219.02 μs/i) -    274.339k in  60.095499s
+RSS-after[eager_load]: 114.52 MB
 ```
 
 ### Personal conclusion

data/docs/cli/README.md

@@ -51,19 +51,28 @@ Also look at the action cookbook in `docs/cli/action_cookbook`.
 # For IParty options refer to the IParty documentation.
 #     https://github.com/2called-chaos/iparty/blob/master/README.md
 
-IParty.config.annotate "1.1.1.1", "1.0.0.1", tags: %i[cloudflare_dns]
-IParty.config.annotate_tag %i[loopback], "127.0.0.1/8", "::1"
+IParty.config.account_id = "..."
+IParty.config.license_key = "..."
+
+# tip: tidy up with offloading to `require_relative "annotations"`
+IParty.configure do |config|
+  config.annotate "1.1.1.1", "1.0.0.1", tags: %i[cloudflare_dns]
+  config.annotate_tag %i[loopback], "127.0.0.1/8", "::1"
+end
 
 
-# Change defaults (arguments will still override)
+# Change CLI defaults (arguments will still override)
 # For CLI options refer to application/options.rb#default_options
 #     https://github.com/2called-chaos/iparty/blob/master/lib/iparty/cli/application/options.rb
 
-# @opts[:summarize] = false
-# @opts[:except] += [
-#   "registered_country",
-#   "subdivisions",
-# ]
+@opts[:summarize] = false
+@opts[:except] += [
+  "registered_country",
+  "subdivisions",
+]
+
+# This will eval (usable) examples from docs/cli/action_cookbook
+cookbook("show_my_remote_ips")
 
 
 

data/docs/cli/action_cookbook/show_my_remote_ips.rb

@@ -4,6 +4,7 @@
 
 # iparty -d me
 # iparty --dispatch me
+# iparty --dispatch me short
 def dispatch_me
   require "net/http"
 
@@ -11,20 +12,22 @@ def dispatch_me
     Net::HTTP.get(URI(url))
   rescue Socket::ResolutionError
     formatter.colorize? ? c("SOCKET_ERROR", :red) : :SOCKET_ERROR
-  rescue StandardError
-    formatter.colorize? ? c("ERROR", :red) : :ERROR
+  rescue StandardError => ex
+    formatter.colorize? ? c("ERROR-#{ex.class}", :red) : :"ERROR-#{ex.class}"
   end
 
-  if the_more_clever_way = true
-    @argv << get_ip["https://api.ipify.org"]
-    @argv << get_ip["https://api6.ipify.org"]
-    dispatch_info
-  else
+  if @argv.delete("short")
     out << formatter.format("my external ips") do
       onlyexcept_data!(
         ipv4: get_ip["https://api.ipify.org"],
         ipv6: get_ip["https://api6.ipify.org"],
       )
     end
+  else
+    @argv.concat([
+      get_ip["https://api.ipify.org"],
+      get_ip["https://api6.ipify.org"],
+    ].reject{ _1.include?("ERROR") })
+    dispatch_info
   end
 end

data/docs/configuration.md

@@ -30,7 +30,7 @@ IParty(request.remote_ip).best_tenant # => :us
 
 ### Full config
 
-This config, minus the CurrentAttributes cache is default config. For basic usage you only need account_id/license_key.
+Apart from the examples this config represents default behaviour. For basic usage you only need account_id/license_key.
 Please also take a look at docs/maxmind_result.md for extending the address and geo results.
 
 ```ruby
@@ -42,33 +42,6 @@ defined?(IParty) && IParty.configure do |config|
   #   * significant: keyword (affected methods only but including new/initialize)
   config.ipv6_significant = config.env_value("IPARTY_IPV6_SIGNIFICANT", true)
 
-  # Whether to use the low memory file reader or load mmdb into memory as a whole (see docs/benchmark.md)
-  config.eager_load = config.env_value("IPARTY_EAGER_LOAD", false)
-
-  # Use singleton instances of MaxMind::Database readers.
-  # These are lazily initialized so in a threaded environment or with eager load enabled you should pre-init them.
-  # Side Effect: You will have to reboot your app for mmdb changes to take effect.
-  config.singletons = config.env_value("IPARTY_SINGLETONS", false)
-  #config.singletons = {} # lazy load singleton instances, not thread-safe
-  #config.singletons = true # eagerly init all editions (eager_load into memory if enabled, thread-safe after init)
-
-  # alternatively you can do something like this:
-  # * singleton DB instances (lazily memoized) per-request (eager load should be disabled)
-  # * IParty::Address cache (including their geo lookups)
-  if defined?(ActiveSupport::CurrentAttributes)
-    class IPartyCache < ActiveSupport::CurrentAttributes
-      attribute(:databases, default: {})
-
-      # cached IParty addresses, i.e. IPartyCache.ips["1.2.3.4"]
-      # Be wary of mutating (i.e. mask!), use clones
-      attribute(:ips, default: -> { Hash.new{|h, ip| h[ip.to_s] = IParty(ip.to_s) } })
-    end
-    config.singletons = -> { IPartyCache.databases }
-  end
-
-  # An IP that is used instead of local IPs
-  config.local_ip_alias = config.env_value("IPARTY_LOCAL_IP_ALIAS", nil)
-
   # MaxMind account_id and license_key aka mirror basic-auth
   config.account_id = config.env_value("MAXMIND_ACCOUNT_ID", nil)
   config.license_key = config.env_value("MAXMIND_LICENSE_KEY", nil)
@@ -99,8 +72,52 @@ defined?(IParty) && IParty.configure do |config|
     system("#{curl} | #{tar}")
   end
 
+  # An IP that is used instead of local IPs
+  config.local_ip_alias = config.env_value("IPARTY_LOCAL_IP_ALIAS", nil)
+
+  # Whether to use the low memory file reader or load mmdb into memory as a whole (see docs/benchmark.md)
+  config.eager_load = config.env_value("IPARTY_EAGER_LOAD", false)
+
+  # Use singleton instances of MaxMind::Database readers.
+  # These are lazily initialized so in a threaded environment or with eager load enabled you should pre-init them.
+  # Side Effect: You will have to reboot your app for mmdb changes to take effect.
+  # See per-request singletons+cache in examples below.
+  config.singletons = config.env_value("IPARTY_SINGLETONS", false)
+
+  # Lazy load singleton instances, not thread-safe
+  #config.singletons = {}
+
+  # Eager load instances (eager_load into memory if enabled)
+  # WARNING: do that after all other options!
+  #config.init_singletons!
+
+
   # --- following is example code and not default behaviour ---
 
+
+  # You may want to rely on rake task and/or ensure on app boot?
+  #   fetch_when can be
+  #     * :always
+  #     * :missing
+  #     * (Numeric) maxAge (i.e. (int)seconds or (AS::Duration)14.days)
+  IParty.fetch_db_files!(:missing, verbose: true)
+
+
+  # Per-request singletons and IP cache (ActiveSupport 8+):
+  # * singleton DB instances (lazily memoized) per-request (eager_load should be disabled)
+  # * IParty::Address cache (including their geo lookups)
+  if defined?(ActiveSupport::CurrentAttributes)
+    class IPartyCache < ActiveSupport::CurrentAttributes
+      attribute(:databases, default: {})
+
+      # cached IParty addresses, i.e. IPartyCache.ip["1.2.3.4"]
+      # Be wary of mutating (i.e. mask!), use clones
+      attribute(:ip, default: -> { Hash.new{|h, ip| h[ip.to_s] = IParty(ip.to_s) } })
+    end
+    config.singletons = -> { IPartyCache.databases }
+  end
+
+
   # Proc to transform geo result data, by default does nothing.
   # yields
   #   data          the result hash
@@ -113,17 +130,11 @@ defined?(IParty) && IParty.configure do |config|
     end
   end
 
+
   # For more info on extending look at docs/maxmind_result.md
   IParty::Address.define_method(:detailed) do |*args|
     "#{to_s} -- #{geo.detailed} -- #{asn.detailed}"
   end
-
-  # You may want to rely on rake task and/or ensure on app boot?
-  #   fetch_when can be
-  #     * :always
-  #     * :missing
-  #     * (Numeric) maxAge (i.e. (int)seconds or (AS::Duration)14.days)
-  IParty.fetch_db_files!(:missing, verbose: true)
 end
 ```
 
@@ -168,3 +179,24 @@ rake iparty:config[json]
 # check mmdb file status
 rake iparty:status
 ```
+
+
+
+### CurrentAttribute cache (ActiveSupport <8)
+
+This works around the lack of `default` keyword support in older ActiveSupport.
+
+```ruby
+class IPartyCache < ActiveSupport::CurrentAttributes
+  attribute(:databases)
+  attribute(:ip)
+
+  def databases
+    super || attributes[:databases] = {}
+  end
+
+  def ip
+    super || attributes[:ip] = Hash.new{|h, ip| h[ip.to_s] = IParty(ip.to_s) }
+  end
+end
+```

data/docs/maxmind_result.md

@@ -61,7 +61,7 @@ IParty::MaxMind::Result::Geo.define_attr(:best_tenant, export: true) { continent
 IParty::MaxMind::Result::Geo.define_attr(:short, export: true) { [continent.code, country.name].compact.join(" / ") }
 IParty::MaxMind::Result::Asn.define_attr(:short, export: :asn_short) { "AS#{number} #{organization}" }
 IParty::Address.define_method(:detailed) { "#{to_s} -- #{geo.detailed} -- #{asn_short}" }
-# IParty(ip).short/asn_short/detailed
+# IParty(ip).best_tenant/short/asn_short/detailed
 
 # Delegate geo/asn methods so you can do `ip.METHOD` instead of `ip.geo.METHOD`
 IParty::Address.def_delegators(:geo, *%i[registered_country])

data/docs/mmdb_download.md

@@ -15,10 +15,10 @@ By default IParty will use this proc (and you may change it) to turn a URL (to a
 Note: This requires a unix-oid environment with curl, tar and gzip available.
 
 ```ruby
-IParty::MaxMind.download_proc = proc do |url, temp_dir|
-  auth = %{-u "#{account_id}:#{license_key}"} if account_id && license_key
+IParty.config.url_to_mmdb = proc do |url, dir, config|
+  auth = %{-u "#{config.account_id}:#{config.license_key}"} if config.account_id && config.license_key
   curl = %{curl -L -s #{"#{auth} " if auth}"#{url}"}
-  tar = %{tar xz --strip-components 1 --exclude "*.txt" --no-same-owner -C #{temp_dir.to_s.shellescape}}
+  tar = %{tar xz --strip-components 1 --exclude "*.txt" --no-same-owner -C #{dir.to_s.shellescape}}
   system("#{curl} | #{tar}")
 end
 ```

data/lib/iparty/address.rb

@@ -6,6 +6,10 @@ module IParty
   class Address < IPAddr
     extend Forwardable
 
+    def self.from_insignificant long, **kw
+      new((long << 64) & ((1 >> 64) - 1), Socket::AF_INET6, **kw)
+    end
+
     attr_accessor :ipv6_significant
 
     def initialize *args, **kw
@@ -17,7 +21,7 @@ module IParty
     end
 
     def force_significant?
-      @family == Socket::AF_INET6 && @addr == 1
+      @family == Socket::AF_INET6 && (@addr == 1 || ipv4_mapped? || ipv4_compat?)
     end
 
     def type
@@ -32,7 +36,7 @@ module IParty
       if ipv4?
         2**(32 - prefix)
       elsif ipv6?
-        if force_significant? || significant || ipv4_mapped? || ipv4_compat?
+        if significant || force_significant?
           2**(128 - prefix)
         else
           2**[0, 128 - prefix - 64].max
@@ -81,26 +85,31 @@ module IParty
     end
 
     def prefix significant: ipv6_significant
-      return super() if force_significant? || significant || !ipv6? || ipv4_mapped? || ipv4_compat? || super() <= 64
+      return super() if significant || force_significant? || super() <= 64
 
       64
     end
 
     def to_i significant: ipv6_significant
-      return super() if force_significant? || significant || !ipv6? || ipv4_mapped? || ipv4_compat? || prefix(significant: true) <= 64
+      return super() if significant || force_significant? || prefix(significant: true) <= 64
 
       # drop upper 64 bits / host-identifier of ipv6
       (super() >> 64) & ((1 << 64) - 1)
     end
 
+    alias_method :original_to_s, :to_s
     def to_s significant: ipv6_significant
-      return super() if force_significant? || significant || !ipv6? || ipv4_mapped? || ipv4_compat? || prefix(significant: true) <= 64
+      return original_to_s unless @family == Socket::AF_INET6
 
-      mask(64).to_s(significant: true)
+      if significant || force_significant? || prefix(significant: true) <= 64
+        to_significant.original_to_s
+      else
+        mask(64).original_to_s
+      end
     end
 
     def to_string significant: ipv6_significant
-      return super() if force_significant? || significant || !ipv6? || ipv4_mapped? || ipv4_compat? || prefix(significant: true) <= 64
+      return super() if significant || force_significant? || prefix(significant: true) <= 64
 
       mask(64).to_string(significant: true)
     end

data/lib/iparty/cli/application/actions.rb

@@ -20,7 +20,7 @@ module IParty
         # via -v/--version
         def dispatch_appinfo pad: 20
           parts = if @opts[:debug]
-            %i[runtime cli_opts cli_config formatters iparty_config mmdb_status]
+            %i[runtime cli_opts cli_config actions formatters iparty_config mmdb_status]
           else
             %i[runtime cli_config mmdb_status]
           end

data/lib/iparty/cli/application/appinfo.rb

@@ -73,10 +73,23 @@ module IParty
           end.all?
         end
 
+        def appinfo_actions pad: 20
+          pad = -2 if pad.zero?
+
+          puts c("#{"".rjust(pad + 2)}# Available actions (-d)", :magenta)
+          methods.grep(/^dispatch_/).reverse_each do |name|
+            puts [
+              c("#{"".rjust(pad)}* "),
+              c(name.to_s.delete_prefix("dispatch_"), :blue),
+              c(" in #{method(name).source_location.join(":")}", :black),
+            ].join
+          end
+        end
+
         def appinfo_formatters pad: 20
           pad = -2 if pad.zero?
 
-          puts c("#{"".rjust(pad + 2)}# Available formatters", :magenta)
+          puts c("#{"".rjust(pad + 2)}# Available formatters (-f)", :magenta)
           CLI::Formatter.descendants.each do |fmt|
             name = fmt.to_s
             source_location = begin

data/lib/iparty/cli/application.rb

@@ -47,6 +47,13 @@ module IParty
         yield(self) if block_given?
       end
 
+      def cookbook *recipes
+        recipes.flatten.each do |recipe|
+          file = IParty::GEM_ROOT.join("docs", "cli", "action_cookbook", "#{recipe}.rb")
+          instance_eval(file.read, "#{caller(3..3).first}, eval #{file}")
+        end
+      end
+
       def ensure_mmdb_files! fetch_when = @opts[:mmdb_fetch_when]
         IParty::MaxMind.fetch_db_files!(fetch_when, verbose: true)
       end

data/lib/iparty/config.rb

@@ -18,7 +18,6 @@ module IParty
   ) do
     def singletons=(val)
       self[:singletons] = val
-      init_singletons! if val == true
     end
 
     def init_singletons!

data/lib/iparty/max_mind.rb

@@ -13,7 +13,12 @@ module IParty
         return unless file.exist?
 
         if ctn = IParty.config.singletons
-          ctn = ctn.call if ctn.is_a?(Proc)
+          if ctn.is_a?(Proc)
+            ctn = ctn.call
+          elsif ctn == true
+            ctn = IParty.config.init_singletons!
+          end
+
           return ctn.fetch(edition) if ctn.key?(edition)
         end
 

data/lib/iparty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IParty
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/iparty.rb

@@ -28,6 +28,18 @@ module IParty
     IParty::MaxMind.fetch_db_files!(*args, **kw)
   end
 
+  def self.insignificant long, **kw
+    return unless long
+
+    Address.from_insignificant(long, **kw)
+  end
+
+  def self.classify input
+    normalize(input).type
+  rescue IPAddr::Error
+    :invalid
+  end
+
   def self.normalize input, family = nil, native: false, **kw
     return unless input
     return if input.is_a?(String) && input.match?(/\A[[:space:]]*\z/)
@@ -36,11 +48,13 @@ module IParty
     addr = case input
     when String
       Address.new(input.strip, **kw)
+    when IParty::Address
+      Address.new(input.to_i(significant: true), input.family)
     when IPAddr
       Address.new(input.to_i, input.family)
     when Integer
       family ||= input > (2**32) - 1 ? Socket::AF_INET6 : Socket::AF_INET
-      Address.new(input, family, **kw)
+      Address.new(input, normalize_family(family), **kw)
     else
       raise IPAddr::InvalidAddressError, "invalid address: #{input}"
     end
@@ -48,14 +62,21 @@ module IParty
     native ? addr.native : addr
   end
 
-  def self.classify input
-    normalize(input).type
-  rescue IPAddr::Error
-    :invalid
+  def self.normalize_family family
+    case family
+    when :ipv6, 6, 30 # Socket::AF_INET6 = 30
+      Socket::AF_INET6
+    when :ipv4, 4, 2 # Socket::AF_INET = 2
+      Socket::AF_INET
+    when nil
+      raise IPAddr::AddressFamilyError, "address family must be specified"
+    else
+      raise IPAddr::AddressFamilyError, "unsupported address family: #{family}"
+    end
   end
 
   def self.expand_hostnames *ips_or_hosts
-    ips_or_hosts.flatten.flat_map do |name|
+    ips_or_hosts.flatten.compact.flat_map do |name|
       next name unless name.is_a?(String) && !name.include?(":") && name.match?(/[a-z]/i)
 
       if defined?(Resolv)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iparty
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sven Pachnit