rudder_analytics_sync 1.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 157030c6f0cb2352bf8efda032c35fd760fdbf6f
-  data.tar.gz: 59af93b4a244d8836f766995901e16cba9a24489
+SHA256:
+  metadata.gz: fb211e617c13d145525cadb6d595b2685ac6cb6344cbb24f68770c3b0dc1ad9b
+  data.tar.gz: 18f1e329449195fe5547fe385d7a9b029bd412f8c9c7c2eb7c21bd9a15f516ed
 SHA512:
-  metadata.gz: 4f66625ad1e88c3bb0c36790e606b86c207914cd35e6a6641883ddd33ab39c3bb176c81b9cd33325ac68c558f0260da42f40d0b019316d1b420eca1eb2f6afc3
-  data.tar.gz: 2b5ff7739615de79136ac718a89f975ffde9a7972c8aa6e48baf1034cd1aa72377c8e232fefe6c7d5271f6da108f6b557e52f0a22d68bdadbc33b58c87460d35
+  metadata.gz: 9e4a3abb0d9b46a5808ac8e56ce3af55e275dea61bac56ef029e04fb26fcd0b1dbfd5a4ac1206829e31c724476ec89e277bf67bc179590dd7800dfc3bcc5953c
+  data.tar.gz: dc207499b0f313f0ab6442766070875e7855500d03f662e199a25bf65464439021fcef32b8611309ca63a6f315048fb1e418372d3c74c1891e935869ecb37321

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+# Description
+
+< Replace with adequate description for this PR>

data/.github/workflows/build-and-quality-checks.yml

@@ -0,0 +1,31 @@
+name: Code Quality Checks
+on:
+  pull_request:
+    branches: ['master']
+    types: ['opened', 'reopened', 'synchronize']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+        
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+      # - name: Install rubocop
+      #   run: gem install rubocop
+      # - name: Install rubocop-rspec
+      #   run: gem install rubocop-rspec
+      # - name: Install rubocop-performance
+      #   run: gem install rubocop-performance
+      # - name: Install rubocop-rails
+      #   run: gem install rubocop-rails
+      # - name: Execute linting
+      #   run: bundle exec rubocop

data/.github/workflows/check-pr-title.yml

@@ -0,0 +1,16 @@
+name: Check PR title
+on:
+  pull_request:
+    branches: ['master']
+    types: ['opened', 'reopened', 'edited', 'synchronize']
+
+jobs:
+  check_pr_title:
+    name: Check PR title
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source branch
+        uses: actions/checkout@v3
+
+      - name: Check PR title
+        uses: rudderlabs/github-action-check-pr-title@v1.0.7

data/.github/workflows/notion-pr-sync.yml

@@ -0,0 +1,55 @@
+name: Notion PR Sync
+
+on:
+  issues:
+    types:
+      [
+        opened,
+        edited,
+        deleted,
+        transferred,
+        pinned,
+        unpinned,
+        closed,
+        reopened,
+        assigned,
+        unassigned,
+        labeled,
+        unlabeled,
+        locked,
+        unlocked,
+        milestoned,
+        demilestoned,
+      ]
+  pull_request:
+    types:
+      [
+        assigned,
+        unassigned,
+        labeled,
+        unlabeled,
+        opened,
+        edited,
+        closed,
+        reopened,
+        synchronize,
+        converted_to_draft,
+        ready_for_review,
+        locked,
+        unlocked,
+        review_requested,
+        review_request_removed,
+        auto_merge_enabled,
+        auto_merge_disabled,
+      ]
+
+jobs:
+  request:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Sync Github PRs to Notion
+        uses: sivashanmukh/github-notion-pr-sync@1.0.0
+        with:
+          notionKey: ${{ secrets.NOTION_BOT_KEY }}
+          notionDatabaseId: ${{ secrets.NOTION_PR_DB_ID }}
+          githubKey: ${{ secrets.PAT }}

data/.github/workflows/slack-notify.yml

@@ -0,0 +1,41 @@
+name: Notify Slack Channel
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy-tag:
+    name: Notify Slack
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send message to Slack channel
+        id: slack
+        uses: slackapi/slack-github-action@v1.23.0
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+          PROJECT_NAME: 'Ruby(Sync) SDK'
+        with:
+          channel-id: "${{ secrets.SLACK_RELEASE_CHANNEL_ID }}"
+          payload: |
+            {
+              "blocks": [
+                {
+                  "type": "header",
+                  "text": {
+                    "type": "plain_text",
+                    "text": "New release: ${{ env.PROJECT_NAME }}"
+                  }
+                },
+                {
+                  "type": "divider"
+                },
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "*Release: <${{ github.event.release.html_url }}|${{ github.event.release.tag_name }}>*"
+                  }
+                }
+              ]
+            }

