complete implementation of REST api in typo3 flow

Classes/Joson/Rest/Command/UserCommandController.php

+<?php
+namespace Joson\Rest\Command;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+use TYPO3\Flow\Annotations as Flow;
+
+/**
+ * @Flow\Scope("singleton")
+ */
+class UserCommandController extends \TYPO3\Flow\Cli\CommandController
+{
+   const user_role = 'Joson.Test:Admin';
+   const authentication_provider = 'DefaultProvider';
+   const password_hashing_strategy = 'default';
+
+    /**
+    * @Flow\Inject
+    * @var \TYPO3\Flow\Security\AccountFactory
+    */
+    protected $accountFactory;
+
+    /**
+     * @var \TYPO3\Flow\Security\AccountRepository
+     * @Flow\Inject
+     */
+    protected $accountRepository;
+
+    /**
+    * @Flow\Inject
+    * @var \Joson\Rest\Domain\Repository\RealUsersRepository
+    */
+    protected $realUsersRepository;
+
+    /**
+    * @Flow\Inject
+    * @var \TYPO3\Flow\Security\Cryptography\HashService
+    */
+    protected $hashService;
+
+    /**
+     * This command is used for adding authenticated user in the current system.
+     *
+     * @param string $username
+     * @param string $password
+     * @Flow\Validate(argumentName="username", type="NotEmpty")
+     * @Flow\Validate(argumentName="password", type="NotEmpty")
+     * @return void
+     */
+    public function createCommand($username, $password )
+    {
+
+      $this->outputLine('Trying to create a user with the username "%s", password "%s".', [$username, $password]);
+
+      $duplicateUser = $this->realUsersRepository->findOneByUsername($username);
+      if( empty($duplicateUser) === false ) {
+        $this->outputLine("Duplicate user.");
+      } else {
+        $account = $this->accountFactory->createAccountWithPassword($username, $password, [self::user_role], self::authentication_provider);
+        $token = $this->hashService->generateHmac($username);
+        $realUser = new \Joson\Rest\Domain\Model\RealUsers();
+        $realUser->setUsername($username);
+        $realUser->setPassword($password);
+        $realUser->setUserAccount($account);
+        $realUser->setToken($token);
+        $this->accountRepository->add($account);
+        $this->realUsersRepository->add($realUser);
+        $this->outputLine('Added the user "%s" to the system.', [$username]);
+        $this->outputLine('Authenticated Token is "%s".', [$token]);
+      }
+
+    }
+
+    /**
+     * @param  string $username
+     */
+    public function removeCommand($username, $authentication_provider=NULL)
+    {
+        $this->outputLine('Trying to remove the user "%s" from system.', [$username]);
+        $authentication_provider = ($authentication_provider!=NULL) ? $authentication_provider : self::authentication_provider;
+        $account = $this->getAccountByIdentifier($username, $authentication_provider);
+        if ($account != NULL) {
+            $this->accountRepository->remove($account);
+            $realUser = $this->realUsersRepository->findOneByUsername($username);
+            if ($realUser!=NULL) $this->realUsersRepository->remove($realUser);
+            $this->outputLine('Removed the user "%s" from system.', [$username]);
+        } else {
+            $this->outputLine('Cant find the user "%s" in the system.', [$username]);
+        }
+    }
+
+   private function getAccountByIdentifier($identifier, $authentication_provider)
+   {
+       return $this->accountRepository->findByAccountIdentifierAndAuthenticationProviderName($identifier, $authentication_provider);
+   }
+
+}

Classes/Joson/Rest/Controller/StandardController.php

