Checking in all the SmartThings apps; both official and third-party.
[smartapps.git] / official / jenkins-notifier.groovy
diff --git a/official/jenkins-notifier.groovy b/official/jenkins-notifier.groovy
new file mode 100755 (executable)
index 0000000..f822ee3
--- /dev/null
@@ -0,0 +1,131 @@
+/*
+ * Copyright (C) 2014 Andrew Reitz
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Jenkins Notifier
+ *
+ * Checks a Jenkins server at a specific time, if the build fails it will turn on a light.  If the build goes from
+ * failing back to succeeding the light will turn off. Hues can also be used in place of the light in order to create
+ * colors for build statuses
+ */
+
+// Automatically generated. Make future change here.
+definition(
+    name: "Jenkins Notifier",
+    namespace: "com.andrewreitz",
+    author: "aj.reitz@gmail.com",
+    description: "Turn off and on devices based on the state that your Jenkins Build is in.",
+    category: "Fun & Social",
+    iconUrl: "http://i.imgur.com/tyIp8wQ.jpg",
+    iconX2Url: "http://i.imgur.com/tyIp8wQ.jpg"
+)
+
+preferences {
+    section("The URL to your Jenkins, including the job you want to monitor. Ex. https://jenkins.example.com/job/myproject/") {
+        input "jenkinsUrl", "text", title: "Jenkins URL"
+    }
+    section("Jenkins Username") {
+        input "jenkinsUsername", "text", title: "Jenkins Username"
+    }
+    section("Jenkins Password") {
+        input "jenkinsPassword", "password", title: "Jenkins Password"
+    }
+    section("On Failed Build Turn On...") {
+        input "switches", "capability.switch", multiple: true, required: false
+    }
+    section("Or Change These Bulbs...") {
+        input "hues", "capability.colorControl", title: "Which Hue Bulbs?", required: false, multiple: true
+        input "colorSuccess", "enum", title: "Hue Color On Success?", required: false, multiple: false, options: getHueColors().keySet() as String[]
+        input "colorFail", "enum", title: "Hue Color On Fail?", required: false, multiple: false, options: getHueColors().keySet() as String[]
+        input "lightLevelSuccess", "number", title: "Light Level On Success?", required: false
+        input "lightLevelFail", "number", title: "Light Level On Fail?", required: false
+    }
+    section("Additional settings", hideable: true, hidden: true) {
+        paragraph("Default check time is 15 Minutes")
+        input "refreshInterval", "decimal", title: "Check Server... (minutes)",
+                description: "Enter time in minutes", defaultValue: 15, required: false
+    }
+}
+
+def installed() {
+    log.debug "Installed with settings: ${settings}"
+    initialize()
+}
+
+def updated() {
+    log.debug "Updated with settings: ${settings}"
+    unsubscribe()
+    initialize()
+}
+
+/** Constants for Hue Colors */
+Map getHueColors() {
+    return [Red: 0, Green: 39, Blue: 70, Yellow: 25, Orange: 10, Purple: 75, Pink: 83]
+}
+
+/** Constant for Saturation */
+int getSaturation() {
+    return 100;
+}
+
+/** Constant for Level */
+int getMaxLevel() {
+    return 100;
+}
+
+def initialize() {
+    def successColor = [switch: "on", hue: getHueColors()[colorSuccess], saturation: getSaturation(), level: lightLevelSuccess ?: getMaxLevel()]
+    def failColor = [switch: "on", hue: getHueColors()[colorFail], saturation: getSaturation(), level: lightLevelFail ?: getMaxLevel()]
+    state.successColor = successColor
+    state.failColor = failColor
+    log.debug "successColor: ${successColor}, failColor: ${failColor}"
+    
+    checkServer()
+    
+    def cron = "* */${refreshInterval ?: 15} * * * ?"
+    schedule(cron, checkServer)
+}
+
+def checkServer() {
+    log.debug "Checking Server Now"
+
+       def successColor = state.successColor
+    def failColor = state.failColor
+
+    def basicCredentials = "${jenkinsUsername}:${jenkinsPassword}"
+    def encodedCredentials = basicCredentials.encodeAsBase64().toString()
+    def basicAuth = "Basic ${encodedCredentials}"
+
+    def head = ["Authorization": basicAuth]
+
+    log.debug "Auth ${head}"
+
+       def host = jenkinsUrl.contains("lastBuild/api/json") ? jenkinsUrl : "${jenkinsUrl}/lastBuild/api/json"
+
+    httpGet(uri: host, headers: ["Authorization": "${basicAuth}"]) { resp ->
+       def buildError = (resp.data.result == "FAILURE")
+        def buildSuccess = (resp.data.result == "SUCCESS")
+        log.debug "Build Success? ${buildSuccess}"
+        if (buildError) {
+            switches?.on()
+            hues?.setColor(failColor)
+        } else if (buildSuccess) {
+            switches?.off()
+            hues?.setColor(successColor)
+        } // else in some other state, probably building, do nothing.
+
+    }
+}