[suppression_list] minor PR fixes and test suite

Author: Ashu Goel

lib/suppression_list.ex

@@ -1,12 +1,12 @@
 defmodule SparkPost.SuppressionList do
   @moduledoc """
   The SparkPost Suppression List API for working with suppression lists.
-  Use `SparkPost.SupressionList.search/1` to search through your account's suppression list.
+  Use `SparkPost.SuppressionList.search/1` to search through your account's suppression list.
 
   Check out the documentation for each function
   or use the [SparkPost API reference](https://developers.sparkpost.com/api/suppression_list.html) for details.
 
-  Returned by `SparkPost.SupressionList.search/1`.
+  Returned by `SparkPost.SuppressionList.search/1`.
     - %SparkPost.SuppressionList.SearchResult{}
   """
 
@@ -32,7 +32,12 @@ defmodule SparkPost.SuppressionList do
     response = Endpoint.request(:get, "suppression-list", %{}, %{}, [params: params], false)
     case response do
       %SparkPost.Endpoint.Response{results: body} ->
-        struct(SparkPost.SuppressionList.SearchResult, body)
+        mapped_results = Enum.map(body.results, fn res -> struct(SparkPost.SuppressionList.ListEntry, res) end)
+        %SparkPost.SuppressionList.SearchResult{
+          results: mapped_results,
+          links: body.links,
+          total_count: body.total_count
+        }
       _ -> response
     end
   end

lib/suppression_list/.list_entry.ex.swp

@@ -14,5 +14,7 @@ defmodule SparkPost.SuppressionList.ListEntry do
   defstruct recipient: :required,
     type: :required,
     source: nil,
-    description: nil
+    description: nil,
+    transactional: nil,
+    non_transactional: nil
 end

lib/suppression_list/list_entry.ex

@@ -9,5 +9,7 @@ defmodule SparkPost.SuppressionList.SearchResult do
    - total_count: Total number of results across all pages based on the query params.
   """
 
-  defstruct results: :required, links: :required, total_count: :required
+  defstruct results: :required,
+    links: :required,
+    total_count: :required
 end

lib/suppression_list/search_result.ex

@@ -0,0 +1,10 @@
+{
+    "results": [
+        {
+            "recipient": "test@marketing.com",
+            "type": "non_transactional"
+        }
+    ],
+    "links": [],
+    "total_count": 1
+}

test/.suppression_list_test.exs.swp

@@ -0,0 +1,19 @@
+{
+    "results": [
+        {
+            "recipient": "test@marketing.com",
+            "type": "non_transactional"
+        }
+    ],
+    "links": [
+        {
+            "href": "/currentlink",
+            "rel": "first"
+        },
+        {
+            "href": "/linkwithcursor",
+            "rel": "next"
+        }
+    ],
+    "total_count": 1
+}

test/data/suppressionsearch.json

@@ -0,0 +1,73 @@
+defmodule SparkPost.SuppressionListTest do
+  @moduledoc false
+
+  use ExUnit.Case, async: false
+
+  alias SparkPost.{MockServer, SuppressionList}
+  alias SparkPost.SuppressionList.{SearchResult, ListEntry}
+
+  import Mock
+
+  test_with_mock "SuppressionList.search succeeds with SuppressionList.SearchResult",
+    HTTPoison, [request: fn (method, url, body, headers, opts) ->
+      assert method == :get
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("suppressionsearch"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = SuppressionList.search()
+      assert %SearchResult{} = resp
+  end
+
+  test_with_mock "SuppressionList.search fails with Endpoint.Error", HTTPoison,
+    [request: MockServer.mk_fail] do
+      resp = SuppressionList.search()
+      assert %SparkPost.Endpoint.Error{} = resp
+  end
+
+  test_with_mock "SuppressionList.search creates ListEntry structs", HTTPoison,
+    [request: fn (method, url, body, headers, opts) ->
+      assert method == :get
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("suppressionsearch"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = SuppressionList.search()
+      assert %SearchResult{
+        results: [
+          %ListEntry{
+            recipient: "test@marketing.com",
+            type: "non_transactional",
+            source: nil,
+            description: nil,
+            non_transactional: nil
+          }
+        ],
+        links: [],
+        total_count: 1
+      } == resp
+  end
+
+  test_with_mock "SuppressionList.search parses out cursor info", HTTPoison,
+    [request: fn (method, url, body, headers, opts) ->
+      assert method == :get
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("suppressionsearch_links"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = SuppressionList.search()
+      assert %SearchResult{
+        results: [
+          %ListEntry{
+            recipient: "test@marketing.com",
+            type: "non_transactional",
+            source: nil,
+            description: nil,
+            non_transactional: nil
+          }
+        ],
+        links: [
+          %{href: "/currentlink", rel: "first"},
+          %{href: "/linkwithcursor", rel: "next"}
+        ],
+        total_count: 1
+      } == resp
+  end
+end