rail-locator-api 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc4f957d48ba4a6a724fdc6eb30a4e98c3a870f238687df672343822e7d9e62
-  data.tar.gz: 39793e92df61361bb59b53dc0f42eaa3e26f3af4a95ce55f76cef4989adca554
+  metadata.gz: da757da5a995acefce054caa13481192c75e90601232a8d91f60da72d76fbae9
+  data.tar.gz: 8873e45d2446b3b5704691c9fed01a38c9be37e9bfa320952840957d3c6188cd
 SHA512:
-  metadata.gz: 59538f8648d35498520b19fdfe66d028a867f46bcfae08354cbdb3be8eae673c6375083d86228cdf21c7615e48dce38571aa97d09d493d4008432a99b8a9ddd8
-  data.tar.gz: 919b0d37c8cb4cbcfd6f313520c5680aa928eede734052de8ea006adc24e8d9d64a0a7de011666cec9b6b694560c69b71c08774203ffa141986ccaefa1dd9d3e
+  metadata.gz: 2cccb68cee0ae41504f7f1e0c9fab054fd182eaebe43f86815c36c5f35b0b6f575ddccbaac0dfdff0bde1e35488bfe024edbdb7e010662352fca541fe4753da2
+  data.tar.gz: 99489e413ed24932c1fe7a82fac11a201abecf47474b7e8ccbad2c4a3290f7509b19c82cb6621cf640e35b5dfa776a9682740c706fad7706955057d15ed93f68

data/README.markdown

