iparty 0.1.0

data/lib/iparty/max_mind.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+require_relative "max_mind/database"
+
+module IParty
+  class MaxMind
+    class << self
+      def db edition
+        edition = "GeoLite2-#{edition}" if edition.is_a?(Symbol)
+        file = IParty.config.directory.join("#{edition}.mmdb")
+        return unless file.exist?
+
+        if ctn = IParty.config.singletons
+          ctn = ctn.call if ctn.is_a?(Proc)
+          return ctn.fetch(edition) if ctn.key?(edition)
+        end
+
+        Database.new(file, reader: IParty.config.eager_load ? EagerReader : LazyReader).tap do |dbi|
+          ctn[edition] ||= dbi if ctn
+        end
+      end
+
+      def lookup edition, *args, close: true, **kw
+        return unless mmdb = db(edition)
+
+        mmdb.lookup(*args, **kw).tap do
+          mmdb.close if close && !IParty.config.singletons
+        end
+      end
+
+      def with_transactional_update_directory
+        temp_dir = IParty.config.directory.join(".updating")
+        return yield(temp_dir) if @in_transaction
+
+        begin
+          @in_transaction = true
+          temp_dir.mkpath
+          yield(temp_dir)
+        ensure
+          @in_transaction = false
+          temp_dir.glob("*.mmdb").each do |file|
+            Database.new(file, reader: LazyReader)
+            FileUtils.mv(file, IParty.config.directory)
+          rescue Database::InvalidFileFormatError
+            warn "iparty: ignoring invalid mmdb file: #{file}"
+          end
+          FileUtils.rm_rf(temp_dir)
+        end
+      end
+
+      def fetch_db_files! fetch_when = :always, verbose: false
+        with_transactional_update_directory do
+          IParty.config.editions.each do |edition|
+            fetch_db_file!(edition, fetch_when, verbose: verbose)
+          end
+        end
+      end
+
+      def fetch_db_file_reason file, fetch_when = :always
+        return fetch_when if fetch_when == :always
+        return :missing unless file.exist?
+
+        begin
+          Database.new(file, reader: LazyReader)
+        rescue Database::InvalidFileFormatError
+          return :invalid
+        end
+
+        return unless fetch_when.is_a?(Numeric)
+
+        ctime = file.ctime
+        age = Time.now - ctime
+        :expired unless fetch_when > age
+      end
+
+      def fetch_db_file! edition, fetch_when = :always, verbose: false
+        target_file = IParty.config.directory.join("#{edition}.mmdb")
+        return target_file unless reason = fetch_db_file_reason(target_file, fetch_when)
+
+        with_transactional_update_directory do |temp_dir|
+          warn "iparty: fetching #{reason}: #{target_file.basename}" if verbose
+          IParty.config.url_to_mmdb.call(
+            IParty.config.mirror.gsub(":edition", edition),
+            temp_dir,
+            IParty.config,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/iparty/railtie.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module IParty
+  class Railtie < Rails::Railtie
+    railtie_name :iparty
+
+    rake_tasks do
+      require "iparty/rake_task"
+      IParty::RakeTask.new
+    end
+
+    config.before_configuration do
+      IParty.config.directory = IParty.env_value("IPARTY_DIRECTORY", nil) do |dir|
+        if dir && !dir.empty?
+          Pathname.new(dir)
+        else
+          Rails.root.join("vendor", "maxmind")
+        end
+      end
+    end
+  end
+end

data/lib/iparty/rake_task.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+module IParty
+  class RakeTask < ::Rake::TaskLib
+    attr_accessor :name, :verbose
+
+    def initialize(name = :iparty)
+      super()
+
+      @name = name
+      @verbose = true
+
+      yield self if block_given?
+      define_update
+      define_fetch
+      define_status
+      define_config
+    end
+
+    def parse_duration input, default = :missing
+      return default unless input.is_a?(String)
+
+      if input.match?(/\A\d+\z/)
+        input.to_i
+      elsif asm = input.match(/\A(\d+)\.(second|minute|hour|day|week|month|year)s?\z/)
+        ActiveSupport::Duration.send(:"#{asm[2]}s", asm[1].to_i)
+      else
+        default
+      end
+    end
+
+    # iparty:update
+    def define_update
+      namespace(name) do
+        desc "Updates geoip mmdb-files"
+        task :update do
+          Rake.application.lookup("environment")&.invoke
+
+          IParty::MaxMind.fetch_db_files!(verbose: @verbose)
+        end
+      end
+    end
+
+    # iparty:fetch
+    # iparty:fetch[86400]
+    # iparty:fetch[14.days]
+    def define_fetch
+      namespace(name) do
+        desc "Fetches missing or expired geoip mmdb-files (optional numeric max_age)"
+        task :fetch, [:max_age] do |task, args|
+          Rake.application.lookup("environment")&.invoke
+
+          IParty::MaxMind.fetch_db_files!(parse_duration(args[:max_age]), verbose: @verbose)
+        end
+      end
+    end
+
+    # iparty:status
+    def define_status
+      namespace(name) do
+        desc "Show status of geoip mmdb-files (optional numeric max_age)"
+        task :status, [:max_age] do |task, args|
+          Rake.application.lookup("environment")&.invoke
+
+          max_age = parse_duration(args[:max_age])
+
+          success = IParty.config.editions.map do |edition|
+            file = IParty.config.directory.join("#{edition}.mmdb")
+            reason = IParty::MaxMind.fetch_db_file_reason(file, max_age)
+
+            stat_string = if file.exist?
+              ctime   = file.ctime
+              age     = Time.now - ctime
+              days    = (age / 86_400).floor
+              hours   = ((age / 3_600) % 24).floor
+              minutes = ((age / 60) % 60).floor
+              age_string = [
+                ("#{days}d" if days > 0),
+                ("%02d:%02d" % [hours, minutes] if hours > 0 || minutes > 0),
+              ].compact.join(" ")
+              age_string = "#{age.floor}s" if age_string.empty?
+              "[age: #{age_string}, ctime: #{ctime}]"
+            end
+
+            puts [reason&.upcase || "OK", stat_string, file].compact.join(" ")
+            !reason
+          end.all?
+
+          exit(1) unless success
+        end
+      end
+    end
+
+    # iparty:config
+    # iparty:config[inspect]
+    # iparty:config[json]
+    def define_config
+      namespace(name) do
+        desc "Shows effective IParty config (including license_key, optional format json/inspect)"
+        task :config, [:format] do |task, args|
+          Rake.application.lookup("environment")&.invoke
+
+          case args[:format]
+          when "json"
+            require "json"
+            puts JSON.pretty_generate(IParty.config.to_h)
+          when "inspect"
+            puts IParty.config.inspect
+          else
+            IParty.config.each_pair do |key, value|
+              puts "#{key.to_s.rjust(16)}: #{value.inspect}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/iparty/version.rb

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

data/lib/iparty.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require "fileutils"
+require "forwardable"
+
+# rubocop:disable Naming/MethodName -- we party!
+def IParty *args, **kw
+  IParty.normalize(*args, **kw)
+end
+# rubocop:enable Naming/MethodName
+
+module IParty
+  class Error < StandardError; end
+
+  require_relative "iparty/version"
+  require_relative "iparty/config"
+  require_relative "iparty/address"
+  require_relative "iparty/max_mind"
+  require_relative "iparty/railtie" if defined?(Rails)
+
+  @config = default_config
+
+  def self.fetch_db_files! *args, **kw
+    IParty::MaxMind.fetch_db_files!(*args, **kw)
+  end
+
+  def self.normalize input, family = nil, native: false, **kw
+    return unless input
+    return if input.is_a?(String) && input.match?(/\A[[:space:]]*\z/)
+    return if input.respond_to?(:empty?) && input.empty?
+
+    addr = case input
+    when String
+      Address.new(input.strip, **kw)
+    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)
+    else
+      raise IPAddr::InvalidAddressError, "invalid address: #{input}"
+    end
+
+    native ? addr.native : addr
+  end
+
+  def self.classify input
+    normalize(input).type
+  rescue IPAddr::Error
+    :invalid
+  end
+
+  def self.expand_hostnames *ips_or_hosts
+    ips_or_hosts.flatten.flat_map do |name|
+      next name unless name.is_a?(String) && !name.include?(":") && name.match?(/[a-z]/i)
+
+      if defined?(Resolv)
+        Resolv.getaddresses(name)
+      elsif defined?(Addrinfo)
+        begin
+          Addrinfo.getaddrinfo(name, nil).map(&:ip_address).uniq
+        rescue Socket::ResolutionError
+          []
+        end
+      else
+        raise "neither resolv nor addrinfo is available (gem install resolv)"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: iparty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sven Pachnit
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  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: forwardable
+  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: optparse
+  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: tmpdir
+  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'
+description: Makes (geo) IP fun again! Geo, v6 significance and more.
+email:
+- sven@bmonkeys.net
+executables:
+- iparty
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/iparty
+- lib/iparty.rb
+- lib/iparty/address.rb
+- lib/iparty/cli/application.rb
+- lib/iparty/cli/application/actions.rb
+- lib/iparty/cli/application/appinfo.rb
+- lib/iparty/cli/application/irb_context.rb
+- lib/iparty/cli/application/options.rb
+- lib/iparty/cli/colorize.rb
+- lib/iparty/cli/formatter.rb
+- lib/iparty/config.rb
+- lib/iparty/max_mind.rb
+- lib/iparty/max_mind/database.rb
+- lib/iparty/max_mind/eager_reader.rb
+- lib/iparty/max_mind/lazy_reader.rb
+- lib/iparty/max_mind/result.rb
+- lib/iparty/railtie.rb
+- lib/iparty/rake_task.rb
+- lib/iparty/version.rb
+homepage: https://github.com/2called-chaos/iparty
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/2called-chaos/iparty/blob/master/README.md
+  source_code_uri: https://github.com/2called-chaos/iparty
+  changelog_uri: https://github.com/2called-chaos/iparty/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Makes (geo) IP fun again!
+test_files: []