Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitaldias/translate
Wrapper for using the Microsoft Cognitive Translation Service
https://github.com/digitaldias/translate
csharp ddd microsoft-cognitive-services solid translate
Last synced: 17 days ago
JSON representation
Wrapper for using the Microsoft Cognitive Translation Service
- Host: GitHub
- URL: https://github.com/digitaldias/translate
- Owner: digitaldias
- Created: 2017-04-05T08:17:40.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-17T10:16:45.000Z (over 6 years ago)
- Last Synced: 2024-11-13T05:42:10.077Z (3 months ago)
- Topics: csharp, ddd, microsoft-cognitive-services, solid, translate
- Language: C#
- Size: 70.3 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://bettercodehub.com/)
# Translate
This repository defines the **TranslationService** and includes a sample console application to translate text between all supported languages of the [Microsoft Cognitive Translation API](https://www.microsoft.com/cognitive-services/en-us/translator-api)
**TranslationService** automatically requests a new authentication token every 9 minutes (Translate API provides a 10-minute token), and performs the Microsoft Translation API calls masking away the details of each REST invocation.
The list of API methods can be found [here](http://docs.microsofttranslator.com/text-translate.html#!/default).
## TranslationService Details
### Methods and properties
```csharp
// Translate text from one language to another
string TranslateSingle(TranslationRequest)
// Dictionary of supported languages, populated during startup
Dictionary SupportedLanguages { get; }
// Detect the language used in a chunk of text
Language DetectLanguage(string text)
// Break a text up into sentences and then return the character length for each sentence
IEnumerable BreakSentences(Language language, string text)
```
### Entities
```csharp
public class Language
{
public string Name { get; set; }
public string Code { get; set; }
}
public class TranslationRequest
{
public Language From { get; set; }
public Language To { get; set; }
public string Text { get; set; }
}
```
## Quickstart / Running the code
* Follow [this guide](http://docs.microsofttranslator.com/text-translate.html) to create a cognitive services client in Azure
* Create the file **Translate-Secrets.json** in your **My Documents** folder and paste in the Json structure at the bottom of this document.
## Contributions welcome!
I'm happy to accept any contributions to make this wrapper as useful as possible! The more, the merrier!
A couple of notes:
- The project was written in [Visual Studio 2017](https://www.visualstudio.com). In order to work on this code, you only need the Community Edition.
- Please write [useful commit messages](https://chris.beams.io/posts/git-commit/)
- I am a strong believer in Unit-Testing and TDD. Please ensure adequate test-coverage for your logic
- [XUnit.Net](https://xunit.github.io/) is used as the test framwork
- Follow the code-style used. It is based on proven patterns and practices :)
## A note on secrets
You need to provide the Account Name and key to the framework, and of course, saving that into source-code is not considered great practice.
The framework therefore exposes the following interface named **ISettingsReader**:
```csharp
namespace Translate.Domain.Contracts
{
public interface ISettingsReader
{
string this[string name] { get; }
}
}
```
The implementation of this interface can be found in the **Translate.Data.File** project, where I'm simply reading the settings from a Json file stored in **My Documents**.
You can implement your own *SettingsReader* to obtain the AccountName and AccountKey, or you can opt-in on the already
provided implementation
In the project, the console application is named **Translate.exe** so there is a corresponding
***Translate-Secrets.Json*** in my **My Documents** folder
## Attributions
The following external nuGet packages are part of the solution:
| Nuget Package | Purpose |
| ------------- | ------- |
| [StructureMap](http://www.nuget.org/packages/StructureMap/) | IoC Container |
| [StructureMap.AutoMocking.Moq](http://www.nuget.org/packages/structuremap.automocking.moq/) | For baseclass in unit-testing |
| [Moq](http://www.nuget.org/packages/Moq/) | My favourite mocking framework |
| [Should](http://www.nuget.org/packages/Should/) | For writing fluent assertions |
| [NewtonSoft.Json](https://www.nuget.org/packages/Newtonsoft.Json) | For working with Json |
| [xUnit](http://www.nuget.org/packages/xunit/) | Unit testing framework |
| [RestSharp](http://www.nuget.org/packages/RestSharp/) | for performing restful operations |
| [nBuilder](https://code.google.com/archive/p/nbuilder/) | For rapid testdata creation |
## Resources
Contents of Translate-Secrets.json:
```Json
{
"Translator:AccountName" : "[Your Account Name]",
"Translator:AccountKey" : "[Your Account Key]"
}
```
Save this file in **My Documents** folder