Merge pull request #2 from eternal-flame-AD/master

Update v1 API

Author: jmattheis

config.go

@@ -3,12 +3,12 @@ package plugin
 // Configurer is the interface plugins should implement in order to provide configuration interface to the user
 type Configurer interface {
 	Plugin
-	// DefaultConfig will be called on plugin first run. The default configuration will be provided to the user for future editing.
+	// DefaultConfig will be called on plugin first run to set the default config.
+	// DefaultConfig will also be used if the provided config cannot be validate during initialization.
+	// The default configuration will be provided to the user for future editing. Used for generating schemas and unmarshaling.
 	DefaultConfig() interface{}
-	// EmptyConfig returns an instance of an empty configuration. Used for generating schemes.
-	EmptyConfig() interface{}
 	// ValidateAndSetConfig will be called every time the plugin is initialized or the configuration has been changed by the user.
 	// Plugins should check whether the configuration is valid and optionally return an error.
-	// Parameter is guaranteed to be the same type as the return type of EmptyConfig()
+	// Parameter is guaranteed to be the same type as the return type of DefaultConfig()
 	ValidateAndSetConfig(c interface{}) error
 }

displayer.go

@@ -1,9 +1,14 @@
 package plugin
 
+import "net/url"
+
 // Displayer is the interface plugins should implement to show a text to the user.
 // The text will appear on the plugin details page and can be multi-line.
 // Markdown syntax is allowed. Good for providing dynamically generated instructions to the user.
+// Location is the current location the user is accessing the API from, nil if not recoverable.
+// Location contains the path to the display api endpoint, you may only need the base url.
+// Example: https://gotify.net/plugin/5/display
 type Displayer interface {
 	Plugin
-	GetDisplay() string
+	GetDisplay(location *url.URL) string
 }

export_ref_do_not_edit.json

