Blame view

app/library/App/Resources/AllPositionResource.php 14.4 KB
b660745b   Alex Savenko   git bug
1
2
3
4
5
6
7
8
9
10
11
  <?php
  /**
   * Created by PhpStorm.
   * User: Alex Savenko
   * Date: 22.02.2017
   * Time: 20:29
   */
  
  namespace App\Resources;
  
  
056ab121   Alex Savenko   ga fix
12
  use App\Constants\AclRoles;
b660745b   Alex Savenko   git bug
13
  use App\Controllers\AllPositionController;
e83a94b3   Alex Savenko   docs + ap
14
  use PhalconApi\Constants\HttpMethods;
056ab121   Alex Savenko   ga fix
15
  use PhalconRest\Api\ApiEndpoint;
b660745b   Alex Savenko   git bug
16
17
18
19
20
21
22
23
24
25
  use PhalconRest\Api\ApiResource;
  
  class AllPositionResource extends ApiResource
  {
  
      public function initialize() {
  
          $this
              ->name('All Position')
              ->expectsJsonData()
b660745b   Alex Savenko   git bug
26
27
28
29
30
              ->itemKey('ap')
              ->collectionKey('ap')
              ->deny(AclRoles::UNAUTHORIZED)
              ->handler(AllPositionController::class)
  
5824f1c9   Alex Savenko   add get_report_da...
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
              /** -------------------- [GET] project ------------------------------ **/
                  ->endpoint(
                      ApiEndpoint::factory('/project', HttpMethods::GET, 'projectAction')
                          ->name('project')
                          ->description('Данные о проекте')
                          ->paramsDescription([
                              'required params' => [
                                  'project' => "integer(ID проекта)"
                              ]
                          ])
                          ->exampleResponse([
                              "url"       => "rukzachok.com.ua(URL проекта)",
                              "cy"        => "60(тИЦ)",
                              "pr"        => "0(Google PageRank)",
                              "yaca"      => "0(Наличие сайта в Яндекс каталоге)",
                              "dmoz"      => "0(Наличие сайта в DMOZ)",
                              "yahoo"     => "0(Наличие сайта в Yahoo)",
                              "name"      => "rukzachok.com.ua",
                              "interval"  => 0
                          ])
                          ->allow(AclRoles::USER)
                  )
              /** ----------------------------------------------------------------- **/
37701e29   Alex Savenko   ap testing
54
  
5824f1c9   Alex Savenko   add get_report_da...
55
56
              /** -------------------- [GET] projects ----------------------------- **/
                  ->endpoint(
e83a94b3   Alex Savenko   docs + ap
57
                  ApiEndpoint::factory('/projects', HttpMethods::GET, 'projectsAction')
34cfbfc0   Alex Savenko   allposition docs
58
59
                      ->name('projects')
                      ->description('Список проектов пользователя')
ec2de8a1   Alex Savenko   docs
60
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
                          'required params' => [],
                          'optional params' => [
                              'id_group' => "integer(ID проекта)"
                          ]
                      ])
                      ->exampleResponse([
                          [
                              "id_project"    => "{id}(ID проекта)",
                              "id_group"      => "11111(ID группы проектов)",
                              "url"           => "8nebo.com(URL проекта)",
                              "cy"            => "20(тИЦ)",
                              "pr"            => "0(Google PageRank)",
                              "name"          => "8nebo.com",
                              "interval"      => 7,
                              "sleep"         => 1
                          ],
                          [
                              "id_project"    => "{id}(ID проекта)",
                              "id_group"      => "11111(ID группы проектов)",
                              "url"           => "a-v-z.com.ua(URL проекта)",
                              "cy"            => "10(тИЦ)",
                              "pr"            => "0(Google PageRank)",
                              "name"          => "",
                              "interval"      => 0,
                              "sleep"         => 0
                          ]
                      ])
                      ->allow(AclRoles::USER)
37701e29   Alex Savenko   ap testing
89
              )
5824f1c9   Alex Savenko   add get_report_da...
90
              /** ------------------------------------------------------------------**/
37701e29   Alex Savenko   ap testing
91
  