+<?php
+namespace Joson\Rest\Controller;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+use TYPO3\Flow\Annotations as Flow;
+
+class StandardController extends \TYPO3\Flow\Mvc\Controller\ActionController {
+
+	/**
+	 * @Flow\Inject
+	 * @var \Joson\Rest\Domain\Repository\UserRepository
+	 */
+	protected $userRepository;
+
+	/**
+	* @Flow\Inject
+	* @var \Joson\Rest\Domain\Repository\RealUsersRepository
+	*/
+	protected $realUsersRepository;
+
+	/**
+	 * Adding user (PUT HTTP method)
+	 * @return void
+	 */
+	public function indexAction() {
+		$flag1    = 0;
+		$name = "";
+		$age  = "";
+		try {
+			$checkToken = $this->hasAuthenticatedUser();
+			if( $checkToken === true ) {
+				if ($this->request->hasArgument("name") == false) {
+					$this->response->setStatus(400, "Bad Request");
+					$flag1   = 1;
+				} else {
+					$name =$this->request->getArgument("name");
+					if( empty($name) === true ) {
+						$this->response->setStatus(400, "Bad Request");
+						$flag1   = 1;
+					} else {
+						if ($this->request->hasArgument("age") == false) {
+							$this->response->setStatus(400, "Bad Request");
+							$flag1   = 1;
+						} else {
+							$age = $this->request->getArgument("age");
+							if( empty($age) === true ) {
+								$this->response->setStatus(400, "Bad Request");
+								$flag1   = 1;
+							}
+						}
+					}
+
+				}
+				if ($flag1 == 0) {
+					$user = new \Joson\Rest\Domain\Model\User();
+					$user->setName($name);
+					$user->setAge($age);
+					$this->userRepository->add($user);
+					$this->response->setStatus(201, "Created");
+				}
+				$this->persistenceManager->persistAll();
+		}
+
+		} catch (\Exception $e) {
+			$this->response->setStatus(500, "Internal Server Error");
+		}
+		return "";
+
+	}
+
+	/**
+	 * get Details of users (GET HTTP method)
+	 * @return void
+	 */
+	public function getUserAction() {
+		$user    = array();
+		$id = NULL;
+		try {
+			$checkToken = $this->hasAuthenticatedUser();
+			if( $checkToken === true ) {
+				if ($this->request->hasArgument("id") == true) {
+					$id = $this->request->getArgument("id");
+				}
+
+				if (empty($id) == false) {
+					$users = $this->userRepository->findOneById($id);
+				} else {
+					$users = $this->userRepository->findAll();
+				}
+
+				if (empty($users) == true) {
+					$this->response->setStatus(204, "No Content");
+				} else {
+					$i = 0;
+					if ($users instanceof \Joson\Rest\Domain\Model\User) {
+						$user[$i]["id"] = $users->getId();
+						$user[$i]["name"] = $users->getName();
+						$user[$i]["age"]  = $users->getAge();
+					} else {
+						foreach ($users as $userDetails) {
+							$user[$i]["id"] = $userDetails->getId();
+							$user[$i]["name"] = $userDetails->getName();
+							$user[$i]["age"]  = $userDetails->getAge();
+							$i++;
+						}
+					}
+
+				}
+			}
+
+			$this->persistenceManager->persistAll();
+		} catch (\Exception $e) {
+			$this->response->setStatus(500, "Internal Server Error");
+		}
+
+		return \json_encode($user);
+
+	}
+
+	/**
+	 * Remove user from user table (DELETE HTTP method)
+	 * @return void
+	 */
+	public function removeUserAction() {
+		try {
+			$checkToken = $this->hasAuthenticatedUser();
+			if( $checkToken == true ) {
+				if ($this->request->hasArgument("id") === true) {
+					$id    = $this->request->getArgument("id");
+					$users = $this->userRepository->findOneById($id);
+					if (empty($users) === true) {
+						$this->response->setStatus(204, "No Content");
+					} else {
+						$this->userRepository->remove($users);
+					}
+				} else {
+					$this->response->setStatus(400, "Bad Request");
+				}
+				$this->persistenceManager->persistAll();
+			}
+
+		} catch (\Exception $e) {
+			$this->response->setStatus(500, "Internal Server Error");
+		}
+		return "";
+	}
+
+	/**
+	 * Update the user details (POST HTTP method)
+	 * @return void
+	 */
+	public function updateUserAction() {
+
+		$flag1   = 0;
+		$id   = 0;
+		$name = "";
+		$age  = 0;
+
+		try {
+			$checkToken = $this->hasAuthenticatedUser();
+			if( $checkToken === true ) {
+				if ($this->request->hasArgument("id") === false) {
+					$this->response->setStatus(400, "Bad Request");
+					$flag1   = 1;
+				} else {
+					$id = $this->request->getArgument("id");
+					if (empty($id) === true) {
+						$this->response->setStatus(400, "Bad Request");
+						$flag1   = 1;
+					} else {
+						if ($this->request->hasArgument("name") === false) {
+							$this->response->setStatus(400, "Bad Request");
+							$flag1   = 1;
+						} else {
+							$name = $this->request->getArgument("name");
+							if (empty($name) === true) {
+								$this->response->setStatus(400, "Bad Request");
+								$flag1   = 1;
+							} else {
+								if ($this->request->hasArgument("age") === false) {
+									$this->response->setStatus(400, "Bad Request");
+									$flag1   = 1;
+								} else {
+									$age = $this->request->getArgument("age");
+									if (empty($age) === true) {
+										$this->response->setStatus(400, "Bad Request");
+										$flag1   = 1;
+									}
+								}
+							}
+						}
+					}
+				}
+
+				if ($flag1 === 0) {
+					$users = $this->userRepository->findOneById($id);
+					if (empty($users) === true) {
+						$this->response->setStatus(204, "No Content");
+					} else {
+						$users->setName($name);
+						$users->setAge($age);
+						$this->userRepository->update($users);
+					}
+				}
+			}
+			$this->persistenceManager->persistAll();
+		} catch (\Exception $e) {
+			$this->response->setStatus(500, "Internal Server Error");
+		}
+
+		return "";
+	}
+
+	/**
+	* Update small part of user details (PATCH HTTP method)
+	* @return void
+	*/
+	public function updatePartialUserDetailsAction() {
+		$flag1   = 0;
+		$id   = 0;
+		$name = "";
+		$age  = 0;
+		try {
+			$checkToken = $this->hasAuthenticatedUser();
+			if( $checkToken === true ) {
+				if( $this->request->hasArgument("id") === false ) {
+					$this->response->setStatus(400, "Bad Request");
+					$flag1   = 1;
+				} else {
+					$id = $this->request->getArgument("id");
+					if( empty($id) === true ) {
+						$this->response->setStatus(400, "Bad Request");
+						$flag1   = 1;
+					}
+				}
+
+				if($flag1 === 0) {
+					$user = $this->userRepository->findOneById($id);
+					if( empty($user) === true ) {
+						$this->response->setStatus(204, "No Content");
+					} else {
+						if( $this->request->hasArgument("name") === true ) {
+							$name = $this->request->getArgument("name");
+							if( empty($name) === true ) {
+								$name = $user->getName();
+							}
+						} else {
+							$name = $user->getName();
+						}
+
+						if( $this->request->hasArgument("age") === true ) {
+							$age = $this->request->getArgument("age");
+							if( empty($age) === true ) {
+								$age = $user->getAge();
+							}
+						} else {
+							$age = $user->getAge();
+						}
+						$user->setName($name);
+						$user->setAge($age);
+						$this->userRepository->update($user);
+					}
+
+				}
+
+			}
+			$this->persistenceManager->persistAll();
+
+		} catch (\Exception $e) {
+			$this->response->setStatus(500, "Internal Server Error");
+		}
+		return "";
+
+	}
+
+	/**
+	* Get the list of available http methods for this restful service (OPTIONS HTTP method)
+	* @return void
+	*/
+	public function getAvailableHttpMethodsAction() {
+		$checkToken = $this->hasAuthenticatedUser();
+		if( $checkToken === true ) {
+			$options = array(
+				"Allow"=>"PUT,GET,DELETE,POST,PATCH,OPTIONS"
+			);
+			return \json_encode($options);
+		}
+		return "";
+	}
+
+	/**
+	* Check whether authenticated token is valid or not
+	* @return boolean
+	*/
+	private function hasAuthenticatedUser() {
+		$currentHeaders = $this->response->getHeaders();
+		$currentHeaders->set('Content-Type', 'text/json; charset=utf-8');
+		$this->response->sendHeaders();
+		$returnResult = true;
+
+		// Authenticating user
+		$httpRequestHeaders = $this->request->getHttpRequest()->getHeaders();
+		if( empty($httpRequestHeaders) === true ) {
+			$this->response->setStatus(400, "Bad Request");
+			$returnResult = false;
+		} else {
+			if( $httpRequestHeaders->has("Token") === false ) {
+				$this->response->setStatus(400, "Bad Request");
+				$returnResult = false;
+			} else {
+				$authToken = $httpRequestHeaders->get("Token");
+				if( empty($authToken) ===  true ) {
+					$this->response->setStatus(401, "Unauthorized");
+					$returnResult = false;
+			} else {
+					$authUser = $this->realUsersRepository->findOneByToken($authToken);
+					if( empty($authUser) === true ) {
+						$this->response->setStatus(401, "Unauthorized");
+						$returnResult = false;
+					}
+				}
+			}
+		}
+		return $returnResult;
+	}
+
+}

