SharpGrip.FileSystem.Adapters.AmazonS3 1.0.0-beta1

.NET Standard 2.0
This is a prerelease version of SharpGrip.FileSystem.Adapters.AmazonS3.
Install-Package SharpGrip.FileSystem.Adapters.AmazonS3 -Version 1.0.0-beta1
dotnet add package SharpGrip.FileSystem.Adapters.AmazonS3 --version 1.0.0-beta1
<PackageReference Include="SharpGrip.FileSystem.Adapters.AmazonS3" Version="1.0.0-beta1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SharpGrip.FileSystem.Adapters.AmazonS3 --version 1.0.0-beta1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SharpGrip.FileSystem.Adapters.AmazonS3, 1.0.0-beta1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install SharpGrip.FileSystem.Adapters.AmazonS3 as a Cake Addin
#addin nuget:?package=SharpGrip.FileSystem.Adapters.AmazonS3&version=1.0.0-beta1&prerelease

// Install SharpGrip.FileSystem.Adapters.AmazonS3 as a Cake Tool
#tool nuget:?package=SharpGrip.FileSystem.Adapters.AmazonS3&version=1.0.0-beta1&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SharpGrip FileSystem NuGet

Builds

FileSystem [Build]

Quality Gate Status
Maintainability Rating
Reliability Rating
Security Rating
Coverage

Introduction

SharpGrip FileSystem is a file system abstraction supporting multiple adapters.

Installation

Reference NuGet package SharpGrip.FileSystem (https://www.nuget.org/packages/SharpGrip.FileSystem).

For adapters other than the local file system (included in the SharpGrip.FileSystem package) please see the Supported adapters section.

Supported adapters

Adapter Package NuGet
Local adapter SharpGrip.FileSystem NuGet
AmazonS3 SharpGrip.FileSystem.Adapters.AmazonS3 NuGet
AzureBlobStorage SharpGrip.FileSystem.Adapters.AzureBlobStorage NuGet
AzureFileStorage SharpGrip.FileSystem.Adapters.AzureFileStorage NuGet
Dropbox SharpGrip.FileSystem.Adapters.Dropbox NuGet
MicrosoftOneDrive SharpGrip.FileSystem.Adapters.MicrosoftOneDrive NuGet
SFTP SharpGrip.FileSystem.Adapters.Sftp NuGet

Supported operations

For a full list of the supported operations please see the IFileSystem interface.

Usage

Instantiation

var adapters = new List<IAdapter>
{
    new LocalAdapter("adapterPrefix", "adapterRootPath")
};

// Instantiation option 1.
var fileSystem = new FileSystem(adapters);

// Instantiation option 2.
var fileSystem = new FileSystem();
fileSystem.Adapters = adapters;

Local adapter

var adapters = new List<IAdapter>
{
    new LocalAdapter("local1", "/var/files"),
    new LocalAdapter("local2", "D:\\Files")
};

var fileSystem = new FileSystem(adapters);

AmazonS3 adapter

// Amazon connection.
var amazonClient = new AmazonS3Client("awsAccessKeyId", "awsSecretAccessKey", RegionEndpoint.USEast2);

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new AmazonS3Adapter("amazon", "/Files", amazonClient, "bucketName")
};

var fileSystem = new FileSystem(adapters);

AzureBlobStorage adapter

// Azure connection.
var blobServiceClient = new BlobServiceClient("connectionString");
var azureClient = blobServiceClient.GetBlobContainerClient("blobContainerName");

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new AzureBlobStorageAdapter("azure", "/Files", azureClient)
};

var fileSystem = new FileSystem(adapters);

AzureFileStorage adapter

// Azure connection.
var azureClient = new ShareClient("connectionString", "shareName");

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new AzureFileStorageAdapter("azure", "/Files", azureClient)
};

var fileSystem = new FileSystem(adapters);

Dropbox adapter

// Dropbox connection.
var dropboxClient = new DropboxClient("oAuth2AccessToken");

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new DropboxAdapter("dropbox", "/Files", dropboxClient)
};

var fileSystem = new FileSystem(adapters);

MicrosoftOneDrive adapter

// Microsoft connection.
var scopes = new[] {"https://graph.microsoft.com/.default"};
var tenantId = "tenantId";
var confidentialClient = ConfidentialClientApplicationBuilder
    .Create("clientId")
    .WithAuthority($"https://login.microsoftonline.com/{tenantId}/v2.0")
    .WithClientSecret("clientSecret")
    .Build();
var oneDriveClient = new GraphServiceClient(new DelegateAuthenticationProvider(async requestMessage =>
    {
        var authResult = await confidentialClient.AcquireTokenForClient(scopes).ExecuteAsync();
        requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", authResult.AccessToken);
    })
);

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new MicrosoftOneDriveAdapter("onedrive", "/Files", oneDriveClient, "driveId")
};

var fileSystem = new FileSystem(adapters);

SFTP adapter

// SFTP connection.
var privateKeyFile = new PrivateKeyFile("/home/userName/.ssh/id_rsa");
var privateKeyAuthenticationMethod = new PrivateKeyAuthenticationMethod("userName", privateKeyFile);
var sftpConnectionInfo = new ConnectionInfo("hostName", "userName", privateKeyAuthenticationMethod);
var sftpClient = new SftpClient(sftpConnectionInfo);

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new SftpAdapter("sftp", "/var/files", sftpClient)
};

var fileSystem = new FileSystem(adapters);

Example operations

// Azure connection.
var azureClient = new ShareClient("connectionString", "shareName");

// Dropbox connection.
var dropboxClient = new DropboxClient("oAuth2AccessToken");

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new AzureFileStorageAdapter("azure", "/Files", azureClient),
    new DropboxAdapter("dropbox", "/Files", dropboxClient)
};

// Copies a file from the `local` adapter to the `azure` adapter.
await fileSystem.CopyFileAsync("local://foo/bar.txt", "azure://bar/foo.txt");

// Moves a file from the `azure` adapter to the `dropbox` adapter.
await fileSystem.MoveFileAsync("azure://Foo/Bar.txt", "dropbox://Bar/Foo.txt");

// Writes string contents to the `azure` adapter.
await fileSystem.WriteFileAsync("azure://Foo.txt", "Bar!");

// Reads a text file from the `dropbox` adapter.
var contents = fileSystem.ReadTextFileAsync("dropbox://Foo.txt");
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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.0.0-beta1 1,058 5/14/2022
1.0.0-alpha3 2,964 7/7/2020
1.0.0-alpha2 1,389 5/28/2020
1.0.0-alpha1 4,087 5/13/2020