gitlab-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d02a90e3d161d2e2edc18fb76a08dc011bc567d56ef7d29d62c3df22c40c3ebc
+  data.tar.gz: 15e64bfc91b0e4f23dddc7fc07d32e0906232bca06d9f4f4c36dbaa17b6c19c5
+SHA512:
+  metadata.gz: d9c5ed95c3d1bcdef50e777a04a42e64ccc6d0f4bb77fc6385e8050248d81f51c3f16f898793468512dfd90a5fd85e63f343bb4afc76b73fee0f8a73a45a8a9d
+  data.tar.gz: cf474d2e60515b417caa2230c81d24d620f464761ed835b1fa71f37968fecf327bcee8ea7a69a59ddf746e9cef149f236824baee967e03ea8c0ef89edbd8058c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-default.yml
+
+CodeReuse/ActiveRecord:
+  Exclude:
+    - spec/**/*.rb
+
+RSpec/FilePath:
+  Exclude:
+    - spec/gitlab-sdk/version_spec.rb
+  CustomTransform:
+    GitlabSDK: gitlab-sdk
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+Naming/FileName:
+  Exclude:
+    - lib/gitlab-sdk.rb

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitlab-sdk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    gitlab-sdk (0.1.0)
+      activesupport (~> 7.0)
+      rake (~> 13.0)
+      snowplow-tracker (~> 0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    gitlab-styles (10.0.0)
+      rubocop (~> 1.43.0)
+      rubocop-graphql (~> 0.18)
+      rubocop-performance (~> 1.15)
+      rubocop-rails (~> 2.17)
+      rubocop-rspec (~> 2.18)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-graphql (0.19.0)
+      rubocop (>= 0.87, < 2)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    snowplow-tracker (0.8.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  gitlab-sdk!
+  gitlab-styles (~> 10.0.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   2.3.22

data/README.md

@@ -0,0 +1,62 @@
+# GitLab Application SDK - Ruby
+
+This SDK is for using GitLab Application Services with Ruby.
+
+## How to use the SDK
+
+### Using the gem
+
+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'
+```
+
+### Using the client
+
+Initialize the client:
+
+```ruby
+client = GitlabSDK::Client.new(app_id: 'YOUR_APP_ID', host: 'YOUR_HOST')
+```
+
+## Client initialization options
+
+| Option          | Description                                                                                                                               |
+|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------|
+| `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.                                                           |
+
+## Methods
+
+### `identify`
+
+Used to associate a user and their attributes with the session and tracking events.
+
+```ruby
+client.identify('123abc', { user_name: 'Matthew' })
+```
+
+| Property         | Type     | Description                                                                   |
+|:-----------------|:---------|:------------------------------------------------------------------------------|
+| `user_id`         | `String` | The ID of the user.      |
+| `user_attributes` | `Hash` | Optional. The user attributes to add to the session and tracking events. |
+
+### `track`
+
+Used to trigger a custom event.
+
+```ruby
+client.track(event_name, event_attributes)
+```
+
+| Property          | Type      | Description                                                      |
+|:------------------|:----------|:-----------------------------------------------------------------|
+| `event_name`       | `String` | The name of the event.                                           |
+| `event_attributes` | `Hash`   | The event attributes to add to the tracked event. |
+
+## Developing with the devkit
+
+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`.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/gitlab-sdk/client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require_relative "current_user"
+require 'snowplow-tracker'
+
+module GitlabSDK
+  class Client
+    SCHEMAS = {
+      custom_event: 'iglu:com.gitlab/custom_event/jsonschema/1-0-0',
+      user_context: 'iglu:com.gitlab/user_context/jsonschema/1-0-0'
+    }.freeze
+    DEFAULT_TRACKER_NAMESPACE = 'gitlab'
+
+    def initialize(app_id:, host:)
+      emitter = SnowplowTracker::Emitter.new(endpoint: host)
+
+      @tracker = SnowplowTracker::Tracker.new(
+        emitters: emitter,
+        app_id: app_id,
+        namespace: DEFAULT_TRACKER_NAMESPACE
+      )
+    end
+
+    def track(event_name, event_payload)
+      self_desc_json = SnowplowTracker::SelfDescribingJson.new(
+        SCHEMAS[:custom_event],
+        name: event_name,
+        props: event_payload
+      )
+
+      track_arguments = { event_json: self_desc_json }
+      set_user_data(track_arguments)
+
+      tracker.track_self_describing_event(**track_arguments)
+    end
+
+    def identify(user_id, user_attributes = {})
+      GitlabSDK::CurrentUser.user_id = user_id
+      GitlabSDK::CurrentUser.user_attributes = user_attributes
+    end
+
+    private
+
+    attr_reader :tracker
+
+    def set_user_data(track_arguments)
+      set_user_id
+      set_user_context(track_arguments)
+    end
+
+    def set_user_id
+      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)
+      user_attributes = GitlabSDK::CurrentUser.user_attributes || {}
+
+      return if user_attributes.empty?
+
+      user_context = SnowplowTracker::SelfDescribingJson.new(
+        SCHEMAS[:user_context],
+        user_attributes
+      )
+      track_arguments[:context] = [user_context]
+    end
+  end
+end

data/lib/gitlab-sdk/current_user.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module GitlabSDK
+  class CurrentUser < ::ActiveSupport::CurrentAttributes
+    attribute :user_id, :user_attributes
+  end
+end

data/lib/gitlab-sdk/version.rb

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

data/lib/gitlab-sdk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "gitlab-sdk/client"

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GitLab
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: snowplow-tracker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: gitlab-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client side Ruby SDK for GitLab Application services
+email:
+- gitlab_rubygems@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/gitlab-sdk.rb
+- lib/gitlab-sdk/client.rb
+- lib/gitlab-sdk/current_user.rb
+- lib/gitlab-sdk/version.rb
+homepage: https://gitlab.com/gitlab-org/analytics-section/product-analytics/gl-application-sdk-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Client side Ruby SDK for GitLab Application services
+test_files: []