iptoasn 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9becad4d91cd66d645e228fb998106ed1832b1d70eb633107106621be50262e
-  data.tar.gz: 560094583c0b251f3dff6e5c24fb1220df7475c461d3a996a7c854a6dea32afc
+  metadata.gz: e7d28863be637ca0ad4c3b7b7ac648828fb963f3fed53bc237e695c83876737f
+  data.tar.gz: ac59b82846fcacd8e5d584ca7d10804dfe9097cd43d889bd53339c503686c011
 SHA512:
-  metadata.gz: af385e1b8401f25a6b3ee8259496d9beaa3a5a8513c0d3ee5d5a135575fae1b4b69c18367254ffdddff03b271d79549f6531b539ad9f57086a0442b04d923825
-  data.tar.gz: 7264f892662f1fb6b63d709bb6bf7ffa57ea10cfbe38fd268b0460f9d916d8658463a51d0e7acf93e7a5451bf6f14136a7676649e2733ddc6f3e958f9611d1aa
+  metadata.gz: 5bfdd00ff5e6d10bea42810af1861de3bcaf0eafebf933788ccac9b0056a5974bc9e457bd5cc3077b6b4d0952f9a46ed758512891beaa59c7fcec977a42f2ca1
+  data.tar.gz: b0f0ad77ee6e089c3dfa0143523f8829ddf5fe25d3c38063fc383038a9a1350c8de00847925e3cff7a2c2c9439e797f93ac021bbb67f1904d10f5c62dbd1f7d7

data/README.md

@@ -0,0 +1,73 @@
+# iptoasn
+
+`iptoasn` is a Ruby gem that provides a simple way to query Autonomous System (AS) information for a given IP address using the [iptoasn.com](https://iptoasn.com) dataset. This gem directly contains the iptoasn dataset broken up into chunks; at build time an index is created so individual chunks can be lazy loaded.
+
+## Features
+
+- Query AS information by IP address.
+- Efficient lazy loading to minimize memory usage.
+- Compatible with IPv4 addresses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iptoasn'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install iptoasn
+```
+
+## Usage
+
+Here is a basic example of how to use the `iptoasn` gem:
+
+```ruby
+require 'iptoasn'
+
+finder = IpToAsn.new
+ip_address = ARGV[0]
+
+response = finder.lookup(ip_address)
+if response.nil?
+  puts "Couldn't locate #{ip_address}!"
+  exit 1
+end
+
+puts "#{ip_address} is in #{response[:country_code]} and belongs to #{response[:as_name]}"
+```
+
+## Building
+
+```shell
+$ make fetch   # grab the latest copy of the dataset
+$ make process # break it up into chunks
+$ make index   # build indexes
+$ make clean   # clean up
+```
+
+## Dataset
+
+The gem wraps the [iptoasn.com](https://iptoasn.com) dataset, which contains information about:
+- IP address ranges (start and end IPs)
+- Autonomous System Numbers (ASNs)
+- Country codes
+- Autonomous System names
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgments
+
+This gem utilizes the [iptoasn.com](https://iptoasn.com) dataset. Special thanks to them for providing this valuable resource.

data/lib/iptoasn.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'main'

data/lib/main.rb

@@ -1,14 +1,31 @@
+# frozen_string_literal: true
+
 require 'ipaddr'
-require_relative 'index.rb'
+require_relative 'index'
 
 class IpToAsn
   def initialize
     @index = chunk_index
     @cache = {}
-    @chunk_dir = "./chunks"
+    @chunk_dir = './chunks'
+    @reserved_ranges = {
+      IPAddr.new('10.0.0.0/8') => 'RFC1918 Private',
+      IPAddr.new('172.16.0.0/12') => 'RFC1918 Private',
+      IPAddr.new('192.168.0.0/16') => 'RFC1918 Private',
+      IPAddr.new('0.0.0.0/8') => 'Current Network',
+      IPAddr.new('127.0.0.0/8') => 'Loopback',
+      IPAddr.new('169.254.0.0/16') => 'Link Local'
+    }
   end
 
-  def lookup(ip_str)
+  def lookup(ip_str) # rubocop:disable Metrics/AbcSize
+    reserved_range_name = find_range(
+      ranges: @reserved_ranges,
+      ip_address: ip_str
+    )
+
+    return { as_number: 0, country_code: 'XX', as_name: reserved_range_name } unless reserved_range_name.nil?
+
     chunk_name = binary_search(@index, ip_str).first
     return nil if chunk_name.nil?
 
@@ -18,11 +35,19 @@ class IpToAsn
     end
 
     result = binary_search(@cache[chunk_name], ip_str)
-    nil if result.empty?
+    return nil if result.empty?
 
     { as_number: result[0], country_code: result[1], as_name: result[2] }
   end
 
+  private
+
+  def find_range(ranges:, ip_address:)
+    ranges.filter_map do |k, v|
+      v if k.include? ip_address
+    end.first
+  end
+
   def binary_search(ranges, ip_str)
     ip_int = IPAddr.new(ip_str).to_i
     low = 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iptoasn
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - OMAR
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-28 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies: []
 description: This gem wraps the IP to ASN dataset. It uses lazy loading so it doesn't
   load the entire ~25M dataset all at once.
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/chunks/chunk_aa.rb
 - lib/chunks/chunk_ab.rb
 - lib/chunks/chunk_ac.rb
@@ -42,6 +43,7 @@ files:
 - lib/chunks/chunk_aw.rb
 - lib/chunks/chunk_ax.rb
 - lib/index.rb
+- lib/iptoasn.rb
 - lib/main.rb
 homepage: https://github.com/ancat/iptoasn
 licenses: