Initial commit

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,16 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.editorconfig               export-ignore
+/.gitattributes              export-ignore
+/.gitignore                  export-ignore
+/.scrutinizer.yml            export-ignore
+/.styleci.yml                export-ignore
+/.travis.yml                 export-ignore
+/PULL_REQUEST_TEMPLATE.md    export-ignore
+/ISSUE_TEMPLATE.md           export-ignore
+/phpcs.xml.dist              export-ignore
+/phpunit.xml.dist            export-ignore
+/tests                       export-ignore
+/docs                        export-ignore

.gitignore

@@ -0,0 +1,7 @@
+.idea
+build
+composer.lock
+vendor
+phpcs.xml
+phpunit.xml
+index.php

.scrutinizer.yml

@@ -0,0 +1,31 @@
+build:
+    nodes:
+        analysis:
+            project_setup:
+                override: true
+            tests:
+                override: [php-scrutinizer-run]
+
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+
+tools:
+    external_code_coverage:
+        timeout: 600
+        runs: 3

.styleci.yml

@@ -0,0 +1 @@
+preset: psr2

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/mettleworks/big-huge-thesaurus-client).
+
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2019 
+
+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.

README.md

@@ -0,0 +1,100 @@
+# BigHugetThesaurusClient
+
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Total Downloads][ico-downloads]][link-downloads]
+
+PHP Wrapper for the [Big Huge Labs Thesaurus API](http://words.bighugelabs.com/).
+
+## Install
+
+Via Composer
+
+``` bash
+$ composer require mettleworks/big-huge-thesaurus-client
+```
+
+## Usage
+
+``` php
+$API_KEY = 'Get an api key @ https://words.bighugelabs.com/api.php';
+
+$client = new Mettleworks\BigHugeThesaurusClient($API_KEY);
+$response = $client->lookup('love');
+```
+
+The response object is an instance of `ThesaurusResponse`, an object that wraps the original response and adds a few convenience methods. You can optionally pass an argument to each method to indicate if you want only nouns (`noun`), verbs (`verb`), adjectives (`adjective`) or adverbs (`adverb`) otherwise they will return all results combined. The signature of the methods is the following:
+
+```php
+/**
+ * Get the synonyms from the response
+ */
+$response->getSynonyms($type = null): array
+
+/**
+ * Get the antonyms from the response
+ */
+public function getAntonyms($type = null): array
+
+/**
+ * Get the similar terms from the response
+ */
+public function getSimilarTerms($type = null): array
+
+/**
+ * Get related terms from the response
+ */
+public function getRelatedTerms($type = null): array
+
+/**
+ * Cast response to array (returns the original response)
+ */ 
+public function toArray(): array
+
+/**
+ * Cast response to JSON
+ */
+public function toJson()
+```
+
+The client throws specific exceptions when an error occurs. Those errors are documented on the [Big Huge Thesaurus Api Page](https://words.bighugelabs.com/api.php).
+
+```php
+try {
+    $response = $client->lookup('love');
+} catch (NotFoundException $ex) {
+    // Not Found
+} catch (UsageExceededException $ex) {
+    // Usage exceeded
+} catch (InactiveKeyException $ex) {
+    // Key not active
+} catch (MissingWordsException $ex) {
+    // No words provided
+} catch (NotWhitelistedException $ex) {
+    // IP address blocked
+}
+```
+
+Additionally if an error occurs outside the listed ones, the original Guzzle Exception is thrown.
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+## Credits
+
+- [Maurizio Bonani](https://github.com/mauricius)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,51 @@
+{
+    "name": "mettleworks/big-huge-thesaurus-client",
+    "type": "library",
+    "description": "PHP Client around Big Huge Thesaurus API",
+    "keywords": [
+        "mettleworks",
+        "big-huge-thesaurus-client",
+        "big huge thesaurus"
+    ],
+    "homepage": "https://github.com/mettleworks/big-huge-thesaurus-client",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Maurizio Bonani",
+            "email": "[email protected]",
+            "homepage": "https://mettle.io/",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php" : "~7.1",
+        "guzzlehttp/guzzle": "~6.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit" : ">=7.0",
+        "squizlabs/php_codesniffer": "^3.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Mettleworks\\BigHugeThesaurusClient\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Mettleworks\\BigHugeThesaurusClient\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "check-style": "phpcs src tests",
+        "fix-style": "phpcbf src tests"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="BigHugeThesaurusClient Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-html" target="build/coverage"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+</phpunit>