Initial commit

.gitattributes

@@ -0,0 +1,3 @@
+* text=auto
+
+*.php text eol=lf

.gitignore

@@ -0,0 +1,12 @@
+/vendor
+/node_modules
+composer.lock
+.phpunit.result.cache
+.php_cs.cache
+npm-debug.log
+Thumbs.db
+.DS_Store
+.log
+/.idea
+/.vscode
+/.vs

.php_cs.dist

@@ -0,0 +1,125 @@
+<?php
+
+use PhpCsFixer\Finder;
+use PhpCsFixer\Config;
+
+$finder = Finder::create()->in(__DIR__)
+    ->exclude('docs');
+
+return Config::create()->setRules([
+    '@PSR2' => true,
+    'align_multiline_comment' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'backtick_to_shell_exec' => true,
+    'binary_operator_spaces' => true,
+    'blank_line_after_namespace' => true,
+    'blank_line_after_opening_tag' => true,
+    'blank_line_before_statement' => [
+        'statements' => [
+            'break', 'case', 'continue', 'declare', 'default', 'do', 'for',
+            'if', 'foreach', 'return', 'switch', 'try', 'while',
+        ],
+    ],
+    'braces' => [
+        'allow_single_line_closure' => false,
+        'position_after_control_structures' => 'same',
+        'position_after_functions_and_oop_constructs' => 'next',
+    ],
+    'cast_spaces' => ['space' => 'single'],
+    'class_attributes_separation' => [
+        'elements' => ['const', 'property', 'method'],
+    ],
+    'combine_consecutive_issets' => true,
+    'combine_consecutive_unsets' => true,
+    'compact_nullable_typehint' => true,
+    'concat_space' => ['spacing' => 'one'],
+    'fully_qualified_strict_types' => true,
+    'function_typehint_space' => true,
+    'increment_style' => ['style' => 'pre'],
+    'linebreak_after_opening_tag' => true,
+    'list_syntax' => ['syntax' => 'short'],
+    'lowercase_cast' => true,
+    'lowercase_static_reference' => true,
+    'magic_constant_casing' => true,
+    'magic_method_casing' => true,
+    'multiline_comment_opening_closing' => true,
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line',
+    ],
+    'native_function_casing' => true,
+    'native_function_type_declaration_casing' => true,
+    'new_with_braces' => true,
+    'no_alternative_syntax' => true,
+    'no_blank_lines_after_class_opening' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_empty_statement' => true,
+    'no_extra_blank_lines' => true,
+    'no_leading_import_slash' => true,
+    'no_leading_namespace_whitespace' => true,
+    'no_mixed_echo_print' => ['use' => 'echo'],
+    'no_null_property_initialization' => true,
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_spaces_around_offset' => true,
+    'no_superfluous_phpdoc_tags' => false,
+    'no_superfluous_elseif' => true,
+    'no_trailing_comma_in_list_call' => true,
+    'no_trailing_comma_in_singleline_array' => true,
+    'no_unneeded_control_parentheses' => true,
+    'no_unneeded_curly_braces' => true,
+    'no_unset_cast' => true,
+    'no_unused_imports' => true,
+    'no_useless_else' => true,
+    'no_useless_return' => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line' => true,
+    'normalize_index_brace' => true,
+    'nullable_type_declaration_for_default_null_value' => true,
+    'object_operator_without_whitespace' => true,
+    'ordered_class_elements' => [
+        'order' => [
+            'use_trait', 'constant_public', 'constant_protected',
+            'constant_private', 'property_public_static', 'property_protected_static',
+            'property_private_static', 'property_public', 'property_protected',
+            'property_private', 'method_public_static', 'method_protected_static',
+            'method_private_static', 'construct', 'destruct', 'phpunit',
+            'method_public', 'method_protected', 'method_private', 'magic',
+        ],
+        'sortAlgorithm' => 'none',
+    ],
+    'php_unit_fqcn_annotation' => true,
+    'php_unit_method_casing' => ['case' => 'camel_case'],
+    'php_unit_ordered_covers' => true,
+    'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
+    'phpdoc_align' => ['align' => 'left'],
+    'phpdoc_inline_tag' => true,
+    'phpdoc_line_span' => [
+        'const' => 'multi',
+        'method' => 'multi',
+        'property' => 'multi',
+    ],
+    'phpdoc_no_access' => true,
+    'phpdoc_no_empty_return' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_order' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_to_comment' => false,
+    'phpdoc_trim' => true,
+    'phpdoc_trim_consecutive_blank_line_separation' => true,
+    'phpdoc_var_without_name' => true,
+    'protected_to_private' => true,
+    'return_assignment' => false,
+    'return_type_declaration' => ['space_before' => 'one'],
+    'semicolon_after_instruction' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => true,
+    'single_blank_line_before_namespace' => true,
+    'single_quote' => true,
+    'single_line_comment_style' => true,
+    'ternary_operator_spaces' => true,
+    'ternary_to_null_coalescing' => true,
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'whitespace_after_comma_in_array' => true,
+])->setFinder($finder);

