userplex 0.15.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +10 -9
- data/lib/userplex/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5409cd80ddef6dff1a3805e550e0c9c247c95931435508bfb2492b44c2f7710c
|
|
4
|
+
data.tar.gz: e47a691919907a0d70dec176d29a778e292238506d99116f3797b2775f902660
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0d5c413ee75ff3fcf3cc4a07ef9d297e4d9254746c5b97a7fc36ee318415022223401e5bb2ba3e8ff67bd7c9c0fd5b6d45344679112c3fd58259e94270e4e8d2
|
|
7
|
+
data.tar.gz: '0495e186952c28e1672e481c027caa6eca64ff84c15a9c7a2f23f3fc427d8513bb2b53343a9de984a7f957dee2ac5cc0ef4ed4eeea935677099d4a288ee54928'
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.16.0 (2026-01-06)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.15.0...v0.16.0](https://github.com/dqnamo/userplex-ruby/compare/v0.15.0...v0.16.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** manual updates ([eec546a](https://github.com/dqnamo/userplex-ruby/commit/eec546a90792b035aa09ea4c194b4e91a8eee8c4))
|
|
10
|
+
|
|
3
11
|
## 0.15.0 (2026-01-06)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.14.0...v0.15.0](https://github.com/dqnamo/userplex-ruby/compare/v0.14.0...v0.15.0)
|
data/README.md
CHANGED
|
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
15
15
|
<!-- x-release-please-start-version -->
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
|
-
gem "userplex", "~> 0.
|
|
18
|
+
gem "userplex", "~> 0.16.0"
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
<!-- x-release-please-end -->
|
|
@@ -30,7 +30,7 @@ userplex = Userplex::Client.new(
|
|
|
30
30
|
api_key: ENV["USERPLEX_API_KEY"] # This is the default and can be omitted
|
|
31
31
|
)
|
|
32
32
|
|
|
33
|
-
response = userplex.
|
|
33
|
+
response = userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
|
|
34
34
|
|
|
35
35
|
puts(response.success)
|
|
36
36
|
```
|
|
@@ -41,7 +41,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
|
|
|
41
41
|
|
|
42
42
|
```ruby
|
|
43
43
|
begin
|
|
44
|
-
event = userplex.events.capture
|
|
44
|
+
event = userplex.events.capture(name: "REPLACE_ME")
|
|
45
45
|
rescue Userplex::Errors::APIConnectionError => e
|
|
46
46
|
puts("The server could not be reached")
|
|
47
47
|
puts(e.cause) # an underlying Exception, likely raised within `net/http`
|
|
@@ -84,7 +84,7 @@ userplex = Userplex::Client.new(
|
|
|
84
84
|
)
|
|
85
85
|
|
|
86
86
|
# Or, configure per-request:
|
|
87
|
-
userplex.events.capture(request_options: {max_retries: 5})
|
|
87
|
+
userplex.events.capture(name: "REPLACE_ME", request_options: {max_retries: 5})
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
### Timeouts
|
|
@@ -98,7 +98,7 @@ userplex = Userplex::Client.new(
|
|
|
98
98
|
)
|
|
99
99
|
|
|
100
100
|
# Or, configure per-request:
|
|
101
|
-
userplex.events.capture(request_options: {timeout: 5})
|
|
101
|
+
userplex.events.capture(name: "REPLACE_ME", request_options: {timeout: 5})
|
|
102
102
|
```
|
|
103
103
|
|
|
104
104
|
On timeout, `Userplex::Errors::APITimeoutError` is raised.
|
|
@@ -130,6 +130,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
|
|
|
130
130
|
```ruby
|
|
131
131
|
response =
|
|
132
132
|
userplex.events.capture(
|
|
133
|
+
name: "REPLACE_ME",
|
|
133
134
|
request_options: {
|
|
134
135
|
extra_query: {my_query_parameter: value},
|
|
135
136
|
extra_body: {my_body_parameter: value},
|
|
@@ -175,18 +176,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
|
|
|
175
176
|
You can provide typesafe request parameters like so:
|
|
176
177
|
|
|
177
178
|
```ruby
|
|
178
|
-
userplex.
|
|
179
|
+
userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
|
|
179
180
|
```
|
|
180
181
|
|
|
181
182
|
Or, equivalently:
|
|
182
183
|
|
|
183
184
|
```ruby
|
|
184
185
|
# Hashes work, but are not typesafe:
|
|
185
|
-
userplex.
|
|
186
|
+
userplex.users.identify(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
|
|
186
187
|
|
|
187
188
|
# You can also splat a full Params class:
|
|
188
|
-
params = Userplex::
|
|
189
|
-
userplex.
|
|
189
|
+
params = Userplex::UserIdentifyParams.new(user_id: "user_id", email: "REPLACE_ME", name: "REPLACE_ME")
|
|
190
|
+
userplex.users.identify(**params)
|
|
190
191
|
```
|
|
191
192
|
|
|
192
193
|
## Versioning
|
data/lib/userplex/version.rb
CHANGED