Ruby API

June / Docs

Users

Identify

Track behaviour

Companies

Identify

Track behaviour

Instant insights from any Ruby app

Installing

To install the gem from Ruby Gems into a ruby app, simply run:

1
gem install june-analytics-ruby

Configuring

Now, you must configure the June SDK with a valid API key, which you can get from your June workspace.

1
require 'june/analytics'
2

3
Analytics = June::Analytics.new({
4
                                  write_key: 'YOUR_WRITE_KEY'
5
                                })

If you're using Rails, you can create a config/initializers/analytics_ruby.rb file and add the following code:

1
require 'june/analytics'
2

3
Analytics = June::Analytics.new({
4
                                     write_key: Rails.env.production? ? ENV['JUNE_WRITE_KEY'] : 'YOUR_TEST_WRITE_KEY',
5
                                     on_error: proc { |_status, msg| print msg },
6
                                     stub: !Rails.env.production?
7
                                   })

Identifying users

You can use the identify method to identify your users. Replace USER_ID with the unique identifier for the user in your database.

1
Analytics.identify(user_id: 'USER_ID',
2
                   traits: {
3
                     email: 'test@example.com'
4
                   })

Identifying companies (optional)

You can use the group method to identify your companies. Replace GROUP_ID and USER_ID with the unique identifier for the company and user in your database.

1
Analytics.group(user_id: 'USER_ID',
2
                group_id: 'GROUP_ID',
3
                traits: {
4
                  name: 'Acme Inc'
5
                })

Send track events

In order to track user behaviour, you can use the track method.

Note: If you're identifying companies, you should pass the groupId in the track context, as shown in the example below. Replace GROUP_ID and USER_ID with the unique identifier for the company and user in your database.

1
Analytics.track(user_id: 'USER_ID',
2
                event: 'Created Account',
3
                properties: {
4
                  plan: 'Pro'
5
                },
6
                context: {
7
                  groupId: 'GROUP_ID'
8
                })

Our SDK is based on Segment's SDK. You can find more documentation here: https://segment.com/docs/connections/sources/catalog/libraries/server/ruby