dovico 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d0fc89e13ae40ce8fba111ea73420cb03dced3
-  data.tar.gz: 2e41cc97b937deb844a8d6da1c24eb3e3f2d3483
+  metadata.gz: 641eaa573848e60b70368be58db24872e2237a24
+  data.tar.gz: ca2e3477d9d1a70545e95d223aed5101796aec50
 SHA512:
-  metadata.gz: 44898ec1528b4f6e4c40cba7d2e44ff3b6b8101cc6b00b39ff5736e80ac87dd6fb0853b459fb8c34e56c8e2068479e4401da83ff3a547447c65b9feebdd9d64a
-  data.tar.gz: 60fa2fd23b39d6a76ed0279a655efce636b3406aafefdfb8b6a04bd1b410190af5610b6b5d383d8a58065aa8c07298571e3549f01708b9d275a8b5948301942e
+  metadata.gz: 4b837afe730bbc5fe4a057c2b71ba8910a73cb50d0de4cc5dd9a738d0eecc79d19c7c108709f9d6f2bf4559e22cf93ba223e8d6af0fb6fc7a84a6cc2acd0a3b3
+  data.tar.gz: 8a7550467aaafa92c599e1f9aa556a534ca15cdb35c0a095523cb4f5e50b97bf8e2755648cefae7590f8f44688a10bc9782ba5fdf40d31f880489dd7d0337a52

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Next version
+- Your contribution!
+
+# Version 1.2.0
+- Update [README.md](README.md)
+- Add `--clear` option to delete time entries
+- Fix a typo on Projet URL
+- Fix formatting tasks list when mutliple tasks are associated to an assignment
 
 # Version 1.1.0
 - Remove `bin/console` from the Gem

data/README.md

@@ -2,9 +2,16 @@
 
 Repository for Dovico API management.
 
+# Requirements
+- Ruby 2.2.2 or newer
+
 # Installation
+`gem install dovico`
+
+# Configuration
+
 ## Dovico authentication
-Dovico provide a way to generate a 3rd party token. This token provide a full access to your account:
+Dovico provide a way to generate a 3rd party token. This token provides a full access to your account:
 - Do not expose your token.
 - If you believe your token has been exposed publicly, regenerate a new one. The previous token will be invalidated.
 
@@ -22,15 +29,11 @@ user_token: "<token you have copied from dovico.net page>"
 client_token: "<token given by your company's dovico admin>"
 ~~~
 
-## Install required libraries
-* Install Ruby 2.4.0
-* `make install`
-
 ## Setup your default timesheet
-* List the available tasks with `make tasks`
+* List the available tasks with `dovico --tasks`
 
 ~~~
-$ make tasks
+$ dovico --tasks
 == List of available projects ==
 Project | Task | Description
    1200 |  100 | Sauron Project: Forge the One Ring
@@ -74,30 +77,79 @@ assignments:
 
 # Usage
 ## Display informations on your account
-`make myself`
+`dovico --myself`
+
+~~~
+$ dovico --myself
+Informations about yourself
+ - ID:         42
+ - First Name: Gandalf
+ - Last Name:  The White
+~~~
 
 ## Display the list of the tasks
-`make tasks`
+`dovico --tasks`
+~~~
+$ dovico --tasks
+== List of available projects ==
+Project | Task | Description
+   1200 |  100 | Sauron Project: Forge the One Ring
+   1200 |  110 | Sauron Project: Attack Gondor
+   1400 |  100 | Gandalf Project: Meet Bilbo
+   1400 |  120 | Gandalf Project: Convince Frodo
+   1600 |  100 | Frodo Project: Go home
+~~~
 
 ## Fill the timesheet
+`dovico --fill [date options]`
+
+The date options are detailed below. All the other commands use the same format for these date options.
+
 ### For the current week
-`make current_week`
+`dovico --fill --current_week`
 
 ### For today
-`make today`
+`dovico --fill --today`
 
 ### For a specific [commercial week](http://www.epochconverter.com/weeks/)
