dovico 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67d5d34d0fb717d92b72759aaa52d4f859e06c18
+  data.tar.gz: a0661c8ada849a06068b0c5c998881a1ed679b92
+SHA512:
+  metadata.gz: c1b6046789cdfed1e55347c610254c5f4154ac414c3c56ead42e5135f1ca72849ffa02ac5353c77777332fdaf10866a165c44fcbd746a3b24ad31dd95add0c19
+  data.tar.gz: a03029e6d62076b85c2ac5f2a7995dca2e8f50f3fd529720b0664f0c9a466a02f1ef06774fd8fa1d43f5f2f5663d0784f70be03a37ea916244fa535d9a29eecb

data/.dockerignore

@@ -0,0 +1 @@
+.git/

data/.gitignore

@@ -0,0 +1,4 @@
+dovico.yml
+coverage/
+*.gem
+Gemfile.lock

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+stages:
+  - build
+  - test
+
+build docker image:
+  stage: build
+  tags: [ docker ]
+  script:
+    - make docker-build-image TAG=${CI_BUILD_REF}
+
+specs:
+  stage: test
+  tags: [ docker ]
+  script:
+    - make docker-test TAG=$CI_BUILD_REF

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order=random

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/Dockerfile

@@ -0,0 +1,28 @@
+FROM ruby:2.4
+
+# System dependencies: Add here any librairies needed for certain gems
+RUN apt-get update \
+  && apt-get install -y libpq-dev \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Application working directory
+WORKDIR /home/dovico
+
+# WARNING The following line is important to keep bundle config
+# inside the app directory
+ENV  BUNDLE_APP_CONFIG /home/dovico/.bundle/
+# Copy dependency file
+COPY ./dovico-client.gemspec /home/dovico/dovico-client.gemspec
+COPY ./lib/dovico/version.rb /home/dovico/lib/dovico/version.rb
+COPY ./Gemfile /home/dovico/Gemfile
+
+# Bundle
+RUN bundle install
+
+# Copy code
+COPY ./ /home/dovico
+
+# What to launch on container startup
+ENTRYPOINT ["make"]
+CMD        ["run"]

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Makefile

@@ -0,0 +1,66 @@
+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; }
+	@command -v bundle >/dev/null 2>&1 || gem install bundler;
+	bundle check || bundle install
+
+# Run all the tests
+test: bundler
+	bundle exec rake spec
+
+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
+
+# 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

data/README.md