data/.gitignore

@@ -6,4 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
-Gemfile.lock
+Gemfile.lock
+*.DS_Store
+local_config.yaml
+.vscode/

data/.hound.yml

@@ -1,3 +1,3 @@
 rubocop:
   config_file: .rubocop.yml
-  version: 0.75.0
+  version: 1.42

data/.rubocop.yml

@@ -1,12 +1,38 @@
+require: rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'spec/**/*'
+    - 'example/**/*'
+
 Metrics/BlockLength:
   Exclude:
-    - '**/*_spec.rb'
+    - 'spec/**/*'
+    - 'example/**/*'
 
-Metrics/LineLength:
-  Max: 100
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'spec/**/*'
+    - 'example/**/*'
+
+Style/FormatStringToken:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 200
   IgnoreCopDirectives: true
   Exclude:
-    - 'simple_segment.gemspec'
+    - 'rudder_analytics_sync.gemspec'
 
 Style/Documentation:
   Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 200
+
+Style/IfUnlessModifier:
+  Enabled: false

data/CODEOWNERS

@@ -0,0 +1 @@
+* @pallabmaiti @bardisg

data/Gemfile

@@ -2,5 +2,6 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in simple_segment.gemspec
+# Specify your gem's dependencies in rudder_analytics_sync.gemspec
+# gem 'debug'
 gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 RudderStack
+Copyright (c) 2016 Mikhail Topolskiy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,58 +1,108 @@
-# What is Rudder?
+<p align="center">
+  <a href="https://rudderstack.com/">
+    <img src="https://user-images.githubusercontent.com/59817155/121357083-1c571300-c94f-11eb-8cc7-ce6df13855c9.png">
+  </a>
+</p>
 
-**Short answer:** 
-Rudder is an open-source Segment alternative written in Go, built for the enterprise. .
+<p align="center"><b>The Customer Data Platform for Developers</b></p>
 
-**Long answer:** 
-Rudder is a platform for collecting, storing and routing customer event data to dozens of tools. Rudder is open-source, can run in your cloud environment (AWS, GCP, Azure or even your data-centre) and provides a powerful transformation framework to process your event data on the fly.
+<p align="center">
+  <b>
+    <a href="https://rudderstack.com">Website</a>
+    ·
+    <a href="https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-ruby-sdk/">Documentation</a>
+    ·
+    <a href="https://rudderstack.com/join-rudderstack-slack-community">Community Slack</a>
+  </b>
+</p>
 