-`make week WEEK=49`
+`dovicon --fill --week=49`
 
 Year can be set too:
-`make week YEAR=2015 WEEK=40`
+`dovico --fill --year=2015 --week=40`
 
 ### For a specific day
-`make day DAY=2017-12-31`
+`dovico --fill --day=2017-12-31`
 
-# Restrictions and known issues
-* The client can't edit already created timesheets for now.
+## Show the timesheet
+`dovico --show [date options]`
+
+~~~
+$ dovico --show --start=2017-01-02 --end=2017-01-12
+== List of Time Entries between 2017-01-02 and 2017-01-06 ==
+2017-01-02 [××××××××××××××]    : [not_submitted]  7h Sauron Project: Forge the One Ring
+2017-01-03 [××××××××××××××]    : [not_submitted]  7h Sauron Project: Attack Gondor
+2017-01-12 [××××]              : [under_review]  2h Gandalf Project: Meet Bilbo
+2017-01-12 [××××××××]          : [under_review]  4h Gandalf Project: Convince Frodo
+2017-01-12 [××]                : [under_review]  1h Frodo Project: Go home
+~~~
+
+## Submit the timesheet
+`dovico --submit [date options]`
+
+Once submitted, the timesheet can't be edited.
+
+## Delete timesheet
+`dovico --clear [date options]`
+
+A confirmation will be asked before the deletion.
+~~~
+$ dovico --clear --day=2017-01-05
+• 1 Time Entries to be deleted. Are you sure? (yes/no)
+yes
+✓ 1 Time Entries deleted
+~~~
 
+# Contributing
 You are warmly welcome to contribute to the project!
 
 # Dovico API Documentation

data/dovico-client.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'easy_app_helper'
   s.add_dependency 'active_attr'
   s.add_dependency 'typhoeus'
+  s.add_dependency 'highline'
 
   s.add_development_dependency 'pry'
   s.add_development_dependency 'guard'

data/lib/dovico/api_client.rb

@@ -24,6 +24,10 @@ module Dovico
         perform!(:put, path, params: params, body: body)
       end
 
+      def delete(path, params: {}, body: nil)
+        perform!(:delete, path, params: params, body: body)
+      end
+
       private
 
       attr_accessor :client_token, :user_token
@@ -60,7 +64,11 @@ module Dovico
           raise "Error during HTTP request"
         end
 
-        JSON.parse(response.body)
+        if response.body.length > 0
+          JSON.parse(response.body)
+        else
+          nil
+        end
       end
     end
   end

data/lib/dovico/app.rb

@@ -1,4 +1,5 @@
 require 'easy_app_helper'
+require 'highline'
 
 module Dovico
   class App
@@ -37,7 +38,10 @@ EOL
       config.add_command_line_section('Submit the timesheets') do |slop|
         slop.on :submit,       'Submit timesheets', argument: false
       end
-      config.add_command_line_section('Date options (required for --show, --fill and --submit)') do |slop|
+      config.add_command_line_section('Clear the timesheets') do |slop|
+        slop.on :clear,        'Clear the timesheets', argument: false
+      end
+      config.add_command_line_section('Date options (required for --show, --fill, --submit and --clear)') do |slop|
         slop.on :current_week, 'Current week', argument: false
         slop.on :today,        'Current day',  argument: false
         slop.on :day,          'Specific day', argument: true
@@ -65,6 +69,10 @@ EOL
         display_tasks
       end
 
+      if config[:clear]
+        clear_time_entries(start_date, end_date)
+      end
+
       if config[:show]
         display_time_entries(start_date, end_date)
       end
@@ -112,8 +120,22 @@ EOL
       puts ""
     end
 
+    def clear_time_entries(start_date, end_date)
+      time_entries = TimeEntry.search(start_date, end_date)
+      if highline.agree("• #{time_entries.count} Time Entries to be deleted. Are you sure? (yes/no)")
+        time_entries.each do |time_entry|
+          time_entry.delete!
+        end
+        puts "✓ #{time_entries.count} Time Entries deleted"
+      end
+    end
+
     def display_help
       puts config.command_line_help
     end
