Shift-it 1.8.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Shift-it --version 1.8.0
NuGet\Install-Package Shift-it -Version 1.8.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Shift-it" Version="1.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shift-it --version 1.8.0
#r "nuget: Shift-it, 1.8.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Shift-it as a Cake Addin
#addin nuget:?package=Shift-it&version=1.8.0

// Install Shift-it as a Cake Tool
#tool nuget:?package=Shift-it&version=1.8.0

Shift-it

Collection of low-level HTTP and FTP file transfer tools

https://www.nuget.org/packages/Shift-it/

Why?

.Net has some pretty good FTP and HTTP libraries built in. However, they aren't amazingly unit-test friendly. They also wrap a lot of status results in exceptions. The protocol strictness of the libraries is also problematic when dealing with the general internet.

FTP

An old and battle hardend FTP client library, works with many old and cranky FTP servers that the standard .Net libraries can't handle.

HTTP

A HTTP client that can accept a reasonable level of invalid protocol from servers. This is a blocking, synchronous library that uses only .Net sockets, not WebClient or HttpWebRequest, and has a lot of replaceable components.

Example GET:

var rq = new HttpRequestBuilder().Get(new Uri("https://www.nuget.org/")).Build();
using (var result = _subject.Request(rq)) {
    var body = result.BodyReader.ReadStringToLength();
    // . . .
}

Example POST string data, without reading result:

var client = new HttpClient();
var postRq = new HttpRequestBuilder().Put(new Uri("https://target.example.com/resource")).Build("Hello, world");
client.Request(postRq).Dispose();

Example with upload and download with files and progress:

long uploadBytes = 0;
long downloadBytes = 0;

using (var fs = File.OpenRead(@"C:\my\file.dat"))
{
    var rq = new HttpRequestBuilder()
    .Post(new Uri("http://myserver.com/whatever"))
    .Build(fs, fs.Length);

    using (var result = new HttpClient().Request(rq, b => uploadBytes = b))
    {
        var responseString = result.BodyReader.ReadStringToLength(b => downloadBytes = b);
    }
}

Performance

Thanks to skolima for these:

=== 14MB file

Measured on Windows
Time taken        Mem         Method
->2849ms          29MB        Web client
->2657ms          20MB        Web Client - stream copy, no hash
->2647ms          16MB        Web Client - stream copy, Shift-It hash
->1575ms          0MB         ShiftIt [current]
->1592ms          0MB         ShiftIt - no hashing [current]
->1616ms          0MB         ShiftIt - no compression [current]
->1574ms          0MB         ShiftIt - no hashing, no compression [current]


Measured on Mono + Linux + fast connection
Time taken        Mem     Method
->1763ms          30MB    Web client
->403ms           1MB     Web Client - stream copy, no hash
->651ms           16MB    Web Client - stream copy, Shift-It hash
->755ms           0MB     ShiftIt [current]
->603ms           0MB     ShiftIt - no hashing [current]
->762ms           0MB     ShiftIt - no compression [current]
->669ms           0MB     ShiftIt - no hashing, no compression [current]
->833ms           0MB     ShiftIt [previous]
->602ms           0MB     ShiftIt - no hashing [previous]
->903ms           0MB     ShiftIt - no compression [previous]
->601ms           0MB     ShiftIt - no hashing, no compression [previous]

=== 191MB file

Measured on Windows
Time taken        Mem        Method
->35378ms       638MB   Web client
->34211ms       334MB   Web Client - stream copy, no hash
->35382ms       320MB   Web Client - stream copy, Shift-It hash
->20292ms       0MB     ShiftIt [current]
->20157ms       0MB     ShiftIt - no hashing [current]
->20446ms       0MB     ShiftIt - no compression [current]
->19689ms       0MB     ShiftIt - no hashing, no compression [current]

Measured on Mono + Linux + fast connection
Time taken        Mem        Method
->17435ms       383MB   Web client
->5843ms        69MB    Web Client - stream copy, no hash
->9327ms        260MB   Web Client - stream copy, Shift-It hash
->12948ms       0MB     ShiftIt [current]
->8529ms        0MB     ShiftIt - no hashing [current]
->13472ms       0MB     ShiftIt - no compression [current]
->8108ms        0MB     ShiftIt - no hashing, no compression [current]
->13584ms       0MB     ShiftIt [previous]
->8237ms        0MB     ShiftIt - no hashing [previous]
->10648ms       0MB     ShiftIt - no compression [previous]
->7308ms        0MB     ShiftIt - no hashing, no compression [previous]

Todo

  • Digest authentication
  • chunked upload
Product Compatible and additional computed target framework versions.
.NET Framework net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.9.1 1,005 5/25/2022
1.9.0 1,418 2/12/2019
1.8.1 1,354 11/30/2018
1.8.0 1,584 5/22/2018
1.7.0 2,370 2/16/2015
1.6.0 2,117 4/17/2014
1.5.0 2,210 11/7/2013
1.4.4 1,819 11/7/2013
1.4.2 1,840 10/25/2013
1.4.1 1,874 10/22/2013
1.4.0 1,836 10/15/2013
1.3.1 1,895 10/1/2013
1.3.0 2,234 9/19/2013
1.2.5 1,805 9/10/2013
1.2.4 1,786 9/10/2013
1.2.3 1,831 9/3/2013
1.2.2 1,750 9/2/2013
1.2.1 5,422 7/2/2013
1.2.0 1,947 6/25/2013
1.1.1 1,885 4/22/2013
1.1.0 1,807 4/16/2013
1.0.2 1,831 4/15/2013
1.0.1 1,912 3/6/2013
1.0.0 1,838 3/6/2013

Adding progress functionality