Improve docs, rearrage file contents.

README.md

@@ -1,28 +1,12 @@
 # internet :) [![Build Status](https://drone.io/github.com/thomasf/internet/status.png)](https://drone.io/github.com/thomasf/internet/latest)
 
+## Introduction
+
 This package contains a server and client for historical searches in bgp dumps.
 I'm not sure where this is going so for the moment this package is named
 internet to postpone the definition.
 
-## Features
-
-* Downloads BGP table dumps from http://data.ris.ripe.net/rrc00 and imports
-  them into redis for current and historical IP address to AS Number lookup.
-* Downloads http://www.cidr-report.org/as2.0/autnums.html (controlled to once
-  per day) and stores the entries in redis for current and historical AS Number
-  to AS Description lookup.
-* Caches all data downloads so that databases can be rebuilt easily.
-
-
-## Pre requirements
-
-* BGPDump - [Download](http://www.ris.ripe.net/source/bgpdump/), compile and
-  install it somewhere into PATH.
-* Redis
-
+## Documentation
 
-## Acknowledgments
+* http://godoc.org/github.com/thomasf/internet
 
-Basic design for the IP2ASN history and ASN2ASDescription parts were inspired
-from https://github.com/CIRCL/IP-ASN-history and
-https://github.com/CIRCL/ASN-Description-History .

asn2asd.go

@@ -6,11 +6,8 @@ import (
 	"github.com/garyburd/redigo/redis"
 )
 
-type ASN2ASDescClient struct {
-	conn redis.Conn
-}
-
-//NewASN2ASDescClient .
+//NewASN2ASDescClient returns a new client for quering the. The caller is
+//reposible for closing the conn when the client is not used anymore.
 func NewASN2ASDescClient(conn redis.Conn) *ASN2ASDescClient {
 	asnasd := ASN2ASDescClient{
 		conn: conn,
@@ -18,6 +15,11 @@ func NewASN2ASDescClient(conn redis.Conn) *ASN2ASDescClient {
 	return &asnasd
 }
 
+//ASN2ASDescClient is the query client.
+type ASN2ASDescClient struct {
+	conn redis.Conn
+}
+
 // importedDates fetches all imported dates from redis
 func (i *ASN2ASDescClient) importedDates() ([]string, error) {
 	return redis.Strings(i.conn.Do("SMEMBERS", "asd:imported_dates"))

cidrreport.go

@@ -16,14 +16,16 @@ import (
 	"golang.org/x/net/html"
 )
 
+// ASDescription contains the parsed result of an row inside a autnums.html file.
 type ASDescription struct {
-	ASN         int
-	Description string
-	CountryCode string
+	ASN         int    // AS Number
+	Description string // AS Description
+	CountryCode string // Country code (split from the as description field)
 }
 
+// CIDRReport encapuslates downloading and importing of autnums.html files.
 type CIDRReport struct {
-	Date time.Time
+	Date time.Time // Timestamp
 }
 
 // Path returns the absolute path to the target archive dump download file.

internet.go

@@ -1,8 +1,37 @@
-// Package internet gives access to information about internet by
-// downloading/parsing/putting ripe BGP dumps and cidr-report.org data into
-// redis databases. Redis query clients are also supplied.
-//
-// This is a work in progress, the API's are unstable.
+/*
+
+Package internet produces queryable information about the internet by
+fetching and downloading ripe BGP dumps and cidr-report.org data into redis
+databases.
+
+Features
+
+Download BGP table dumps from http://data.ris.ripe.net/rrc00. Entries are
+stored into redis for current and historical IP address to AS Number lookup.
+
+Download http://www.cidr-report.org/as2.0/autnums.html (controlled to once per
+day). Entries are stored in redis for current and historical AS Number to AS
+Description lookup.
+
+All downloads are cached so that databases can be rebuilt easily.
+
+Golang redis query clients are also also included.
+
+Pre requirements
+
+BGPDump: http://www.ris.ripe.net/source/bgpdump/. Download, compile and install
+it somewhere into PATH.
+
+A Redis server.
+
+
+Acknowledgments
+
+Basic design for the IP2ASN history and ASN2ASDescription parts were inspired
+from https://github.com/CIRCL/IP-ASN-history and
+https://github.com/CIRCL/ASN-Description-History.
+
+*/
 package internet
 
 import (

ip2asn.go

@@ -9,32 +9,9 @@ import (
 	"github.com/garyburd/redigo/redis"
 )
 
-// IP2ASNClient .
-type IP2ASNClient struct {
-	conn redis.Conn
-}
-
-func (i *IP2ASNClient) parseIP(IP string) (net.IP, error) {
-	I := net.ParseIP(IP)
-	if I == nil {
-		return nil, net.InvalidAddrError(IP)
-	}
-	return I, nil
-}
-
-func (i *IP2ASNClient) keys(IP net.IP) []net.IPNet {
-	var keys []net.IPNet
-	for _, n := range netmasks {
-		ipn := net.IPNet{
-			IP:   IP.Mask(n),
-			Mask: n,
-		}
-		keys = append(keys, ipn)
-	}
-	return keys
-}
-
-// NewIP2ASNClient .
+// NewIP2ASNClient returns a new client for IP address to AS Number queries.
+// The caller is reposible for closing the conn when the client is not used
+// anymore.
 func NewIP2ASNClient(conn redis.Conn) *IP2ASNClient {
 	ipasn := &IP2ASNClient{
 		conn: conn,
@@ -42,6 +19,18 @@ func NewIP2ASNClient(conn redis.Conn) *IP2ASNClient {
 	return ipasn
 }
 
+// ASNResult contains the lookup results from resolving an IP address to a ASN.
+type ASNResult struct {
+	Mask net.IPNet
+	ASN  int
+	Date time.Time // Recorded time for when
+}
+
+// IP2ASNClient is the query client.
+type IP2ASNClient struct {
+	conn redis.Conn
+}
+
 // Current returns the latest known result for an IP2ASN lookup.
 func (i *IP2ASNClient) Current(IP string) *ASNResult {
 	ip, err := i.parseIP(IP)
@@ -80,11 +69,24 @@ func (i *IP2ASNClient) AllHistory(IP string) []ASNResult {
 	return result
 }
 
-// ASNResult contains the lookup results from resolving an IP address to a ASN.
-type ASNResult struct {
-	Mask net.IPNet
-	ASN  int
-	Date time.Time // Recorded time for when
+func (i *IP2ASNClient) parseIP(IP string) (net.IP, error) {
+	I := net.ParseIP(IP)
+	if I == nil {
+		return nil, net.InvalidAddrError(IP)
+	}
+	return I, nil
+}
+
+func (i *IP2ASNClient) keys(IP net.IP) []net.IPNet {
+	var keys []net.IPNet
+	for _, n := range netmasks {
+		ipn := net.IPNet{
+			IP:   IP.Mask(n),
+			Mask: n,
+		}
+		keys = append(keys, ipn)
+	}
+	return keys
 }
 
 // Stringer.