worldsmithroy/togglv8

Ruby wrapper for Toggl API v8

Toggl API v8

Toggl is a time tracking tool.

togglv8 is a Ruby Wrapper for Toggl API v8. It is designed to mirror the Toggl API as closely as possible.

Note: Currently togglv8 only includes calls to Toggl API, not the Reports API

Installation

Add this line to your application's Gemfile:

gem 'togglv8'

And then execute:

$ bundle

Or install it yourself as:

$ gem install togglv8

Usage

This short example shows one way to create a time entry for the first workspace of the user identified by <API_TOKEN>:

require 'togglv8'

toggl_api    = TogglV8::API.new(<API_TOKEN>)
user         = toggl_api.me(all=true)
workspaces   = toggl_api.my_workspaces(user)
workspace_id = workspaces.first['id']
toggl_api.create_time_entry({description: "Workspace time entry",
        wid: workspace_id,
        duration: 1200,
        start: "2015-08-18T01:13:40.000Z",
        created_with: "My awesome Ruby application"})

See specs for more examples.

Documentation

Run rdoc to generate documentation. Open doc/index.html in your browser.

Also available on DocumentUp

Test Coverage

Open coverage/index.html to see test coverage.

As of 2015-08-21, coverage is "90.39% covered at 6.16 hits/line" according to SimpleCov.

Acknowledgements

• Thanks to Koen Van der Auwera for the Ruby Wrapper for Toggl API v6
• Thanks to the Toggl team for exposing the API.

Contributing

1. Fork it ( https://github.com/[my-github-username]/togglv8/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

Copyright (c) 2013-2015 Tom Kane. Released under the MIT License. See LICENSE.txt for details.