@@ -1,34 +1,44 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFoldable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE RankNTypes #-}
47{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE TemplateHaskell #-}
69module Network.API.Mandrill.Types where
710
8−import Network.API.Mandrill.Utils
9−import Test.QuickCheck
10−import Text.Email.Validate
11+import Control.Applicative
12+import Control.Monad (mzero)
1113import Data.Char
1214import Data.Maybe
1315import Data.Time
16+import Lens.Micro.TH (makeLenses)
17+import Network.API.Mandrill.Utils
18+import Test.QuickCheck
19+import Text.Email.Validate
1420#if MIN_VERSION_time(1,5,0)
15−import Data.Time.Format (TimeLocale, defaultTimeLocale)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
1622#else
17−import System.Locale (TimeLocale, defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
1824#endif
19−import qualified Data.ByteString as B
20−import qualified Data.ByteString.Base64 as Base64
21−import qualified Data.Text as T
22−import qualified Data.Text.Encoding as TL
23−import qualified Data.Text.Lazy as TL
24−import Control.Lens
25−import Data.Monoid
2625import Data.Aeson
27−import Data.Aeson.Types
2826import Data.Aeson.TH
29−import qualified Text.Blaze.Html as Blaze
27+import Data.Aeson.Types
28+import qualified Data.ByteString as B
29+import qualified Data.ByteString.Base64 as Base64
30+#if !MIN_VERSION_base(4,8,0)
31+import Data.Foldable
32+import Data.Traversable
33+#endif
34+import qualified Data.HashMap.Strict as H
35+import Data.Monoid
36+import qualified Data.Text as T
37+import qualified Data.Text.Encoding as TL
38+import qualified Data.Text.Lazy as TL
39+import qualified Text.Blaze.Html as Blaze
3040import qualified Text.Blaze.Html.Renderer.Text as Blaze
31−
41+import qualified Text.Email.Validate as TEV
3242
3343timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
3444#if MIN_VERSION_time(1,5,0)
@@ -39,11 +49,11 @@ timeParse = parseTime
3949
4050--------------------------------------------------------------------------------
4151data MandrillError = MandrillError {
42− _merr_status :: !T.Text
43− , _merr_code :: !Int
44− , _merr_name :: !T.Text
52+ _merr_status :: !T.Text
53+ , _merr_code :: !Int
54+ , _merr_name :: !T.Text
4555 , _merr_message :: !T.Text
46− } deriving Show
56+ } deriving (Show, Eq)
4757
4858makeLenses ''MandrillError
4959deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -68,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
6878 | RR_InvalidSender
6979 | RR_Invalid
7080 | RR_TestModeLimit
81+ | RR_Unsigned
7182 | RR_Rule deriving Show
7283
7384deriveJSON defaultOptions {
@@ -80,7 +91,7 @@ deriveJSON defaultOptions {
8091-- which can be either a success or a failure.
8192data MandrillResponse k =
8293 MandrillSuccess k
83− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
8495
8596instance FromJSON k => FromJSON (MandrillResponse k) where
8697 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -116,9 +127,9 @@ instance FromJSON MandrillEmail where
116127data MandrillRecipient = MandrillRecipient {
117128 _mrec_email :: MandrillEmail
118129 -- ^ The email address of the recipient
119− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
120131 -- ^ The optional display name to use for the recipient
121− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
122133 -- ^ The header type to use for the recipient.
123134 -- defaults to "to" if not provided
124135 } deriving Show
@@ -147,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
147158mkMandrillHtml :: Blaze.Html -> MandrillHtml
148159mkMandrillHtml = MandrillHtml
149160
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
164+#endif
165+
150166instance Monoid MandrillHtml where
151167 mempty = MandrillHtml mempty
152168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -169,17 +185,23 @@ type MandrillTags = T.Text
169185
170186
171187--------------------------------------------------------------------------------
172−type MandrillHeaders = Value
188+type MandrillHeaders = Object
173189
174190
175191--------------------------------------------------------------------------------
176−type MandrillVars = Value
177192
193+data MergeVar = MergeVar {
194+ _mv_name :: !T.Text
195+ , _mv_content :: Value
196+ } deriving Show
197+
198+makeLenses ''MergeVar
199+deriveJSON defaultOptions { fieldLabelModifier = drop 4 } ''MergeVar
178200
179201--------------------------------------------------------------------------------
180202data MandrillMergeVars = MandrillMergeVars {
181203 _mmvr_rcpt :: !T.Text
182− , _mmvr_vars :: [MandrillVars]
204+ , _mmvr_vars :: [MergeVar]
183205 } deriving Show
184206
185207makeLenses ''MandrillMergeVars
@@ -187,29 +209,33 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
187209
188210--------------------------------------------------------------------------------
189211data MandrillMetadata = MandrillMetadata {
190− _mmdt_rcpt :: !T.Text
191− , _mmdt_values :: MandrillVars
212+ _mmdt_rcpt :: !T.Text
213+ , _mmdt_values :: Object
192214 } deriving Show
193215
194216makeLenses ''MandrillMetadata
195217deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
196218
197219
198−newtype Base64ByteString = B64BS B.ByteString deriving Show
220+data Base64ByteString =
221+ EncodedB64BS B.ByteString
222+ -- ^ An already-encoded Base64 ByteString.
223+ | PlainBS B.ByteString
224+ -- ^ A plain Base64 ByteString which requires encoding.
225+ deriving Show
199226
200227instance ToJSON Base64ByteString where
201− toJSON (B64BS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
228+ toJSON (PlainBS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
229+ toJSON (EncodedB64BS bs) = String . TL.decodeUtf8 $ bs
202230
203231instance FromJSON Base64ByteString where
204− parseJSON (String v) = case Base64.decode (TL.encodeUtf8 v) of
205− Left err -> fail err
206− Right rs -> return $ B64BS rs
232+ parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
207233 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
208234
209235--------------------------------------------------------------------------------
210236data MandrillWebContent = MandrillWebContent {
211− _mwct_type :: !T.Text
212− , _mwct_name :: !T.Text
237+ _mwct_type :: !T.Text
238+ , _mwct_name :: !T.Text
213239 -- ^ [for images] the Content ID of the image
214240 -- - use <img src="cid:THIS_VALUE"> to reference the image
215241 -- in your HTML content
@@ -222,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
222248--------------------------------------------------------------------------------
223249-- | The information on the message to send
224250data MandrillMessage = MandrillMessage {
225− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
226252 -- ^ The full HTML content to be sent
227− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
228254 -- ^ Optional full text content to be sent
229− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
230256 -- ^ The message subject
231− , _mmsg_from_email :: MandrillEmail
257+ , _mmsg_from_email :: MandrillEmail
232258 -- ^ The sender email address
233− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
234260 -- ^ Optional from name to be used
235− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
236262 -- ^ A list of recipient information
237− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
238264 -- ^ optional extra headers to add to the message (most headers are allowed)
239− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
240266 -- ^ whether or not this message is important, and should be delivered ahead
241267 -- of non-important messages
242− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
243269 -- ^ whether or not to turn on open tracking for the message
244− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
245271 -- ^ whether or not to turn on click tracking for the message
246− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
247273 -- ^ whether or not to automatically generate a text part for messages that are not given text
248− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
249275 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
250− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
251277 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
252278 -- - only for HTML documents less than 256KB in size
253− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
254280 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
255− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
256282 -- ^ whether or not to expose all recipients in to "To" header for each email
257− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
258284 -- ^ set to false to remove content logging for sensitive emails
259− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
260286 -- ^ an optional address to receive an exact copy of each recipient's email
261− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
262288 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
263− , _mmsg_signing_domain :: Maybe Bool
264− -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
289+ , _mmsg_signing_domain :: Maybe Bool
290+ -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
265291 -- (for "via" or "on behalf of" in email clients)
266− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
267293 -- ^ a custom domain to use for the messages's return-path
268− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
269295 -- ^ whether to evaluate merge tags in the message.
270296 -- Will automatically be set to true if either merge_vars
271297 -- or global_merge_vars are provided.
272− , _mmsg_global_merge_vars :: [MandrillVars]
298+ , _mmsg_global_merge_vars :: [MergeVar]
273299 -- ^ global merge variables to use for all recipients. You can override these per recipient.
274− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
275301 -- ^ per-recipient merge variables, which override global merge variables with the same name.
276− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
277303 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
278304 -- though we only store the first 100 we see, so this should not be unique
279305 -- or change frequently. Tags should be 50 characters or less.
280306 -- Any tags starting with an underscore are reserved for internal use
281307 -- and will cause errors.
282− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
283309 -- ^ the unique id of a subaccount for this message
284310 -- - must already exist or will fail with an error
285− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
286312 -- ^ an array of strings indicating for which any matching URLs
287313 -- will automatically have Google Analytics parameters appended
288314 -- to their query string automatically.
@@ -290,17 +316,17 @@ data MandrillMessage = MandrillMessage {
290316 -- ^ optional string indicating the value to set for the utm_campaign
291317 -- tracking parameter. If this isn't provided the email's from address
292318 -- will be used instead.
293− , _mmsg_metadata :: MandrillVars
319+ , _mmsg_metadata :: Object
294320 -- ^ metadata an associative array of user metadata. Mandrill will store
295321 -- this metadata and make it available for retrieval.
296322 -- In addition, you can select up to 10 metadata fields to index
297323 -- and make searchable using the Mandrill search api.
298− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
299325 -- ^ Per-recipient metadata that will override the global values
300326 -- specified in the metadata parameter.
301− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
302328 -- ^ an array of supported attachments to add to the message
303− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
304330 -- ^ an array of embedded images to add to the message
305331 } deriving Show
306332
@@ -314,7 +340,7 @@ instance Arbitrary MandrillMessage where
314340 <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
315341 <*> pure Nothing
316342 <*> resize 2 arbitrary
317− <*> pure emptyObject
343+ <*> pure H.empty
318344 <*> pure Nothing
319345 <*> pure Nothing
320346 <*> pure Nothing
@@ -335,7 +361,7 @@ instance Arbitrary MandrillMessage where
335361 <*> pure Nothing
336362 <*> pure []
337363 <*> pure Nothing
338− <*> pure emptyObject
364+ <*> pure H.empty
339365 <*> pure []
340366 <*> pure []
341367 <*> pure []