rail-locator-api 1.0.35 → 1.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b615e28535741f010ad218a4f844b1ed47d83e05841d4b87035181959316bbe
-  data.tar.gz: b0970713fd66072b17b29611523620a8a2aa2055987212c19e400a6bbb6cd5eb
+  metadata.gz: d5f9d6ab8b3ee1262f0c465e5514c9c54250629263ddd9844eb7e86f403e95e3
+  data.tar.gz: b2bc9b609f34bf04c4913772a02f995b07c383f62c4b4de470e89d14893885f9
 SHA512:
-  metadata.gz: c609f8abe8f9ab850dfae270eb47c5d9776cf9274239adbdc250a9b153d92905061677c26ab88f6363e02bf7aa17bbc8c57d6f5f3d0260561320ec58695db2ff
-  data.tar.gz: c98d9b3f48a73a2c9ac4f6f51044a245f6391ec9c2fd82064edc95b3be1358dd86178faac77c51c1d369a064e5358af133ed932ff57852aff9ccca2f06742988
+  metadata.gz: b8b81a281da285e95ec1a0e85e6a1f23cb9447428d796b8f8a3e91d4db5eb46da691edc9e1dc336628a551c5b7947225ba992e42f5ba324e03889bf8cef5ca75
+  data.tar.gz: 0fcecbea8647cc12a765999cfef4961df82ac9516b521e1d9af43bf78961374e9f3068ed264a5a758641bf00950de18ea0fe6ceee0826a28f7de23903ff24a91

data/README.markdown

