diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/shelduck.cabal b/shelduck.cabal new file mode 100644 --- /dev/null +++ b/shelduck.cabal @@ -0,0 +1,79 @@ +name: shelduck +version: 0.1.2.0 +-- synopsis: +-- description: +license: Apache-2.0 +license-file: LICENSE +author: Bob Long +synopsis: Test webhooks locally +description: Opinionated tool for QAing webhooks on remote services using ngrok +maintainer: robertjflong@gmail.com +-- copyright: +category: Web +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/bobjflong/shelduck.git + +library + exposed-modules: Shelduck, Templating, IntercomDefinitions, Internal + other-modules: Configuration + build-depends: base < 5 + , Spock + , async + , text + , lens-aeson + , lens + , stm + , wreq + , aeson + , rainbow + , hastache + , random + , bytestring + , transformers + , shelly + hs-source-dirs: src + default-language: Haskell2010 + +executable shelduck + main-is: Main.hs + build-depends: base < 5 + , shelduck + , Spock + , async + , text + , lens-aeson + , lens + , stm + , wreq + , aeson + , rainbow + , hastache + , random + , bytestring + , transformers + , shelly + hs-source-dirs: src + default-language: Haskell2010 + +test-suite tests + ghc-options: -Wall + type: exitcode-stdio-1.0 + main-is: Tests.hs + hs-source-dirs: test + + build-depends: base + , hspec + , lens + , aeson + , shelduck + , regex-compat + , text + , transformers + , stm + , wreq + default-language: Haskell2010 diff --git a/src/Configuration.hs b/src/Configuration.hs new file mode 100644 --- /dev/null +++ b/src/Configuration.hs @@ -0,0 +1,7 @@ +module Configuration where + +pollTime :: Int +pollTime = 100000 + +polls :: Int +polls = 1000 diff --git a/src/IntercomDefinitions.hs b/src/IntercomDefinitions.hs new file mode 100644 --- /dev/null +++ b/src/IntercomDefinitions.hs @@ -0,0 +1,141 @@ +{-# LANGUAGE OverloadedStrings #-} + +module IntercomDefinitions where + +import Control.Concurrent +import Control.Concurrent.Async +import Control.Concurrent.STM.TVar +import Control.Lens hiding ((.=)) +import Control.Monad +import Control.Monad.STM +import Control.Monad.Trans.Reader +import Data.Aeson (object, (.=)) +import Data.Aeson.Lens as AL +import Data.ByteString hiding (getLine, pack) +import Data.ByteString.Char8 (pack) +import qualified Data.ByteString.Lazy as L +import Data.Maybe +import qualified Data.Text as T +import qualified Network.Wreq as W +import Shelduck hiding (opts) +import System.Environment + +opts = do + appId <- getEnv "INTERCOM_APP_ID" + appApiKey <- getEnv "INTERCOM_APP_API_KEY" + return $ W.defaults & W.header "Accept" .~ ["application/json"] + & W.header "Content-Type" .~ ["application/json"] + & W.auth ?~ W.basicAuth (pack appId) (pack appApiKey) + +type DefinitionList = IO [WebhookRequest] + +-- +-- Example parameters for API requests +-- +userId :: T.Text +userId = "55b26822ce97179e52001334" + +userType :: T.Text +userType = "user" + +adminType :: T.Text +adminType = "admin" + +commentType :: T.Text +commentType = "comment" + +noteType :: T.Text +noteType = "note" + +assignmentType :: T.Text +assignmentType = "assignment" + +adminId :: T.Text +adminId = "25610" + +assigneeId :: T.Text +assigneeId = "25610" + +contactId :: T.Text +contactId = "55d306eb886c98f8110028dd" + +hi :: T.Text +hi = "Hi :)" + +tagName :: T.Text +tagName = "foo" + +run :: TVar TopicResult -> IO () +run t = void $ do + threadDelay 5000000 + options <- opts + contactResp <- go $ blank & requestEndpoint .~ "https://api.intercom.io/contacts" + & requestOpts .~ options + & requestParameters .~ object [] + & requestTopic .~ "contact.created" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/contacts" + & requestOpts .~ options + & requestParameters .~ object ["id" .= cid contactResp, "email" .= ("bob+{{random}}@intercom.io" :: T.Text)] + & requestTopic .~ "contact.added_email" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/contacts/convert" + & requestOpts .~ options + & requestParameters .~ object ["contact" .= object ["id" .= cid contactResp], "user" .= object ["email" .= ("bob+{{random}}@intercom.io" :: T.Text)]] + & requestTopic .~ "contact.signed_up" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/users" + & requestOpts .~ options + & requestParameters .~ object ["email" .= ("bob+{{random}}@intercom.io" :: T.Text)] + & requestTopic .~ "user.created" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/messages" + & requestOpts .~ options + & requestParameters .~ object ["from" .= object ["id" .= userId, "type" .= userType], "body" .= hi] + & requestTopic .~ "conversation.user.created" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/conversations/1039067180/reply" + & requestOpts .~ options + & requestParameters .~ object ["intercom_user_id" .= userId, "body" .= hi, "type" .= userType, "message_type" .= commentType] + & requestTopic .~ "conversation.user.replied" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/conversations/1039067180/reply" + & requestOpts .~ options + & requestParameters .~ object ["admin_id" .= adminId, "body" .= hi, "type" .= adminType, "message_type" .= commentType] + & requestTopic .~ "conversation.admin.replied" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/conversations/1039067180/reply" + & requestOpts .~ options + & requestParameters .~ object ["admin_id" .= adminId, "body" .= hi, "type" .= adminType, "message_type" .= noteType] + & requestTopic .~ "conversation.admin.noted" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/conversations/1039067180/reply" + & requestOpts .~ options + & requestParameters .~ object ["admin_id" .= adminId, "assignee_id" .= assigneeId, "body" .= hi, "type" .= adminType, "message_type" .= assignmentType] + & requestTopic .~ "conversation.admin.assigned" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/tags" + & requestOpts .~ options + & requestParameters .~ object ["name" .= tagName, "users" .= [object ["id" .= userId]]] + & requestTopic .~ "user.tag.created" + + go $ blank & requestEndpoint .~ "https://api.intercom.io/tags" + & requestOpts .~ options + & requestParameters .~ object ["name" .= tagName, "users" .= [object ["untag" .= True, "id" .= userId]]] + & requestTopic .~ "user.tag.deleted" + where go = runDefinition t + cid resp = resp ^. W.responseBody . key "id" . _String + +runIntercomDefinitions :: IO () +runIntercomDefinitions = do + info "Running Intercom definitions" + r <- newTVarIO Nothing :: IO (TVar TopicResult) + withAsync (server r) $ \webServer -> + withAsync (run r) $ \testRun -> wait testRun >> cancel webServer + return () + +runDefinition :: TVar TopicResult -> WebhookRequest -> IO (W.Response L.ByteString) +runDefinition t w = do + x <- runReaderT req t + return $ x ^. response + where req = performRequest w diff --git a/src/Internal.hs b/src/Internal.hs new file mode 100644 --- /dev/null +++ b/src/Internal.hs @@ -0,0 +1,16 @@ +module Internal where + +import Configuration +import Control.Concurrent +import Control.Concurrent.STM.TVar +import Control.Monad.STM +import Data.Text + +record :: Maybe Text -> TVar (Maybe Text) -> IO () +record t r = atomically $ writeTVar r t + +pollingIO :: Int -> TVar a -> (TVar a -> IO Bool) -> IO b -> IO (Int, b) +pollingIO c t x i = temporaryFailure >>= \f -> if f then tryAgain else finish + where tryAgain = threadDelay pollTime >> pollingIO (c - 1) t x i + finish = i >>= \result -> return (c, result) + temporaryFailure = x t >>= \p -> return $ not p && c > 0 diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,16 @@ +module Main ( + main +) where + +import IntercomDefinitions +import System.Environment + +printUsage :: IO () +printUsage = mapM_ putStrLn usageLines + where usageLines = ["USAGE: scalp-webhooks ", "Current definition_types: intercom"] + +main = do + args <- getArgs + case args of + ("intercom":_) -> runIntercomDefinitions + _ -> printUsage diff --git a/src/Shelduck.hs b/src/Shelduck.hs new file mode 100644 --- /dev/null +++ b/src/Shelduck.hs @@ -0,0 +1,133 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TemplateHaskell #-} + +module Shelduck ( + requestTopic, + requestEndpoint, + requestOpts, + requestParameters, + Shelduck.response, + timing, + info, + TopicResult, + server, + WebhookRequest, + performRequest, + blank, + doHandle + ) where + +import Configuration +import Control.Concurrent +import Control.Concurrent.Async +import Control.Concurrent.STM.TVar +import Control.Lens hiding ((.=)) +import Control.Lens.TH +import Control.Monad +import Control.Monad.STM +import Control.Monad.Trans.Class +import Control.Monad.Trans.Reader +import Data.Aeson +import Data.Aeson.Lens +import Data.ByteString.Lazy (toStrict) +import qualified Data.ByteString.Lazy as L +import Data.Maybe +import Data.Monoid +import Data.Text +import Data.Text.Encoding +import Internal +import qualified Network.Wreq as W +import Rainbow +import Shelly +import Templating +import Web.Spock.Safe + +data WebhookRequest = WebhookRequest { + _requestEndpoint :: Text, + _requestOpts :: W.Options, + _requestParameters :: Value, + _requestTopic :: Text +} + +blank :: WebhookRequest +blank = WebhookRequest mempty W.defaults (object []) mempty + +$(makeLenses ''WebhookRequest) + +data TimedResponse = TimedResponse { + _response :: W.Response L.ByteString, + _timing :: Int +} deriving (Show) + +$(makeLenses ''TimedResponse) + +type TopicResult = Maybe Text + +doPost :: (WebhookRequest, Text, Text) -> ReaderT a IO (W.Response L.ByteString) +doPost (w, e, p) = lift $ W.postWith (w ^. requestOpts) (unpack e) (encodeUtf8 p) + +doLog :: W.Response L.ByteString -> ReaderT a IO (W.Response L.ByteString) +doLog r = lift ((info . pack . show) (r ^. W.responseStatus)) >> return r + +doWait :: Int -> W.Response L.ByteString -> ReaderT (TVar TopicResult) IO TimedResponse +doWait c x = ask >>= + \t -> lift $ do + (c, r) <- pollingIO c t predicate (return x) + return $ TimedResponse r c + where predicate t = fmap isJust (readTVarIO t) + +doHandle :: WebhookRequest -> ReaderT (TVar TopicResult) IO Bool +doHandle w = ask >>= + \t -> lift $ do + b <- atomically $ do + b' <- readTVar t + writeTVar t Nothing + return b' + handleSuccess (fromMaybe mempty b) (w ^. requestTopic) + +doLogTimings :: Int -> TimedResponse -> IO () +doLogTimings i t = void $ info $ mconcat ["Took approx: ", (pack . show) time, " microseconds..."] + where time = (i - (t ^. timing)) * pollTime + +performRequest :: WebhookRequest -> ReaderT (TVar TopicResult) IO TimedResponse +performRequest w = doTemplating >>= + doPost >>= + doLog >>= + doWait polls >>= + (\x -> lift (doLogTimings polls x) >> doHandle w >> return x) + where doTemplating = lift $ do + e <- template (w ^. requestEndpoint) + p <- template ((decodeUtf8 . toStrict . encode) $ w ^. requestParameters) + return (w, e, p) + +handleSuccess :: Text -> Text -> IO Bool +handleSuccess b t = + if b == t + then success (mconcat [" Good topic: ", showResult b]) >> return True + else failure (mconcat [" Bad topic: ", showResult b]) >> return False + where showResult = pack . show + +failure :: Text -> IO () +failure x = putChunkLn $ chunk x & fore red + +info :: Text -> IO () +info x = putChunkLn $ chunk x & fore cyan + +success :: Text -> IO () +success x = putChunkLn $ chunk x & fore green + +ngrok :: IO () +ngrok = shelly $ verbosely $ run "ngrok" ["start", "shelduck"] >>= (liftIO . info) + +server :: TVar TopicResult -> IO () +server t = void $ concurrently ngrok $ do + info "Starting server to listen for webhooks" + runSpock 8080 $ spockT id $ + post root $ do + responseBody <- body + let topic = responseBody ^? key "topic" + lift $ case topic of + Just (String s) -> record (Just s) t + Nothing -> record Nothing t + r <- lift $ readTVarIO t + text $ r & (pack . show) diff --git a/src/Templating.hs b/src/Templating.hs new file mode 100644 --- /dev/null +++ b/src/Templating.hs @@ -0,0 +1,14 @@ +module Templating where + +import Data.Text +import Data.Text.Lazy (toStrict) +import qualified Data.Text.Lazy.IO as TL +import System.Random +import Text.Hastache +import Text.Hastache.Context + +template :: Text -> IO Text +template t = do + r <- randomIO :: IO Float + fmap toStrict (hastacheStr defaultConfig t (mkStrContext $ c r)) + where c r "random" = MuVariable $ (pack . show) r diff --git a/test/Tests.hs b/test/Tests.hs new file mode 100644 --- /dev/null +++ b/test/Tests.hs @@ -0,0 +1,62 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Main where + +import Control.Concurrent.STM +import Control.Lens +import Control.Monad.Trans.Reader +import Data.Aeson +import Data.Text +import Internal +import qualified Network.Wreq as W +import Shelduck +import Templating +import Test.Hspec +import Text.Regex + +main :: IO () +main = hspec $ do + describe "templating" $ + it "substitutes random numbers at runtime" $ do + let regex = mkRegex "{\"foo\":\"bar[0-9.e\\-]+\"}" + t <- template "{\"foo\":\"bar{{random}}\"}" + matchRegex regex (unpack t) `shouldBe` Just [] + describe "reading results" $ do + it "detects success" $ do + r <- newTVarIO (Just "foo") :: IO (TVar TopicResult) + let req = blank & requestEndpoint .~ "x" + & requestOpts .~ W.defaults + & requestParameters .~ object [] + & requestTopic .~ "foo" + handler = doHandle req + result <- runReaderT handler r + result `shouldBe` True + it "detects failures" $ do + r <- newTVarIO (Just "bar") :: IO (TVar TopicResult) + let req = blank & requestEndpoint .~ "x" + & requestOpts .~ W.defaults + & requestParameters .~ object [] + & requestTopic .~ "foo" + handler = doHandle req + result <- runReaderT handler r + result `shouldBe` False + describe "writing results" $ + it "works" $ do + r <- newTVarIO Nothing :: IO (TVar TopicResult) + record (Just "foo") r + result <- readTVarIO r + result `shouldBe` Just "foo" + describe "polling for TVar results" $ do + it "works" $ do + r <- newTVarIO Nothing :: IO (TVar TopicResult) + let c = const $ return True + let f = return "Hello world" :: IO String + (_, t) <- pollingIO 1 r c f + t `shouldBe` "Hello world" + it "gives up" $ do + r <- newTVarIO Nothing :: IO (TVar TopicResult) + let c = const $ return False + let f = return "Hello world" :: IO String + (i, t) <- pollingIO 10 r c f + t `shouldBe` "Hello world" + i `shouldBe` 0