toggl_api 0.0.2

data/lib/toggl_api/api/workspace.rb

@@ -0,0 +1,36 @@
+module Toggl
+  module Api
+    module Workspace
+
+      # *name*:  (string, required)
+      # premium: If it's a pro workspace or not. Shows if someone is paying for the workspace or not (boolean, not required)
+      # at:      timestamp that is sent in the response, indicates the time item was last updated
+
+      def workspaces
+        get "/workspaces"
+      end
+
+      def get_workspace_users(wid)
+        get "/workspaces/#{wid}/users"
+      end
+      alias :workspace_users :get_workspace_users
+
+      def get_workspace_clients(wid)
+        get "/workspaces/#{wid}/clients"
+      end
+      alias :workspace_clients :get_workspace_clients
+
+      # the token owner must be workspace admin
+      def get_workspace_projects(wid, active=true)
+        get "/workspaces/#{wid}/projects", {:active => active}
+      end
+      alias :workspace_projects :get_workspace_projects
+
+      def get_workspace_tasks(wid, active=true)
+        get "/workspaces/#{wid}/tasks", {:active => active}
+      end
+      alias :workspace_tasks :get_workspace_tasks
+
+    end 
+  end 
+end 

data/lib/toggl_api/api/workspace_user.rb

@@ -0,0 +1,32 @@
+module Toggl
+  module Api
+    module WorkspaceUser
+
+      # id:         workspace user id (integer)
+      # uid:        user id of the workspace user (integer)
+      # admin:      if user is workspace admin (boolean)
+      # active:     if the workspace user has accepted the invitation to this workspace (boolean)
+      # invite_url: if user has not accepted the invitation the url for accepting his/her invitation is sent when the request is made by workspace_admin
+
+      def invite_users_to_workspace(wid, emails)
+        post "/workspaces/#{wid}/invite",{:emails => emails}
+      end
+
+      def update_workspace_user(wuid, options)
+        options = Hashie::Mash.new options
+        post "/workspace_users/#{wuid}",(options.key?(:workspace_user) ? options : {:workspace_user => options})
+      end
+
+      def delete_workspace_user(uid)
+        delete "/workspace_users/#{uid}"
+      end
+
+      #orkspace_user objects (the connection between user and workspace)
+      def get_relations_of_workspace_and_user(wid)
+        get "/workspaces/#{wid}/workspace_users"
+      end
+      alias :relations_of_workspace_and_user :get_relations_of_workspace_and_user
+
+    end
+  end 
+end 

data/lib/toggl_api/base.rb

@@ -0,0 +1,39 @@
+require 'toggl_api/request'
+require 'toggl_api/api/client'
+require 'toggl_api/api/project'
+require 'toggl_api/api/project_user'
+require 'toggl_api/api/tag'
+require 'toggl_api/api/task'
+require 'toggl_api/api/time_entry'
+require 'toggl_api/api/user'
+require 'toggl_api/api/workspace'
+require 'toggl_api/api/workspace_user'
+
+module Toggl
+  class Base
+
+    include Toggl::Request
+    include Toggl::Api::Client
+    include Toggl::Api::Project
+    include Toggl::Api::ProjectUser
+    include Toggl::Api::Tag
+    include Toggl::Api::Task
+    include Toggl::Api::TimeEntry
+    include Toggl::Api::User
+    include Toggl::Api::Workspace
+    include Toggl::Api::WorkspaceUser
+
+    APIVERSION = "v8"
+
+    def initialize(username, pass='api_token')
+      @username,@pass = username,pass
+    end
+
+    private 
+
+    def basic_path(path)
+      path = "/api/#{APIVERSION}#{path}" unless path =~ /api/
+    end
+
+  end 
+end

data/lib/toggl_api/error.rb

@@ -0,0 +1,8 @@
+module Toggl
+  class Unauthorized           < StandardError; end
+  class Forbidden              < StandardError; end 
+  class BadRequest             < StandardError; end 
+  class Unavailable            < StandardError; end
+  class NotFound               < StandardError; end
+  class InternalServerError    < StandardError; end
+end

data/lib/toggl_api/report.rb

