RudderStack's Ruby SDK lets you track and send the events from your Ruby applications to the specified destinations.

SDK setup requirements

1. Sign up to RudderStack Cloud.
2. Set up a Ruby source in your dashboard. You should be able to see a write key for this source.

You will also need a data plane URL. Refer to the Dashboard Overview guide for more information on the data plane URL and where to find it.

Installing the Ruby SDK

To install the RudderStack Ruby SDK, add the following line to your application's Gem file:

Copy
gem 'rudder_analytics_sync'

You can also install it by running the following command:

Copy
gem install rudder_analytics_sync

Initializing the SDK

To initialize the SDK, create a client instance as shown below:

Copy
analytics = RudderAnalyticsSync::Client.new(
  write_key: 'WRITE_KEY', # Required
  data_plane_url: 'DATA_PLANE_URL',
  gzip: true,  # Set to false to disable Gzip compression
  on_error: proc { |error_code, error_body, exception, response|
    # defaults to an empty proc
  }
)

Batching events

To manually batch events, use Analytics.batch as shown:

Copy
Analytics.batch do |batch|
  batch.context = {...}       # shared context for all events
  batch.integrations = {...}  # shared integrations hash for all events
  batch.identify(...)
  batch.track(...)
  batch.track(...)
  ...
end

Gzipping requests

The Ruby SDK automatically gzips requests. However, you can disable this feature by setting the Gzip parameter to false while initializing the SDK, as shown:

Copy
analytics = RudderAnalyticsSync::Client.new(
  write_key: 'WRITE_KEY', # required
  data_plane_url: 'DATA_PLANE_URL',
  gzip: false, // Set to true to enable Gzip compression
  on_error: proc { |error_code, error_body, exception, response|
    # defaults to an empty proc
  }
)

Sending events

Identify

The identify call lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.

A sample identify call made using the Ruby SDK is shown below:

Copy
Analytics.identify(
  user_id: '1hKOmRA4GRlm',
  traits: { email: "alex@example.com", friends: 1 },
  context: {ip: '10.81.20.10'}
)

The identify method parameters are as shown:

Track

The track call lets you record the user actions along with their associated properties. Each user action is called an event.

A sample track call is shown below:

Copy
Analytics.track(
  user_id: '1hKOmRA4GRlm',
  event: 'Item Sold',
  properties: { revenue: 9.95, shipping: 'Free' }
)

The track method parameters are as described below:

Page

The page call lets you record the page views on your application along with the other relevant information about the page.

A sample page call is as shown:

Copy
Analytics.page(
  user_id: `1hKOmRA4GRlm`,
  category: 'Food',
  name: 'Pizza',
  properties: { url: 'https://dominos.com' }
)

The page method parameters are as described below:

Screen

The screen call is the mobile equivalent of the page call. It lets you record the screen views on your mobile app along with other relevant information about the screen.

A sample screen call is as shown:

Copy
Analytics.screen(
  user_id: `1hKOmRA4GRlm`,
  category: 'Food',
  name: 'Pizza',
  properties: { url: 'https://dominos.com' }
)

The screen method parameters are as described below:

Group

The group call lets you link an identified user with a group, such as a company, organization, or an account. It also lets you record any custom traits or properties associated with that group.

A sample group call made using the Ruby SDK is shown below:

Copy
Analytics.group(
  user_id: '1hKOmRA4GRlm',
  group_id: '12',
  traits: { name: 'Company', description: 'Software'}
)

The group method parameters are as follows:

Alias

The alias call lets you merge different identities of a known user. It is an advanced method that lets you change the tracked user's ID explicitly. You can use alias for managing the user's identity in some of the downstream destinations.

A sample alias call is as shown:

Copy
Analytics.alias(previous_id: '1hKOmRA4GRlm', user_id: '12345')

The alias method parameters are as mentioned below: