castle-rb 4.1.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +158 -43
- data/lib/castle.rb +46 -21
- data/lib/castle/api.rb +24 -12
- data/lib/castle/api/approve_device.rb +25 -0
- data/lib/castle/api/authenticate.rb +34 -0
- data/lib/castle/api/end_impersonation.rb +29 -0
- data/lib/castle/api/get_device.rb +25 -0
- data/lib/castle/api/get_devices_for_user.rb +25 -0
- data/lib/castle/api/identify.rb +26 -0
- data/lib/castle/api/report_device.rb +25 -0
- data/lib/castle/api/review.rb +24 -0
- data/lib/castle/api/start_impersonation.rb +29 -0
- data/lib/castle/api/track.rb +26 -0
- data/lib/castle/client.rb +52 -45
- data/lib/castle/{extractors/client_id.rb → client_id/extract.rb} +2 -2
- data/lib/castle/commands/approve_device.rb +21 -0
- data/lib/castle/commands/authenticate.rb +13 -13
- data/lib/castle/commands/end_impersonation.rb +25 -0
- data/lib/castle/commands/get_device.rb +21 -0
- data/lib/castle/commands/get_devices_for_user.rb +21 -0
- data/lib/castle/commands/identify.rb +12 -13
- data/lib/castle/commands/report_device.rb +21 -0
- data/lib/castle/commands/review.rb +6 -3
- data/lib/castle/commands/start_impersonation.rb +25 -0
- data/lib/castle/commands/track.rb +12 -13
- data/lib/castle/configuration.rb +45 -28
- data/lib/castle/context/{default.rb → get_default.rb} +5 -6
- data/lib/castle/context/{merger.rb → merge.rb} +3 -3
- data/lib/castle/context/prepare.rb +18 -0
- data/lib/castle/context/{sanitizer.rb → sanitize.rb} +1 -1
- data/lib/castle/core/get_connection.rb +25 -0
- data/lib/castle/{api/response.rb → core/process_response.rb} +4 -2
- data/lib/castle/core/process_webhook.rb +20 -0
- data/lib/castle/core/send_request.rb +50 -0
- data/lib/castle/errors.rb +2 -0
- data/lib/castle/events.rb +1 -1
- data/lib/castle/failover/prepare_response.rb +23 -0
- data/lib/castle/failover/strategy.rb +20 -0
- data/lib/castle/headers/extract.rb +47 -0
- data/lib/castle/headers/filter.rb +37 -0
- data/lib/castle/headers/format.rb +24 -0
- data/lib/castle/ip/extract.rb +83 -0
- data/lib/castle/logger.rb +19 -0
- data/lib/castle/payload/prepare.rb +27 -0
- data/lib/castle/secure_mode.rb +6 -2
- data/lib/castle/session.rb +18 -0
- data/lib/castle/singleton_configuration.rb +9 -0
- data/lib/castle/utils/clean_invalid_chars.rb +24 -0
- data/lib/castle/utils/clone.rb +15 -0
- data/lib/castle/utils/deep_symbolize_keys.rb +45 -0
- data/lib/castle/utils/get_timestamp.rb +15 -0
- data/lib/castle/utils/{merger.rb → merge.rb} +3 -3
- data/lib/castle/utils/secure_compare.rb +22 -0
- data/lib/castle/validators/not_supported.rb +1 -0
- data/lib/castle/validators/present.rb +1 -0
- data/lib/castle/verdict.rb +13 -0
- data/lib/castle/version.rb +1 -1
- data/lib/castle/webhooks/verify.rb +43 -0
- data/spec/integration/rails/rails_spec.rb +33 -7
- data/spec/integration/rails/support/application.rb +3 -1
- data/spec/integration/rails/support/home_controller.rb +47 -5
- data/spec/lib/castle/api/approve_device_spec.rb +21 -0
- data/spec/lib/castle/api/authenticate_spec.rb +140 -0
- data/spec/lib/castle/api/end_impersonation_spec.rb +59 -0
- data/spec/lib/castle/api/get_device_spec.rb +19 -0
- data/spec/lib/castle/api/get_devices_for_user_spec.rb +19 -0
- data/spec/lib/castle/api/identify_spec.rb +68 -0
- data/spec/lib/castle/api/report_device_spec.rb +21 -0
- data/spec/lib/castle/{review_spec.rb → api/review_spec.rb} +3 -3
- data/spec/lib/castle/api/start_impersonation_spec.rb +59 -0
- data/spec/lib/castle/api/track_spec.rb +68 -0
- data/spec/lib/castle/api_spec.rb +16 -1
- data/spec/lib/castle/{extractors/client_id_spec.rb → client_id/extract_spec.rb} +2 -2
- data/spec/lib/castle/client_spec.rb +41 -23
- data/spec/lib/castle/commands/approve_device_spec.rb +24 -0
- data/spec/lib/castle/commands/authenticate_spec.rb +7 -16
- data/spec/lib/castle/commands/end_impersonation_spec.rb +82 -0
- data/spec/lib/castle/commands/get_device_spec.rb +24 -0
- data/spec/lib/castle/commands/get_devices_for_user_spec.rb +24 -0
- data/spec/lib/castle/commands/identify_spec.rb +5 -16
- data/spec/lib/castle/commands/report_device_spec.rb +24 -0
- data/spec/lib/castle/commands/review_spec.rb +1 -1
- data/spec/lib/castle/commands/{impersonate_spec.rb → start_impersonation_spec.rb} +9 -34
- data/spec/lib/castle/commands/track_spec.rb +5 -16
- data/spec/lib/castle/configuration_spec.rb +9 -138
- data/spec/lib/castle/context/{default_spec.rb → get_default_spec.rb} +1 -2
- data/spec/lib/castle/context/{merger_spec.rb → merge_spec.rb} +1 -1
- data/spec/lib/castle/context/prepare_spec.rb +44 -0
- data/spec/lib/castle/context/{sanitizer_spec.rb → sanitize_spec.rb} +1 -1
- data/spec/lib/castle/core/get_connection_spec.rb +59 -0
- data/spec/lib/castle/{api/response_spec.rb → core/process_response_spec.rb} +56 -1
- data/spec/lib/castle/core/process_webhook_spec.rb +46 -0
- data/spec/lib/castle/core/send_request_spec.rb +102 -0
- data/spec/lib/castle/failover/strategy_spec.rb +12 -0
- data/spec/lib/castle/{extractors/headers_spec.rb → headers/extract_spec.rb} +18 -18
- data/spec/lib/castle/{headers_filter_spec.rb → headers/filter_spec.rb} +6 -5
- data/spec/lib/castle/headers/format_spec.rb +25 -0
- data/spec/lib/castle/{extractors/ip_spec.rb → ip/extract_spec.rb} +35 -7
- data/spec/lib/castle/logger_spec.rb +42 -0
- data/spec/lib/castle/payload/prepare_spec.rb +54 -0
- data/spec/lib/castle/session_spec.rb +88 -0
- data/spec/lib/castle/singleton_configuration_spec.rb +18 -0
- data/spec/lib/castle/utils/clean_invalid_chars_spec.rb +69 -0
- data/spec/lib/castle/utils/{cloner_spec.rb → clone_spec.rb} +3 -3
- data/spec/lib/castle/utils/deep_symbolize_keys_spec.rb +50 -0
- data/spec/lib/castle/utils/{timestamp_spec.rb → get_timestamp_spec.rb} +1 -1
- data/spec/lib/castle/utils/{merger_spec.rb → merge_spec.rb} +3 -3
- data/spec/lib/castle/verdict_spec.rb +9 -0
- data/spec/lib/castle/webhooks/verify_spec.rb +69 -0
- data/spec/spec_helper.rb +2 -0
- data/spec/support/shared_examples/configuration.rb +129 -0
- metadata +133 -56
- data/lib/castle/api/request.rb +0 -42
- data/lib/castle/api/session.rb +0 -39
- data/lib/castle/commands/impersonate.rb +0 -26
- data/lib/castle/extractors/headers.rb +0 -45
- data/lib/castle/extractors/ip.rb +0 -68
- data/lib/castle/failover_auth_response.rb +0 -21
- data/lib/castle/headers_filter.rb +0 -35
- data/lib/castle/headers_formatter.rb +0 -22
- data/lib/castle/review.rb +0 -11
- data/lib/castle/utils.rb +0 -55
- data/lib/castle/utils/cloner.rb +0 -11
- data/lib/castle/utils/timestamp.rb +0 -12
- data/spec/lib/castle/api/request_spec.rb +0 -72
- data/spec/lib/castle/headers_formatter_spec.rb +0 -25
- data/spec/lib/castle/utils_spec.rb +0 -156
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5e4354fd7a96d78e03da9bbe10015e375af34636a2e5e186c4de361d0851a6ca
|
4
|
+
data.tar.gz: 15c6bbf6f34ba315b5f42db490754a92e238f66a006a91e3986b9b1ba540d47a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7bb580056e70ed854014054791ef5987874e52b2471838605a90092f70269ba095d40ef5df5310636b0fbd652dfa9460bb95a314e6e2dae5074732672c77122b
|
7
|
+
data.tar.gz: 22fb6013ec018e8c983ecf8051041eb62f69f4b54f73528f185f783ab2343e23f5504e3d420143fb3a19f0f49e094a2d56c2fc873411d697b95be645b7cefb47
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Ruby SDK for Castle
|
2
2
|
|
3
|
-
[![Build Status](https://
|
3
|
+
[![Build Status](https://circleci.com/gh/castle/castle-ruby.svg?style=shield&branch=master)](https://circleci.com/gh/castle/castle-ruby)
|
4
4
|
[![Coverage Status](https://coveralls.io/repos/github/castle/castle-ruby/badge.svg?branch=coveralls)](https://coveralls.io/github/castle/castle-ruby?branch=coveralls)
|
5
5
|
[![Gem Version](https://badge.fury.io/rb/castle-rb.svg)](https://badge.fury.io/rb/castle-rb)
|
6
6
|
|
@@ -62,55 +62,103 @@ Castle.configure do |config|
|
|
62
62
|
# For authenticate method you can set failover strategies: allow(default), deny, challenge, throw
|
63
63
|
config.failover_strategy = :deny
|
64
64
|
|
65
|
-
# Castle::RequestError is raised when timing out in milliseconds (default:
|
66
|
-
config.request_timeout =
|
65
|
+
# Castle::RequestError is raised when timing out in milliseconds (default: 1000 milliseconds)
|
66
|
+
config.request_timeout = 1500
|
67
67
|
|
68
|
-
#
|
69
|
-
#
|
68
|
+
# Base Castle API url
|
69
|
+
# config.base_url = "https://api.castle.io/v1"
|
70
|
+
|
71
|
+
# Logger (need to respond to info method) - logs Castle API requests and responses
|
72
|
+
# config.logger = Logger.new(STDOUT)
|
73
|
+
|
74
|
+
# Allowlisted and Denylisted headers are case insensitive and allow to use _ and - as a separator, http prefixes are removed
|
75
|
+
# Allowlisted headers
|
70
76
|
# By default, the SDK sends all HTTP headers, except for Cookie and Authorization.
|
71
|
-
# If you decide to use a
|
77
|
+
# If you decide to use a allowlist, the SDK will:
|
72
78
|
# - always send the User-Agent header
|
73
|
-
# - send scrubbed values of non-
|
74
|
-
# - send proper values of
|
79
|
+
# - send scrubbed values of non-allowlisted headers
|
80
|
+
# - send proper values of allowlisted headers.
|
75
81
|
# @example
|
76
|
-
# config.
|
82
|
+
# config.allowlisted = ['X_HEADER']
|
77
83
|
# # will send { 'User-Agent' => 'Chrome', 'X_HEADER' => 'proper value', 'Any-Other-Header' => true }
|
78
84
|
#
|
79
|
-
# We highly suggest using
|
80
|
-
# as possible to secure your users. If you want to use the
|
85
|
+
# We highly suggest using denylist instead of allowlist, so that Castle can use as many data points
|
86
|
+
# as possible to secure your users. If you want to use the allowlist, this is the minimal
|
81
87
|
# amount of headers we recommend:
|
82
|
-
config.
|
88
|
+
config.allowlisted = Castle::Configuration::DEFAULT_ALLOWLIST
|
83
89
|
|
84
|
-
#
|
85
|
-
# We always
|
86
|
-
# might contain sensitive information, you should
|
87
|
-
config.
|
90
|
+
# Denylisted headers take precedence over allowlisted elements
|
91
|
+
# We always denylist Cookie and Authentication headers. If you use any other headers that
|
92
|
+
# might contain sensitive information, you should denylist them.
|
93
|
+
config.denylisted = ['HTTP-X-header']
|
88
94
|
|
89
95
|
# Castle needs the original IP of the client, not the IP of your proxy or load balancer.
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
|
94
|
-
|
95
|
-
#
|
96
|
+
# The SDK will only trust the proxy chain as defined in the configuration.
|
97
|
+
# We try to fetch the client IP based on X-Forwarded-For or Remote-Addr headers in that order,
|
98
|
+
# but sometimes the client IP may be stored in a different header or order.
|
99
|
+
# The SDK can be configured to look for the client IP address in headers that you specify.
|
100
|
+
|
101
|
+
# Sometimes, Cloud providers do not use consistent IP addresses to proxy requests.
|
102
|
+
# In this case, the client IP is usually preserved in a custom header. Example:
|
103
|
+
# Cloudflare preserves the client request in the 'Cf-Connecting-Ip' header.
|
104
|
+
# It would be used like so: config.ip_headers=['Cf-Connecting-Ip']
|
105
|
+
config.ip_headers = []
|
106
|
+
|
107
|
+
# If the specified header or X-Forwarded-For default contains a proxy chain with public IP addresses,
|
108
|
+
# then you must choose only one of the following (but not both):
|
109
|
+
# 1. The trusted_proxies value must match the known proxy IPs. This option is preferable if the IP is static.
|
110
|
+
# 2. The trusted_proxy_depth value must be set to the number of known trusted proxies in the chain (see below).
|
111
|
+
# This option is preferable if the IPs are ephemeral, but the depth is consistent.
|
112
|
+
|
113
|
+
# Additionally to make X-Forwarded-For and other headers work better discovering client ip address,
|
96
114
|
# and not the address of a reverse proxy server, you can define trusted proxies
|
97
115
|
# which will help to fetch proper ip from those headers
|
98
|
-
|
99
|
-
#
|
100
|
-
#
|
116
|
+
|
117
|
+
# In order to extract the client IP of the X-Forwarded-For header
|
118
|
+
# and not the address of a reverse proxy server, you must define all trusted public proxies
|
119
|
+
# you can achieve this by listing all the proxies ip defined by string or regular expressions
|
120
|
+
# in the trusted_proxies setting
|
121
|
+
config.trusted_proxies = []
|
122
|
+
# or by providing number of trusted proxies used in the chain
|
123
|
+
config.trusted_proxy_depth = 0
|
124
|
+
# note that you must pick one approach over the other.
|
125
|
+
|
126
|
+
# If there is no possibility to define options above and there is no other header that holds the client IP,
|
127
|
+
# then you may set trust_proxy_chain = true to trust all of the proxy IPs in X-Forwarded-For
|
128
|
+
config.trust_proxy_chain = false
|
129
|
+
# *Warning*: this mode is highly promiscuous and could lead to wrongly trusting a spoofed IP if the request passes through a malicious proxy
|
130
|
+
|
131
|
+
# *Note: the default list of proxies that are always marked as "trusted" can be found in: Castle::Configuration::TRUSTED_PROXIES
|
101
132
|
end
|
102
133
|
```
|
103
134
|
|
135
|
+
### Multi-environment configuration
|
136
|
+
|
137
|
+
It is also possible to define multiple configs within one application.
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
# Initialize new instance of Castle::Configuration
|
141
|
+
config = Castle::Configuration.new.tap do |c|
|
142
|
+
# and set any attribute
|
143
|
+
c.api_secret = 'YOUR_API_SECRET'
|
144
|
+
end
|
145
|
+
```
|
146
|
+
|
147
|
+
After a successful setup, you can pass the config to any API command as follows:
|
148
|
+
|
149
|
+
```ruby
|
150
|
+
::Castle::API::GetDevice.call(device_token: device_token, config: config)
|
151
|
+
```
|
152
|
+
|
104
153
|
## Event Context
|
105
154
|
|
106
155
|
The client will automatically configure the context for each request.
|
107
156
|
|
108
157
|
### Overriding Default Context Properties
|
109
158
|
|
110
|
-
If you need to modify the event context properties or if you desire to add additional properties such as user traits to the context, you can pass the properties
|
159
|
+
If you need to modify the event context properties or if you desire to add additional properties such as user traits to the context, you can pass the properties along with the other data. For example:
|
111
160
|
```ruby
|
112
|
-
|
113
|
-
track_options = ::Castle::Client.to_options({
|
161
|
+
{
|
114
162
|
event: ::Castle::Events::LOGIN_SUCCEEDED,
|
115
163
|
user_id: user.id,
|
116
164
|
properties: {
|
@@ -118,8 +166,11 @@ track_options = ::Castle::Client.to_options({
|
|
118
166
|
},
|
119
167
|
user_traits: {
|
120
168
|
key: 'value'
|
169
|
+
},
|
170
|
+
context: {
|
171
|
+
section: 'mobile'
|
121
172
|
}
|
122
|
-
}
|
173
|
+
}
|
123
174
|
```
|
124
175
|
|
125
176
|
## Tracking
|
@@ -151,9 +202,8 @@ By default Castle sends requests synchronously. To eg. use Sidekiq to send reque
|
|
151
202
|
class CastleTrackingWorker
|
152
203
|
include Sidekiq::Worker
|
153
204
|
|
154
|
-
def perform(
|
155
|
-
|
156
|
-
client.track(track_options)
|
205
|
+
def perform(payload = {})
|
206
|
+
::Castle::API::Track.call(payload)
|
157
207
|
end
|
158
208
|
end
|
159
209
|
```
|
@@ -161,24 +211,79 @@ end
|
|
161
211
|
#### tracking_controller.rb
|
162
212
|
|
163
213
|
```ruby
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
214
|
+
payload = ::Castle::Payload::Prepare.call(
|
215
|
+
{
|
216
|
+
event: ::Castle::Events::LOGIN_SUCCEEDED,
|
217
|
+
user_id: user.id,
|
218
|
+
properties: {
|
219
|
+
key: 'value'
|
220
|
+
},
|
221
|
+
user_traits: {
|
222
|
+
key: 'value'
|
223
|
+
}
|
170
224
|
},
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
225
|
+
request
|
226
|
+
)
|
227
|
+
CastleTrackingWorker.perform_async(payload)
|
228
|
+
```
|
229
|
+
|
230
|
+
## Connection reuse
|
231
|
+
|
232
|
+
If you want to reuse the connection to send multiple events:
|
233
|
+
|
234
|
+
```ruby
|
235
|
+
Castle::Session.call do |http|
|
236
|
+
castle.track(
|
237
|
+
event: ::Castle::Events::LOGOUT_SUCCEEDED,
|
238
|
+
user_id: user2.id
|
239
|
+
http: http
|
240
|
+
)
|
241
|
+
castle.track(
|
242
|
+
event: ::Castle::Events::LOGIN_SUCCEEDED,
|
243
|
+
user_id: user1.id
|
244
|
+
http: http
|
245
|
+
)
|
246
|
+
end
|
176
247
|
```
|
177
248
|
|
178
249
|
## Events
|
179
250
|
|
180
251
|
List of Recognized Events can be found [here](https://github.com/castle/castle-ruby/tree/master/lib/castle/events.rb) or in the [docs](https://docs.castle.io/api_reference/#list-of-recognized-events)
|
181
252
|
|
253
|
+
## Device management
|
254
|
+
|
255
|
+
This SDK allows issuing requests to [Castle's Device Management Endpoints](https://docs.castle.io/device_management_tool/). Use these endpoints for admin-level management of end-user devices (i.e., for an internal dashboard).
|
256
|
+
|
257
|
+
Fetching device data, approving a device, reporting a device requires a valid `device_token`.
|
258
|
+
|
259
|
+
```ruby
|
260
|
+
# Get device data
|
261
|
+
::Castle::API::GetDevice.call(device_token: device_token)
|
262
|
+
# Approve a device
|
263
|
+
::Castle::API::ApproveDevice.call(device_token: device_token)
|
264
|
+
# Report a device
|
265
|
+
::Castle::API::ReportDevice.call(device_token: device_token)
|
266
|
+
```
|
267
|
+
|
268
|
+
#### castle_device_reporting_worker.rb
|
269
|
+
|
270
|
+
```ruby
|
271
|
+
class CastleDeviceReportingWorker
|
272
|
+
include Sidekiq::Worker
|
273
|
+
|
274
|
+
def perform(device_token)
|
275
|
+
::Castle::API::ReportDevice.call(device_token: device_token)
|
276
|
+
end
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
Fetching available devices that belong to a given user requires a valid `user_id`.
|
281
|
+
|
282
|
+
```ruby
|
283
|
+
# Get user's devices data
|
284
|
+
::Castle::API::GetDevicesForUser.call(user_id: user.id)
|
285
|
+
```
|
286
|
+
|
182
287
|
## Impersonation mode
|
183
288
|
|
184
289
|
https://castle.io/docs/impersonation_mode
|
@@ -188,6 +293,16 @@ https://castle.io/docs/impersonation_mode
|
|
188
293
|
`Castle::Error` will be thrown if the Castle API returns a 400 or a 500 level HTTP response.
|
189
294
|
You can also choose to catch a more [finegrained error](https://github.com/castle/castle-ruby/blob/master/lib/castle/errors.rb).
|
190
295
|
|
296
|
+
## Webhooks
|
297
|
+
|
298
|
+
Castle uses webhooks to notify about `$incident.confirmed` or `$review.opened` events. Each webhook has `X-Castle-Signature` header that allows verifying webhook's source.
|
299
|
+
|
300
|
+
```ruby
|
301
|
+
# Verify the webhook, passed as a Request object
|
302
|
+
::Castle::Webhooks::Verify.call(webhook_request)
|
303
|
+
# Castle::WebhookVerificationError is raised when the signature is not matching
|
304
|
+
```
|
305
|
+
|
191
306
|
## Documentation
|
192
307
|
|
193
308
|
[Official Castle docs](https://castle.io/docs)
|
data/lib/castle.rb
CHANGED
@@ -9,36 +9,61 @@
|
|
9
9
|
|
10
10
|
%w[
|
11
11
|
castle/version
|
12
|
+
castle/verdict
|
12
13
|
castle/events
|
13
14
|
castle/errors
|
14
15
|
castle/command
|
15
|
-
castle/utils
|
16
|
-
castle/utils/
|
17
|
-
castle/utils/
|
18
|
-
castle/utils/
|
16
|
+
castle/utils/deep_symbolize_keys
|
17
|
+
castle/utils/clean_invalid_chars
|
18
|
+
castle/utils/merge
|
19
|
+
castle/utils/clone
|
20
|
+
castle/utils/get_timestamp
|
21
|
+
castle/utils/secure_compare
|
19
22
|
castle/validators/present
|
20
23
|
castle/validators/not_supported
|
21
|
-
castle/
|
22
|
-
castle/context/
|
23
|
-
castle/context/
|
24
|
-
castle/
|
24
|
+
castle/webhooks/verify
|
25
|
+
castle/context/merge
|
26
|
+
castle/context/sanitize
|
27
|
+
castle/context/get_default
|
28
|
+
castle/context/prepare
|
29
|
+
castle/commands/approve_device
|
25
30
|
castle/commands/authenticate
|
26
|
-
castle/commands/
|
31
|
+
castle/commands/end_impersonation
|
32
|
+
castle/commands/get_device
|
33
|
+
castle/commands/get_devices_for_user
|
34
|
+
castle/commands/identify
|
35
|
+
castle/commands/report_device
|
27
36
|
castle/commands/review
|
28
|
-
castle/commands/
|
37
|
+
castle/commands/start_impersonation
|
38
|
+
castle/commands/track
|
39
|
+
castle/api/approve_device
|
40
|
+
castle/api/authenticate
|
41
|
+
castle/api/end_impersonation
|
42
|
+
castle/api/get_device
|
43
|
+
castle/api/get_devices_for_user
|
44
|
+
castle/api/identify
|
45
|
+
castle/api/report_device
|
46
|
+
castle/api/review
|
47
|
+
castle/api/start_impersonation
|
48
|
+
castle/api/track
|
49
|
+
castle/payload/prepare
|
29
50
|
castle/configuration
|
30
|
-
castle/
|
51
|
+
castle/singleton_configuration
|
52
|
+
castle/logger
|
53
|
+
castle/failover/prepare_response
|
54
|
+
castle/failover/strategy
|
31
55
|
castle/client
|
32
|
-
castle/
|
33
|
-
castle/
|
56
|
+
castle/headers/filter
|
57
|
+
castle/headers/format
|
58
|
+
castle/headers/extract
|
34
59
|
castle/secure_mode
|
35
|
-
castle/
|
36
|
-
castle/
|
37
|
-
castle/
|
38
|
-
castle/
|
39
|
-
castle/
|
40
|
-
castle/
|
41
|
-
castle/
|
60
|
+
castle/client_id/extract
|
61
|
+
castle/ip/extract
|
62
|
+
castle/core/get_connection
|
63
|
+
castle/core/process_response
|
64
|
+
castle/core/send_request
|
65
|
+
castle/core/process_webhook
|
66
|
+
castle/session
|
42
67
|
castle/api
|
43
68
|
].each(&method(:require))
|
44
69
|
|
@@ -54,7 +79,7 @@ module Castle
|
|
54
79
|
end
|
55
80
|
|
56
81
|
def config
|
57
|
-
|
82
|
+
SingletonConfiguration.instance
|
58
83
|
end
|
59
84
|
|
60
85
|
def api_secret=(api_secret)
|
data/lib/castle/api.rb
CHANGED
@@ -19,28 +19,40 @@ module Castle
|
|
19
19
|
class << self
|
20
20
|
# @param command [String]
|
21
21
|
# @param headers [Hash]
|
22
|
-
|
23
|
-
|
22
|
+
# @param http [Net::HTTP]
|
23
|
+
# @param config [Castle::Configuration, Castle::SingletonConfiguration]
|
24
|
+
# @return [Hash]
|
25
|
+
def call(command, headers = {}, http = nil, config = Castle.config)
|
26
|
+
Castle::Core::ProcessResponse.call(
|
27
|
+
send_request(command, headers, http, config)
|
28
|
+
)
|
29
|
+
end
|
30
|
+
|
31
|
+
private
|
32
|
+
|
33
|
+
# @param command [String]
|
34
|
+
# @param headers [Hash]
|
35
|
+
# @param http [Net::HTTP]
|
36
|
+
# @param config [Castle::Configuration, Castle::SingletonConfiguration]
|
37
|
+
def send_request(command, headers = {}, http = nil, config = Castle.config)
|
38
|
+
raise Castle::ConfigurationError, 'configuration is not valid' unless config.valid?
|
24
39
|
|
25
40
|
begin
|
26
|
-
Castle::
|
41
|
+
Castle::Core::SendRequest.call(
|
27
42
|
command,
|
28
|
-
|
29
|
-
|
43
|
+
headers,
|
44
|
+
http,
|
45
|
+
config
|
30
46
|
)
|
31
47
|
rescue *HANDLED_ERRORS => e
|
32
48
|
# @note We need to initialize the error, as the original error is a cause for this
|
33
49
|
# custom exception. If we would do it the default Ruby way, the original error
|
34
50
|
# would get converted into a string
|
35
|
-
|
51
|
+
# rubocop:disable Style/RaiseArgs
|
52
|
+
raise Castle::RequestError.new(e)
|
53
|
+
# rubocop:enable Style/RaiseArgs
|
36
54
|
end
|
37
55
|
end
|
38
|
-
|
39
|
-
# @param command [String]
|
40
|
-
# @param headers [Hash]
|
41
|
-
def call(command, headers = {})
|
42
|
-
Castle::API::Response.call(request(command, headers))
|
43
|
-
end
|
44
56
|
end
|
45
57
|
end
|
46
58
|
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Castle
|
4
|
+
module API
|
5
|
+
# Sends PUT devices/#{device_token}/approve request
|
6
|
+
module ApproveDevice
|
7
|
+
class << self
|
8
|
+
# @param options [Hash]
|
9
|
+
# return [Hash]
|
10
|
+
def call(options = {})
|
11
|
+
options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
|
12
|
+
http = options.delete(:http)
|
13
|
+
config = options.delete(:config) || Castle.config
|
14
|
+
|
15
|
+
Castle::API.call(
|
16
|
+
Castle::Commands::ApproveDevice.build(options),
|
17
|
+
{},
|
18
|
+
http,
|
19
|
+
config
|
20
|
+
)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|