setup structure

Author: Matthias Huttar

.gitignore

@@ -0,0 +1,34 @@
+jmeter.log
+germany/*/target
+core/*/target
+germany/target
+core/target
+target
+extra
+.idea/
+*.iml
+*.ipr
+*.iws
+nb*.xml
+.project
+.classpath
+.settings
+db*.log
+db.data
+db.redo
+.#webclasspath
+.tomcatplugin
+.metadata
+velocity.log*
+.cache
+work
+*global-groovy.log
+glassfish-web.xml
+context.xml
+.pmd
+jrebel.xml
+.DS_Store
+activemq-data
+/germany/belen-selenium-tests/nbactions.xml
+.checkstyle
+test-output/

README.md

@@ -0,0 +1,20 @@
+# Message Extraction Sample
+this example is based on a task that we worked on half a year ago for our online message box.
+At eBay Kleinanzeigen buyers and sellers used to communicate via E-Mail through our platform.
+
+We introduced a new feature  called *message box* to allow people a quicker and less formal way of communication.
+Message box can be used transparently over different channels (a user of messagebox might be communicating with a user that
+still uses e-mails).
+
+One of the biggest challenge we had, was to cope with the e-mail format in order to extract the actual contents of a mail
+from our template text in the first mail and all the quotation mess that mail clients produce.
+
+## Tasks and considerations
+This is a complicated task and we know that you're not going to finish it in time. Also, we have not found a perfect solution.
+We want to see your approach and considerations as well as your style of work. (and maybe learn from your ideas ;) )
+
+For this task you can assume that:
+
+* we only cope with plaintext mails (no html content e-mails)
+* you will have to handle all weird sorts of quotation styles that mail clients may or may not use.
+* users may mix their replies with the quoted parts (meaning they reply individually to each paragraph)

pom.xml

@@ -0,0 +1,30 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.ebay.classifieds.germany</groupId>
+  <artifactId>message-extraction</artifactId>
+  <packaging>jar</packaging>
+  <version>1.0-SNAPSHOT</version>
+  <url>http://kleinanzeigen.ebay.de/anzeigen</url>
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.11</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.1</version>
+                <configuration>
+                    <source>1.7</source>
+                    <target>1.7</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

src/main/java/com/ebay/classifieds/germany/Mail.java

@@ -0,0 +1,33 @@
+package com.ebay.classifieds.germany;
+
+import static com.ebay.classifieds.germany.Mail.Role.BUYER;
+import static com.ebay.classifieds.germany.Mail.Role.SELLER;
+
+public class Mail {
+
+    public static enum Role {BUYER, SELLER}
+
+    private final String mailContents;
+    private final Role from;
+
+
+    public Mail(String mailContents, Role from) {
+        if (from == null || mailContents == null) {
+            throw new IllegalArgumentException("all parameters are mandatory");
+        }
+        this.mailContents = mailContents;
+        this.from = from;
+    }
+
+    public String getMailContents() {
+        return mailContents;
+    }
+
+    public Role getFrom() {
+        return from;
+    }
+
+    public Role getTo() {
+        return from == BUYER ? SELLER : BUYER;
+    }
+}

src/main/java/com/ebay/classifieds/germany/MessageExtractor.java

@@ -0,0 +1,16 @@
+package com.ebay.classifieds.germany;
+
+import java.util.Stack;
+
+public class MessageExtractor {
+    /**
+     * extract the actual text of the mail from parameter <code>actualMail</code>. the second parameter, <code>history</code>
+     * will contain the previous messages in this conversation (from both people involved).
+     * <p>
+     * The stack will be filled with messages in the order they arrived. Meaning the first message of the conversation
+     * is added to the stack first. The <code>actualMail</code> will not be in the stack.
+     */
+    public String extractText(Mail actualMail, Stack<Mail> history) {
+        return actualMail.getMailContents();
+    }
+}

src/test/java/com/ebay/classifieds/germany/ExampleTest.java

@@ -0,0 +1,28 @@
+package com.ebay.classifieds.germany;
+
+import org.junit.Test;
+
+import java.io.IOException;
+import java.util.Stack;
+
+import static com.ebay.classifieds.germany.Mail.Role.BUYER;
+import static com.ebay.classifieds.germany.SampleReader.readFileContents;
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertThat;
+
+public class ExampleTest {
+
+    private MessageExtractor messageExtractor = new MessageExtractor();
+
+    @Test
+    public void stripsStandardTemplate() throws IOException {
+
+        Mail input = new Mail(
+                readFileContents("/sample-first-mail.txt"),
+                BUYER);
+
+        assertThat(messageExtractor.extractText(input, new Stack<Mail>()),
+                is("Hello! I just saw this ticket and wanted to ask if it is still available?"));
+    }
+
+}

src/test/java/com/ebay/classifieds/germany/SampleReader.java

@@ -0,0 +1,22 @@
+package com.ebay.classifieds.germany;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.Charset;
+
+public class SampleReader {
+    public static String readFileContents(String filename) {
+        try(InputStream i = SampleReader.class.getResourceAsStream(filename)) {
+            ByteArrayOutputStream output = new ByteArrayOutputStream();
+            byte[] buffer = new byte[100];
+            int bytesRead = 0;
+            while((bytesRead = i.read(buffer)) != -1) {
+                output.write(buffer, 0, bytesRead);
+            }
+            return new String(output.toByteArray(), Charset.forName("UTF-8"));
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}

src/test/resources/sample-first-mail.txt

@@ -0,0 +1,12 @@
+Dear User!
+
+Somebody wants to buy this item from you:
+'Ticket for the next game.'
+Ad Id: 46703318
+
+Message from: Max
+
+Hello! I just saw this ticket and wanted to ask if it is still available?
+
+Copyright © 2005-2014 eBay International AG. All rights reserved
+Help | Privacy | Terms of use |  Imprint |  Press |  Contact us