gitlab-sdk 0.2.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c5951cd03dfb98fbcb92ef04436e50e984117040e59cb991a3bd8f4d8b7557e
-  data.tar.gz: 820348b1c3ba2fa2b46ca06d1660069518f827d307042c9c3536195f1da8a93e
+  metadata.gz: aea01fe6700609b32e376e19478b48d269f023e1f5276b823e4f7497c050cacb
+  data.tar.gz: a9bda3fc4c97fe8fd207144d004a8abb71fff72d81232630327461fdfbe1f835
 SHA512:
-  metadata.gz: 5fc3cb9ab2a0598948471499bc4ef79d76ff46f3c57da9316a98c2b19ea49d8c11ef4b812b7d977809417569c9581e642a2151b27b847643a215c071321123e0
-  data.tar.gz: de9b05e5bab69adc5c6e3687bbd0f88d86e71be845768d6cbf45cd6904b44eba8d93758c3f8659ab0fbc838f8f06ce61992fd8cb7ad7c7850fd467c5e2cfc25f
+  metadata.gz: 1a673a3212d5f457d1ea521944e69d338d759d8087b182859eb179b85e21918d81e228529d20dccf0b7c39a7b4ba8c350a04de5bbea636d33418ebede975bd86
+  data.tar.gz: 218fd1c7c44fd37faba7d1dff14dd106a7cabd83a5b13e2cb89f029f7b3504430641674c6249346202419b60dfd69ae7ce38aa9246c5873646dedecc08556ea4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-sdk (0.2.6)
+    gitlab-sdk (0.3.1)
       activesupport (>= 5.2.0)
       rake (~> 13.0)
       snowplow-tracker (~> 0.8.0)

data/README.md

@@ -26,9 +26,29 @@ client = GitlabSDK::Client.new(app_id: 'YOUR_APP_ID', host: 'YOUR_HOST')
 |:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|
 | `app_id`        | The ID specified in the GitLab Project Analytics setup guide. It ensures your data is sent to your analytics instance.                             |
 | `host`          | The GitLab Project Analytics instance specified in the setup guide. When using a non-standard port, includde it here, e.g. `http://localhost:9091` |
+| `buffer_size`   | Optional. Default `1`. How many events are sent in one request at a time. Setting more than `1` will change the HTTP method from `GET` to `POST`.  |
+| `async`         | Optional. Default `true`. Use `AsyncEmitter` instead of `Emitter` for non-blocking requests.                                                       |
+
+For more details see Snowplow Ruby Tracker [docs](https://snowplow.github.io/snowplow-ruby-tracker/).
 
 ## Methods
 
+### `flush`
+
+Used to manually flush all events from Snowplow Ruby Tracker's emitters, defaults to synchronous.
+
+```ruby
+# Flush events synchronously (default)
+client.flush_events
+
+# Flush events asynchronously
+client.flush_events(async: true)
+```
+
+| Property         | Type      | Description                                                               |
+|:-----------------|:----------|:--------------------------------------------------------------------------|
+| `async`          | `Boolean` | Optional. Default `false`. Use `true` to flush all events asynchronously. |
+
 ### `identify`
 
 Used to associate a user and their attributes with the session and tracking events.

data/lib/gitlab-sdk/client.rb

@@ -15,8 +15,8 @@ module GitlabSDK
 
     HostHasNoSchemeError = Class.new(StandardError)
 
-    def initialize(app_id:, host:)
-      emitter = build_emitter(host)
+    def initialize(app_id:, host:, buffer_size: 1, async: true)
+      emitter = build_emitter(host, buffer_size: buffer_size, async: async)
 
       @tracker = SnowplowTracker::Tracker.new(
         emitters: emitter,
@@ -25,7 +25,7 @@ module GitlabSDK
       )
     end
 
-    def track(event_name, event_payload)
+    def track(event_name, event_payload = {})
       self_desc_json = SnowplowTracker::SelfDescribingJson.new(
         SCHEMAS[:custom_event],
         name: event_name,
@@ -45,16 +45,31 @@ module GitlabSDK
       GitlabSDK::CurrentUser.user_attributes = user_attributes
     end
 
+    def flush_events(async: false)
+      tracker.flush(async: async)
+    end
+
     private
 
     attr_reader :tracker
 
-    def build_emitter(host)
+    def build_emitter(host, buffer_size:, async:)
       uri = URI(host)
       raise HostHasNoSchemeError unless uri.scheme
+      raise ArgumentError, 'buffer_size has to be positive' unless buffer_size.positive?
 
       endpoint = "#{uri.hostname}:#{uri.port}#{uri.path}"
-      SnowplowTracker::Emitter.new(endpoint: endpoint, options: { protocol: uri.scheme })
+      method = buffer_size > 1 ? 'post' : 'get'
+      emitter_class = async ? SnowplowTracker::AsyncEmitter : SnowplowTracker::Emitter
+
+      emitter_class.new(
+        endpoint: endpoint,
+        options: {
+          protocol: uri.scheme,
+          method: method,
+          buffer_size: buffer_size
+        }
+      )
     end
 
     def set_subject_data

data/lib/gitlab-sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitlabSDK
-  VERSION = "0.2.6"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.1
 platform: ruby
 authors:
 - GitLab
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,7 +119,7 @@ metadata:
   homepage_uri: https://gitlab.com/gitlab-org/analytics-section/product-analytics/gl-application-sdk-rb
   source_code_uri: https://gitlab.com/gitlab-org/analytics-section/product-analytics/gl-application-sdk-rb
   changelog_uri: https://gitlab.com/gitlab-org/analytics-section/product-analytics/gl-application-sdk-rb/-/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Client side Ruby SDK for GitLab Application services
 test_files: []