NotifyMyAndroid plugin

Add slf4j API jar

Change-Id: I56f1f80196a64c5c34b6824d0056de6bf289f6d8
Reviewed-on: http://gerrit.dmdirc.com/2319
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/addons/nma/NotifyMyAndroidClient.java

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2006-2012 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.nma;
+
+import com.dmdirc.util.io.Downloader;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * Simple client for sending events to NotifyMyAndroid.
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class NotifyMyAndroidClient {
+
+    /** The base URL for the NMA API. */
+    private static final String BASE_URL = "https://www.notifymyandroid.com";
+    /** The method to call to send a notification. */
+    private static final String NOTIFY_PATH = "/publicapi/notify";
+
+    /** The API keys to deliver to. */
+    private final Collection<String> apiKeys;
+
+    /** The application to report ourselves as. */
+    private final String application;
+
+    /**
+     * Creates a new instance of {@link NotifyMyAndroidClient} with a single
+     * API key.
+     *
+     * @param apiKey The API key to use when connecting to NMA
+     * @param application The application string to report to NMA.
+     */
+    public NotifyMyAndroidClient(final String apiKey, final String application) {
+        this(Arrays.asList(new String[] { apiKey }), application);
+    }
+
+    /**
+     * Sends a notification to NotifyMyAndroid. At present return status and
+     * text is ignored.
+     *
+     * @param event The name of the event to send (max 1,000 chars).
+     * @param description The description of the event (max 10,000 chars).
+     * @throws IOException If the NMA service couldn't be reached
+     */
+    public void notify(final String event, final String description) throws IOException {
+        final Map<String, String> arguments = new HashMap<String, String>();
+        arguments.put("apikey", getApiKeys());
+        arguments.put("application", application);
+        arguments.put("event", event);
+        arguments.put("description", description);
+
+        log.info("Sending notification to NMA for event '{}'", event);
+        log.debug("Arguments: {}", arguments);
+
+        final List<String> response = Downloader.getPage(BASE_URL + NOTIFY_PATH, arguments);
+        log.debug("Response: {}", response);
+    }
+
+    /**
+     * Returns a comma-separated list of API keys.
+     *
+     * @return A string representation of API keys.
+     */
+    private String getApiKeys() {
+        final StringBuilder builder = new StringBuilder();
+
+        for (String apiKey : apiKeys) {
+            if (builder.length() > 0) {
+                builder.append(',');
+            }
+
+            builder.append(apiKey);
+        }
+
+        return builder.toString();
+    }
+
+}

src/com/dmdirc/addons/nma/NotifyMyAndroidCommand.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2006-2012 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.nma;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.commandparser.BaseCommandInfo;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.CommandType;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+
+import java.io.IOException;
+
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * Command to raise notifications with NotifyMyAndroid.
+ */
+@Slf4j
+public class NotifyMyAndroidCommand extends Command {
+
+    /** A command info object for this command. */
+    public static final BaseCommandInfo INFO = new BaseCommandInfo(
+            "notifymyandroid",
+            "notifymyandroid <title> -- <body>"
+                + " - Sends notification to NotifyMyAndroid",
+            CommandType.TYPE_GLOBAL);
+
+    /** The configuration domain to retrieve settings from. */
+    @Setter
+    private String configDomain;
+
+    /** {@inheritDoc} */
+    @Override
+    public void execute(final FrameContainer origin,
+            final CommandArguments args, final CommandContext context) {
+        final String[] parts = args.getArgumentsAsString().split("\\s+--\\s+", 2);
+        log.trace("Split input: {}", parts);
+
+        if (parts.length != 2) {
+            showUsage(origin, args.isSilent(), INFO.getName(), INFO.getHelp());
+        }
+
+        log.trace("Retrieving settings from domain '{}'", configDomain);
+        final NotifyMyAndroidClient client = new NotifyMyAndroidClient(
+                origin.getConfigManager().getOption(configDomain, "apikey"),
+                origin.getConfigManager().getOption(configDomain, "application"));
+
+        try {
+            client.notify(parts[0], parts[1]);
+            sendLine(origin, args.isSilent(), FORMAT_OUTPUT, "Notification sent");
+        } catch (IOException ex) {
+            log.info("Exception when trying to notify NMA", ex);
+            sendLine(origin, args.isSilent(), FORMAT_ERROR, "Unable to send: " + ex.getMessage());
+        }
+    }
+
+}

src/com/dmdirc/addons/nma/NotifyMyAndroidPlugin.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2006-2012 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.nma;
+
+import com.dmdirc.config.prefs.PluginPreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesDialogModel;
+import com.dmdirc.config.prefs.PreferencesSetting;
+import com.dmdirc.config.prefs.PreferencesType;
+import com.dmdirc.plugins.BasePlugin;
+import com.dmdirc.plugins.PluginInfo;
+
+/**
+ * Plugin to allow pushing notifications to NotifyMyAndroid.
+ */
+public class NotifyMyAndroidPlugin extends BasePlugin {
+
+    /** The command to register. */
+    private final NotifyMyAndroidCommand command = new NotifyMyAndroidCommand();
+
+    /** Our info object. */
+    private final PluginInfo pluginInfo;
+
+    /**
+     * Creates a new instance of the {@link NotifyMyAndroidPlugin}.
+     *
+     * @param pluginInfo The plugin info object for this plugin.
+     */
+    public NotifyMyAndroidPlugin(final PluginInfo pluginInfo) {
+        registerCommand(command, NotifyMyAndroidCommand.INFO);
+
+        this.pluginInfo = pluginInfo;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setDomain(final String newDomain) {
+        super.setDomain(newDomain);
+        command.setConfigDomain(newDomain);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void showConfig(final PreferencesDialogModel manager) {
+        final PreferencesCategory category = new PluginPreferencesCategory(
+                pluginInfo, "Notify My Android",
+                "General configuration for Notify My Android plugin.");
+
+        category.addSetting(new PreferencesSetting(
+                PreferencesType.TEXT, getDomain(), "apikey",
+                "API Key", "Comma-separated list of NotifyMyAndroid API keys"
+                + " to be notified when the command is used.",
+                manager.getConfigManager(), manager.getIdentity()));
+        category.addSetting(new PreferencesSetting(
+                PreferencesType.TEXT, getDomain(), "application",
+                "Application", "Name of the application to report to "
+                + "NotifyMyAndroid",
+                manager.getConfigManager(), manager.getIdentity()));
+
+        manager.getCategory("Plugins").addSubCategory(category);
+    }
+
+}

src/com/dmdirc/addons/nma/plugin.config

@@ -0,0 +1,30 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  version
+  defaults
+  updates
+
+metadata:
+  author=Chris <chris@dmdirc.com>
+  mainclass=com.dmdirc.addons.nma.NotifyMyAndroidPlugin
+  description=Facilitates sending notifications to NotifyMyAndroid
+  name=nma
+  nicename=Notify My Android plugin
+
+updates:
+  id=70
+
+version:
+  friendly=0.1
+
+provides:
+  notifymyandroid command
+
+defaults:
+  apikey=
+  application=DMDirc