@@ -43,9 +43,16 @@ API wrapper для RailLocator API v2
 8. [Справочники](#references)
    1. [Получение Координат Станции](#references_station_get)
    2. [Получение Списка Станций С Краткой Информацией](#references_stations_get)
+9. [Рассылки](#emailings)
+   1. [Создание Рассылки](#emailings_post)
 
 # <a name="install"></a> Установка
 
+Для авторизации по api key необходимо получить его [в личном кабинете локатора](https://rail-locator.com/app/api-keys)
+либо использовать другие методы авторизации:
+
+`:keycloak, :api_key, :base64`
+
 ## Ruby
     $ gem install rail-locator-api
 ## Rails
@@ -59,7 +66,6 @@ API wrapper для RailLocator API v2
 
     rails g rail_locator_api:install
 
-
 ## <a name="using_rails"></a> Использование Rails
 
 В файл `config/rail_locator_api.yml` вставьте ваши данные
@@ -69,19 +75,24 @@ API wrapper для RailLocator API v2
 Сначала создайте экземпляр объекта `RailLocatorApi::Request`:
 
 ```ruby
-locator = RailLocatorApi::Request.new(api_user_email: "email@ctm.ru", api_user_password: "12345678")
+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_user_email`, `api_user_password`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
+Вы можете изменять `api_auth_method`, `api_key`, `api_user_email`, `api_user_password`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, и `debug`:
 
 ```ruby
-RailLocatorApi::Request.api_key = "your_api_key"
-RailLocatorApi::Request.api_user_email = "email@ctm.ru"
-RailLocatorApi::Request.api_user_password = "12345678"
 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.
@@ -91,7 +102,7 @@ RailLocatorApi::Request.debug = false
 Измените `debug: true` чтобы включить логирование в STDOUT.
 
 ```ruby
-locator = RailLocatorApi::Request.new(api_key: "your_api_key", debug: true)
+locator = RailLocatorApi::Request.new(api_key: "***", debug: true)
 ```
 
 ### <a name="custom_logger"></a> Custom logger
@@ -99,7 +110,7 @@ locator = RailLocatorApi::Request.new(api_key: "your_api_key", debug: true)
 `Logger.new` используется по умолчанию, но вы можете изменить на свой:
 
 ```ruby
-locator = RailLocatorApi::Request.new(api_user_email: "email@ctm.ru", api_user_password: "12345678", debug: true, logger: MyLogger.new)
+locator = RailLocatorApi::Request.new(api_key: "***", debug: true, logger: MyLogger.new)
 ```
 
 Или:
@@ -182,14 +193,15 @@ request = {
         ],
         "operations_count": 10
 }
-response = RailLocatorApi::Request.tracks.dislocation.batch.retrieve(body: request)
+response = RailLocatorApi::Request.tracks.dislocation.history.retrieve(body: request)
 p response.body
 ```
 
 ### <a name="tracks_dislocation_route_info_get"></a> [Получение Информации О Маршруте](http://soap.ctm.ru:8112/api/v2.0/redoc#tag/Dislokaciya/operation/________________________________tracks_dislocation_route_info_get)
 
 ```ruby
-response = RailLocatorApi::Request.tracks.dislocation.route_info.retrieve(params: {track_id: 1})
+track_id = 1
+response = RailLocatorApi::Request.tracks.dislocation(track_id).route.retrieve
 p response.body
 ```
 
@@ -197,7 +209,7 @@ p response.body
 
 ```ruby
 track_id = 1
-response = RailLocatorApi::Request.tracks.dislocation(track_id).retrieve
+response = RailLocatorApi::Request.tracks.dislocation(track_id).history.retrieve
 p response.body
 ```
 
@@ -298,13 +310,13 @@ request = {
         ],
         "count": 1
 }
-response = RailLocatorApi::Request.tracks.tech_passport.batch.retrieve(body: request)
+response = RailLocatorApi::Request.tracks.dislocation.tech_passports.retrieve(body: request)
 p response.body
 ```
 ### <a name="tracks_tech_passport__track_id__get"></a> [Получение Тех. Паспорта](http://soap.ctm.ru:8112/api/v2.0/redoc#tag/Teh.-pasport-vagona/operation/_________________________tracks_tech_passport__track_id__get)
 ```ruby
 track_id = 1
-response = RailLocatorApi::Request.tracks.tech_passport(track_id).retrieve
+response = RailLocatorApi::Request.tracks.dislocation(track_id).tech_passports.retrieve
 p response.body
 ```
 
@@ -489,4 +501,40 @@ p response.body
 ```ruby
 response = RailLocatorApi::Request.references.stations.retrieve(params: {station_code: "111"})
 p response.body
-```
+```
+## <a name="emailings"></a> Рассылки
+### <a name="emailings_post"></a> [Создание Рассылки](http://soap.ctm.ru:8112/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/generators/rail_locator_api/install/templates/rail_locator_api.yml

@@ -1,8 +1,12 @@
 defaults: &defaults
-  API_KEY: "***"
   API_ENDPOINT: "http://soap.ctm.ru:8112"
+
+  API_AUTH_METHOD: "api_key"
+  API_KEY: "***"
+
   API_USER_EMAIL: ""
   API_USER_PASSWORD: ""
+
   KEYCLOAK_TOKEN_URL: "https://iam.ctm.ru/auth/realms/ctm/protocol/openid-connect/token"
   KEYCLOAK_GRANT_TYPE: "password"
   KEYCLOAK_CLIENT_ID: "client_id"

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

@@ -127,6 +127,9 @@ module RailLocatorApi
         if [:api_key, :keycloak].include?(self.api_auth_method)
           request.headers['Authorization'] = "Bearer #{RailLocatorApi::Request.access_token}"
         end
+        if [:keycloak].include?(self.api_auth_method)
+          request.headers['X-API-KEY'] = "#{RailLocatorApi::Request.api_key}"
+        end
         request.headers['User-Agent'] = "RailLocatorApi/#{RailLocatorApi::VERSION} Ruby gem"
         if @request_builder.without_ratelimit
           request.headers['X-Request-Without-Ratelimit'] = "1"

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

@@ -5,7 +5,7 @@ module RailLocatorApi
                   :without_ratelimit, :logger, :test
 
     AUTH_METHODS = [:keycloak, :api_key, :base64]
-    DEFAULT_AUTH_METHOD = :keycloak
+    DEFAULT_AUTH_METHOD = :api_key
     DEFAULT_TIMEOUT = 60
     DEFAULT_OPEN_TIMEOUT = 60
 

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

@@ -1,3 +1,3 @@
 module RailLocatorApi
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

metadata

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