togglv8-ng 1.4.0

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

data/spec/lib/togglv8/dashboard_spec.rb

@@ -0,0 +1,31 @@
+describe 'Dashboard' do
+  before :all do
+    @toggl = TogglV8::API.new(Testing::API_TOKEN)
+    @workspaces = @toggl.workspaces
+    @workspace_id = @workspaces.first['id']
+  end
+
+  it 'gets nil dashboard data' do
+    dashboard = @toggl.dashboard(@workspace_id)
+    expect(dashboard).to eq Hash['most_active_user' => nil, 'activity' => nil]
+  end
+
+  context 'gets dashboard time entries' do
+    before :all do
+      @new_time_entry = @toggl.start_time_entry({ 'wid' => @workspace_id, 'description' => 'new time entry +1' })
+    end
+
+    after :all do
+      @toggl.delete_time_entry(@new_time_entry['id'])
+    end
+
+    it 'gets dashboard data' do
+      dashboard = @toggl.dashboard(@workspace_id)
+      expect(dashboard['most_active_user']).to be nil
+      expect(dashboard['activity']).to_not be nil
+      expect(dashboard['activity'].first['user_id']).to eq @toggl.me['id']
+      expect(dashboard['activity'].first['project_id']).to be nil
+      expect(dashboard['activity'].first['description']).to eq 'new time entry +1'
+    end
+  end
+end

data/spec/lib/togglv8/projects_spec.rb

@@ -0,0 +1,111 @@
+describe 'Projects' 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 workspace projects' do
+    projects = @toggl.projects(@workspace_id)
+    expect(projects).to be_empty
+  end
+
+  context 'new project' do
+    before :all do
+      @project = @toggl.create_project({ 'name' => 'new project +1', 'wid' => @workspace_id })
+      project_ids = @toggl.my_projects.map { |p| p['id'] }
+      expect(project_ids).to eq [ @project['id'] ]
+    end
+
+    after :all do
+      TogglV8SpecHelper.delete_all_projects(@toggl)
+      projects = @toggl.my_projects
+      expect(projects).to be_empty
+    end
+
+    it 'creates a project' do
+      expect(@project).to_not be nil
+      expect(@project['name']).to eq 'new project +1'
+      expect(@project['billable']).to eq false
+      expect(@project['is_private']).to eq true
+      expect(@project['active']).to eq true
+      expect(@project['template']).to eq false
+      expect(@project['auto_estimates']).to eq false
+      expect(@project['wid']).to eq @workspace_id
+    end
+
+    it 'gets project data' do
+      project = @toggl.get_project(@project['id'])
+      expect(project).to_not be nil
+      expect(project['wid']).to eq @project['wid']
+      expect(project['name']).to eq @project['name']
+      expect(project['billable']).to eq @project['billable']
+      expect(project['is_private']).to eq @project['is_private']
+      expect(project['active']).to eq @project['active']
+      expect(project['template']).to eq @project['template']
+      expect(project['auto_estimates']).to eq @project['auto_estimates']
+      expect(project['at']).to_not be nil
+    end
+
+    it 'gets project users' do
+      users = @toggl.get_project_users(@project['id'])
+      expect(users.length).to eq 1
+      expect(users.first['uid']).to eq Testing::USER_ID
+      expect(users.first['manager']).to eq true
+    end
+  end
+
+  context 'updated project' do
+    before :each do
+      @project = @toggl.create_project({ 'name' => 'project to update', 'wid' => @workspace_id })
+    end
+
+    after :each do
+      @toggl.delete_project(@project['id'])
+    end
+
+    it 'updates project data' do
+      new_values = {
+        'name' => 'PROJECT-NEW',
+        'is_private' => false,
+        'active' => false,
+        'auto_estimates' => true,
+      }
+      project = @toggl.update_project(@project['id'], new_values)
+      expect(project).to include(new_values)
+    end
+
+    it 'updates Pro project data', :pro_account do
+      new_values = {
+        'template' => true,
+        'billable' => true,
+      }
+      project = @toggl.update_project(@project['id'], new_values)
+      expect(project).to include(new_values)
+    end
+  end
+
+  context 'multiple projects' do
+    after :all do
+      TogglV8SpecHelper.delete_all_projects(@toggl)
+    end
+
+    it 'deletes multiple projects' do
+      # start with no projects
+      expect(@toggl.projects(@workspace_id)).to be_empty
+
+      p1 = @toggl.create_project({ 'name' => 'p1', 'wid' => @workspace_id })
+      p2 = @toggl.create_project({ 'name' => 'p2', 'wid' => @workspace_id })
+      p3 = @toggl.create_project({ 'name' => 'p3', 'wid' => @workspace_id })
+
+      # see 3 new projects
+      expect(@toggl.projects(@workspace_id).length).to eq 3
+
+      p_ids = [p1, p2, p3].map { |p| p['id'] }
+      @toggl.delete_projects(p_ids)
+
+      # end with no projects
+      expect(@toggl.projects(@workspace_id)).to be_empty
+    end
+  end
+end

data/spec/lib/togglv8/tags_spec.rb

