SLIM app

parent 75f910d7
......@@ -5,5 +5,5 @@
Περιέχονται δείγματα κώδικα και βιβλιοθήκες κατανάλωσης στις εξής παραλλαγές:
* [Εφαρμογή διαδικτύου αναπτυγμένη σε SLIM framwork](./slim-app/)
* [Πρόγραμμα κατανάλωσης από γραμμή εντολών με χρήση βασικών δυνατοτήτων PHP](./command-line-client/)
......@@ -9,6 +9,10 @@
τροποποιήστε αναλόγως. Κατ' ελάχιστο θα πρέπει να συμπληρωθεί το auth token key
που σας έχει αποδοθεί.
**Προσοχή!** Η ρύθμιση `verify_ssl` πρέπει να είναι true σε περιβάλλον
παραγωγής. Εάν έχετε προβλήματα κλήσης της υπηρεσίας θα πρέπει να προβείται
σε κατάλληλες ρυθμίσεις σχετικές με το SSL.
```php
return [
'url' => 'https://amka-services.gunet.gr/api/rest/v1/ssn_validation',
......
/vendor/
/logs/*
!/logs/README.md
Βιβλιοθήκη και διαδικτυακή εφαρμογή SLIM
========================================
# Οδηγίες
Αντιγράψτε το αρχείο `src\settings.php.dist` σε ένα νέο αρχείο `src\settings.php`
και τροποποιήστε αναλόγως. Κατ' ελάχιστο θα πρέπει να συμπληρωθεί το auth token key
που σας έχει αποδοθεί.
**Προσοχή!** Η ρύθμιση `verify_ssl` πρέπει να είναι true σε περιβάλλον
παραγωγής. Εάν έχετε προβλήματα κλήσης της υπηρεσίας θα πρέπει να προβείται
σε κατάλληλες ρυθμίσεις σχετικές με το SSL.
# Εφαρμογή επίδειξης
Η εφαρμογή έχει αναπτυχθεί με το SLIM framework και παρέχει τις παρακάτω
λειτουργίες. Οι σχετικές path parameters αποδίδονται στις μεθόδους.
Όπου χρησιμοποιούνται επιπλέον παράμετροι, μέσω query string ή post
body, αναφέρονται παρακάτω στις σχετικές παραγράφους περιγραφής των
λειτουργιών.
| HTTP Method | Resource routes | Επιστρεφόμενη τιμή | Μέθοδος που καλείται στο [Gr\Gov\Minedu\Osteam\Slim\App](src/osteam/App.php) |
|-------------+-----------------+--------------------+--------------------------------------------------------------------------------|
| GET | amka/{amka}/{surname} | JSON μήνυμα | validateAmka |
| GET | amka/{amka}/{surname}?fields=[comma separated list of field names] | TEXT μήνυμα | validateAmka |
Η εφαρμογή δημιουργήθηκε με σημείο εκκίνησης το Slim Framework 3 Skeleton Application.
Περισσότερες λεπτομέρειες στη [σελίδα του Slim-Skeleton](https://github.com/slimphp/Slim-Skeleton)
Στο φάκελο [src\osteam](src/osteam) βρίσκεται ο κύριος κώδικας της εφαρμογής και στο
αρχείο [src\routes.php](src/routes.php) καθορίζονται τα σχετικά routes.
**Σημαντικό!** Για να τρέξει η εφαρμογή είναι απαραίτητο μετά τη λήψη της
να εκτελέσετε την εντολή `composer install` μέσα στο ριζικό της φάκελο
(\slim-app).
## Gr\Gov\Minedu\Osteam\Slim\App
Η κλάση [Gr\Gov\Minedu\Osteam\Slim\App](src/osteam/App.php) παρέχει μεθόδους
διευκόλυνσης για τον προγραμματιστή ώστε να μπορεί εύκολα να καταναλώσει
λειτουργίες που αφορούν την πρωτοκόλληση εγγράφων. Οι βασικές λειτουργίες
περιγράφηκαν παραπάνω.
**Τεκμηρίωση παρέχεται εντός του [Gr\Gov\Minedu\Osteam\Slim\App](src/osteam/App.php)**
## Gr\Gov\Minedu\Osteam\Client
Η κλάση [Gr\Gov\Minedu\Osteam\Slim\Client](src/osteam/Client.php) καταναλώνει
λειτουργίες του
[open.gunet.gr/apis/amka-services/](http://open.gunet.gr/apis/amka-services/)
αξιοποιώντας τη βιβλιοθήκη CURL. Παρέχει μεθόδους αφαίρεσης για κατανάλωση των
λειτουργιών που αφορούν την πρωτοκόλληση εγγράφων καθώς και βασικές μεθόδους
κλήσης GET, PUT, POST. Οι βασικές λειτουργίες είναι:
* _put($uri, $payload, $headers = [])_
* _post($uri, $payload, $headers = [])_
* _get($uri, $params = [], $headers = [])_
# Λειτουργίες
> Στα παρακάτω δείγματα κλήσης θεωρείται ότι η εφαρμογή είναι διαθέσιμη στη διεύθυνση: http://generic.local.dev/public/
## Ανάκτηση πληροφοριών ΑΜΚΑ
- `http://generic.local.dev/public/amka/12097301234/ΠΑΠΑΔΑΚΗΣ`
Δείγμα απάντησης
```json
{
"match": "true",
"ssn": "12097301234"
}```
Εκτός από τις path parameters μπορεί να δοθεί και η παράμετρος fields στο query string:
- `fields` (προεραιτικό) Λίστα ετικετών, χωρισμένη με κόμμα, των τιμών που ζητούνται. _Λεπτομέρειες δεν παρέχονται_
Δείγμα κλήσης
- `http://generic.local.dev/public/amka/12097301234/ΠΑΠΑΔΑΚΗΣ?fields=ssn`
Δείγμα απάντησης
```
12097301234
```
- `http://generic.local.dev/public/amka/12097301234/ΠΑΠΑΔΑΚΗΣ?fields=ssn,match`
Δείγμα απάντησης
```
12097301234,true
```
## Άλλες πιθανές απαντήσεις της εφαρμογής
Σε περίπτωση που γίνει κλήση σε μη διαθέσιμο resource η εφαρμογή απαντά με
σχετικό μήνυμα.
Δείγμα απάντησης σε κλήση με λανθασμένο AMKA
```json
{
"message": "Προέκυψε λάθος",
"in": "Αποτυχημένη κλήση. HTTP STATUS 400. Η απάντηση ήταν: {\"error\":\"invalid ssn\"}"
}
```
Δείγμα απάντησης στο `http://generic.local.dev/public/%CE%B1%CF%85%CF%84%CF%8C%20%CE%B4%CE%B5%CE%BD%20%CF%85%CF%80%CE%AC%CF%81%CF%87%CE%B5%CE%B9`
```json
{
"message": "Δεν αναγνωρίστηκε το αίτημα σας",
"in": "array (\n 'anythingelse' => 'αυτό δεν υπάρχει',\n)"
}
```
{
"name": "minedu-osteam/amka-api-slim-app",
"description": "A Slim Framework application for consuming the GUNET amka api",
"keywords": ["rest", "minedu"],
"homepage": "https://git.minedu.gov.gr/spapad/samples",
"license": "EUPL",
"authors": [
{
"name": "MINEDU OPEN SOURCE TEAM",
"email": "osteam@minedu.gov.gr",
"homepage": "http://ostmgmt.minedu.gov.gr/"
},
{
"name": "Stavros Papadakis",
"email": "spapad@gmail.com"
}
],
"require": {
"php": ">=5.5.0",
"slim/slim": "^3.1",
"slim/php-view": "^2.0",
"monolog/monolog": "^1.17"
},
"require-dev": {
"phpunit/phpunit": ">=4.8 < 6.0"
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
}
},
"scripts": {
"start": "php -S 0.0.0.0:8080 -t public public/index.php",
"test": "phpunit"
}
}
This diff is collapsed.
Your Slim Framework application's log files will be written to this directory.
<phpunit bootstrap="vendor/autoload.php">
<testsuites>
<testsuite name="SampleApp">
<directory>tests</directory>
</testsuite>
</testsuites>
</phpunit>
\ No newline at end of file
RewriteEngine On
# Some hosts may require you to use the `RewriteBase` directive.
# If you need to use the `RewriteBase` directive, it should be the
# absolute physical path to the directory that contains this htaccess file.
#
# RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [QSA,L]
<?php
if (PHP_SAPI == 'cli-server') {
// To help the built-in PHP dev server, check if the request was actually for
// something which should probably be served as a static file
$url = parse_url($_SERVER['REQUEST_URI']);
$file = __DIR__ . $url['path'];
if (is_file($file)) {
return false;
}
}
$autoloader = require __DIR__ . '/../vendor/autoload.php';
session_name('MineduOsteamApp');
session_start();
date_default_timezone_set('Europe/Athens');
// Instantiate the app
$settings = require __DIR__ . '/../src/settings.php';
$app = new \Slim\App($settings);
$container = $app->getContainer();
// Set up dependencies
require __DIR__ . '/../src/dependencies.php';
// Register middleware
require __DIR__ . '/../src/middleware.php';
//
// setup the app
//
$container['autoloader'] = $autoloader;
$autoloader->addPsr4('Gr\Gov\Minedu\Osteam\Slim\\', __DIR__ . '/../src/osteam');
$container['errorHandler'] = function ($c) {
return function ($request, $response, $exception) use ($c) {
return $c['response']->withJson([
'message' => 'Προέκυψε λάθος',
'in' => $exception->getMessage()
], intval($code = $exception->getCode()) > 0 ? $code : null
);
};
};
//
// end setup the app
//
// Register routes
require __DIR__ . '/../src/routes.php';
// Run app
$app->run();
<?php
// DIC configuration
$container = $app->getContainer();
// view renderer
$container['renderer'] = function ($c) {
$settings = $c->get('settings')['renderer'];
return new Slim\Views\PhpRenderer($settings['template_path']);
};
// monolog
$container['logger'] = function ($c) {
$settings = $c->get('settings')['logger'];
$logger = new Monolog\Logger($settings['name']);
$logger->pushProcessor(new Monolog\Processor\UidProcessor());
$logger->pushHandler(new Monolog\Handler\StreamHandler($settings['path'], $settings['level']));
return $logger;
};
<?php
// Application middleware
// e.g: $app->add(new \Slim\Csrf\Guard);
<?php
namespace Gr\Gov\Minedu\Osteam\Slim;
use Interop\Container\ContainerInterface;
use Slim\Http\Body;
use Gr\Gov\Minedu\Osteam\Slim\Client;
/**
* Description of app
*
* @author spapad
*/
class App
{
protected $ci = null;
protected $client = null;
protected $logger = null;
private $url = '';
private $key = '';
private $headers = [];
public function __construct(ContainerInterface $ci)
{
$this->ci = $ci;
$settings = $this->ci->get('settings')['amka'];
$this->key = (isset($settings['key']) ? $settings['key'] : '');
$this->url = (isset($settings['url']) ? $settings['url'] : 'https://amka-services.gunet.gr/api/rest/v1/ssn_validation');
if (isset($settings['extra_headers']) && is_array($extra_headers = $settings['extra_headers'])) {
$this->headers = array_reduce(array_keys($extra_headers), function ($h, $key) use ($extra_headers) {
array_push($h, "{$key}: {$extra_headers[$key]}");
return $h;
}, []);
}
$this->client = new Client([
'NO_SAFE_CURL' => (isset($settings['verify_ssl']) ? $settings['verify_ssl'] === false : false),
'base_uri' => $this->url
]);
if (($logger = $this->ci->get('logger')) != null) {
$this->logger = $logger;
}
}
/**
* Send a JSON formatted string as JSON response to the client.
*
* @param Response $res
* @param mixed $data The data
* @param int $status The HTTP status code.
* @return response
*/
public function withJsonReady($res, $data, $status = null)
{
$response = $res->withBody(new Body(fopen('php://temp', 'r+')));
$response->getBody()->write($data);
$jsonResponse = $response->withHeader('Content-Type', 'application/json;charset=utf-8');
if (isset($status)) {
return $jsonResponse->withStatus($status);
}
return $jsonResponse;
}
/**
* Send a text response string as text/plain response to the client.
*
* @param Response $res
* @param mixed $data The text
* @param int $status The HTTP status code.
* @return response
*/
public function withTextReady($res, $data, $status = null)
{
$response = $res->withBody(new Body(fopen('php://temp', 'r+')));
$response->getBody()->write($data);
$textResponse = $response->withHeader('Content-Type', 'text/plain');
if (isset($status)) {
return $textResponse->withStatus($status);
}
return $textResponse;
}
protected function log($msg)
{
if ($this->logger) {
$this->logger->info($msg);
}
}
/**
* Έλεγχος ΑΜΚΑ.
*
* @param Psr\Http\Message\ServerRequestInterface $req
* @param Psr\Http\Message\ResponseInterface $res
* @param string[] $args Πίνακας με παραμέτρους από το call:
* 'amka' Το ΑΜΚΑ για έλεγχο
* 'surname' Το επίθετο
* Επίσης μπορεί να δοθεί η παράμετρος (query) 'fields'
* με την οποία ο καλών μπορεί να ζητήσει σε μορφή text
* συγκεκριμένα πεδία από το response, εφόσον υπάρχουν
* @throws \Exception
* @return Response
*/
public function validateAmka($req, $res, $args)
{
$amka = $args['amka'];
$surname = $args['surname'];
$bdate = '';
if (preg_match('/^([0-9]{2})([0-9]{2})([0-9]{2})[0-9]*/', $amka, $bdate_parts) === 1) {
$bdate = "{$bdate_parts[3]}-{$bdate_parts[2]}-{$bdate_parts[1]}";
if (intval($bdate_parts[3]) > 40) {
$bdate = "19{$bdate}";
}
}
$data = [
'ssn' => $amka,
'birthdate' => $bdate,
'surname' => $surname,
];
$this->logger->info("validateAmka::{$amka}");
$result = $this->client->get($this->url, $data, array_merge([
"Authorization: Token {$this->key}",
'Content-Type: application/json'
], $this->headers)
);
// request specific fields?
// if so, return string results
// or else respond with json
$fields_requested = $req->getQueryParam('fields', null);
$field_names = [];
if ($fields_requested) {
$field_names = explode(',', $fields_requested);
}
if (count($field_names) > 0) {
$result = json_decode($result, true);
$response_string = array_reduce($field_names, function ($r, $field_name) use ($result) {
if (isset($result["$field_name"])) {
$r = $r . ($r == '' ? '' : ',') . $result["$field_name"];
}
return $r;
}, '');
return $this->withTextReady($res, $response_string);
} else {
return $this->withJsonReady($res, $result);
}
}
public function setDebug($debug = true)
{
$this->client->setDebug($debug === true);
return;
}
}
<?php
/*
*
*/
namespace Gr\Gov\Minedu\Osteam\Slim;
use Exception;
/**
* Description of Client
*
* @author spapad
*/
class Client
{
private $_debug = false;
private $_settings = [
'base_uri' => '' // must set this
];
public function __construct($settings = [])
{
$this->_settings = array_merge($this->_settings, $settings);
}
protected function setCommonCurlOptions($ch, $uri, $headers)
{
curl_setopt($ch, CURLOPT_URL, $uri);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_USERAGENT, "OSTEAM SLIM client");
if (isset($this->_settings['NO_SAFE_CURL']) && $this->_settings['NO_SAFE_CURL'] === true) {
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
}
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_MAXREDIRS, 3);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
if ($this->_debug === true) {
curl_setopt($ch, CURLOPT_VERBOSE, true);
}
}
public function put($uri, $payload, $headers = [])
{
$ch = curl_init();
$this->setCommonCurlOptions($ch, $uri, $headers);
// curl_setopt($ch, CURLOPT_PUT, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
if (curl_errno($ch)) {
throw new Exception("Λάθος κατά την κλήση του {$uri}. Curl error: " . curl_error($ch) . " Curl info: " . var_export(curl_getinfo($ch), true));
}
if (intval(($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) / 100) != 2) {
// πραγματοποιήθηκε κλήση αλλά δεν ήταν "επιτυχής"
throw new Exception("Αποτυχημένη κλήση. HTTP STATUS {$http_code}. Η απάντηση ήταν: {$result}", $http_code);
}
curl_close($ch);
return $result;
}
public function post($uri, $payload, $headers = [])
{
$ch = curl_init();
$this->setCommonCurlOptions($ch, $uri, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
if (curl_errno($ch)) {
throw new Exception("Λάθος κατά την κλήση του {$uri}. Curl error: " . curl_error($ch) . " Curl info: " . var_export(curl_getinfo($ch), true));
}
if (intval(($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) / 100) != 2) {
// πραγματοποιήθηκε κλήση αλλά δεν ήταν "επιτυχής"
throw new Exception("Αποτυχημένη κλήση. HTTP STATUS {$http_code}. Η απάντηση ήταν: {$result}", $http_code);
}
curl_close($ch);
return $result;
}
public function get($uri, $params = [], $headers = [])
{
$ch = curl_init();
if (is_array($params) && count($params) > 0) {
$qs = '?' . http_build_query($params);
} else {
$qs = '';
}
$this->setCommonCurlOptions($ch, "{$uri}{$qs}", $headers);
// curl_setopt($ch, CURLOPT_HTTPGET, true); // default
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
if (curl_errno($ch)) {
throw new Exception("Λάθος κατά την κλήση του {$uri}. Curl error: " . curl_error($ch) . " Curl info: " . var_export(curl_getinfo($ch), true));
}
if (intval(($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) / 100) != 2) {
// πραγματοποιήθηκε κλήση αλλά δεν ήταν "επιτυχής"
throw new Exception("Αποτυχημένη κλήση. HTTP STATUS {$http_code}. Η απάντηση ήταν: {$result}", $http_code);
}
curl_close($ch);
return $result;
}
public function setDebug($debug = true)
{
$this->_debug = ($debug === true);
return;
}
}
<?php
$app->get('/amka/{amka}/{surname}', '\Gr\Gov\Minedu\Osteam\Slim\App:validateAmka');
$app->any('/[{anythingelse}]', function ($request, $response, $args) {
$this->logger->info("Void response, no action route was enabled");
return $response->withJson([
'message' => 'Δεν αναγνωρίστηκε το αίτημα σας',
'in' => var_export($args, true)
], 404
);
});
<?php
return [
'settings' => [
'displayErrorDetails' => true, // set to false in production
'addContentLengthHeader' => false, // Allow the web server to send the content-length header
// Renderer settings
'renderer' => [
'template_path' => __DIR__ . '/../templates/',
],
// Monolog settings
'logger' => [
'name' => 'slim-app',
'path' => __DIR__ . '/../logs/app.log',
'level' => \Monolog\Logger::DEBUG,
],
//
// app custom settings
'amka' => [
'url' => 'https://amka-services.gunet.gr/api/rest/v1/ssn_validation',
'key' => 'place-your-auth-key-here',
'extra_headers' => [
// any custom headers as 'key' => 'value'
],
'verify_ssl' => false // only if ssl is not tuned correctly!
]
],
];
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>Slim 3</title>
<link href='//fonts.googleapis.com/css?family=Lato:300' rel='stylesheet' type='text/css'>
<style>
body {
margin: 50px 0 0 0;
padding: 0;
width: 100%;
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
text-align: center;
color: #aaa;
font-size: 18px;
}
h1 {
color: #719e40;
letter-spacing: -3px;
font-family: 'Lato', sans-serif;
font-size: 100px;
font-weight: 200;
margin-bottom: 0;
}
</style>
</head>
<body>
<h1>Slim</h1>
<div>a microframework for PHP</div>
<?php if (isset($name)) : ?>
<h2>Hello <?= htmlspecialchars($name); ?>!</h2>
<?php else: ?>
<p>Try <a href="http://www.slimframework.com">SlimFramework</a></p>
<?php endif; ?>
</body>
</html>
<?php
namespace Tests\Functional;
use Slim\App;
use Slim\Http\Request;
use Slim\Http\Response;
use Slim\Http\Environment;
/**
* This is an example class that shows how you could set up a method that
* runs the application. Note that it doesn't cover all use-cases and is
* tuned to the specifics of this skeleton app, so if your needs are
* different, you'll need to change it.
*/
class BaseTestCase extends \PHPUnit_Framework_TestCase
{
/**
* Use middleware when running application?
*
* @var bool
*/
protected $withMiddleware = true;
/**
* Process the application given a request method and URI
*
* @param string $requestMethod the request method (e.g. GET, POST, etc.)
* @param string $requestUri the request URI
* @param array|object|null $requestData the request data
* @return \Slim\Http\Response
*/
public function runApp($requestMethod, $requestUri, $requestData = null)
{
// Create a mock environment for testing with
$environment = Environment::mock(
[
'REQUEST_METHOD' => $requestMethod,
'REQUEST_URI' => $requestUri
]
);
// Set up a request object based on the environment
$request = Request::createFromEnvironment($environment);
// Add request data, if it exists
if (isset($requestData)) {
$request = $request->withParsedBody($requestData);
}
// Set up a response object
$response = new Response();
// Use the application settings
$settings = require __DIR__ . '/../../src/settings.php';
// Instantiate the application
$app = new App($settings);
// Set up dependencies
require __DIR__ . '/../../src/dependencies.php';
// Register middleware
if ($this->withMiddleware) {
require __DIR__ . '/../../src/middleware.php';
}
// Register routes
require __DIR__ . '/../../src/routes.php';
// Process the application
$response = $app->process($request, $response);
// Return the response
return $response;