dovico 1.0.0

data/dovico.yml.example

@@ -0,0 +1,26 @@
+# Personal token. Can be reset through Dovico setting page
+user_token: "...."
+# Your company 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

data/lib/dovico.rb

@@ -0,0 +1,9 @@
+require 'dovico/version'
+require 'dovico/api_client'
+require 'dovico/app'
+require 'dovico/model/assignment'
+require 'dovico/model/time_entry_generator'
+require 'dovico/model/employee'
+require 'dovico/model/project'
+require 'dovico/model/task'
+require 'dovico/model/time_entry'

data/lib/dovico/api_client.rb

@@ -0,0 +1,67 @@
+require 'typhoeus'
+require 'json'
+
+module Dovico
+  class ApiClient
+    API_URL = "https://api.dovico.com/"
+    API_VERSION = "5"
+
+    class << self
+      def initialize!(client_token, user_token)
+        @client_token = client_token
+        @user_token = user_token
+      end
+
+      def get(path, params: {})
+        perform!(:get, path, params: params)
+      end
+
+      def post(path, params: {}, body: nil)
+        perform!(:post, path, params: params, body: body)
+      end
+
+      def put(path, params: {}, body: nil)
+        perform!(:put, path, params: params, body: body)
+      end
+
+      private
+
+      attr_accessor :client_token, :user_token
+
+      def authorization_token
+        "WRAP access_token=\"client=#{client_token}&user_token=#{user_token}\""
+      end
+
+      def request_headers
+        {
+          "Accept"        => "application/json",
+          "Content-Type"  => "application/json",
+          "Authorization" => authorization_token,
+        }
+      end
+
+      def perform!(method, path, params: {}, body: nil)
+        request = Typhoeus::Request.new(
+          "#{API_URL}#{path}",
+          method: method,
+          params: params.merge(version: API_VERSION),
+          headers: request_headers,
+          body: body,
+        )
+
+        response = request.run
+
+        if response.code != 200
+          response = JSON.parse(response.body)
+          puts "== Error during HTTP request =="
+          puts "Status:      #{response["Status"]}"
+          puts "Description: #{response["Description"]}"
+          puts ""
+          raise "Error during HTTP request"
+        end
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/dovico/app.rb

