dovico 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 641eaa573848e60b70368be58db24872e2237a24
-  data.tar.gz: ca2e3477d9d1a70545e95d223aed5101796aec50
+  metadata.gz: 14163c6be8c7579510cc31562a4ad12654913915
+  data.tar.gz: 199cf014ef1ead6072d13991b52aa909c7ef7a88
 SHA512:
-  metadata.gz: 4b837afe730bbc5fe4a057c2b71ba8910a73cb50d0de4cc5dd9a738d0eecc79d19c7c108709f9d6f2bf4559e22cf93ba223e8d6af0fb6fc7a84a6cc2acd0a3b3
-  data.tar.gz: 8a7550467aaafa92c599e1f9aa556a534ca15cdb35c0a095523cb4f5e50b97bf8e2755648cefae7590f8f44688a10bc9782ba5fdf40d31f880489dd7d0337a52
+  metadata.gz: b9da177d527421c5d0567437658d6be258b43bf05df977ed8531552feff1f7d350e9911c6ae7a4e42fc7b16a7aaa29c3d200ae7bb2db1ef9b3ceb9990a3edcda
+  data.tar.gz: ce26cd4d455096696a38ffcc96ef461601d95de7126a1d234986100b0ba6c486f73bd7855ac5295ff299523aef18640bcfb66f1f0c81f49298150cc239dce879

data/CHANGELOG.md

@@ -1,6 +1,41 @@
 # Next version
 - Your contribution!
 
+# Version 1.3.0
+- Update [README.md](README.md)
+- Fix bug when no time entries were to be submitted
+- **Breaking change**: Specific days must be configured in the special `specific_days` section in the configuration file
+- Specific weeks or months can be defined with `specific_weeks` and `specific_months` configuration
+~~~json
+assignments:
+  default_day:
+    - project_id: 1234
+      task_id:    100
+      hours:      3
+    - project_id: 9999
+      task_id:    120
+      hours:      2
+    - project_id: 4321
+      task_id:    424
+      hours:      2
+  specific_days:
+    # Quotes around day are mandatory
+    # On leave: use an empty array
+    '2016-01-17': []
+    # Specific day: redefine each tasks
+    '2017-12-19':
+      - project_id: 1234
+        task_id:    456
+        hours:      6
+      - project_id: 4321
+        task_id:    424
+        hours:      1
+  specific_weeks:
+    '2016-52': [] # Christmas week
+  specific_months:
+    '2016-07': [] # No work on July
+~~~
+
 # Version 1.2.0
 - Update [README.md](README.md)
 - Add `--clear` option to delete time entries

data/Makefile

@@ -1,8 +1,3 @@
-WEEK ?= $(shell date +%V)
-YEAR ?= $(shell date +%Y)
-DAY ?= $(shell date +%F)
-TAG   ?= $(shell git log -1 --abbrev=10 --format=%h)
-
 # Update the specified dependencies
 install:
 	@command -v ruby >/dev/null 2>&1 || { echo >&2 "I require ruby but it's not installed. Aborting."; exit 1; }
@@ -13,54 +8,17 @@ install:
 test: bundler
 	bundle exec rake spec
 
+# Build a new package file
 build:
 	bundle exec gem build dovico-client.gemspec
 
-help:
-	bundle exec bin/dovico --help
-
-tasks:
-	bundle exec bin/dovico --tasks
-
-myself:
-	bundle exec bin/dovico --myself
-
-# Fill actions
-current_week:
-	bundle exec bin/dovico --fill --current-week
-
-week:
-	bundle exec bin/dovico --fill --year=$(YEAR) --week=$(WEEK)
-
-today:
-	bundle exec bin/dovico --fill --today
-
-day:
-	bundle exec bin/dovico --fill --day=$(DAY)
-
-# Submit actions
-submit-current-week:
-	bundle exec bin/dovico --submit --current-week
-
-submit-week:
-	bundle exec bin/dovico --submit --year=$(YEAR) --week=$(WEEK)
-
-submit-day:
-	bundle exec bin/dovico --submit --day=$(DAY)
-
-submit-today:
-	bundle exec bin/dovico --submit --today
+# Publish a package on https://rubygems.org/gems/dovico
+publish:
+	bundle exec gem push $(PACKAGE_FILE)
 
 # Private - ensure gems are up-to-date
 bundler:
 	bundle check>/dev/null || bundle install
 
-docker-build-image:
-	docker images | grep capitainetrain/dovico | grep $(TAG) || docker build --force-rm -t capitainetrain/dovico:$(TAG) -f Dockerfile .
-
-# Run tests in Docker image
-docker-test: docker-build-image
-	docker run --rm capitainetrain/dovico:$(TAG) test
-
 
