Summary

NuGet is just plain hard to work with.  I know you shouldn’t throw stones in glass houses and all that.  I’m sure many people think my contributions to Naos are terribly written code.  All that said, I personally think the entire NuGet stack is terribly written code.  Its got far too many layers, zero to terrible documentation, hard to read, hard to follow, counter-intuitive, etc.  Since I needed to be able to simply download packages for use in the Naos.Deployment work I created this library to hide and document all the scariness necessary to download packages from either a private repository or the public one using .NET.

Project

Naos is an opensource project dedicated to providing infrastructure tools for free to aid in small companies having solid platforms to launch on, learn more at http://naosproject.com.

Source

The entire project is open sourced under the MIT license and available at: https://github.com/NaosFramework/Naos.Packaging

Referencing

It’s best to reference the NuGet package: http://www.nuget.org/packages/Naos.Packaging.NuGet which will provide a more feature rich interaction with packages…

The specific NuGet operations using the prototcol are included in a single file which can be copied into your project without a Naos depedency in your project (will still REQUIRE package NuGet.PackageManagement):https://raw.githubusercontent.com/NaosProject/Naos.Packaging/master/Naos.Packaging.NuGet/NuGetPackageManager.cs.

Use

Below is an example of usage in C#.

// this is how you would use the full retriever
[Fact(Skip = "Meant for local debugging and to show usage.")]
public void DownloadPrivate()
{
        var repoConfig = new PackageRepositoryConfiguration
                            {
                                Source = "https://ci.appveyor.com/nuget/XXX",
                                ClearTextPassword = "ThisIsPassword",
                                Username = "ThisIsUser",
                                SourceName = "ThisIsGalleryName",
                                ProtocolVersion = 2,
                            };

    var defaultWorkingDirectory = @"D:\Temp\NewNuGet";
    var pm = new PackageRetriever(repoConfig, defaultWorkingDirectory);
    var bundleAllDependencies = false;
    var package = pm.GetPackage(new PackageDescription { Id = "ThisIsPackage" }, bundleAllDependencies);
    Assert.NotNull(package.PackageFileBytes);
}

[Fact(Skip = "Meant for local debugging and to show usage.")]
public void DownloadPublic()
{
    var defaultWorkingDirectory = @"D:\Temp\NewNuGet";
    var pm = new PackageRetriever(defaultWorkingDirectory);
    var bundleAllDependencies = false;
    var package = pm.GetPackage(new PackageDescription { Id = "Newtonsoft.Json" }, bundleAllDependencies);
    Assert.NotNull(package.PackageFileBytes);
}

// this is how you would use the NuGet only file
[Fact(Skip = "Meant for local debugging and to show usage.")]
public void DownloadPrivate()
{
    var defaultWorkingDirectory = @"D:\Temp\NewNuGet";
    var downloadDirectory = Path.Combine(defaultWorkingDirectory, Guid.NewGuid() + ".tmp");

    var pm = new NuGetPackageManager(2, "ThisIsGalleryName", "https://ci.appveyor.com/nuget/XXX", "ThisIsUser", "ThisIsPassword");

    var includeUnlisted = true;
    var includePreRelease = true;
    var latestVersionTask = pm.GetLatestVersionAsync("ThisIsPackageId", includeUnlisted, includePreRelease);
    latestVersionTask.Wait();
    var version = latestVersionTask.Result;

    var includeDependencies = true;

    pm.DownloadPackageToPathAsync(
        "ThisIsPackageid",
        version,
        downloadDirectory,
        includeDependencies,
        includeUnlisted,
        includePreRelease).Wait();
}

[Fact]
public void DownloadPublic()
{
    var defaultWorkingDirectory = @"D:\Temp\NewNuGet";
    var downloadDirectory = Path.Combine(defaultWorkingDirectory, Guid.NewGuid() + ".tmp");

    var pm = new NuGetPackageManager();

    var includeUnlisted = true;
    var includePreRelease = true;
    var latestVersionTask = pm.GetLatestVersionAsync("Newtonsoft.Json", includeUnlisted, includePreRelease);
    latestVersionTask.Wait();
    var version = latestVersionTask.Result;

    var includeDependencies = true;

    pm.DownloadPackageToPathAsync(
        "Newtonsoft.Json",
        version,
        downloadDirectory,
        includeDependencies,
        includeUnlisted,
        includePreRelease).Wait();
}

Summary

Microsoft sort of recommends the HttpClient but I really just don’t like the interface on it.  I wanted something that sat on top of the .NET Uri object without having to new up anything else.  I also really like the fluent interface for work like this because its easy to see where the components came from rather than using format strings.  Naos.FluentUri was created to simply clean up the way I called RESTful services from .NET.

Project

Naos is an opensource project dedicated to providing infrastructure tools for free to aid in small companies having solid platforms to launch on, learn more at http://naosproject.com.

Source

The entire project is open sourced under the MIT license and available at: https://github.com/NaosFramework/Naos.FluentUri

Referencing

The entire implemenation is in a single file so it can be included without taking a dependency on the NuGet package if necessary preferred.

• Reference the NuGet package: http://www.nuget.org/packages/Naos.FluentUri.
  OR
• Include the single file in your project:https://raw.githubusercontent.com/NaosFramework/Naos.FluentUri/master/Naos.FluentUri/Naos.FluentUri.cs.

