diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for http-client-websockets + +## 0.1.0.0 -- 2020-09-28 + +* First version. Released on an uNsUsPeCtInG world. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# http-client-websockets +![CI](https://github.com/amesgen/http-client-websockets/workflows/CI/badge.svg) +[![Hackage](https://img.shields.io/hackage/v/http-client-websockets)](https://hackage.haskell.org/package/http-client-websockets) + +Glue code for [http-client](https://hackage.haskell.org/package/http-client) and [websockets](https://hackage.haskell.org/package/websockets). diff --git a/doctest/Main.hs b/doctest/Main.hs new file mode 100644 --- /dev/null +++ b/doctest/Main.hs @@ -0,0 +1,6 @@ +module Main (main) where + +import Test.DocTest + +main :: IO () +main = doctest ["-isrc", "src"] diff --git a/http-client-websockets.cabal b/http-client-websockets.cabal new file mode 100644 --- /dev/null +++ b/http-client-websockets.cabal @@ -0,0 +1,70 @@ +cabal-version: 2.4 +name: http-client-websockets +version: 0.1.0.0 + +synopsis: Glue code for http-client and websockets +description: + Glue code for http-client and websockets, so that + you can use a @Manager@ from http-client to create + a WebSocket connection. + . + This way, all applicable @Manager@ options like + TLS or proxy settings can be reused. +category: Network + +homepage: https://github.com/amesgen/http-client-websockets +bug-reports: https://github.com/amesgen/http-client-websockets/issues +license: CC0-1.0 +license-file: LICENSE +extra-source-files: README.md +author: amesgen +maintainer: amesgen@amesgen.de +extra-source-files: CHANGELOG.md + +source-repository head + location: https://github.com/amesgen/http-client-websockets + type: git + +common commons + default-language: Haskell2010 + ghc-options: -Wall -Wincomplete-record-updates -Wincomplete-uni-patterns -Wredundant-constraints -Wmissing-export-lists -fno-warn-name-shadowing -fhide-source-paths + if impl(ghc >= 8.10) + ghc-options: -Wunused-packages + +library + import: commons + hs-source-dirs: src + exposed-modules: + Network.HTTP.Client.WebSockets + build-depends: + base >= 4.9 && < 5 + , utf8-string + , bytestring + , network-uri >= 2.6 + , http-client >= 0.6 + , websockets >= 0.12 + +test-suite hspec + import: commons + type: exitcode-stdio-1.0 + main-is: Spec.hs + hs-source-dirs: test + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + base + , bytestring + , hspec >= 2.5 + , network-uri + , http-client-tls + , websockets + , http-client-websockets + +test-suite doctest + import: commons + type: exitcode-stdio-1.0 + ghc-options: -threaded -rtsopts -with-rtsopts=-N + main-is: Main.hs + hs-source-dirs: doctest + build-depends: + base + , doctest >= 0.8 diff --git a/src/Network/HTTP/Client/WebSockets.hs b/src/Network/HTTP/Client/WebSockets.hs new file mode 100644 --- /dev/null +++ b/src/Network/HTTP/Client/WebSockets.hs @@ -0,0 +1,93 @@ +{-# LANGUAGE LambdaCase #-} + +-- | Glue code for [http-client](https://hackage.haskell.org/package/http-client) +-- and [websockets](https://hackage.haskell.org/package/websockets). +-- +-- This module is intended to be imported @qualified@. +-- +-- If you want to use TLS-secured WebSockets (via the @wss@ scheme) +-- you need to supply a 'Manager' which supports TLS, for example +-- from [http-client-tls](https://hackage.haskell.org/package/http-client-tls) +-- or [http-client-openssl](https://hackage.haskell.org/package/http-client-openssl). +-- +-- == Example +-- >>> :set -XOverloadedStrings +-- >>> :set -XQuasiQuotes +-- >>> +-- >>> import Network.HTTP.Client (Manager, newManager, defaultManagerSettings) +-- >>> import qualified Network.WebSockets as WS +-- >>> import Network.HTTP.Client.WebSockets as HCWS +-- >>> import Network.URI.Static +-- >>> import Data.ByteString (ByteString) +-- >>> +-- >>> :{ +-- runEchoExample :: Manager -> IO ByteString +-- runEchoExample mgr = HCWS.runClient mgr echoUri $ \conn -> do +-- WS.sendTextData conn ("hello there" :: ByteString) +-- msg <- WS.receiveData conn +-- pure (msg :: ByteString) +-- where +-- echoUri = [uri|ws://echo.websocket.org|] +-- :} +-- +-- >>> -- this Manager does not support TLS, so can't use the wss scheme above +-- >>> newManager defaultManagerSettings >>= runEchoExample +-- "hello there" +module Network.HTTP.Client.WebSockets + ( runClient, + runClientWith, + ) +where + +import qualified Codec.Binary.UTF8.Generic as UTF8 +import qualified Data.ByteString as B +import qualified Data.ByteString.Lazy as LB +import qualified Network.HTTP.Client as HTTP +import qualified Network.HTTP.Client.Internal as HTTP +import Network.URI (URI (..)) +import qualified Network.WebSockets as WS +import qualified Network.WebSockets.Stream as WS + +runClient :: + -- | 'HTTP.Manager' to use to establish the connection + HTTP.Manager -> + -- | 'URI' to connect to. Only the schemes @ws@ and @wss@ are valid. + URI -> + -- | Client application + WS.ClientApp a -> + IO a +runClient mgr uri = runClientWith mgr uri WS.defaultConnectionOptions [] + +runClientWith :: + -- | 'HTTP.Manager' to use to establish the connection + HTTP.Manager -> + -- | 'URI' to connect to. Only the schemes @ws@ and @wss@ are valid. + URI -> + -- | Options + WS.ConnectionOptions -> + -- | Custom headers to send + WS.Headers -> + -- | Client application + WS.ClientApp a -> + IO a +runClientWith mgr uri connOpts headers app = do + httpScheme <- case uriScheme uri of + "ws:" -> pure "http:" + "wss:" -> pure "https:" + s -> fail $ "invalid WebSockets scheme: " <> s + req <- HTTP.requestFromURI uri {uriScheme = httpScheme} + HTTP.withConnection req mgr $ \conn -> do + let read = do + bs <- HTTP.connectionRead conn + pure $ if B.null bs then Nothing else Just bs + write = \case + Nothing -> HTTP.connectionClose conn + Just bs -> HTTP.connectionWrite conn $ LB.toStrict bs + stream <- WS.makeStream read write + WS.runClientWithStream + stream + (UTF8.toString $ HTTP.host req) + (UTF8.toString $ HTTP.path req <> HTTP.queryString req) + connOpts + headers + app diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,24 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} + +module Main (main) where + +import Data.ByteString +import Data.Foldable (for_) +import Network.HTTP.Client.TLS (newTlsManager) +import Network.HTTP.Client.WebSockets as HCWS +import Network.URI.Static +import qualified Network.WebSockets as WS +import Test.Hspec + +main :: IO () +main = hspec $ + describe "WebSockets via http-client" $ do + it "should connect to an echo server" $ do + mgr <- newTlsManager + for_ [[uri|ws://echo.websocket.org|], [uri|wss://echo.websocket.org|]] $ \u -> + HCWS.runClient mgr u $ \conn -> do + let bs = "test" :: ByteString + WS.sendTextData conn bs + bs' <- WS.receiveData conn + bs `shouldBe` bs'