Alex Savenko / analytics

Commit 64ff922406aa9c10cddb3b790ba904059c562850

Authored by Alex Savenko
2 parents da19e117 8baf4948

Merge branch 'restart' of gitlab.artweb.com.ua:Alex/analytics into restart

Showing 2 changed files with 81 additions and 29 deletions   Show diff stats
Inline Side-by-side
app/library/App/Controllers/AllPositionController.php
  Show/Hide comments   View file @64ff922
... ... @@ -18,6 +18,11 @@ class AllPositionController extends CrudResourceController
18 18 {
19 19 const API_KEY = '150bb253651622507341cd7845f5b9d2';
20 20  
  21 + /**
  22 + * Данные о проекте
  23 + *
  24 + * @return array [url, cy, pr, yaca, dmoz, yahoo]
  25 + */
21 26 public function projectAction() {
22 27  
23 28 /** user params **/
... ... @@ -31,6 +36,11 @@ class AllPositionController extends CrudResourceController
31 36  
32 37 }
33 38  
  39 + /**
  40 + * Список проектов пользователя
  41 + *
  42 + * @return array[] [id_project, id_group, url, cy, pr]
  43 + */
34 44 public function projectsAction() {
35 45  
36 46 /** user params **/
... ... @@ -44,6 +54,11 @@ class AllPositionController extends CrudResourceController
44 54  
45 55 }
46 56  
  57 + /**
  58 + * Список групп проектов
  59 + *
  60 + * @return array[] [id_group, group]
  61 + */
47 62 public function projectsGroupAction() {
48 63  
49 64 $APObj = new Client(self::API_KEY);
... ... @@ -54,6 +69,11 @@ class AllPositionController extends CrudResourceController
54 69  
55 70 }
56 71  
  72 + /**
  73 + * Список запросов, по которым определяется позиция сайта
  74 + *
  75 + * @return array[] [id_query, id_group, query, freq, url]
  76 + */
57 77 public function queriesAction() {
58 78  
59 79 /** user params **/
... ... @@ -68,6 +88,11 @@ class AllPositionController extends CrudResourceController
68 88  
69 89 }
70 90  
  91 + /**
  92 + * Список групп запросов
  93 + *
  94 + * @return array[] [id_group, group]
  95 + */
71 96 public function queriesGroupAction() {
72 97  
73 98 /** user params **/
... ... @@ -81,6 +106,16 @@ class AllPositionController extends CrudResourceController
81 106  
82 107 }
83 108  
  109 + /**
  110 + * Отчет по позициям сайта
  111 + *
  112 + * @return array [
  113 + * count, top3, top10, top30, down, up, date, prev_date,
  114 + * sengines[id_se, name_se, name_region][],
  115 + * queries[id_query, query, wordstat][],
  116 + * positions[position, prev_position, change_position, url][]
  117 + * ]
  118 + */
84 119 public function reportAction() {
85 120  
86 121 /** user params **/
... ... @@ -96,6 +131,11 @@ class AllPositionController extends CrudResourceController
96 131  
97 132 }
98 133  
  134 + /**
  135 + * Данные о видимости сайта за указанный период
  136 + *
  137 + * @return array [id_project, begin_date, end_date, id_se]
  138 + */
99 139 public function visibilityAction() {
100 140  
101 141 /** user params **/
... ... @@ -112,6 +152,11 @@ class AllPositionController extends CrudResourceController
112 152  
113 153 }
114 154  
  155 + /**
  156 + * Список дат, когда обновлялись позиции сайта
  157 + *
  158 + * @return array
  159 + */
115 160 public function reportDatesAction() {
116 161  
117 162 /** user params **/
... ...
app/library/App/Resources/UserResource.php
  Show/Hide comments   View file @64ff922
... ... @@ -22,27 +22,26 @@ class UserResource extends ApiResource {
22 22 ->itemKey('user')
23 23 ->collectionKey('users')
24 24 ->deny(AclRoles::UNAUTHORIZED, AclRoles::USER)
25   - ->handler(UserController::class);
  25 + ->handler(UserController::class)
26 26  
27   - $this
28   - ->endpoint(ApiEndpoint::all()
29   - ->allow(AclRoles::USER)
30   - ->name('all')
31   - ->description('Возвращает всех зарегистрированных пользователей')
32   - );
  27 + /** -------------------- [GET] users -------------------------------- **/
  28 + ->endpoint(ApiEndpoint::all()
  29 + ->allow(AclRoles::USER)
  30 + ->name('all')
  31 + ->description('Возвращает всех зарегистрированных пользователей')
  32 + )
  33 + /** ----------------------------------------------------------------- **/
33 34  
34   - $this
35   - ->endpoint(ApiEndpoint::remove()
36   - ->name('remove')
37   - ->description('Удаление пользователя')
  35 + /** -------------------- [GET] users/me ----------------------------- **/
  36 + ->endpoint(ApiEndpoint::factory('/me', HttpMethods::GET, 'meAction')
  37 + ->name('me')
  38 + ->description('Возвращает текущего залогиненного пользователя')
38 39 ->allow(AclRoles::USER)
39   - ->exampleResponse([
40   - "result" => "OK"
41   - ])
42 40 )
43   - ;
44   - $this
45   - ->endpoint(ApiEndpoint::update()
  41 + /** ----------------------------------------------------------------- **/
  42 +
  43 + /** -------------------- [PUT] users/{id} -------------------------- **/
  44 + ->endpoint(ApiEndpoint::update()
46 45 ->name('update')
47 46 ->description('Изменение данных пользователя')
48 47 ->allow(AclRoles::ADMINISTRATOR)
... ... @@ -62,17 +61,21 @@ class UserResource extends ApiResource {
62 61 ]
63 62 ])
64 63 )
65   - ;
  64 + /** ----------------------------------------------------------------- **/
66 65  
67   - $this
68   - ->endpoint(ApiEndpoint::factory('/me', HttpMethods::GET, 'meAction')
69   - ->name('me')
70   - ->description('Возвращает текущего залогиненного пользователя')
  66 + /** -------------------- [DELETE] users/{id} ------------------------ **/
  67 + ->endpoint(ApiEndpoint::remove()
  68 + ->name('remove')
  69 + ->description('Удаление пользователя')
71 70 ->allow(AclRoles::USER)
72   - );
  71 + ->exampleResponse([
  72 + "result" => "OK"
  73 + ])
  74 + )
  75 + /** ----------------------------------------------------------------- **/
73 76  
74   - $this
75   - ->endpoint(ApiEndpoint::factory('/authenticate', HttpMethods::POST, 'authenticateAction')
  77 + /** -------------------- [POST] users/authenticate ------------------ **/
  78 + ->endpoint(ApiEndpoint::factory('/authenticate', HttpMethods::POST, 'authenticateAction')
76 79 ->name('authenticate')
77 80 ->description('Авторизация пользователя через BasicAuth и возвращает токен доступа')
78 81 ->allow(AclRoles::UNAUTHORIZED)
... ... @@ -93,9 +96,11 @@ class UserResource extends ApiResource {
93 96 ]
94 97  
95 98 ])
96   - );
97   - $this
98   - ->endpoint(ApiEndpoint::factory('/', HttpMethods::POST, 'registerAction')
  99 + )
  100 + /** ----------------------------------------------------------------- **/
  101 +
  102 + /** -------------------- [POST] users -------------------------------- **/
  103 + ->endpoint(ApiEndpoint::factory('/', HttpMethods::POST, 'registerAction')
99 104 ->name('register')
100 105 ->description('Регистрация нового пользователя')
101 106 ->allow(AclRoles::UNAUTHORIZED)
... ... @@ -111,6 +116,8 @@ class UserResource extends ApiResource {
111 116 "updatedAt" => "2017-02-16 17:57:52"
112 117 ]
113 118 ])
114   - );
  119 + )
  120 + /** ----------------------------------------------------------------- **/
  121 + ;
115 122 }
116 123 }
117 124 \ No newline at end of file
... ...