-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | SOAP client tools -- -- Tools to build SOAP clients using xml-conduit. -- -- A mildly-complicated example: -- -- 
--   main = do
--       -- Initial one-time preparations.
--       certP <- clientCert "priv/client.crt" "priv/client.key"
--       transport <- initTransport "https://example.com/soap/endpoint" certP (iconv "cp-1251")
--   
--       -- Making queries
--       activeStaff <- listStaff transport True
--       print activeStaff
--   
--   data Person = Person Text Int deriving Show
--   
--   listStaff :: Transport -> Bool -> IO [Person]
--   listStaff t active = invokeWS t "urn:dummy:listStaff" () body parser
--       where
--           body = element "request" $ element "listStaff" $ do
--                      element "active" active
--                      element "order" $ T.pack "age"
--                      element "limit" (10 :: Int)
--   
--           parser = StreamParser $ force "no people" $ tagNoAttr "people" $ Parse.many parsePerson
--   
--           parsePerson = tagName "person" (requireAttr "age") $ \age -> do
--                             name <- Parse.content
--                             return $ Person name (read . unpack $ age)
--
-- -- Changelog -- -- @package soap @version 0.2.0.3 -- | Collection of helpers to use with Text.XML.Stream.Parse parsers. -- -- 
--   let sink = flaxTag "MethodNameResponse"
--            $ flaxTag "MethodNameResult" $ do
--                info <- flaxTag "Info" $ do
--                            q <- readTag "quantity"
--                            b <- readTag "balance"
--                            return $ Info q b
--                rc <- readTag "ResponseCode"
--                return (rc, info)
--
module Network.SOAP.Parsing.Stream -- | Namespace- and attribute- ignorant tagNoAttr. laxTag :: MonadThrow m => Text -> Sink Event m a -> Sink Event m (Maybe a) -- | Non-maybe version of laxTag/tagNoAttr. flaxTag :: MonadThrow m => Text -> Sink Event m a -> Sink Event m a laxContent :: MonadThrow m => Text -> Sink Event m (Maybe Text) flaxContent :: MonadThrow m => Text -> Sink Event m Text -- | Unpack and read a current tag content. readContent :: (Read a, MonadThrow m) => Sink Event m a -- | Unpack and read tag content by local name. readTag :: (Read a, MonadThrow m) => Text -> Sink Event m a -- | Consumes a stream of input values and produces a final result, without -- producing any output. -- -- Since 0.5.0 type Sink i (m :: * -> *) r = ConduitM i Void m r -- | Some XML processing tools are incremental, and work in terms of events -- rather than node trees. The Event type allows a document to be -- fully specified as a sequence of events. -- -- Event-based XML libraries include: -- -- data Event :: * module Network.SOAP.Exception -- | Exception to be thrown when transport encounters an exception that is -- acutally a SOAP Fault. data SOAPFault SOAPFault :: Text -> Text -> Text -> SOAPFault faultCode :: SOAPFault -> Text faultString :: SOAPFault -> Text faultDetail :: SOAPFault -> Text -- | Try to find a SOAP Fault in a document. extractSoapFault :: Document -> Maybe SOAPFault instance Typeable SOAPFault instance Eq SOAPFault instance Show SOAPFault instance Exception SOAPFault -- | This package comes with a single transport, but the your vendor's SOAP -- implementation can behave very differently, so invokeWS can be rigged -- to use anything that follows a simple interface. module Network.SOAP.Transport -- | Common transport type. Get a request and deliver it to an endpoint -- specified during initialization. type Transport = String -> Document -> IO ByteString -- | A feature-rich http-conduit based transport allowing to deal with -- HTTPS, authentication and other stuff using request and body -- processors. module Network.SOAP.Transport.HTTP.Conduit -- | Create a http-conduit transport. Use identity transformers if you -- don't need any special treatment. initTransport :: EndpointURL -> RequestP -> BodyP -> IO Transport -- | Create a transport without any request and body processing. initTransport_ :: EndpointURL -> IO Transport -- | Web service URL. Configured at initialization, but you can tweak it -- dynamically with a request processor. type EndpointURL = String -- | Update request record after defaults and method-specific fields are -- set. type RequestP = Request (ResourceT IO) -> Request (ResourceT IO) -- | Load certificate, key and make a request processor setting them. clientCert :: FilePath -> FilePath -> IO RequestP -- | Show a debug dump of a request body. traceRequest :: RequestP -- | Process response body to make it a nice UTF8-encoded XML document. type BodyP = ByteString -> ByteString -- | Create an IConv-based processor. iconv :: EncodingName -> BodyP -- | Show a debug dump of a response body. traceBody :: BodyP -- | Render document, submit it as a POST request and retrieve a body. runQuery :: Manager -> EndpointURL -> RequestP -> BodyP -> Transport -- | Debug transport to train your parsers without bugging real services. module Network.SOAP.Transport.Mock -- | Wrap a collection of handlers into a transport. initTransport :: Handlers -> IO Transport type Handler = Document -> IO ByteString type Handlers = [(String, Handler)] -- | Process a Document and wrap result in a SOAP Envelope. handler :: ToXML a => (Document -> IO a) -> Handler -- | Emulate a SOAP fault. fault :: Text -> Text -> Text -> Handler -- | Choose and apply a handler. runQuery :: [(String, Handler)] -> Transport -- | A heart of the package, invokeWS assembles and executes -- requests. module Network.SOAP -- | Prepare data, assemble request and apply a parser to a response. invokeWS :: (ToXML h, ToXML b) => Transport -> String -> h -> b -> ResponseParser a -> IO a -- | Common transport type. Get a request and deliver it to an endpoint -- specified during initialization. type Transport = String -> Document -> IO ByteString -- | Different parsing modes available to extract reply contents. data ResponseParser a -- | Streaming parser from Text.XML.Stream.Parse StreamParser :: (Parser a) -> ResponseParser a -- | XPath-like parser from Text.XML.Cursor CursorParser :: (Cursor -> a) -> ResponseParser a -- | Parse raw XML document. DocumentParser :: (Document -> a) -> ResponseParser a -- | Work with a raw bytestring. RawParser :: (ByteString -> a) -> ResponseParser a -- | Stream parser from Text.XML.Stream.Parse. type Parser a = Sink Event (ResourceT IO) a -- | Some helpers to parse documents with Text.XML.Cursor. module Network.SOAP.Parsing.Cursor -- | Grab node content by element name. -- -- 
--   pair cur = (readT "fst" cur, readT "snd" cur)
--
readT :: Text -> Cursor -> Text -- | Extract a read-able type from a content of a node with given name. -- -- 
--   age = readC "age" :: Cursor -> Integer
--
readC :: Read a => Text -> Cursor -> a -- | Very generic type to catch server reply when you don't care about -- types. type Dict = HashMap Text Text -- | Apply an axis and extract a key-value from child elements. -- -- 
--   invokeWS … (CursorParser . readDict $ laxElement "WebScaleResponse" &/ laxElement "BigDataResult")
--
readDict :: Axis -> Cursor -> Dict -- | Simple parser to grab a flat response by an element name. -- -- 
--   result <- invokeWS … (dictBy "BigDataResult")
--   case HM.lookup "SuccessError" result of …
--
dictBy :: Text -> ResponseParser Dict