umami-ruby 0.1.3 → 0.2.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/.env.test +9 -0
- data/.simplecov +36 -0
- data/CHANGELOG.md +83 -1
- data/CLAUDE.md +45 -0
- data/README.md +396 -25
- data/Rakefile +10 -1
- data/docs/Umami/APIError.html +2 -2
- data/docs/Umami/AuthenticationError.html +2 -2
- data/docs/Umami/Client.html +11047 -1855
- data/docs/Umami/ClientError.html +2 -2
- data/docs/Umami/Configuration.html +401 -81
- data/docs/Umami/ConfigurationError.html +2 -2
- data/docs/Umami/Error.html +2 -2
- data/docs/Umami/NotFoundError.html +2 -2
- data/docs/Umami/ServerError.html +2 -2
- data/docs/Umami.html +3 -3
- data/docs/_index.html +2 -2
- data/docs/file.CHANGELOG.html +117 -3
- data/docs/file.LICENSE.html +2 -2
- data/docs/file.README.html +465 -30
- data/docs/index.html +465 -30
- data/docs/method_list.html +395 -19
- data/docs/top-level-namespace.html +2 -2
- data/lib/umami/client.rb +989 -192
- data/lib/umami/configuration.rb +62 -0
- data/lib/umami/version.rb +1 -1
- metadata +6 -62
|
@@ -132,9 +132,9 @@
|
|
|
132
132
|
</div>
|
|
133
133
|
|
|
134
134
|
<div id="footer">
|
|
135
|
-
Generated on
|
|
135
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
136
136
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
137
|
-
0.9.36 (ruby-3.
|
|
137
|
+
0.9.36 (ruby-3.4.2).
|
|
138
138
|
</div>
|
|
139
139
|
|
|
140
140
|
</div>
|
data/docs/Umami/Error.html
CHANGED
|
@@ -128,9 +128,9 @@
|
|
|
128
128
|
</div>
|
|
129
129
|
|
|
130
130
|
<div id="footer">
|
|
131
|
-
Generated on
|
|
131
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
132
132
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
133
|
-
0.9.36 (ruby-3.
|
|
133
|
+
0.9.36 (ruby-3.4.2).
|
|
134
134
|
</div>
|
|
135
135
|
|
|
136
136
|
</div>
|
|
@@ -140,9 +140,9 @@
|
|
|
140
140
|
</div>
|
|
141
141
|
|
|
142
142
|
<div id="footer">
|
|
143
|
-
Generated on
|
|
143
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
144
144
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
145
|
-
0.9.36 (ruby-3.
|
|
145
|
+
0.9.36 (ruby-3.4.2).
|
|
146
146
|
</div>
|
|
147
147
|
|
|
148
148
|
</div>
|
data/docs/Umami/ServerError.html
CHANGED
|
@@ -140,9 +140,9 @@
|
|
|
140
140
|
</div>
|
|
141
141
|
|
|
142
142
|
<div id="footer">
|
|
143
|
-
Generated on
|
|
143
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
144
144
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
145
|
-
0.9.36 (ruby-3.
|
|
145
|
+
0.9.36 (ruby-3.4.2).
|
|
146
146
|
</div>
|
|
147
147
|
|
|
148
148
|
</div>
|
data/docs/Umami.html
CHANGED
|
@@ -107,7 +107,7 @@
|
|
|
107
107
|
<dt id="VERSION-constant" class="">VERSION =
|
|
108
108
|
|
|
109
109
|
</dt>
|
|
110
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.
|
|
110
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
|
111
111
|
|
|
112
112
|
</dl>
|
|
113
113
|
|
|
@@ -446,9 +446,9 @@
|
|
|
446
446
|
</div>
|
|
447
447
|
|
|
448
448
|
<div id="footer">
|
|
449
|
-
Generated on
|
|
449
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
450
450
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
451
|
-
0.9.36 (ruby-3.
|
|
451
|
+
0.9.36 (ruby-3.4.2).
|
|
452
452
|
</div>
|
|
453
453
|
|
|
454
454
|
</div>
|
data/docs/_index.html
CHANGED
|
@@ -206,9 +206,9 @@
|
|
|
206
206
|
</div>
|
|
207
207
|
|
|
208
208
|
<div id="footer">
|
|
209
|
-
Generated on
|
|
209
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
210
210
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
211
|
-
0.9.36 (ruby-3.
|
|
211
|
+
0.9.36 (ruby-3.4.2).
|
|
212
212
|
</div>
|
|
213
213
|
|
|
214
214
|
</div>
|
data/docs/file.CHANGELOG.html
CHANGED
|
@@ -57,7 +57,121 @@
|
|
|
57
57
|
<div class="clear"></div>
|
|
58
58
|
</div>
|
|
59
59
|
|
|
60
|
-
<div id="content"><div id='filecontents'><h2 id="
|
|
60
|
+
<div id="content"><div id='filecontents'><h2 id="0-2-0-2026-02-02">[0.2.0] - 2026-02-02</h2>
|
|
61
|
+
|
|
62
|
+
<h3 id="added">Added</h3>
|
|
63
|
+
|
|
64
|
+
<p><strong>New Endpoint Categories:</strong></p>
|
|
65
|
+
|
|
66
|
+
<ul>
|
|
67
|
+
<li><strong>Me endpoints</strong>: <code>me</code>, <code>my_teams</code>, <code>my_websites</code> - Get current user info and resources</li>
|
|
68
|
+
<li><strong>Admin endpoints</strong>: <code>admin_users</code>, <code>admin_websites</code>, <code>admin_teams</code> - Admin-only endpoints for self-hosted</li>
|
|
69
|
+
<li><strong>Sessions endpoints</strong> (8 new methods):
|
|
70
|
+
|
|
71
|
+
<ul>
|
|
72
|
+
<li><code>website_sessions</code> - Get sessions within a time range</li>
|
|
73
|
+
<li><code>website_sessions_stats</code> - Get summarized session statistics</li>
|
|
74
|
+
<li><code>website_sessions_weekly</code> - Get session counts by hour of weekday</li>
|
|
75
|
+
<li><code>website_session</code> - Get individual session details</li>
|
|
76
|
+
<li><code>website_session_activity</code> - Get session activity</li>
|
|
77
|
+
<li><code>website_session_properties</code> - Get session properties</li>
|
|
78
|
+
<li><code>website_session_data_properties</code> - Get session data property counts</li>
|
|
79
|
+
<li><code>website_session_data_values</code> - Get session data value counts</li>
|
|
80
|
+
</ul></li>
|
|
81
|
+
<li><strong>Realtime endpoint</strong>: <code>realtime</code> - Get live stats for last 30 minutes</li>
|
|
82
|
+
<li><strong>Links endpoints</strong>: <code>links</code>, <code>link</code>, <code>update_link</code>, <code>delete_link</code></li>
|
|
83
|
+
<li><strong>Pixels endpoints</strong>: <code>pixels</code>, <code>pixel</code>, <code>update_pixel</code>, <code>delete_pixel</code></li>
|
|
84
|
+
<li><strong>Reports endpoints</strong> (13 new methods):
|
|
85
|
+
|
|
86
|
+
<ul>
|
|
87
|
+
<li>CRUD: <code>reports</code>, <code>create_report</code>, <code>report</code>, <code>update_report</code>, <code>delete_report</code></li>
|
|
88
|
+
<li>Specialized: <code>report_attribution</code>, <code>report_breakdown</code>, <code>report_funnel</code>, <code>report_goals</code>, <code>report_journey</code>, <code>report_retention</code>, <code>report_revenue</code>, <code>report_utm</code></li>
|
|
89
|
+
</ul></li>
|
|
90
|
+
<li><strong>Website stats endpoints</strong>:
|
|
91
|
+
|
|
92
|
+
<ul>
|
|
93
|
+
<li><code>website_events_series</code> - Get events series with time bucketing</li>
|
|
94
|
+
<li><code>website_metrics_expanded</code> - Get detailed metrics with engagement data</li>
|
|
95
|
+
</ul></li>
|
|
96
|
+
<li><strong>Events endpoints</strong>:
|
|
97
|
+
|
|
98
|
+
<ul>
|
|
99
|
+
<li><code>website_events_list</code> - Get paginated event details</li>
|
|
100
|
+
<li><code>website_event_data</code> - Get data for individual event</li>
|
|
101
|
+
<li><code>website_event_data_events</code> - Get event data names and counts</li>
|
|
102
|
+
<li><code>website_event_data_fields</code> - Get event data fields</li>
|
|
103
|
+
<li><code>website_event_data_properties</code> - Get event properties</li>
|
|
104
|
+
<li><code>website_event_data_values</code> - Get event data values</li>
|
|
105
|
+
<li><code>website_event_data_stats</code> - Get aggregated event stats</li>
|
|
106
|
+
</ul></li>
|
|
107
|
+
</ul>
|
|
108
|
+
|
|
109
|
+
<p><strong>Configuration:</strong></p>
|
|
110
|
+
|
|
111
|
+
<ul>
|
|
112
|
+
<li><code>request_timeout=</code> setter - users can now customize timeout via <code>Umami.configure</code> block</li>
|
|
113
|
+
<li>New <code>UMAMI_CLOUD_SEND_URL</code> constant for the Cloud send endpoint URL</li>
|
|
114
|
+
<li>Optional <code>user_agent:</code> parameter to <code>send_event</code> method for custom User-Agent strings</li>
|
|
115
|
+
</ul>
|
|
116
|
+
|
|
117
|
+
<p><strong>Documentation:</strong></p>
|
|
118
|
+
|
|
119
|
+
<ul>
|
|
120
|
+
<li>Configuration Options table in README with all available options and defaults</li>
|
|
121
|
+
<li>Report Types reference table in README</li>
|
|
122
|
+
</ul>
|
|
123
|
+
|
|
124
|
+
<p><strong>Test Suite:</strong></p>
|
|
125
|
+
|
|
126
|
+
<ul>
|
|
127
|
+
<li>Comprehensive Minitest test suite with 152 tests</li>
|
|
128
|
+
<li>VCR cassettes for all read API endpoints (33 cassettes)</li>
|
|
129
|
+
<li>CI workflow for Ruby 3.3, 3.4, 4.0</li>
|
|
130
|
+
<li>~72% line and branch coverage</li>
|
|
131
|
+
</ul>
|
|
132
|
+
|
|
133
|
+
<h3 id="changed">Changed</h3>
|
|
134
|
+
|
|
135
|
+
<ul>
|
|
136
|
+
<li>Updated <code>website_metrics</code> documentation with all current metric types</li>
|
|
137
|
+
<li>Updated user role documentation to include <code>view-only</code> option</li>
|
|
138
|
+
<li>Updated team role documentation with <code>team-manager</code>, <code>team-member</code>, <code>team-view-only</code> roles</li>
|
|
139
|
+
<li>Updated <code>send_event</code> documentation with <code>tag</code> and <code>id</code> parameters</li>
|
|
140
|
+
<li>Improved filter parameter documentation across all endpoints</li>
|
|
141
|
+
<li>Added optional <code>id</code> parameter to <code>create_user</code> for UUID control</li>
|
|
142
|
+
<li>Report endpoints use <code>startDate</code>/<code>endDate</code> (ISO 8601) instead of <code>startAt</code>/<code>endAt</code> (timestamps)</li>
|
|
143
|
+
<li>Added <code>window</code> parameter to <code>report_funnel</code> for days between steps</li>
|
|
144
|
+
<li>Added <code>timezone</code> parameter (required) to <code>report_retention</code></li>
|
|
145
|
+
<li>Updated <code>unit</code> parameter to include <code>minute</code> option</li>
|
|
146
|
+
<li>Made <code>timezone</code> required for <code>website_sessions_weekly</code></li>
|
|
147
|
+
<li>Made <code>startAt</code>/<code>endAt</code> required for <code>website_session_activity</code></li>
|
|
148
|
+
</ul>
|
|
149
|
+
|
|
150
|
+
<h3 id="fixed">Fixed</h3>
|
|
151
|
+
|
|
152
|
+
<ul>
|
|
153
|
+
<li><strong>Critical</strong>: Fixed <code>send_event</code> to use correct Umami Cloud URL (<code>https://cloud.umami.is/api/send</code>)</li>
|
|
154
|
+
<li><strong>Critical</strong>: Added mandatory <code>User-Agent</code> header to <code>send_event</code> requests (fixes <a href="https://github.com/rameerez/umami-ruby/issues/2">#2</a>)</li>
|
|
155
|
+
<li>Fixed <code>send_event</code> to not send unnecessary <code>Authorization</code> header</li>
|
|
156
|
+
<li>Fixed event data endpoint paths from <code>/api/event-data/...</code> to <code>/api/websites/:websiteId/event-data/...</code></li>
|
|
157
|
+
<li>Fixed <code>verify_token</code> to use POST method instead of GET</li>
|
|
158
|
+
<li>Fixed <code>website_event_data_stats</code> return type documentation</li>
|
|
159
|
+
</ul>
|
|
160
|
+
|
|
161
|
+
<h3 id="deprecated">Deprecated</h3>
|
|
162
|
+
|
|
163
|
+
<ul>
|
|
164
|
+
<li><code>event_data_events</code> - Use <code>website_event_data_events</code> instead</li>
|
|
165
|
+
<li><code>event_data_fields</code> - Use <code>website_event_data_fields</code> instead</li>
|
|
166
|
+
<li><code>event_data_stats</code> - Use <code>website_event_data_stats</code> instead</li>
|
|
167
|
+
<li><code>users</code> - Use <code>admin_users</code> instead</li>
|
|
168
|
+
</ul>
|
|
169
|
+
|
|
170
|
+
<h2 id="0-1-3-2025-02-19">[0.1.3] - 2025-02-19</h2>
|
|
171
|
+
|
|
172
|
+
<ul>
|
|
173
|
+
<li>Bug fixes and improvements</li>
|
|
174
|
+
</ul>
|
|
61
175
|
|
|
62
176
|
<h2 id="0-1-0-2024-07-22">[0.1.0] - 2024-07-22</h2>
|
|
63
177
|
|
|
@@ -67,9 +181,9 @@
|
|
|
67
181
|
</div></div>
|
|
68
182
|
|
|
69
183
|
<div id="footer">
|
|
70
|
-
Generated on
|
|
184
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
71
185
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
72
|
-
0.9.36 (ruby-3.
|
|
186
|
+
0.9.36 (ruby-3.4.2).
|
|
73
187
|
</div>
|
|
74
188
|
|
|
75
189
|
</div>
|
data/docs/file.LICENSE.html
CHANGED
|
@@ -60,9 +60,9 @@
|
|
|
60
60
|
<div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2024 Rameerez<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the "Software"), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
|
|
61
61
|
|
|
62
62
|
<div id="footer">
|
|
63
|
-
Generated on
|
|
63
|
+
Generated on Tue Feb 3 01:30:16 2026 by
|
|
64
64
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
65
|
-
0.9.36 (ruby-3.
|
|
65
|
+
0.9.36 (ruby-3.4.2).
|
|
66
66
|
</div>
|
|
67
67
|
|
|
68
68
|
</div>
|