@@ -0,0 +1,138 @@
+require 'easy_app_helper'
+
+module Dovico
+  class App
+    include EasyAppHelper
+
+    NAME = 'Dovico Simple Client'
+    DESCRIPTION = <<EOL
+Simple client for Dovico TimeSheet web application.
+
+Please refer to the README.md page to setup your client.
+
+WARNING: --auto and --simulate options are not effective.
+EOL
+
+    def initialize
+      config.config_file_base_name = 'dovico'
+      config.describes_application app_name: NAME,
+                                   app_version: Dovico::VERSION,
+                                   app_description: DESCRIPTION
+      add_script_options
+
+      ApiClient.initialize!(config["client_token"], config["user_token"])
+    end
+
+    def add_script_options
+      config.add_command_line_section('Display informations') do |slop|
+        slop.on :myself, 'Display info on yourself', argument: false
+        slop.on :tasks,  'Display info on tasks',    argument: false
+      end
+      config.add_command_line_section('Fill the timesheets') do |slop|
+        slop.on :fill,         'Fill the timesheet',    argument: false
+      end
+      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 (for --fill and --submit)') do |slop|
+        slop.on :current_week, 'Current week', argument: false
+        slop.on :today,        'Current day',  argument: false
+        slop.on :day,          'Specific day', argument: true
+        slop.on :week,         'Specific "commercial" week. See https://www.epochconverter.com/weeks/',  argument: true, as: Integer
+        slop.on :year,         '[optional] Specifiy year (for --week option), default current year',  argument: true, as: Integer
+      end
+    end
+
+    def run
+      if config[:help] || !(config[:myself] || config[:tasks] || config[:fill] || config[:submit])
+        display_help
+        exit 0
+      end
+
+      if config[:myself]
+        display_myself
+      end
+
+      if config[:tasks]
+        display_tasks
+      end
+
+      if config[:fill] || config[:submit]
+        start_date, end_date = parse_date_options
+
+        time_entry_generator = TimeEntryGenerator.new(
+          assignments: config["assignments"],
+          employee_id: myself.id,
+        )
+      end
+
+      if config[:fill]
+        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}"
+      end
+
+      if config[:submit]
+        submitted_time_entries = TimeEntry.submit!(myself.id, start_date, end_date)
+        puts "#{submitted_time_entries["TimeEntries"].count} Entries submitted between #{start_date} and #{end_date}"
+      end
+    end
+
+    private
+
+    def myself
+      @myself ||= Employee.myself
+    end
+
+    def display_myself
+      puts "Informations about yourself"
+      puts " - ID:         #{myself.id}"
+      puts " - First Name: #{myself.first_name}"
+      puts " - Last Name:  #{myself.last_name}"
+      puts ""
+    end
+
+    def display_tasks
+      projects = Project.all
+
+      puts "== List of available projects =="
+      puts " Project | Task | Description"
+      projects.each do |project|
+        if project.tasks.count > 0
+          project.tasks.each do |task|
+            puts sprintf ' %7d | %4d | %s: %s', project.id, task.id, project.name, task.name
+          end
+        else
+          puts sprintf " %7d |      | %s (No tasks linked)", project.id, task.name
+        end
+      end
+      puts ""
+    end
+
+    def parse_date_options
+      if config[:week]
+        year = config[:year] || Date.current.year
+        start_date = Date.commercial(year, config[:week]).beginning_of_week
+        end_date = start_date.advance(days: 4)
+      elsif config[:current_week]
+        start_date = Date.current.beginning_of_week
+        end_date = start_date.advance(days: 4)
+      elsif config[:day]
+        start_date = end_date = Date.parse(config[:day])
+      elsif config[:today]
+        start_date = end_date = Date.current
+      else
+        puts "Error : You must precise one date options"
+        display_help
+        exit 1
+      end
+
+      [start_date, end_date]
+    end
+
+    def display_help
+      puts config.command_line_help
+    end
+  end
+end

data/lib/dovico/model/assignment.rb

@@ -0,0 +1,26 @@
+require 'active_attr'
+
+module Dovico
+  class Assignment
+    URL_PATH = 'Assignments/'
+
+    include ActiveAttr::Model
+
+    attribute :id
+    attribute :assignement_id
+    attribute :name
+    attribute :start_date
+    attribute :finish_date
+
+
+    def self.parse(hash)
+      self.new(
+        id:           hash["ItemID"],
+        assignement_id: hash["AssignmentID"],
+        name:         hash["Name"],
+        start_date:   hash["StartDate"],
+        finish_date:  hash["FinishDate"]
+      )
+    end
+  end
+end

data/lib/dovico/model/employee.rb

@@ -0,0 +1,27 @@
+require 'active_attr'
+
+module Dovico
+  class Employee
+    URL_PATH = 'Employees/'
+
+    include ActiveAttr::Model
+
+    attribute :id
+    attribute :first_name
+    attribute :last_name
+
+    def self.parse(hash)
+      Employee.new(
+        id:         hash["ID"],
+        first_name: hash["FirstName"],
+        last_name:  hash["LastName"],
+      )
+    end
+
+    def self.myself
+      employees = ApiClient.get("#{URL_PATH}/Me")
+
+      parse(employees["Employees"].first)
+    end
+  end
+end

data/lib/dovico/model/project.rb

@@ -0,0 +1,18 @@
+require 'active_attr'
+
+module Dovico
+  class Project < Assignment
+
+    attribute :tasks
+
+    def self.all
+      projects_search = ApiClient.get(URL_PATH)
+      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) }
+      end
+    end
+  end
+end

data/lib/dovico/model/task.rb

@@ -0,0 +1,6 @@
+require 'active_attr'
+
+module Dovico
+  class Task < Assignment
+  end
+end

data/lib/dovico/model/time_entry.rb

