new feature(SpellCheck), Language structure changed, and much more

Author: Anton3413

README.md

@@ -3,7 +3,7 @@
 ![logotype](https://i.imgur.com/Mxbpi3N.jpeg)
 
 Java API wrapper to perform contextual translations, 
- find synonyms, voice text, conjugate verbs, and much more.
+ find synonyms, voice sourceText, conjugate verbs, and much more.
 
 Unfortunately,  complete information about the
 services used by Reverso is not available, though some are known.
@@ -34,7 +34,7 @@ public abstract class Response {
 
     private String sourceLanguage;
 
-    private String text;
+    private String sourceText;
 
     private String errorMessage;
 
@@ -55,30 +55,29 @@ translation or synonym search. It is represented as an **enum** with a
 list of all supported languages.
 ```java
 public enum Language {
-ARABIC("arabic", "ar", "ara", true),
-GERMAN("german", "de", "ger", true),
-ENGLISH("english", "en", "eng", true);
+    ARABIC("ar", true, null),
+    GERMAN("de", true, null),
+    ENGLISH("en", true, "eng"),
 }
 ```
 Each object in this enumeration has fields that help determine whether
 a specific language is supported for a given functionality. The fields 
 are arranged in the following sequence:
 
-1) `String fullName` <br>
-2) `String synonymName` <br>
-3) `String translateName` <br>
-4) `boolean conjugate`
+1) `String synonymName` <br>
+2) `boolean isConjugate` <br>
+3) `String spellCheckName`
 
 If any of these fields are false or null, it indicates that the language
 does not support the respective functionality.
 
 For example:
 ```java
-KOREAN("korean", null, "kor", false); 
+JAPANESE("ja", true, null);
 ```
-Since the second and fourth fields are **null** and **false**, 
-respectively, this means that **synonym** search and verb 
-**conjugation** are not available for *korean* language.
+
+The third field is null, this means that **spellCheck** are not available
+for *japanese* language.
 
 ## Usage
 The fundamental class, **Reverso**, manages all interactions with the API.
