RudderStack’s Ruby SDK allows you to track your customer event data from your Ruby code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.
You can find this SDK in our GitHub repository.
To install the RudderStack Ruby SDK, add this line to your application's Gem file:
gem 'rudder_analytics_sync'
You can also install it yourself, as below:
gem install rudder_analytics_sync
To use the SDK, create a client instance as shown:
analytics = RudderAnalyticsSync::Client.new(write_key: WRITE_KEY, # requireddata_plane_url: DATA_PLANE_URLon_error: proc { |error_code, error_body, exception, response|# defaults to an empty proc})
You can use it as shown in the following snippet:
analytics.track(user_id: user.id,event: 'Created Account')
You can manually batch events with analytics.batch
as shown:
analytics.batch do |batch|batch.context = {...} # shared context for all eventsbatch.integrations = {...} # shared integrations hash for all eventsbatch.identify(...)batch.track(...)batch.track(...)...end
The identify
call lets you associate a user to their actions as well as captures the relevant traits or properties related to that user.
For a detailed explanation of the identify
call, please refer to our RudderStack API specification guide.
An example identify
call is as shown:
Analytics.identify(user_id: '12345',traits: { email: "#{ username.email }", friends: 1 },context: {ip: '10.81.20.10'})
The identify
method parameters are as shown:
Field | Type | Presence | Description |
| String | Optional | Sets the user ID for cases where there is no unique identifier for the user. Either |
| String | Optional, if | Unique identifier for a particular user in your database. |
| Object | Optional | Dictionary of information that provides context about a message. However, it is not directly related to the API call. |
| Object | Optional | A dictionary containing the destinations to be either enabled or disabled. |
| Date | Optional | The timestamp of the message's arrival. |
| Object | Optional | Dictionary of the traits associated with the user, such as |
The track
call lets you record the users' actions along with their associated properties. Each triggered action is called an 'event'.
For a detailed explanation of the track
call, please refer to our RudderStack API specification guide.
An example track
call is as shown:
Analytics.track(user_id: '12345',event: 'Item Sold',properties: { revenue: 9.95, shipping: 'Free' })
The track
method parameters are as described below:
Name | Type | Presence | Description |
| String | Required | The developer identification for your user |
| String | Required | Name of the event being performed by the user |
| Object | Optional | Dictionary of the properties associated with a particular event. |
| Object | Optional | Dictionary of information that provides context about a message. However, it is not directly related to the API call. |
| Date | Optional | The timestamp of the message's arrival. |
| String | Optional | Sets the user ID for cases where there is no unique identifier for the user. Either |
| Object | Optional | A dictionary containing the destinations to be either enabled or disabled. |
The page
call allows you to record the page views on your website. It also records the other relevant information about the page that is being viewed.
For a detailed explanation of the page
call, please refer to our RudderStack API specification guide.
An example page
call is as shown:
Analytics.page(user_id: userid,category: 'Food',name: 'Pizza',properties: { url: 'https://dominos.com' })
The page
method parameters are as described below:
Field | Type | Presence | Description |
| String | Optional | Sets the user ID for cases where there is no unique identifier for the user. Either |
| String | Optional, if | Unique identifier for a particular user in your database. |
| Object | Optional | Dictionary of information that provides context about a message. However, it is not directly related to the API call. |
| Object | Optional | A dictionary containing the destinations to be either enabled or disabled. |
| String | Required | Name of the page being viewed. |
| Object | Optional | Dictionary of the properties associated with the page being viewed, such as |
| Date | Optional | The timestamp of the message's arrival. |
The group
call allows you to associate an identified user to a group - either a company, project, or a team. You can also record custom traits or properties associated with that group.
For a detailed explanation of the group
call, please refer to our RudderStack API specification guide.
An example group
call is as shown:
Analytics.group(user_id: '12345',group_id: '12',traits: { name: 'Company', description: 'Software'})
The group
method parameters are as follows:
Field | Type | Presence | Description |
| String | Optional | Sets the user ID for cases where there is no unique identifier for the user. Either |
| String | Optional, if | Unique identifier for a particular user in your database. |
| Object | Optional | Dictionary of information that provides context about a message. However, it is not directly related to the API call. |
| Object | Optional | A dictionary containing the destinations to be either enabled or disabled. |
| String | Required | Unique identifier of the group, as present in your database. |
| Object | Optional | Dictionary of the properties or traits associated with the group, such as |
| Date | Optional | The timestamp of the message's arrival. |
The alias
call allows you to associate one identity with another.
alias
is an advanced method. However, it is required when managing user identities in some destinations.
An example alias
call is as shown:
Analytics.alias(previous_id: '12345', user_id: '123')
The alias
method parameters are as mentioned below:
Field | Type | Presence | Description |
| String | Optional, if | Unique identifier for a particular user in your database. |
| Object | Optional | Dictionary of information that provides context about a message. However, it is not directly related to the API call. |
| Object | Optional | A dictionary containing the destinations to be either enabled or disabled. |
| String | Required | The previous unique identifier of the user. |
| Object | Optional | Dictionary of the properties or traits associated with the group, such as |
| Date | Optional | The timestamp of the message's arrival. |
For a detailed explanation of the alias
call, please refer to our RudderStack API specification guide.
To know more about the RudderStack Node.js SDK, you can contact us. You can also start a conversation on our Slack channel; we will be happy to talk to you!