@@ -1 +1 @@
-[{"label":"Displayer","type":"interface","fileName":"displayer.go","pos":276,"members":[{"label":"Plugin","type":"embed"},{"label":"GetDisplay","type":"method","funcSpec":{"returns":[{"type":"type","underlyingType":"string"}]}}]},{"label":"Message","type":"struct","fileName":"messenger.go","pos":93,"members":[{"label":"Message","type":"member"},{"label":"Title","type":"member"},{"label":"Priority","type":"member"}]},{"label":"MessageHandler","type":"interface","fileName":"messenger.go","pos":237,"members":[{"label":"SendMessage","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"Message"}],"returns":[{"type":"type","underlyingType":"error"}]}}]},{"label":"Messenger","type":"interface","fileName":"messenger.go","pos":452,"members":[{"label":"Plugin","type":"embed"},{"label":"SetMessageHandler","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"MessageHandler"}]}}]},{"label":"Plugin","type":"interface","fileName":"plugin.go","pos":79,"members":[{"label":"Enable","type":"method","funcSpec":{"returns":[{"type":"type","underlyingType":"error"}]}},{"label":"Disable","type":"method","funcSpec":{"returns":[{"type":"type","underlyingType":"error"}]}}]},{"label":"UserContext","type":"struct","fileName":"plugin.go","pos":473,"members":[{"label":"ID","type":"member"},{"label":"Name","type":"member"},{"label":"Admin","type":"member"}]},{"label":"Info","type":"struct","fileName":"plugin.go","pos":731,"members":[{"label":"Version","type":"member"},{"label":"Author","type":"member"},{"label":"Name","type":"member"},{"label":"Website","type":"member"},{"label":"Description","type":"member"},{"label":"License","type":"member"},{"label":"ModulePath","type":"member"}]},{"label":"Configurer","type":"interface","fileName":"config.go","pos":133,"members":[{"label":"Plugin","type":"embed"},{"label":"DefaultConfig","type":"method","funcSpec":{"returns":[{"type":"interface"}]}},{"label":"EmptyConfig","type":"method","funcSpec":{"returns":[{"type":"interface"}]}},{"label":"ValidateAndSetConfig","type":"method","funcSpec":{"params":[{"type":"interface"}],"returns":[{"type":"type","underlyingType":"error"}]}}]},{"label":"Webhooker","type":"interface","fileName":"webhook.go","pos":139,"members":[{"label":"Plugin","type":"embed"},{"label":"RegisterWebhook","type":"method","funcSpec":{"params":[{"label":"gin.RouterGroup","type":"selector"}]}}]},{"label":"StorageHandler","type":"interface","fileName":"storage.go","pos":125,"members":[{"label":"Save","type":"method","funcSpec":{"params":[{"label":"[]byte","type":"array"}],"returns":[{"type":"type","underlyingType":"error"}]}},{"label":"Load","type":"method","funcSpec":{"returns":[{"label":"[]byte","type":"array"},{"type":"type","underlyingType":"error"}]}}]},{"label":"Storager","type":"interface","fileName":"storage.go","pos":287,"members":[{"label":"Plugin","type":"embed"},{"label":"SetStorageHandler","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"StorageHandler"}]}}]}]
+[{"label":"StorageHandler","type":"interface","fileName":"storage.go","pos":125,"members":[{"label":"Save","type":"method","funcSpec":{"params":[{"label":"[]byte","type":"array"}],"returns":[{"type":"type","underlyingType":"error"}]}},{"label":"Load","type":"method","funcSpec":{"returns":[{"label":"[]byte","type":"array"},{"type":"type","underlyingType":"error"}]}}]},{"label":"Storager","type":"interface","fileName":"storage.go","pos":287,"members":[{"label":"Plugin","type":"embed"},{"label":"SetStorageHandler","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"StorageHandler"}]}}]},{"label":"Displayer","type":"interface","fileName":"displayer.go","pos":390,"members":[{"label":"Plugin","type":"embed"},{"label":"GetDisplay","type":"method","funcSpec":{"params":[{"label":"*url.URL","type":"star"}],"returns":[{"type":"type","underlyingType":"string"}]}}]},{"label":"Message","type":"struct","fileName":"messenger.go","pos":93,"members":[{"label":"Message","type":"member"},{"label":"Title","type":"member"},{"label":"Priority","type":"member"},{"label":"Extras","type":"member"}]},{"label":"MessageHandler","type":"interface","fileName":"messenger.go","pos":270,"members":[{"label":"SendMessage","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"Message"}],"returns":[{"type":"type","underlyingType":"error"}]}}]},{"label":"Messenger","type":"interface","fileName":"messenger.go","pos":485,"members":[{"label":"Plugin","type":"embed"},{"label":"SetMessageHandler","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"MessageHandler"}]}}]},{"label":"Plugin","type":"interface","fileName":"plugin.go","pos":79,"members":[{"label":"Enable","type":"method","funcSpec":{"returns":[{"type":"type","underlyingType":"error"}]}},{"label":"Disable","type":"method","funcSpec":{"returns":[{"type":"type","underlyingType":"error"}]}}]},{"label":"UserContext","type":"struct","fileName":"plugin.go","pos":473,"members":[{"label":"ID","type":"member"},{"label":"Name","type":"member"},{"label":"Admin","type":"member"}]},{"label":"Info","type":"struct","fileName":"plugin.go","pos":731,"members":[{"label":"Version","type":"member"},{"label":"Author","type":"member"},{"label":"Name","type":"member"},{"label":"Website","type":"member"},{"label":"Description","type":"member"},{"label":"License","type":"member"},{"label":"ModulePath","type":"member"}]},{"label":"Configurer","type":"interface","fileName":"config.go","pos":133,"members":[{"label":"Plugin","type":"embed"},{"label":"DefaultConfig","type":"method","funcSpec":{"returns":[{"type":"interface"}]}},{"label":"ValidateAndSetConfig","type":"method","funcSpec":{"params":[{"type":"interface"}],"returns":[{"type":"type","underlyingType":"error"}]}}]},{"label":"Webhooker","type":"interface","fileName":"webhook.go","pos":139,"members":[{"label":"Plugin","type":"embed"},{"label":"RegisterWebhook","type":"method","funcSpec":{"params":[{"type":"type","underlyingType":"string"},{"label":"*gin.RouterGroup","type":"star"}]}}]}]

messenger.go

@@ -5,6 +5,7 @@ type Message struct {
 	Message  string
 	Title    string
 	Priority int
+	Extras   map[string]interface{}
 }
 
 // MessageHandler consists of message callbacks to be used by plugins.

webhook.go

@@ -6,6 +6,5 @@ import "github.com/gin-gonic/gin"
 type Webhooker interface {
 	Plugin
 	// RegisterWebhook is called for plugins to create their own handler.
-	// Plugins can call mux.BasePath() to acquire their custom handler base path.
-	RegisterWebhook(mux gin.RouterGroup)
+	RegisterWebhook(basePath string, mux *gin.RouterGroup)
 }