Classes/Joson/Rest/Domain/Model/RealUsers.php

+<?php
+namespace Joson\Rest\Domain\Model;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+use Doctrine\ORM\Mapping as ORM;
+use TYPO3\Flow\Annotations as Flow;
+
+/**
+ * @Flow\Entity
+ */
+class RealUsers {
+
+	/**
+	 * @ORM\Id
+	 * @ORM\GeneratedValue
+	 * @ORM\Column(type="integer")
+	 * @var integer
+	 */
+	protected $id;
+
+	/**
+	 * @ORM\Column(name="realuser_username")
+	 * @var string
+	 */
+	protected $username = "";
+
+	/**
+	 * @ORM\Column(name="realuser_password")
+	 * @var string
+	 */
+	protected $password = "";
+
+  /**
+  * @ORM\Column(name="realuser_token")
+  * @var string
+  */
+  protected $token ="";
+
+	/**
+	 * @var \TYPO3\Flow\Security\Account
+	 * @ORM\OneToOne(cascade={"persist", "remove"})
+	 * @ORM\JoinColumns({@ORM\JoinColumn(name="realuser_account_id", referencedColumnName="id", nullable=true)})
+	 */
+	protected $userAccount = NULL;
+
+	/**
+	 * Get the value of $id
+	 * @return integer
+	 */
+	public function getId() {
+		return $this->id;
+	}
+
+	/**
+	 * Get the value of  $username
+	 * @return string
+	 */
+	public function getUsername() {
+		return $this->username;
+	}
+
+	/**
+	 * set the value of $username
+	 * @param string $username
+	 * @return void
+	 */
+	public function setUsername($username = "") {
+		$this->username = $username;
+	}
+
+	/**
+	 * Get the value of $password
+	 * @return string
+	 */
+	public function getPassword() {
+		return $this->password;
+	}
+
+	/**
+	 * Set the value of $password
+	 * @param string $password
+	 * @return void
+	 */
+	public function setPassword($password = "") {
+		$this->password = $password;
+	}
+
+	/**
+	 * Get value of $userAccount
+	 * @return \TYPO3\Flow\Security\Account
+	 */
+	public function getUserAccount() {
+		return $this->userAccount;
+	}
+
+	/**
+	 * Set the value of $userAccount
+	 * @param \TYPO3\Flow\Security\Account $userAccount
+	 * @return void
+	 */
+	public function setUserAccount($userAccount = NULL) {
+		$this->userAccount = $userAccount;
+	}
+
+  /**
+  * Get the value of $token
+  * @return string
+  */
+  public function getToken() {
+    return $this->token;
+  }
+
+  /**
+  * Set the value of $token
+  * @param string $token
+  * @return void 
+  */
+  public function setToken($token="") {
+    $this->token = $token;
+  }
+
+}

