New Cache - Renew in CronJob

.github/workflows/unit-tests.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.operating-system }}
     strategy:
       matrix:
-        operating-system: [ubuntu-latest]
+        operating-system: [ubuntu-20.04]
         php-versions: ['7.4', '8.0']
     name: Unittest on ${{ matrix.operating-system }} with PHP version ${{ matrix.php-versions }}
     steps:

.gitignore

@@ -2,4 +2,5 @@
 vendor/
 nbproject/
 build/
-node_modules/
+node_modules/
+SDK/vendor

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "SDK"]
-	path = SDK
-	url = https://github.com/onOfficeGmbH/sdk

SDK/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## 0.2.0 (2020-02-24)
+
+* Fix description of composer command in README (#10 by @mrcodefinger)
+* Add Travis to CI pipeline (#22 by @dkaisers, #7 by @legionth)
+* Adding PHP-CS-Fixer as development dependency (#19 by @legionth)
+* Move example to examples folder (#20 by @legionth)
+* Introduced PHPUnit (#11, #12, #13, #14, #15, #16, #18 by @legionth)
+* Rename SDK folder to src folder and update autoloader according to changes (#9 by @legionth)
+* Added PSR-4 Autoloader via composer (#6 by @legionth)
+
+## 0.1.0 (2020-02-12)
+
+* Improve documentation of the README and create CONTRIBUTING document
+  for developers (#2 and #3 by @legionth)
+* Add composer.json to identify dependencies and adding the repository
+  to packagist.org (#1 and #4 by @legionth)

SDK/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+When contributing to this service,
+please open an issue via the
+[GitHub issues page](https://github.com/onOfficeGmbH/sdk/issues)
+or send a mail to `[email protected]`
+before making a change.
+
+## Bugs
+
+Bugs must be reported via the
+[GitHub issues page](https://github.com/onOfficeGmbH/sdk/issues).
+
+Bug fixes and improvements can be provided via a
+[Pull Request](https://github.com/onOfficeGmbH/sdk/pulls).
+
+A fix that introduces a change in behavior is considered a
+[breaking change](#breaking-changes).
+
+## Features
+
+Features and Breaking Changes must be discussed with the
+maintainers of this repository.
+
+A feature that introduces a change in existing behavior is considered a
+[breaking change](#breaking-changes).
+
+## Breaking Changes
+
+A breaking change must be discussed with the maintainers.
+The list of maintainers can be found [here](https://github.com/orgs/onOfficeGmbH/people)
+
+## Pull Request Process
+
+* Update the `README.md` with details of changes to the interface, classes or
+  general behaviour.
+* Contact one of the maintainers in the Pull Request.
+  The list of maintainers can be found [here](https://github.com/orgs/onOfficeGmbH/people)
+* Every Pull Request with actual code changes has to add or adapt unit and/or integration tests. 
+  Please see [Running the Tests](#running-the-tests) down below.
+* Create a meaningful title for the Pull Request that addresses the topic.
+* The Pull Request must pass the CI integration.
+  Be aware of the currently supported PHP versions and optimize your code according
+  to the supported versions.
+* Keep the Pull Request as small as possible.
+  Avoid unnecessary changes to speed up the review process.
+* Write readable and understandable code.
+  Try always to create the best possible solution.
+* Use readable and understandable commit messages, so the reviewer can understand the
+  intention of each commit.
+
+## Running the Tests
+
+The tests of this project consist on two [test suites](https://phpunit.readthedocs.io/en/9.5/organizing-tests.html).
+These are named _unit_ and _integration_ for unit tests and integration tests, respectively.
+Running the unit tests should be no harder that running
+`./vendor/bin/phpunit --testsuite unit`,  while executing the integration tests requires the binaries `faketime` and `ncat`
+to be in the `$PATH`. The integration tests can be run by typing
+`./vendor/bin/phpunit --testsuite integration`.

SDK/LICENSE

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

SDK/README.md

@@ -0,0 +1,181 @@
+# onOffice-SDK
+[![PHP Composer](https://github.com/onOfficeGmbH/sdk/actions/workflows/php.yml/badge.svg)](https://github.com/onOfficeGmbH/sdk/actions/workflows/php.yml)
+
+This project is the official PHP API client for the
+[onOffice API](https://apidoc.onoffice.de/)
+supported by the onOffice GmbH.
+
+* **The HTTP protocol** is used to communicate with the API.
+* An **Access Token** and **TLS connection** are used to ensure a **secure**
+  communication with the API.
+* The intention is to have **lightweight** client that can be used in other environments
+
+**Table of Contents**
+* [Quickstart Example](#quickstart-example)
+* [Usage](#usage)
+  * [Client](#client)
+  * [Parameters](#parameters)
+  * [Request](#request)
+  * [Response](#response)
+* [API Documentation](#api-documentation)
+* [Install](#install)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Quickstart Example
+
+```php
+$sdk = new onOfficeSDK();
+$sdk->setApiVersion('stable');
+
+$parametersReadEstate = [
+	'data' => [
+		'Id',
+		'kaufpreis',
+		'lage',
+	],
+	'listlimit' => 10,
+	'sortby' => [
+		'kaufpreis' => 'ASC',
+		'warmmiete' => 'ASC',
+	],
+	'filter' => [
+		'kaufpreis' => [
+			['op' => '>', 'val' => 300000],
+		],
+		'status' => [
+			['op' => '=', 'val' => 1],
+		],
+	],
+];
+
+$handleReadEstate = $sdk->callGeneric(onOfficeSDK::ACTION_ID_READ, 'estate', $parametersReadEstate);
+
+$sdk->sendRequests('put the token here', 'and secret here');
+
+var_export($sdk->getResponseArray($handleReadEstate));
+```
+
+Checkout the [examples folder](/examples/) to see a possible implementation of
+this client.
+
+## Usage
+
+### Client
+
+The `onOfficeSDK` is responsible for creating HTTP Requests and
+receiving HTTP Responses from the official API
+
+```php
+$sdk = new onOfficeSDK();
+$sdk->setApiVersion('stable');
+```
+
+Make sure that the correct API version is used for your client.
+By default this value is set to `stable`.
+
+### Parameters
+
+The parameters are transferred as JSON in the HTTP Request.
+The client uses the official
+[PHP array notation](https://www.php.net/manual/en/book.json.php)
+before transforming the array to JSON.
+
+```php
+$parametersReadEstate = [
+	'data' => [
+		'Id',
+		'kaufpreis',
+		'lage',
+	],
+	'listlimit' => 10,
+	'sortby' => [
+		'kaufpreis' => 'ASC',
+		'warmmiete' => 'ASC',
+	],
+	'filter' => [
+		'kaufpreis' => [
+			['op' => '>', 'val' => 300000],
+		],
+		'status' => [
+			['op' => '=', 'val' => 1],
+		],
+	],
+];
+```
+
+### Request
+
+To create a request to the API an `ACTION_ID` is needed.
+The class `onOfficeSDK` defines several constants,
+that can be used, so there is no need to copy these `ACTION_IDs`. 
+
+A token and secret are needed to send a request to the API.
+Check out the [official API documentation](#api-documentation)
+for information on how to acquire these credentials.
+
+```php
+$handleReadEstate = $sdk->callGeneric(onOfficeSDK::ACTION_ID_READ, 'estate', $parametersReadEstate);
+
+$sdk->sendRequests('put the token here', 'and secret here');
+```
+
+The return value of `onOfficeSDK::callGeneric` is used to identify the
+equivalent response value.
+`onOfficeSDK::callGeneric` can be called multiple times before sending
+the request to the API via `onOfficeSDK::sendRequests`.
+
+
+### Response
+
+Use the method `onOfficeSDK::getResponseArray` to fetch the response data for a request.
+To identify the response of the request, use the value returned by `onOfficeSDK::callGeneric`.
+```php
+var_export($sdk->getResponseArray($handleReadEstate));
+```
+
+The response will be a PHP array.
+
+### Difference between `call` and `callGeneric`
+
+This library will provide two general methods to create the calls to the onOffice API.
+
+* `callGeneric` is used to create simple calls e.g. 
+   [Estate searches](https://apidoc.onoffice.de/actions/datensatz-lesen/objekte/)
+   or
+  [reading addresses](https://apidoc.onoffice.de/actions/datensatz-lesen/adressen/)
+* `call` can be used more specific for special API Requests.
+  Some API Request need some more information like `identifier`, `resourceId` and `resourceType`
+  to be processed.
+  These can be calls like [Estate files](https://apidoc.onoffice.de/actions/informationen-abfragen/objektdateien/)
+  or [Editing Addresses](https://apidoc.onoffice.de/actions/datensatz-bearbeiten/addresses/)
+
+Check the [API documentation](#api-documentation) for more information.
+
+## API Documentation
+
+The API client is developed for the latest version of the official API.
+Additional information about the API can be [found here](https://apidoc.onoffice.de/).
+
+## Install
+
+The recommended way to install this library is through Composer. 
+[New to Composer?](https://getcomposer.org/)
+
+This will install the latest supported version:
+
+```
+$ composer require onoffice/sdk:^0.2.0
+```
+See also the [CHANGELOG](/CHANGELOG.md)
+for details about version upgrades.
+
+## Contributing
+
+You want to contribute? Great!
+
+Check out our [contribution rules](/CONTRIBUTING.md) and get started!
+
+## License
+
+This project is licensed under the MIT License. See [LICENSE document](/LICENSE).

SDK/composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "onoffice/sdk",
+    "description": "Official client to communicate with the onOffice API",
+    "license": "MIT",
+    "require": {
+        "ext-json": "*",
+        "ext-curl": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "onOffice\\SDK\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\onOffice\\SDK\\": "tests"
+        }
+    },
+    "require-dev": {
+      "phpunit/phpunit": "^6",
+      "friendsofphp/php-cs-fixer": "^2.16",
+      "symfony/process": "^3.4.37"
+    }
+}