Skip to content

worldsmithroy/togglv8

This branch is 3 commits ahead of, 91 commits behind kanet77/togglv8:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3488ece · Jun 21, 2016
Jun 21, 2016
Aug 22, 2015
Aug 21, 2015
Aug 21, 2015
Aug 18, 2015
Aug 18, 2015
Aug 21, 2015
Aug 12, 2013
Aug 18, 2015
Aug 18, 2015
Aug 21, 2015
Aug 19, 2015
Aug 21, 2015

Repository files navigation

Toggl API v8

Build Status Coverage Status

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

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.

About

Ruby wrapper for Toggl API v8

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%