Classes/Joson/Rest/Domain/Model/User.php

+<?php
+namespace Joson\Rest\Domain\Model;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+ use TYPO3\Flow\Annotations as Flow;
+ use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @Flow\Entity
+ */
+class User {
+
+  /**
+  * @ORM\Id
+  * @ORM\GeneratedValue
+  * @ORM\Column(name="user_id")
+  * @var integer
+  */
+  protected $id;
+
+  /**
+  * @ORM\Column(name="user_name")
+  * @var string
+  */
+  protected $name="";
+
+  /**
+  * @ORM\Column(name="user_age")
+  * @var integer
+  */
+  protected $age = 0;
+
+  /**
+  * Get the value of $id
+  * @return integer
+  */
+  public function getId() {
+    return $this->id;
+  }
+
+  /**
+  * Get the value of $name
+  * @return string
+  */
+  public function getName() {
+    return $this->name;
+  }
+
+  /**
+  * sets the value of $name
+  * @param string $name
+  * @return void
+  */
+  public function setName($name="") {
+    $this->name = $name;
+  }
+
+  /**
+  * Gets the value of $age
+  * @return integer
+  */
+  public function getAge() {
+    return $this->age;
+  }
+
+  /**
+  * Sets the value of $age
+  * @return void
+  */
+  public function setAge($age=0) {
+    $this->age = $age;
+  }
+
+}

