refactor: restructure and tidy up

Author: simskij

.gitignore

@@ -1,4 +1,6 @@
 # Binaries for programs and plugins
+# ---
+
 *.exe
 *.exe~
 *.dll
@@ -7,8 +9,12 @@
 shoutrrr
 
 # Test binary, build with `go test -c`
+# ---
+
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
+# ---
+
 *.out
 .idea

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Arctic Bit
+Copyright (c) 2019 Containrrr
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -42,18 +42,60 @@
 
 ### Using Shoutrrr
 
-Using shoutrrr is as easy as:
+#### As a package
 
-```
+Using shoutrrr is easy! There is currently two ways of using it as a package.
+
+##### Using the direct send command
+
+```go
   url := "slack://token-a/token-b/token-c"
   err := shoutrrr.Send(url, "Hello world (or slack channel) !")
 
 ```
 
-If you've provided the environment variable `SHOUTRRR_URL`, you may instead use
+##### Using a sender
+```go
+  url := "slack://token-a/token-b/token-c"
+  sender := shoutrrr.CreateSender(url)
+  sender.Send("Hello world (or slack channel) !", map[string]string { /* ... */ })
+```
+
+#### Through the CLI
+
+Start by running the `build.sh` script. 
+You may then run the shoutrrr executable:
+
+```shell
+$ ./shoutrrr
+
+Usage:
+./shoutrrr <ActionVerb> [...]
+Possible actions: send, verify, generate
+```
+
+##### Action details
 
+```shell
+$ ./shoutrrr send
+Usage:
+./shoutrrr send [OPTIONS] <URL> <Message [...]>
+
+OPTIONS:
+  -verbose
+        display additional output
+``` 
+
+```shell
+$ ./shoutrrr verify
+Usage:
+./shoutrrr send [OPTIONS] <URL> <Message [...]>
 ```
-  err := shoutrrr.SendEnv("Hello world (or slack channel) !")
+
+```shell
+$ ./shoutrrr generate
+Usage:
+./shoutrrr generate [OPTIONS] <service>
 ```
 
 ### Service URL:s

build.sh

@@ -0,0 +1 @@
+go build -o ./shoutrrr ./cmd/shoutrrr

pkg/cli/generate.go cmd/shoutrrr/generate.go

@@ -36,7 +36,7 @@ func generate() action {
 			return 1
 		},
 		FlagSet: *flag.NewFlagSet("generate", flag.ExitOnError),
-		Usage: "%s generate [OPTIONS] <service>\n",
+		Usage:   "%s generate [OPTIONS] <service>\n",
 	}
 
 	// action.FlagSet.BoolVar(&verbose, "verbose", false, "display additional output")

pkg/cli/main.go cmd/shoutrrr/main.go

@@ -12,6 +12,7 @@ import (
 )
 
 var verbose bool
+var usageExample = "%s send [OPTIONS] <URL> <Message [...]>\n"
 
 func send() action {
 	action := action{
@@ -46,7 +47,7 @@ func send() action {
 			return 0
 		},
 		FlagSet: *flag.NewFlagSet("send", flag.ExitOnError),
-		Usage: "%s send [OPTIONS] <URL> <Message [...]>\n",
+		Usage:   usageExample,
 	}
 
 	action.FlagSet.BoolVar(&verbose, "verbose", false, "display additional output")

pkg/cli/send.go cmd/shoutrrr/send.go

@@ -34,6 +34,6 @@ func verify() action {
 			return 0
 		},
 		FlagSet: *flag.NewFlagSet("verify", flag.ExitOnError),
-		Usage: "%s send [OPTIONS] <URL> <Message [...]>\n",
+		Usage:   "%s send [OPTIONS] <URL> <Message [...]>\n",
 	}
 }

pkg/cli/verify.go cmd/shoutrrr/verify.go

@@ -1,6 +1,6 @@
 package smtp
 
-import "github.com/containrrr/shoutrrr/pkg/failures"
+import "github.com/containrrr/shoutrrr/internal/failures"
 
 const (
 	// FailUnknown is the default FailureID

config.yml

@@ -10,8 +10,8 @@ import (
 	"testing"
 	"unsafe"
 
-	"github.com/containrrr/shoutrrr/pkg/failures"
-	"github.com/containrrr/shoutrrr/pkg/testutils"
+	"github.com/containrrr/shoutrrr/internal/failures"
+	"github.com/containrrr/shoutrrr/internal/testutils"
 	"github.com/containrrr/shoutrrr/pkg/util"
 
 	. "github.com/onsi/ginkgo"

pkg/failures/failure.go internal/failures/failure.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/containrrr/shoutrrr/pkg/router"
 	"github.com/containrrr/shoutrrr/pkg/types"
-	"github.com/containrrr/shoutrrr/pkg/util/queue"
 )
 
 var routing = router.ServiceRouter{}
@@ -15,7 +14,7 @@ func SetLogger(logger *log.Logger) {
 	routing.SetLogger(logger)
 }
 
-// Send lets you send shoutrrr notifications using a supplied url and message
+// Send notifications using a supplied url and message
 func Send(rawURL string, message string) error {
 	service, err := routing.Locate(rawURL)
 	if err != nil {
@@ -28,20 +27,4 @@ func Send(rawURL string, message string) error {
 // CreateSender returns a notification sender configured according to the supplied URL
 func CreateSender(rawURL string) (types.Service, error) {
 	return routing.Locate(rawURL)
-}
-
-// CreateQueue returns a notification queued sender configured according to the supplied URL
-func CreateQueue(rawURL string) (types.QueuedSender, error) {
-	service, err := routing.Locate(rawURL)
-	if err != nil {
-		return nil, err
-	}
-
-	return queue.GetQueued(service), nil
-}
-
-// VerifyURL lets you verify that a configuration URL is valid
-func VerifyURL(rawURL string) error {
-	_, err := routing.Locate(rawURL)
-	return err
 }