@@ -0,0 +1,106 @@
+[![build status](https://scm.capitainetrain.com/capitainetrain/dovico-client/badges/master/build.svg)](https://scm.capitainetrain.com/capitainetrain/dovico-client/commits/master)
+[![coverage report](https://scm.capitainetrain.com/capitainetrain/dovico-client/badges/master/coverage.svg)](https://scm.capitainetrain.com/capitainetrain/dovico-client/commits/master)
+
+Repository for Dovico API management.
+
+# Installation
+## Dovico authentication
+Dovico provide a way to generate a 3rd party token. This token provide 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.
+
+To generate a token:
+* Login to https://login.dovico.com/index.aspx
+* In **Options** tab, in the **Apps** part, click on the `Reset` button and copy your token
+
+## Local configuration
+* Create a new YAML file `~/.dovico/dovico.yml` with the following content:
+
+~~~ruby
+# Personal token. Can be reset through Dovico setting page
+user_token: "<token you have copied from dovico.net page>"
+# Your company's token
+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`
+
+~~~
+$ make 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
+~~~
+
+* For each tasks you work on, note the Project, Task and hours spent. You should have a total of 7 hours of work each day.
+* In your `~/.dovico/dovico.yml` file, *append* it with the following content
+
+~~~ruby
+# Personal token. Can be reset through Dovico setting page
+user_token: "...."
+# Your company's token
+client_token: "...."
+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
+  # 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
+~~~
+
+# Usage
+## Display informations on your account
+`make myself`
+
+## Display the list of the tasks
+`make tasks`
+
+## Fill the timesheet
+### For the current week
+`make current_week`
+
+### For today
+`make today`
+
+### For a specific [commercial week](http://www.epochconverter.com/weeks/)
+`make week WEEK=49`
+
+Year can be set too:
+`make week YEAR=2015 WEEK=40`
+
+### For a specific day
+`make day DAY=2017-12-31`
+
+# Restrictions and known issues
+* The timesheet are currently created, but not submitted. You still need to login and submit your timesheet
+* The client can't edit already created timesheets for now.
+
+You are warmly welcome to contribute to the project!
+
+# Dovico API Documentation
+* http://apideveloper.dovico.com/

data/Rakefile

@@ -0,0 +1,11 @@
+# Test tasks
+begin
+  require "ci/reporter/rake/rspec"
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task :rspec => "ci:setup:rspec"
+
+  # Default
+  task :default => :spec
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "dovico"
+require "pry"
+
+Pry.start

data/bin/dovico

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'dovico'
+
+Dovico::App.new.run

data/doc/API.md

@@ -0,0 +1,135 @@
+# Dovico API
+
+## `/Employees`
+### Query myself
+Query : `GET /Employees/me`
+
+Response :
+~~~json
+{
+  "Employees": [
+    {
+      "ID": "860",
+      "FirstName": "Theophile",
+      "LastName": "Helleboid",
+      "GetItemURI": "https://api.dovico.com/Employees/860/?version=5"
+    }
+  ]
+}
+~~~
+
+## `/TimeEntries`
+### Get Time Entries for one employee
+Query `GET TimeEntries/Employee/860`
+
+Response:
+~~~json
+{
+  "TimeEntries": [
+    {
+      "ID":         "T4d5ba65f-9ebc-4587-a72c-8243b2612a2b",
+      "Sheet":      {"ID":"0", "Status":"N", "RejectedReason":""},
+      "Client":     {"ID":"0", "Name":"[None]", "GetItemURI":"N/A"},
+      "Project":    {"ID":"1269", "Name":"Non-Project Related", "GetItemURI":"https://api.dovico.com/Projects/1269/?version=5"},
+      "Task":       {"ID":"482", "Name":"Other", "GetItemURI":"https://api.dovico.com/Tasks/482/?version=5"},
+      "Employee":   {"ID":"860", "Name":"Helleboid, Theophile", "GetItemURI":"https://api.dovico.com/Employees/860/?version=5"},
+      "Date":       "2017-01-02",
+      "StartTime":  "0900",
+      "StopTime":   "1600",
+      "TotalHours": "7",
+      "Description":"",
+      "Billable":   "T",
+      "Charge":     "0",
+      "ChargeCurrency": {"ID":"-1", "Symbol":"£", "GetItemURI":"N/A"},
+      "OTCharge":   "1",
+      "Wage":       "0",
+      "WageCurrency":{"ID":"-1", "Symbol":"£", "GetItemURI":"N/A"},
+      "OTWage":     "1",
+      "Prorate":    "0",
+      "Integrate":  "",
+      "CustomFields":[]
+    }
+  ],
+  "PrevPageURI": "N/A",
+  "NextPageURI": "N/A"
+}
+~~~
+
+### Create a new TimeEntry
+Query `POST /TimeEntries/`
+Body :
+~~~json
+[
+  {
+    "ProjectID":  "1297",
+    "TaskID":     "4917",
+    "EmployeeID": "111",
+    "Date":       "2011-06-01",
+    "TotalHours": "1"
+  }
+]
+~~~
+
+
+## `/Assignments`
+### Get a list of Assignments (ie, projects)
+Query: `GET /Assignments`
+
+Response
+~~~json
+{
+  "Assignments": [
+    {
+      "AssignmentID": "P1238",
+      "ItemID":       "1238",
+      "Name":         "C004 - iOS Optimisation",
+      "StartDate":    "2017-01-04",
+      "FinishDate":   "2018-01-04",
+      "EstimatedHours":"N/A",
+      "TimeBillableByDefault":"N/A",
+      "ExpensesBillableByDefault":"T",
+      "Charge":       "N/A",
+      "ChargeCurrency":{"ID":"N/A", "Symbol":"N/A", "GetItemURI":"N/A"},
+      "Wage":         "N/A",
+      "WageCurrency": {"ID":"N/A", "Symbol":"N/A", "GetItemURI":"N/A"},
+      "Prorate":      "N/A",
+      "ETC":          "N/A",
+      "Hide":         "N/A",
+      "GetAssignmentsURI":"https://api.dovico.com/Assignments/P1238/?version=5",
+      "GetItemURI":"https://api.dovico.com/Projects/1238/?version=5"
+    }
+  ]
+}
+~~~
+
+### Get a list of task linked to a Project (ie Task)
+Query: `GET /Assignements/P1238`
+
+Response
+~~~json
+{
+  "Assignments": [
+    {
+      "AssignmentID": "T32197",
+      "ItemID":       "100",
+      "Name":         "Core Development",
+      "StartDate":    "N/A",
+      "FinishDate":   "N/A",
+      "EstimatedHours":"N/A",
+      "TimeBillableByDefault":"N/A",
+      "ExpensesBillableByDefault":"N/A",
+      "Charge":       "N/A",
+      "ChargeCurrency": {"ID":"N/A", "Symbol":"N/A", "GetItemURI":"N/A"},
+      "Wage":         "N/A",
+      "WageCurrency":   {"ID":"N/A", "Symbol":"N/A", "GetItemURI":"N/A"},
+      "Prorate":      "N/A",
+      "ETC":          "N/A",
+      "Hide":         "N/A",
+      "GetAssignmentsURI":"https://api.dovico.com/Assignments/T32197/?version=5",
+      "GetItemURI":   "https://api.dovico.com/Tasks/100/?version=5"}],
+      "PrevPageURI":  "N/A",
+      "NextPageURI":  "N/A"
+    }
+  ]
+ }
+~~~

data/dovico-client.gemspec

@@ -0,0 +1,39 @@
+$: << File.expand_path("../lib", __FILE__)
+require 'dovico/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dovico'
+  s.licenses    = ['MIT']
+  s.version     = Dovico::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Théophile Helleboid', 'Paul Bonaud']
+  s.email       = ['theophile.helleboid@trainline.com']
+  s.homepage    = 'https://rubygems.org/gems/dovico'
+  s.summary     = %q(Simple client & tools for http://www.dovico.com/.)
+  s.description = %q(Simple client & tools for http://www.dovico.com/.)
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'easy_app_helper'
+  s.add_dependency 'active_attr'
+  s.add_dependency 'typhoeus'
+
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'guard-rubocop'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'ci_reporter'
+  s.add_development_dependency 'ci_reporter_rspec'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'webmock'
+end