-.PHONY: install test help tasks myself current_week week today day submit-current-week submit-week submit-day submit-today bundler docker-build-image docker-test
+.PHONY: install test build publish bundler

data/README.md

@@ -62,17 +62,23 @@ assignments:
     - project_id: 4321
       task_id:    424
       hours:      2
-  # Quotes around day are mandatory
-  # On leave: use an empty array
-  '2016-01-17': []
-  # Specific day: redefine each tasks
-  '2017-12-19':
-    - project_id: 1234
-      task_id:    456
-      hours:      6
-    - project_id: 4321
-      task_id:    424
-      hours:      1
+  specific_days:
+    # Quotes around day are mandatory
+    # On leave: use an empty array
+    '2016-01-17': []
+    # Specific day: redefine each tasks
+    '2017-12-19':
+      - project_id: 1234
+        task_id:    456
+        hours:      6
+      - project_id: 4321
+        task_id:    424
+        hours:      1
+  specific_weeks:
+    '2016-52': [] # Christmas week
+  specific_months:
+    '2016-07': [] # No work on July
+
 ~~~
 
 # Usage
@@ -106,7 +112,7 @@ Project | Task | Description
 The date options are detailed below. All the other commands use the same format for these date options.
 
 ### For the current week
-`dovico --fill --current_week`
+`dovico --fill --current-week`
 
 ### For today
 `dovico --fill --today`

data/dovico.yml.example

@@ -13,14 +13,19 @@ assignments:
     - project_id: 4321
       task_id:    424
       hours:      2
-  # Quotes around day are mandatory
-  # On leave: use an empty array
-  '2016-01-17': []
-  # Specific day: redefine each tasks
-  '2017-12-19':
-    - project_id: 1234
-      task_id:    456
-      hours:      6
-    - project_id: 4321
-      task_id:    424
-      hours:      1
+  specific_days:
+    # Quotes around day are mandatory
+    # On leave: use an empty array
+    '2016-01-17': []
+    # Specific day: redefine each tasks
+    '2017-12-19':
+      - project_id: 1234
+        task_id:    456
+        hours:      6
+      - project_id: 4321
+        task_id:    424
+        hours:      1
+  specific_weeks:
+    '2016-52': [] # Christmas week
+  specific_months:
+    '2016-07': [] # No work on July

data/lib/dovico/app.rb

@@ -84,8 +84,12 @@ EOL
         )
         time_entries = time_entry_generator.generate(start_date, end_date)
 
-        saved_time_entries = TimeEntry.batch_create!(time_entries)
-        puts "#{saved_time_entries["TimeEntries"].count} Entries created between #{start_date} and #{end_date}"
+        if time_entries.count > 0
+          saved_time_entries = TimeEntry.batch_create!(time_entries)
+          puts "#{saved_time_entries["TimeEntries"].count} Entries created between #{start_date} and #{end_date}"
+        else
+          puts "No entries to be created between #{start_date} and #{end_date}"
+        end
       end
 
       if config[:submit]

data/lib/dovico/model/time_entry.rb

@@ -54,7 +54,11 @@ module Dovico
 
     def self.batch_create!(assignments)
       api_assignements = assignments.map(&:to_api)
-      ApiClient.post(URL_PATH, body: api_assignements.to_json)
+      if api_assignements.count > 0
+        ApiClient.post(URL_PATH, body: api_assignements.to_json)
+      else
+        []
+      end
     end
 
     def self.submit!(employee_id, start_date, end_date)

data/lib/dovico/model/time_entry_generator.rb

@@ -50,7 +50,19 @@ module Dovico
     end
 
     def day_assignments(date)
-      assignments[date.to_s] || assignments["default_day"]
+      special_day(date) || special_week(date) || special_month(date) || assignments["default_day"]
+    end
+
+    def special_day(date)
+      assignments["special_days"] && assignments["special_days"][date.iso8601]
+    end
+
+    def special_week(date)
+      assignments["special_weeks"] && assignments["special_weeks"][date.strftime("%Y-%V")]
+    end
+
+    def special_month(date)
+      assignments["special_months"] && assignments["special_months"][date.strftime("%Y-%m")]
     end
   end
 end

data/lib/dovico/version.rb

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

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

@@ -11,15 +11,22 @@ module Dovico
     let(:employee_id) { "999" }
     let(:assignment_1) do
       {
-        "project_id": "1234",
-        "task_id":    "456",
+        "project_id": "1111",
+        "task_id":    "111",
         "hours":      4,
       }.stringify_keys
     end
     let(:assignment_2) do
       {
-        "project_id": "6789",
-        "task_id":    "999",
+        "project_id": "2222",
+        "task_id":    "222",
+        "hours":      3,
+      }.stringify_keys
+    end
+    let(:assignment_3) do
+      {
+        "project_id": "3333",
+        "task_id":    "333",
         "hours":      3,
       }.stringify_keys
     end