CHANGELOG.md

@@ -0,0 +1,2 @@
+0.0.1-beta
+    - Migrate code from Server package

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Andrew DalPino
+
+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,182 @@
+# Rubix Client
+The client SDK for Rubix ML Server.
+
+## Installation
+Install Rubix Client SDK using [Composer](https://getcomposer.org/):
+
+```sh
+$ composer require rubix/client
+```
+
+## Requirements
+- [PHP](https://php.net/manual/en/install.php) 7.4 or above
+
+## Documentation
+The latest documentation can be found below.
+
+### Table of Contents
+- [Clients](#clients)
+	- [REST Client](#rest-client)
+- [Client Middleware](#client-middleware)
+	- [Backoff and Retry](#backoff-and-retry)
+	- [Basic Authenticator](#basic-authenticator-client-side)
+	- [Compress Request Body](#compress-request-body)
+	- [Shared Token Authenticator](#shared-token-authenticator-client-side)
+
+---
+### Clients
+Clients allow you to communicate directly with a model server using a friendly object-oriented interface inside your PHP applications. Under the hood, clients handle all the networking communication and content negotiation for you so you can write programs *as if* the model was directly accessible in your applications.
+
+Return the predictions from the model:
+```php
+public predict(Dataset $dataset) : array
+```
+
+```php
+use Rubix\Client\RESTClient;
+
+$client = new RESTClient('127.0.0.1', 8080);
+
+// Import a dataset
+
+$predictions = $client->predict($dataset);
+```
+
+Calculate the joint probabilities of each sample in a dataset:
+```php
+public proba(Dataset $dataset) : array
+```
+
+Calculate the anomaly scores of each sample in a dataset:
+```php
+public score(Dataset $dataset) : array
+```
+
+### Async Clients
+Clients that implement the Async Client interface have asynchronous versions of all the standard client methods. All asynchronous methods return a [Promises/A+](https://promisesaplus.com/) object that resolves to the return value of the response. Promises allow you to perform other work while the request is processing or to execute multiple requests in parallel. Calling the `wait()` method on the promise will block until the promise is resolved and return the value.
+
+```php
+public predictAsync(Dataset $dataset) : Promise
+```
+
+```php
+$promise = $client->predictAsync($dataset);
+
+// Do something else
+
+$predictions = $promise->wait();
+```
+
+Return a promise for the probabilities predicted by the model:
+```php
+public probaAsync(Dataset $dataset) : Promise
+```
+
+Return a promise for the anomaly scores predicted by the model:
+```php
+public scoreAsync(Dataset $dataset) : Promise
+```
+
+### REST Client
+The REST Client communicates with the [HTTP Server](#http-server) through the JSON REST API it exposes.
+
+Interfaces: [Client](#clients), [AsyncClient](#async-clients)
+
+#### Parameters
+| # | Param | Default | Type | Description |
+|---|---|---|---|---|
+| 1 | host | '127.0.0.1' | string | The IP address or hostname of the server. |
+| 2 | port | 8000 | int | The network port that the HTTP server is running on. |
+| 3 | secure | false | bool | Should we use an encrypted HTTP channel (HTTPS)? |
+| 4 | middlewares | | array | The stack of client middleware to run on each request/response.  |
+| 5 | timeout | | float | The number of seconds to wait before giving up on the request. |
+| 6 | verify certificate | true | bool | Should we try to verify the server's TLS certificate? |
+
+**Example**
+
+```php
+use Rubix\Client\RESTClient;
+use Rubix\Client\HTTP\Middleware\BasicAuthenticator;
+use Rubix\Client\HTTP\Middleware\CompressRequestBody;
+use Rubix\Client\HTTP\Middleware\BackoffAndRetry;
+use Rubix\Client\HTTP\Encoders\Gzip;
+
+$client = new RESTClient('127.0.0.1', 443, true, [
+	new BasicAuthenticator('user', 'password'),
+	new CompressRequestBody(new Gzip(1)),
+	new BackoffAndRetry(),
+], 0.0, true);
+```
+
+### Client Middleware
+Similarly to Server middleware, client middlewares are functions that hook into the request/response cycle but from the client end. Some of the server middlewares have accompanying client middleware such as [Basic Authenticator](#basic-authenticator) and [Shared Token Authenticator](#shared-token-authenticator).
+
+### Backoff and Retry
+The Backoff and Retry middleware handles Too Many Requests (429) and Service Unavailable (503) responses by retrying the request after waiting for a period of time to avoid overloading the server even further. An acceptable backoff period is gradually achieved by multiplicatively increasing the delay between retries.
+
+#### Parameters
+| # | Param | Default | Type | Description |
+|---|---|---|---|---|
+| 1 | max retries | 3 | int | The maximum number of times to retry the request before giving up. |
+| 2 | initial delay | 0.5 | float | The number of seconds to delay between retries before exponential backoff is applied. |
+
+**Example**
+
+```php
+use Rubix\Client\HTTP\Middleware\BackoffAndRetry;
+
+$middleware = new BackoffAndRetry(5, 0.5);
+```
+
+### Basic Authenticator (Client Side)
+Adds the necessary authorization headers to the request using the Basic scheme.
+
+#### Parameters
+| # | Param | Default | Type | Description |
+|---|---|---|---|---|
+| 1 | username | | string | The user's name. |
+| 2 | password | | string | The user's password. |
+
+**Example**
+
+```php
+use Rubix\Client\HTTP\Middleware\BasicAuthenticator;
+
+$middleware = new BasicAuthenticator('morgan', 'secret');
+```
+
+### Compress Request Body
+Apply the Gzip compression algorithm to the request body.
+
+#### Parameters
+| # | Param | Default | Type | Description |
+|---|---|---|---|---|
+| 1 | level | 1 | int | The compression level between 0 and 9 with 0 meaning no compression. |
+| 2 | threshold | 65535 | int | The minimum size of the request body in bytes in order to be compressed. |
+
+**Example**
+
+```php
+use Rubix\Client\HTTP\Middleware\CompressRequestBody;
+
+$middleware = new CompressRequestBody(5, 65535);
+```
+
+### Shared Token Authenticator (Client Side)
+Adds the necessary authorization headers to the request using the Bearer scheme.
+
+#### Parameters
+| # | Param | Default | Type | Description |
+|---|---|---|---|---|
+| 1 | token | | string | The shared token to authenticate the request. |
+
+**Example**
+
+```php
+use Rubix\Client\HTTP\Middleware\SharedtokenAuthenticator;
+
+$middleware = new SharedTokenAuthenticator('secret');
+```
+
+## License
+The code is licensed [MIT](LICENSE) and the documentation is licensed [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/).

SECURITY.md

@@ -0,0 +1,2 @@
+# Reporting a Vulnerability
+If you find a vulnerability in our software we ask that you alert us in a timely and private manner. You can report any security vulnerabilities to [email protected]. In your message, please include a brief description of the vulnerability, the conditions, and steps necessary to reproduce the exploit.