openinfra/openstackid-resources
Code Issues Proposed changes

Endpoint add attendee ticket

Browse Source 
POST /api/v1/summits/{id}/attendees/{attendee_id}/tickets

Payload

{
  ticket_type_id: 1234
  external_order_id: "1234",
  external_attendee_id: "1234"
}

Change-Id: Icfbf9cc07b4261829c74f5fe493025e785850300
This commit is contained in:
Sebastian Marcet 2018-01-18 23:22:34 -03:00
parent ea822c5d4f
commit d292a9478d
16 changed files with 373 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitAttendeesApiController.php
View File

@ -563,4 +563,56 @@ final class OAuth2SummitAttendeesApiController extends OAuth2ProtectedController
}
}
/**
* @param $summit_id
* @param $attendee_id
* @return mixed
*/
public function addAttendeeTicket($summit_id, $attendee_id){
try {
if(!Request::isJson()) return $this->error403();
$data = Input::json();
$summit = SummitFinderStrategyFactory::build($this->repository, $this->resource_server_context)->find($summit_id);
if (is_null($summit)) return $this->error404();
$attendee = $this->attendee_repository->getById($attendee_id);
if(is_null($attendee)) return $this->error404();
$rules = [
'ticket_type_id' => 'required|integer',
'external_order_id' => 'required|string',
'external_attendee_id' => 'required|string',
];
// Creates a Validator instance and validates the data.
$validation = Validator::make($data->all(), $rules);
if ($validation->fails()) {
$messages = $validation->messages()->toArray();
return $this->error412
(
$messages
);
}
$ticket = $this->attendee_service->addAttendeeTicket($attendee, $data->all());
return $this->created(SerializerRegistry::getInstance()->getSerializer($ticket)->serialize());
}
catch (ValidationException $ex1) {
Log::warning($ex1);
return $this->error412(array($ex1->getMessage()));
}
catch(EntityNotFoundException $ex2)
{
Log::warning($ex2);
return $this->error404(array('message'=> $ex2->getMessage()));
}
catch (Exception $ex) {
Log::error($ex);
return $this->error500($ex);
}
}
}

4
app/Http/routes.php
View File

@ -172,6 +172,10 @@ Route::group([
Route::put('/check-in', 'OAuth2SummitAttendeesApiController@checkingAttendeeOnEvent')->where('attendee_id', 'me|[0-9]+');
});
});
Route::group(array('prefix' => 'tickets'), function ()
{
Route::post('', [ 'middleware' => 'auth.user:administrators|summit-front-end-administrators', 'uses' => 'OAuth2SummitAttendeesApiController@addAttendeeTicket']);
});
});
});

16
app/ModelSerializers/Summit/SummitAttendeeTicketSerializer.php
View File

