Merge pull request #37 from asgoel/suppression_list_search

Suppression list search

Author: ewandennis

.gitignore

@@ -4,3 +4,4 @@
 /doc
 erl_crash.dump
 *.ez
+*.swp

lib/endpoint.ex

@@ -32,7 +32,7 @@ defmodule SparkPost.Endpoint do
           "id" => "102258558346809186", "name" => "102258558346809186",
           "state" => "Success"}, ...], status_code: 200}
   """
-  def request(method, endpoint, body \\ %{},  headers \\ %{}, options \\ []) do
+  def request(method, endpoint, body \\ %{},  headers \\ %{}, options \\ [], decode_results \\ true) do
     url = Application.get_env(:sparkpost, :api_endpoint, @default_endpoint) <> endpoint
 
     {:ok, request_body} = encode_request_body(body)
@@ -49,7 +49,7 @@ defmodule SparkPost.Endpoint do
     |> Keyword.put(:recv_timeout, Application.get_env(:sparkpost, :http_recv_timeout, 8000))
 
     HTTPoison.request(method, url, request_body, request_headers, request_options)
-    |> handle_response
+    |> handle_response(decode_results)
   end
 
   def marshal_response(response, struct_type, subkey\\nil)
@@ -70,12 +70,16 @@ defmodule SparkPost.Endpoint do
     response
   end
 
-  defp handle_response({:ok, %HTTPoison.Response{status_code: code, body: body}}) when code >= 200 and code < 300 do
+  defp handle_response({:ok, %HTTPoison.Response{status_code: code, body: body}}, decode_results) when code >= 200 and code < 300 do
     decoded_body = decode_response_body(body)
-    %SparkPost.Endpoint.Response{status_code: 200, results: decoded_body.results}
+    if decode_results do
+      %SparkPost.Endpoint.Response{status_code: 200, results: decoded_body.results}
+    else
+      %SparkPost.Endpoint.Response{status_code: 200, results: decoded_body}
+    end
   end
 
-  defp handle_response({:ok, %HTTPoison.Response{status_code: code, body: body}}) when code >= 400 do
+  defp handle_response({:ok, %HTTPoison.Response{status_code: code, body: body}}, _decode_results) when code >= 400 do
     decoded_body = decode_response_body(body)
     if Map.has_key?(decoded_body, :errors) do
       %SparkPost.Endpoint.Error{status_code: code, errors: decoded_body.errors}

lib/suppression_list.ex

@@ -0,0 +1,44 @@
+defmodule SparkPost.SuppressionList do
+  @moduledoc """
+  The SparkPost Suppression List API for working with suppression lists.
+  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.SuppressionList.search/1`.
+    - %SparkPost.SuppressionList.SearchResult{}
+  """
+
+  alias SparkPost.Endpoint
+
+  @doc """
+  Execute a search of the suppression list based on the provided
+  parameters.
+
+  ### Possible Parameters
+   - to: Datetime the entries were last updated, in the format YYYY-MM-DDTHH:mm:ssZ (defaults to now)
+   - from: Datetime the entries were last updated, in the format YYYY-MM-DDTHH:mm:ssZ
+   - domain: Domain of entries to include in search
+   - cursor: Results cursor (first query should use the value "initial")
+   - per_page: Max number of results to return per page (between 1 and 10,000)
+   - page: Results page number to return. Use if looking for less than 10,000 results. Otherwise
+       use the cursor param.
+   - sources: Sources of entries to include in the search.
+   - types: Types of entries to include in the search (transactional and/or non_transactional)
+   - description: Description of entries to include in the search.
+  """
+  def search(params \\ []) do
+    response = Endpoint.request(:get, "suppression-list", %{}, %{}, [params: params], false)
+    case response do
+      %SparkPost.Endpoint.Response{results: 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
+end

lib/suppression_list/list_entry.ex

@@ -0,0 +1,20 @@
+defmodule SparkPost.SuppressionList.ListEntry do
+  @moduledoc """
+  SparkPost representation of a suppression list entry.
+
+  ## Fields
+   - recipient: Email address that was suppressed
+   - type: Type of suppression record (transactional or non_transactional)
+   - source: Source responsible for inserting the list entry. Can be one of
+      "Spam Complaint", "List Unsubscribe", "Bounce Rule", "Unsubscribe Link",
+      "Manually Added", or "Compliance"
+   - description: explanation of suppression
+  """
+
+  defstruct recipient: :required,
+    type: :required,
+    source: nil,
+    description: nil,
+    transactional: nil,
+    non_transactional: nil
+end

lib/suppression_list/search_result.ex

@@ -0,0 +1,15 @@
+defmodule SparkPost.SuppressionList.SearchResult do
+  @moduledoc """
+  SparkPost representation of a suppression list search result.
+
+  ## Fields
+   - results: List of %SparkPost.SuppressionList.ListEntry{} objects.
+   - links: Links to the first query in the chain and next query to be made for cursor
+      based pagination.
+   - total_count: Total number of results across all pages based on the query params.
+  """
+
+  defstruct results: :required,
+    links: :required,
+    total_count: :required
+end

test/data/suppressionsearch.json

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

test/data/suppressionsearch_links.json

@@ -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/suppression_list_test.exs

@@ -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