Merge pull request #32 from asgoel/ISSUE-31

Issue 31 - Add template preview API

Author: ewandennis

lib/content/inline.ex

@@ -25,4 +25,12 @@ defmodule SparkPost.Content.Inline do
     html: nil,
     attachments: nil,
     inline_images: nil
+
+  @doc """
+  Convert a raw "from" field into a %SparkPost.Address{} object.
+  """
+  def convert_from_field(%SparkPost.Endpoint.Error{} = content), do: content
+  def convert_from_field(%__MODULE__{} = content) do
+    %{content | from: SparkPost.Address.to_address(content.from)}
+  end
 end

lib/endpoint.ex

@@ -42,7 +42,7 @@ defmodule SparkPost.Endpoint do
       else
         Map.merge(headers, %{"Content-Type": "application/json"})
       end
-      |> Map.merge(base_request_headers)
+      |> Map.merge(base_request_headers())
 
     request_options = options
     |> Keyword.put(:timeout, Application.get_env(:sparkpost, :http_timeout, 30000))

lib/mockserver.ex

@@ -18,19 +18,19 @@ defmodule SparkPost.MockServer do
   end
 
   def mk_resp do
-    SparkPost.MockServer.mk_http_resp(200, create_json)
+    SparkPost.MockServer.mk_http_resp(200, create_json())
   end
 
   def mk_fail do
-    SparkPost.MockServer.mk_http_resp(400, create_fail_json)
+    SparkPost.MockServer.mk_http_resp(400, create_fail_json())
   end
 
   def mk_list do
-    SparkPost.MockServer.mk_http_resp(200, list_json)
+    SparkPost.MockServer.mk_http_resp(200, list_json())
   end
 
   def mk_get do
-    SparkPost.MockServer.mk_http_resp(200, get_json)
+    SparkPost.MockServer.mk_http_resp(200, get_json())
   end
 
   def mk_http_resp(status_code, body) do

lib/template.ex

@@ -0,0 +1,47 @@
+defmodule SparkPost.Template do
+  @moduledoc """
+  The SparkPost Template API for working with templates. Use `SparkPost.Template.preview/2` to
+  preview a template.
+
+  Check out the documentation for each function
+  or use the [SparkPost API reference](https://developers.sparkpost.com/api/templates.html) for details.
+
+  Returned by `SparkPost.template.preview/2`.
+    -from
+      -email
+      -name
+    -subject
+    -reply_to
+    -text
+    -html
+    -headers
+  """
+
+  alias SparkPost.Endpoint
+
+  @doc """
+  Generate a preview of an existing template.
+
+  ### Parameters
+  - %SparkPost.Content.TemplateRef{} consisting of:
+    - template_id: The string id of the template to retrieve a preview or.
+    - use_draft_template: If true, previews the most recent draft template.
+        If false, previews the most recent published template. If nil,
+        previews the most recently template version period.
+  - substitution_data: k,v map consisting of substituions. See the
+      [SparkPost Substitutions Reference](https://developers.sparkpost.com/api/substitutions-reference.html)
+      for more details.
+  """
+  def preview(%SparkPost.Content.TemplateRef{} = template, substitution_data) do
+    qs = if is_nil(template.use_draft_template) do
+      ""
+    else
+      "?draft=#{template.use_draft_template}"
+    end
+    body = %{substitution_data: substitution_data}
+    :post
+    |> Endpoint.request("/templates/#{template.template_id}/preview#{qs}", body)
+    |> Endpoint.marshal_response(SparkPost.Content.Inline)
+    |> SparkPost.Content.Inline.convert_from_field
+  end
+end

mix.exs

@@ -9,8 +9,8 @@ defmodule SparkPost.Mixfile do
      start_permanent: Mix.env == :prod,
      source_url: "https://github.com/SparkPost/elixir-sparkpost",
      description: "The official Elixir package for the SparkPost API",