@@ -0,0 +1,30 @@
+require 'toggl_api/request'
+
+module Toggl
+  class Report
+
+    include Toggl::Request
+    
+    APIVERSION = "v2"
+
+    def initialize(token)
+      @username,@pass = token,"api_token"
+    end
+
+    #reports
+    %w[weekly details summary].each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(workspace_id, params={})
+          request(:get, '/#{method}', params.merge({:workspace_id => workspace_id,:user_agent => user_agent}))
+        end
+      RUBY
+    end
+
+    private
+
+    def basic_path(path)
+      path = "/reports/api/#{APIVERSION}#{path}" unless path =~ /reports/
+    end
+
+  end
+end

data/lib/toggl_api/request.rb

@@ -0,0 +1,100 @@
+require 'toggl_api/error'
+
+module Toggl
+  module Request
+
+    ENDPOINT = "https://www.toggl.com"
+
+    attr_writer :user_agent, :connection_options
+
+    def user_agent
+      @user_agent ||= "Toggl Api Ruby Gem #{Toggl::VERSION}"
+    end
+
+    def connection_options
+      @connection_options ||= {
+        :headers => {
+        :accept => 'application/json',
+        :user_agent => user_agent,
+        'Content-Type' => 'application/json'
+        }
+      }
+    end
+
+    #perform http request
+    %w[get delete].each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(path, params={})
+          request(:#{method}, path, params)
+        end
+      RUBY
+    end
+    
+    %w[post put].each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(path, params={})
+          request(:#{method}, path, MultiJson.dump(params))
+        end
+      RUBY
+    end
+
+    private 
+    
+    def request(method, path, params={})
+      handle_response connection.send(method.to_sym, basic_path(path), params)
+    rescue Faraday::Error::ClientError
+      raise TogglApi::Error
+    end
+
+    def connection
+      @connection ||= Faraday.new(ENDPOINT,connection_options) do |faraday|
+        faraday.request :url_encoded  
+        faraday.adapter Faraday.default_adapter
+        faraday.basic_auth @username, @pass
+      end 
+    end
+
+    def handle_response(response)
+      raise_errors(response)
+      data = mash(MultiJson.load(response.body))
+      (data.is_a?(Hash) && data.key?('data')) ? data['data'] : data
+    end
+
+    def raise_errors(response)
+      message = "(#{response.status}): #{response.body}"
+      case response.status.to_i
+      when 400
+        raise BadRequest, message
+      when 401
+        raise Unauthorized, message
+      when 403
+        raise Forbidden, message
+      when 404
+        raise NotFound, message
+      when 500
+        raise InternalServerError, message
+      when 502..503
+        raise Unavailable, message
+      end
+    end
+
+    def mash(obj)
+      if obj.is_a?(Array)
+        obj.map { |item| make_mash_with_consistent_hash(item) }
+      elsif obj.is_a?(Hash)
+        make_mash_with_consistent_hash(obj)
+      else
+        obj
+      end
+    end
+
+    def make_mash_with_consistent_hash(obj)
+      m = Hashie::Mash.new(obj)
+      def m.hash
+        inspect.hash
+      end
+      return m
+    end
+
+  end 
+end 

data/lib/toggl_api/version.rb

@@ -0,0 +1,3 @@
+module Toggl
+  VERSION = "0.0.2"
+end

data/test/base_test.rb

@@ -0,0 +1,38 @@
+require File.expand_path '../helper.rb', __FILE__
+
+class baseTest < MiniTest::Unit::TestCase
+
+  def setup
+    @base = Toggl::Base.new('abc','123')
+  end
+
+  def test_authorization_header
+    assert_match /Basic/,@base.get("/api/v8/me")[:request_headers]["Authorization"]
+  end
+
+  def test_get_method
+    @base.stub :request, Faraday::Response.new do
+      assert_kind_of Faraday::Response, @base.get("/api/v8/me")
+    end 
+  end
+
+  def test_post_method
+    @base.stub :request, Faraday::Response.new do
+      assert_kind_of Faraday::Response, @base.post("/api/v8/me")
+    end 
+  end
+
+  def test_put_method
+    @base.stub :request, Faraday::Response.new do
+      assert_kind_of Faraday::Response, @base.put("/api/v8/me")
+    end 
+  end
+
+  def test_delete_method
+    @base.stub :request, Faraday::Response.new do
+      assert_kind_of Faraday::Response, @base.delete("/api/v8/me")
+    end 
+  end
+
+end
+

data/test/fixtures/authentication.json

@@ -0,0 +1,44 @@
+{
+    "since":1361780172,
+    "data": {
+        "id":123,
+        "api_token":"1971800d4d82861d8f2c1651fea4d212",
+        "default_wid":777,
+        "email":"john.doe@gmail.com",
+        "fullname":"John Doe",
+        "jquery_timeofday_format":"h:i A",
+        "jquery_date_format":"m/d/Y",
+        "timeofday_format":"h:mm A",
+        "date_format":"MM/DD/YYYY",
+        "store_start_and_stop_time":true,
+        "beginning_of_week":1,
+        "language":"en_US",
+        "image_url":"https://www.toggl.com/images/profile.png",
+        "new_blog_post":{},
+        "projects": [
+            {
+                "id":90123,
+                "wid":777,
+                "name":"Our best project",
+                "billable":true,
+                "active":true,
+                "at":"2013-02-12T09:47:57+00:00"
+            }
+        ],
+        "tags": [
+            {
+                "id":238526,
+                "wid":777,
+                "name":"billed"
+            }
+        ],
+        "tasks": [],
+        "workspaces": [
+            {
+                "id":777,"name":"John's WS","at":"2012-11-28T11:56:49+00:00"
+            }
+        ],
+        "clients": []
+    }
+}
+

data/test/fixtures/bulk_update_tasks.json

@@ -0,0 +1,24 @@
+{
+    "data": [
+        {
+            "name":"A new task",
+            "id":1335076912,
+            "wid":888,
+            "pid":777,
+            "active":false,
+            "at":"2013-02-26T15:09:52+00:00",
+            "estimated_seconds":3600,
+            "uname": "John Swift",
+            "done_seconds": 1200
+        }, {
+            "name":"Another task",
+            "id":1335076911,
+            "wid":888,
+            "pid":777,
+            "active":false,
+            "at":"2013-02-26T15:09:52+00:00",
+            "estimated_seconds":3600,
+            "done_seconds": 10
+        }
+    ]
+}

data/test/fixtures/bulk_update_time_entries.json

@@ -0,0 +1,29 @@
+{   "data":[
+        {
+            "id":436694100,
+            "guid":"dfc88541-f3b0-bffe-fa2e-46a09fa97664",
+            "wid":777,
+            "pid":20123718,
+            "billable":true,
+            "start":"2013-08-01T10:46:00",
+            "stop":"2013-08-01T11:46:02",
+            "duration":3602,
+            "description":"Development",
+            "tags":["billed","poductive","overhours"],
+            "duronly":false,
+            "at":"2013-08-01T12:04:57"
+        },{
+            "id":436694101,
+            "guid":"ce3c2409-e624-64e2-6742-c623ff284091",
+            "wid":777,
+            "billable":false,
+            "start":"2013-08-01T11:11:00",
+            "stop":"2013-08-01T11:46:04",
+            "duration":2104,
+            "description":"Meeting with the client",
+            "tags":["billed","poductive","holiday"],
+            "duronly":false,
+            "at":"2013-08-01T11:46:08"
+        }
+    ]
+}

data/test/fixtures/client.json

@@ -0,0 +1,11 @@
+{
+    "data": {
+        "id":1239455,
+        "wid":777,
+        "name":"Very Big Company",
+        "at":"2013-02-26T08:45:28+00:00",
+    "notes": "Contact: John Jacob Jingleheimer Schmidt",
+    "hrate": 12,
+    "cur": "AUD"
+    }
+}

data/test/fixtures/client_projects.json

@@ -0,0 +1,21 @@
+[
+    {
+        "id":909,
+        "wid":777,
+        "cid":987,
+        "name":"Very lucrative project",
+        "billable":false,
+        "is_private":true,
+        "active":true,
+        "at":"2013-03-06T09:15:18+00:00"
+    },{
+        "id":32143,
+        "wid":777,
+        "cid":987,
+        "name":"Factory server infrastructure",
+        "billable":true,
+        "is_private":true,
+        "active":true,
+        "at":"2013-03-06T09:16:06+00:00"
+    }
+]

data/test/fixtures/clients.json

@@ -0,0 +1,15 @@
+[
+    {
+        "id":1239455,
+        "wid":777,
+        "name":"Very Big Company",
+        "notes":"something about the client",
+        "at":"2013-02-26T08:55:28+00:00"
+    }, {
+        "id":1239456,
+        "wid":777,
+        "name":"Small Startup",
+        "notes":"Really cool people",
+        "at":"2013-03-26T08:55:28+00:00"
+    }
+]