gitlab-sdk 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2706a349414fe8ff7bc8da5fca1455fbd5065c60c778b412b22a98f099b8a603
-  data.tar.gz: ad8a0b829bd04bf458c96d1520b20ebfba2e1ecc786cdd0b4c6d92b53be0da8b
+  metadata.gz: 38ec160731634aef4547e601d3e8b69ad5c885963d9236e89d8eff213c28743f
+  data.tar.gz: bf4a0c6454ae9102211a1fc3e8bcd7f3bd4b928d96a4703f92f9d2bcd07a4afd
 SHA512:
-  metadata.gz: 3780750bb5628628380f4badb7df25a94ecdb2a0e7a499245742d10ac5ebdc8c33d9e99b9437c7175bf1b80927cf87e34b9eb263bf0cc4e92f05745e21547568
-  data.tar.gz: '02699c246b245ba5263a5216b279afaa0e2ca638b93f79266c240a91bb5eabe1cc4686072cdf85b9dff70672a8132e9aaf1b3c1ff3389fb7207da5db07b27c51'
+  metadata.gz: 91844d2429060c4ad01212d9306a4073e4f631296fee2361dc344dc4c8fe25147796361e348a0af567e0c0f13a287befb4427923c8238b30c5991f2a64be7ed4
+  data.tar.gz: 8cce8707020443c8dd48aae6c0de1d8cd5601b8404209d446bf53a70b5244d06e98b1f6c61745f0daef3e413d85799b14510bfeb202a40c06b47d3628c63f20f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-sdk (0.2.5)
+    gitlab-sdk (0.3.0)
       activesupport (>= 5.2.0)
       rake (~> 13.0)
       snowplow-tracker (~> 0.8.0)
@@ -38,7 +38,7 @@ GEM
     public_suffix (5.0.1)
     rack (3.0.7)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)

data/README.md

@@ -26,6 +26,10 @@ 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
 

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,
@@ -49,12 +49,23 @@ module GitlabSDK
 
     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.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - GitLab
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-01-16 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: []