5824f1c9   Alex Savenko   add get_report_da...
92
93
              /** -------------------- [GET] projects_group ----------------------- **/
                  ->endpoint(
e83a94b3   Alex Savenko   docs + ap
94
                  ApiEndpoint::factory('/projects_group', HttpMethods::GET, 'projectsGroupAction')
34cfbfc0   Alex Savenko   allposition docs
95
96
                      ->name('projects group')
                      ->description('Список групп проектов')
ec2de8a1   Alex Savenko   docs
97
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
98
99
100
101
102
103
104
105
106
107
108
109
110
                          'required params' => []
                      ])
                      ->exampleResponse([
                          [
                              "id_group"  => "{id}(ID группы проектов)",
                              "group"     => "bkko.com.ua(Название группы)"
                          ],
                          [
                              "id_group"  => "{id}(ID группы проектов)",
                              "group"     => "Dveri(Название группы)"
                          ]
                      ])
                      ->allow(AclRoles::USER)
37701e29   Alex Savenko   ap testing
111
              )
5824f1c9   Alex Savenko   add get_report_da...
112
              /** ----------------------------------------------------------------- **/
37701e29   Alex Savenko   ap testing
113
  
5824f1c9   Alex Savenko   add get_report_da...
114
115
              /** -------------------- [GET] queries ------------------------------ **/
                  ->endpoint(
e83a94b3   Alex Savenko   docs + ap
116
                  ApiEndpoint::factory('/queries', HttpMethods::GET, 'queriesAction')
34cfbfc0   Alex Savenko   allposition docs
117
118
                      ->name('queries')
                      ->description('Список запросов, по которым определяется позиция сайта')
ec2de8a1   Alex Savenko   docs
119
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
                          'required params' => [
                              'project'   => 'integer(ID проекта)'
                          ],
                          'optional params' => [
                              'id_group' => 'integer(ID группы запросов)'
                          ]
                      ])
                      ->exampleResponse([
                          [
                              "id_query"  => "{id}(ID запроса)",
                              "id_group"  => "{id}(ID группы запросов)",
                              "query"     => "=рюкзаки переноски для детей(Запрос)",
                              "freq"      => "50(Частота запроса)",
                              "url"       => "(URL целевой страницы)"
                          ],
                          [
                              "id_query"  => "{id}(ID запроса)",
                              "id_group"  => "{id}(ID группы запросов)",
                              "query"     => "dakine кошелек(Запрос)",
                              "freq"      => "10(Частота запроса)",
                              "url"       => "(URL целевой страницы)"
                          ]
                      ])
                      ->allow(AclRoles::USER)
f0d4c855   Alex Savenko   ap testing
144
              )
5824f1c9   Alex Savenko   add get_report_da...
145
              /** ----------------------------------------------------------------- **/
f0d4c855   Alex Savenko   ap testing
146
  
5824f1c9   Alex Savenko   add get_report_da...
147
148
              /** -------------------- [GET] queries_group ------------------------ **/
                  ->endpoint(
e83a94b3   Alex Savenko   docs + ap
149
150
151
                  ApiEndpoint::factory('/queries_group', HttpMethods::GET, 'queriesGroupAction')
                      ->name('queries group')
                      ->description('Список групп запросов')
ec2de8a1   Alex Savenko   docs
152
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
153
154
155
156
157
158
159
160
161
162
163
164
                          'required params' => ['project' => 'integer(ID проекта)']
                      ])
                      ->exampleResponse([
                          [
                              "id_group"  => "{id}(ID группы запросов)",
                              "group"     => "head рюкзак(Название группы)"
                          ],
                          [
                              "id_group"  => "{id}(ID группы запросов)",
                              "group"     => "quiksilver рюкзак(Название группы)"
                          ]
                      ])
e83a94b3   Alex Savenko   docs + ap
165
166
                      ->allow(AclRoles::USER)
              )
5824f1c9   Alex Savenko   add get_report_da...
167
              /** ----------------------------------------------------------------- **/
e83a94b3   Alex Savenko   docs + ap
168
  