@@ -0,0 +1,54 @@
+describe 'Tags' do
+  before :all do
+    @toggl = TogglV8::API.new(Testing::API_TOKEN)
+    @workspaces = @toggl.workspaces
+    @workspace_id = @workspaces.first['id']
+  end
+
+  context 'new tag' do
+    before :all do
+      @tag = @toggl.create_tag({ 'name' => 'new tag +1', 'wid' => @workspace_id })
+      tag_ids = @toggl.my_tags.map { |t| t['id'] }
+      expect(tag_ids).to eq [ @tag['id'] ]
+    end
+
+    after :all do
+      TogglV8SpecHelper.delete_all_tags(@toggl)
+      tags = @toggl.my_tags
+      expect(tags).to be_empty
+    end
+
+    it 'creates a tag' do
+      expect(@tag).to_not be nil
+      expect(@tag['name']).to eq 'new tag +1'
+      expect(@tag['notes']).to eq nil
+      expect(@tag['wid']).to eq @workspace_id
+    end
+
+    it 'returns tag associated with workspace_id' do
+      tags = @toggl.tags(@workspace_id)
+      expect(tags).not_to be_empty
+      expect(tags.first['name']).to eq 'new tag +1'
+      expect(tags.first['wid']).to eq @workspace_id
+    end
+  end
+
+  context 'updated tag' do
+    before :each do
+      @tag = @toggl.create_tag({ 'name' => 'tag to update', 'wid' => @workspace_id })
+    end
+
+    after :each do
+      @toggl.delete_tag(@tag['id'])
+    end
+
+    it 'updates tag data' do
+      new_values = {
+        'name' => 'TAG-NEW',
+      }
+
+      tag = @toggl.update_tag(@tag['id'], new_values)
+      expect(tag).to include(new_values)
+    end
+  end
+end

data/spec/lib/togglv8/tasks_spec.rb

@@ -0,0 +1,100 @@
+describe 'Tasks', :pro_account do
+  before :all do
+    @toggl = TogglV8::API.new(Testing::API_TOKEN)
+    @workspaces = @toggl.workspaces
+    @workspace_id = @workspaces.first['id']
+    @project = @toggl.create_project({ 'name' => 'project with a task', 'wid' => @workspace_id })
+  end
+
+  after :all do
+    @toggl.delete_project(@project['id'])
+  end
+
+  context 'new task' do
+    before :all do
+      @task = @toggl.create_task({ 'name' => 'new task +1', 'pid' => @project['id'] })
+      @task_ids = @toggl.get_project_tasks(@project['id']).map { |t| t['id'] }
+      expect(@task_ids).to eq [ @task['id'] ]
+    end
+
+    after :all do
+      @toggl.delete_tasks(@task_ids)
+      tasks = @toggl.get_project_tasks(@project['id'])
+      expect(tasks).to be_empty
+    end
+
+    it 'creates a task' do
+      expect(@task).to_not be nil
+      expect(@task['name']).to eq 'new task +1'
+      expect(@task['pid']).to eq @project['id']
+      expect(@task['wid']).to eq @workspace_id
+      expect(@task['active']).to eq true
+    end
+
+    it 'gets a task' do
+      task = @toggl.get_task(@task['id'])
+      expect(task).to include('at') # 'at' is last updated timestamp
+      task.delete('at')             # 'at' is not included in POST response
+      expect(task).to eq @task      # compare POST and GET responses
+    end
+  end
+
+  context 'updated task' do
+    before :each do
+      @task = @toggl.create_task({ 'name' => 'task to update', 'pid' => @project['id'] })
+    end
+
+    after :each do
+      @toggl.delete_task(@task['id'])
+    end
+
+    it 'updates task data' do
+      new_values = {
+        'name' => 'task-NEW',
+      }
+
+      task = @toggl.update_task(@task['id'], new_values)
+      expect(task).to include(new_values)
+    end
+  end
+
+  context 'multiple tasks' do
+    before :each do
+      timestamp = Time.now.strftime("%H%M%S.%9N")
+      @task1 = @toggl.create_task({ 'name' => "task1-#{timestamp}", 'pid' => @project['id'] })
+      @task2 = @toggl.create_task({ 'name' => "task2-#{timestamp}", 'pid' => @project['id'] })
+      @task3 = @toggl.create_task({ 'name' => "task3-#{timestamp}", 'pid' => @project['id'] })
+      @task_ids = [ @task1['id'], @task2['id'], @task3['id'] ]
+    end
+
+    after :all do
+      @toggl.delete_tasks(@task_ids)
+    end
+
+    it 'updates multiple tasks' do
+      # start with 3 active tasks
+      tasks = @toggl.get_project_tasks(@project['id'])
+      active_flags = tasks.map { |t| t['active'] }
+      expect(active_flags).to match_array([true, true, true])
+
+      t_ids = [@task1, @task2, @task3].map { |t| t['id'] }
+      params = { 'active' => false }
+      @toggl.update_tasks(t_ids, params)
+
+      # end with no active tasks
+      tasks = @toggl.get_project_tasks(@project['id'])
+      expect(tasks).to be_empty
+    end
+
+    it 'deletes multiple tasks' do
+      # start with 3 new tasks
+      expect(@toggl.get_project_tasks(@project['id']).length).to eq 3
+
+      t_ids = [@task1, @task2, @task3].map { |t| t['id'] }
+      @toggl.delete_tasks(t_ids)
+
+      # end with no active tasks
+      expect(@toggl.get_project_tasks(@project['id'])).to be_empty
+    end
+  end
+end