Merge pull request #7 from elyday/0.2

0.2.0

Author: elyday

.env.example

@@ -15,3 +15,8 @@ DB_PASSWORD=secret
 
 CACHE_DRIVER=file
 QUEUE_DRIVER=sync
+
+CAPTCHA_SECRET=captcha
+
+AUTH0_API_AUDIENCE=
+AUTH0_DOMAIN=

README.md

@@ -0,0 +1,17 @@
+# PHP Comment Server
+[![Build Status](https://travis-ci.org/elyday/comment-server.svg)](https://travis-ci.org/elyday/comment-server)
+[![Total Downloads](https://poser.pugx.org/elyday/comment-server/downloads)](https://packagist.org/packages/elyday/comment-server)
+[![License](https://poser.pugx.org/elyday/comment-server/license.svg)](https://packagist.org/packages/elyday/comment-server)
+[![Latest Stable Version](https://poser.pugx.org/elyday/comment-server/v/stable.svg)](https://packagist.org/packages/elyday/comment-server)
+[![Latest Unstable Version](https://poser.pugx.org/elyday/comment-server/v/unstable.svg)](https://packagist.org/packages/elyday/comment-server)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/elyday/comment-server/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/elyday/comment-server/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/elyday/comment-server/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/elyday/comment-server/?branch=master)
+
+This comment server was written using the [PHP Microframework Lumen](https://lumen.laravel.com/) and is used to store, moderate and read comments.
+
+## Configuration
+1. To use the Comment Server you must first copy the file `.env.example` and rename it to `.env`.
+2. Then you have to specify a key for the app under `APP_KEY` (best with the head over the keyboard).
+3. Now you have to enter your database configuration in the `DB_` section. This includes address, user name and password.
+4. With `CAPTCHA_SECRET` you now have to define a captcha. This must be answered or sent as soon as someone wants to write a comment.
+5. wip...

_ide_helper.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * A helper file for Laravel 5, to provide autocomplete information to your IDE
- * Generated for Laravel Lumen (5.6.3) (Laravel Components 5.6.*) on 2018-04-10 13:41:42.
+ * Generated for Laravel Lumen (5.6.3) (Laravel Components 5.6.*) on 2018-04-20 08:37:22.
  *
  * This file should not be included in your code, only analyzed by your IDE!
  *

app/Blog.php

@@ -8,31 +8,33 @@
 /**
  * Class Blog
  *
- * @property int $id
+ * @package App
+ * @property string $hash
  * @property string $name
  * @property string $description
  * @property string $url
  * @property \Carbon\Carbon|null $created_at
  * @property \Carbon\Carbon|null $updated_at
  * @method static Builder|Blog whereCreatedAt($value)
  * @method static Builder|Blog whereDescription($value)
- * @method static Builder|Blog whereId($value)
+ * @method static Builder|Blog whereHash($value)
  * @method static Builder|Blog whereName($value)
  * @method static Builder|Blog whereUpdatedAt($value)
  * @method static Builder|Blog whereUrl($value)
- * @method static Builder|Blog whereHash($value)
  * @mixin \Eloquent
- * @property string $hash
  */
 class Blog extends Model
 {
     protected $table = "blog";
+    protected $primaryKey = "hash";
+    protected $keyType = "varchar";
 
     protected $fillable = [
-        'name', 'description', 'url'
+        'hash',
+        'name',
+        'description',
+        'url'
     ];
 
-    protected $hidden = [
-        'hash'
-    ];
+    protected $hidden = [];
 }

app/BlogArticle.php

@@ -9,17 +9,17 @@
  * Class BlogArticle
  *
  * @package App
- * @property int $id
- * @property int $blogId
+ * @property string $hash
+ * @property string $blogHash
  * @property string $title
  * @property string $author
  * @property string $url
  * @property \Carbon\Carbon|null $created_at
  * @property \Carbon\Carbon|null $updated_at
  * @method static Builder|BlogArticle whereAuthor($value)
- * @method static Builder|BlogArticle whereBlogId($value)
+ * @method static Builder|BlogArticle whereBlogHash($value)
  * @method static Builder|BlogArticle whereCreatedAt($value)
- * @method static Builder|BlogArticle whereId($value)
+ * @method static Builder|BlogArticle whereHash($value)
  * @method static Builder|BlogArticle whereTitle($value)
  * @method static Builder|BlogArticle whereUpdatedAt($value)
  * @method static Builder|BlogArticle whereUrl($value)
@@ -28,9 +28,15 @@
 class BlogArticle extends Model
 {
     protected $table = "blog_article";
+    protected $primaryKey = 'hash';
+    protected $keyType = "varchar";
 
     protected $fillable = [
-        'blogId', 'title', 'author', 'url'
+        'hash',
+        'blogHash',
+        'title',
+        'author',
+        'url'
     ];
 
     protected $hidden = [];

app/Comments.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * Class Comments
+ *
+ * @package App
+ * @property string $hash
+ * @property string $articleHash
+ * @property string $authorName
+ * @property string|null $authorMail
+ * @property string|null $title
+ * @property string $content
+ * @property \Carbon\Carbon|null $created_at
+ * @property \Carbon\Carbon|null $updated_at
+ * @method static Builder|Comments whereArticleHash($value)
+ * @method static Builder|Comments whereAuthorMail($value)
+ * @method static Builder|Comments whereAuthorName($value)
+ * @method static Builder|Comments whereContent($value)
+ * @method static Builder|Comments whereCreatedAt($value)
+ * @method static Builder|Comments whereHash($value)
+ * @method static Builder|Comments whereTitle($value)
+ * @method static Builder|Comments whereUpdatedAt($value)
+ * @mixin \Eloquent
+ */
+class Comments extends Model
+{
+    protected $table = "comments";
+
+    protected $fillable = [
+        'hash',
+        'articleHash',
+        'authorName',
+        'authorMail',
+        'title',
+        'content'
+    ];
+
+    protected $hidden = [];
+}

app/Http/Controllers/ArticleController.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\BlogArticle;
+use App\Comments;
+use App\Helper\FormatHelper;
+use Illuminate\Http\Request;
+
+/**
+ * Class ArticleController
+ * @package App\Http\Controllers
+ */
+class ArticleController extends Controller
+{
+    public function getArticlesByBlog($blogHash)
+    {
+        $blogArticle = new BlogArticle();
+        $articleResult = $blogArticle->where("blogHash", $blogHash)->orderBy("created_at")->get();
+
+        return FormatHelper::formatData($articleResult);
+    }
+
+    public function addArticle(Request $request)
+    {
+        $article = new BlogArticle();
+
+        $blogHash = $request->input("blogHash");
+        $title = $request->input("title");
+        $author = $request->input("author");
+        $url = $request->input("url");
+
+        $articleHash = md5(time());
+        $dataArray = array(
+            "hash" => $articleHash,
+            "blogHash" => $blogHash,
+            "title" => $title,
+            "author" => $author,
+            "url" => $url
+        );
+        $article->create($dataArray);
+        return $dataArray;
+    }
+
+    public function editArticle(Request $request)
+    {
+        $article = new BlogArticle();
+
+        $articleHash = $request->input("blogHash");
+        $title = $request->input("title");
+        $author = $request->input("author");
+        $url = $request->input("url");
+
+        $dataArray = array();
+
+        if ($title != null) {
+            $dataArray["title"] = $title;
+        }
+
+        if ($author != null) {
+            $dataArray["author"] = $author;
+        }
+
+        if ($url != null) {
+            $dataArray["url"] = $url;
+        }
+
+        $article->where("hash", $articleHash)->update($dataArray);
+
+        return $dataArray;
+    }
+
+    public function deleteArticle($articleHash)
+    {
+        $comment = new Comments();
+
+        $article = new BlogArticle();
+        $articleResult = $article->where("hash", $articleHash)->first();
+        if ($articleResult != null) {
+            $comment->where("articleHash", $articleHash)->delete();
+            $articleResult->delete();
+            return FormatHelper::formatData(array(), true);
+        } else {
+            return FormatHelper::formatData(array("errorCode" => "article-not-found"), false, 404);
+        }
+    }
+}

app/Http/Controllers/BlogController.php

@@ -5,6 +5,7 @@
 use App\Blog;
 use App\BlogArticle;
 use App\Helper\FormatHelper;
+use Illuminate\Http\Request;
 
 /**
  * Class BlogController
@@ -17,25 +18,86 @@ public function index()
         return FormatHelper::formatData(Blog::all());
     }
 
-    public function getBlog($blogHash)
+    public function getBlogByHash($blogHash)
     {
         $blog = new Blog();
-        $return = $blog->where("hash", $blogHash)->first();
-        return $return != null ? FormatHelper::formatData($return) : FormatHelper::formatData(array(), FALSE);
+        $blogResult = $blog->where("hash", $blogHash)->first();
+
+        if ($blogResult != null) {
+            return FormatHelper::formatData($blogResult);
+        } else {
+            return FormatHelper::formatData(array("errorCode" => "blog-not-found"), false, 404);
+        }
     }
 
-    public function getBlogWithArticles($blogHash)
+    public function getArticle($articleHash)
+    {
+        $article = new BlogArticle();
+        $articleResult = $article->where("hash", $articleHash)->first();
+
+        if ($articleResult != null) {
+            return FormatHelper::formatData($articleResult);
+        } else {
+            return FormatHelper::formatData(array("errorCode" => "article-not-found"), false, 404);
+        }
+    }
+
+    public function addBlog(Request $request)
     {
         $blog = new Blog();
-        $blogResult = $blog->where("hash", $blogHash)->first();
 
-        if ($blogResult != null) {
-            $blogArticle = new BlogArticle();
-            $blogResult["articles"] = $blogArticle->where("blogId", $blogResult["id"])->get();
+        $name = $request->input("name");
+        $description = $request->input("description");
+        $url = $request->input("url");
 
-            return $blogResult != null ? FormatHelper::formatData($blogResult) : FormatHelper::formatData(array(), FALSE);
+        $blogHash = md5(time());
+        $dataArray = array(
+            "hash" => $blogHash,
+            "name" => $name,
+            "description" => $description,
+            "url" => $url
+        );
+        $blog->create($dataArray);
+        return $dataArray;
+    }
+
+    public function editBlog(Request $request)
+    {
+        $blog = new Blog();
+
+        $blogHash = $request->input("hash");
+        $name = $request->input("name");
+        $description = $request->input("description");
+        $url = $request->input("url");
+
+        $dataArray = array();
+
+        if ($name != null) {
+            $dataArray["name"] = $name;
+        }
+
+        if ($description != null) {
+            $dataArray["description"] = $description;
+        }
+
+        if ($url != null) {
+            $dataArray["url"] = $url;
+        }
+
+        $blog->where("hash", $blogHash)->update($dataArray);
+
+        return $dataArray;
+    }
+
+    public function deleteBlog($blogHash)
+    {
+        $blog = new Blog();
+        $blogResult = $blog->where("hash", $blogHash)->first();
+        if ($blogResult != null) {
+            $blogResult->delete();
+            return FormatHelper::formatData(array(), true);
         } else {
-            return FormatHelper::formatData(array(), false);
+            return FormatHelper::formatData(array("errorCode" => "blog-not-found"), false, 404);
         }
     }
 }