5824f1c9   Alex Savenko   add get_report_da...
169
170
              /** -------------------- [GET] report ------------------------------- **/
                  ->endpoint(
e83a94b3   Alex Savenko   docs + ap
171
                  ApiEndpoint::factory('/report', HttpMethods::GET, 'reportAction')
34cfbfc0   Alex Savenko   allposition docs
172
173
                      ->name('report')
                      ->description('Отчет по позициям сайта')
ec2de8a1   Alex Savenko   docs
174
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
                          'required params' => [
                              'project'   => 'integer(ID проекта)'
                          ],
                          'optional params' => [
                              'date'      => 'date(дата отчета в формате Y-m-d (например, 2010-12-31))',
                              'prev_date' => 'date(дата для сравнения позиции сайта в формате Y-m-d (например, 2010-12-30))'
                          ]
                      ])
                      ->exampleResponse([
                          "count"     => "526(Количество запросов)",
                          "top3"      => "50(Запросов в ТОП 3)",
                          "top10"     => "113(Запросов в ТОП 3)",
                          "top30"     => "275(Запросов в ТОП 3)",
                          "down"      => "230(Позиций улучшилось)",
                          "up"        => "205(Позиций улучшилось)",
                          "sengines"  => [
                              [
                                  "id_se"         => "{id}(ID поисковой системы)",
                                  "name_se"       => "Google(название поисковой системы)",
                                  "name_region"   => "com.ua/Киев(название региона)"
                              ],
                              [
                                  "id_se"         => "{id}(ID поисковой системы)",
                                  "name_se"       => "Google(название поисковой системы)",
                                  "name_region"   => "com.ua(название региона)"
                              ]
                          ],
                          "queries" => [
                              [
                                  "id_query"      => "{id}(ID запроса)",
                                  "query"         => "=рюкзаки переноски для детей(запрос)",
                                  "wordstat"      => "50(частота запроса)"
                              ],
                              [
                                  "id_query"      => "{id}(ID запроса)",
                                  "query"         => "dakine кошелек(запрос)",
                                  "wordstat"      => "10(частота запроса)"
                              ]
                          ],
                          "positions" => [
                              [
                                  "position "         => "{id}(ID запроса)",
                                  "prev_position "    => "=рюкзаки переноски для детей(запрос)",
                                  "change_position"   => "50(частота запроса)",
                                  "url"               => "50(частота запроса)"
                              ],
                              [
                                  "position "         => "(текущая позиция сайта)",
                                  "prev_position "    => "(предыдущая позиция сайта)",
                                  "change_position"   => "(изменение позиции сайта)",
                                  "url"               => "(найденный URL)"
                              ]
                          ]
                      ])
                      ->allow(AclRoles::USER)
e83a94b3   Alex Savenko   docs + ap
230
              )
5824f1c9   Alex Savenko   add get_report_da...
231
              /** ----------------------------------------------------------------- **/
e83a94b3   Alex Savenko   docs + ap
232
  
5824f1c9   Alex Savenko   add get_report_da...
233
234
              /** -------------------- [GET] visibility --------------------------- **/
                  ->endpoint(
e83a94b3   Alex Savenko   docs + ap
235
                  ApiEndpoint::factory('/visibility', HttpMethods::GET, 'visibilityAction')
34cfbfc0   Alex Savenko   allposition docs
236
237
                      ->name('visibility')
                      ->description('Данные о видимости сайта за указанный период')
ec2de8a1   Alex Savenko   docs
238
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
                          'required params' => [
                              'project'   => 'integer(ID проекта)'
                          ],
                          'optional params' => [
                              'start'     => 'date(начальная дата в формате Y-m-d (например, 2010-12-01))',
                              'end'       => 'date(конечная дата в формате Y-m-d (например, 2010-12-31))',
                              'id_se' => 'integer(ID поисковой системы)'
                          ]
                      ])
                      ->exampleResponse([
                          "2017-02-13"    => "0.2",
                          "2017-02-15"    => "0.2",
                          "2017-02-20"    => "0.3",
                          "2017-02-26"    => "0.3",
                          "2017-03-06"    => "0.3",
                          "2017-03-12"    => "0.2"
                      ])
                      ->allow(AclRoles::USER)
b660745b   Alex Savenko   git bug
257
              )
5824f1c9   Alex Savenko   add get_report_da...
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
              /** ----------------------------------------------------------------- **/
  
              /** -------------------- [GET] visibility --------------------------- **/
              ->endpoint(
                  ApiEndpoint::factory('/report_dates', HttpMethods::GET, 'reportDatesAction')
                      ->name('report dates')
                      ->description('Список дат, когда обновлялись позиции сайта')
                      ->paramsDescription([
                          'required params' => [
                              'project'   => 'integer(ID проекта)'
                          ],
                      ])
                      ->exampleResponse([
                          "2017-02-13"    => "0.2",
                          "2017-02-15"    => "0.2",
                          "2017-02-20"    => "0.3",
                          "2017-02-26"    => "0.3",
                          "2017-03-06"    => "0.3",
                          "2017-03-12"    => "0.2"
                      ])
                      ->allow(AclRoles::USER)
              )
              /** ----------------------------------------------------------------- **/
b660745b   Alex Savenko   git bug
281
282
283
284
285
          ;
  
      }
  
  }