Project

seline

0.0
The project is in a healthy, maintained state
Ruby wrapper for seline.so API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Seline

Seline is a Ruby gem that provides a simple wrapper for the Seline analytics API. It allows you to easily track events and set user data in your Ruby or Rails applications.

Installation

Add this line to your application's Gemfile:

gem 'seline'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install seline

Configuration

For Rails applications

Create an initializer file config/initializers/seline.rb:

Seline.configure do |config|
  config.token = 'your-api-token'
end

For non-Rails applications

Configure the gem at the start of your application:

require 'seline'

Seline.configure do |config|
  config.token = 'your-api-token'
end

Usage

Create user profile

Seline.set_user(user_id: 'sk-123', email: 'john@example.com', properties: { name: 'John Doe' })

Tracking events

Seline.track(event: 'user: signed up', user_id: 'sk-123', properties: { plan: 'free' })

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/seline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Seline project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.