+
+    def highline
+      @highline ||= HighLine.new
+    end
   end
 end

data/lib/dovico/config_parser.rb

@@ -1,6 +1,7 @@
 module Dovico
   class ConfigParser
-    AVAILABLE_ACTIONS = [:myself, :tasks, :show, :fill, :submit]
+    AVAILABLE_ACTIONS = [:myself, :tasks, :show, :fill, :submit, :clear]
+    DATE_REQUIRED_ACTIONS = [:show, :fill, :submit, :clear]
 
     def initialize(config)
       @config = config
@@ -12,7 +13,7 @@ module Dovico
         true
       elsif AVAILABLE_ACTIONS.map{|action| config[action] }.compact.empty?
         true
-      elsif (config[:fill] || config[:submit]) && !(@start_date && @end_date)
+      elsif !(@start_date && @end_date) && !DATE_REQUIRED_ACTIONS.map{|action| config[action] }.compact.empty?
         true
       else
         false

data/lib/dovico/model/assignment.rb

@@ -2,7 +2,7 @@ require 'active_attr'
 
 module Dovico
   class Assignment
-    URL_PATH = 'Assignments/'
+    URL_PATH = 'Assignments'
 
     include ActiveAttr::Model
 

data/lib/dovico/model/employee.rb

@@ -2,7 +2,7 @@ require 'active_attr'
 
 module Dovico
   class Employee
-    URL_PATH = 'Employees/'
+    URL_PATH = 'Employees'
 
     include ActiveAttr::Model
 

data/lib/dovico/model/project.rb

@@ -16,15 +16,19 @@ module Dovico
       projects = projects_search["Assignments"].map {|project_hash| parse(project_hash) }
 
       projects.each do |project|
-        tasks_search = ApiClient.get("#{URL_PATH}#{project.assignement_id}")
-        project.tasks = tasks_search["Assignments"].map {|task_hash| Task.parse(task_hash) }
+        tasks_search = ApiClient.get("#{URL_PATH}/#{project.assignement_id}")
+        tasks = tasks_search["Assignments"].map {|task_hash| Task.parse(task_hash) }
+
+        project.tasks = tasks.sort_by do |task|
+          task.id
+        end
       end
 
       projects
     end
 
     def self.format_all
-      text = " Project | Task | Description"
+      text = " Project | Task | Description\n"
       text += all.map(&:to_s).join("\n")
     end
 
@@ -32,9 +36,9 @@ module Dovico
       text = ''
 
       if tasks.count > 0
-        tasks.each do |task|
-          text += sprintf ' %7d | %4d | %s: %s', id, task.id, name, task.name
-        end
+        text += tasks.map do |task|
+          sprintf " %7d | %4d | %s: %s", id, task.id, name, task.name
+        end.join("\n")
       else
         text += sprintf " %7d |      | %s (No tasks linked)", id, name
       end

data/lib/dovico/model/time_entry.rb

@@ -2,7 +2,7 @@ require 'active_attr'
 
 module Dovico
   class TimeEntry
-    URL_PATH = 'TimeEntries/'
+    URL_PATH = 'TimeEntries'
 
     include ActiveAttr::Model
 