@ -1,6 +1,4 @@
<?php namespace ModelSerializers;
use models\summit\SummitAttendeeTicket;
/**
* Copyright 2018 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
@ -13,6 +11,11 @@ use models\summit\SummitAttendeeTicket;
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\summit\SummitAttendeeTicket;
/**
* Class SummitAttendeeTicketSerializer
* @package ModelSerializers
*/
final class SummitAttendeeTicketSerializer extends SilverStripeSerializer
{
protected static $array_mappings = [
@ -20,6 +23,7 @@ final class SummitAttendeeTicketSerializer extends SilverStripeSerializer
'ExternalAttendeeId' => 'external_attendee_id:json_string',
'BoughtDate' => 'bought_date:datetime_epoch',
'TicketTypeId' => 'ticket_type_id:json_int',
'OwnerId' => 'owner_id:json_int',
];
/**
@ -39,11 +43,19 @@ final class SummitAttendeeTicketSerializer extends SilverStripeSerializer
foreach ($exp_expand as $relation) {
switch (trim($relation)) {
case 'ticket_type': {
if(!$ticket->hasTicketType()) continue;
unset($values['ticket_type_id']);
$values['ticket_type'] = SerializerRegistry::getInstance()->getSerializer($ticket->getTicketType())->serialize();
}
break;
case 'owner_id': {
if(!$ticket->hasOwner()) continue;
unset($values['owner_id']);
$values['owner'] = SerializerRegistry::getInstance()->getSerializer($ticket->getOwner())->serialize();
}
break;
}
}
}

23
app/Models/Foundation/Summit/Attendees/SummitAttendeeTicket.php
View File

@ -136,7 +136,7 @@ class SummitAttendeeTicket extends SilverstripeBaseModel
*/
public function getTicketTypeId(){
try{
return $this->ticket_type->getId();
return is_null($this->ticket_type) ? 0 : $this->ticket_type->getId();
}
catch(\Exception $ex){
return 0;
@ -173,4 +173,25 @@ class SummitAttendeeTicket extends SilverstripeBaseModel
{
$this->owner = $owner;
}
/**
* @return int
*/
public function getOwnerId(){
try{
return is_null($this->owner) ? 0 : $this->owner->getId();
}
catch(\Exception $ex){
return 0;
}
}
/**
* @return bool
*/
public function hasOwner(){
return $this->getOwnerId() > 0;
}
}

42
app/Models/Foundation/Summit/Factories/SummitAttendeeTicketFactory.php Normal file
View File

@ -0,0 +1,42 @@
<?php namespace models\summit\factories;
/**
* Copyright 2018 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\summit\SummitAttendee;
use models\summit\SummitAttendeeTicket;
use models\summit\SummitTicketType;
/**
* Class SummitAttendeeTicketFactory
* @package models\summit\factories
*/
final class SummitAttendeeTicketFactory
{
/**
* @param SummitAttendee $attendee
* @param SummitTicketType $type
* @param array $data
* @return SummitAttendeeTicket
*/
public static function build(SummitAttendee $attendee, SummitTicketType $type, array $data){
$ticket = new SummitAttendeeTicket();
$attendee->addTicket($ticket);
if(isset($data['external_order_id']))
$ticket->setExternalOrderId($data['external_order_id']);
if(isset($data['external_attendee_id']))
$ticket->setExternalAttendeeId($data['external_attendee_id']);
$ticket->setTicketType($type);
return $ticket;
}
}

8
app/Models/Foundation/Summit/Repositories/ISummitRepository.php
View File

@ -1,7 +1,4 @@
<?php namespace models\summit;
use models\utils\IBaseRepository;
/**
* Copyright 2015 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
@ -14,6 +11,11 @@ use models\utils\IBaseRepository;
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\utils\IBaseRepository;
/**
* Interface ISummitRepository
* @package models\summit
*/
interface ISummitRepository extends IBaseRepository
{
/**

22
app/Models/Foundation/Summit/Repositories/ISummitTicketTypeRepository.php Normal file
View File

@ -0,0 +1,22 @@
<?php namespace models\summit;
/**
* Copyright 2018 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\utils\IBaseRepository;
/**
* Interface ISummitTicketTypeRepository
* @package models\summit
*/
interface ISummitTicketTypeRepository extends IBaseRepository
{
}

4
app/Models/Foundation/Summit/SummitTicketType.php
View File

@ -11,13 +11,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use Doctrine\ORM\Mapping AS ORM;
use models\utils\SilverstripeBaseModel;
use Doctrine\Common\Collections\ArrayCollection;
/**
* @ORM\Entity
* @ORM\Entity(repositoryClass="App\Repositories\Summit\DoctrineSummitTicketTypeRepository")
* @ORM\Table(name="SummitTicketType")
* Class SummitTicketType
* @package models\summit

8
app/Repositories/RepositoriesProvider.php
View File

@ -19,8 +19,11 @@ use models\main\Company;
use models\main\EmailCreationRequest;
use models\main\File;
use models\main\Group;
use models\summit\ISummitTicketTypeRepository;
use models\summit\SpeakerRegistrationRequest;
use models\summit\SpeakerSummitRegistrationPromoCode;
use models\summit\SummitTicketType;
/**
* Class RepositoriesProvider
* @package repositories
@ -231,5 +234,10 @@ final class RepositoriesProvider extends ServiceProvider
return EntityManager::getRepository(EmailCreationRequest::class);
});
App::singleton(
ISummitTicketTypeRepository::class,
function(){
return EntityManager::getRepository(SummitTicketType::class);
});
}
}

12
app/Repositories/Summit/DoctrineSummitAttendeeTicketRepository.php
View File

@ -14,6 +14,7 @@
use models\summit\ISummitAttendeeTicketRepository;
use models\summit\SummitAttendeeTicket;
use App\Repositories\SilverStripeDoctrineRepository;
use models\utils\IEntity;
/**
* Class DoctrineSummitAttendeeTicketRepository
@ -51,4 +52,15 @@ final class DoctrineSummitAttendeeTicketRepository
{
return SummitAttendeeTicket::class;
}
/**
* @param IEntity $entity
* @return void
*/
public function delete($entity)
{
$this->_em->getConnection()->delete("
SummitAttendeeTicket
", ["ID" => $entity->getIdentifier()]);
}
}

3
app/Repositories/Summit/DoctrineSummitRepository.php
View File

@ -1,5 +1,4 @@
<?php namespace App\Repositories\Summit;
/**
* Copyright 2016 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
@ -12,11 +11,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\summit\ISummitRepository;
use models\summit\Summit;
use App\Repositories\SilverStripeDoctrineRepository;
/**
* Class DoctrineSummitRepository
* @package App\Repositories\Summit

32
app/Repositories/Summit/DoctrineSummitTicketTypeRepository.php Normal file
View File

@ -0,0 +1,32 @@
<?php namespace App\Repositories\Summit;
/**
* Copyright 2018 OpenStack Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use App\Repositories\SilverStripeDoctrineRepository;
use models\summit\ISummitTicketTypeRepository;
use models\summit\SummitTicketType;
/**
* Class DoctrineSummitTicketTypeRepository
* @package App\Repositories\Summit
*/
final class DoctrineSummitTicketTypeRepository
extends SilverStripeDoctrineRepository
implements ISummitTicketTypeRepository
{
/**
* @return string
*/
protected function getBaseEntity()
{
return SummitTicketType::class;
}
}

103
app/Services/Model/AttendeeService.php
View File

@ -11,14 +11,21 @@
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use GuzzleHttp\Exception\ClientException;
use libs\utils\ITransactionService;
use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
use models\main\IMemberRepository;
use models\summit\factories\SummitAttendeeFactory;
use models\summit\factories\SummitAttendeeTicketFactory;
use models\summit\ISummitAttendeeRepository;
use models\summit\ISummitAttendeeTicketRepository;
use models\summit\ISummitTicketTypeRepository;
use models\summit\Summit;
use models\summit\SummitAttendee;
use models\summit\SummitAttendeeTicket;
use services\apis\IEventbriteAPI;
/**
* Class AttendeeService
* @package App\Services\Model
@ -36,20 +43,42 @@ final class AttendeeService implements IAttendeeService
*/
private $member_repository;
/**
* @var ISummitTicketTypeRepository
*/
private $ticket_type_repository;
/**
* @var ISummitAttendeeTicketRepository
*/
private $ticket_repository;
/**
* @var ITransactionService
*/
private $tx_service;
/**
* @var IEventbriteAPI
*/
private $eventbrite_api;
public function __construct
(
ISummitAttendeeRepository $attendee_repository,
IMemberRepository $member_repository,
ISummitAttendeeTicketRepository $ticket_repository,
ISummitTicketTypeRepository $ticket_type_repository,
IEventbriteAPI $eventbrite_api,
ITransactionService $tx_service
)
{
$this->attendee_repository = $attendee_repository;
$this->ticket_repository = $ticket_repository;
$this->member_repository = $member_repository;
$this->ticket_type_repository = $ticket_type_repository;
$this->eventbrite_api = $eventbrite_api;
$this->tx_service = $tx_service;
}
@ -139,4 +168,78 @@ final class AttendeeService implements IAttendeeService
});
}
/**
* @param SummitAttendee $attendee
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return SummitAttendeeTicket
*/
public function addAttendeeTicket(SummitAttendee $attendee, array $data){
return $this->tx_service->transaction(function() use($attendee, $data){
if(!isset($data['ticket_type_id']))
throw new ValidationException("ticket_type_id is mandatory!");
$type = $this->ticket_type_repository->getById(intval($data['ticket_type_id']));
if(is_null($type))
throw new EntityNotFoundException(sprintf("ticket type %s not found!", $data['ticket_type_id']));
$old_ticket = $this->ticket_repository->getByExternalOrderIdAndExternalAttendeeId
(
$data['external_order_id'],
$data['external_attendee_id']
);
if(!is_null($old_ticket)) {
if ($old_ticket->hasOwner())
throw new ValidationException
(
sprintf
(
"external_order_id %s - external_attendee_id %s already assigned to attendee id %s",
$data['external_order_id'],
$data['external_attendee_id'],
$old_ticket->getOwner()->getId()
)
);
$this->ticket_repository->delete($old_ticket);
}
// validate with external api ...
try {
$external_order = $this->eventbrite_api->getOrder($data['external_order_id']);
$external_attendee_found = false;
$summit_external_id = $external_order['event_id'];
if (intval($attendee->getSummit()->getSummitExternalId()) !== intval($summit_external_id))
throw new ValidationException('order %s does not belongs to current summit!', $external_order_id);
foreach ($external_order['attendees'] as $external_attendee){
if($data['external_attendee_id'] == $external_attendee['id']){
$external_attendee_found = true;
break;
}
}
if(!$external_attendee_found){
throw new ValidationException
(
sprintf("external_attendee_id %s does not belongs to external_order_id %s", $data['external_attendee_id'], $data['external_order_id'])
);
}
}
catch (ClientException $ex1) {
if ($ex1->getCode() === 400)
throw new EntityNotFoundException('external order does not exists!');
if ($ex1->getCode() === 403)
throw new EntityNotFoundException('external order does not exists!');
throw $ex1;
}
return SummitAttendeeTicketFactory::build($attendee, $type, $data);
});
}
}

