togglv8-limitusus 1.2.1

data/lib/togglv8/togglv8.rb

@@ -0,0 +1,43 @@
+require_relative 'clients'
+require_relative 'dashboard'
+require_relative 'project_users'
+require_relative 'projects'
+require_relative 'tags'
+require_relative 'tasks'
+require_relative 'time_entries'
+require_relative 'users'
+require_relative 'version'
+require_relative 'workspaces'
+
+module TogglV8
+  TOGGL_API_URL = 'https://api.track.toggl.com/api/'
+
+  class API
+    include TogglV8::Connection
+
+    TOGGL_API_V8_URL = TOGGL_API_URL + 'v8/'
+
+    attr_reader :conn
+
+    def initialize(username=nil, password=API_TOKEN, opts={})
+      debug(false)
+      if username.nil? && password == API_TOKEN
+        toggl_api_file = File.join(Dir.home, TOGGL_FILE)
+        # logger.debug("toggl_api_file = #{toggl_api_file}")
+        if File.exist?(toggl_api_file) then
+          username = IO.read(toggl_api_file).strip
+        else
+          raise "Expecting one of:\n" +
+            " 1) api_token in file #{toggl_api_file}, or\n" +
+            " 2) parameter: (api_token), or\n" +
+            " 3) parameters: (username, password).\n" +
+            "\n\tSee https://github.com/kanet77/togglv8#togglv8api" +
+            "\n\tand https://github.com/toggl/toggl_api_docs/blob/master/chapters/authentication.md"
+        end
+      end
+
+      @conn = TogglV8::Connection.open(username, password,
+                TOGGL_API_V8_URL, opts)
+    end
+  end
+end

data/lib/togglv8/users.rb

@@ -0,0 +1,74 @@
+module TogglV8
+  class API
+
+    ##
+    # ---------
+    # :section: Users
+    #
+    # api_token                 : (string)
+    # default_wid               : default workspace id (integer)
+    # email                     : (string)
+    # jquery_timeofday_format   : (string)
+    # jquery_date_format        : (string)
+    # timeofday_format          : (string)
+    # date_format               : (string)
+    # store_start_and_stop_time : whether start and stop time are saved on time entry (boolean)
+    # beginning_of_week         : (integer, Sunday=0)
+    # language                  : user's language (string)
+    # image_url                 : url with the user's profile picture(string)
+    # sidebar_piechart          : should a piechart be shown on the sidebar (boolean)
+    # at                        : timestamp of last changes
+    # new_blog_post             : an object with toggl blog post title and link
+
+    def me(all=nil)
+      # NOTE: response['since'] is discarded because it is outside response['data']
+      #       (See TogglV8::API#get in lib/togglv8.rb)
+      get "me%s" % [all.nil? ? "" : "?with_related_data=#{all}"]
+    end
+
+    def my_clients(user=nil)
+      user = me(all=true) if user.nil?
+      user['clients'] || {}
+    end
+
+    def my_projects(user=nil)
+      user = me(all=true) if user.nil?
+      return {} unless user['projects']
+      projects = user['projects']
+      projects.delete_if { |p| p['server_deleted_at'] }
+    end
+
+    def my_deleted_projects(user=nil)
+      user = me(all=true) if user.nil?
+      return {} unless user['projects']
+      projects = user['projects']
+      projects.keep_if { |p| p['server_deleted_at'] }
+    end
+
+    def my_tags(user=nil)
+      user = me(all=true) if user.nil?
+      user['tags'] || {}
+    end
+
+    def my_tasks(user=nil)
+      user = me(all=true) if user.nil?
+      user['tasks'] || {}
+    end
+
+    def my_time_entries(user=nil)
+      user = me(all=true) if user.nil?
+      user['time_entries'] || {}
+    end
+
+    def my_workspaces(user=nil)
+      user = me(all=true) if user.nil?
+      user['workspaces'] || {}
+    end
+
+    def create_user(params)
+      params['created_with'] = TogglV8::NAME unless params.has_key?('created_with')
+      requireParams(params, ['email', 'password', 'timezone', 'created_with'])
+      post "signups", { 'user' => params }
+    end
+  end
+end

data/lib/togglv8/version.rb

@@ -0,0 +1,4 @@
+module TogglV8
+  # :section:
+  VERSION = "1.2.1"
+end

data/lib/togglv8/workspaces.rb

