8622d4d...master · typeable/mandrill

.gitignore+1

since splitsnapshots

unifiedsplit

@@ -3,3 +3,4 @@ dist

3cabal.sandbox.config

4shell.nix

5.stack-work

6+tags

.travis.yml+4−4

@@ -5,17 +5,17 @@ notifications:

5 email: false

6

7env:

8− - GHCVER=7.6.2 CABALVER=1.16

9 - GHCVER=7.6.3 CABALVER=1.16

8 - GHCVER=7.6.3 CABALVER=1.16

10 - GHCVER=7.8.2 CABALVER=1.18

9 - GHCVER=7.8.2 CABALVER=1.18

11 - GHCVER=7.8.3 CABALVER=1.18

10 - GHCVER=7.8.3 CABALVER=1.18

12− - GHCVER=7.10.1 CABALVER=1.22

13 - GHCVER=7.10.2 CABALVER=1.22

11 - GHCVER=7.10.2 CABALVER=1.22

12+ - GHCVER=8.0.1 CABALVER=1.22

14− - GHCVER=head CABALVER=1.20

13+ - GHCVER=head CABALVER=1.22

15

14

16matrix:

15matrix:

17 allow_failures:

16 allow_failures:

17+ - env: GHCVER=8.0.1 CABALVER=1.22

18− - env: GHCVER=head CABALVER=1.20

18+ - env: GHCVER=head CABALVER=1.22

19

20before_install:

21 - travis_retry sudo add-apt-repository -y ppa:hvr/ghc

README.md+36

