Do not have a public Go API

Author: oschwald

CHANGELOG.md

@@ -12,12 +12,12 @@
   `network`, and `record`. This allows for efficient streaming of large
   lookups, makes the key naming more consistent, and reduces the depth of
   the data structure.
-* Upgrade to `github.com/oschwald/maxminddb-golang/v2`. This is a breaking
-  API change, but should not affect the use of the program.
 * You may now use a glob for the `-db` argument. If there are multiple
   matches, it will be treated as if multiple `-db` arguments were provided.
   Note that you must quote the parameter when using globs to prevent the
   shell's globbing from interfering. See the [pattern syntax](https://pkg.go.dev/path#Match)
+* This repo no longer provides a public Go API. It is only intended to be
+  used as a CLI program.
 
 ## 0.2.0 (2024-01-10)
 

cmd/mmdbinspect/main.go

@@ -11,8 +11,6 @@ import (
 	"strings"
 
 	"github.com/goccy/go-yaml"
-
-	"github.com/maxmind/mmdbinspect/v2/pkg/mmdbinspect"
 )
 
 type arrayFlags []string
@@ -67,7 +65,7 @@ func main() {
 		encoder = yaml.NewEncoder(w)
 	}
 
-	iterator := mmdbinspect.Records(network, mmdb, *includeAliasedNetworks)
+	iterator := records(network, mmdb, *includeAliasedNetworks)
 
 	for r, err := range iterator {
 		if err != nil {

pkg/mmdbinspect/mmdbinspect.go cmd/mmdbinspect/mmdbinspect.gopkg/mmdbinspect/mmdbinspect.go renamed to cmd/mmdbinspect/mmdbinspect.go

@@ -1,5 +1,4 @@
-// Package mmdbinspect peeks at the contents of .mmdb files
-package mmdbinspect
+package main
 
 import (
 	"errors"
@@ -14,21 +13,21 @@ import (
 	"github.com/oschwald/maxminddb-golang/v2"
 )
 
-// Record holds the records for a lookup in a database.
-type Record struct {
+// record holds the records for a lookup in a database.
+type record struct {
 	DatabasePath    string       `json:"database_path"`
 	RequestedLookup string       `json:"requested_lookup"`
 	Network         netip.Prefix `json:"network"`
 	Record          any          `json:"record"`
 }
 
-// Records returns an iterator over the records for the networks and
+// records returns an iterator over the records for the networks and
 // databases provided.
-func Records(
+func records(
 	networks, databases []string,
 	includeAliasedNetworks bool,
-) iter.Seq2[*Record, error] {
-	return func(yield func(*Record, error) bool) {
+) iter.Seq2[*record, error] {
+	return func(yield func(*record, error) bool) {
 		for _, glob := range databases {
 			matches, err := filepath.Glob(glob)
 			if err != nil {
@@ -43,7 +42,7 @@ func Records(
 				}
 
 				for _, thisNetwork := range networks {
-					baseRecord := Record{
+					baseRecord := record{
 						DatabasePath:    path,
 						RequestedLookup: thisNetwork,
 					}
@@ -64,8 +63,8 @@ func Records(
 func recordsForNetwork(
 	reader *maxminddb.Reader,
 	includeAliasedNetworks bool,
-	record Record,
-	yield func(*Record, error) bool,
+	record record,
+	yield func(*record, error) bool,
 ) bool {
 	var err error
 	var network netip.Prefix

pkg/mmdbinspect/mmdbinspect_test.go cmd/mmdbinspect/mmdbinspect_test.gopkg/mmdbinspect/mmdbinspect_test.go renamed to cmd/mmdbinspect/mmdbinspect_test.go

@@ -1,4 +1,4 @@
-package mmdbinspect
+package main
 
 import (
 	"net/netip"
@@ -139,19 +139,19 @@ var country81_2_69_142 = map[string]any{
 	},
 }
 
-func TestAggregatedRecords(t *testing.T) {
+func TestRecords(t *testing.T) {
 	tests := []struct {
 		name          string
 		dbs           []string
 		networks      []string
-		expectRecords []Record
+		expectRecords []record
 		expectErr     string
 	}{
 		{
 			name:     "multiple non-glob paths and multiple IPs",
 			dbs:      []string{CityDBPath, CountryDBPath},
 			networks: []string{"81.2.69.142", "8.8.8.8"},
-			expectRecords: []Record{
+			expectRecords: []record{
 				{
 					DatabasePath:    CityDBPath,
 					RequestedLookup: "81.2.69.142",
@@ -170,7 +170,7 @@ func TestAggregatedRecords(t *testing.T) {
 			name:     "glob path",
 			dbs:      []string{filepath.Join(testDataDir, "GeoIP2-C*y-Test.mmdb")},
 			networks: []string{"81.2.69.142"},
-			expectRecords: []Record{
+			expectRecords: []record{
 				{
 					DatabasePath:    CityDBPath,
 					RequestedLookup: "81.2.69.142",
@@ -212,8 +212,8 @@ func TestAggregatedRecords(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			var records []Record
-			for record, err := range Records(test.networks, test.dbs, false) {
+			var recs []record
+			for record, err := range records(test.networks, test.dbs, false) {
 				// For now, we don't test errors that happen half way through an
 				// iteration. If we want to in the future, we will need to rework
 				// this a bit.
@@ -224,11 +224,11 @@ func TestAggregatedRecords(t *testing.T) {
 				}
 
 				if err == nil {
-					records = append(records, *record)
+					recs = append(recs, *record)
 				}
 			}
 
-			assert.Equal(t, test.expectRecords, records)
+			assert.Equal(t, test.expectRecords, recs)
 		})
 	}
 }