@@ -41,7 +41,7 @@ module Dovico
 
     def self.search(start_date, end_date)
       api_response = ApiClient.get(
-        "#{URL_PATH}",
+        URL_PATH,
         params: {
           daterange: "#{start_date} #{end_date}"
         },
@@ -75,6 +75,10 @@ module Dovico
       ApiClient.put(URL_PATH, body: [to_api].to_json)
     end
 
+    def delete!
+      ApiClient.delete("#{URL_PATH}/#{id}")
+    end
+
     def to_api
       {
         "ID":         id,

data/lib/dovico/version.rb

@@ -1,3 +1,3 @@
 module Dovico
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/unit/dovico/api_client_spec.rb

@@ -77,5 +77,15 @@ module Dovico
         expect(response).to eq({"Stubbed": "Response"}.stringify_keys)
       end
     end
+
+    describe ".delete" do
+      it 'perform a DELETE request' do
+        stub_request(:delete, "#{Dovico::ApiClient::API_URL}TimeEntries/42?version=#{Dovico::ApiClient::API_VERSION}")
+          .to_return(body: '')
+
+        response = Dovico::ApiClient.delete('TimeEntries/42')
+        expect(response).to eq(nil)
+      end
+    end
   end
 end

data/spec/unit/dovico/model/project_spec.rb

@@ -20,7 +20,14 @@ module Dovico
         "Assignments": [project_api_hash]
       }.stringify_keys
     end
-    let(:task_api_hash) do
+    let(:task_api_hash_1) do
+      {
+        "ItemID":       "995",
+        "AssignmentID": "E456",
+        "Name":         "Task write specs, second part",
+      }.stringify_keys
+    end
+    let(:task_api_hash_2) do
       {
         "ItemID":       "789",
         "AssignmentID": "E456",
@@ -31,14 +38,14 @@ module Dovico
     end
     let(:tasks_api_hash) do
       {
-        "Assignments": [task_api_hash]
+        "Assignments": [task_api_hash_1, task_api_hash_2]
       }.stringify_keys
     end
 
     describe ".all" do
       before do
         allow(ApiClient).to receive(:get).with(Dovico::Project::URL_PATH).and_return(projects_api_hash)
-        allow(ApiClient).to receive(:get).with("#{Dovico::Project::URL_PATH}T456").and_return(tasks_api_hash)
+        allow(ApiClient).to receive(:get).with("#{Dovico::Project::URL_PATH}/T456").and_return(tasks_api_hash)
       end
 
       it "lists all the assignements" do
@@ -50,7 +57,7 @@ module Dovico
         expect(project.id).to eq('123')
         expect(project.name).to eq('Project Dovico API Client')
 
-        expect(project.tasks.count).to eq(1)
+        expect(project.tasks.count).to eq(2)
         task = project.tasks.first
         expect(task.id).to eq('789')
         expect(task.name).to eq('Task write specs')
@@ -60,11 +67,16 @@ module Dovico
     describe ".format_all" do
       before do
         allow(ApiClient).to receive(:get).with(Dovico::Project::URL_PATH).and_return(projects_api_hash)
-        allow(ApiClient).to receive(:get).with("#{Dovico::Project::URL_PATH}T456").and_return(tasks_api_hash)
+        allow(ApiClient).to receive(:get).with("#{Dovico::Project::URL_PATH}/T456").and_return(tasks_api_hash)
       end
 
       it 'returns projects with formatted text' do
-        expect(Dovico::Project.format_all).to eq(" Project | Task | Description     123 |  789 | Project Dovico API Client: Task write specs")
+        expected_strings = [
+          ' Project | Task | Description',
+          '     123 |  789 | Project Dovico API Client: Task write specs',
+          '     123 |  995 | Project Dovico API Client: Task write specs, second part',
+        ]
+        expect(Dovico::Project.format_all).to eq(expected_strings.join("\n"))
       end
     end
 

data/spec/unit/dovico/model/time_entry_spec.rb

@@ -182,6 +182,18 @@ module Dovico
       end
     end
 
+    describe ".delete!" do
+      before do
+        allow(ApiClient).to receive(:delete)
+      end
+
+      it 'calls the API and delete TimeEntries objects' do
+        subject.delete!
+
+        expect(ApiClient).to have_received(:delete).with("#{Dovico::TimeEntry::URL_PATH}/#{subject.id}")
+      end
+    end
+
     describe ".to_api" do
       it 'serializes the object' do
         expect(subject.to_api).to eq(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dovico
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Théophile Helleboid
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_app_helper
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -332,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple client & tools for http://www.dovico.com/.