@@ -44,16 +51,16 @@ module Dovico
 
           expect(first_time_entry.id).to be_nil
           expect(first_time_entry.employee_id).to eq(employee_id)
-          expect(first_time_entry.project_id).to eq('1234')
-          expect(first_time_entry.task_id).to eq('456')
+          expect(first_time_entry.project_id).to eq('1111')
+          expect(first_time_entry.task_id).to eq('111')
           expect(first_time_entry.date).to eq('2017-01-02')
           expect(first_time_entry.start_time).to eq('0900')
           expect(first_time_entry.stop_time).to eq('1300')
           expect(first_time_entry.total_hours).to eq(4)
 
           expect(first_time_entry.employee_id).to eq(employee_id)
-          expect(last_time_entry.project_id).to eq('6789')
-          expect(last_time_entry.task_id).to eq('999')
+          expect(last_time_entry.project_id).to eq('2222')
+          expect(last_time_entry.task_id).to eq('222')
           expect(last_time_entry.date).to eq('2017-01-06')
           expect(last_time_entry.start_time).to eq('1300')
           expect(last_time_entry.stop_time).to eq('1600')
@@ -65,8 +72,10 @@ module Dovico
         let(:assignments_config) do
           {
             'default_day': [ assignment_1, assignment_2 ],
-            '2016-02-29': [],
-            '2016-03-01': [ assignment_2 ],
+            'special_days': {
+              '2016-02-29': [],
+              '2016-03-01': [ assignment_2 ],
+            }.stringify_keys,
           }.stringify_keys
         end
         let(:start_date) { Date.parse('2016-02-29') }
@@ -81,6 +90,56 @@ module Dovico
           expect(time_entry.total_hours).to eq(3)
         end
       end
+
+      context 'with specific day, weeks and month assignments' do
+        let(:assignments_config) do
+          {
+            'default_day': [ ],
+            'special_days': {
+              '2017-08-28': [ assignment_1 ],
+            }.stringify_keys,
+            'special_weeks': {
+              '2017-35': [ assignment_2 ],
+            }.stringify_keys,
+            'special_months': {
+              '2017-09': [ assignment_3 ],
+            }.stringify_keys,
+          }.stringify_keys
+        end
+        context 'in the first week' do
+          let(:start_date) { Date.parse('2017-08-28') }
+          let(:end_date) { Date.parse('2017-08-29') }
+
+          it 'uses specific days and weeks assignments' do
+            time_entries = subject.generate(start_date, end_date)
+            expect(time_entries.count).to eq(2)
+
+            # Specific day
+            expect(time_entries[0].date).to eq('2017-08-28')
+            expect(time_entries[0].project_id).to eq('1111')
+            expect(time_entries[0].task_id).to eq('111')
+
+            # Specific week
+            expect(time_entries[1].date).to eq('2017-08-29')
+            expect(time_entries[1].project_id).to eq('2222')
+            expect(time_entries[1].task_id).to eq('222')
+          end
+        end
+
+        context 'in a second week' do
+          let(:start_date) { Date.parse('2017-09-04') }
+          let(:end_date) { Date.parse('2017-09-04') }
+
+          it 'uses specific months assignments' do
+            time_entries = subject.generate(start_date, end_date)
+
+            # Specific month
+            expect(time_entries[0].date).to eq('2017-09-04')
+            expect(time_entries[0].project_id).to eq('3333')
+            expect(time_entries[0].task_id).to eq('333')
+          end
+        end
+      end
     end
   end
 end

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

@@ -120,13 +120,24 @@ module Dovico
         allow(ApiClient).to receive(:post)
       end
 
-      it 'calls the API and post TimeEntries objects' do
-        Dovico::TimeEntry.batch_create!(assignments)
+      context 'with time entries to be created' do
+        it 'calls the API and post TimeEntries objects' do
+          Dovico::TimeEntry.batch_create!(assignments)
 
-        expect(ApiClient).to have_received(:post).with(
-          "#{Dovico::TimeEntry::URL_PATH}",
-          body: [subject.to_api].to_json
-        )
+          expect(ApiClient).to have_received(:post).with(
+            "#{Dovico::TimeEntry::URL_PATH}",
+            body: [subject.to_api].to_json
+          )
+        end
+      end
+
+      context 'with no time entries to be created' do
+        it 'does not call the API and returns an empty array' do
+          result = Dovico::TimeEntry.batch_create!([])
+
+          expect(ApiClient).not_to have_received(:post)
+          expect(result).to eq([])
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dovico
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Théophile Helleboid
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_app_helper