Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/riywo/traildb-ruby

Ruby bindings for TrailDB
https://github.com/riywo/traildb-ruby

traildb

Last synced: 26 days ago
JSON representation

Ruby bindings for TrailDB

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.