@@ -1,59 +1,39 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFoldable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE DeriveTraversable #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE RankNTypes #-}
73{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TemplateHaskell #-}
4+{-# LANGUAGE OverloadedStrings #-}
95module Network.API.Mandrill.Types where
106
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)
177import Network.API.Mandrill.Utils
8+import Network.API.Mandrill.Orphans()
189import Test.QuickCheck
1910import Text.Email.Validate
20−#if MIN_VERSION_time(1,5,0)
21−import Data.Time.Format (TimeLocale, defaultTimeLocale)
22−#else
23−import System.Locale (TimeLocale, defaultTimeLocale)
24−#endif
11+import Data.Char
12+import Data.Maybe
13+import Data.Time
14+import Control.Applicative
15+import System.Locale (defaultTimeLocale)
16+import qualified Data.ByteString as B
17+import qualified Data.ByteString.Base64 as Base64
18+import qualified Data.Text as T
19+import qualified Data.Text.Encoding as TL
20+import qualified Data.Text.Lazy as TL
21+import Control.Lens
22+import Data.Monoid
2523import Data.Aeson
26−import Data.Aeson.TH
2724import 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
25+import Data.Aeson.TH
26+import qualified Text.Blaze.Html as Blaze
4027import qualified Text.Blaze.Html.Renderer.Text as Blaze
41−import qualified Text.Email.Validate as TEV
4228
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
4929
5030--------------------------------------------------------------------------------
5131data MandrillError = MandrillError {
52− _merr_status :: !T.Text
53− , _merr_code :: !Int
54− , _merr_name :: !T.Text
32+ _merr_status :: !T.Text
33+ , _merr_code :: !Int
34+ , _merr_name :: !T.Text
5535 , _merr_message :: !T.Text
56− } deriving (Show, Eq)
36+ } deriving Show
5737
5838makeLenses ''MandrillError
5939deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -78,7 +58,6 @@ data MandrillRejectReason = RR_HardBounce
7858 | RR_InvalidSender
7959 | RR_Invalid
8060 | RR_TestModeLimit
81− | RR_Unsigned
8261 | RR_Rule deriving Show
8362
8463deriveJSON defaultOptions {
@@ -91,7 +70,7 @@ deriveJSON defaultOptions {
9170-- which can be either a success or a failure.
9271data MandrillResponse k =
9372 MandrillSuccess k
94− | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
73+ | MandrillFailure MandrillError deriving Show
9574
9675instance FromJSON k => FromJSON (MandrillResponse k) where
9776 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -109,27 +88,14 @@ data MandrillRecipientTag = To | Cc | Bcc deriving Show
10988deriveJSON defaultOptions { constructorTagModifier = map toLower } ''MandrillRecipientTag
11089
11190
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−
12591--------------------------------------------------------------------------------
12692-- | An array of recipient information.
12793data MandrillRecipient = MandrillRecipient {
128− _mrec_email :: MandrillEmail
94+ _mrec_email :: EmailAddress
12995 -- ^ The email address of the recipient
130− , _mrec_name :: Maybe T.Text
96+ , _mrec_name :: Maybe T.Text
13197 -- ^ The optional display name to use for the recipient
132− , _mrec_type :: Maybe MandrillRecipientTag
98+ , _mrec_type :: Maybe MandrillRecipientTag
13399 -- ^ The header type to use for the recipient.
134100 -- defaults to "to" if not provided
135101 } deriving Show
@@ -138,11 +104,11 @@ makeLenses ''MandrillRecipient
138104deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
139105
140106newRecipient :: EmailAddress -> MandrillRecipient
141−newRecipient email = MandrillRecipient (MandrillEmail email) Nothing Nothing
107+newRecipient email = MandrillRecipient email Nothing Nothing
142108
143109instance Arbitrary MandrillRecipient where
144110 arbitrary = pure MandrillRecipient {
145− _mrec_email = MandrillEmail $ fromJust (emailAddress "test@example.com")
111+ _mrec_email = fromJust (emailAddress "test@example.com")
146112 , _mrec_name = Nothing
147113 , _mrec_type = Nothing
148114 }
@@ -158,11 +124,6 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
158124mkMandrillHtml :: Blaze.Html -> MandrillHtml
159125mkMandrillHtml = MandrillHtml
160126
161−#if MIN_VERSION_base(4,11,0)
162−instance Semigroup MandrillHtml where
163− MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
164−#endif
165−
166127instance Monoid MandrillHtml where
167128 mempty = MandrillHtml mempty
168129 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -174,7 +135,7 @@ instance ToJSON MandrillHtml where
174135 toJSON (MandrillHtml h) = String . TL.toStrict . Blaze.renderHtml $ h
175136
176137instance FromJSON MandrillHtml where
177− parseJSON (String h) = return $ MandrillHtml (Blaze.preEscapedToHtml h)
138+ parseJSON (String h) = return $ MandrillHtml (Blaze.toHtml h)
178139 parseJSON v = typeMismatch "Expecting a String for MandrillHtml" v
179140
180141instance Arbitrary MandrillHtml where
@@ -185,23 +146,17 @@ type MandrillTags = T.Text
185146
186147
187148--------------------------------------------------------------------------------
188−type MandrillHeaders = Object
149+type MandrillHeaders = Value
189150
190151
191152--------------------------------------------------------------------------------
153+type MandrillVars = Value
192154
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
200155
201156--------------------------------------------------------------------------------
202157data MandrillMergeVars = MandrillMergeVars {
203158 _mmvr_rcpt :: !T.Text
204− , _mmvr_vars :: [MergeVar]
159+ , _mmvr_vars :: [MandrillVars]
205160 } deriving Show
206161
207162makeLenses ''MandrillMergeVars
@@ -209,33 +164,29 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
209164
210165--------------------------------------------------------------------------------
211166data MandrillMetadata = MandrillMetadata {
212− _mmdt_rcpt :: !T.Text
213− , _mmdt_values :: Object
167+ _mmdt_rcpt :: !T.Text
168+ , _mmdt_values :: MandrillVars
214169 } deriving Show
215170
216171makeLenses ''MandrillMetadata
217172deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
218173
219174
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
175+newtype Base64ByteString = B64BS B.ByteString deriving Show
226176
227177instance ToJSON Base64ByteString where
228− toJSON (PlainBS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
229− toJSON (EncodedB64BS bs) = String . TL.decodeUtf8 $ bs
178+ toJSON (B64BS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
230179
231180instance FromJSON Base64ByteString where
232− parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
181+ parseJSON (String v) = case Base64.decode (TL.encodeUtf8 v) of
182+ Left err -> fail err
183+ Right rs -> return $ B64BS rs
233184 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
234185
235186--------------------------------------------------------------------------------
236187data MandrillWebContent = MandrillWebContent {
237− _mwct_type :: !T.Text
238− , _mwct_name :: !T.Text
188+ _mwct_type :: !T.Text
189+ , _mwct_name :: !T.Text
239190 -- ^ [for images] the Content ID of the image
240191 -- - use <img src="cid:THIS_VALUE"> to reference the image
241192 -- in your HTML content
@@ -248,67 +199,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
248199--------------------------------------------------------------------------------
249200-- | The information on the message to send
250201data MandrillMessage = MandrillMessage {
251− _mmsg_html :: MandrillHtml
202+ _mmsg_html :: MandrillHtml
252203 -- ^ The full HTML content to be sent
253− , _mmsg_text :: Maybe T.Text
204+ , _mmsg_text :: Maybe T.Text
254205 -- ^ Optional full text content to be sent
255− , _mmsg_subject :: !T.Text
206+ , _mmsg_subject :: !T.Text
256207 -- ^ The message subject
257− , _mmsg_from_email :: MandrillEmail
208+ , _mmsg_from_email :: EmailAddress
258209 -- ^ The sender email address
259− , _mmsg_from_name :: Maybe T.Text
210+ , _mmsg_from_name :: Maybe T.Text
260211 -- ^ Optional from name to be used
261− , _mmsg_to :: [MandrillRecipient]
212+ , _mmsg_to :: [MandrillRecipient]
262213 -- ^ A list of recipient information
263− , _mmsg_headers :: MandrillHeaders
214+ , _mmsg_headers :: MandrillHeaders
264215 -- ^ optional extra headers to add to the message (most headers are allowed)
265− , _mmsg_important :: Maybe Bool
216+ , _mmsg_important :: Maybe Bool
266217 -- ^ whether or not this message is important, and should be delivered ahead
267218 -- of non-important messages
268− , _mmsg_track_opens :: Maybe Bool
219+ , _mmsg_track_opens :: Maybe Bool
269220 -- ^ whether or not to turn on open tracking for the message
270− , _mmsg_track_clicks :: Maybe Bool
221+ , _mmsg_track_clicks :: Maybe Bool
271222 -- ^ whether or not to turn on click tracking for the message
272− , _mmsg_auto_text :: Maybe Bool
223+ , _mmsg_auto_text :: Maybe Bool
273224 -- ^ whether or not to automatically generate a text part for messages that are not given text
274− , _mmsg_auto_html :: Maybe Bool
225+ , _mmsg_auto_html :: Maybe Bool
275226 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
276− , _mmsg_inline_css :: Maybe Bool
227+ , _mmsg_inline_css :: Maybe Bool
277228 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
278229 -- - only for HTML documents less than 256KB in size
279− , _mmsg_url_strip_qs :: Maybe Bool
230+ , _mmsg_url_strip_qs :: Maybe Bool
280231 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
281− , _mmsg_preserve_recipients :: Maybe Bool
232+ , _mmsg_preserve_recipients :: Maybe Bool
282233 -- ^ whether or not to expose all recipients in to "To" header for each email
283− , _mmsg_view_content_link :: Maybe Bool
234+ , _mmsg_view_content_link :: Maybe Bool
284235 -- ^ set to false to remove content logging for sensitive emails
285− , _mmsg_bcc_address :: Maybe T.Text
236+ , _mmsg_bcc_address :: Maybe T.Text
286237 -- ^ an optional address to receive an exact copy of each recipient's email
287− , _mmsg_tracking_domain :: Maybe T.Text
238+ , _mmsg_tracking_domain :: Maybe T.Text
288239 -- ^ 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
240+ , _mmsg_signing_domain :: Maybe Bool
241+ -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
291242 -- (for "via" or "on behalf of" in email clients)
292− , _mmsg_return_path_domain :: Maybe Bool
243+ , _mmsg_return_path_domain :: Maybe Bool
293244 -- ^ a custom domain to use for the messages's return-path
294− , _mmsg_merge :: Maybe Bool
245+ , _mmsg_merge :: Maybe Bool
295246 -- ^ whether to evaluate merge tags in the message.
296247 -- Will automatically be set to true if either merge_vars
297248 -- or global_merge_vars are provided.
298− , _mmsg_global_merge_vars :: [MergeVar]
249+ , _mmsg_global_merge_vars :: [MandrillVars]
299250 -- ^ global merge variables to use for all recipients. You can override these per recipient.
300− , _mmsg_merge_vars :: [MandrillMergeVars]
251+ , _mmsg_merge_vars :: [MandrillMergeVars]
301252 -- ^ per-recipient merge variables, which override global merge variables with the same name.
302− , _mmsg_tags :: [MandrillTags]
253+ , _mmsg_tags :: [MandrillTags]
303254 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
304255 -- though we only store the first 100 we see, so this should not be unique
305256 -- or change frequently. Tags should be 50 characters or less.
306257 -- Any tags starting with an underscore are reserved for internal use
307258 -- and will cause errors.
308− , _mmsg_subaccount :: Maybe T.Text
259+ , _mmsg_subaccount :: Maybe T.Text
309260 -- ^ the unique id of a subaccount for this message
310261 -- - must already exist or will fail with an error
311− , _mmsg_google_analytics_domains :: [T.Text]
262+ , _mmsg_google_analytics_domains :: [T.Text]
312263 -- ^ an array of strings indicating for which any matching URLs
313264 -- will automatically have Google Analytics parameters appended
314265 -- to their query string automatically.
@@ -316,17 +267,17 @@ data MandrillMessage = MandrillMessage {
316267 -- ^ optional string indicating the value to set for the utm_campaign
317268 -- tracking parameter. If this isn't provided the email's from address
318269 -- will be used instead.
319− , _mmsg_metadata :: Object
270+ , _mmsg_metadata :: MandrillVars
320271 -- ^ metadata an associative array of user metadata. Mandrill will store
321272 -- this metadata and make it available for retrieval.
322273 -- In addition, you can select up to 10 metadata fields to index
323274 -- and make searchable using the Mandrill search api.
324− , _mmsg_recipient_metadata :: [MandrillMetadata]
275+ , _mmsg_recipient_metadata :: [MandrillMetadata]
325276 -- ^ Per-recipient metadata that will override the global values
326277 -- specified in the metadata parameter.
327− , _mmsg_attachments :: [MandrillWebContent]
278+ , _mmsg_attachments :: [MandrillWebContent]
328279 -- ^ an array of supported attachments to add to the message
329− , _mmsg_images :: [MandrillWebContent]
280+ , _mmsg_images :: [MandrillWebContent]
330281 -- ^ an array of embedded images to add to the message
331282 } deriving Show
332283
@@ -337,10 +288,10 @@ instance Arbitrary MandrillMessage where
337288 arbitrary = MandrillMessage <$> arbitrary
338289 <*> pure Nothing
339290 <*> pure "Test Subject"
340− <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
291+ <*> pure (fromJust $ emailAddress "sender@example.com")
341292 <*> pure Nothing
342293 <*> resize 2 arbitrary
343− <*> pure H.empty
294+ <*> pure emptyObject
344295 <*> pure Nothing
345296 <*> pure Nothing
346297 <*> pure Nothing
@@ -361,24 +312,13 @@ instance Arbitrary MandrillMessage where
361312 <*> pure Nothing
362313 <*> pure []
363314 <*> pure Nothing
364− <*> pure H.empty
315+ <*> pure emptyObject
365316 <*> pure []
366317 <*> pure []
367318 <*> pure []
368319
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−
379320--------------------------------------------------------------------------------
380321type MandrillKey = T.Text
381−type MandrillTemplate = T.Text
382322
383323newtype MandrillDate = MandrillDate {
384324 fromMandrillDate :: UTCTime
@@ -389,6 +329,6 @@ instance ToJSON MandrillDate where
389329
390330instance FromJSON MandrillDate where
391331 parseJSON = withText "MandrillDate" $ \t ->
392− case timeParse defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
332+ case parseTime defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
393333 Just d -> pure $ MandrillDate d
394334 _ -> fail "could not parse Mandrill date"