-     package: package,
-     deps: deps,
+     package: package(),
+     deps: deps(),
      docs: [
        extras: ["README.md", "CONTRIBUTING.md", "CHANGELOG.md"]
      ],

mix.lock

@@ -5,16 +5,16 @@
   "ex_doc": {:hex, :ex_doc, "0.14.3", "e61cec6cf9731d7d23d254266ab06ac1decbb7651c3d1568402ec535d387b6f7", [:mix], [{:earmark, "~> 1.0", [hex: :earmark, optional: false]}]},
   "excoveralls": {:hex, :excoveralls, "0.5.7", "5d26e4a7cdf08294217594a1b0643636accc2ad30e984d62f1d166f70629ff50", [:mix], [{:exjsx, "~> 3.0", [hex: :exjsx, optional: false]}, {:hackney, ">= 0.12.0", [hex: :hackney, optional: false]}]},
   "exjsx": {:hex, :exjsx, "3.2.1", "1bc5bf1e4fd249104178f0885030bcd75a4526f4d2a1e976f4b428d347614f0f", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, optional: false]}]},
-  "hackney": {:hex, :hackney, "1.6.3", "d489d7ca2d4323e307bedc4bfe684323a7bf773ecfd77938f3ee8074e488e140", [:rebar3, :mix], [{:certifi, "0.7.0", [hex: :certifi, optional: false]}, {:idna, "1.2.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
+  "hackney": {:hex, :hackney, "1.6.3", "d489d7ca2d4323e307bedc4bfe684323a7bf773ecfd77938f3ee8074e488e140", [:mix, :rebar3], [{:certifi, "0.7.0", [hex: :certifi, optional: false]}, {:idna, "1.2.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
   "httpoison": {:hex, :httpoison, "0.9.2", "a211a8e87403a043c41218e64df250d321f236ac57f786c6a0ccf3e9e817c819", [:mix], [{:hackney, "~> 1.6.0", [hex: :hackney, optional: false]}]},
   "httpotion": {:hex, :httpotion, "2.1.0", "3fe84fbd13d4560c2514da656d022b1191a079178ee4992d245fc3c33c01ee18", [:mix], []},
   "ibrowse": {:git, "https://github.com/cmullaparthi/ibrowse.git", "ea3305d21f37eced4fac290f64b068e56df7de80", [tag: "v4.1.2"]},
   "idna": {:hex, :idna, "1.2.0", "ac62ee99da068f43c50dc69acf700e03a62a348360126260e87f2b54eced86b2", [:rebar3], []},
   "jsx": {:hex, :jsx, "2.8.0", "749bec6d205c694ae1786d62cea6cc45a390437e24835fd16d12d74f07097727", [:mix, :rebar], []},
-  "meck": {:hex, :meck, "0.8.4", "59ca1cd971372aa223138efcf9b29475bde299e1953046a0c727184790ab1520", [:rebar, :make], []},
+  "meck": {:hex, :meck, "0.8.4", "59ca1cd971372aa223138efcf9b29475bde299e1953046a0c727184790ab1520", [:make, :rebar], []},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], []},
   "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], []},
   "mock": {:hex, :mock, "0.2.0", "5991877be6bb514b647dbd6f4869bc12bd7f2829df16e86c98d6108f966d34d7", [:mix], [{:meck, "~> 0.8.2", [hex: :meck, optional: false]}]},
   "poison": {:hex, :poison, "3.0.0", "625ebd64d33ae2e65201c2c14d6c85c27cc8b68f2d0dd37828fde9c6920dd131", [:mix], []},
-  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:rebar, :make], []},
+  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], []},
   "ssl_verify_hostname": {:hex, :ssl_verify_hostname, "1.0.5", "2e73e068cd6393526f9fa6d399353d7c9477d6886ba005f323b592d389fb47be", [:make], []}}

test/data/previewtemplate.json

