openinfra/openstackid-resources
Code Issues Proposed changes

Added endpoint Add Ticket Type

Browse Source 
POST /api/v1/summits/{id}/ticket-types

Payload

* name (required|string)
* external_id (required|string|max:255)
* description (sometimes|string)

Change-Id: Ia97b29fc8979aeb7a2f7d451b157c65193b6286b
This commit is contained in:
Sebastian Marcet 2018-03-23 12:56:39 -03:00
parent 9a360b00b1
commit b62eb94d12
11 changed files with 324 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
app/Http/Controllers/Apis/Protected/Summit/Factories/SummitTicketTypeValidationRulesFactory.php Normal file
View File

@ -0,0 +1,42 @@
<?php namespace App\Http\Controllers;
/**
* 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.
**/
/**
* Class SummitTicketTypeValidationRulesFactory
* @package App\Http\Controllers
*/
final class SummitTicketTypeValidationRulesFactory
{
/**
* @param array $data
* @return array
*/
public static function build(array $data, $update = false){
if($update){
return [
'name' => 'sometimes|string',
'description' => 'sometimes|string',
'external_id' => 'sometimes|string|max:255',
];
}
return [
'name' => 'required|string',
'description' => 'sometimes|string',
'external_id' => 'required|string|max:255',
];
}
}

46
app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitsTicketTypesApiController.php
View File

@ -259,4 +259,50 @@ final class OAuth2SummitsTicketTypesApiController extends OAuth2ProtectedControl
}
}
public function addTicketTypeBySummit($summit_id){
try {
if(!Request::isJson()) return $this->error400();
$data = Input::json();
$payload = $data->all();
$summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->resource_server_context)->find($summit_id);
if (is_null($summit)) return $this->error404();
$rules = SummitTicketTypeValidationRulesFactory::build($payload);
// Creates a Validator instance and validates the data.
$validation = Validator::make($payload, $rules);
if ($validation->fails()) {
$messages = $validation->messages()->toArray();
return $this->error412
(
$messages
);
}
$ticket_type = $this->ticket_type_service->addTicketType($summit, $payload);
return $this->created(SerializerRegistry::getInstance()->getSerializer($ticket_type)->serialize());
}
catch (ValidationException $ex1) {
Log::warning($ex1);
return $this->error412([$ex1->getMessage()]);
}
catch(EntityNotFoundException $ex2)
{
Log::warning($ex2);
return $this->error404(['message'=> $ex2->getMessage()]);
}
catch (Exception $ex) {
Log::error($ex);
return $this->error500($ex);
}
}
public function seedDefaultTicketTypesBySummit($summit_id){
}
}

2
app/Http/routes.php
View File

