- Update README.md

- add source & target option to languages-function
- add Testscases

Author: VimS

README.md

@@ -51,20 +51,26 @@ foreach ($translations as $translation) {
 }
 ```
 ### Supported languages
-* `de` - German
-* `en` - English
-* `fr` - French
-* `it` - Italian
-* `ja` - Japanese
-* `es` - Spanish
-* `nl` - Dutch
-* `pl` - Polish
-* `pt` - Portuguese
-* `pt-pt` - Portuguese variant
-* `pt-br` - Portuguese variant
-* `ru` - Russian
-* `zh` - Chinese
+In Version 2 we removed the internal List of supported Languages.
+Instead, you can now get an array with the supported Languages directly form DeepL:
 
+```php
+$languagesArray = $deepl->languages();
+
+foreach ($languagesArray as $language) {
+    echo $language['name'];
+    echo $language['language'];
+}
+```
+
+### Monitoring usage
+You can now check ow much you translate, as well as the limits set.
+```php
+$usageArray = $deepl->usage();
+
+echo 'You have used '.$usageArray['character_count'].' of '.$usageArray['character_limit'].' in in the current billing period.';
+ 
+```
 ## Testing
 
 Run PHP_CodeSniffer Tests:
@@ -93,7 +99,7 @@ composer test:all
 
 ## Credits
 
-- [Arkadius Jonczek][link-author]
+- [babymarkt.de GmbH][link-author]
 - [All Contributors][link-contributors]
 
 ## License
@@ -112,5 +118,5 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 [link-scrutinizer]: https://scrutinizer-ci.com/g/Baby-Markt/deepl-php-lib/code-structure
 [link-code-quality]: https://scrutinizer-ci.com/g/Baby-Markt/deepl-php-lib
 [link-downloads]: https://packagist.org/packages/babymarkt/deepl-php-lib
-[link-author]: https://github.com/arkadiusjonczek
+[link-author]: https://github.com/Baby-Markt
 [link-contributors]: ../../contributors

src/DeepL.php

@@ -82,17 +82,20 @@ public function __destruct()
     }
 
     /**
-     * Calls the usage-Endpoint and return Json-response as an array
+     * Call languages-Endpoint and return Json-response as an Array
+     *
+     * @param string $type
      *
      * @return array
      * @throws DeepLException
      */
-    public function usage()
+    public function languages($type = null)
     {
-        $url   = $this->buildBaseUrl(self::API_URL_RESOURCE_USAGE);
-        $usage = $this->request($url);
+        $url       = $this->buildBaseUrl(self::API_URL_RESOURCE_LANGUAGES);
+        $body      = $this->buildQuery(array('type' => $type));
+        $languages = $this->request($url, $body);
 
-        return $usage;
+        return $languages;
     }
 
     /**
@@ -156,19 +159,20 @@ public function translate(
     }
 
     /**
-     * Call languages-Endpoint and return Json-response as an Array
+     * Calls the usage-Endpoint and return Json-response as an array
      *
      * @return array
      * @throws DeepLException
      */
-    public function languages()
+    public function usage()
     {
-        $url       = $this->buildBaseUrl(self::API_URL_RESOURCE_LANGUAGES);
-        $languages = $this->request($url);
+        $url   = $this->buildBaseUrl(self::API_URL_RESOURCE_USAGE);
+        $usage = $this->request($url);
 
-        return $languages;
+        return $usage;
     }
 
+
     /**
      * Creates the Base-Url which all of the 3 API-resources have in common.
      *
@@ -197,7 +201,7 @@ protected function buildBaseUrl($resource = 'translate')
      */
     protected function buildQuery($paramsArray)
     {
-        if (true === is_array($paramsArray['text'])) {
+        if (isset($paramsArray['text']) && true === is_array($paramsArray['text'])) {
             $text = $paramsArray['text'];
             unset($paramsArray['text']);
             $textString = '';

tests/integration/DeepLApiTest.php

@@ -193,6 +193,58 @@ public function testLanguages()
         }
     }
 
+    /**
+     * Test languages() can return the source-languages
+     */
+    public function testLanguagesSource()
+    {
+        if (self::$authKey === false) {
+            $this->markTestSkipped('DeepL Auth Key (DEEPL_AUTH_KEY) is not configured.');
+        }
+
+        $deepl    = new DeepL(self::$authKey);
+        $response = $deepl->languages('source');
+
+        foreach ($response as $language) {
+            $this->assertArrayHasKey('language', $language);
+            $this->assertArrayHasKey('name', $language);
+        }
+    }
+
+    /**
+     * Test languages()  can return the targe-languages
+     */
+    public function testLanguagesTarget()
+    {
+        if (self::$authKey === false) {
+            $this->markTestSkipped('DeepL Auth Key (DEEPL_AUTH_KEY) is not configured.');
+        }
+
+        $deepl    = new DeepL(self::$authKey);
+        $response = $deepl->languages('target');
+
+        foreach ($response as $language) {
+            $this->assertArrayHasKey('language', $language);
+            $this->assertArrayHasKey('name', $language);
+        }
+    }
+
+    /**
+     * Test languages() will fail with wrong Parameter
+     */
+    public function testLanguagesFail()
+    {
+        if (self::$authKey === false) {
+            $this->markTestSkipped('DeepL Auth Key (DEEPL_AUTH_KEY) is not configured.');
+        }
+
+        $deepl    = new DeepL(self::$authKey);
+
+        $this->setExpectedException('\BabyMarkt\DeepL\DeepLException');
+
+        $deepl->languages('fail');
+    }
+
     /**
      * Test translate() with all Params
      */