@@ -0,0 +1,83 @@
+require 'active_attr'
+
+module Dovico
+  class TimeEntry
+    URL_PATH = 'TimeEntries/'
+
+    include ActiveAttr::Model
+
+    attribute :id
+    attribute :start_time
+    attribute :stop_time
+    attribute :project_id
+    attribute :task_id
+    attribute :employee_id
+    attribute :date
+    attribute :total_hours
+    attribute :description
+
+    def self.parse(hash)
+      TimeEntry.new(
+        id:         parse_id(hash['ID']),
+        start_time: hash['StartTime'],
+        stop_time:  hash['StopTime'],
+        project_id: hash['Project']['ID'],
+        task_id:    hash['Task']['ID'],
+        employee_id:hash['Employee']['ID'],
+        date:       hash['Date'],
+        total_hours:hash['TotalHours'],
+        description:hash['Description']
+      )
+    end
+
+    def self.get(id)
+      entry = ApiClient.get("#{URL_PATH}/#{id}")["TimeEntries"].first
+      TimeEntry.parse(entry)
+    end
+
+    def self.batch_create!(assignments)
+      api_assignements = assignments.map(&:to_api)
+      ApiClient.post(URL_PATH, body: api_assignements.to_json)
+    end
+
+    def self.submit!(employee_id, start_date, end_date)
+      ApiClient.post(
+        "#{URL_PATH}/Employee/#{employee_id}/Submit",
+        params: {
+          daterange: "#{start_date} #{end_date}"
+        },
+        body: {}.to_json,
+      )
+    end
+
+    def create!
+      ApiClient.post(URL_PATH, body: [to_api].to_json)
+    end
+
+    def update!
+      ApiClient.put(URL_PATH, body: [to_api].to_json)
+    end
+
+    def to_api
+      {
+        "ID":         id,
+        "StartTime":  start_time,
+        "StopTime":   stop_time,
+        "ProjectID":  project_id.to_s,
+        "TaskID":     task_id.to_s,
+        "EmployeeID": employee_id.to_s,
+        "Date":       date,
+        "TotalHours": total_hours.to_s,
+        "Description": description,
+      }.compact.stringify_keys
+    end
+
+    private
+
+    def self.parse_id(long_id)
+      # T: ID is a GUID, non-approved
+      # M: ID is a long, approved
+      long_id.sub(/^(T|M)/, "")
+    end
+  end
+end

data/lib/dovico/model/time_entry_generator.rb

@@ -0,0 +1,58 @@
+require 'active_attr'
+
+module Dovico
+  class TimeEntryGenerator
+    DEFAULT_START_HOUR = 9
+
+    def initialize(assignments:, employee_id:)
+      @assignments = assignments
+      @employee_id = employee_id
+    end
+
+    def generate(start_date, end_date)
+      start_date.upto(end_date).flat_map do |day|
+        build_day_time_entries(day)
+      end
+    end
+
+    private
+    attr_accessor :assignments, :employee_id
+
+    def build_day_time_entries(day)
+      time_entries = []
+      start_date = Time.parse(day.to_s).advance(hours: DEFAULT_START_HOUR)
+
+      day_assignments = day_assignments(day)
+      day_assignments.each do |assignment|
+        time_entry = build_time_entry(assignment, start_date)
+        time_entries << time_entry
+
+        start_date = start_date.advance(hours: time_entry.total_hours.to_f)
+      end
+      time_entries
+    end
+
+    def build_time_entry(assignment, start_date)
+      project_id  = assignment["project_id"]
+      task_id     = assignment["task_id"]
+      hours       = assignment["hours"]
+      stop_date   = start_date.advance(hours: hours)
+      start_time  = sprintf "%02d%02d", start_date.hour, start_date.min
+      stop_time   = sprintf "%02d%02d", stop_date.hour, stop_date.min
+
+      TimeEntry.new(
+        employee_id: employee_id,
+        project_id:  project_id,
+        task_id:     task_id,
+        date:        start_date.to_date.to_s,
+        total_hours: hours,
+        start_time:  start_time,
+        stop_time:   stop_time,
+      )
+    end
+
+    def day_assignments(date)
+      assignments[date.to_s] || assignments["default_day"]
+    end
+  end
+end