From 127bec77241f34de8bc929993ea8c356c9cebafb Mon Sep 17 00:00:00 2001
From: Laurent Laffont <llaffont@afi-sa.fr>
Date: Mon, 14 May 2018 17:16:01 +0200
Subject: [PATCH] add API for user holds and cancel
---
.../api/controllers/UserController.php | 36 ++++--
.../api/views/scripts/user/holds.pjson | 3 +
library/ZendAfi/View/Helper/Api/Holds.php | 51 +++++++++
.../MobileApplication/UserAccountTest.php | 105 +++++++++++++++++-
4 files changed, 185 insertions(+), 10 deletions(-)
create mode 100644 application/modules/api/views/scripts/user/holds.pjson
create mode 100644 library/ZendAfi/View/Helper/Api/Holds.php
diff --git a/application/modules/api/controllers/UserController.php b/application/modules/api/controllers/UserController.php
index 25c879b606a..7688562b97a 100644
--- a/application/modules/api/controllers/UserController.php
+++ b/application/modules/api/controllers/UserController.php
@@ -39,29 +39,49 @@ class Api_UserController extends ZendAfi_Controller_Action {
public function loansAction() {
- $this->view->loans = (new Class_User_Cards(Class_Users::getIdentity()))->getLoans();
+ $this->view->loans = $this->_userCards()->getLoans();
+ }
+
+
+ public function holdsAction() {
+ $this->view->holds = $this->_userCards()->getHolds();
}
public function renewLoanAction() {
- $user = Class_Users::getIdentity();
- $cards = new Class_User_Cards($user);
+ $cards = $this->_userCards();
$loan_id = $this->_getParam('id');
$status = $cards->renewLoan($loan_id);
+ if ($status['statut'] == false)
+ return $this->_helper->json(['status' => 'error',
+ 'error' => $status['erreur']]);
+
$loan = $cards->getLoans()
->detect(function($loan) use ($loan_id)
{
return $loan->getId() == $loan_id;
});
- if ($status['statut'] == true)
- return $this->_helper->json(['status' => 'renewed',
- 'date_due' => $loan->getDateRetourISO8601()]);
+ return $this->_helper->json(['status' => 'renewed',
+ 'date_due' => $loan->getDateRetourISO8601()]);
+ }
+
+
+ public function cancelHoldAction() {
+ $status = $this->_userCards()
+ ->cancelHold($this->_getParam('id'));
+
+ return ($status['statut'] == false)
+ ? $this->_helper->json(['status' => 'error',
+ 'error' => $status['erreur']])
+ : $this->_helper->json(['status' => 'canceled']);
+ }
+
- return $this->_helper->json(['status' => 'error',
- 'error' => $status['erreur']]);
+ protected function _userCards() {
+ return new Class_User_Cards(Class_Users::getIdentity());
}
diff --git a/application/modules/api/views/scripts/user/holds.pjson b/application/modules/api/views/scripts/user/holds.pjson
new file mode 100644
index 00000000000..87732946fb1
--- /dev/null
+++ b/application/modules/api/views/scripts/user/holds.pjson
@@ -0,0 +1,3 @@
+{
+ "holds": <?php echo $this->holds($this->holds) ?>
+}
diff --git a/library/ZendAfi/View/Helper/Api/Holds.php b/library/ZendAfi/View/Helper/Api/Holds.php
new file mode 100644
index 00000000000..ddafc3d948c
--- /dev/null
+++ b/library/ZendAfi/View/Helper/Api/Holds.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright (c) 2012-2014, Agence Française Informatique (AFI). All rights reserved.
+ *
+ * BOKEH is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
+ * the Free Software Foundation.
+ *
+ * There are special exceptions to the terms and conditions of the AGPL as it
+ * is applied to this software (see README file).
+ *
+ * BOKEH 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 AFFERO GENERAL PUBLIC LICENSE for more details.
+ *
+ * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * along with BOKEH; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+
+class ZendAfi_View_Helper_Api_Holds extends Zend_View_Helper_Abstract {
+ public function holds($holds) {
+ return json_encode(
+ $holds->collect([$this, 'holdToArray'])
+ ->getArrayCopy()
+ );
+ }
+
+
+ public function holdToArray($hold) {
+ $datas = [
+ 'id' => $hold->getId(),
+ 'title' => $hold->getTitre(),
+ 'author' => $hold->getAuteur(),
+ 'status' => $hold->getEtat(),
+ 'held_by' => $hold->getUserFullName(),
+ 'library' => $hold->getBibliotheque() ];
+
+ if (!$record = $hold->getNoticeOPAC())
+ return $datas;
+
+ $datas['record'] = ['id' => $record->getId()];
+ if ($record->hasVignette())
+ $datas['record']['thumbnail'] = $record->getUrlVignette();
+
+ return $datas;
+ }
+}
+?>
\ No newline at end of file
diff --git a/tests/scenarios/MobileApplication/UserAccountTest.php b/tests/scenarios/MobileApplication/UserAccountTest.php
index ad044e47a6a..935ef9517a3 100644
--- a/tests/scenarios/MobileApplication/UserAccountTest.php
+++ b/tests/scenarios/MobileApplication/UserAccountTest.php
@@ -63,9 +63,23 @@ abstract class Scenario_MobileApplication_UserAccountTestCase extends AbstractCo
->setDateRetour(date('d/m/Y', strtotime('tomorrow')))
->getExemplaire()->setTitre('Alice');
+
+ $afrodeezia = new Class_WebService_SIGB_Reservation('18', new Class_WebService_SIGB_Exemplaire(938));
+ $afrodeezia
+ ->setBibliotheque('Annecy')
+ ->setEtat('En attente')
+ ->getExemplaire()
+ ->setNoticeOPAC($this->fixture('Class_Notice',
+ ['id' => 83,
+ 'url_vignette' => 'http://img.com/marcus.jpg',
+ 'titre_principal' => 'Afrodeezia',
+ 'auteur_principal' => 'Marcus Miller' ]));
+
$puppy
- ->setFicheSigb(['fiche' => (new Class_WebService_SIGB_Emprunteur(345, 'puppy'))
- ->empruntsAddAll([$this->_potter, $alice])])
+ ->setFicheSigb(['fiche' =>
+ (new Class_WebService_SIGB_Emprunteur(345, 'puppy'))
+ ->empruntsAddAll([$this->_potter, $alice])
+ ->reservationsAddAll([$afrodeezia])])
->assertSave();
ZendAfi_Auth::getInstance()->clearIdentity();
@@ -148,6 +162,7 @@ class Scenario_MobileApplication_UserAccountRenewTest extends Scenario_MobileApp
}
+ /** @test */
public function resultShouldAnswerErrorOnSIGBError() {
$this->_sigb->whenCalled('prolongerPret')
->answers(['statut' => false,
@@ -460,4 +475,90 @@ class Scenario_MobileApplication_UserAccountWithTokenTest extends Scenario_Mobil
$this->_json['account']);
}
}
+
+
+
+class Scenario_MobileApplication_UserAccountHoldsWithTokenTest extends Scenario_MobileApplication_UserAccountTestCase {
+ protected
+ $_json;
+
+ public function setUp() {
+ parent::setUp();
+
+ $this->dispatch('/api/user/holds',
+ true,
+ ["Authorization" => "Bearer nonos" ,
+ "Content-Type" => "application/json"]);
+
+ $this->_json = json_decode($this->_response->getBody(), true);
+ }
+
+
+ /** @test */
+ public function responseShouldContainsAfrodeeziaHold() {
+ $this->assertEquals(['id' => '345_18',
+ 'title' => 'Afrodeezia',
+ 'author' => 'Marcus Miller',
+ 'status' => 'En attente',
+ 'held_by' => 'puppy',
+ 'library' => 'Annecy',
+ 'record' => [ 'id' => '83',
+ 'thumbnail' => 'http://img.com/marcus.jpg' ]
+ ],
+ $this->_json['holds'][0]);
+ }
+
+}
+
+
+
+
+class Scenario_MobileApplication_UserAccountCancelHoldTest extends Scenario_MobileApplication_UserAccountTestCase {
+ /** @test */
+ public function resultShouldAnswerSuccess() {
+ $this->_sigb->whenCalled('supprimerReservation')
+ ->answers(['statut' => true,
+ 'erreur' => '']);
+
+ $this->dispatch('/api/user/cancel-hold/id/345_18',
+ true,
+ ["Authorization" => "Bearer nonos" ,
+ "Content-Type" => "application/json"]);
+
+ $this->assertEquals(['status' => 'canceled'],
+ json_decode($this->_response->getBody(), true));
+ }
+
+
+ /** @test */
+ public function resultShouldAnswerErrorOnSIGBError() {
+ $this->_sigb->whenCalled('supprimerReservation')
+ ->answers(['statut' => false,
+ 'erreur' => 'could not cancel']);
+
+ $this->dispatch('/api/user/cancel-hold/id/345_18',
+ true,
+ ["Authorization" => "Bearer nonos" ,
+ "Content-Type" => "application/json"]);
+
+ $this->assertEquals(['status' => 'error',
+ 'error' => 'could not cancel'],
+ json_decode($this->_response->getBody(), true));
+ }
+
+
+ /** @test */
+ public function resultShouldAnswerErrorOnHoldNotFound() {
+ $this->dispatch('/api/user/cancel-hold/id/666_18',
+ true,
+ ["Authorization" => "Bearer nonos" ,
+ "Content-Type" => "application/json"]);
+
+ $this->assertEquals(['status' => 'error',
+ 'error' => 'Réservation introuvable'],
+ json_decode($this->_response->getBody(), true));
+ }
+
+}
+
?>
\ No newline at end of file
--
GitLab