gitlab-sdk 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d02a90e3d161d2e2edc18fb76a08dc011bc567d56ef7d29d62c3df22c40c3ebc
-  data.tar.gz: 15e64bfc91b0e4f23dddc7fc07d32e0906232bca06d9f4f4c36dbaa17b6c19c5
+  metadata.gz: f7b6fd23071b9f55fa712ae849d2091563108bc5fcff52e17699ca6e2247ab2b
+  data.tar.gz: 07a37a862af1807ee7b25a2fd25eef3d991d2b54c1cf288440b55416723f7e17
 SHA512:
-  metadata.gz: d9c5ed95c3d1bcdef50e777a04a42e64ccc6d0f4bb77fc6385e8050248d81f51c3f16f898793468512dfd90a5fd85e63f343bb4afc76b73fee0f8a73a45a8a9d
-  data.tar.gz: cf474d2e60515b417caa2230c81d24d620f464761ed835b1fa71f37968fecf327bcee8ea7a69a59ddf746e9cef149f236824baee967e03ea8c0ef89edbd8058c
+  metadata.gz: 59c75ccb7af6e55324536e752f934f37fc894b68bddcb7216061b28ae5736cc8e9af5db092d082e550db1a45430ecd9edd99382fa8ccc1fe1054e8310286144c
+  data.tar.gz: 250d4d34a8ab534da48e318bcd3149746735f8cb090bad8deabcac65445f3cace997cbc44abed17ffff7dfa2ac745d2da5986cc99661f20de9ef3617ca11211a

data/.rubocop.yml

@@ -18,3 +18,7 @@ RSpec/MultipleMemoizedHelpers:
 Naming/FileName:
   Exclude:
     - lib/gitlab-sdk.rb
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 25
+  AllowSubject: true

data/Gemfile

@@ -2,5 +2,5 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in gitlab-sdk.gemspec
+# Specify your gem's dependencies in gl-application-sdk-rb.gemspec
 gemspec

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    gitlab-sdk (0.1.0)
-      activesupport (~> 7.0)
+    gitlab-sdk (0.2.1)
+      activesupport (>= 5.2.0)
       rake (~> 13.0)
       snowplow-tracker (~> 0.8.0)
 

data/README.md

@@ -9,7 +9,7 @@ This SDK is for using GitLab Application Services with Ruby.
 Add the gem to your Gemfile:
 
 ```ruby
-gem 'gitlab-sdk', '~> 0.1.0', git: 'git@gitlab.com:gitlab-org/analytics-section/product-analytics/gl-application-sdk-rb.git'
+gem 'gitlab-sdk'
 ```
 
 ### Using the client
@@ -60,3 +60,10 @@ client.track(event_name, event_attributes)
 To develop with a local Snowplow pipeline, use Analytics devkit's [Snowplow setup](https://gitlab.com/gitlab-org/analytics-section/product-analytics/devkit/-/tree/main#setup).
 
 To test the gem's functionality, run `bin/console`.
+
+## Releasing the gem
+
+To release a new version of the gem:
+
+1. Update the version in [lib/gitlab-sdk/version.rb](lib/gitlab-sdk/version.rb).
+2. After merging the MR including the changes, new version of the gem will be uploaded to [RubyGems](https://rubygems.org/gems/gitlab-sdk).

data/lib/gitlab-sdk/client.rb

@@ -11,9 +11,12 @@ module GitlabSDK
       user_context: 'iglu:com.gitlab/user_context/jsonschema/1-0-0'
     }.freeze
     DEFAULT_TRACKER_NAMESPACE = 'gitlab'
+    USERAGENT = "GitLab Analytics Ruby SDK/#{GitlabSDK::VERSION}"
+
+    HostHasNoSchemeError = Class.new(StandardError)
 
     def initialize(app_id:, host:)
-      emitter = SnowplowTracker::Emitter.new(endpoint: host)
+      emitter = build_emitter(host)
 
       @tracker = SnowplowTracker::Tracker.new(
         emitters: emitter,
@@ -30,7 +33,9 @@ module GitlabSDK
       )
 
       track_arguments = { event_json: self_desc_json }
-      set_user_data(track_arguments)
+
+      set_subject_data
+      set_user_context(track_arguments)
 
       tracker.track_self_describing_event(**track_arguments)
     end
@@ -44,17 +49,26 @@ module GitlabSDK
 
     attr_reader :tracker
 
-    def set_user_data(track_arguments)
-      set_user_id
-      set_user_context(track_arguments)
+    def build_emitter(host)
+      uri = URI(host)
+      raise HostHasNoSchemeError unless uri.scheme
+
+      SnowplowTracker::Emitter.new(endpoint: uri.hostname + uri.path, options: { protocol: uri.scheme })
     end
 
-    def set_user_id
+    def set_subject_data
+      subject = SnowplowTracker::Subject.new
+
+      set_user_id_on_subject(subject)
+      subject.set_useragent(USERAGENT)
+
+      tracker.set_subject(subject)
+    end
+
+    def set_user_id_on_subject(subject)
       user_id = GitlabSDK::CurrentUser.user_id
 
-      subject = SnowplowTracker::Subject.new
       subject.set_user_id(user_id) if user_id
-      tracker.set_subject(subject)
     end
 
     def set_user_context(track_arguments)

data/lib/gitlab-sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - GitLab
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-09-07 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.2.22
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Client side Ruby SDK for GitLab Application services
 test_files: []