@@ -0,0 +1,47 @@
+module TogglV8
+  class API
+
+    ##
+    # ---------
+    # :section: Workspaces
+    #
+    # 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 clients(workspace_id=nil)
+      if workspace_id.nil?
+        get "clients"
+      else
+        get "workspaces/#{workspace_id}/clients"
+      end
+    end
+
+    def projects(workspace_id, params={})
+      active = params.has_key?(:active) ? "?active=#{params[:active]}" : ""
+      get "workspaces/#{workspace_id}/projects#{active}"
+    end
+
+    def users(workspace_id)
+      get "workspaces/#{workspace_id}/users"
+    end
+
+    def tasks(workspace_id, params={})
+      active = params.has_key?(:active) ? "?active=#{params[:active]}" : ""
+      get "workspaces/#{workspace_id}/tasks#{active}"
+    end
+
+    def tags(workspace_id)
+      get "workspaces/#{workspace_id}/tags"
+    end
+
+    def leave_workspace(workspace_id)
+      delete "workspaces/#{workspace_id}/leave"
+    end
+  end
+end

data/spec/lib/reportsv2_spec.rb

@@ -0,0 +1,254 @@
+require 'fileutils'
+
+describe 'ReportsV2' do
+  it 'initializes with api_token' do
+    reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+    env = reports.env
+    expect(env).to_not be nil
+    expect(env['user']['api_token']).to eq Testing::API_TOKEN
+  end
+
+  it 'does not initialize with bogus api_token' do
+    reports = TogglV8::ReportsV2.new(api_token: '4880nqor1orr9n241sn08070q33oq49s')
+    expect { reports.env }.to raise_error(RuntimeError, "HTTP Status: 401")
+  end
+
+  context '.toggl file' do
+    before :each do
+      @tmp_home = mktemp_dir
+      @original_home = Dir.home
+      ENV['HOME'] = @tmp_home
+    end
+
+    after :each do
+      FileUtils.rm_rf(@tmp_home)
+      ENV['HOME'] = @original_home
+    end
+
+    it 'initializes with .toggl file' do
+      toggl_file = File.join(@tmp_home, '.toggl')
+      File.open(toggl_file, 'w') { |file| file.write(Testing::API_TOKEN) }
+
+      reports = TogglV8::ReportsV2.new
+      env = reports.env
+      expect(env).to_not be nil
+      expect(env['user']['api_token']).to eq Testing::API_TOKEN
+    end
+
+    it 'initializes with custom toggl file' do
+      toggl_file = File.join(@tmp_home, 'my_toggl')
+      File.open(toggl_file, 'w') { |file| file.write(Testing::API_TOKEN) }
+
+      reports = TogglV8::ReportsV2.new(toggl_api_file: toggl_file)
+      env = reports.env
+      expect(env).to_not be nil
+      expect(env['user']['api_token']).to eq Testing::API_TOKEN
+    end
+
+    it 'raises error if .toggl file is missing' do
+      expect{ reports = TogglV8::ReportsV2.new }.to raise_error(RuntimeError)
+    end
+  end
+
+  context 'handles errors' do
+    before :all do
+      @reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      @reports.workspace_id = @workspace_id
+    end
+
+    it 'surfaces a Warning HTTP header in case of 400 error' do
+      # https://github.com/toggl/toggl_api_docs/blob/master/reports.md#failed-requests
+      expect { @reports.error400 }.to raise_error(RuntimeError,
+                                      "This URL is intended only for testing")
+    end
+
+    it 'retries a request up to 3 times if a 429 is received' do
+      expect(@reports.conn).to receive(:get).exactly(3).times.and_return(
+        MockResponse.new(429, {}, 'body'))
+      expect { @reports.env }.to raise_error(RuntimeError, "HTTP Status: 429")
+    end
+
+    it 'retries a request after 429' do
+      expect(@reports.conn).to receive(:get).twice.and_return(
+        MockResponse.new(429, {}, 'body'),
+        MockResponse.new(200, {}, 'rev1.2.3'))
+      expect(@reports.revision).to eq('rev1.2.3')
+    end
+  end
+
+  context 'miscellaneous' do
+    it 'env returns environment' do
+      reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      reports.workspace_id = @workspace_id
+      env = reports.env
+      expect(env['workspace']).to_not be nil
+      expect(env['user']).to_not be nil
+      expect(env['user']['id']).to eq Testing::USER_ID
+    end
+
+    it 'index returns endpoints' do
+      reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      reports.workspace_id = @workspace_id
+      index = reports.index
+      expect(index['Welcome to reports api V2. VALID requests are:']).to_not be nil
+    end
+
+    it 'revision has not changed' do
+      reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      reports.workspace_id = @workspace_id
+      expect(reports.revision).to start_with "0.0.38\n"
+    end
+  end
+
+  context 'project', :pro_account do
+    before :all do
+      @toggl = TogglV8::API.new(Testing::API_TOKEN)
+      @project_name = "Project #{Time.now.iso8601}"
+      @project = @toggl.create_project({
+        'name' => @project_name,
+        'wid' => @workspace_id
+      })
+    end
+
+    after :all do
+      @toggl.delete_project(@project['id'])
+    end
+
+    it 'dashboard' do
+      reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      reports.workspace_id = @toggl.workspaces.first['id']
+      project_dashboard = reports.project(@project['id'])
+
+      expect(project_dashboard['name']).to eq @project_name
+    end
+  end
+
+  context 'blank reports' do
+    before :all do
+      @toggl = TogglV8::API.new(Testing::API_TOKEN)
+      @workspaces = @toggl.workspaces
+      @workspace_id = @workspaces.first['id']
+      @reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      @reports.workspace_id = @workspace_id
+    end
+
+    it 'summary' do
+      expect(@reports.summary).to eq []
+    end
+
+    it 'weekly' do
+      expect(@reports.weekly).to eq []
+    end
+
+    it 'details' do
+      expect(@reports.details).to eq []
+    end
+  end
+
+  context 'reports' do
+    before :all do
+      @toggl = TogglV8::API.new(Testing::API_TOKEN)
+      @workspaces = @toggl.workspaces
+      @workspace_id = @workspaces.first['id']
+      time_entry_info = {
+        'wid' => @workspace_id,
+        'start' => @toggl.iso8601(DateTime.now),
+        'duration' => 77
+      }
+
+      @time_entry = @toggl.create_time_entry(time_entry_info)
+
+      @reports = TogglV8::ReportsV2.new(api_token: Testing::API_TOKEN)
+      @reports.workspace_id = @workspace_id
+
+      @tmp_home = mktemp_dir
+      @original_home = Dir.home
+      ENV['HOME'] = @tmp_home
+    end
+
+    after :all do
+      @toggl.delete_time_entry(@time_entry['id'])
+
+      FileUtils.rm_rf(@tmp_home)
+      ENV['HOME'] = @original_home
+    end
+
+    context 'JSON reports' do
+      it 'summary' do
+        summary = @reports.summary
+        expect(summary.length).to eq 1
+        expect(summary.first['time']).to eq 77000
+        expect(summary.first['items'].length).to eq 1
+        expect(summary.first['items'].first['time']).to eq 77000
+      end
+
+      it 'weekly' do
+        weekly = @reports.weekly
+        expect(weekly.length).to eq 1
+        expect(weekly.first['details'].first['title']['user']).to eq Testing::USERNAME
+        expect(weekly.first['totals'][7]).to eq 77000
+      end
+
+      it 'details' do
+        details = @reports.details
+        expect(details.length).to eq 1
+        expect(details.first['user']).to eq Testing::USERNAME
+        expect(details.first['dur']).to eq 77000
+      end
+    end
+
+    context 'CSV reports' do
+      it 'summary' do
+        filename = File.join(@tmp_home, 'summary.csv')
+        summary = @reports.write_summary(filename)
+        expect(file_contains(filename, /00:01:17/))
+      end
+
+      it 'weekly' do
+        filename = File.join(@tmp_home, 'weekly.csv')
+        weekly = @reports.write_weekly(filename)
+        expect(file_contains(filename, /00:01:17/))
+      end
+
+      it 'details' do
+        filename = File.join(@tmp_home, 'details.csv')
+        details = @reports.write_details(filename)
+        expect(file_contains(filename, /00:01:17/))
+      end
+    end
+
+    context 'PDF reports' do
+      it 'summary' do
+        filename = File.join(@tmp_home, 'summary.pdf')
+        summary = @reports.write_summary(filename)
+        expect(file_is_pdf(filename))
+      end
+
+      it 'weekly' do
+        filename = File.join(@tmp_home, 'weekly.pdf')
+        weekly = @reports.write_weekly(filename)
+        expect(file_is_pdf(filename))
+      end
+
+      it 'details' do
+        filename = File.join(@tmp_home, 'details.pdf')
+        details = @reports.write_details(filename)
+        expect(file_is_pdf(filename))
+      end
+    end
+
+    context 'XLS reports', :pro_account do
+      it 'summary' do
+        filename = File.join(@tmp_home, 'summary.xls')
+        summary = @reports.write_summary(filename)
+        expect(file_is_xls(filename))
+      end
+
+      it 'details' do
+        filename = File.join(@tmp_home, 'details.xls')
+        details = @reports.write_details(filename)
+        expect(file_is_xls(filename))
+      end
+    end
+  end
+end

