feat: separate cidrlist SDK & CLI, and update the README accordingly (#2)

Author: novalagung

README.md

@@ -2,29 +2,61 @@
 
 Simple cli to get CIDR list from well known providers
 
-## List IPs from following providers:
+## Available Providers
 
-- akamai (origin IP acl)
-- aws
-- cloudflare
-- gcp
-- google
+| Provider name | Constant name | Source of IP addresses |
+| :- | :- | :- |
+| `akamai` | `cidrlist.ProviderAkamai` | [Akamai Origin IP ACL](https://techdocs.akamai.com/origin-ip-acl/docs/welcome) |
+| `aws` | `cidrlist.ProviderAWS` | [AWS IP Address Ranges](https://docs.aws.amazon.com/vpc/latest/userguide/aws-ip-ranges.html) |
+| `cloudflare` | `cidrlist.ProviderCloudflare` | [Cloudflare IP Ranges](https://www.cloudflare.com/ips/) |
+| `gcp` | `cidrlist.ProviderGCP` | [Google Cloud Global & Regional IP Address Ranges](https://support.google.com/a/answer/10026322?hl=en) |
+| `google` | `cidrlist.ProviderGoogle` | [Google IP Address Ranges](https://support.google.com/a/answer/10026322?hl=en) |
 
 ## Usage
 
-```bash
-usage: cidrlist <command> [<args> ...]
+Install the library using the following command:
 
-A command-line tool to fetch IP address ranges from well known providers.
+```go
+go get -u github.com/franzramadhan/cidrlist
+```
+
+Implementation example:
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"github.com/franzramadhan/cidrlist"
+)
 
+func main() {
+	ips, err := cidrlist.Get(cidrlist.ProviderAWS)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
 
-Flags:
-  --[no-]help  Show context-sensitive help (also try --help-long and --help-man).
+	fmt.Printf("IP of provider %s:\n", cidrlist.ProviderAWS)
+	for _, ip := range ips {
+		fmt.Println(ip)
+	}
+}
+```
+
+## CLI Usage
+
+Install cidrlist CLI using the following command:
+
+```go
+go install github.com/franzramadhan/cidrlist/cmd/cidrlist@latest
+```
 
-Commands:
-help [<command>...]
-    Show help.
+Usage:
 
-get <provider>
-    Get IP from provider (cloudflare, akamai, aws, gcp, and google).
+```go
+cidrlist get <provider-name>
+cidrlist get cloudflare
+cidrlist get gcp
 ```

cidrlist.go

@@ -0,0 +1,43 @@
+package cidrlist
+
+import (
+	"fmt"
+
+	"github.com/franzramadhan/cidrlist/providers"
+)
+
+type Provider string
+
+const (
+	ProviderAkamai     Provider = "akamai"
+	ProviderAWS        Provider = "aws"
+	ProviderCloudflare Provider = "cloudflare"
+	ProviderGCP        Provider = "gcp"
+	ProviderGoogle     Provider = "google"
+)
+
+func GetProviderNames() []string {
+	return []string{
+		string(ProviderAkamai),
+		string(ProviderAWS),
+		string(ProviderCloudflare),
+		string(ProviderGCP),
+		string(ProviderGoogle),
+	}
+}
+
+func Get(provider Provider) ([]string, error) {
+	fnByProviders := map[Provider]func() ([]string, error){
+		ProviderAkamai:     providers.AkamaiIps,
+		ProviderAWS:        new(providers.AwsInputs).AwsIps,
+		ProviderCloudflare: providers.CloudflareIps,
+		ProviderGCP:        providers.GcpIps,
+		ProviderGoogle:     providers.GoogleIps,
+	}
+
+	if fn, ok := fnByProviders[provider]; ok {
+		return fn()
+	}
+
+	return nil, fmt.Errorf("invalid provider %s", provider)
+}

cmd/cidrlist/main.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/alecthomas/kingpin/v2"
+	"github.com/franzramadhan/cidrlist"
+)
+
+var (
+	app          = kingpin.New("cidrlist", "A command-line tool to fetch IP address ranges from well known providers.")
+	getIp        = app.Command("get", fmt.Sprintf("Get IP from provider (%s).", strings.Join(cidrlist.GetProviderNames(), ", ")))
+	providerName = getIp.Arg("provider", "The name of the provider.").Required().String()
+)
+
+func main() {
+	switch kingpin.MustParse(app.Parse(os.Args[1:])) {
+	case getIp.FullCommand():
+		target := strings.ToLower(*providerName)
+		provider := cidrlist.Provider(target)
+		ips, err := cidrlist.Get(provider)
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+		fmt.Printf("%s:\n%s", strings.ToUpper(target), ips)
+	}
+}

go.mod

@@ -5,6 +5,6 @@ go 1.21.4
 require github.com/alecthomas/kingpin/v2 v2.4.0
 
 require (
-	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 // indirect
+	github.com/alecthomas/units v0.0.0-20231202071711-9a357b53e9c9 // indirect
 	github.com/xhit/go-str2duration/v2 v2.1.0 // indirect
 )

go.sum

@@ -2,6 +2,8 @@ github.com/alecthomas/kingpin/v2 v2.4.0 h1:f48lwail6p8zpO1bC4TxtqACaGqHYA22qkHjH
 github.com/alecthomas/kingpin/v2 v2.4.0/go.mod h1:0gyi0zQnjuFk8xrkNKamJoyUo382HRL7ATRpFZCw6tE=
 github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 h1:s6gZFSlWYmbqAuRjVTiNNhvNRfY2Wxp9nhfyel4rklc=
 github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137/go.mod h1:OMCwj8VM1Kc9e19TLln2VL61YJF0x1XFtfdL4JdbSyE=
+github.com/alecthomas/units v0.0.0-20231202071711-9a357b53e9c9 h1:ez/4by2iGztzR4L0zgAOR8lTQK9VlyBVVd7G4omaOQs=
+github.com/alecthomas/units v0.0.0-20231202071711-9a357b53e9c9/go.mod h1:OMCwj8VM1Kc9e19TLln2VL61YJF0x1XFtfdL4JdbSyE=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

main.go

@@ -1,9 +1,5 @@
 package providers
 
-import (
-	"strings"
-)
-
 /*
 Origin IP Access Control List (Origin IP ACL) offers some protection for your origin server by restricting traffic to ​Akamai​-controlled IP addresses.
 ​Akamai​ maintains a small and stable list of IP addresses that you use in policy rules in your origin server's firewall.
@@ -12,6 +8,7 @@ CIDR is an IP addressing scheme that improves the allocation of IP addresses by
 
 Reference: https://techdocs.akamai.com/origin-ip-acl/docs/welcome
 */
+
 var AkamaiCidrs = []string{
 	"23.32.0.0/11",
 	"23.192.0.0/11",
@@ -37,7 +34,6 @@ var AkamaiCidrs = []string{
 	"2405:9600::/32",
 }
 
-func AkamaiIps() (string, error) {
-	results := strings.Join(AkamaiCidrs, ",")
-	return results, nil
+func AkamaiIps() ([]string, error) {
+	return AkamaiCidrs, nil
 }

providers/akamai.go

@@ -2,7 +2,6 @@ package providers
 
 import (
 	"net"
-	"strings"
 	"testing"
 )
 
@@ -13,7 +12,7 @@ func TestAkamaiIps(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	for _, prefix := range strings.Split(ips, ",") {
+	for _, prefix := range ips {
 		ipv4Addr, _, err := net.ParseCIDR(prefix)
 		if err != nil {
 			t.Errorf("Akamai IP Address is invalid %s", ipv4Addr)

providers/akamai_test.go

@@ -4,7 +4,6 @@ import (
 	"encoding/json"
 	"net/http"
 	"slices"
-	"strings"
 )
 
 /*
@@ -42,25 +41,25 @@ type AwsInputs struct {
 	// Service string
 }
 
-func (a *AwsInputs) AwsIps() (string, error) {
+func (a *AwsInputs) AwsIps() ([]string, error) {
 	var err error
 	var client = &http.Client{}
 	var data *Aws
 	var prefixes []string
 
 	request, err := http.NewRequest(http.MethodGet, URL_AWS, nil)
 	if err != nil {
-		return "", err
+		return nil, err
 	}
 	response, err := client.Do(request)
 	if err != nil {
-		return "", err
+		return nil, err
 	}
 	defer response.Body.Close()
 
 	err = json.NewDecoder(response.Body).Decode(&data)
 	if err != nil {
-		return "", err
+		return nil, err
 	}
 
 	switch ipType := a.IpType; ipType {
@@ -84,7 +83,6 @@ func (a *AwsInputs) AwsIps() (string, error) {
 
 	slices.Sort(prefixes)
 	prefixes = slices.Compact(prefixes)
-	results := strings.Join(prefixes, ",")
 
-	return results, nil
+	return prefixes, nil
 }

providers/aws.go

@@ -2,7 +2,6 @@ package providers
 
 import (
 	"net"
-	"strings"
 	"testing"
 )
 
@@ -14,7 +13,7 @@ func TestAwsIps(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	for _, prefix := range strings.Split(ips, ",") {
+	for _, prefix := range ips {
 		ipv4Addr, _, err := net.ParseCIDR(prefix)
 		if err != nil {
 			t.Errorf("AWS IP Address is invalid %s", ipv4Addr)

providers/aws_test.go

@@ -3,7 +3,6 @@ package providers
 import (
 	"encoding/json"
 	"net/http"
-	"strings"
 )
 
 /*
@@ -28,27 +27,27 @@ type Cloudflare struct {
 	Messages []interface{} `json:"messages"`
 }
 
-func CloudflareIps() (string, error) {
+func CloudflareIps() ([]string, error) {
 	var err error
 	var client = &http.Client{}
 	var data *Cloudflare
 
 	request, err := http.NewRequest(http.MethodGet, URL_CLOUDFLARE, nil)
 	if err != nil {
-		return "", err
+		return nil, err
 	}
 	response, err := client.Do(request)
 	if err != nil {
-		return "", err
+		return nil, err
 	}
 	defer response.Body.Close()
 
 	err = json.NewDecoder(response.Body).Decode(&data)
 	if err != nil {
-		return "", err
+		return nil, err
 	}
 
-	results := strings.Join(append(data.Result.Ipv4Cidrs, data.Result.Ipv6Cidrs...), ",")
+	results := append(data.Result.Ipv4Cidrs, data.Result.Ipv6Cidrs...)
 
 	return results, nil
 }

providers/cloudflare.go

@@ -2,7 +2,6 @@ package providers
 
 import (
 	"net"
-	"strings"
 	"testing"
 )
 
@@ -13,7 +12,7 @@ func TestCloudflareIps(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	for _, prefix := range strings.Split(ips, ",") {
+	for _, prefix := range ips {
 		ipv4Addr, _, err := net.ParseCIDR(prefix)
 		if err != nil {
 			t.Errorf("Cloudflare IP Address is invalid %s", ipv4Addr)