10
app/Services/Model/IAttendeeService.php
View File

@ -15,6 +15,7 @@ use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
use models\summit\Summit;
use models\summit\SummitAttendee;
use models\summit\SummitAttendeeTicket;
/**
* Interface IAttendeeService
* @package App\Services\Model
@ -48,4 +49,13 @@ interface IAttendeeService
* @throws EntityNotFoundException
*/
public function updateAttendee(Summit $summit, $attendee_id, array $data);
/**
* @param SummitAttendee $attendee
* @param array $data
* @throws ValidationException
* @throws EntityNotFoundException
* @return SummitAttendeeTicket
*/
public function addAttendeeTicket(SummitAttendee $attendee, array $data);
}

8
database/seeds/ApiEndpointsSeeder.php
View File

@ -180,6 +180,14 @@ class ApiEndpointsSeeder extends Seeder
sprintf(SummitScopes::WriteAttendeesData, $current_realm),
],
),
array(
'name' => 'add-attendee-ticket',
'route' => '/api/v1/summits/{id}/attendees/{attendee_id}/tickets',
'http_method' => 'POST',
'scopes' => [
sprintf(SummitScopes::WriteAttendeesData, $current_realm),
],
),
// speakers
array(
'name' => 'get-speakers',

35
tests/OAuth2AttendeesApiTest.php
View File

@ -232,4 +232,39 @@ class OAuth2AttendeesApiTest extends ProtectedApiTest
$this->assertTrue(!is_null($attendee));
return $attendee;
}
public function testAddAttendeeTicket(){
$params = [
'id' => 23,
'attendee_id' => 12642
];
$data = [
'ticket_type_id' => 50,
'external_order_id' => '617372932',
'external_attendee_id' => '774078887',
];
$headers = [
"HTTP_Authorization" => " Bearer " . $this->access_token,
"CONTENT_TYPE" => "application/json"
];
$response = $this->action(
"POST",
"OAuth2SummitAttendeesApiController@addAttendeeTicket",
$params,
[],
[],
[],
$headers,
json_encode($data)
);
$content = $response->getContent();
$this->assertResponseStatus(201);
$ticket = json_decode($content);
$this->assertTrue(!is_null($ticket));
return $ticket;
}
}