Classes/Joson/Rest/Domain/Repository/RealUsersRepository.php

+<?php
+namespace Joson\Rest\Domain\Repository;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+use TYPO3\Flow\Annotations as Flow;
+use TYPO3\Flow\Persistence\Repository;
+
+/**
+ * @Flow\Scope("singleton")
+ */
+class RealUsersRepository extends Repository
+{
+
+    // add customized methods here
+
+}

Classes/Joson/Rest/Domain/Repository/UserRepository.php

+<?php
+namespace Joson\Rest\Domain\Repository;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+use TYPO3\Flow\Annotations as Flow;
+use TYPO3\Flow\Persistence\Repository;
+
+/**
+ * @Flow\Scope("singleton")
+ */
+class UserRepository extends Repository
+{
+
+    // add customized methods here
+
+}

Configuration/Policy.yaml

+#                                                                        #
+# Security policy for the "Joson.Rest" package                            #
+#                                                                        #
+
+privilegeTargets:
+  TYPO3\Flow\Security\Authorization\Privilege\Method\MethodPrivilege:
+    Joson_Rest_Standard_Controller:
+      matcher: 'method(Joson\Test\Controller\StandardController->(.*)Action())'
+roles:
+  'Joson.Test:Admin':
+    privileges:
+      -
+        privilegeTarget: Joson_Rest_Standard_Controller
+        permission: GRANT

Configuration/Routes.yaml

+#                                                                        #
+# Routes configuration                                                   #
+#                                                                        #
+# This file contains the configuration for the MVC router.               #
+# Just add your own modifications as necessary.                          #
+#                                                                        #
+# Please refer to the Flow manual for possible configuration options.    #
+
+-
+  name: 'Add user details'
+  uriPattern: 'api/users'
+  defaults:
+    @package: 'Joson.Rest'
+    @controller: 'Standard'
+    @action: 'index'
+  httpMethods: ['PUT']
+  appendExceedingArguments: true
+-
+  name: 'Get users'
+  uriPattern: 'api/users'
+  defaults:
+    @package: 'Joson.Rest'
+    @controller: 'Standard'
+    @action: 'getUser'
+  httpMethods: ['GET']
+  appendExceedingArguments: true
+-
+  name: 'Remove user'
+  uriPattern: 'api/users'
+  defaults:
+    @package: 'Joson.Rest'
+    @controller: 'Standard'
+    @action: 'removeUser'
+  httpMethods: ['DELETE']
+  appendExceedingArguments: true
+-
+  name: 'Update user details'
+  uriPattern: 'api/users'
+  defaults:
+    @package: 'Joson.Rest'
+    @controller: 'Standard'
+    @action: 'updateUser'
+  httpMethods: ['POST']
+  appendExceedingArguments: true
+-
+  name: 'Update partial user details'
+  uriPattern: 'api/users'
+  defaults:
+    @package: 'Joson.Rest'
+    @controller: 'Standard'
+    @action: 'updatePartialUserDetails'
+  httpMethods: ['PATCH']
+  appendExceedingArguments: true
+-
+  name: 'Get the allowable http methods list'
+  uriPattern: 'api/users'
+  defaults:
+    @package: 'Joson.Rest'
+    @controller: 'Standard'
+    @action: 'getAvailableHttpMethods'
+  httpMethods: ['OPTIONS']
+  appendExceedingArguments: true

