Merge c040b23 into 936a61c

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/amihaiemil/comdor.svg?branch=master)](https://travis-ci.org/amihaiemil/comdor)
 [![Coverage Status](https://coveralls.io/repos/github/amihaiemil/comdor/badge.svg?branch=master)](https://coveralls.io/github/amihaiemil/comdor?branch=master)
-[![PDD status](http://www.0pdd.com/svg?name=opencharles/charles-rest)](http://www.0pdd.com/p?name=amihaiemil/comdor)
+[![PDD status](http://www.0pdd.com/svg?name=amihaiemil/comdor)](http://www.0pdd.com/p?name=amihaiemil/comdor)
 
 [![DevOps By Rultor.com](http://www.rultor.com/b/amihaiemil/comdor)](http://www.rultor.com/p/amihaiemil/comdor)
 [![We recommend IntelliJ IDEA](http://amihaiemil.github.io/images/intellij-idea-recommend.svg)](https://www.jetbrains.com/idea/)

src/main/java/co/comdor/github/English.java

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) 2017, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of comdor nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package co.comdor.github;
+
+/**
+ * The bot speaks English.
+ * @author Mihai Andronache (amihaiemil@gmail.com)
+ * @version $Id$
+ * @since 0.0.1
+ */
+public final class English extends Language {
+
+    /**
+     * Ctor.
+     */
+    public English() {
+        super("commands_en.properties", "responses_en.properties");
+    }
+}

src/main/java/co/comdor/github/Language.java

@@ -0,0 +1,115 @@
+/**
+ * Copyright (c) 2017, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of comdor nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package co.comdor.github;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.io.IOException;
+import java.util.Properties;
+import java.util.Set;
+
+/**
+ * Language that the bot speaks.
+ * @author Mihai Andronache (amihaiemil@gmail.com)
+ * @version $Id$
+ * @since 0.0.1
+ */
+abstract class Language {
+    /**
+     * Logger.
+     */
+    private static final Logger LOG = LoggerFactory.getLogger(
+        Language.class.getName()
+    );
+
+    /**
+     * Commands that the agent can understand, in a given language.
+     */
+    private Properties commands = new Properties();
+
+    /**
+     * Responses that the agent can give, in a given language.
+     */
+    private Properties responses = new Properties();
+
+    /**
+     * Ctor.
+     * @param commandsFileName Properties file with commands.
+     * @param responsesFileName Properties file with responses.
+     */
+    Language(final String commandsFileName, final String responsesFileName) {
+        try {
+            this.commands.load(
+                this.getClass().getClassLoader()
+                    .getResourceAsStream(commandsFileName)
+            );
+            this.responses.load(
+                this.getClass().getClassLoader()
+                    .getResourceAsStream(responsesFileName)
+            );
+        } catch (final IOException ex) {
+            LOG.error("Exception when loading commands' patterns!", ex);
+            throw new IllegalStateException(ex);
+        }
+    }
+
+    /**
+     * Categorize the given mention.
+     * @param mention Mention where the bot has been called.
+     * @return String type.
+     * @throws IOException If something goes wrong with the call to Github.
+     * @checkstyle
+     */
+    String categorize(final Mention mention) throws IOException {
+        final Set<Object> keys = this.commands.keySet();
+        String type = "unknown";
+        boolean match = true;
+        for(final Object key : keys) {
+            final String keyString = (String) key;
+            final String[] words = this.commands.getProperty(keyString, "")
+                .split("\\^");
+            for(final String word : words) {
+                if(!mention.json().getString("body").contains(word.trim())) {
+                    match = false;
+                }
+            }
+            if(match) {
+                type = keyString.split("\\.")[0];
+                break;
+            }
+        }
+        return type;
+    }
+
+    /**
+     * Find a response.
+     * @param key The response's key.
+     * @return String.
+     */
+    String response(final String key) {
+        return this.responses.getProperty(key);
+    }
+}

src/main/resources/commands_en.properties

@@ -0,0 +1,4 @@
+#english commands
+#DO NOT change the keys' prefixes (first string before the dot), as they are used in the code to identify the command type
+
+hello.command=hello

src/main/resources/responses_en.properties

@@ -0,0 +1 @@
+hello.comment=Hi there, @%s!

src/test/java/co/comdor/github/EnglishTestCase.java

@@ -0,0 +1,112 @@
+/**
+ * Copyright (c) 2017, Mihai Emil Andronache
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1)Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2)Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3)Neither the name of comdor nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package co.comdor.github;
+
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+
+import javax.json.Json;
+import javax.json.JsonObject;
+import java.util.regex.Matcher;
+
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Unit tests for {@link English}.
+ * @author Mihai Andronache (amihaiemil@gmail.com)
+ * @version $Id$
+ * @since 0.0.1
+ */
+public final class EnglishTestCase {
+
+    /**
+     * A 'hello' comment is understood.
+     */
+    @Test
+    public void categorizesHelloCommands() throws Exception {
+        final Mention hello1 = this.mockMention("@comdor, hello there!");
+        final Mention hello2 = this.mockMention("@comdor, hello?!");
+        final Mention hello3 = this.mockMention("@comdor hello");
+        final Mention hello4 = this.mockMention("@comdor hello, how are you?");
+        final Mention hello5 = this.mockMention("@comdor hello, who are you?");
+
+        final Language english = new English();
+        MatcherAssert.assertThat(
+            english.categorize(hello1), Matchers.equalTo("hello")
+        );
+        MatcherAssert.assertThat(
+            english.categorize(hello2), Matchers.equalTo("hello")
+        );
+        MatcherAssert.assertThat(
+            english.categorize(hello3), Matchers.equalTo("hello")
+        );
+        MatcherAssert.assertThat(
+            english.categorize(hello4), Matchers.equalTo("hello")
+        );
+        MatcherAssert.assertThat(
+            english.categorize(hello5), Matchers.equalTo("hello")
+        );
+    }
+
+    /**
+     * A comment is not understood.
+     */
+    @Test
+    public void commandIsUnknown() throws Exception {
+        final Mention unknown1 = this.mockMention("@comdor who are you?");
+        final Mention unknown2 = this.mockMention("@comdor, Something else");
+        final Mention unknown3 = this.mockMention("@comdor howdy");
+
+        final Language english = new English();
+        MatcherAssert.assertThat(
+            english.categorize(unknown1), Matchers.equalTo("unknown")
+        );
+        MatcherAssert.assertThat(
+            english.categorize(unknown2), Matchers.equalTo("unknown")
+        );
+        MatcherAssert.assertThat(
+            english.categorize(unknown3), Matchers.equalTo("unknown")
+        );
+    }
+
+    /**
+     * Mock a Mention.
+     * @param message Message for it.
+     * @return The mocked Mention.
+     */
+    private Mention mockMention(final String message) {
+        final Mention mock = Mockito.mock(Mention.class);
+        final JsonObject comment = Json
+            .createObjectBuilder().add("body", message)
+            .build();
+
+        Mockito.when(mock.json()).thenReturn(comment);
+        return mock;
+    }
+}