Expose urlWithQueryString

Author: bdukes

src/Engage/Http.elm

@@ -2,7 +2,7 @@ module Engage.Http exposing
     ( Config, Error(..)
     , get, post, patch, put, delete
     , requestJson, requestString
-    , getErrorMessage
+    , getErrorMessage, urlWithQueryString
     , configDecoder, serverErrorDecoder, multipleServerErrorDecoder, nullDecoder
     )
 
@@ -26,7 +26,7 @@ module Engage.Http exposing
 
 # Helper functions
 
-@docs getErrorMessage
+@docs getErrorMessage, urlWithQueryString
 
 
 # Decoders
@@ -291,6 +291,29 @@ ensureStringEndsWithSlash baseUrl =
         baseUrl ++ "/"
 
 
+{-| Get the full URL from a base URL, a method name (i.e. a route), and query string values.
+
+The function adds a trailing slash to the base URL if missing. Query string values are URL encoded.
+
+    config : Engage.Http.Config
+    config =
+        { baseUrl = "https://example.com/API/MyModule"
+        , headers = []
+        }
+
+    Engage.Http.urlWithQueryString config.baseUrl "" []
+    --> "https://example.com/API/MyModule/"
+
+    Engage.Http.urlWithQueryString config.baseUrl "health" []
+    --> "https://example.com/API/MyModule/health"
+
+    Engage.Http.urlWithQueryString config.baseUrl "articles" [ ( "page", "1" ) ]
+    --> "https://example.com/API/MyModule/articles?page=1"
+
+    Engage.Http.urlWithQueryString config.baseUrl "author" [ ( "name", "Joël Quenneville" ) ]
+    --> "https://example.com/API/MyModule/author?name=Jo%C3%ABl%20Quenneville"
+
+-}
 urlWithQueryString : String -> String -> List ( String, String ) -> String
 urlWithQueryString baseUrl methodName queryStringParams =
     queryStringParams

tests/Tests.elm

@@ -16,6 +16,7 @@ suite =
         , nullDecoderTests
         , serverErrorDecoderTests
         , getErrorMessageTests
+        , urlWithQueryStringTests
         ]
 
 
@@ -237,3 +238,65 @@ getErrorMessageTests =
                     |> Engage.Http.getErrorMessage { localization = Engage.Localization.empty }
                     |> Expect.equal "It wasn't found"
         ]
+
+
+urlWithQueryStringTests : Test
+urlWithQueryStringTests =
+    describe "urlWithQueryString"
+        [ test "empty" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "" "" []
+                    |> Expect.equal "/"
+        , test "relative base" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "/api/" "" []
+                    |> Expect.equal "/api/"
+        , test "relative base ensures ends with slash" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "/api" "" []
+                    |> Expect.equal "/api/"
+        , test "relative base with path separated by slash" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "/api" "cat/blog" []
+                    |> Expect.equal "/api/cat/blog"
+        , test "relative multi-part base with path separated by slash" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "/DesktopModules/MyCompany/API/MyModule" "cat/blog" []
+                    |> Expect.equal "/DesktopModules/MyCompany/API/MyModule/cat/blog"
+        , test "absolute base" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/" "" []
+                    |> Expect.equal "https://example.com/"
+        , test "absolute base ensures ends with slash" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com" "" []
+                    |> Expect.equal "https://example.com/"
+        , test "absolute base with path separated by slash" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com" "cat/blog" []
+                    |> Expect.equal "https://example.com/cat/blog"
+        , test "absolute multi-part base with path separated by slash" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/DesktopModules/MyCompany/API/MyModule" "cat/blog" []
+                    |> Expect.equal "https://example.com/DesktopModules/MyCompany/API/MyModule/cat/blog"
+        , test "no methodName - single query-string added with question mark" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/API/MyModule" "" [ ( "page", "1" ) ]
+                    |> Expect.equal "https://example.com/API/MyModule/?page=1"
+        , test "with methodName - single query-string added with question mark" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/API/MyModule" "elevate" [ ( "page", "1" ) ]
+                    |> Expect.equal "https://example.com/API/MyModule/elevate?page=1"
+        , test "no methodName - many query-strings" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/API/MyModule" "" [ ( "page", "1" ), ( "name", "fang" ), ( "type", "page" ), ( "author", "b" ), ( "choice", "0" ) ]
+                    |> Expect.equal "https://example.com/API/MyModule/?page=1&name=fang&type=page&author=b&choice=0"
+        , test "with methodName - many query-strings" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/API/MyModule" "elevate" [ ( "name", "fang" ), ( "type", "page" ), ( "author", "b" ), ( "choice", "0" ) ]
+                    |> Expect.equal "https://example.com/API/MyModule/elevate?name=fang&type=page&author=b&choice=0"
+        , test "query string values encoded" <|
+            \_ ->
+                Engage.Http.urlWithQueryString "https://example.com/" "" [ ( "name", "Brené Brown" ), ( "type", "one & done" ), ( "other", "b (or c)" ) ]
+                    |> Expect.equal "https://example.com/?name=Bren%C3%A9%20Brown&type=one%20%26%20done&other=b%20(or%20c)"
+        ]