Documentation/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  livehtml   to make livereload HTML files at 127.0.0.1:8000"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+livehtml: html
+#	# Ignore Vim Temporary Files: *.sw[pmnox] and *~ and 4913
+	sphinx-autobuild -b html -i '*.sw[pmnox]' -i '*~' -i '*/4913' -i '4913' $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NeosCMS.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NeosCMS.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/NeosCMS"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NeosCMS"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

Documentation/_build/.gitignore

+*
+!.gitignore

Documentation/_static/.gitignore

+*
+!.gitignore

Documentation/_templates/.gitignore

+*
+!.gitignore

Documentation/index.rst

+Joson.Rest |version| Documentation
+==================================================================================================
+
+This documentation covering version |release| has been rendered at: |today|
+
+Introduction
+------------
+
+This package has very sparse documentation until now. You should fix this!
+
+Some markup examples
+--------------------
+
+Backticks make for `inline code` and code blocks can be in various languages like YAML:
+
+.. code-block:: yaml
+
+  TYPO3:
+    Neos:
+      Seo:
+        twitterCard:
+          siteHandle: '@neoscms'
+
+or PHP:
+
+.. code-block:: php
+  :linenos:
+
+  $foo = new Bar();
+  $drink = $bar->getKeeper()->order('White Russian');
+
+More information can be found at
+
+* https://www.neos.io/join/contribute.html
+* http://sphinx-doc.org/rest.html
+* https://docs.readthedocs.org/en/latest/getting_started.html#in-rst

Resources/Private/Layouts/Default.html

+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title><f:render section="Title" /></title>
+        <f:base />
+    </head>
+    <body>
+        <f:flashMessages class="flashmessages" />
+
+        <h1><f:render section="Title" /></h1>
+        <f:render section="Content" />
+    </body>
+</html>
\ No newline at end of file

Resources/Private/Templates/Standard/Index.html

+<f:layout name="Default" />
+
+<f:section name="Title">Index view of Standard controller</f:section>
+
+<f:section name="Content">
+    <h1>A freshly created Fluid template!</h1>
+    <p>Some data set by the controller:</p>
+    <ul>
+        
+        <f:for each="{foos}" as="foo">
+            <li>{foo}</li>
+        </f:for>
+        
+    </ul>
+</f:section>
\ No newline at end of file

Tests/Unit/Domain/Model/RealUsersTest.php

+<?php
+namespace Joson\Rest\Tests\Unit\Domain\Model;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+/**
+ * Testcase for Real users
+ */
+class RealUsersTest extends \TYPO3\Flow\Tests\UnitTestCase
+{
+
+    /**
+     * @test
+     */
+    public function makeSureThatSomethingHolds()
+    {
+        $this->markTestIncomplete('Automatically generated test case; you need to adjust this!');
+
+        $expected = 'Foo';
+        $actual = 'Foo'; // This should be the result of some function call
+        $this->assertSame($expected, $actual);
+    }
+}

Tests/Unit/Domain/Model/UserTest.php

+<?php
+namespace Joson\Rest\Tests\Unit\Domain\Model;
+
+/*
+ * This file is part of the Joson.Rest package.
+ */
+
+/**
+ * Testcase for User
+ */
+class UserTest extends \TYPO3\Flow\Tests\UnitTestCase
+{
+
+    /**
+     * @test
+     */
+    public function makeSureThatSomethingHolds()
+    {
+        $this->markTestIncomplete('Automatically generated test case; you need to adjust this!');
+
+        $expected = 'Foo';
+        $actual = 'Foo'; // This should be the result of some function call
+        $this->assertSame($expected, $actual);
+    }
+}

composer.json

+{
+    "name": "joson/rest",
+    "type": "typo3-flow-package",
+    "description": "Add description here",
+    "require": {
+        "typo3/flow": "*"
+    },
+    "autoload": {
+        "psr-0": {
+            "Joson\\Rest": "Classes"
+        }
+    }
+}
\ No newline at end of file