-Released under [MIT License 2.0](https://opensource.org/licenses/MIT)
+<p align="center"><a href="https://rubygems.org/gems/rudder_analytics_sync/"><img src="https://img.shields.io/gem/v/rudder_analytics_sync?style=flat"/></a></p>
+
+----
+
+# RudderStack Ruby SDK
+
+The RudderStack Ruby SDK lets you send customer event data from your Ruby applications to your specified destinations.
+
+## SDK setup requirements
+
+- Set up a [RudderStack open source](https://app.rudderstack.com/signup?type=opensource) account.
+- Set up a Ruby source in the dashboard.
+- Copy the write key and the data plane URL. For more information, refer to the [Ruby SDK documentation](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-ruby-sdk/#sdk-setup-requirements).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install the RudderStack Ruby SDK, add this line to your application's Gem file:
 
 ```ruby
 gem 'rudder_analytics_sync'
 ```
 
-Or install it yourself as:
+You can also install it yourself by running the following command:
 
-```sh
-$ gem install rudder_analytics_sync
+```bash
+gem install rudder_analytics_sync
 ```
 
-## Usage
+## Using the SDK
 
-Create a client instance:
+To use the Ruby SDK, create a client instance as shown:
 
 ```ruby
 analytics = RudderAnalyticsSync::Client.new(
-  write_key: <YOUR_WRITE_KEY>, # required
-  data_plane_url: <DATA_PLANE_URL>
+  write_key: 'WRITE_KEY', # Required
+  data_plane_url: 'DATA_PLANE_URL',
+  stub: false,
+  gzip: true,  # Set to false to disable Gzip compression
   on_error: proc { |error_code, error_body, exception, response|
     # defaults to an empty proc
   }
 )
 ```
 
-Use it as you would use `analytics-ruby`:
+You can then use this client to send the events. A sample `track` call sent using the client is shown below:
 
 ```ruby
 analytics.track(
-  user_id: user.id,
-  event: 'Created Account'
+  user_id: 12345,
+  event: 'Test Event'
+)
+```
+
+## Gzip support
+
+From version 2.0.0, the Ruby SDK supports Gzip compression and it is enabled (set to `true`) by default. However, you can disable this feature by setting the `Gzip` parameter to `false` while initializing the SDK, as shown:
+
+```ruby
+analytics = RudderAnalyticsSync::Client.new(
+  write_key: 'WRITE_KEY', # required
+  data_plane_url: 'DATA_PLANE_URL',
+  stub: false,
+  gzip: false, // Set to true to enable Gzip compression
+  on_error: proc { |error_code, error_body, exception, response|
+    # defaults to an empty proc
+  }
 )
 ```
 
-### Batching
+| Note: Gzip requires `rudder-server` version 1.4 or later. |
+| :-----|
 
-You can manually batch events with `analytics.batch`:
+## Sending events
+
+Refer to the [RudderStack Ruby SDK documentation](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-ruby-sdk/) for more information on the supported event types.
+
+| From version 2.0.0, the Ruby SDK supports [`screen`](https://www.rudderstack.com/docs/event-spec/standard-events/screen/) events. |
+| :-----|
+
+### Manually batching events
+
+You can manually batch your events using `analytics.batch`, as shown:
 
 ```ruby
 analytics.batch do |batch|
-  batch.context = {...}       # shared context for all events
-  batch.integrations = {...}  # shared integrations hash for all events
+  batch.context = {...}       # Shared context for all the events
+  batch.integrations = {...}  # Shared integrations hash for all the events
   batch.identify(...)
   batch.track(...)
   batch.track(...)
@@ -60,5 +110,6 @@ analytics.batch do |batch|
 end
 ```
 
-## Contact Us
-If you come across any issues while configuring or using RudderStack, please feel free to [contact us](https://rudderstack.com/contact/) or start a conversation on our [Discord](https://discordapp.com/invite/xNEdEGw) channel. We will be happy to help you.
+## License
+
+The RudderStack Ruby SDK is released under the [MIT license](https://github.com/rudderlabs/rudder-sdk-ruby-sync/blob/feat/latest-pull/LICENSE.txt).

data/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Reporting
+
+Thank you in advance for helping us keep RudderStack secure!
+
+Please report any security issues or vulnerabilities to [security@rudderstack.com](mailto:security@rudderstack.com), before proceeding to post them publicly as issues on GitHub or any other public channel like the RudderStack community Slack. These issues might also affect other users, and security vulnerabilities need to be handled quickly and sometimes privately.
+
+We will triage the issue, contact you for further instructions and make sure to take any necessary measures as needed.
+
+## Supported versions
+
+We will fix any security bugs for the latest major.minor version published in the [Docker Hub](https://hub.docker.com/r/rudderlabs/rudder-server).
+
+| Version | Supported |
+| :-------| :---------|
+| Latest 1.x | ✅ |
+| Older 1.x | ❌ |
+| < 1.0 | ❌ |
+
+We may fix the vulnerabilities in the older versions depending on the severity of the issue and the age of the release, but we are only committing to the latest version released.

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'simple_segment'
+require 'rudder_analytics_sync'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/example/example.rb

@@ -1,53 +1,163 @@
+# frozen_string_literal: true
+
 require 'rudder_analytics_sync'
+require 'yaml'
+require 'date'
+
+def uid
+  arr = SecureRandom.random_bytes(16).unpack('NnnnnN')
+  arr[2] = (arr[2] & 0x0fff) | 0x4000
+  arr[3] = (arr[3] & 0x3fff) | 0x8000
+  '%08x-%04x-%04x-%04x-%04x%08x' % arr
+end
 
-include RudderAnalyticsSync
+local_config = YAML.safe_load(File.read('example/local_config.yaml'))
+
+ENV['WRITE_KEY'] = local_config['WRITE_KEY']
+ENV['DATA_PLANE_URL'] = local_config['DATA_PLANE_URL']
+ENV['LOCAL_DATA_PLANE_URL'] = local_config['LOCAL_DATA_PLANE_URL']
 
 analytics = RudderAnalyticsSync::Client.new(
-  write_key: '1aJDXU7xlQpUp6qW1ppTJTvkgSi', # required
-  data_plane_url: 'https://86143ed0.ngrok.io',
-  stub: true,
+  write_key: ENV['WRITE_KEY'], # required
+  data_plane_url: ENV['LOCAL_DATA_PLANE_URL'],
+  # logger: Logger::DEBUG,
+  gzip: false,
   on_error: proc { |error_code, error_body, exception, response|
     # defaults to an empty proc
   }
 )
 
-# analytics.track(
-#   user_id: 'test_user_id',
-#   event: 'Created Account'
-# )
+properties = {
+  library: {
+    application: 'Rudder Desktop',
+    version: '1.1.0',
+    platform: 'osx'
+  }
+}
+
+traits = {
+  firstname: 'First',
+  lastname: 'Last',
+  Role: 'Jedi',
+  age: 25
+}
+
+user_id = '123456'
+anonymous_id = uid
+
+context = {
+  screen: {
+    width: 852,
+    height: 393,
+    density: 3
+  },
+  os: {
+    name: 'macOS',
+    version: '2.0.0'
+  },
+  locale: 'en-US'
+}
+
+context_with_library = {
+  screen: {
+    width: 852,
+    height: 393,
+    density: 3
+  },
+  os: {
+    name: 'macOS',
+    version: '2.0.0'
+  },
+  locale: 'en-US',
+  library: {
+    name: 'analytics-random-sdk',
+    version: '1.0.0.beta.1'
+  }
+}
+
+analytics.track(
+  user_id: user_id,
+  event: 'Test Track',
+  anonymous_id: anonymous_id,
+  properties: properties,
+  context: context
+)
+
+analytics.screen(
+  user_id: user_id,
+  name: 'Test Screen',
+  anonymous_id: anonymous_id,
+  properties: properties,
+  context: context
+)
+
+analytics.identify(
+  user_id: '654321',
+  traits: traits,
+  context: context
+)
+
+analytics.group(
+  user_id: user_id,
+  group_id: uid,
+  anonymous_id: anonymous_id,
+  traits: traits,
+  context: context
+)
+
+analytics.alias(
+  user_id: user_id,
+  previous_id: '654321',
+  context: context
+)
+
+analytics.page(
+  user_id: user_id,
+  name: 'Test Page',
+  anonymous_id: anonymous_id,
+  properties: properties,
+  context: context
+)
 
 analytics.batch do |batch|
-  batch.context = { source: "test"}
+  batch.context = context_with_library
   batch.integrations = { All: false, S3: true }
-  batch.track({ event: "test" })
-  batch.identify({ user_id: "test" })
-  batch.screen({ user_id: "test", name: 'test'})
-  batch.page({ user_id: "test", name: 'test'})
-  batch.alias({ user_id: "test", previous_id: 'test'})
-  batch.group({ group_id: "test" })
-  # batch.track(
-  #   user_id: 'test_user_id',
-  #   event: 'Created Account'
-  # )
-  # batch.page(
-  #   user_id: 'test_user_id',
-  #   name: 'Created Account',
-  #   properties: {
-  #     k1: 'v1'
-  #   }
-  # )
-  # batch.track(
-  #   user_id: 'test_user_id',
-  #   event: 'Closed Account'
-  # )
-  # batch.identify(
-  #   user_id: 'test_user_id_1',
-  #   traits: {
-  #     name: 'test'
-  #   }
-  # )
-  # batch.group(
-  #   user_id: 'test_user_id',
-  #   group_id: 'group_id'
-  # )
-end
+
+  batch.track(
+    user_id: user_id,
+    event: 'Test Track',
+    anonymous_id: anonymous_id,
+    properties: properties
+  )
+
+  batch.screen(
+    user_id: user_id,
+    name: 'Test Screen',
+    anonymous_id: anonymous_id,
+    properties: properties
+  )
+
+  batch.identify(
+    user_id: '654321',
+    traits: traits
+  )
+
+  batch.group(
+    user_id: user_id,
+    group_id: uid,
+    anonymous_id: anonymous_id,
+    traits: traits
+  )
+
+  batch.alias(
+    user_id: user_id,
+    previous_id: '654321'
+  )
+
+  batch.page(
+    user_id: user_id,
+    name: 'Test Page',
+    anonymous_id: anonymous_id,
+    properties: properties
+  )
+end