Ruby client for the Streak REST API
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
Gemfile
LICENSE
README.rdoc
Rakefile
streak_client.gemspec

README.rdoc

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 Streak.

Usage

Set it up:

require 'streak_client'
StreakClient.api_key = YOUR_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.

Credits & License

This client was written by Kristof for the fine folks at TurningArt. It is released under the MIT license (see LICENSE).