rail-locator-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: facf4423c0e86173d4dc747fc5223723b98a7999c316f5b1fb64b80ce048b988
-  data.tar.gz: eac12b206586fd5d73e70bc812d7b0f293d0676bb2dd400ffc1d03b9b3197057
+  metadata.gz: 86dafa172f5244cd21ea40704c850a5f585514ba5b00437da05bca58d420cbe5
+  data.tar.gz: 439dc8ac49e8998c577981a319e1939600831304ce60bfcd2f10179af2d28c51
 SHA512:
-  metadata.gz: 123fe83f4d87605ea16a9ce70d2d1d7f94c114cafa18431fde2947feee042ac9a72ad05c2ffadce538fc6e2a920832ecb2b679e3a2a1cedc73baba20993b3691
-  data.tar.gz: f51540d4f9048cd0c2d57638d65cabeb6e8a4d33dd5c755180a32a5d74c1ef40f97e51f768f815a7dd30aa3f7491805a269348253a11fd382ca2f98965d68dfc
+  metadata.gz: 074b9f3ad0f4561006e01a58bc9a7f83c2b792f3c715adc85f25317d080a9cdada8e3c95f2ba1d28c267a511f93dfac118894af414ae51ded59ffae582592b9c
+  data.tar.gz: 1393c5d85d5bc21600d50e618a2c0ef1e87763e68d5a77c936e87911f139f172d439951d024345d927f1569a3086bb4916e96a60821ece19885e6aba04811d24

data/README.markdown

@@ -46,6 +46,11 @@ API wrapper для RailLocator API v2
 
 # <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 +64,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 +73,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 +100,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 +108,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)
 ```
 
 Или:

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.2"
+  VERSION = "0.1.3"
 end

metadata

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