Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e9f3e5ed8b | ||
|
|
8b053f0f77 | ||
|
|
b68af327ab | ||
|
|
68bf719c27 | ||
|
|
3ff3165a42 | ||
|
|
16f96b9b27 | ||
|
|
04e2090a95 | ||
|
|
6e3e23061a | ||
|
|
91579a1700 | ||
|
|
d6c78f2193 | ||
|
|
dbb9f5b404 | ||
|
|
5bfe876f57 | ||
|
|
6a31a1968e |
17
Readme.md
17
Readme.md
@@ -1,7 +1,7 @@
|
|||||||
## UriBuilder.Fluent
|
## UriBuilder.Fluent
|
||||||
[](https://coveralls.io/github/TerribleDev/UriBuilder.Fluent) [](https://ci.appveyor.com/project/tparnell8/uribuilder-fluent/branch/master)
|
[](https://coveralls.io/github/TerribleDev/UriBuilder.Fluent) [](https://ci.appveyor.com/project/tparnell8/uribuilder-fluent/branch/master)
|
||||||
|
|
||||||
This places extension methods over System.UriBuilder to help deal with query string parameters, and create more of a fluent interface. Unlike other projects this builds ontop of trusty UriBuilder, and does not use custom Uri generators, or have outside dependencies.
|
This places extension methods over System.UriBuilder to help deal with query string parameters, and create more of a fluent interface. Unlike other projects, this NetStandardLibrary compliant package builds ontop of trusty UriBuilder, does not use custom Uri generators, or have outside dependencies. Unit tests continue to be a first class citizen!
|
||||||
|
|
||||||
This lets you do things like
|
This lets you do things like
|
||||||
|
|
||||||
@@ -32,6 +32,19 @@ new UriBuilder("https://awesome.com/yo)
|
|||||||
```
|
```
|
||||||
result: `https://awesome.com/yo?id=5`
|
result: `https://awesome.com/yo?id=5`
|
||||||
|
|
||||||
|
you can even pass a dictionary of parameters
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
var dictionary = new Dictionary<string, string>()
|
||||||
|
{
|
||||||
|
["yo"] = "dawg"
|
||||||
|
};
|
||||||
|
new UriBuilder("http://awesome.com")
|
||||||
|
.WithParameter(dictionary);
|
||||||
|
http://awesome.com/?yo=dawg
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
Just install the nuget package `install-package UriBuilder.Fluent` and thats it. The extension methods should be avalbile to you!
|
Just install the nuget package `install-package UriBuilder.Fluent` and thats it. The extension methods should be available to you!
|
||||||
@@ -116,5 +116,19 @@ namespace FluentUriBuilder.Tests
|
|||||||
.WithParameter("supgf", "no22");
|
.WithParameter("supgf", "no22");
|
||||||
Assert.Equal("http://awesome.com/?awesome=yodawg&supg=no2&supgf=no22", url.Uri.ToString());
|
Assert.Equal("http://awesome.com/?awesome=yodawg&supg=no2&supgf=no22", url.Uri.ToString());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void AddDictOfParams()
|
||||||
|
{
|
||||||
|
var dictionary = new Dictionary<string, string>()
|
||||||
|
{
|
||||||
|
["yo"] = "dawg",
|
||||||
|
["troll"] = "toll",
|
||||||
|
["hammer"] = string.Empty
|
||||||
|
};
|
||||||
|
var url = new UriBuilder("http://awesome.com")
|
||||||
|
.WithParameter(dictionary);
|
||||||
|
Assert.Equal("http://awesome.com/?yo=dawg&troll=toll&hammer", url.Uri.ToString());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -16,6 +16,7 @@ namespace FluentUriBuilder.Tests
|
|||||||
Assert.Throws<ArgumentNullException>(() => tstObj.WithPathSegment(null));
|
Assert.Throws<ArgumentNullException>(() => tstObj.WithPathSegment(null));
|
||||||
Assert.Throws<ArgumentNullException>(() => tstObj.WithScheme(null));
|
Assert.Throws<ArgumentNullException>(() => tstObj.WithScheme(null));
|
||||||
Assert.Throws<ArgumentNullException>(() => tstObj.WithHost(null));
|
Assert.Throws<ArgumentNullException>(() => tstObj.WithHost(null));
|
||||||
|
Assert.Throws<ArgumentNullException>(() => tstObj.WithParameter(parameterDictionary: null));
|
||||||
Assert.Throws<ArgumentOutOfRangeException>(() => tstObj.WithPort(-1));
|
Assert.Throws<ArgumentOutOfRangeException>(() => tstObj.WithPort(-1));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,8 +8,39 @@ namespace System
|
|||||||
{
|
{
|
||||||
public static class TerribleDevUriExtensions
|
public static class TerribleDevUriExtensions
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Appends a query string parameter with a key, and many values. Multiple values will be comma seperated. If only 1 value is passed and its null or value, the key will be added to the QS.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="key"></param>
|
||||||
|
/// <param name="values"></param>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder WithParameter(this UriBuilder bld, string key, params string[] values) => bld.WithParameter(key, valuesEnum: values);
|
public static UriBuilder WithParameter(this UriBuilder bld, string key, params string[] values) => bld.WithParameter(key, valuesEnum: values);
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Appends query strings from dictionary
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="parameterDictionary"></param>
|
||||||
|
/// <exception cref="ArgumentNullException"></exception>
|
||||||
|
/// <returns></returns>
|
||||||
|
public static UriBuilder WithParameter(this UriBuilder bld, IDictionary<string, string> parameterDictionary)
|
||||||
|
{
|
||||||
|
if(parameterDictionary == null) throw new ArgumentNullException(nameof(parameterDictionary));
|
||||||
|
foreach(var item in parameterDictionary)
|
||||||
|
{
|
||||||
|
bld.WithParameter(item.Key, item.Value);
|
||||||
|
}
|
||||||
|
return bld;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Appends a query string parameter with a key, and many values. Multiple values will be comma seperated. If only 1 value is passed and its null or value, the key will be added to the QS.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="key"></param>
|
||||||
|
/// <param name="valuesEnum"></param>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder WithParameter(this UriBuilder bld, string key, IEnumerable<object> valuesEnum)
|
public static UriBuilder WithParameter(this UriBuilder bld, string key, IEnumerable<object> valuesEnum)
|
||||||
{
|
{
|
||||||
if(string.IsNullOrWhiteSpace(key))
|
if(string.IsNullOrWhiteSpace(key))
|
||||||
@@ -20,8 +51,7 @@ namespace System
|
|||||||
{
|
{
|
||||||
valuesEnum = new string[0];
|
valuesEnum = new string[0];
|
||||||
}
|
}
|
||||||
var isfirst = string.IsNullOrWhiteSpace(bld.Query);
|
var intitialValue = string.IsNullOrWhiteSpace(bld.Query) ? "" : $"{bld.Query.TrimStart('?')}&";
|
||||||
var intitialValue = isfirst ? "" : $"{bld.Query.TrimStart('?')}&";
|
|
||||||
var sb = new StringBuilder($"{intitialValue}{key}");
|
var sb = new StringBuilder($"{intitialValue}{key}");
|
||||||
var validValueHit = false;
|
var validValueHit = false;
|
||||||
foreach(var value in valuesEnum)
|
foreach(var value in valuesEnum)
|
||||||
@@ -37,6 +67,13 @@ namespace System
|
|||||||
return bld;
|
return bld;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Sets the port to be the port number
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="port"></param>
|
||||||
|
/// <exception cref="ArgumentOutOfRangeException">Throws if port is less than one</exception>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder WithPort(this UriBuilder bld, int port)
|
public static UriBuilder WithPort(this UriBuilder bld, int port)
|
||||||
{
|
{
|
||||||
if(port < 1) throw new ArgumentOutOfRangeException(nameof(port));
|
if(port < 1) throw new ArgumentOutOfRangeException(nameof(port));
|
||||||
@@ -44,6 +81,13 @@ namespace System
|
|||||||
return bld;
|
return bld;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// appends a path segment to the path. Can be called multiple times to append multiple segments
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="pathSegment"></param>
|
||||||
|
/// <exception cref="ArgumentNullException">You pass a string as a path segment</exception>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder WithPathSegment(this UriBuilder bld, string pathSegment)
|
public static UriBuilder WithPathSegment(this UriBuilder bld, string pathSegment)
|
||||||
{
|
{
|
||||||
if(string.IsNullOrWhiteSpace(pathSegment))
|
if(string.IsNullOrWhiteSpace(pathSegment))
|
||||||
@@ -55,6 +99,13 @@ namespace System
|
|||||||
return bld;
|
return bld;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Sets your Uri Scheme
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="scheme"></param>
|
||||||
|
/// <exception cref="ArgumentNullException">You must pass a scheme</exception>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder WithScheme(this UriBuilder bld, string scheme)
|
public static UriBuilder WithScheme(this UriBuilder bld, string scheme)
|
||||||
{
|
{
|
||||||
if(string.IsNullOrWhiteSpace(scheme)) throw new ArgumentNullException(nameof(scheme));
|
if(string.IsNullOrWhiteSpace(scheme)) throw new ArgumentNullException(nameof(scheme));
|
||||||
@@ -62,6 +113,13 @@ namespace System
|
|||||||
return bld;
|
return bld;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="host"></param>
|
||||||
|
/// <exception cref="ArgumentNullException">You must pass a ho0st</exception>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder WithHost(this UriBuilder bld, string host)
|
public static UriBuilder WithHost(this UriBuilder bld, string host)
|
||||||
{
|
{
|
||||||
if(string.IsNullOrWhiteSpace(host)) throw new ArgumentNullException(nameof(host));
|
if(string.IsNullOrWhiteSpace(host)) throw new ArgumentNullException(nameof(host));
|
||||||
@@ -69,6 +127,12 @@ namespace System
|
|||||||
return bld;
|
return bld;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Use Https?
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="bld"></param>
|
||||||
|
/// <param name="predicate">default true, if false sets scheme to http</param>
|
||||||
|
/// <returns></returns>
|
||||||
public static UriBuilder UseHttps(this UriBuilder bld, bool predicate = true)
|
public static UriBuilder UseHttps(this UriBuilder bld, bool predicate = true)
|
||||||
{
|
{
|
||||||
bld.Scheme = predicate ? "https" : "http";
|
bld.Scheme = predicate ? "https" : "http";
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
"owners": [
|
"owners": [
|
||||||
"Tommy Parnell"
|
"Tommy Parnell"
|
||||||
],
|
],
|
||||||
"projectUrl": "https://github.com/tparnell8/TurboLinks.Net",
|
"projectUrl": "https://github.com/TerribleDev/UriBuilder.Fluent",
|
||||||
"summary": "Fluent extensions for UriBuilder",
|
"summary": "Fluent extensions for UriBuilder",
|
||||||
"tags": [
|
"tags": [
|
||||||
"Url building",
|
"Url building",
|
||||||
@@ -14,14 +14,17 @@
|
|||||||
"extension"
|
"extension"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"dependencies": {
|
|
||||||
"NETStandard.Library": "1.6.0"
|
|
||||||
},
|
|
||||||
"authors": [
|
"authors": [
|
||||||
"Tommy Parnell"
|
"Tommy Parnell"
|
||||||
],
|
],
|
||||||
"frameworks": {
|
"frameworks": {
|
||||||
"netstandard1.3": {
|
"netstandard1.1": {
|
||||||
|
"imports": "dnxcore50",
|
||||||
|
"dependencies": {
|
||||||
|
"NETStandard.Library": "1.6.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"net40": {
|
||||||
"imports": "dnxcore50"
|
"imports": "dnxcore50"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user