@ -425,6 +425,8 @@ Route::group([
Route::group(['prefix' => 'ticket-types'], function () {
Route::get('', 'OAuth2SummitsTicketTypesApiController@getAllBySummit');
Route::get('csv', 'OAuth2SummitsTicketTypesApiController@getAllBySummitCSV');
Route::post('seed-defaults', [ 'middleware' => 'auth.user:administrators|summit-front-end-administrators', 'uses' => 'OAuth2SummitsTicketTypesApiController@seedDefaultTicketTypesBySummit']);
Route::post('', [ 'middleware' => 'auth.user:administrators|summit-front-end-administrators', 'uses' => 'OAuth2SummitsTicketTypesApiController@addTicketTypeBySummit']);
});
// external orders

47
app/Models/Foundation/Summit/Factories/SummitTicketTypeFactory.php Normal file
View File

@ -0,0 +1,47 @@
<?php namespace App\Models\Foundation\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\SummitTicketType;
/**
* Class SummitTicketTypeFactory
* @package App\Models\Foundation\Summit\Factories
*/
final class SummitTicketTypeFactory
{
/**
* @param array $data
* @return SummitTicketTypeFactory
*/
public static function build(array $data){
return self::populate(new SummitTicketType, $data);
}
/**
* @param SummitTicketType $ticket_type
* @param array $data
* @return SummitTicketType
*/
public static function populate(SummitTicketType $ticket_type, array $data){
if(isset($data['name']))
$ticket_type->setName(trim($data['name']));
if(isset($data['description']))
$ticket_type->setDescription(trim($data['description']));
if(isset($data['external_id']))
$ticket_type->setExternalId(trim($data['external_id']));
return $ticket_type;
}
}

46
app/Models/Foundation/Summit/Summit.php
View File

@ -1677,6 +1677,52 @@ SQL;
return $this;
}
/**
* @param SummitTicketType $ticket_type
* @return $this
*/
public function addTicketType(SummitTicketType $ticket_type)
{
$this->ticket_types->add($ticket_type);
$ticket_type->setSummit($this);
return $this;
}
/**
* @param SummitTicketType $ticket_type
* @return $this
*/
public function removeTicketType(SummitTicketType $ticket_type)
{
$this->ticket_types->remove($ticket_type);
$ticket_type->clearSummit($this);
return $this;
}
/**
* @param string $name
* @return SummitTicketType|null
*/
public function getTicketTypeByName($name){
$criteria = Criteria::create();
$criteria->where(Criteria::expr()->eq('name', trim($name)));
$res = $this->ticket_types->matching($criteria)->first();
return $res === false ? null : $res;
}
/**
* @param int $id
* @return SummitTicketType|null
*/
public function getTicketTypeById($id){
$criteria = Criteria::create();
$criteria->where(Criteria::expr()->eq('id', intval($id)));
$res = $this->ticket_types->matching($criteria)->first();
return $res === false ? null : $res;
}
/**
* @param int $rsvp_template_id
* @return RSVPTemplate|null

2
app/Security/SummitScopes.php
View File

@ -46,4 +46,6 @@ final class SummitScopes
const WriteLocationBannersData = '%s/locations/banners/write';
const WriteSummitSpeakerAssistanceData = '%s/summit-speaker-assistance/write';
const WriteTicketTypeData = '%s/ticket-types/write';
}

18
app/Services/Model/ISummitTicketTypeService.php
View File

@ -11,8 +11,22 @@
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
use models\summit\Summit;
use models\summit\SummitTicketType;
/**
* Interface ISummitTicketTypeService
* @package App\Services\Model
*/
interface ISummitTicketTypeService
{
/**
* @param Summit $summit
* @param array $data
* @return SummitTicketType
* @throws EntityNotFoundException
* @throws ValidationException
*/
public function addTicketType(Summit $summit, array $data);
}

76
app/Services/Model/SummitTicketTypeService.php
View File

@ -11,7 +11,13 @@
* See the License for the specific language governing permissions and
* limitations under the License.
**/
use App\Models\Foundation\Summit\Factories\SummitTicketTypeFactory;
use libs\utils\ITransactionService;
use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
use models\summit\ISummitTicketTypeRepository;
use models\summit\Summit;
use models\summit\SummitTicketType;
/**
* Class SummitTicketTypeService
* @package App\Services\Model
@ -21,4 +27,72 @@ final class SummitTicketTypeService
implements ISummitTicketTypeService
{
/**
* @var ISummitTicketTypeRepository
*/
private $repository;
/**
* SummitTicketTypeService constructor.
* @param ISummitTicketTypeRepository $repository
* @param ITransactionService $tx_service
*/
public function __construct
(
ISummitTicketTypeRepository $repository,
ITransactionService $tx_service
)
{
parent::__construct($tx_service);
$this->repository = $repository;
}
/**
* @param Summit $summit
* @param array $data
* @return SummitTicketType
* @throws EntityNotFoundException
* @throws ValidationException
*/
public function addTicketType(Summit $summit, array $data)
{
return $this->tx_service->transaction(function() use ($summit, $data){
$former_ticket_type = $summit->getTicketTypeByName(trim($data['name']));
if(!is_null($former_ticket_type)){
throw new ValidationException
(
trans
(
'validation_errors.SummitTicketTypeService.addTicketType.NameAlreadyExists'
),
[
'name' => trim($data['name']),
'summit_id' => $summit->getId()
]
);
}
$former_ticket_type = $summit->getTicketTypeByExternalId(trim($data['external_id']));
if(!is_null($former_ticket_type)){
throw new ValidationException
(
trans
(
'validation_errors.SummitTicketTypeService.addTicketType.ExternalIdAlreadyExists'
),
[
'external_id' => trim($data['external_id']),
'summit_id' => $summit->getId()
]
);
}
$ticket_type = SummitTicketTypeFactory::build($data);
$summit->addTicketType($ticket_type);
return $ticket_type;
});
}
}

9
database/seeds/ApiEndpointsSeeder.php
View File

@ -1123,6 +1123,15 @@ class ApiEndpointsSeeder extends Seeder
sprintf(SummitScopes::ReadAllSummitData, $current_realm)
],
],
[
'name' => 'add-ticket-type',
'route' => '/api/v1/summits/{id}/ticket-types',
'http_method' => 'POST',
'scopes' => [
sprintf(SummitScopes::WriteTicketTypeData, $current_realm),
sprintf(SummitScopes::WriteSummitData, $current_realm)
],
],
// track groups
array(
'name' => 'get-track-groups',

2
resources/lang/en/validation_errors.php
View File

@ -55,4 +55,6 @@ return [
'RSVPTemplateService.addQuestion.QuestionNameAlreadyExists' => 'question name :name already exists for template :template_id',
'RSVPTemplateService.updateQuestion.QuestionNameAlreadyExists' => 'question name :name already exists for template :template_id',
'RSVPTemplateService.addQuestionValue.ValueAlreadyExist' => 'value :value already exists on question :question_id',
'SummitTicketTypeService.addTicketType.NameAlreadyExists' => 'ticket name :name already exists on summit :summit_id',
'SummitTicketTypeService.addTicketType.ExternalIdAlreadyExists' => 'ticket external id :external_id already exists on summit :summit_id',
];

37
tests/OAuth2TicketTypesApiTest.php
View File

@ -49,4 +49,41 @@ final class OAuth2TicketTypesApiTest extends ProtectedApiTest
return $ticket_types;
}
public function testAddTicketType($summit_id = 24){
$params = [
'id' => $summit_id,
];
$name = str_random(16).'_ticket_type';
$external_id = str_random(16).'_external_id';
$data = [
'name' => $name,
'external_id' => $external_id,
];
$headers = [
"HTTP_Authorization" => " Bearer " . $this->access_token,
"CONTENT_TYPE" => "application/json"
];
$response = $this->action(
"POST",
"OAuth2SummitsTicketTypesApiController@addTicketTypeBySummit",
$params,
[],
[],
[],
$headers,
json_encode($data)
);
$content = $response->getContent();
$this->assertResponseStatus(201);
$ticket_type = json_decode($content);
$this->assertTrue(!is_null($ticket_type));
$this->assertTrue($ticket_type->name == $name);
$this->assertTrue($ticket_type->external_id == $external_id);
return $ticket_type;
}
}