Merge pull request #43 from JuliaWeb/jq/queryparampairs

Add queryparampairs to support duplicate query param key case

.github/workflows/ci.yml

@@ -2,6 +2,9 @@ name: CI
 on:
   - push
   - pull_request
+concurrency: 
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}

Project.toml

@@ -1,7 +1,7 @@
 name = "URIs"
 uuid = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 authors = ["Jacob Quinn", "Sam O'Connor", "contributors: https://github.com/JuliaWeb/URIs.jl/graphs/contributors"]
-version = "1.3.1"
+version = "1.4.0"
 
 [compat]
 julia = "1.6"

docs/src/index.md

@@ -53,6 +53,7 @@ Dict{String,String} with 2 entries:
 ```@docs
 URI
 queryparams
+queryparampairs
 absuri
 escapeuri
 unescapeuri

src/URIs.jl

@@ -1,7 +1,7 @@
 module URIs
 
 export URI,
-       queryparams, absuri,
+       queryparams, queryparampairs, absuri,
        escapeuri, unescapeuri, escapepath,
        resolvereference
 
@@ -267,6 +267,8 @@ uristring(u::URI) = uristring(u.scheme, u.userinfo, u.host, u.port,
 Returns a `Dict` containing the `query` parameter string parsed according to
 the key=value pair formatting convention.
 
+Note that duplicate query param values are not supported; if needed, use `queryparampairs`.
+
 Note that this is not part of the formal URI grammar, merely a common parsing
 convention — see [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3.4).
 """
@@ -278,6 +280,24 @@ function queryparams(q::AbstractString)
                                       for e in split(q, "&", keepempty=false)))
 end
 
+"""
+    queryparampairs(::URI) -> Vector{Pair{String, String}}
+    queryparampairs(query_str::AbstractString) -> Vector{Pair{String, String}}
+
+Identical to `queryparams`, but returns a `Vector{Pair{String, String}}` containing the `query` parameter string parsed according to
+the key=value pair formatting convention.
+
+Note that this is not part of the formal URI grammar, merely a common parsing
+convention — see [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3.4).
+"""
+queryparampairs(uri::URI) = queryparampairs(uri.query)
+
+function queryparampairs(q::AbstractString)
+    [unescapeuri(decodeplus(k)) => unescapeuri(decodeplus(v))
+                        for (k,v) in ([split(e, "=")..., ""][1:2]
+                                      for e in split(q, "&", keepempty=false))]
+end
+
 # Validate known URI formats
 const uses_authority = ["https", "http", "ws", "wss", "hdfs", "ftp", "gopher", "nntp", "telnet", "imap", "wais", "file", "mms", "shttp", "snews", "prospero", "rtsp", "rtspu", "rsync", "svn", "svn+ssh", "sftp" ,"nfs", "git", "git+ssh", "ldap", "s3", "ssh"]
 const non_hierarchical = ["gopher", "hdl", "mailto", "news", "telnet", "wais", "imap", "snews", "sip", "sips"]

test/uri.jl

@@ -477,6 +477,7 @@ urltests = URLTest[
         @test queryparams(URI("http://example.com"))::Dict{String,String} == Dict()
         @test queryparams(URI("https://httphost/path1/path2;paramstring?q=a&p=r#frag")) == Dict("q"=>"a","p"=>"r")
         @test queryparams(URI("https://foo.net/?q=a&malformed")) == Dict("q"=>"a","malformed"=>"")
+        @test queryparampairs(URI("http://example.com?a=b&a=c&a=d"))::Vector{Pair{String, String}} == ["a" => "b", "a" => "c", "a" => "d"]
     end
 
     @testset "Parse Errors" begin