Added connector metadata sample and REST API endpoints.

Author: sebinside

src/main/resources/connector/org.codeoverflow.chatoverflow.requirement.service.twitch.chat.twitchchatconnector.xml

@@ -0,0 +1,8 @@
+<connector>
+    <display>Twitch Chat</display>
+    <description>TODO</description>
+    <wiki>https://github.com/codeoverflow-org/chatoverflow/wiki/Twitch-Chat</wiki>
+    <icon48>
+        data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC4AAAAwCAYAAABuZUjcAAABEklEQVRoge3X0Q2CMBRA0QthGpzCIXQC9wB3cSXn0Y9ColJoi32PvqT3R4JNOGmaQpvb+cFUDzwxUvtxfTlMsSPz8B44HQlJbYabmm2AbvpdgzdakECv3xstBpcJOLi5ZQIOfj0asad5qZirDQ8pM7PwLjwkqsV2xfZWmjp+kdkZr3DtKly7CteuwrWrcO3MwnN9ZKWeTf8+y5qd8QoXbPDdLB0+AKPvj5Lhq2jgXip8Ew2MJcKDaChvqUShIfwC8p3GffleKFuI1L7QIDfjomiQgYujIT9cBQ154WpoyAdXRUM+ePBBkUWhoax9PBoNbh9P+aiP3dd3YVKSnHExNMjBRdEgAxdHQ364ChrywtXQAG9A2SgNqLuDfQAAAABJRU5ErkJggg==
+    </icon48>
+</connector>

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/DTOs.scala

@@ -21,6 +21,8 @@ object DTOs {
 
   case class Types(pluginTypes: Seq[PluginType], requirementTypes: RequirementTypes, connectorTypes: Seq[String])
 
+  case class ConnectorMetadata(found: Boolean, displayName: String, description: String, wikiUrl: String, icon: String)
+
   case class RequirementTypes(input: Seq[String], output: Seq[String], parameter: Seq[String])
 
   case class APIAndSpecificType(interface: String, implementation: String, connector: String, found: Boolean)

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/types/TypeController.scala

@@ -31,6 +31,19 @@ class TypeController(implicit val swagger: Swagger) extends JsonServlet with Typ
     }
   }
 
+  get("/connector/metadata", operation(getConnectorsMetadata)) {
+    authKeyRequired {
+      getConnectorTypes.map(typeString => typeString -> readConnectorMetadata(typeString))
+    }
+  }
+
+  get("/connector/metadata/:qualifiedConnectorType", operation(getConnectorMetadata)) {
+    authKeyRequired {
+      val qualifiedConnectorType = params("qualifiedConnectorType")
+      readConnectorMetadata(qualifiedConnectorType)
+    }
+  }
+
   get("/", operation(getTypes)) {
     authKeyRequired {
       Types(getPluginTypes, getRequirementTypes, getConnectorTypes)
@@ -78,4 +91,20 @@ class TypeController(implicit val swagger: Swagger) extends JsonServlet with Typ
 
   private def getConnectorTypes = chatOverflow.typeRegistry.getConnectorTypes
 
+  private def readConnectorMetadata(typeString: String): ConnectorMetadata = {
+
+    val ressource = getClass.getResourceAsStream(s"/connector/${typeString.toLowerCase}.xml")
+
+    if (ressource == null) {
+      ConnectorMetadata(found = false, "", "", "", "")
+    } else {
+      val node = xml.Utility.trim(xml.XML.load(ressource))
+      ConnectorMetadata(found = true,
+        (node \ "display").text,
+        (node \ "description").text,
+        (node \ "wiki").text,
+        (node \ "icon48").text)
+    }
+  }
+
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/types/TypesControllerDefinition.scala

@@ -25,6 +25,19 @@ trait TypesControllerDefinition extends SwaggerSupport with TagSupport with Auth
       description "Shows the fully qualified type strings of all connectors."
       parameter authHeader
       tags controllerTag)
+  val getConnectorsMetadata: OperationBuilder =
+    (apiOperation[Map[String, ConnectorMetadata]]("getConnectorsMetadata")
+      summary "Shows the metadata of all connectors, if found."
+      description "Shows a map of connector type string and metadata with display name, description, wiki url and base64 encoded icon."
+      parameter authHeader
+      tags controllerTag)
+  val getConnectorMetadata: OperationBuilder =
+    (apiOperation[ConnectorMetadata]("getConnectorMetadata")
+      summary "Shows the metadata of a specified connector, if found."
+      description "Shows the connectors metadata with display name, description, wiki url and base64 encoded icon."
+      parameter pathParam[String]("qualifiedConnectorType").description("The qualified connector type string of a registered connector.")
+      parameter authHeader
+      tags controllerTag)
   val getTypes: OperationBuilder =
     (apiOperation[Types]("getTypes")
       summary "Shows all possible types of plugins, requirements and connectors."