@@ -8,6 +8,34 @@ the [Mandrill](http://mandrillapp.com) transactional email service.

8

9# Changelog

10

11+## Version 0.5.3.5

12+

13+* Replaced dependency on lens with microlens (Courtesy of @tom-bop)

14+

15+## Version 0.5.3.3

16+

17+* Relaxed upper bound on Aeson (see: fpco/stackage/issues/3337)

18+

19+## Version 0.5.3.2

20+

21+* Relaxed upper bound on Aeson (see: fpco/stackage/issues/2449)

22+

23+## Version 0.5.3.1

24+

25+* Relaxed upper bound on Aeson (see: fpco/stackage/issues/2177 )

26+

27+## Version 0.5.3.0

28+

29+* Added support for webhooks (thanks to @mwotton).

30+

31+## Version 0.5.2.3

32+

33+* Added support for aeson-1.0.0.0 by relaxing its upper bound.

34+

35+## Version 0.5.2.2

36+

37+* Added support for QuickCheck-2.9 by relaxing its upper bound.

38+

11## Version 0.5.2.1

39## Version 0.5.2.1

12

40

13* Added `Functor`, `Foldable` and `Traversable` instances to `MandrillResponse` (Courtesy of @dredozubov)

41* Added `Functor`, `Foldable` and `Traversable` instances to `MandrillResponse` (Courtesy of @dredozubov)

@@ -77,9 +105,17 @@ main = do

77 + ~~ping.json~~ (as **doesn't return valid json!**)

105 + ~~ping.json~~ (as **doesn't return valid json!**)

78 + ping2.json

106 + ping2.json

79 + senders.json

107 + senders.json

108+

80 - [Messages call](https://mandrillapp.com/api/docs/messages.JSON.html)

109 - [Messages call](https://mandrillapp.com/api/docs/messages.JSON.html)

81 + send.json

110 + send.json

82

111

112+ - [Senders call](https://mandrillapp.com/api/docs/senders.JSON.html)

113+ + verify-domain.json

114+

115+ - [Inbound call](https://mandrillapp.com/api/docs/inbound.JSON.html)

116+ + add-route.json

117+ + add-domain.json

118+

83# Testing online API

119# Testing online API

84

120

85To test the online API, first build the package with tests enabled:

121To test the online API, first build the package with tests enabled:

mandrill-nightly.yml+7−7

@@ -1,10 +1,10 @@

1−flags: {}

1+flags:

2+ semigroups:

3+ bytestring-builder: false

2packages:

4packages:

3- '.'

5- '.'

4−- location:

5− git: git@github.com:bos/aeson.git

6− commit: 674eee5972864f9a32e27e9a827693edef0ad737

7extra-deps:

6extra-deps:

8− - aeson-0.11.0.0

7+ - aeson-1.3.0.0

9− - fail-4.9.0.0

8+ - text-1.2.3.0

9+ - semigroups-0.18.2

10−resolver: lts-5.2

10+resolver: lts-9.1

mandrill.cabal+5−4

@@ -1,5 +1,5 @@

1name: mandrill

2−version: 0.5.2.1

2+version: 0.5.3.5

3synopsis: Library for interfacing with the Mandrill JSON API

4description: Pure Haskell client for the Mandrill JSON API

5license: MIT

@@ -26,6 +26,7 @@ library

26 Network.API.Mandrill.Messages

27 Network.API.Mandrill.Messages.Types

28 Network.API.Mandrill.Inbound

29+ Network.API.Mandrill.Webhooks

29 Network.API.Mandrill.Senders

30 Network.API.Mandrill.Senders

30 other-modules:

31 other-modules:

31 Network.API.Mandrill.Utils

32 Network.API.Mandrill.Utils

@@ -40,10 +41,10 @@ library

40 , http-types >= 0.8.0

41 , http-types >= 0.8.0

41 , http-client >= 0.3.0

42 , http-client >= 0.3.0

42 , http-client-tls >= 0.2.0.0

43 , http-client-tls >= 0.2.0.0

43− , aeson >= 0.7.0.3 && < 0.12.0.0

44+ , aeson >= 0.7.0.3 && < 1.5.0.0

44− , lens >= 4.0

45+ , microlens-th >= 0.4.0.0

45 , blaze-html >= 0.5.0.0

46 , blaze-html >= 0.5.0.0

46− , QuickCheck >= 2.6 && < 2.9

47+ , QuickCheck >= 2.6 && < 3.0

47 , mtl < 3.0

48 , mtl < 3.0

48 , time

49 , time

49 , email-validate >= 1.0.0

50 , email-validate >= 1.0.0

src/Network/API/Mandrill.hs+7−6

@@ -20,7 +20,6 @@ module Network.API.Mandrill (

20 -- $exampleusage

21 ) where

22

23−import Control.Lens

24import Control.Monad.Reader

23import Control.Monad.Reader

25import qualified Data.Aeson as JSON

24import qualified Data.Aeson as JSON

26import qualified Data.HashMap.Strict as H

25import qualified Data.HashMap.Strict as H

@@ -107,7 +106,7 @@ newHtmlMessage :: EmailAddress

107 -- ^ The HTML body

106 -- ^ The HTML body

108 -> MandrillMessage

107 -> MandrillMessage

109newHtmlMessage f t subj html = let body = mkMandrillHtml html in

108newHtmlMessage f t subj html = let body = mkMandrillHtml html in

110− ((mmsg_html .~ body) . (mmsg_subject .~ subj)) $ (emptyMessage f t)

109+ (emptyMessage f t) { _mmsg_html = body, _mmsg_subject = subj }

111

110

112--------------------------------------------------------------------------------

111--------------------------------------------------------------------------------

113-- | Create a new template message (no HTML).

112-- | Create a new template message (no HTML).

@@ -118,7 +117,7 @@ newTemplateMessage :: EmailAddress

118 -> T.Text

117 -> T.Text

119 -- ^ Subject

118 -- ^ Subject

120 -> MandrillMessage

119 -> MandrillMessage

121−newTemplateMessage f t subj = (mmsg_subject .~ subj) $ (emptyMessage f t)

120+newTemplateMessage f t subj = (emptyMessage f t) { _mmsg_subject = subj }

122

121

123--------------------------------------------------------------------------------

122--------------------------------------------------------------------------------

124-- | Create a new textual message. By default Mandrill doesn't require you

123-- | Create a new textual message. By default Mandrill doesn't require you

@@ -134,9 +133,11 @@ newTextMessage :: EmailAddress

134 -- ^ The body, as normal text.

133 -- ^ The body, as normal text.

135 -> MandrillMessage

134 -> MandrillMessage

136newTextMessage f t subj txt = let body = unsafeMkMandrillHtml txt in

135newTextMessage f t subj txt = let body = unsafeMkMandrillHtml txt in

137− ((mmsg_html .~ body) .

136+ (emptyMessage f t) {

137+ _mmsg_html = body

138− (mmsg_text .~ Just txt) .

138+ , _mmsg_text = Just txt

139− (mmsg_subject .~ subj)) (emptyMessage f t)

139+ , _mmsg_subject = subj

140+ }

140

141

142

142--------------------------------------------------------------------------------

143--------------------------------------------------------------------------------

src/Network/API/Mandrill/Inbound.hs+1−1

@@ -1,11 +1,11 @@

1{-# LANGUAGE TemplateHaskell #-}

2module Network.API.Mandrill.Inbound where

3−import Control.Lens

4import Data.Aeson (FromJSON, ToJSON, parseJSON,

3import Data.Aeson (FromJSON, ToJSON, parseJSON,

5 toJSON)

4 toJSON)

6import Data.Aeson.TH (defaultOptions, deriveJSON)

5import Data.Aeson.TH (defaultOptions, deriveJSON)

7import Data.Aeson.Types (fieldLabelModifier)

6import Data.Aeson.Types (fieldLabelModifier)

8import Data.Text (Text)

7import Data.Text (Text)

8+import Lens.Micro.TH (makeLenses)

9import Network.API.Mandrill.HTTP (toMandrillResponse)

10import Network.API.Mandrill.Settings

11import Network.API.Mandrill.Types

src/Network/API/Mandrill/Messages/Types.hs+1−1

@@ -5,12 +5,12 @@ module Network.API.Mandrill.Messages.Types where

5import Data.Char

6import Data.Time

7import qualified Data.Text as T

8−import Control.Lens

9import Control.Monad

8import Control.Monad

10import Data.Monoid

9import Data.Monoid

11import Data.Aeson

10import Data.Aeson

12import Data.Aeson.Types

11import Data.Aeson.Types

13import Data.Aeson.TH

12import Data.Aeson.TH

13+import Lens.Micro.TH (makeLenses)

14

15import Network.API.Mandrill.Types

16

src/Network/API/Mandrill/Senders.hs+3−20

@@ -1,12 +1,12 @@

1{-# LANGUAGE TemplateHaskell #-}

2module Network.API.Mandrill.Senders where

3−import Control.Lens

4import Data.Aeson (FromJSON, ToJSON, parseJSON,

3import Data.Aeson (FromJSON, ToJSON, parseJSON,

5 toJSON)

4 toJSON)

6import Data.Aeson.TH (defaultOptions, deriveJSON)

5import Data.Aeson.TH (defaultOptions, deriveJSON)

7import Data.Aeson.Types (Value (..), fieldLabelModifier)

6import Data.Aeson.Types (Value (..), fieldLabelModifier)

8import Data.Text (Text)

7import Data.Text (Text)

9import Data.Text.Encoding (decodeUtf8, encodeUtf8)

8import Data.Text.Encoding (decodeUtf8, encodeUtf8)

9+import Lens.Micro.TH (makeLenses)

10import Network.API.Mandrill.HTTP (toMandrillResponse)

11import Network.API.Mandrill.Settings

12import Network.API.Mandrill.Types

@@ -27,7 +27,7 @@ data VerifyDomainResponse =

27 VerifyDomainResponse

28 { _vdres_status :: Text

29 , _vdres_domain :: Text

30− , _vdres_email :: TEV.EmailAddress

30+ , _vdres_email :: MandrillEmail

31 } deriving Show

32

33makeLenses ''VerifyDomainResponse

@@ -42,21 +42,4 @@ verifyDomain :: MandrillKey

42 -> IO (MandrillResponse VerifyDomainResponse)

43verifyDomain k email =

44 toMandrillResponse VerifyDomain

45− (VerifyDomainRq k (decodeUtf8 $ TEV.domainPart email) (decodeUtf8 $ TEV.localPart email))

45+ (VerifyDomainRq k (decodeUtf8 $ TEV.domainPart email) (decodeUtf8 $ TEV.localPart email))

46−-- addDomain :: MandrillKey

47−

48−-- addDomain k dom = toMandrillResponse DomainsAdd (DomainAddRq k dom)

49−

50−

51−

52−-- addRoute :: MandrillKey

53−-- -- ^ The API key

54−-- -> Text

55−-- -- ^ The domain to add

56−-- -> Text

57−-- -- ^ the pattern including wildcards

58−-- -> Text

59−-- -- ^ URL to forward to

60−-- -> Maybe Manager

61−-- -> IO (MandrillResponse RouteAddResponse)

62−-- addRoute k dom pattern forward = toMandrillResponse RoutesAdd (RouteAddRq k dom pattern forward)

src/Network/API/Mandrill/Types.hs+6−11

@@ -13,6 +13,7 @@ import Control.Monad (mzero)

13import Data.Char

14import Data.Maybe

15import Data.Time

16+import Lens.Micro.TH (makeLenses)

16import Network.API.Mandrill.Utils

17import Network.API.Mandrill.Utils

17import Test.QuickCheck

18import Test.QuickCheck

18import Text.Email.Validate

19import Text.Email.Validate

@@ -21,7 +22,6 @@ import Data.Time.Format (TimeLocale, defaultTimeLocale)

21#else

22#else

22import System.Locale (TimeLocale, defaultTimeLocale)

23import System.Locale (TimeLocale, defaultTimeLocale)

23#endif

24#endif

24−import Control.Lens

25import Data.Aeson

26import Data.Aeson.TH

27import Data.Aeson.Types

@@ -158,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml

158mkMandrillHtml :: Blaze.Html -> MandrillHtml

159mkMandrillHtml = MandrillHtml

160

161+#if MIN_VERSION_base(4,11,0)

162+instance Semigroup MandrillHtml where

163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)

164+#endif

165+

161instance Monoid MandrillHtml where

166instance Monoid MandrillHtml where

162 mempty = MandrillHtml mempty

167 mempty = MandrillHtml mempty

163 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)

168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)

@@ -387,13 +392,3 @@ instance FromJSON MandrillDate where

387 case timeParse defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of

392 case timeParse defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of

388 Just d -> pure $ MandrillDate d

393 Just d -> pure $ MandrillDate d

389 _ -> fail "could not parse Mandrill date"

394 _ -> fail "could not parse Mandrill date"

390−

391−

392−instance ToJSON TEV.EmailAddress where

393− toJSON = String . TL.decodeUtf8 . TEV.toByteString

394−

395−instance FromJSON TEV.EmailAddress where

396− parseJSON (String s) = case TEV.emailAddress (TL.encodeUtf8 s) of

397− Nothing -> mzero

398− Just x -> return x

399− parseJSON _ = mzero

src/Network/API/Mandrill/Users/Types.hs+1−1

@@ -5,12 +5,12 @@ module Network.API.Mandrill.Users.Types where

5import Data.Char

6import Data.Time

7import qualified Data.Text as T

8−import Control.Lens

9import Control.Monad

8import Control.Monad

10import Data.Monoid

9import Data.Monoid

11import Data.Aeson

10import Data.Aeson

12import Data.Aeson.Types

11import Data.Aeson.Types

13import Data.Aeson.TH

12import Data.Aeson.TH

13+import Lens.Micro.TH (makeLenses)

14

15import Network.API.Mandrill.Types

16

src/Network/API/Mandrill/Webhooks.hsnew file+70

@@ -0,0 +1,70 @@

1+{-# LANGUAGE OverloadedStrings #-}

2+{-# LANGUAGE TemplateHaskell #-}

3+module Network.API.Mandrill.Webhooks where

4+import Control.Applicative (pure)

5+import Control.Monad (mzero)

6+import Data.Aeson (FromJSON, ToJSON, parseJSON,

7+ toJSON)

8+import Data.Aeson (Value (String))

9+import Data.Aeson.TH (defaultOptions, deriveJSON)

10+import Data.Aeson.Types (fieldLabelModifier)

11+import Data.Set (Set)

12+import Data.Text (Text)

13+import qualified Data.Text as T

14+import Lens.Micro.TH (makeLenses)

15+import Network.API.Mandrill.HTTP (toMandrillResponse)

16+import Network.API.Mandrill.Settings

17+import Network.API.Mandrill.Types

18+import Network.HTTP.Client (Manager)

19+

20+data EventHook

21+ = EventSent

22+ | EventDeferred

23+ | EventHardBounced

24+ | EventSoftBounced

25+ | EventOpened

26+ | EventClicked

27+ | EventMarkedAsSpam

28+ | EventUnsubscribed

29+ | EventRejected

30+ deriving (Ord,Eq)

31+

32+instance Show EventHook where

33+ show e = case e of

34+ EventSent -> "send"

35+ EventDeferred -> "deferral"

36+ EventSoftBounced -> "soft_bounce"

37+ EventHardBounced -> "hard_bounce"

38+ EventOpened -> "open"

39+ EventClicked -> "click"

40+ EventMarkedAsSpam -> "spam"

41+ EventUnsubscribed -> "unsub"

42+ EventRejected -> "reject"

43+instance FromJSON EventHook where

44+ parseJSON (String s) =

45+ case s of

46+ "send" -> pure EventSent

47+ "deferral" -> pure EventDeferred

48+ "soft_bounce" -> pure EventSoftBounced

49+ "hard_bounce" -> pure EventHardBounced

50+ "open" -> pure EventOpened

51+ "click" -> pure EventClicked

52+ "spam" -> pure EventMarkedAsSpam

53+ "reject" -> pure EventRejected

54+ "unsub" -> pure EventUnsubscribed

55+ x -> fail ("can't parse " ++ show x)

56+

57+

58+instance ToJSON EventHook where

59+ toJSON e = String (T.pack $ show e)

60+

61+data WebhookAddRq =

62+ WebhookAddRq

63+ { _warq_key :: MandrillKey

64+ , _warq_url :: Text

65+ , _warq_description :: Text

66+ , _warq_events :: Set EventHook

67+ } deriving Show

68+

69+makeLenses ''WebhookAddRq

70+deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''WebhookAddRq

stack.yaml+1−1

@@ -2,4 +2,4 @@ flags: {}

2packages:

3- '.'

4extra-deps: []

5−resolver: lts-5.2

5+resolver: lts-11.13

test/Main.hs+1

@@ -45,5 +45,6 @@ main = do

45 , testCase "inbound/add-route.json API response parsing" testRouteAdd

46 , testCase "inbound/add-domain.json API response parsing" testDomainAdd

47 , testCase "senders/verify-domain.json API response parsing" testVerifyDomain

48+ , testCase "webhooks/add.json API response parsing" testWebhookAdd

48 ]

49 ]

50 ]

test/RawData.hs+19

@@ -236,3 +236,22 @@ domainVerify = [r|

236 "email": "email@domain.com"

237}

238|]

239+

240+webhookAdd = [r|

241+{

242+ "key": "example key",

243+ "url": "http://example/webhook-url",

244+ "description": "My Example Webhook",

245+ "events": [

246+ "send",

247+ "deferral",

248+ "hard_bounce",

249+ "soft_bounce",

250+ "open",

251+ "click",

252+ "spam",

253+ "unsub",

254+ "reject"

255+ ]

256+}

257+|]

test/Tests.hs+10

@@ -9,6 +9,7 @@ import Network.API.Mandrill.Messages.Types

9import Network.API.Mandrill.Senders

10import Network.API.Mandrill.Types

11import Network.API.Mandrill.Users.Types

12+import Network.API.Mandrill.Webhooks

12import RawData

13import RawData

13import Test.Tasty.HUnit

14import Test.Tasty.HUnit

14

15

@@ -76,3 +77,12 @@ testVerifyDomain =

76 where

77 where

77 parsePayload :: Either String VerifyDomainResponse

78 parsePayload :: Either String VerifyDomainResponse

78 parsePayload = eitherDecodeStrict . C8.pack $ domainVerify

79 parsePayload = eitherDecodeStrict . C8.pack $ domainVerify

80+

81+

82+testWebhookAdd :: Assertion

83+testWebhookAdd =

84+ assertBool ("webhooks/add.json (request): parsing failed" ++ show parsePayload)

85+ (isRight parsePayload)

86+ where

87+ parsePayload :: Either String WebhookAddRq

88+ parsePayload = eitherDecodeStrict . C8.pack $ webhookAdd