toggl_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c85d613997879ceca21022bec6c8cf78a0e9938
+  data.tar.gz: 463fdeecfe329b23d3a1a742db36f75df98fbe55
+SHA512:
+  metadata.gz: 8acad8db1ca172e743b2b21e50374b5b4fe226ea39165c89ce71b548471533849e6910a7f6600c5b2cf3b3d8b23a77e64539c407b7e14882c82ecf80371f19a5
+  data.tar.gz: 6c0d282164bc046e159c4ce1e6f8eacbdc9f41594ca5a64037ff77f131b6f98a6b7d319a711a60727c6124091d7fd0c3d5ed19b296e82139b848995fec940ba9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://ruby.taobao.org'
+
+# Specify your gem's dependencies in toggl_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Kang Wen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kang Wen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+Toggl API Ruby Client
+=======
+# TogglApi
+
+A Ruby interface to the [Toggl](https://github.com/toggl/toggl_api_docs/blob/master/toggl_api.md) and [Reports](https://github.com/toggl/toggl_api_docs/blob/master/reports.md) API 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'toggl_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install toggl_api
+
+## Usage
+
+### Base Api
+
+     base = Toggl::Base.new "2a9800b95ef1d8d2b61d630f5df448f8" 
+
+     base.me(true) ##will return current user data with related data, default is false
+
+     base.time_entries(Date.today) ##return today's entries
+
+     entries = base.time_entries(Date.today - 1, Date.today) ##return yesterday's entries
+     entries.first.description ##get description for the first entry
+
+### Report Api
+
+     report = Toggl::Report.new "2a9800b95ef1d8d2b61d630f5df448f8" 
+
+     report.weekly('wid')
+     report.details('wid')
+     report.summary('wid')
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/toggl_api.rb

@@ -0,0 +1,7 @@
+require 'multi_json'
+require 'faraday'
+require 'hashie'
+
+require "toggl_api/version"
+require 'toggl_api/base'
+require 'toggl_api/report'

data/lib/toggl_api/api/client.rb

@@ -0,0 +1,42 @@
+module Toggl
+  module Api
+    module Client
+
+      #*name*: The name of the client (string, required, unique in workspace)
+      #*wid*:  workspace ID, where the client will be used (integer, required)
+      # notes: Notes for the client (string, not required)
+      # hrate: The hourly rate for this client (float, not required, available only for pro workspaces)
+      # cur:   The name of the client's currency (string, not required, available only for pro workspaces)
+      # at:    timestamp that is sent in the response, indicates the time client was last updated
+
+      def create_client(name, wid,options={})
+        post "/clients", {"client" => {"name"=>name,"wid"=>wid}.merge(options)}
+      end
+
+      def get_client(cid)
+        get "/clients/#{cid}"
+      end
+      alias :client :get_client
+
+      def get_clients
+        get "/clients"
+      end
+      alias :clients :get_clients
+
+      def get_client_projects(cid,active=true)
+        get "clients/#{cid}/projects",{:active => active}
+      end
+      alias :client_projects :get_client_projects
+
+      def update_client(cid,options)
+        options = Hashie::Mash.new options
+        put "/clients/#{cid}", (options.key?(:client) ? options : {:client => options})
+      end
+
+      def delete_client(cid)
+        delete "/clients/#{cid}"
+      end
+
+    end 
+  end 
+end 

data/lib/toggl_api/api/project.rb

@@ -0,0 +1,46 @@
+module Toggl
+  module Api
+    module Project
+
+      #  *name*:           The name of the project (string, required, unique for client and workspace)
+      #  *wid*:            workspace ID, where the project will be saved (integer, required)
+      #   cid:             client ID(integer, not required)
+      #   active:          whether the project is archived or not (boolean, by default true)
+      #   is_private:      whether project is accessible for only project users or for all workspace users (boolean, default true)
+      #   template:        whether the project can be used as a template (boolean, not required)
+      #   template_id:     id of the template project used on current project's creation
+      #   billable:        whether the project is billable or not (boolean, default true, available only for pro workspaces)
+      #   auto_estimates:  whether the esitamated hours is calculated based on task esimations or is fixed manually(boolean, default false, not required, premium functionality)
+      #   estimated_hours: if auto_estimates is true then the sum of task estimations is returned, otherwise user inserted hours (integer, not required, premium functionality)
+      #   at:              timestamp that is sent in the response for PUT, indicates the time task was last updated
+
+      def create_project(name, wid, options={})
+        post "/projects", {"project" =>{"name"=>name,"wid"=>wid}.merge(options)}
+      end
+
+      def update_project(pid, option)
+        options = Hashie::Mash.new options
+        put "/projects/#{pid}", (options.key?(:project) ? options : {:project => options})
+      end
+
+      def get_project(pid)
+        get "/projects/#{pid}"
+      end
+
+      alias :project :get_project
+
+      def get_project_users(pid)
+        get "/projects/#{pid}/project_users"
+      end
+      alias :project_users :get_project_users
+
+      def delete_project(pid)
+        pid = pid.join(',') if pid.is_a?(Array)
+        delete "/projects/#{pid}"
+      end
+
+      alias :bulk_delete_projects :delete_project
+
+    end 
+  end 
+end 

data/lib/toggl_api/api/project_user.rb

@@ -0,0 +1,38 @@
+module Toggl
+  module Api
+    module ProjectUser
+
+      #  *pid*:   project ID (integer, required)
+      #  *uid*:   user ID, who is added to the project (integer, required)
+      #  wid:     workspace ID, where the project belongs to (integer, not-required, project's workspace id is used)
+      #  manager: admin rights for this project (boolean, default false)
+      #  rate:    hourly rate for the project user (float, not-required, only for pro workspaces) in the currency of the project's client or in workspace default currency.
+      #  at:      timestamp that is sent in the response, indicates when the project user was last updated
+      #  
+      #  #Workspace id (wid), project id (pid) and user id (uid) can't be changed on update.
+
+      def create_project_user(pid,uids,options={})
+        uids = uids.join(',') if uids.is_a? Array
+        post "/project_users", {"project_user"=>{"pid"=>pid,"uid"=>uids,"fields"=>"fullname"}.merge(options)}
+      end
+
+      alias :bulk_create_project_users :create_project_user
+
+      def update_project_user(uids, options)
+        options = Hashie::Mash.new options
+        options.merge!({"fields" =>  "fullname"})
+        uids = uids.join(',') if uids.is_a? Array
+        put "/project_users/#{uids}", (options.key?(:project_user) ? options : {:project_user => options})
+      end
+
+      alias :bulk_update_project_users :update_project_user
+
+      def delete_project_user(uids)
+        uids = uids.join(',') if uids.is_a? Array
+        delete "/project_users/#{uids}"
+      end
+
+      alias :bulk_delete_project_users :delete_project_user 
+    end
+  end 
+end 

data/lib/toggl_api/api/tag.rb

@@ -0,0 +1,24 @@
+module Toggl
+  module Api
+    module Tag
+
+      #  *name*: The name of the tag (string, required, unique in workspace)
+      #  *wid*:  workspace ID, where the tag will be used (integer, required)
+
+      def create_tag(name,wid)
+        post "/tags", {"tag" => {"name" => name,"wid" =>wid}}
+      end
+
+      #tag wid can't be changed.
+      #only name can be updated
+      def update_tag_name(tag_id, name)
+        put "/tags/#{tag_id}", {"tag" => {"name" => name}}
+      end
+
+      def delete_tag(tag_id)
+        delete "/tags/#{tag_id}"
+      end
+
+    end 
+  end 
+end 

data/lib/toggl_api/api/task.rb

@@ -0,0 +1,38 @@
+module Toggl
+  module Api
+    module Task
+
+      #  *name*:             The name of the task (string, required, unique in project)
+      #  *pid*:              project ID for the task (integer, required)
+      #   wid:               workspace ID, where the task will be saved (integer, project's workspace id is used when not supplied)
+      #   uid:               user ID, to whom the task is assigned to (integer, not required)
+      #   estimated_seconds: estimated duration of task in seconds (integer, not required)
+      #   active:            whether the task is done or not (boolean, by default true)
+      #   at:                timestamp that is sent in the response for PUT, indicates the time task was last updated
+
+      def create_task(name, pid, options={})
+        post "/tasks", {"tag" => {"name" => name,"pid" =>pid}.merge(options)}
+      end
+
+      def get_task(tid)
+        get "/tasks/#{tid}"
+      end
+      alias :task :get_task
+
+      def update_task(tids, options)
+        options = Hashie::Mash.new options
+        tids = tids.join(',') if tids.is_a?(Array)
+        put "/tasks/#{tids}",(options.key?(:task) ? options : {:task => options})
+      end
+
+      alias :bulk_update_tasks :update_task
+
+      def delete_task(tid)
+        tids = tids.join(',') if tids.is_a?(Array)
+        delete "/tasks/#{tids}"
+      end
+      alias :bulk_delete_tasks :delete_task
+
+    end 
+  end 
+end 

data/lib/toggl_api/api/time_entry.rb

@@ -0,0 +1,73 @@
+module Toggl
+  module Api
+    module TimeEntry
+
+      #  *description*:  (string, required)
+      #  *wid*:          workspace ID (integer, required if pid or tid not supplied)
+      #  *pid*:          project ID (integer, not required)
+      #  *tid*:          task ID (integer, not required)
+      #  *start*:        time entry start time (string, required, ISO 8601 date and time)
+      #  *duration*:     time entry duration in seconds. If the time entry is currently running, the duration attribute contains a negative value, denoting the start of the time entry in seconds since epoch (Jan 1 1970). The correct duration can be calculated as current_time + duration, where current_time is the current time in seconds since epoch. (integer, required)
+      #  *created_with*: the name of your client app (string, required)
+      #   stop:          time entry stop time (string, not required, ISO 8601 date and time)
+      #   billable:      (boolean, not required, default false, available for pro workspaces)
+      #   tags:          a list of tag names (array of strings, not required)
+      #   duronly:       should Toggl show the start and stop time of this time entry? (boolean, not required)
+      #   at:            timestamp that is sent in the response, indicates the time item was last updated
+
+      def create_time_entry(options)
+        options = options.merge({:created_with => "Toggl Api Ruby Gem #{Toggl::VERSION}"})
+        post "/time_entries", (options.key?(:time_entry) ? options : {:time_entry => options})
+      end
+
+      def start_time_entry(options)
+        options = Hashie::Mash.new options
+        post "/time_entries/start", (options.key?(:time_entry) ? options : {:time_entry => options})
+      end
+
+      def stop_time_entry(tid)
+        put "/time_entries/#{tid}/stop"
+      end
+
+      def get_time_entry(tid)
+        get "/time_entries/#{tid}"
+      end
+      alias :time_entry :get_time_entry
+
+      def iso8601_date(date)
+        case date
+        when Time,Date
+          iso = date.to_datetime.iso8601
+        when String
+          iso = DateTime.parse(date).iso8601
+        else
+          raise ArgumentError, "Can't convert #{date.class} to ISO-8601 Date/Time"
+        end
+      end
+
+      #default return last 9 days time entries
+      def get_time_entries(start_date=nil, end_date=nil)
+        options = Hash.new
+        options["start_date"] = iso8601_date(start_date) if start_date
+        options["end_date"] = iso8601_date(end_date) if end_date
+        get "/time_entries", options
+      end
+
+      alias :time_entries :get_time_entries
+
+      def update_time_entry(tid,options)
+        tid = tid.join(",") if tid.is_a? Array
+        options = Hashie::Mash.new options
+        put "/time_entries/#{tid}", (options.key?(:time_entry) ? options : {:time_entry => options})
+      end
+
+      alias :bulk_update_time_entries :update_time_entry
+
+      def delete_time_entry(tid)
+        delete "/time_entries/#{tid}"
+      end
+
+    end
+  end
+end
+

data/lib/toggl_api/api/user.rb

@@ -0,0 +1,46 @@
+module Toggl
+  module Api
+    module User
+
+      #pass related_data as true to all related data
+      def me(related_data=false)
+        get "/me",{:with_related_data => related_data }
+      end
+
+      # You can update the following user fields:
+      # fullname: string
+      # email: string, valid email
+      # send_product_emails: boolean
+      # send_weekly_report: boolean
+      # send_timer_notifications: boolean
+      # store_start_and_stop_time: boolean
+      # beginning_of_week: integer, in the range of 0-6
+      # timezone: string, IANA TZ timezones
+      # timeofday_format: string, two formats are supported:
+      # "H:mm" for 24-hour format
+      # "h:mm A" for 12-hour format (AM/PM)
+      # date_format: string, possible values: "YYYY-MM-DD", "DD.MM.YYYY", "DD-MM-YYYY", "MM/DD/YYYY", "DD/MM/YYYY", "MM-DD-YYYY"
+      # 
+      # To change password you have to have the following fields:
+      # current_password: string
+      # password: string
+      def update_me(options={})
+        options = Hashie::Mash.new options
+        put "/me", (options.key?(:user) ? options : {:user => options})
+      end
+
+      #  *email*:        a valid email for the user whose account is created (string, required)
+      #  *password*:     password at least 6 characters long (string, required)
+      #  *timezone*:     for example "Etc/UTC" (string, required)
+      #  *created_with*: in free form, name of the app that signed the user app (string, required)
+      def signup(email, password, timezone, created_with="Toggl Api Ruby Gem #{Toggl::VERSION}")
+        post "/signups",{"user" => {"email" => email,"password" => "password","timezone" => timezone,"created_with" => created_with}}
+      end
+
+      def reset_token
+        post "/reset_token"
+      end
+
+    end 
+  end 
+end