/streak_client

Ruby client for the Streak REST API

Primary LanguageRubyBSD 2-Clause "Simplified" LicenseBSD-2-Clause

Streak Client - Ruby client for the Streak REST API

This client wraps the REST API for Streak, a Gmail CRM tool provided by the folks at Rewardly.

Usage

Set it up:

require 'streak_client'
Set ENV['STREAK_API_KEY']

Create resources:

@pipeline = StreakClient::Pipeline.create(name: "Test", description: "T")
@box = StreakClient::Box.create(@pipeline.pipelineKey, {name: "Test Box"})

Load existing resources:

@pipelines = StreakClient::Pipeline.all
@box = StreakClient::Box.find(@box.boxKey)
@boxes_in_a_pipeline = pipelines.first.boxes

Edit resources:

@box.name = "New Name"
@box.save!

Delete resources:

StreakClient::Pipeline.delete(@pipeline.pipelineKey)

TODO

The following resources are not yet supported: fields, reminders, files, search.

Contributing

Feel free to submit pull requests via Github. Include tests please.