Fix incorrect header names in Webhook class (#20)

Fix minor problems in webhook class
- correct name of custom 'help-scout' headers
- add mockito to test harness
- create small unit test for checking of event header
- fix NPE in case ErrorStream is null

Author: sphinks

pom.xml

@@ -83,6 +83,12 @@
 			<version>1.3</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-core</artifactId>
+			<version>1.10.19</version>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 	<repositories>
 		<repository>

src/main/java/net/helpscout/api/ApiClient.java

@@ -1732,7 +1732,10 @@ private void checkStatusCode(HttpURLConnection conn, int expectedCode) throws Ap
 
     private String getDetailedErrorMessage(HttpURLConnection conn) throws IOException {
         InputStream is = conn.getErrorStream();
-        String json = IOUtils.toString(is, "UTF-8");
+        String json = "";
+        if (is != null) {
+            json = IOUtils.toString(is, "UTF-8");
+        }
 
         return StringUtils.isNotEmpty(json) ? new JsonFormatter().format(json) : null;
     }

src/main/java/net/helpscout/api/Webhook.java

@@ -31,7 +31,7 @@ private String getHeader(String headerName) {
      * @return string
      */
     public String getEventType() {
-        return this.getHeader("HTTP_X_HELPSCOUT_EVENT");        
+        return this.getHeader("X-HELPSCOUT-EVENT");
     }   
 
     public boolean isTestEvent() {
@@ -70,7 +70,7 @@ public boolean isValid() {
         String computed = generateSignature();
 
         if (computed != null) {
-            return computed.equals(getHeader("HTTP_X_HELPSCOUT_SIGNATURE"));            
+            return computed.equals(getHeader("X-HELPSCOUT-SIGNATURE"));
         }
         return false;
     }

src/test/java/net/helpscout/api/WebhookApiTest.java

@@ -0,0 +1,103 @@
+package net.helpscout.api;
+
+import lombok.SneakyThrows;
+import net.helpscout.api.model.Customer;
+import org.junit.Test;
+
+import javax.servlet.http.HttpServletRequest;
+import java.io.BufferedReader;
+import java.io.StringReader;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import static org.hamcrest.Matchers.equalTo;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.*;
+
+/**
+ * @Author: ivan
+ * Date: 22.03.16
+ * Time: 0:33
+ */
+public class WebhookApiTest {
+
+
+    /**
+     * Real webhook request contains such kind of headers:
+     *
+     * host: youcallback.domain.com
+     * user-agent: Help Scout/Webhooks
+     * accept-encoding: UTF-8
+     * content-type: application/json
+     * x-helpscout-event: customer.created
+     * x-helpscout-signature: qALfoJFZ/WVbevIxtFYKHJ86D8o=
+     * x-forwarded-proto: http
+     * x-forwarded-port: 80
+     * x-request-start: t=1458595138602884
+     * x-client-ip: 000.000.000.000
+     * content-length: 406
+     * x-forwarded-host: youcallback.domain.com
+     * x-forwarded-server: youcallback.domain.com
+     * connection: Keep-Alive
+     */
+    @Test
+    public void basicTestForCustomEventHeader() {
+
+        HttpServletRequest httpServletRequest = mock(HttpServletRequest.class);
+
+        when(httpServletRequest.getHeader("X-HELPSCOUT-EVENT")).thenReturn("customer.created");
+
+        Webhook webhook = new Webhook("SecretKey", httpServletRequest);
+
+        assertThat(webhook.getEventType(), equalTo("customer.created"));
+        assertTrue(webhook.isCustomerEvent());
+    }
+
+    /**
+     * Calculating of signature performed based on JSON data and compared to
+     * data in header 'x-helpscout-signature'.
+     * At file 'webhook_customer' located example structure of json send to webhook.
+     */
+    @Test
+    @SneakyThrows
+    public void basicTestForCheckIfRequestIsValid() {
+
+        HttpServletRequest httpServletRequest = mock(HttpServletRequest.class);
+        BufferedReader bufferedReader = new BufferedReader(new StringReader(readJsonDataToString("webhook_customer")));
+
+        when(httpServletRequest.getReader()).thenReturn(bufferedReader);
+        when(httpServletRequest.getHeader("x-helpscout-signature".toUpperCase())).thenReturn("gV91IzHpvzCSLYW+/QGAxfm7KOM=");
+
+        Webhook webhook = new Webhook("SecretKey", httpServletRequest);
+
+        assertTrue(webhook.isValid());
+    }
+
+    /**
+     * Simple test for getting customer object from Webhook class via JSON data
+     */
+    @Test
+    @SneakyThrows
+    public void basicTestForReadingJsonData() {
+
+        HttpServletRequest httpServletRequest = mock(HttpServletRequest.class);
+        BufferedReader bufferedReader = new BufferedReader(new StringReader(readJsonDataToString("webhook_customer")));
+
+        when(httpServletRequest.getReader()).thenReturn(bufferedReader);
+
+        Webhook webhook = new Webhook("SecretKey", httpServletRequest);
+        Customer customer = webhook.getCustomer();
+
+        assertThat(customer.getFirstName(), equalTo("First_Name"));
+        assertThat(customer.getLastName(), equalTo("Last_Name"));
+        assertThat(customer.getEmails().get(0).getValue(), equalTo("[email protected]"));
+    }
+
+    @SneakyThrows
+    private static String readJsonDataToString(String jsonFileName) {
+        Path pathToJsonData = Paths.get(ClassLoader.getSystemResource("responses/" + jsonFileName + ".json").toURI());
+        return new String(Files.readAllBytes(pathToJsonData), "UTF-8");
+    }
+}

src/test/resources/responses/webhook_customer.json

@@ -0,0 +1,27 @@
+{
+  "lastName":"Last_Name",
+  "photoType":null,
+  "modifiedAt":"2016-03-21T21:18:58Z",
+  "location":null,
+  "emails":[
+    {
+      "id": 98037223,
+      "location": "work",
+      "value": "[email protected]"
+    }
+  ],
+  "websites":null,
+  "phones":null,
+  "id":76688730,
+  "organization":null,
+  "address":null,
+  "createdAt":"2016-03-21T21:18:58Z",
+  "background":null,
+  "age":null,
+  "gender":null,
+  "socialProfiles":null,
+  "firstName":"First_Name",
+  "photoUrl":null,
+  "chats":null,
+  "jobTitle":null
+}