Transport Foundation

Author: bajb

README.md

@@ -0,0 +1,3 @@
+# API Transport
+
+Foundation for json<>php data transport

composer.json

@@ -0,0 +1,38 @@
+{
+  "name": "cubex/api-transport",
+  "description": "Cubex API Transport",
+  "keywords": [
+    "api",
+    "cubex"
+  ],
+  "homepage": "http://cubex.io",
+  "license": "BSD-3-Clause",
+  "authors": [
+    {
+      "name": "Brooke Bryan",
+      "email": "[email protected]",
+      "homepage": "http://www.bajb.net"
+    }
+  ],
+  "config": {
+    "optimize-autoloader": true
+  },
+  "require": {
+    "php": ">=7.2",
+    "ext-json": "*",
+    "packaged/context": "~1.3",
+    "packaged/helpers": "~1|~2"
+  },
+  "require-dev": {
+  },
+  "autoload": {
+    "psr-4": {
+      "Cubex\\ApiTransport\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Cubex\\ApiTransport\\Tests\\": "tests/"
+    }
+  }
+}

src/Endpoints/AbstractEndpoint.php

@@ -0,0 +1,32 @@
+<?php
+namespace Cubex\ApiTransport\Endpoints;
+
+use Cubex\ApiTransport\Permissions\ApiPermission;
+
+abstract class AbstractEndpoint implements ApiEndpoint
+{
+  /**
+   * Permissions that are required to make a request to this endpoint
+   *
+   * @return ApiPermission[]
+   */
+  public function getRequiredPermissions(): array
+  {
+    return [];
+  }
+
+  /**
+   * Permissions that may be used within the endpoint to provide functionality
+   *
+   * @return ApiPermission[]
+   */
+  public function getPermissions(): array
+  {
+    return [];
+  }
+
+  public function requiresAuthentication(): bool
+  {
+    return true;
+  }
+}

src/Endpoints/ApiEndpoint.php

@@ -0,0 +1,61 @@
+<?php
+namespace Cubex\ApiTransport\Endpoints;
+
+use Cubex\ApiTransport\Permissions\ApiPermission;
+
+interface ApiEndpoint
+{
+  const VERB_HEAD = 'HEAD';
+  const VERB_GET = 'GET';
+  const VERB_POST = 'POST';
+  const VERB_PUT = 'PUT';
+  const VERB_PATCH = 'PATCH';
+  const VERB_DELETE = 'DELETE';
+  const VERB_PURGE = 'PURGE';
+  const VERB_OPTIONS = 'OPTIONS';
+  const VERB_TRACE = 'TRACE';
+  const VERB_CONNECT = 'CONNECT';
+
+  /**
+   * @return string HTTP Verb e.g. GET, POST, DELETE, PATCH
+   */
+  public function getVerb(): string;
+
+  /**
+   * @return string Path the endpoint can be located
+   */
+  public function getPath(): string;
+
+  /**
+   * Payload Class
+   *
+   * @return null|string
+   */
+  public function getPayloadClass(): ?string;
+
+  /**
+   * Response Class
+   *
+   * @return string
+   */
+  public function getResponseClass(): string;
+
+  /**
+   * Permissions that are required to make a request to this endpoint
+   *
+   * @return ApiPermission[]
+   */
+  public function getRequiredPermissions(): array;
+
+  /**
+   * Permissions that may be used within the endpoint to provide functionality
+   *
+   * @return ApiPermission[]
+   */
+  public function getPermissions(): array;
+
+  /**
+   * @return bool
+   */
+  public function requiresAuthentication(): bool;
+}

src/Exceptions/ApiException.php

@@ -0,0 +1,6 @@
+<?php
+namespace Cubex\ApiTransport\Exceptions;
+
+interface ApiException extends \Throwable
+{
+}

src/Exceptions/GenericApiException.php

@@ -0,0 +1,6 @@
+<?php
+namespace Cubex\ApiTransport\Exceptions;
+
+class GenericApiException extends \Exception implements ApiException
+{
+}

src/Payloads/AbstractPayload.php

@@ -0,0 +1,37 @@
+<?php
+namespace Cubex\ApiTransport\Payloads;
+
+use Packaged\Context\Context;
+use Packaged\Helpers\Objects;
+use Packaged\Helpers\ValueAs;
+
+abstract class AbstractPayload implements ApiPayload
+{
+  public function isValid(): bool
+  {
+    return $this->_validate();
+  }
+
+  protected function _validate(): bool
+  {
+    return true;
+  }
+
+  public static function i()
+  {
+    return new static();
+  }
+
+  /**
+   * @param Context $c
+   *
+   * @return static
+   * @throws \Exception
+   */
+  public function fromContext(Context $c)
+  {
+    $json = ValueAs::obj(json_decode($c->request()->getContent()), new \stdClass());
+    Objects::hydrate($this, $json);
+    return $this;
+  }
+}

src/Payloads/ApiPayload.php

@@ -0,0 +1,7 @@
+<?php
+namespace Cubex\ApiTransport\Payloads;
+
+interface ApiPayload
+{
+
+}

src/Permissions/AbstractPermission.php

@@ -0,0 +1,6 @@
+<?php
+namespace Cubex\ApiTransport\Permissions;
+
+abstract class AbstractPermission implements ApiPermission
+{
+}

src/Permissions/ApiPermission.php

@@ -0,0 +1,7 @@
+<?php
+namespace Cubex\ApiTransport\Permissions;
+
+interface ApiPermission
+{
+  public function getKey(): string;
+}

src/Responses/AbstractResponse.php

@@ -0,0 +1,7 @@
+<?php
+namespace Cubex\ApiTransport\Responses;
+
+abstract class AbstractResponse implements ApiResponse
+{
+
+}

src/Responses/ApiResponse.php

@@ -0,0 +1,7 @@
+<?php
+namespace Cubex\ApiTransport\Responses;
+
+interface ApiResponse
+{
+
+}