Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ERNI-Academy/assets-cloud-storage-abstraction
With this package we standardize the usage and implementation of Azure Storage Blobs in all your code.
https://github.com/ERNI-Academy/assets-cloud-storage-abstraction
azure azure-storage blob-storage
Last synced: 3 months ago
JSON representation
With this package we standardize the usage and implementation of Azure Storage Blobs in all your code.
- Host: GitHub
- URL: https://github.com/ERNI-Academy/assets-cloud-storage-abstraction
- Owner: ERNI-Academy
- License: mit
- Created: 2022-01-27T09:41:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-21T22:44:17.000Z (over 2 years ago)
- Last Synced: 2024-05-12T06:33:57.321Z (6 months ago)
- Topics: azure, azure-storage, blob-storage
- Language: C#
- Homepage:
- Size: 151 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-resources - assets-cloud-storage-abstraction
README
# About
**Azure Blob storage** is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data. Unstructured data is data that doesn't adhere to a particular data model or definition, such as text or binary data.
About Blob storage
Blob storage is designed for:
- Serving images or documents directly to a browser.
- Storing files for distributed access.
- Streaming video and audio.
- Writing to log files.
- Storing data for backup and restore, disaster recovery, and archiving.
- Storing data for analysis by an on-premises or Azure-hosted service.
**Cloud Storage Abstraction** is a small dll ( on the next iteration, it will be a nuget package) that provides a robust and reusable implementations.
> With this package we standardize the usage and implementation of [Azure Storage Blobs](https://docs.microsoft.com/en-us/azure/storage/blobs/) in all your code.
>
> With this implementation you have both publish and subscriber clients available at one sight.
[](#contributors)
## Built With
- [.Net 6.0](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6)
- [c# 8](https://docs.microsoft.com/es-es/dotnet/csharp/whats-new/csharp-8)
## Features
- Create Container
- Upload Blob
- Get list of blobs
- Get concrete blob
- Delete blob
## Getting Started
At this point, we have to use this project like dll or directly on our production projects.
On next releases, we transform the solution into nuget.
## Pre-requisites
- [.Net 6.0](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6)
- [c# 8](https://docs.microsoft.com/es-es/dotnet/csharp/whats-new/csharp-8)
- [Azure Blob Storage Emulator](https://docs.microsoft.com/es-es/azure/storage/common/storage-use-emulator)
- [Azure Account](https://portal.azure.com)
## Dependencies
- Newtonsoft
- Azure.Storage.Blob v12
- .Net 6.0
- System.Text.Json
## Installation
```sh
git clone https://github.com/ERNI-Academy/assets-cloud-storage-abstraction.git
```
## Object definitions
### IBlobContainerClient
That contract contains all methods to manage a default CRUD.
```c#
public interface IBlobContainerClient
{
string GetConnectionString();
Task CreateContainerIfNotExist(string name = "");
Task UploadBlob(string id, object blob, string containerName);
Task Get(Guid id, string containerId);
IEnumerable Get(string containerId);
Task RemoveBlob(Guid id, string containerId);
}
```
### BlobContainerClient
That is the main implementation. It is the client to manage the CRUD operations with a concrete blob container.
```c#
public class BlobContainerClient : ContainerClientBase, IBlobContainerClient
{
private BlobServiceClient serviceClient;
public BlobContainerClient(IContainerServiceConfig config) : base(config){}
...
}
```
### IContainerServiceConfig
That contract specify the only way to assign a connectionstring to the **BlobContainerClient**
```c#
public interface IContainerServiceConfig
{
string GetConnectionString();
}
```
### ContainerServiceDevelopmentConfig
That implementation has the purpose to be used only to development environments. If you are developing and you want to use the local emulator, you could use that implementation. **but take care, that approach never can be used on production**
```c#
public class ContainerServiceDevelopmentConfig : IContainerServiceConfig
{
public string GetConnectionString()
{
return "UseDevelopmentStorage=true";
}
}
```
## Notes
- the interface **IContainerServiceConfig** has a default implementation that is forbidden use it on production. **ALWAYS RETURN** a connection string for the Azure Storage Emulator.
- You should implement your own class where you could manage your proper connectionstring
## samples
In order to run this sample, you need to have [Azure Blob Storage Emulator](https://docs.microsoft.com/es-es/azure/storage/common/storage-use-emulator)
```c#
IContainerServiceConfig config = new ContainerServiceDevelopmentConfig();
Console.WriteLine($"ConnectionString used: {config.GetConnectionString()}");
Console.WriteLine("first sample about upload an object");
IBlobContainerClient blobClient = new BlobContainerClient(config);
var obj = new { name = "Smith", age = 38 };
Guid id = Guid.NewGuid();
string containerName = "localcontainer";
Console.WriteLine($"object used: {obj}");
var blobLink = blobClient.UploadBlob(id.ToString(), obj, containerName).Result;
Console.WriteLine($"Http code response: {blobLink}");
```
- take care about that sample are instances directly. In general situation, we should use DI.
## Contributing
Please see our [Contribution Guide](CONTRIBUTING.md) to learn how to contribute.
## License
(LICENSE) © 2022 [ERNI - Swiss Software Engineering](https://www.betterask.erni)
## Code of conduct
Please see our [Code of Conduct](CODE_OF_CONDUCT.md)
## Stats
## Follow us
[](https://www.twitter.com/ERNI)
[](https://www.twitch.tv/erni_academy)
[](https://www.youtube.com/channel/UCkdDcxjml85-Ydn7Dc577WQ)
[](https://www.linkedin.com/company/erni)
## Contact
📧 [[email protected]](mailto:[email protected])
Manu Delgado - [@mdelgadodiaz83](https://twitter.com/MDelgadoDiaz83) - [email protected]
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
omaramalfi
💻 🖋 📖 🎨 🤔 🚧 ⚠️ 💡 👀
mdelgadodiaz83-erni
💻 🖋 📖 🎨 🤔 🚧 ⚠️ 💡 👀
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!