ipmax 0.1.0

data/lib/ipmax/models.rb

@@ -0,0 +1,571 @@
+# frozen_string_literal: true
+
+module IPMax
+  module Models
+    module AnonymizerExemptionReason
+      CLOUDFLARE_CDN_ORIGIN = "cloudflare_cdn_origin"
+      SEARCH_ENGINE_CRAWLER = "search_engine_crawler"
+    end
+
+    module CpePart
+      APPLICATION = "application"
+      OPERATING_SYSTEM = "operating_system"
+      HARDWARE = "hardware"
+    end
+
+    module ErrorCode
+      INVALID_REQUEST = 1000
+      INVALID_PAYLOAD = 1001
+      INVALID_IP = 1002
+      IP_NOT_FOUND = 1003
+      ROUTE_NOT_FOUND = 1004
+      INVALID_API_KEY = 1010
+      RATE_LIMIT_EXCEEDED = 1011
+      SERVICE_UNAVAILABLE = 1400
+      INTERNAL_ERROR = 1401
+      INSUFFICIENT_BALANCE = 1500
+      IDEMPOTENCY_KEY_CONFLICT = 1501
+    end
+
+    module LiveIntelligenceTag
+      HOSTING = "hosting"
+      PUBLIC_DNS_RESOLVER = "public_dns_resolver"
+      WEB_SERVER = "web_server"
+      VPN = "vpn"
+      RESIDENTIAL_PROXY = "residential_proxy"
+    end
+
+    module NetworkClass
+      MOBILE = "mobile"
+      HOSTING = "hosting"
+      RESIDENTIAL = "residential"
+      BUSINESS = "business"
+      ORGANIZATION = "organization"
+      GOVERNMENT = "government"
+      MILITARY = "military"
+      EDUCATION = "education"
+      LIBRARY = "library"
+      DEDICATED = "dedicated"
+      SATELLITE = "satellite"
+      IXP = "ixp"
+      SEARCH_ENGINE = "search_engine"
+      AI_CRAWLER = "ai_crawler"
+      UNKNOWN = "unknown"
+    end
+
+    module NetworkClassSource
+      DOMESTIC_ISP = "domestic_isp"
+      USAGE_TYPE = "usage_type"
+      MOBILE_CARRIER = "mobile_carrier"
+      CONNECTION_TYPE = "connection_type"
+      NETWORK_TAG = "network_tag"
+      THREAT_INTELLIGENCE = "threat_intelligence"
+      ASN_TAG = "asn_tag"
+      IXP = "ixp"
+      NONE = "none"
+    end
+
+    module Product
+      GEOIP = "geoip"
+      INTELLIGENCE = "intelligence"
+    end
+
+    module PtrConfidenceLevel
+      HIGH = "high"
+      MEDIUM = "medium"
+      LOW = "low"
+    end
+
+    module PtrDatasetName
+      GEONAMES = "geonames"
+      OURAIRPORTS = "ourairports"
+      OPERATOR_OVERRIDES = "operator-overrides"
+      UNLOCODE = "unlocode"
+    end
+
+    module PtrHintKind
+      IATA = "iata"
+      UNLOCODE = "unlocode"
+      CLLI = "clli"
+      CITY_NAME = "city_name"
+      OPERATOR_CODE = "operator_code"
+    end
+
+    module RevokedNetworkTag
+      BUSINESS_BROADBAND = "business_broadband"
+      HOME_ISP = "home_isp"
+      MOBILE_ISP = "mobile_isp"
+    end
+
+    module RpkiSource
+      RTR_LIVE = "RTR Live"
+      LOCAL_CACHE = "Local Cache"
+      LOCAL_DB = "Local DB"
+    end
+
+    module RpkiStatus
+      VALID = "valid"
+      INVALID_ASN = "invalid_asn"
+      INVALID_LENGTH = "invalid_length"
+      UNKNOWN = "unknown"
+      NOT_ROUTED = "not_routed"
+    end
+
+    AbuseCategoryCount = Internal::Schema.define do
+      required :id, :integer
+      required :count, :integer
+    end
+
+    AbuseContact = Internal::Schema.define do
+      required :name, :string, null: true
+      required :address, :string, null: true
+      required :country, :string, null: true
+      required :email, :string, null: true
+      required :network, :string, null: true
+      required :phone, :string, null: true
+      optional :source, :string
+    end
+
+    AbuseReports = Internal::Schema.define do
+      required :confidence_score, :integer
+      required :total_reports, :integer
+      required :distinct_reporters, :integer
+      required :last_reported_at, :string, null: true
+      required :is_whitelisted, :boolean, null: true
+      required :categories, [AbuseCategoryCount]
+    end
+
+    Wallet = Internal::Schema.define do
+      required :product, :string
+      required :balance_micros, :float, key: "balanceMicros"
+    end
+
+    LedgerEntry = Internal::Schema.define do
+      required :id, :string
+      required :product, :string
+      required :kind, :string
+      required :amount_micros, :float, key: "amountMicros"
+      required :balance_micros, :float, key: "balanceMicros"
+      required :reference, :string
+      required :created_at, :string, key: "createdAt"
+    end
+
+    Account = Internal::Schema.define do
+      required :id, :string
+      required :name, :string
+      required :key_prefix, :string, key: "keyPrefix"
+      required :wallets, [Wallet]
+      required :entries, [LedgerEntry]
+    end
+
+    AccountResponse = Internal::Schema.define do
+      required :status, :boolean
+      required :data, Account
+    end
+
+    ApiError = Internal::Schema.define do
+      required :code, :integer
+      required :message, :string
+      required :request_id, :string
+      required :retryable, :boolean
+    end
+
+    ErrorResponse = Internal::Schema.define do
+      required :status, :boolean
+      required :data, :null
+      required :error, ApiError
+    end
+
+    AsnEstimatedCapacity = Internal::Schema.define do
+      required :lower_gbps, :float
+      optional :upper_gbps, :float
+      required :label, :string
+    end
+
+    AsnExchangePort = Internal::Schema.define do
+      required :capacity_gbps, :float
+      optional :operational, :boolean
+      optional :rs_peer, :boolean
+    end
+
+    AsnExchange = Internal::Schema.define do
+      required :name, :string
+      optional :country_code, :string, key: "countryCode"
+      required :type, :string
+      required :ports, [AsnExchangePort]
+    end
+
+    AsnConnectivity = Internal::Schema.define do
+      required :declared_traffic, :string
+      optional :exchanges_total, :integer
+      required :estimated_capacity, AsnEstimatedCapacity
+      required :exchanges, [AsnExchange]
+    end
+
+    Blocklist = Internal::Schema.define do
+      required :name, :string
+      required :site, :string
+      required :type, :string
+    end
+
+    Price = Internal::Schema.define do
+      required :product, :string
+      required :name, :string
+      required :unit_micros, :float, key: "unitMicros"
+    end
+
+    Catalog = Internal::Schema.define do
+      required :currency, :string
+      required :prices, [Price]
+      required :purchase_email, :string, key: "purchaseEmail"
+      required :available, :boolean
+    end
+
+    CatalogResponse = Internal::Schema.define do
+      required :status, :boolean
+      required :data, Catalog
+    end
+
+    Company = Internal::Schema.define do
+      required :name, :string, null: true
+      required :address, :string, null: true
+      required :domain, :string, null: true
+      required :phone, :string, null: true
+      required :type, :string, null: true
+      required :network, :string, null: true
+      required :country, :string, null: true
+      optional :source, :string
+    end
+
+    CpeObservation = Internal::Schema.define do
+      required :cpe, :string
+      required :part, :string
+      required :vendor, :string
+      required :product, :string
+      required :version, :string, null: true
+    end
+
+    Currency = Internal::Schema.define do
+      required :name, :string
+      required :code, :string
+      required :symbol, :string
+      required :native, :string
+      required :plural, :string
+    end
+
+    DnsHostnameEvidence = Internal::Schema.define do
+      required :hostname, :string
+      required :kinds, [:string]
+      required :sources, [:string]
+      required :forward_confirmed, :boolean
+      required :first_seen, :string, null: true
+      required :last_seen, :string, null: true
+    end
+
+    DnsPtrEvidence = Internal::Schema.define do
+      required :hostname, :string
+      required :sources, [:string]
+      required :forward_confirmed, :boolean
+      required :first_seen, :string, null: true
+      required :last_seen, :string, null: true
+    end
+
+    DnsRecords = Internal::Schema.define do
+      required :ptr, [:string]
+      required :ptr_evidence, [DnsPtrEvidence]
+      required :hostnames, [DnsHostnameEvidence]
+      required :sources, [:string]
+      required :snapshot_id, :string, null: true
+      required :updated_at, :string, null: true
+    end
+
+    GeoIpAs = Internal::Schema.define do
+      required :asn, :string
+      required :name, :string
+      optional :name_en, :string
+      optional :country_code, :string, key: "countryCode"
+      required :domain, :string
+    end
+
+    Geolocation = Internal::Schema.define do
+      required :city, :string
+      required :region, :string
+      required :district, :string
+      required :region_code, :string
+      required :adcode, :string
+      required :country, :string
+      required :country_code, :string
+      required :continent, :string
+      required :continent_code, :string
+      required :latitude, :float, null: true
+      required :longitude, :float, null: true
+      required :timezone, :string
+      required :postal_code, :string
+      required :radius, :float, null: true
+      optional :area_code, :string
+      optional :plus_code, :string
+      optional :country_en, :string
+      optional :country_zh, :string
+      optional :region_en, :string
+      optional :region_zh, :string
+      optional :city_en, :string
+      optional :city_zh, :string
+      optional :district_en, :string
+      optional :district_zh, :string
+    end
+
+    TimeZone = Internal::Schema.define do
+      required :name, :string
+      required :abbr, :string
+      required :offset, :string
+      required :is_dst, :boolean
+      required :current_time, :string
+    end
+
+    GeoIpData = Internal::Schema.define do
+      required :as, GeoIpAs
+      required :ip, :string
+      required :geo, Geolocation
+      required :netmask, :string
+      required :prefix_length, :integer, null: true
+      required :is_bogon, :boolean
+      optional :currency, Currency
+      optional :time_zone, TimeZone
+      optional :calling_code, :string
+    end
+
+    GeoIpResponse = Internal::Schema.define do
+      required :status, :boolean
+      required :data, GeoIpData
+    end
+
+    IntelligenceAs = Internal::Schema.define do
+      required :asn, :string
+      required :name, :string
+      optional :name_en, :string
+      optional :country_code, :string, key: "countryCode"
+      required :domain, :string
+      required :type, :string
+      optional :as_class, :string, key: "class"
+      optional :tags, [:string]
+      optional :connectivity, AsnConnectivity
+    end
+
+    MobileCarrier = Internal::Schema.define do
+      required :mcc, :string
+      required :mnc, :string
+      required :brand, :string
+    end
+
+    NetworkClassEvidence = Internal::Schema.define do
+      required :network_class, :string, key: "class"
+      required :source, :string
+      required :scope, :string
+      required :value, :string
+    end
+
+    NetworkClassification = Internal::Schema.define do
+      required :primary, :string
+      required :confidence, :string
+      required :source, :string
+      required :conflicts, [:string]
+      required :evidence, [NetworkClassEvidence]
+    end
+
+    NetworkInfo = Internal::Schema.define do
+      required :connection_type, :string
+      required :usage_type, :string
+      optional :address_type, :string
+      required :net_speed, :string
+      required :tags, [:string]
+    end
+
+    PtrOperator = Internal::Schema.define do
+      required :name, :string
+      required :asn, :string
+      required :suffix, :string
+    end
+
+    PtrHint = Internal::Schema.define do
+      required :value, :string
+      required :kind, :string
+    end
+
+    PtrMetroLocation = Internal::Schema.define do
+      required :city, :string
+      required :region, :string, null: true
+      required :region_code, :string, null: true
+      required :country, :string
+      required :country_code, :string
+      required :latitude, :float
+      required :longitude, :float
+      required :precision, :string
+    end
+
+    PtrConfidence = Internal::Schema.define do
+      required :level, :string
+      required :score, :float
+    end
+
+    PtrEvidenceSource = Internal::Schema.define do
+      required :dataset, :string
+      required :version, :string
+    end
+
+    PtrEvidence = Internal::Schema.define do
+      required :rule_id, :string
+      required :ruleset_version, :string
+      required :sources, [PtrEvidenceSource]
+    end
+
+    module PtrIntelligence; end
+
+    PtrLocatedIntelligence = Internal::Schema.define(PtrIntelligence) do
+      required :hostname, :string
+      required :status, :string
+      required :operator, PtrOperator
+      required :hint, PtrHint
+      required :location, PtrMetroLocation
+      required :confidence, PtrConfidence
+      required :evidence, PtrEvidence
+    end
+
+    PtrAsnMismatchIntelligence = Internal::Schema.define(PtrIntelligence) do
+      required :hostname, :string
+      required :status, :string
+      required :operator, PtrOperator
+      required :observed_asn, :string
+      required :evidence, PtrEvidence
+    end
+
+    PtrUnmatchedIntelligence = Internal::Schema.define(PtrIntelligence) do
+      required :hostname, :string
+      required :status, :string
+    end
+
+    PtrOtherIntelligence = Internal::Schema.define(PtrIntelligence) do
+      required :hostname, :string
+      required :status, :string
+    end
+
+    Internal::Schema.union(
+      PtrIntelligence,
+      tag: "status",
+      variants: {
+        "located" => PtrLocatedIntelligence,
+        "asn_mismatch" => PtrAsnMismatchIntelligence,
+        "unmatched" => PtrUnmatchedIntelligence
+      },
+      fallback: PtrOtherIntelligence
+    )
+
+    ResourceTransfer = Internal::Schema.define do
+      required :transfer_time, :string
+      required :transfer_type, :string
+      required :source_resource, :string
+      required :recipient_resource, :string
+      required :source_registry, :string
+      required :recipient_registry, :string
+      required :source_holder, :string
+      required :recipient_holder, :string
+    end
+
+    RpkiRtr = Internal::Schema.define do
+      required :source, :string
+      optional :server, :string
+      required :last_updated, :integer, key: "lastUpdated"
+    end
+
+    RpkiValidator = Internal::Schema.define do
+      required :source, :string
+      required :engine, :string
+      required :last_updated, :integer, key: "lastUpdated"
+    end
+
+    RpkiInfo = Internal::Schema.define do
+      required :status, :string
+      optional :source, :string
+      optional :route_source, :string
+      optional :origin_asn, :string
+      optional :route_prefix, :string
+      optional :roa_prefix, :string
+      optional :roa_asn, :string
+      optional :max_length, :integer
+      optional :ta, :string
+      optional :rtr, RpkiRtr
+      optional :validator, RpkiValidator
+    end
+
+    SegmentProbe = Internal::Schema.define do
+      required :ip, :string
+      required :ports, [:integer]
+      required :tags, [:string]
+    end
+
+    LiveIntelligence = Internal::Schema.define do
+      required :ptr, [PtrIntelligence]
+      required :nameservers, [:string]
+      required :cpes, [CpeObservation]
+      required :tags, [:string]
+      required :revoked_tags, [:string]
+      required :usage_type, :string, null: true
+      optional :rpki, RpkiInfo
+      optional :abuse, AbuseReports
+      optional :transfers, [ResourceTransfer]
+      optional :segment_probe, SegmentProbe
+    end
+
+    ThreatScores = Internal::Schema.define do
+      required :vpn_score, :float, null: true
+      required :proxy_score, :float, null: true
+      required :threat_score, :float, null: true
+      required :trust_score, :float, null: true
+    end
+
+    ThreatInfo = Internal::Schema.define do
+      required :is_tor, :boolean, null: true
+      required :is_vpn, :boolean, null: true
+      required :is_icloud_relay, :boolean, null: true
+      required :is_cloudflare_warp, :boolean, null: true
+      required :is_proxy, :boolean, null: true
+      required :is_datacenter, :boolean, null: true
+      required :is_anonymous, :boolean, null: true
+      required :is_known_attacker, :boolean, null: true
+      required :is_known_abuser, :boolean, null: true
+      required :is_threat, :boolean, null: true
+      required :is_bogon, :boolean
+      required :blocklists, [Blocklist]
+      required :blocklist_count, :integer
+      required :scores, ThreatScores
+      optional :anonymizer_exemptions, [:string]
+    end
+
+    IntelligenceData = Internal::Schema.define do
+      required :as, IntelligenceAs
+      required :intelligence, LiveIntelligence
+      required :ip, :string
+      optional :network, NetworkInfo
+      required :network_class, NetworkClassification
+      optional :mobile, MobileCarrier
+      optional :threat, ThreatInfo
+      optional :rpki, RpkiInfo
+      optional :company, Company
+      optional :abuse, AbuseContact
+      optional :dns, DnsRecords
+      required :is_bogon, :boolean
+      required :is_anycast, :boolean, null: true
+      required :is_mobile, :boolean, null: true
+      required :is_hosting, :boolean, null: true
+      required :is_satellite, :boolean, null: true
+    end
+
+    IntelligenceResponse = Internal::Schema.define do
+      required :status, :boolean
+      required :data, IntelligenceData
+    end
+
+    LookupRequest = Internal::Schema.define do
+      required :ip, :string
+    end
+  end
+end

data/lib/ipmax/version.rb

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

data/lib/ipmax.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "ipmax/version"
+require_relative "ipmax/errors"
+require_relative "ipmax/internal/schema"
+require_relative "ipmax/internal/lru_cache"
+require_relative "ipmax/models"
+require_relative "ipmax/client"
+
+module IPMax
+  private_constant :Internal
+end