Merge pull request #6 from Baby-Markt/update-project

MASTER: Update project

Author: arkadiusjonczek

.travis.yml

@@ -18,12 +18,19 @@ matrix:
   allow_failures:
     - php: nightly
 
+env:
+  - COMPOSER_ALLOW_XDEBUG=0
+
 cache:
   directories:
     - $HOME/.composer/cache
 
-before_script:
+before_install:
+  - phpenv config-rm xdebug.ini
+  - composer validate
+
+install:
   - composer install
 
 script:
-  - composer test
+  - composer test:all

LICENSE

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2019 babymarkt.de GmbH <entwicklung@babymarkt.de>
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

LICENSE.md

@@ -1,12 +1,15 @@
 # deepl-php-lib
 
-[![Build Status](https://travis-ci.org/Baby-Markt/deepl-php-lib.svg?branch=master)](https://travis-ci.org/Baby-Markt/deepl-php-lib)
-[![Latest Stable Version](https://poser.pugx.org/babymarkt/deepl-php-lib/v/stable.svg)](https://packagist.org/packages/babymarkt/deepl-php-lib)
-[![Total Downloads](https://poser.pugx.org/babymarkt/deepl-php-lib/downloads.png)](https://packagist.org/packages/babymarkt/deepl-php-lib)
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Build Status][ico-travis]][link-travis]
+[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
+[![Quality Score][ico-code-quality]][link-code-quality]
+[![Total Downloads][ico-downloads]][link-downloads]
 
 Simple PHP Library for DeepL API. You can translate one or multiple text strings (up to 50) per request.
 
-## Installation
+## Install
 
 Use composer if you want to use this library in your project.
 
@@ -46,34 +49,52 @@ foreach ($translations as $translation) {
 }
 ```
 
-## Run PHPUnit Tests
+## Testing
 
-Clone the repository.
+Run PHP_CodeSniffer Tests:
 
 ```bash
-git clone git@github.com:Baby-Markt/deepl-php-lib.git
+composer cs
 ```
 
-Create phpunit.xml from dist file.
+Run PHPMD Tests:
 
 ```bash
-cp phpunit.xml.dist phpunit.xml
+composer md
 ```
 
-Install composer dependencies.
+Run PHPUnit Tests:
 
 ```bash
-composer install
+composer test
 ```
 
-Now, run PHPUnit Tests.
+Run all tests:
 
 ```bash
-vendor/bin/phpunit
+composer test:all
 ```
 
-Or use composer.
+## Credits
 
-```bash
-composer test
-```
+- [Arkadius Jonczek][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+[ico-version]: https://img.shields.io/packagist/v/babymarkt/deepl-php-lib.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/Baby-Markt/deepl-php-lib/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/babymarkt/deepl-php-lib.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/babymarkt/deepl-php-lib.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/babymarkt/deepl-php-lib.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/babymarkt/deepl-php-lib
+[link-travis]: https://travis-ci.org/Baby-Markt/deepl-php-lib
+[link-scrutinizer]: https://scrutinizer-ci.com/g/babymarkt/deepl-php-lib/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/babymarkt/deepl-php-lib
+[link-downloads]: https://packagist.org/packages/babymarkt/deepl-php-lib
+[link-author]: https://github.com/arkadiusjonczek
+[link-contributors]: ../../contributors

README.md

@@ -1,7 +1,14 @@
 {
     "name": "babymarkt/deepl-php-lib",
-    "description": "DeepL API Client Library supporting PHP >= 5.3 && PHP < 8.0",
     "type": "library",
+    "description": "DeepL API Client Library supporting PHP >= 5.3 && PHP < 8.0",
+    "keywords": [
+      "babymarkt",
+      "deepl",
+      "i18n",
+      "translation"
+    ],
+    "homepage": "https://github.com/Baby-Markt/deepl-php-lib",
     "license": "MIT",
     "authors": [
         {
@@ -14,7 +21,9 @@
     },
     "require-dev": {
         "php": ">=5.3 <8.0",
-        "phpunit/phpunit": "^4.8"
+        "phpmd/phpmd": "2.4.*",
+        "phpunit/phpunit": "^4.8",
+        "squizlabs/php_codesniffer": "^2.9"
     },
     "autoload": {
         "psr-4": {
@@ -27,8 +36,16 @@
         }
     },
     "scripts": {
-        "test": [
-          "vendor/bin/phpunit"
+        "cs": "vendor/bin/phpcs",
+        "md": "vendor/bin/phpmd src,tests text phpmd.xml.dist",
+        "test": "vendor/bin/phpunit",
+        "test:all": [
+            "composer cs",
+            "composer md",
+            "composer test"
         ]
+    },
+    "config": {
+      "sort-packages": true
     }
 }

composer.json

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ruleset name="babymarkt/deepl-php-lib">
+    <description>The coding standard of deepl-php-lib package</description>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <arg value="p" />
+    <arg name="colors" />
+    <arg value="s" />
+
+    <!-- Use the PSR2 Standard-->
+    <rule ref="PSR2" />
+</ruleset>

phpcs.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<ruleset name="deepl-php-lib ruleset"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
+>
+    <description>PHPMD Rules for deepl-php-lib</description>
+
+    <rule ref="rulesets/cleancode.xml" />
+    <rule ref="rulesets/codesize.xml" />
+    <rule ref="rulesets/controversial.xml" />
+    <rule ref="rulesets/design.xml" />
+    <rule ref="rulesets/naming.xml" />
+    <rule ref="rulesets/unusedcode.xml" />
+</ruleset>

phpmd.xml.dist

@@ -159,8 +159,7 @@ public function translate(
         $destinationLanguage = 'en',
         array $tagHandling = array(),
         array $ignoreTags = array()
-    )
-    {
+    ) {
         // make sure we only accept supported languages
         $this->checkLanguages($sourceLanguage, $destinationLanguage);
 
@@ -174,13 +173,11 @@ public function translate(
 
         if ($translationsCount == 0) {
             throw new DeepLException('No translations found.');
-        }
-        else if ($translationsCount == 1) {
+        } elseif ($translationsCount == 1) {
             return $translationsArray['translations'][0]['text'];
         }
-        else {
-            return $translationsArray['translations'];
-        }
+
+        return $translationsArray['translations'];
     }
 
     /**
@@ -198,13 +195,17 @@ protected function checkLanguages($sourceLanguage, $destinationLanguage)
         $sourceLanguage = strtoupper($sourceLanguage);
 
         if (!in_array($sourceLanguage, $this->sourceLanguages)) {
-            throw new DeepLException(sprintf('The language "%s" is not supported as source language.', $sourceLanguage));
+            throw new DeepLException(
+                sprintf('The language "%s" is not supported as source language.', $sourceLanguage)
+            );
         }
 
         $destinationLanguage = strtoupper($destinationLanguage);
 
         if (!in_array($destinationLanguage, $this->destinationLanguages)) {
-            throw new DeepLException(sprintf('The language "%s" is not supported as destination language.', $destinationLanguage));
+            throw new DeepLException(
+                sprintf('The language "%s" is not supported as destination language.', $destinationLanguage)
+            );
         }
 
         return true;
@@ -225,8 +226,7 @@ protected function buildUrl(
         $destinationLanguage,
         array $tagHandling = array(),
         array $ignoreTags = array()
-    )
-    {
+    ) {
         // select correct api url
         switch ($this->apiVersion) {
             case 1:
@@ -271,7 +271,6 @@ protected function buildBody($text)
         }
 
         foreach ($text as $textElement) {
-
             $body .= ($first ? '' : '&') . sprintf(DeepL::API_URL_TEXT, rawurlencode($textElement));
 
             if ($first) {
@@ -299,17 +298,16 @@ protected function request($url, $body)
 
         $response = curl_exec($this->curl);
 
-        if (!curl_errno($this->curl)) {
-            $httpCode = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);
-
-            if ($httpCode != 200 && array_key_exists($httpCode, $this->errorCodes)) {
-                throw new DeepLException($this->errorCodes[$httpCode], $httpCode);
-            }
-        }
-        else {
+        if (curl_errno($this->curl)) {
             throw new DeepLException('There was a cURL Request Error.');
         }
 
+        $httpCode = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);
+
+        if ($httpCode != 200 && array_key_exists($httpCode, $this->errorCodes)) {
+            throw new DeepLException($this->errorCodes[$httpCode], $httpCode);
+        }
+
         $translationsArray = json_decode($response, true);
 
         if (!$translationsArray) {

src/DeepL.php

@@ -10,4 +10,4 @@
 class DeepLException extends \Exception
 {
     // to be continued ..
-}
+}

src/DeepLException.php

@@ -2,10 +2,13 @@
 
 namespace BabyMarkt\DeepL;
 
+use ReflectionClass;
+
 /**
  * Class DeepLTest
  *
  * @package BabyMarkt\DeepL
+ * @SuppressWarnings(PHPMD.TooManyPublicMethods)
  */
 class DeepLTest extends \PHPUnit_Framework_TestCase
 {
@@ -23,7 +26,9 @@ public static function setUpBeforeClass()
     {
         parent::setUpBeforeClass();
 
-        if (($authKey = getenv('DEEPL_AUTH_KEY')) === false) {
+        $authKey = getenv('DEEPL_AUTH_KEY');
+
+        if ($authKey === false) {
             return;
         }
 
@@ -42,7 +47,7 @@ public static function setUpBeforeClass()
      */
     protected static function getMethod($className, $methodName)
     {
-        $class = new \ReflectionClass($className);
+        $class = new ReflectionClass($className);
         $method = $class->getMethod($methodName);
         $method->setAccessible(true);
 
@@ -116,7 +121,8 @@ public function testBuildUrl()
      */
     public function testBuildUrlWithTags()
     {
-        $expectedString = 'https://api.deepl.com/v1/translate?auth_key=123456&source_lang=de&target_lang=en&tag_handling=xml&ignore_tags=x';
+        $expectedString  = 'https://api.deepl.com';
+        $expectedString .= '/v1/translate?auth_key=123456&source_lang=de&target_lang=en&tag_handling=xml&ignore_tags=x';
 
         $authKey = '123456';
         $deepl   = new DeepL($authKey);
@@ -252,6 +258,6 @@ public function testTranslateException()
 
         $this->setExpectedException('\BabyMarkt\DeepL\DeepLException');
 
-        $translatedText = $deepl->translate($germanText);
+        $deepl->translate($germanText);
     }
-}
+}