data/spec/lib/togglv8/clients_spec.rb

@@ -0,0 +1,145 @@
+describe 'Clients' do
+  before :all do
+    @toggl = TogglV8::API.new(Testing::API_TOKEN)
+    @workspaces = @toggl.workspaces
+    @workspace_id = @workspaces.first['id']
+  end
+
+  it 'gets {} if there are no clients' do
+    client = @toggl.clients
+    expect(client).to be_empty
+  end
+
+  it 'gets {} if there are no workspace clients' do
+    client = @toggl.clients(@workspace_id)
+    expect(client).to be_empty
+  end
+
+  context 'new client' do
+    before :all do
+      @client = @toggl.create_client({ 'name' => 'new client +1', 'wid' => @workspace_id })
+      client_ids = @toggl.my_clients.map { |c| c['id'] }
+      expect(client_ids).to eq [ @client['id'] ]
+    end
+
+    after :all do
+      TogglV8SpecHelper.delete_all_clients(@toggl)
+      clients = @toggl.my_clients
+      expect(clients).to be_empty
+    end
+
+    it 'gets a client' do
+      client_ids = @toggl.clients.map { |c| c['id'] }
+      expect(client_ids).to eq [ @client['id'] ]
+    end
+
+    it 'gets a workspace client' do
+      client_ids = @toggl.clients(@workspace_id).map { |c| c['id'] }
+      expect(client_ids).to eq [ @client['id'] ]
+    end
+
+    context 'multiple clients' do
+      before :all do
+        @client2 = @toggl.create_client({ 'name' => 'new client 2', 'wid' => @workspace_id })
+      end
+
+      after :all do
+        @toggl.delete_client(@client2['id'])
+      end
+
+      it 'gets clients' do
+        client_ids = @toggl.clients.map { |c| c['id'] }
+        expect(client_ids).to match_array [ @client['id'], @client2['id'] ]
+      end
+
+      it 'gets workspace clients' do
+        client_ids = @toggl.clients(@workspace_id).map { |c| c['id'] }
+        expect(client_ids).to match_array [ @client['id'], @client2['id'] ]
+      end
+    end
+
+    it 'creates a client' do
+      expect(@client).to_not be nil
+      expect(@client['name']).to eq 'new client +1'
+      expect(@client['notes']).to eq nil
+      expect(@client['wid']).to eq @workspace_id
+    end
+
+    it 'gets client data' do
+      client = @toggl.get_client(@client['id'])
+      expect(client).to_not be nil
+      expect(client['name']).to eq @client['name']
+      expect(client['wid']).to eq @client['wid']
+      expect(client['notes']).to eq @client['notes']
+      expect(client['at']).to_not be nil
+    end
+
+    context 'client projects' do
+      it 'gets {} if there are no client projects' do
+        projects = @toggl.get_client_projects(@client['id'])
+        expect(projects).to be_empty
+      end
+
+      context 'new client projects' do
+        before :all do
+          @project = @toggl.create_project({ 'name' => 'project', 'wid' => @workspace_id, 'cid' => @client['id'] })
+        end
+
+        after :all do
+          TogglV8SpecHelper.delete_all_projects(@toggl)
+        end
+
+        it 'gets a client project' do
+          projects = @toggl.get_client_projects(@client['id'])
+          project_ids = projects.map { |p| p['id'] }
+          expect(project_ids).to eq [ @project['id'] ]
+        end
+
+        it 'gets multiple client projects' do
+          project2 = @toggl.create_project({ 'name' => 'project2', 'wid' => @workspace_id, 'cid' => @client['id'] })
+
+          projects = @toggl.get_client_projects(@client['id'])
+          project_ids = projects.map { |p| p['id'] }
+          expect(project_ids).to match_array [ @project['id'], project2['id'] ]
+
+          @toggl.delete_project(project2['id'])
+        end
+      end
+    end
+  end
+
+  context 'updated client' do
+    before :each do
+      @client = @toggl.create_client({ 'name' => 'client to update', 'wid' => @workspace_id })
+    end
+
+    after :each do
+      @toggl.delete_client(@client['id'])
+    end
+
+    it 'updates client data' do
+      new_values = {
+        'name' => 'CLIENT-NEW',
+        'notes' => 'NOTES-NEW',
+      }
+
+      client = @toggl.update_client(@client['id'], new_values)
+      expect(client).to include(new_values)
+    end
+
+    # :nocov:
+    # It appears hourly rate is no longer tied to a client despite the docs:
+    # https://github.com/toggl/toggl_api_docs/blob/master/chapters/clients.md#clients
+    xit 'updates Pro client data', :pro_account do
+      new_values = {
+        'hrate' => '7.77',
+        'cur' => 'USD',
+      }
+      client = @toggl.update_client(@client['id'], new_values)
+
+      client = @toggl.get_client(@client['id'])
+      expect(client).to include(new_values)
+    end
+    # :nocov:
+  end
+end