@@ -111,7 +110,7 @@ Here's the output :
 {
 "isOK": true,
 "sourceLanguage": "english",
-"text": "world",
+"sourceText": "world",
 "errorMessage": "null",
 "synonyms": {
 "Noun": [
@@ -130,7 +129,7 @@ arguments, such as the translation method, which is logical.
 ## getVoiceStream
 However, there is a method that differs slightly from the others:
 
-`VoiceResponse getVoiceStream(Voice voice, String text)`
+`VoiceResponse getVoiceStream(Voice voice, String sourceText)`
 
 For this method, you should pass one of the objects from the Voice enum. 
 The names of the objects and their fields can tell us the language they
@@ -145,7 +144,7 @@ GERMAN_ANDREAS("Andreas22k", "German", "M"),
 }
 ```
 Among other information, the VoiceResponse contains a byte array that 
-stores the audio file, which voices the required text. To get the audio 
+stores the audio file, which voices the required sourceText. To get the audio 
 data, you can use the following code:
 ```java
 Reverso reverso = new Reverso();
@@ -169,7 +168,7 @@ Here's an example of a successful response:
 {
 "isOK": true,
 "sourceLanguage": "english",
-"text": "hello",
+"sourceText": "hello",
 "targetLanguage": "russian",
 "translation": "привет",
 "contextTranslations": {
@@ -211,7 +210,7 @@ And console output:
 "isOK": false,
 "errorMessage": "Synonyms cannot be obtained for this language. A list of available languages can be found here: https://synonyms.reverso.net/synonym/",
 "sourceLanguage": "swedish",
-"text": "Skön"
+"sourceText": "Skön"
 }
 ```
 ## Credits

pom.xml

@@ -11,7 +11,7 @@
 
     <name>Reverso API</name>
     <description>Utilize our API wrapper to perform contextual translations,
-        find synonyms, voice text, conjugate verbs, and much more.</description>
+        find synonyms, voice sourceText, conjugate verbs, and much more.</description>
     <url>https://github.com/Anton3413/Reverso-Java-API</url>
 
     <licenses>

src/main/java/reverso/Main.java

@@ -1,13 +1,17 @@
 package reverso;
 
 
-
+import reverso.data.response.impl.SpellCheckResponse;
+import reverso.supportedLanguages.Language;
 
 public class Main {
     public static void main(String[] args) {
         Reverso reverso = new Reverso();
 
-       reverso.getSpellCheck();
+        SpellCheckResponse response = reverso.getSpellCheck(Language.ITALIAN,"here ve have errores, we shuld to fix it");
+
+        System.out.println(response.toJson());
 
+        System.out.println(response.getStats().toJson());
     }
 }

src/main/java/reverso/Reverso.java

@@ -1,9 +1,12 @@
 package reverso;
 
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
 import org.jsoup.Connection;
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import reverso.data.parser.HtmlParser;
+import reverso.data.request.SpellCheckRequest;
 import reverso.data.response.impl.*;
 import reverso.supportedLanguages.Language;
 import reverso.supportedLanguages.Voice;
@@ -17,6 +20,7 @@ public class Reverso {
     private static final String CONTEXT_URL = "https://context.reverso.net/translation/";
     private static final String VOICE_URL = "https://voice.reverso.net/RestPronunciation.svc/v1/output=json/GetVoiceStream/";
     private static final String CONJUGATION_URL = "https://conjugator.reverso.net/conjugation";
+    private static final String SPELLCHECK_URL = "https://orthographe.reverso.net/api/v1/Spelling";
 
     {
         initializeProperties();
@@ -26,7 +30,7 @@ public class Reverso {
     public SynonymResponse getSynonyms(Language language, String word) {
         if (language.getSynonymName() == null) {
             String errorMessage = properties.getProperty("message.error.synonym.unSupportedLanguage");
-            return new SynonymResponse(false, errorMessage, language.getFullName(), word);
+            return new SynonymResponse(false, errorMessage, language.toString(), word);
         }
         String URL = SYNONYM_URL + language.getSynonymName() + "/" + word;
 
@@ -38,30 +42,30 @@ public SynonymResponse getSynonyms(Language language, String word) {
                     .execute();
         } catch (IOException e) {
             String errorMessage = properties.getProperty("message.error.connection");
-            return new SynonymResponse(false, errorMessage, language.getFullName(), word);
+            return new SynonymResponse(false, errorMessage, language.toString(), word);
         }
         if (response.statusCode() == 404) {
             String errorMessage = properties.getProperty("message.error.synonym.noResults");
-            return new SynonymResponse(false, errorMessage, language.getFullName(), word);
+            return new SynonymResponse(false, errorMessage, language.toString(), word);
         }
         synonymsMap = parser.parseSynonymsPage(response);
         if (synonymsMap.isEmpty()) {
             String message = properties.getProperty("message.error.synonym.noResults");
-            return new SynonymResponse(false, message, language.getFullName(), word);
+            return new SynonymResponse(false, message, language.toString(), word);
         }
-        return new SynonymResponse(true, language.getFullName(), word, synonymsMap);
+        return new SynonymResponse(true, language.toString(), word, synonymsMap);
     }
 
     public ContextResponse getContext(Language sourceLanguage, Language targetLanguage, String word) {
 
-        ContextResponse contextResponse = new ContextResponse(false, null, sourceLanguage.getFullName(),
-                targetLanguage.getFullName(), word);
+        ContextResponse contextResponse = new ContextResponse(false, null, sourceLanguage.toString(),
+                targetLanguage.toString(), word);
 
         if (sourceLanguage.equals(targetLanguage)) {
             contextResponse.setErrorMessage(properties.getProperty("message.error.context.sameLanguage"));
             return contextResponse;
         }
-        String URL = CONTEXT_URL + sourceLanguage.getFullName() + "-" + targetLanguage.getFullName() + "/" + word;
+        String URL = CONTEXT_URL + sourceLanguage.toString() + "-" + targetLanguage.toString() + "/" + word;
 
         Document document;
         Map<String, String> contextMap;
@@ -127,13 +131,13 @@ public VoiceResponse getVoiceStream(Voice voice, String text) {
 
     public ConjugationResponse getWordConjugation(Language language, String word) {
 
-        ConjugationResponse conjugationResponse = new ConjugationResponse(false, null, language.getFullName(), word);
+        ConjugationResponse conjugationResponse = new ConjugationResponse(false, null, language.toString(), word);
 
         if (!language.isConjugate()) {
             conjugationResponse.setErrorMessage(properties.getProperty("message.error.conjugation.invalidLanguage"));
             return conjugationResponse;
         }
-        String URL = CONJUGATION_URL + "-" + language.getFullName() + "-" + "verb" + "-" + word + ".html";
+        String URL = CONJUGATION_URL + "-" + language.toString() + "-" + "verb" + "-" + word + ".html";
 
         Map<String, String[]> conjugationData;
         Connection.Response response;
@@ -156,6 +160,44 @@ public ConjugationResponse getWordConjugation(Language language, String word) {
         conjugationResponse.setOK(true);
         return conjugationResponse;
     }
+    public SpellCheckResponse getSpellCheck(Language language, String text) {
+
+        if (language.getSpellCheckName() == null) {
+            return new SpellCheckResponse(false, properties.getProperty("message.error.spellCheck.unsupportedLanguage"),
+                    language.toString(), text);
+        }
+
+        String requestJson = SpellCheckRequest.builder().withLanguage(language.getSpellCheckName())
+                .withText(text)
+                .withCorrectionDetails(false)
+                .toJson();
+
+        Connection.Response response;
+        String responseData;
+        try {
+            response = Jsoup.connect(SPELLCHECK_URL)
+                    .header("Content-Type", "application/json")
+                    .ignoreContentType(true)
+                    .ignoreHttpErrors(true)
+                    .requestBody(requestJson)
+                    .method(Connection.Method.POST)
+                    .execute();
+            responseData = response.body();
+        } catch (IOException e) {
+            return new SpellCheckResponse(false, properties.getProperty("message.error.connection"), language.toString(), text);
+        }
+        SpellCheckResponse spellCheckResponse = new Gson().fromJson(responseData, SpellCheckResponse.class);
+
+        if (spellCheckResponse.getCorrectedText().equals(text)) {
+            return new SpellCheckResponse(false, properties.getProperty("message.error.spellCheck.noErrorsOrMismatchedLanguage"),
+                    language.toString(), text);
+        }
+            spellCheckResponse.setOK(true);
+            spellCheckResponse.setSourceText(text);
+            spellCheckResponse.setSourceLanguage(language.toString());
+
+            return spellCheckResponse;
+    }
 
     private void initializeProperties() {
         try {

src/main/java/reverso/data/parser/HtmlParser.java

@@ -93,7 +93,6 @@ private String extractTextWithEmphasis(Element element) {
                 if (childElement.tagName().equals("em")) {
                     sb.append("<em>").append(childElement.html()).append("</em>");
                 } else {
-                    // Recursively handle nested elements
                     sb.append(extractTextWithEmphasis(childElement));
                 }
             }

src/main/java/reverso/data/request/SpellCheckRequest.java

@@ -0,0 +1,50 @@
+package reverso.data.request;
+
+import com.google.gson.GsonBuilder;
+
+public class SpellCheckRequest {
+    private String language;
+    private boolean correctionDetails;
+    private String origin;
+    private String text;
+
+    {
+        this.origin = "interactive";
+    }
+
+    private SpellCheckRequest() {
+    }
+
+
+    public String getLanguage() {
+        return language;
+    }
+
+    public String toJson() {
+        return new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create().toJson(this);
+    }
+
+    public static SpellCheckRequest builder() {
+        return new SpellCheckRequest();
+    }
+
+    public SpellCheckRequest withLanguage(String language) {
+        this.language = language;
+        return this;
+    }
+
+    public SpellCheckRequest withCorrectionDetails(boolean correctionDetails) {
+        this.correctionDetails= correctionDetails;
+        return this;
+    }
+
+    public SpellCheckRequest withOrigin(String origin) {
+        this.origin = origin;
+        return this;
+    }
+
+    public SpellCheckRequest withText(String text) {
+        this.text = text;
+        return this;
+    }
+}

src/main/java/reverso/data/response/Response.java

@@ -11,29 +11,30 @@ public abstract class Response {
 
     private String sourceLanguage;
 
-    private String text;
+    private String sourceText;
 
     private String errorMessage;
 
-    public Response(boolean isOK, String errorMessage, String sourceLanguage, String text) {
+    public Response(boolean isOK, String errorMessage, String sourceLanguage, String sourceText) {
         this.isOK = isOK;
         this.errorMessage = errorMessage;
         this.sourceLanguage = sourceLanguage;
-        this.text = text;
+        this.sourceText = sourceText;
     }
 
-    public Response(boolean isOK, String sourceLanguage, String text) {
+    public Response(boolean isOK, String sourceLanguage, String sourceText) {
         this.isOK = isOK;
         this.sourceLanguage = sourceLanguage;
-        this.text = text;
+        this.sourceText = sourceText;
         this.errorMessage=null;
     }
+
     public String toJson() {
         Map<String, Object> jsonMap = new LinkedHashMap<>();
         jsonMap.put("isOK", isOK());
         jsonMap.put("errorMessage", getErrorMessage());
         jsonMap.put("sourceLanguage", getSourceLanguage());
-        jsonMap.put("text", getText());
+        jsonMap.put("sourceText", getSourceText());
         addCustomFields(jsonMap);
         return new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create().toJson(jsonMap);
     }
@@ -56,12 +57,12 @@ public void setErrorMessage(String errorMessage) {
         this.errorMessage = errorMessage;
     }
 
-    public String getText() {
-        return text;
+    public String getSourceText() {
+        return sourceText;
     }
 
-    public void setText(String text) {
-        this.text = text;
+    public void setSourceText(String sourceText) {
+        this.sourceText = sourceText;
     }
 
     public String getSourceLanguage() {
@@ -77,7 +78,7 @@ public String toString() {
         return "{\n" +
                 "  \"isOK\": " + isOK + ",\n" +
                 "  \"sourceLanguage\": \"" + sourceLanguage + "\",\n" +
-                "  \"text\": \"" + text + "\",\n" +
+                "  \"sourceText\": \"" + sourceText + "\",\n" +
                 "  \"errorMessage\": \"" + errorMessage + "\"\n" +
                 "}";
     }