The getContext method has been fixed using a third-party API. The library now uses the ZenRows API and requires an API key to function.

- Added the apikey.properties file
- Refactored the getContext method
- New messages have been added to the message.properties file
- README.md file has been expanded
- Added new tests

Author: Anton3413

README.md

@@ -10,18 +10,39 @@ services used by Reverso is not available, though some are known.
 They work and behave differently, so our main goal was to create 
 a unified and simple API, the responses of which would have a clear 
 structure and behavior.
+
 ## Navigation
+- [How to use this library](#How-to-use)
 -   [Main components](#main-components)
     -   [Response](#response)
     -   [Language](#language)
 -   [Usage](#usage)
     -   [Standart workfolw](#standard-workflow)
     -   [getVoiceStream](#getvoicestream)
+    -   [getContext problems](#getcontext-problems)
 -   [Response status](#response-status)
     -   [Success](#success)
     -   [Failure](#failure)
 -   [Credits](#credits)
 
+## How to use
+**Recently, the [Context page](https://context.reverso.net/) started using Cloudflare
+protection. The solution to this was to use a third-party scraping API that
+utilizes a headless browser to bypass the protection (by executing JavaScript
+code on the page).**
+
+Since ZenRows was chosen as the third-party API, follow these simple steps to use it:
+
+Go to the [website](https://www.zenrows.com/) and complete a simple registration.
+- Answer a few questions during the initial registration (this part can be skipped).
+- Obtain an API key as part of the free trial period.
+- Insert it into the already created apikey.properties file in the format:
+  `apiKey=yourKey`
+- Everything is ready to use!
+
+P.S It is also worth mentioning that this key can be inserted into the constructor
+when creating a [Reverso object](#usage). However, the first option is preferable.
+
 ## Main components
 ### Response
 Abstract class Response declares the common structure of all responses 
@@ -58,6 +79,7 @@ public enum Language {
     ARABIC("ar", true, null),
     GERMAN("de", true, null),
     ENGLISH("en", true, "eng"),
+    ROMANIAN("ro", false, null)
 }
 ```
 Each object in this enumeration has fields that help determine whether
@@ -74,15 +96,18 @@ does not support the respective functionality.
 For example:
 ```java
 JAPANESE("ja", true, null);
+ROMANIAN("ro", false, null);
 ```
 
-The third field is null, this means that **spellCheck** are not available
-for *japanese* language.
+<i> Japanese </i> – Synonym search and verb conjugation are available, but spell check is not. <br>
+<i>Romanian </i> – Only synonyms are available. Verb conjugation and spell check are not available.
+And so on.
 
 ## Usage
 The fundamental class, **Reverso**, manages all interactions with the API.
-First, we need to create an instance of this class.
-## Standard workflow
+First, we need to create an instance of this class. As mentioned above, the API key can also
+be added to the class constructor, although this is not mandatory.
+### Standard workflow
 To retrieve the necessary data, we must call one of the methods 
 of this class.
 
@@ -126,7 +151,7 @@ Here's the output :
 Most methods are very similar,  some require two languages in their 
 arguments, such as the translation method, which is logical. 
 
-## getVoiceStream
+### getVoiceStream
 However, there is a method that differs slightly from the others:
 
 `VoiceResponse getVoiceStream(Voice voice, String sourceText)`
@@ -157,6 +182,13 @@ method, the *byte[] mp3Data* field is ignored. However, in this class, we
 can also get this field as a Base64 string by invoking 
 the `getAudioAsBase64()` method.
 
+### getContext problems
+
+Unfortunately, due to the use of a third-party API, the method may be unstable. The response
+time can take a while, which can sometimes be critical. This is because the API needs to process
+the request in a headless browser mode and execute the necessary JavaScripts, which has significantly 
+slowed it down. Also, we cannot predict the state of the third-party API servers at the time of use.
+
 ## Response status
 Each response object has a `boolean isOK` field, along with a 
 corresponding getter method, which indicates the success of our

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>anton3413</groupId>
     <artifactId>reverso_java_API</artifactId>
-    <version>1.0.4</version>
+    <version>1.1.0</version>
     <packaging>jar</packaging>
 
     <name>Reverso API</name>

src/main/java/reverso/Reverso.java

@@ -11,9 +11,14 @@
 import reverso.language.Language;
 import reverso.language.Voice;
 import java.io.IOException;
-import java.util.*;
+import java.util.Base64;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
 
 public class Reverso {
+
+    private String apiKey;
     private HtmlParser parser;
     private Properties properties;
     private static final String SYNONYM_URL = "https://synonyms.reverso.net/synonym/";
@@ -22,9 +27,13 @@ public class Reverso {
     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();
-        initializeParser(properties);
+    public Reverso(String apiKey){
+        initialize();
+        this.apiKey = apiKey;
+    }
+    public Reverso(){
+        initialize();
+        initializeAPIKey();
     }
 
     public SynonymResponse getSynonyms(Language language, String word) {
@@ -66,18 +75,31 @@ public ContextResponse getContext(Language sourceLanguage, Language targetLangua
             contextResponse.setErrorMessage(properties.getProperty("message.error.context.sameLanguage"));
             return contextResponse;
         }
-        String URL = CONTEXT_URL + sourceLanguage + "-" + targetLanguage + "/" + word;
+        String contextURL = CONTEXT_URL + sourceLanguage + "-" + targetLanguage + "/" + word;
 
+        String APIURL = "https://api.zenrows.com/v1/?apikey=" + apiKey + "&url=" + contextURL + "&js_render=true" +
+                "&original_status=true";
         Document document;
         Map<String, String> contextMap;
         String[] translations;
         Connection.Response response;
         try {
-            response = Jsoup.connect(URL)
-                    .header("User-Agent", RandomUserAgent.getRandomUserAgent())
+            response = Jsoup.connect(APIURL)
                     .ignoreHttpErrors(true)
+                    .ignoreContentType(true)
+                    .followRedirects(false)
+                    .header("User-Agent",RandomUserAgent.getRandomUserAgent())
+                    .timeout(20000)
                     .execute();
-            document = response.parse();
+          if (response.statusCode() == 404) {
+                contextResponse.setErrorMessage(properties.getProperty("message.error.context.noResults"));
+                return contextResponse;
+          }
+          if(response.statusCode()== 401){
+                contextResponse.setErrorMessage(properties.getProperty("message.error.apikey.invalid"));
+          }
+          document = response.parse();
+
         } catch (IOException e) {
             contextResponse.setErrorMessage(properties.getProperty("message.error.connection"));
             return contextResponse;
@@ -87,17 +109,13 @@ public ContextResponse getContext(Language sourceLanguage, Language targetLangua
             return contextResponse;
         }
         translations = parser.parseContextPageGetTranslations(document);
-        if (translations.length == 0) {
-            contextResponse.setErrorMessage(properties.getProperty("message.error.context.noResults"));
-            return contextResponse;
-        }
         contextMap = parser.parseContextPage(document);
 
         contextResponse.setContextResults(contextMap);
         contextResponse.setOK(true);
         contextResponse.setTranslations(translations);
         return contextResponse;
-    }
+        }
 
     public VoiceResponse getVoiceStream(Voice voice, String text) {
 
@@ -204,6 +222,11 @@ public SpellCheckResponse getSpellCheck(Language language, String text) {
             return spellCheckResponse;
     }
 
+    private void initialize(){
+        initializeProperties();
+        initializeParser(properties);
+    }
+
     private void initializeProperties() {
         try {
             properties = new Properties();
@@ -216,6 +239,23 @@ private void initializeProperties() {
     private void initializeParser(Properties properties){
         parser = new HtmlParser(properties);
     }
+
+    private void initializeAPIKey() {
+        Properties properties = new Properties();
+        try {
+            properties.load(Reverso.class.getResourceAsStream("/apikey.properties"));
+            apiKey = properties.getProperty("apiKey");
+            validateAPIKey(apiKey);
+        } catch (IOException e) {
+            throw new RuntimeException(properties.getProperty("message.error.apikey.init"), e);
+
+        }
+    }
+    private void validateAPIKey(String apiKey) {
+        if (apiKey == null || apiKey.isBlank()) {
+            throw new RuntimeException(properties.getProperty("message.error.apikey.blank"));
+        }
+    }
 }
 
 

src/main/java/reverso/data/response/entity/Stats.java

@@ -53,4 +53,8 @@ public void setLongestSentence(int longestSentence) {
     public String toJson(){
         return new Gson().toJson(this);
     }
+
+    public String toString(){
+        return toJson();
+    }
 }

src/main/resources/apikey.properties

@@ -0,0 +1 @@
+apiKey=

src/main/resources/messages.properties

@@ -20,3 +20,6 @@ message.error.spellCheck.unsupportedLanguage=This language does not support this
 The list of supported languages includes English, French, Spanish, and Italian.
 message.error.spellCheck.noErrorsOrMismatchedLanguage=The input text matches the original. \
 Either there are no errors, or the specified language does not match the language of the text.
+message.error.apikey.blank=API key is missing in apikey.properties
+message.error.apikey.init=Problem during apikey.properties file initialization. Possibly the path is incorrect
+message.error.apikey.invalid=ZenRows API key is invalid or expired

src/test/java/reverso/GetContextTest.java

@@ -9,6 +9,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.Test;
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 public class GetContextTest {
@@ -29,6 +30,30 @@ void initializeReversoAndProperties() {
         }
     }
 
+    @Test
+    void successGermanSpanishContextRequest(){
+        contextResponse = reverso.getContext(Language.GERMAN,Language.SPANISH,"Wirtschaft");
+
+        assertTrue(contextResponse.isOK());
+        assertNull(contextResponse.getErrorMessage());
+        assertEquals(Language.GERMAN.toString(),contextResponse.getSourceLanguage());
+        assertNotNull(contextResponse.getContextResults());
+        assertTrue(contextResponse.getContextResults().size()>15);
+        assertTrue(contextResponse.getTranslations().length>5);
+    }
+
+    @Test
+    void successUkrainianFrenchContextRequest(){
+        contextResponse = reverso.getContext(Language.UKRAINIAN,Language.FRENCH,"небокрай");
+
+        assertTrue(contextResponse.isOK());
+        assertNull(contextResponse.getErrorMessage());
+        assertEquals(Language.UKRAINIAN.toString(),contextResponse.getSourceLanguage());
+        assertNotNull(contextResponse.getContextResults());
+        assertTrue(contextResponse.getContextResults().size()>15);
+        assertTrue(contextResponse.getTranslations().length>0);
+    }
+
     @Test
     void successRussianEnglishContextRequest(){
         contextResponse = reverso.getContext(Language.ENGLISH,Language.RUSSIAN,"красивый");
@@ -54,7 +79,20 @@ void successArabicItalianContextRequest(){
     }
 
     @Test
-    void FailureUnsupportedKoreanUkrainianContextRequest(){
+    void failureUnsupportedKoreanArabicContextRequest(){
+        contextResponse = reverso.getContext(Language.KOREAN,Language.ARABIC,"ありがとう");
+
+        assertFalse(contextResponse.isOK());
+        assertNotNull(contextResponse.getErrorMessage());
+        assertEquals(Language.ARABIC.toString(),contextResponse.getTargetLanguage());
+        assertNull(contextResponse.getContextResults());
+        assertEquals(properties.getProperty("message.error.context.UnsupportedLanguages"),
+                contextResponse.getErrorMessage());
+    }
+
+
+    @Test
+    void failureUnsupportedKoreanUkrainianContextRequest(){
         contextResponse = reverso.getContext(Language.KOREAN,Language.UKRAINIAN,"красивий");
 
         assertFalse(contextResponse.isOK());
@@ -90,6 +128,19 @@ void FailureIncorrectWordContextRequest(){
         assertEquals(properties.getProperty("message.error.context.noResults"),
                 contextResponse.getErrorMessage());
     }
+    @Test
+    void FailureIncorrectWordContextRequest2(){
+        contextResponse = reverso.getContext(Language.ITALIAN, Language.RUSSIAN,"someincorrectstringexample");
+
+        assertFalse(contextResponse.isOK());
+        assertNotNull(contextResponse.getErrorMessage());
+        assertEquals(Language.RUSSIAN.toString(),contextResponse.getTargetLanguage());
+        assertNull(contextResponse.getContextResults());
+        assertNull(contextResponse.getTranslations());
+        assertEquals(properties.getProperty("message.error.context.noResults"),
+                contextResponse.getErrorMessage());
+    }
+
     @Test
     void FailureSameLanguagesContextRequest(){
         contextResponse = reverso.getContext(Language.POLISH,Language.POLISH,"ja pierdole bobr");