@@ -1,542 +0,0 @@
-# RailLocator API
-
-API wrapper для RailLocator API v2
-
-# Оглавление
-0. [Установка](#install)
-    1. [Использование Rails](#using_rails)
-    2. [Использование Ruby](#using_ruby)
-    3. [Debug Logging](#debug_logging)
-    4. [Custom logger](#custom_logger)
-1. [Треки](#tracks)
-    1. [Получение Списка Треков](#tracks_dislocation_get)
-    2. [Постановка На Слежение](#tracks_dislocation_post)
-    3. [Получение Дислокации По Нескольким Трекам](#tracks_dislocation_batch_get)
-    4. [Получение Информации О Маршруте](#tracks_dislocation_route_info_get)
-    5. [Получение Дислокации По Одному Треку](#tracks_dislocation__track_id__get)
-2. [Справки](#inquiries)
-   1. [Получение Справок](#tracks_inquiries_get)
-   2. [Постановка На Слежение](#tracks_inquiries_get)
-   3. [Получение Справки](#tracks_inquiries__track_id__get)
-3. [Подходы](#approaches)
-   1. [Постановка На Слежение](#tracks_approaches_post)
-4. [Тех. паспорт вагона](#tech_passport)
-   1. [Получение Тех. Паспортов](#tracks_tech_passport_batch_get)
-   2. [Получение Тех. Паспорта](#tracks_tech_passport__track_id__get)
-5. [Контроль тех. состояния](#tech_condition)
-   1. [Получение Тех. Состояния](#tracks_tech_condition_get)
-   2. [Постановка На Слежение](#tracks_tech_condition_post)
-6. [Изменение/Снятие треков](#update_delete_tracks)
-   1. [Снятие Со Слежения Нескольких Треков](#tracks_batch_delete)
-   2. [Изменение Информации О Нескольких Треках](#tracks_batch_patch)
-   3. [Снятие Со Слежения Одного Трека](#tracks__track_id__delete)
-   4. [Изменение Информации О Треке](#tracks__track_id__patch)
-7. [Группы](#groups)
-   1. [Получение Списка Групп](#groups_get)
-   2. [Создание Группы](#groups_post)
-   3. [Удаление Группы](#groups__group_id__delete)
-   4. [Изменение Группы](#groups__group_id__patch)
-   5. [Добавление Вагона В Группу](#groups__group_id__cargo_transport_unit_number_batch_put)
-   6. [Удаление Вагонов Из Группы](#groups__group_id__cargo_transport_unit_number_batch_delete)
-   7. [Добавление Вагона В Группу](#groups__group_id__cargo_transport_unit_number__cargo_transport_unit_number__put)
-   8. [Удаление Вагона Из Группы](#groups__group_id__cargo_transport_unit_number__cargo_transport_unit_number__delete)
-8. [Справочники](#references)
-   1. [Получение Координат Станции](#references_station_get)
-   2. [Получение Списка Станций С Краткой Информацией](#references_stations_get)
-9. [Рассылки](#emailings)
-   1. [Создание Рассылки](#emailings_post)
-
-# <a name="install"></a> Установка
-
-Для авторизации по api key необходимо получить его [в личном кабинете локатора](https://rail-scan.com/app/api-keys)
-или в телеграм боте [@RailLocatorApiBot](https://t.me/RailLocatorApiBot)
-
-либо использовать другие методы авторизации:
-
-`:keycloak, :api_key, :base64`
-
-## Ruby
-    $ gem install rail-locator-api
-## Rails
-добавьте в Gemfile:
-
-    gem 'rail-locator-api'
-
-и запустите `bundle install`.
-
-Затем:
-
-    rails g rail_locator_api:install
-
-## <a name="using_rails"></a> Использование Rails
-
-В файл `config/rail_locator_api.yml` вставьте ваши данные
-
-## <a name="using_ruby"></a> Использование Ruby
-
-Сначала создайте экземпляр объекта `RailLocatorApi::Request`:
-
-```ruby
-locator = RailLocatorApi::Request.new(api_key: "***")
-# или
-locator = RailLocatorApi::Request.new(api_auth_method: :base64, api_user_email: "email@ctm.ru", api_user_password: "12345678")
-```
-
-Вы можете изменять `api_auth_method`, `api_key`, `api_user_email`, `api_user_password`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
-
-```ruby
-RailLocatorApi::Request.timeout = 15
-RailLocatorApi::Request.open_timeout = 15
-RailLocatorApi::Request.symbolize_keys = true
-RailLocatorApi::Request.debug = false
-
-RailLocatorApi::Request.api_key = "your_api_key"
-# или
-RailLocatorApi::Request.api_auth_method = :base64
-RailLocatorApi::Request.api_user_email = "email@ctm.ru"
-RailLocatorApi::Request.api_user_password = "12345678"
-```
-
-Либо в файле `config/initializers/rail_locator_api.rb` для Rails.
-
-## <a name="debug_logging"></a> Debug Logging
-
-Измените `debug: true` чтобы включить логирование в STDOUT.
-
-```ruby
-locator = RailLocatorApi::Request.new(api_key: "***", debug: true)
-```
-
-### <a name="custom_logger"></a> Custom logger
-
-`Logger.new` используется по умолчанию, но вы можете изменить на свой:
-
-```ruby
-locator = RailLocatorApi::Request.new(api_key: "***", debug: true, logger: MyLogger.new)
-```
-
-Или:
-
-```ruby
-RailLocatorApi::Request.logger = MyLogger.new
-```
-
-# <a name="examples"></a> Примеры
-## <a name="tracks"></a> Дислокация
-### <a name="tracks_dislocation_get"></a> [Получение Списка Треков](https://rail-scan.com/api/v2.0/redoc#tag/Dislokaciya/operation/________________________tracks_dislocation_get)
-```ruby
-request = {
-        "limit": 100,
-        "offset": 0,
-        "filters": [
-                {
-                        "field": "is_broken",
-                        "operand": "in",
-                        "value": [
-                                null,
-                                true
-                        ]
-                },
-                {
-                        "field": "track_create_time",
-                        "operand": ">=",
-                        "value": "2010-10-10 00:00"
-                },
-                {
-                        "field": "track_stop_time",
-                        "operand": "between",
-                        "value": [
-                                "2010-10-10 00:00",
-                                "2021-10-10 00:00"
-                        ]
-                }
-        ],
-        "sort": [
-                {
-                        "field": "is_active",
-                        "order": "asc"
-                }
-        ],
-        "fulltext_filter": {
-                "value": "2010",
-                "fields": [
-                        "track_create_time",
-                        "track_stop_time"
-                ],
-                "operation": "include"
-        }
-}
-response = RailLocatorApi::Request.tracks.dislocation.retrieve(body: request)
-p response.body
-```
-
-### <a name="tracks_dislocation_post"></a> [Постановка На Слежение](https://rail-scan.com/api/v2.0/redoc#tag/Dislokaciya/operation/_______________________tracks_dislocation_post)
-
-```ruby
-request = [
-        {
-                "is_validate_vehicle": true,
-                "cargo_transport_unit_number": "ASVD123",
-                "country_code": "01",
-                "tracking_type": 1,
-                "is_cross_country_tracking": true
-        }
-]
-response = RailLocatorApi::Request.tracks.dislocation.create(body: request)
-p response.body
-```
-
-### <a name="tracks_dislocation_batch_get"></a> [Получение Дислокации По Нескольким Трекам](https://rail-scan.com/api/v2.0/redoc#tag/Dislokaciya/operation/__________________________________________tracks_dislocation_batch_get)
-
-```ruby
-request = {
-        "track_ids": [
-                0
-        ],
-        "operations_count": 10
-}
-response = RailLocatorApi::Request.tracks.dislocation.history.retrieve(body: request)
-p response.body
-```
-
-### <a name="tracks_dislocation_route_info_get"></a> [Получение Информации О Маршруте](https://rail-scan.com/api/v2.0/redoc#tag/Dislokaciya/operation/________________________________tracks_dislocation_route_info_get)
-
-```ruby
-track_id = 1
-response = RailLocatorApi::Request.tracks.dislocation(track_id).route.retrieve
-p response.body
-```
-
-### <a name="tracks_dislocation__track_id__get"></a> [Получение Дислокации По Одному Треку](https://rail-scan.com/api/v2.0/redoc#tag/Dislokaciya/operation/_____________________________________tracks_dislocation__track_id__get)
-
-```ruby
-track_id = 1
-response = RailLocatorApi::Request.tracks.dislocation(track_id).history.retrieve
-p response.body
-```
-
-## <a name="inquiries"></a> Справки
-
-### <a name="tracks_inquiries_get"></a> [Получение Справок](https://rail-scan.com/api/v2.0/redoc#tag/Spravki/operation/__________________tracks_inquiries_get)
-```ruby
-request = {
-        "limit": 100,
-        "offset": 0,
-        "filters": [
-                {
-                        "field": "is_broken",
-                        "operand": "in",
-                        "value": [
-                                null,
-                                true
-                        ]
-                },
-                {
-                        "field": "track_start",
-                        "operand": ">=",
-                        "value": "2010-10-10 00:00"
-                },
-                {
-                        "field": "track_stop",
-                        "operand": "between",
-                        "value": [
-                                "2010-10-10 00:00",
-                                "2021-10-10 00:00"
-                        ]
-                }
-        ],
-        "sort": [
-                {
-                        "field": "is_active",
-                        "order": "asc"
-                }
-        ],
-        "fulltext_filter": {
-                "value": "2010",
-                "fields": [
-                        "track_start",
-                        "track_stop"
-                ],
-                "operation": "include"
-        }
-}
-response = RailLocatorApi::Request.tracks.inquiries.retrieve(body: request)
-p response.body
-```
-
-### <a name="tracks_inquiries_post"></a> [Постановка На Слежение](https://rail-scan.com/api/v2.0/redoc#tag/Spravki/operation/_______________________tracks_inquiries_post)
-```ruby
-request = [
-        {
-                "inquiry_type": "2612",
-                "cargo_transport_unit_number": "12345678"
-        }
-]
-response = RailLocatorApi::Request.tracks.inquiries.create(body: request)
-p response.body
-```
-
-### <a name="tracks_inquiries__track_id__get"></a> [Получение Справки](https://rail-scan.com/api/v2.0/redoc#tag/Spravki/operation/__________________tracks_inquiries__track_id__get)
-```ruby
-track_id = 1
-response = RailLocatorApi::Request.tracks.inquiries(track_id).retrieve
-p response.body
-```
-
-## <a name="approaches"></a> Подходы
-### <a name="tracks_approaches_post"></a> [Постановка На Слежение](https://rail-scan.com/api/v2.0/redoc#tag/Podhody/operation/_______________________tracks_approaches_post)
-```ruby
-request = [
-        {
-                "cargo_transport_unit_type": 0,
-                "stop_tracking_condition": 0,
-                "cargo_transport_unit_load_state": 0,
-                "cargo_code": "string",
-                "tracking_type": 0,
-                "destination_station": "string",
-                "which_okpo_to_use": 0,
-                "cargo_sender_okpo": "string",
-                "cargo_receiver_okpo": "string"
-        }
-]
-response = RailLocatorApi::Request.tracks.approaches.create(body: request)
-p response.body
-```
-
-## <a name="tech_passport"></a> Тех. паспорт вагона
-### <a name="tracks_tech_passport_batch_get"></a> [Получение Тех. Паспортов](https://rail-scan.com/api/v2.0/redoc#tag/Teh.-pasport-vagona/operation/_________________________tracks_tech_passport_batch_get)
-```ruby
-request = {
-        "track_ids": [
-                0
-        ],
-        "count": 1
-}
-response = RailLocatorApi::Request.tracks.dislocation.tech_passports.retrieve(body: request)
-p response.body
-```
-### <a name="tracks_tech_passport__track_id__get"></a> [Получение Тех. Паспорта](https://rail-scan.com/api/v2.0/redoc#tag/Teh.-pasport-vagona/operation/_________________________tracks_tech_passport__track_id__get)
-```ruby
-track_id = 1
-response = RailLocatorApi::Request.tracks.dislocation(track_id).tech_passports.retrieve
-p response.body
-```
-
-## <a name="tech_condition"></a> Контроль тех. состояния
-### <a name="tracks_tech_condition_get"></a> [Получение Тех. Состояния](https://rail-scan.com/api/v2.0/redoc#tag/Kontrol-teh.-sostoyaniya/operation/_________________________tracks_tech_condition_get)
-```ruby
-request = {
-        "limit": 100,
-        "offset": 0,
-        "filters": [
-                {
-                        "field": "is_broken",
-                        "operand": "in",
-                        "value": [
-                                null,
-                                true
-                        ]
-                },
-                {
-                        "field": "track_start",
-                        "operand": ">=",
-                        "value": "2010-10-10 00:00"
-                },
-                {
-                        "field": "track_stop",
-                        "operand": "between",
-                        "value": [
-                                "2010-10-10 00:00",
-                                "2021-10-10 00:00"
-                        ]
-                }
-        ],
-        "sort": [
-                {
-                        "field": "active",
-                        "order": "asc"
-                }
-        ],
-        "fulltext_filter": {
-                "value": "2010",
-                "fields": [
-                        "track_start",
-                        "track_stop"
-                ],
-                "operation": "include"
-        }
-}
-response = RailLocatorApi::Request.tracks.tech_condition.retrieve(body: request)
-p response.body
-```
-
-### <a name="tracks_tech_condition_post"></a> [Постановка На Слежение](https://rail-scan.com/api/v2.0/redoc#tag/Kontrol-teh.-sostoyaniya/operation/_______________________tracks_tech_condition_post)
-
-```ruby
-request = [
-        {
-                "cargo_transport_unit_number": "12345678"
-        }
-]
-response = RailLocatorApi::Request.tracks.tech_condition.create(body: request)
-p response.body
-```
-
-## <a name="update_delete_tracks"></a> Изменение/Снятие треков
-### <a name="tracks_batch_delete"></a> [Снятие Со Слежения Нескольких Треков](https://rail-scan.com/api/v2.0/redoc#tag/IzmenenieSnyatie-trekov/operation/_____________________________________tracks_batch_delete)
-```ruby
-request = {
-        "track_ids": [
-                123,
-                1234
-        ]
-}
-response = RailLocatorApi::Request.tracks.batch.delete(body: request)
-p response.body
-```
-
-### <a name="tracks_batch_patch"></a> [Изменение Информации О Нескольких Треках](https://rail-scan.com/api/v2.0/redoc#tag/IzmenenieSnyatie-trekov/operation/_________________________________________tracks_batch_patch)
-```ruby
-request = [
-        {
-                "track_id": 123456,
-                "comment": "Примечание трека"
-        }
-]
-response = RailLocatorApi::Request.tracks.batch.update(body: request)
-p response.body
-```
-
-### <a name="tracks__track_id__delete"></a> [Снятие Со Слежения Одного Трека](https://rail-scan.com/api/v2.0/redoc#tag/IzmenenieSnyatie-trekov/operation/________________________________tracks__track_id__delete)
-```ruby
-track_id = 1
-response = RailLocatorApi::Request.tracks(track_id).delete
-p response.body
-```
-
-### <a name="tracks__track_id__patch"></a> [Изменение Информации О Треке](https://rail-scan.com/api/v2.0/redoc#tag/IzmenenieSnyatie-trekov/operation/_____________________________tracks__track_id__patch)
-```ruby
-track_id = 1
-request = {
-        "comment": "Примечание трека"
-}
-response = RailLocatorApi::Request.tracks(track_id).update(body: request)
-p response.body
-```
-
-## <a name="groups"></a> Группы
-### <a name="groups_get"></a> [Получение Списка Групп](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/_______________________groups_get)
-```ruby
-response = RailLocatorApi::Request.groups.retrieve
-p response.body
-```
-### <a name="groups_post"></a> [Создание Группы](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/________________groups_post)
-```ruby
-request = {
-        "group_name": "Название новой группы"
-}
-response = RailLocatorApi::Request.groups.create(body: request)
-p response.body
-```
-### <a name="groups__group_id__delete"></a> [Удаление Группы](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/________________groups__group_id__delete)
-```ruby
-group_id = 1
-response = RailLocatorApi::Request.groups(group_id).delete
-p response.body
-```
-### <a name="groups__group_id__patch"></a> [Изменение Группы](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/_________________groups__group_id__patch)
-```ruby
-group_id = 1
-request = {
-        "group_name": "Переименованная группа"
-}
-response = RailLocatorApi::Request.groups(group_id).update(body: request)
-p response.body
-```
-### <a name="groups__group_id__cargo_transport_unit_number_batch_put"></a> [Добавление Вагона В Группу](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/___________________________groups__group_id__cargo_transport_unit_number_batch_put)
-```ruby
-group_id = 1
-request = {
-        "cargo_transport_unit_numbers": [
-                "ASD1234",
-                "F0123454D"
-        ]
-}
-response = RailLocatorApi::Request.groups(group_id).cargo_transport_unit_number.batch.update(body: request)
-p response.body
-```
-### <a name="groups__group_id__cargo_transport_unit_number_batch_delete"></a> [Удаление Вагонов Из Группы](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/___________________________groups__group_id__cargo_transport_unit_number_batch_delete)
-```ruby
-group_id = 1
-request = {
-        "cargo_transport_unit_numbers": [
-                "ASD1234",
-                "F0123454D"
-        ]
-}
-response = RailLocatorApi::Request.groups(group_id).cargo_transport_unit_number.batch.delete(body: request)
-p response.body
-```
-### <a name="groups__group_id__cargo_transport_unit_number__cargo_transport_unit_number__put"></a> [Добавление Вагона В Группу](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/___________________________groups__group_id__cargo_transport_unit_number__cargo_transport_unit_number__put)
-```ruby
-group_id = 1
-cargo_transport_unit_number = "11111"
-response = RailLocatorApi::Request.groups(group_id).cargo_transport_unit_number(cargo_transport_unit_number).update
-p response.body
-```
-### <a name="groups__group_id__cargo_transport_unit_number__cargo_transport_unit_number__delete"></a> [Удаление Вагона Из Группы](https://rail-scan.com/api/v2.0/redoc#tag/Gruppy/operation/__________________________groups__group_id__cargo_transport_unit_number__cargo_transport_unit_number__delete)
-```ruby
-group_id = 1
-cargo_transport_unit_number = "11111"
-response = RailLocatorApi::Request.groups(group_id).cargo_transport_unit_number(cargo_transport_unit_number).delete
-p response.body
-```
-
-## <a name="references"></a> Справочники
-### <a name="references_station_get"></a> [Получение Координат Станции](https://rail-scan.com/api/v2.0/redoc#tag/Spravochniki/operation/____________________________references_station_get)
-```ruby
-response = RailLocatorApi::Request.references.station.retrieve(params: {disloc_id: 1})
-p response.body
-```
-
-### <a name="references_stations_get"></a> [Получение Списка Станций С Краткой Информацией](https://rail-scan.com/api/v2.0/redoc#tag/Spravochniki/operation/_______________________________________________references_stations_get)
-```ruby
-response = RailLocatorApi::Request.references.stations.retrieve(params: {station_code: "111"})
-p response.body
-```
-## <a name="emailings"></a> Рассылки
-### <a name="emailings_post"></a> [Создание Рассылки](https://rail-scan.com/api/v2.0/redoc#tag/Rassylki/operation/__________________emailings_post)
-
-```ruby
-request = {
-        "title": "Название рассылки",
-        "data_source": "groups",
-        "data_ids": [
-                "1234",
-                "12345"
-        ],
-        "recipients": [
-                "example@mail.ru"
-        ],
-        "sending_days": [
-                "Sun",
-                "Mon",
-                "Tue",
-                "Wed",
-                "Thu",
-                "Fri",
-                "Sat"
-        ],
-        "sending_times": [
-                "08:00:00",
-                "17:00:00"
-        ],
-        "template_title": "Тема письма",
-        "template_content": "Текст письма",
-        "active_objects": true,
-        "language": "ru",
-        "user_note": "Примечание"
-}
-response = RailLocatorApi::Request.emailings.create(body: request)
-p response.body
-```

data/lib/rail-locator-api/version.rb

@@ -1,3 +1,3 @@
 module RailLocatorApi
-  VERSION = "1.0.35"
+  VERSION = "1.0.36"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rail-locator-api
 version: !ruby/object:Gem::Version
-  version: 1.0.35
+  version: 1.0.36
 platform: ruby
 authors:
 - Pavel Osetrov