Use – Building up the URL

• Adding segments to the URL
  • To get http://baseUrlOfService/subPath use new Uri("http://baseUrlOfService").AppendPathSegment("subPath");
  • Trailing slashes are handled… http://baseUrlOfService/subPath can also be done using new Uri("http://baseUrlOfService/").AppendPathSegment("subPath");
• Adding query string parameters
  • To get http://url?myParam=aValue use new Uri(http://url).AppendQueryStringParam("myParam", "aValue");
  • Can also be done in batches by using .AppendQueryStringParams(/* IDictionary<string, string> */); or .AppendQueryStringParams(/* ICollection<KeyValuePair<string, string>> */);
  • Will work correctly out of order too… http://url/path?q=hello can be done using new Uri("http://url").AppendQueryStringParam("q", "hello").AppendPathSegment("path"); although this is not really recommended as it doesn’t read great…

Use – Calling the URL

• Void Return vs. Typed Return
  • Void Return Usage:
    • new Uri("http://api/Objects/42/Setting").Put();
  • Typed Return Usage:
    • MyObject returnedData = net Uri("http://api/Objects/42").Get<MyObject>();
• The four main verbs are currently supported as first class methods as well as a method to pass any verb as a string.
  • GET – new Uri("http://api/Objects/42").Get();
  • POST – new Uri("http://api/Objects/").Post();
  • PUT – new Uri("http://api/Objects/42/Setting").Put();
  • DELETE – new Uri("http://api/Objects/42").Delete();
  • “Custom Verb” – new Uri("http://api/Objects/42").CallWithVerb("Custom Verb");
• There are additional decorators for the call for standard operations.
  • Add a body to the request:
    • new Uri("http://api/Objects/").WithBody(new MyObject()).Post();
  • Add a cookie to the request:
    • // Cookie can also be of type HttpCookie...
    • var cookie = new Cookie(".ASPXAUTH", "[AuthCookieValue]") { Expires = DateTime.Now.AddDays(30) };
    • var obj = new Uri("http://api/Objects/42").WithCookie(cookie).Get<MyObject>();
  • Add headers to the request:
    • // Headers can also be of type WebHeaderCollection or NameValueCollection..
    • var headers = new[] { new KeyValuePair<string, string>("Auth-Token", "[AuthTokenValue]") };
    • var obj = new Uri("http://api/Objects/42").WithHeaders(headers).Get<MyObject>();
  • Update the timeout of the request:
    • var obj = new Uri("http://api/Objects/42").WithTimeout(TimeSpan.FromHours(1)).Get<MyObject>();
  • Save response headers using a lambda:
    • KeyValuePair<string, string>[] responseHeadersFromCall;
    • new Uri("http://api/Auth/Login").WithResponseHeaderSaveAction(responseHeaders => responseHeadersFromCall = responseHeaders).Post();

Use – Combined

C# Example of making and authentication call.

var loginResponse = new Uri("http://auth.services.com")
                                     .AppendPathSegment("login")
                                     .WithBody(loginRequest)
                                     .Post();

C# Example of updating a users’ zip code.

new Uri("http://user.services.com")
            .AppendPathSegment("user")
            .AppendPathSegment(user.Id)
            .AppendPathSegment("zipCode")
            .AppendPathSegment(user.ZipCode)
            .WithCookie(authCookieToAllowThis)
            .Put();

Summary

This is a standard problem space that Microsoft, for whatever reason, has chosen not to solve.  The two problems are 1) you can’t run remote commands on a windows computer from .NET code 2) you can’t send or receive a file via the WinRM Protocol.  I wrote Naos.WinRM to solve both of these.

Project

Naos is an opensource project dedicated to providing infrastructure tools for free to aid in small companies having solid platforms to launch on, learn more at http://naosproject.com.

Source

The entire project is open sourced under the MIT license and available at: https://github.com/NaosFramework/Naos.WinRM

Referencing

The entire implemenation is in a single file so it can be included without taking a dependency on the NuGet package if that is necessary or preferred.

• Reference the NuGet package: http://www.nuget.org/packages/Naos.WinRM.
  OR
• Include the single file (will still REQUIRE System.Management.Automation.dll reference or package reference to Naos.External.MS-WinRM) in your project: https://raw.githubusercontent.com/NaosFramework/Naos.WinRM/master/Naos.WinRM/Naos.WinRM.cs.

Use

Below is an example of usage in C#.

// this is the entrypoint to interact with the system (interfaced for testing).
var machineManager = new MachineManager(
    "10.0.0.1",
    "Administrator",
    MachineManager.ConvertStringToSecureString("xxx"),
    true);

// will perform a user initiated reboot.
machineManager.Reboot();

// can run random script blocks WITH parameters.
var fileObjects = machineManager.RunScript("{ param($path) ls $path }", new[] { @"C:\PathToList" });

// can transfer files to AND from the remote server (over WinRM's protocol!).
var localFilePath = @"D:\Temp\BigFileLocal.nupkg";
var fileBytes = File.ReadAllBytes(localFilePath);
var remoteFilePath = @"D:\Temp\BigFileRemote.nupkg";

machineManager.SendFile(remoteFilePath, fileBytes);
var downloadedBytes = machineManager.RetrieveFile(remoteFilePath);