https://github.com/riywo/traildb-ruby
Ruby bindings for TrailDB
https://github.com/riywo/traildb-ruby
traildb
Last synced: 11 days ago
JSON representation
Ruby bindings for TrailDB
- Host: GitHub
- URL: https://github.com/riywo/traildb-ruby
- Owner: riywo
- License: mit
- Created: 2017-10-03T09:55:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-16T13:44:33.000Z (over 8 years ago)
- Last Synced: 2026-07-04T23:08:05.510Z (28 days ago)
- Topics: traildb
- Language: Ruby
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Traildb
Operate TrailDB from Ruby code using this gem.
http://traildb.io/
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'traildb'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install traildb
## Usage
```ruby
require 'traildb'
cookie = '12345678-1234-5678-1234-567812345678'
cons = Traildb::TrailDBConstructor.new('foo.tdb', ['field1', 'field2'])
cons.add(cookie, 123, ['a'])
cons.add(cookie, 124, ['b', 'c'])
tdb = cons.finalize
tdb.trails.each do |cookie, trail|
trail.each do |event|
puts "#{cookie} #{event}"
end
end
#=> 12345678-1234-5678-1234-567812345678 #
#=> 12345678-1234-5678-1234-567812345678 #
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/riywo/traildb.