Add currency controls to API

app/Api/V1/Controllers/CurrencyController.php

@@ -0,0 +1,214 @@
+<?php
+/**
+ * CurrencyController.php
+ * Copyright (c) 2018 thegrumpydictator@gmail.com
+ *
+ * This file is part of Firefly III.
+ *
+ * Firefly III is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Firefly III is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+/**
+ * CurrencyController.php
+ * Copyright (c) 2018 thegrumpydictator@gmail.com
+ *
+ * This file is part of Firefly III.
+ *
+ * Firefly III is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Firefly III is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace FireflyIII\Api\V1\Controllers;
+
+use FireflyIII\Api\V1\Requests\BillRequest;
+use FireflyIII\Api\V1\Requests\CurrencyRequest;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
+use FireflyIII\Repositories\User\UserRepositoryInterface;
+use FireflyIII\Transformers\CurrencyTransformer;
+use Illuminate\Http\Request;
+use League\Fractal\Manager;
+use League\Fractal\Resource\Collection as FractalCollection;
+use League\Fractal\Resource\Item;
+use League\Fractal\Serializer\JsonApiSerializer;
+use Preferences;
+
+/**
+ * Class CurrencyController
+ */
+class CurrencyController extends Controller
+{
+    /** @var CurrencyRepositoryInterface */
+    private $repository;
+    /** @var UserRepositoryInterface */
+    private $userRepository;
+
+    /**
+     * CurrencyRepository constructor.
+     *
+     * @throws \FireflyIII\Exceptions\FireflyException
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var CurrencyRepositoryInterface repository */
+                $this->repository     = app(CurrencyRepositoryInterface::class);
+                $this->userRepository = app(UserRepositoryInterface::class);
+                $this->repository->setUser(auth()->user());
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param  TransactionCurrency $currency
+     *
+     * @return \Illuminate\Http\Response
+     * @throws FireflyException
+     */
+    public function delete(TransactionCurrency $currency)
+    {
+        if (!$this->userRepository->hasRole(auth()->user(), 'owner')) {
+            // access denied:
+            throw new FireflyException('No access to method, user is not owner.'); // @codeCoverageIgnore
+        }
+        if (!$this->repository->canDeleteCurrency($currency)) {
+            throw new FireflyException('No access to method, currency is in use.'); // @codeCoverageIgnore
+        }
+        $this->repository->destroy($currency);
+
+        return response()->json([], 204);
+    }
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @param Request $request
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function index(Request $request)
+    {
+        $collection = $this->repository->get();
+        $manager    = new Manager();
+        $baseUrl    = $request->getSchemeAndHttpHost() . '/api/v1';
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+        $defaultCurrency = app('amount')->getDefaultCurrencyByUser(auth()->user());
+        $this->parameters->set('defaultCurrency', $defaultCurrency);
+
+        $resource = new FractalCollection($collection, new CurrencyTransformer($this->parameters), 'currencies');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');
+    }
+
+
+    /**
+     * @param Request             $request
+     * @param TransactionCurrency $currency
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function show(Request $request, TransactionCurrency $currency)
+    {
+        $manager = new Manager();
+        // add include parameter:
+        $include = $request->get('include') ?? '';
+        $manager->parseIncludes($include);
+
+        $baseUrl = $request->getSchemeAndHttpHost() . '/api/v1';
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+        $defaultCurrency = app('amount')->getDefaultCurrencyByUser(auth()->user());
+        $this->parameters->set('defaultCurrency', $defaultCurrency);
+
+        $resource = new Item($currency, new CurrencyTransformer($this->parameters), 'currencies');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');
+    }
+
+    /**
+     * @param CurrencyRequest $request
+     *
+     * @return \Illuminate\Http\JsonResponse
+     * @throws FireflyException
+     */
+    public function store(CurrencyRequest $request)
+    {
+        $currency = $this->repository->store($request->getAll());
+
+        if ($request->boolean('default') === true) {
+            Preferences::set('currencyPreference', $currency->code);
+            Preferences::mark();
+        }
+        if (null !== $currency) {
+            $manager = new Manager();
+            $baseUrl = $request->getSchemeAndHttpHost() . '/api/v1';
+            $manager->setSerializer(new JsonApiSerializer($baseUrl));
+            $defaultCurrency = app('amount')->getDefaultCurrencyByUser(auth()->user());
+            $this->parameters->set('defaultCurrency', $defaultCurrency);
+
+            $resource = new Item($currency, new CurrencyTransformer($this->parameters), 'currencies');
+
+            return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');
+        }
+        throw new FireflyException('Could not store new currency.');
+
+    }
+
+
+    /**
+     * @param BillRequest         $request
+     * @param TransactionCurrency $currency
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function update(CurrencyRequest $request, TransactionCurrency $currency)
+    {
+        $data     = $request->getAll();
+        $currency = $this->repository->update($currency, $data);
+
+        if ($request->boolean('default') === true) {
+            Preferences::set('currencyPreference', $currency->code);
+            Preferences::mark();
+        }
+
+        $manager  = new Manager();
+        $baseUrl  = $request->getSchemeAndHttpHost() . '/api/v1';
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        $defaultCurrency = app('amount')->getDefaultCurrencyByUser(auth()->user());
+        $this->parameters->set('defaultCurrency', $defaultCurrency);
+
+        $resource = new Item($currency, new CurrencyTransformer($this->parameters), 'currencies');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', 'application/vnd.api+json');
+
+    }
+}