@@ -0,0 +1,15 @@
+{
+    "results": {
+        "from": {
+            "email": "marketing@bounces.company.example",
+            "name": "Example Company Marketing"
+        },
+        "subject": "Summer deals for Natalie",
+        "reply_to": "Summer deals <summer_deals@company.example>",
+        "text": "Check out these deals Natalie!",
+        "html": "<b>Check out these deals Natalie!</b>",
+        "headers": {
+            "X-Customer-Campaign-ID": "Summer2014"
+        }
+    }
+}

test/data/previewtemplate_simpleemail.json

@@ -0,0 +1,12 @@
+{
+    "results": {
+        "from": "marketing@bounces.company.example",
+        "subject": "Summer deals for Natalie",
+        "reply_to": "Summer deals <summer_deals@company.example>",
+        "text": "Check out these deals Natalie!",
+        "html": "<b>Check out these deals Natalie!</b>",
+        "headers": {
+            "X-Customer-Campaign-ID": "Summer2014"
+        }
+    }
+}

test/endpoint_test.exs

@@ -9,8 +9,8 @@ defmodule SparkPost.EndpointTest do
   defmodule Headers do
     def for_method(method) do
       cond do
-        method in [:post, :put] -> Map.merge(for_body_requests, core)
-        true -> core
+        method in [:post, :put] -> Map.merge(for_body_requests(), core())
+        true -> core()
       end
     end
 

test/template_test.exs

@@ -0,0 +1,80 @@
+defmodule SparkPost.TemplateTest do
+  use ExUnit.Case, async: false
+
+  alias SparkPost.Content.{TemplateRef, Inline}
+  alias SparkPost.{Endpoint, MockServer, Template}
+
+  import Mock
+
+  defmodule TestStruct do
+    def basic_template do
+      %TemplateRef{template_id: "TEMPLATE_ID", use_draft_template: nil}
+    end
+
+    def template_with_draft do
+      %TemplateRef{template_id: "TEMPLATE_ID", use_draft_template: true}
+    end
+
+    def substitution_data do
+      %{
+        key1: "value1",
+        key2: "value2"
+      }
+    end
+  end
+
+  test_with_mock "Template.preview succeeds with Content.Inline",
+    HTTPoison, [request: fn (method, url, body, headers, opts) ->
+      assert method == :post
+      # draft not set
+      assert String.ends_with?(url, "preview")
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("previewtemplate"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = Template.preview(TestStruct.basic_template(), TestStruct.substitution_data())
+      assert %Inline{} = resp
+  end
+
+  test_with_mock "Template.preview succeeds with Content.Inline and draft set",
+    HTTPoison, [request: fn (method, url, body, headers, opts) ->
+      assert method == :post
+      assert String.ends_with?(url, "preview?draft=true")
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("previewtemplate"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = Template.preview(TestStruct.template_with_draft(), TestStruct.substitution_data())
+      assert %Inline{} = resp
+  end
+
+  test_with_mock "Template.preview fails with Endpoint.Error", HTTPoison,
+    [request: MockServer.mk_fail] do
+      resp = Template.preview(TestStruct.basic_template(), TestStruct.substitution_data())
+      assert %Endpoint.Error{} = resp
+  end
+
+  test_with_mock "Template.preview unmarshals complex from field correctly", HTTPoison,
+    [request: fn (method, url, body, headers, opts) ->
+      assert method == :post
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("previewtemplate"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = Template.preview(TestStruct.basic_template(), TestStruct.substitution_data())
+      assert %SparkPost.Address{
+        name: "Example Company Marketing",
+        "email": "marketing@bounces.company.example"
+      } == resp.from
+  end
+
+  test_with_mock "Template.preview unmarshals simple from field correctly", HTTPoison,
+    [request: fn (method, url, body, headers, opts) ->
+      assert method == :post
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("previewtemplate_simpleemail"))
+      fun.(method, url, body, headers, opts)
+    end] do
+      resp = Template.preview(TestStruct.basic_template(), TestStruct.substitution_data())
+      assert %SparkPost.Address{
+        name: nil,
+        "email": "marketing@bounces.company.example"
+      } == resp.from
+  end
+end