@@ -1,59 +1,44 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFoldable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE DeriveTraversable #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE RankNTypes #-}
74{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TemplateHaskell #-}
5+{-# LANGUAGE OverloadedStrings #-}
96module Network.API.Mandrill.Types where
107
11−import Control.Applicative
12−import Control.Monad (mzero)
13−import Data.Char
14−import Data.Maybe
15−import Data.Time
16−import Lens.Micro.TH (makeLenses)
178import Network.API.Mandrill.Utils
9+import Network.API.Mandrill.Orphans()
1810import Test.QuickCheck
1911import Text.Email.Validate
12+import Data.Char
13+import Data.Maybe
14+import Data.Time
15+import Control.Applicative
2016#if MIN_VERSION_time(1,5,0)
21−import Data.Time.Format (TimeLocale, defaultTimeLocale)
17+import Data.Time.Format (defaultTimeLocale)
2218#else
23−import System.Locale (TimeLocale, defaultTimeLocale)
19+import System.Locale (defaultTimeLocale)
2420#endif
21+import qualified Data.ByteString as B
22+import qualified Data.ByteString.Base64 as Base64
23+import qualified Data.Text as T
24+import qualified Data.Text.Encoding as TL
25+import qualified Data.Text.Lazy as TL
26+import Control.Lens
27+import Data.Monoid
2528import Data.Aeson
26−import Data.Aeson.TH
2729import 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
30+import Data.Aeson.TH
31+import qualified Text.Blaze.Html as Blaze
4032import qualified Text.Blaze.Html.Renderer.Text as Blaze
41−import qualified Text.Email.Validate as TEV
4233
43−timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
44−#if MIN_VERSION_time(1,5,0)
45−timeParse = parseTimeM True
46−#else
47−timeParse = parseTime
48−#endif
4934
5035--------------------------------------------------------------------------------
5136data MandrillError = MandrillError {
52− _merr_status :: !T.Text
53− , _merr_code :: !Int
54− , _merr_name :: !T.Text
37+ _merr_status :: !T.Text
38+ , _merr_code :: !Int
39+ , _merr_name :: !T.Text
5540 , _merr_message :: !T.Text
56− } deriving (Show, Eq)
41+ } deriving Show
5742
5843makeLenses ''MandrillError
5944deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -78,7 +63,6 @@ data MandrillRejectReason = RR_HardBounce
7863 | RR_InvalidSender
7964 | RR_Invalid
8065 | RR_TestModeLimit
81− | RR_Unsigned
8266 | RR_Rule deriving Show
8367
8468deriveJSON defaultOptions {
@@ -91,7 +75,7 @@ deriveJSON defaultOptions {
9175-- which can be either a success or a failure.
9276data MandrillResponse k =
9377 MandrillSuccess k
94− | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
78+ | MandrillFailure MandrillError deriving Show
9579
9680instance FromJSON k => FromJSON (MandrillResponse k) where
9781 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -109,27 +93,14 @@ data MandrillRecipientTag = To | Cc | Bcc deriving Show
10993deriveJSON defaultOptions { constructorTagModifier = map toLower } ''MandrillRecipientTag
11094
11195
112−--------------------------------------------------------------------------------
113−newtype MandrillEmail = MandrillEmail EmailAddress deriving Show
114−
115−instance ToJSON MandrillEmail where
116− toJSON (MandrillEmail e) = String . TL.decodeUtf8 . toByteString $ e
117−
118−instance FromJSON MandrillEmail where
119− parseJSON (String s) = case validate (TL.encodeUtf8 s) of
120− Left err -> fail err
121− Right v -> return . MandrillEmail $ v
122− parseJSON o = typeMismatch "Expecting a String for MandrillEmail." o
123−
124−
12596--------------------------------------------------------------------------------
12697-- | An array of recipient information.
12798data MandrillRecipient = MandrillRecipient {
128− _mrec_email :: MandrillEmail
99+ _mrec_email :: EmailAddress
129100 -- ^ The email address of the recipient
130− , _mrec_name :: Maybe T.Text
101+ , _mrec_name :: Maybe T.Text
131102 -- ^ The optional display name to use for the recipient
132− , _mrec_type :: Maybe MandrillRecipientTag
103+ , _mrec_type :: Maybe MandrillRecipientTag
133104 -- ^ The header type to use for the recipient.
134105 -- defaults to "to" if not provided
135106 } deriving Show
@@ -138,11 +109,11 @@ makeLenses ''MandrillRecipient
138109deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
139110
140111newRecipient :: EmailAddress -> MandrillRecipient
141−newRecipient email = MandrillRecipient (MandrillEmail email) Nothing Nothing
112+newRecipient email = MandrillRecipient email Nothing Nothing
142113
143114instance Arbitrary MandrillRecipient where
144115 arbitrary = pure MandrillRecipient {
145− _mrec_email = MandrillEmail $ fromJust (emailAddress "test@example.com")
116+ _mrec_email = fromJust (emailAddress "test@example.com")
146117 , _mrec_name = Nothing
147118 , _mrec_type = Nothing
148119 }
@@ -158,11 +129,6 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
158129mkMandrillHtml :: Blaze.Html -> MandrillHtml
159130mkMandrillHtml = MandrillHtml
160131
161−#if MIN_VERSION_base(4,11,0)
162−instance Semigroup MandrillHtml where
163− MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
164−#endif
165−
166132instance Monoid MandrillHtml where
167133 mempty = MandrillHtml mempty
168134 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -185,23 +151,17 @@ type MandrillTags = T.Text
185151
186152
187153--------------------------------------------------------------------------------
188−type MandrillHeaders = Object
154+type MandrillHeaders = Value
189155
190156
191157--------------------------------------------------------------------------------
158+type MandrillVars = Value
192159
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
200160
201161--------------------------------------------------------------------------------
202162data MandrillMergeVars = MandrillMergeVars {
203163 _mmvr_rcpt :: !T.Text
204− , _mmvr_vars :: [MergeVar]
164+ , _mmvr_vars :: [MandrillVars]
205165 } deriving Show
206166
207167makeLenses ''MandrillMergeVars
@@ -209,33 +169,29 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
209169
210170--------------------------------------------------------------------------------
211171data MandrillMetadata = MandrillMetadata {
212− _mmdt_rcpt :: !T.Text
213− , _mmdt_values :: Object
172+ _mmdt_rcpt :: !T.Text
173+ , _mmdt_values :: MandrillVars
214174 } deriving Show
215175
216176makeLenses ''MandrillMetadata
217177deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
218178
219179
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
180+newtype Base64ByteString = B64BS B.ByteString deriving Show
226181
227182instance ToJSON Base64ByteString where
228− toJSON (PlainBS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
229− toJSON (EncodedB64BS bs) = String . TL.decodeUtf8 $ bs
183+ toJSON (B64BS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
230184
231185instance FromJSON Base64ByteString where
232− parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
186+ parseJSON (String v) = case Base64.decode (TL.encodeUtf8 v) of
187+ Left err -> fail err
188+ Right rs -> return $ B64BS rs
233189 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
234190
235191--------------------------------------------------------------------------------
236192data MandrillWebContent = MandrillWebContent {
237− _mwct_type :: !T.Text
238− , _mwct_name :: !T.Text
193+ _mwct_type :: !T.Text
194+ , _mwct_name :: !T.Text
239195 -- ^ [for images] the Content ID of the image
240196 -- - use <img src="cid:THIS_VALUE"> to reference the image
241197 -- in your HTML content
@@ -248,67 +204,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
248204--------------------------------------------------------------------------------
249205-- | The information on the message to send
250206data MandrillMessage = MandrillMessage {
251− _mmsg_html :: MandrillHtml
207+ _mmsg_html :: MandrillHtml
252208 -- ^ The full HTML content to be sent
253− , _mmsg_text :: Maybe T.Text
209+ , _mmsg_text :: Maybe T.Text
254210 -- ^ Optional full text content to be sent
255− , _mmsg_subject :: !T.Text
211+ , _mmsg_subject :: !T.Text
256212 -- ^ The message subject
257− , _mmsg_from_email :: MandrillEmail
213+ , _mmsg_from_email :: EmailAddress
258214 -- ^ The sender email address
259− , _mmsg_from_name :: Maybe T.Text
215+ , _mmsg_from_name :: Maybe T.Text
260216 -- ^ Optional from name to be used
261− , _mmsg_to :: [MandrillRecipient]
217+ , _mmsg_to :: [MandrillRecipient]
262218 -- ^ A list of recipient information
263− , _mmsg_headers :: MandrillHeaders
219+ , _mmsg_headers :: MandrillHeaders
264220 -- ^ optional extra headers to add to the message (most headers are allowed)
265− , _mmsg_important :: Maybe Bool
221+ , _mmsg_important :: Maybe Bool
266222 -- ^ whether or not this message is important, and should be delivered ahead
267223 -- of non-important messages
268− , _mmsg_track_opens :: Maybe Bool
224+ , _mmsg_track_opens :: Maybe Bool
269225 -- ^ whether or not to turn on open tracking for the message
270− , _mmsg_track_clicks :: Maybe Bool
226+ , _mmsg_track_clicks :: Maybe Bool
271227 -- ^ whether or not to turn on click tracking for the message
272− , _mmsg_auto_text :: Maybe Bool
228+ , _mmsg_auto_text :: Maybe Bool
273229 -- ^ whether or not to automatically generate a text part for messages that are not given text
274− , _mmsg_auto_html :: Maybe Bool
230+ , _mmsg_auto_html :: Maybe Bool
275231 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
276− , _mmsg_inline_css :: Maybe Bool
232+ , _mmsg_inline_css :: Maybe Bool
277233 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
278234 -- - only for HTML documents less than 256KB in size
279− , _mmsg_url_strip_qs :: Maybe Bool
235+ , _mmsg_url_strip_qs :: Maybe Bool
280236 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
281− , _mmsg_preserve_recipients :: Maybe Bool
237+ , _mmsg_preserve_recipients :: Maybe Bool
282238 -- ^ whether or not to expose all recipients in to "To" header for each email
283− , _mmsg_view_content_link :: Maybe Bool
239+ , _mmsg_view_content_link :: Maybe Bool
284240 -- ^ set to false to remove content logging for sensitive emails
285− , _mmsg_bcc_address :: Maybe T.Text
241+ , _mmsg_bcc_address :: Maybe T.Text
286242 -- ^ an optional address to receive an exact copy of each recipient's email
287− , _mmsg_tracking_domain :: Maybe T.Text
243+ , _mmsg_tracking_domain :: Maybe T.Text
288244 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
289− , _mmsg_signing_domain :: Maybe Bool
290− -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
245+ , _mmsg_signing_domain :: Maybe Bool
246+ -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
291247 -- (for "via" or "on behalf of" in email clients)
292− , _mmsg_return_path_domain :: Maybe Bool
248+ , _mmsg_return_path_domain :: Maybe Bool
293249 -- ^ a custom domain to use for the messages's return-path
294− , _mmsg_merge :: Maybe Bool
250+ , _mmsg_merge :: Maybe Bool
295251 -- ^ whether to evaluate merge tags in the message.
296252 -- Will automatically be set to true if either merge_vars
297253 -- or global_merge_vars are provided.
298− , _mmsg_global_merge_vars :: [MergeVar]
254+ , _mmsg_global_merge_vars :: [MandrillVars]
299255 -- ^ global merge variables to use for all recipients. You can override these per recipient.
300− , _mmsg_merge_vars :: [MandrillMergeVars]
256+ , _mmsg_merge_vars :: [MandrillMergeVars]
301257 -- ^ per-recipient merge variables, which override global merge variables with the same name.
302− , _mmsg_tags :: [MandrillTags]
258+ , _mmsg_tags :: [MandrillTags]
303259 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
304260 -- though we only store the first 100 we see, so this should not be unique
305261 -- or change frequently. Tags should be 50 characters or less.
306262 -- Any tags starting with an underscore are reserved for internal use
307263 -- and will cause errors.
308− , _mmsg_subaccount :: Maybe T.Text
264+ , _mmsg_subaccount :: Maybe T.Text
309265 -- ^ the unique id of a subaccount for this message
310266 -- - must already exist or will fail with an error
311− , _mmsg_google_analytics_domains :: [T.Text]
267+ , _mmsg_google_analytics_domains :: [T.Text]
312268 -- ^ an array of strings indicating for which any matching URLs
313269 -- will automatically have Google Analytics parameters appended
314270 -- to their query string automatically.
@@ -316,17 +272,17 @@ data MandrillMessage = MandrillMessage {
316272 -- ^ optional string indicating the value to set for the utm_campaign
317273 -- tracking parameter. If this isn't provided the email's from address
318274 -- will be used instead.
319− , _mmsg_metadata :: Object
275+ , _mmsg_metadata :: MandrillVars
320276 -- ^ metadata an associative array of user metadata. Mandrill will store
321277 -- this metadata and make it available for retrieval.
322278 -- In addition, you can select up to 10 metadata fields to index
323279 -- and make searchable using the Mandrill search api.
324− , _mmsg_recipient_metadata :: [MandrillMetadata]
280+ , _mmsg_recipient_metadata :: [MandrillMetadata]
325281 -- ^ Per-recipient metadata that will override the global values
326282 -- specified in the metadata parameter.
327− , _mmsg_attachments :: [MandrillWebContent]
283+ , _mmsg_attachments :: [MandrillWebContent]
328284 -- ^ an array of supported attachments to add to the message
329− , _mmsg_images :: [MandrillWebContent]
285+ , _mmsg_images :: [MandrillWebContent]
330286 -- ^ an array of embedded images to add to the message
331287 } deriving Show
332288
@@ -337,10 +293,10 @@ instance Arbitrary MandrillMessage where
337293 arbitrary = MandrillMessage <$> arbitrary
338294 <*> pure Nothing
339295 <*> pure "Test Subject"
340− <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
296+ <*> pure (fromJust $ emailAddress "sender@example.com")
341297 <*> pure Nothing
342298 <*> resize 2 arbitrary
343− <*> pure H.empty
299+ <*> pure emptyObject
344300 <*> pure Nothing
345301 <*> pure Nothing
346302 <*> pure Nothing
@@ -361,24 +317,13 @@ instance Arbitrary MandrillMessage where
361317 <*> pure Nothing
362318 <*> pure []
363319 <*> pure Nothing
364− <*> pure H.empty
320+ <*> pure emptyObject
365321 <*> pure []
366322 <*> pure []
367323 <*> pure []
368324
369−--------------------------------------------------------------------------------
370−-- | Key value pair for replacing content in templates via 'Editable Regions'
371−data MandrillTemplateContent = MandrillTemplateContent {
372− _mtc_name :: T.Text
373− , _mtc_content :: T.Text
374− } deriving Show
375−
376−makeLenses ''MandrillTemplateContent
377−deriveJSON defaultOptions { fieldLabelModifier = drop 5 } ''MandrillTemplateContent
378−
379325--------------------------------------------------------------------------------
380326type MandrillKey = T.Text
381−type MandrillTemplate = T.Text
382327
383328newtype MandrillDate = MandrillDate {
384329 fromMandrillDate :: UTCTime
@@ -389,6 +334,6 @@ instance ToJSON MandrillDate where
389334
390335instance FromJSON MandrillDate where
391336 parseJSON = withText "MandrillDate" $ \t ->
392− case timeParse defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
337+ case parseTimeM True defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
393338 Just d -> pure $ MandrillDate d
394339 _ -> fail "could not parse Mandrill date"