Merge pull request #2 from snturk/feature/1/sync_integration

feature: Sync Support

Author: snturk

.gitignore

@@ -27,4 +27,5 @@ go.work
 .DS_Store
 
 # Time entries for Timmy
-.timmy.entries/
+.timmy.entries/
+timmy

README.md

@@ -12,6 +12,50 @@ TODO
 
 ## Usage
 
+
+### Define environment variables
+
+Timmy uses environment variables to connect and sync to toggl and place time entries. You can define these variables in your `.bashrc` or `.zshrc` file.
+
+```bash
+# Timmy environment variables
+# Optional, by default it will use $HOME/.timmy-entries
+export TIMMY_PATH="path/to/.timmy-entries"
+export TOGGL_WORKSPACE_ID="WORKSPACE_ID"
+export TOGGL_API_TOKEN="API_TOKEN"
+```
+### Commands
+
+`start` starts a new time entry with a task name `--task`.
+
+```bash
+timmy start --task "My task"
+```
+
+`stop` stops the current time entry.
+
+```bash
+timmy stop
+```
+
+`current` shows the current time entry, if any.
+
+```bash
+timmy current
+```
+
+`today` shows all time entries for today.
+
+```bash
+timmy today
+```
+
+`sync` syncs non-synced time entries with toggl, if you defined `TOGGL_WORKSPACE_ID` and `TOGGL_API_TOKEN` environment variables.
+
+```bash
+timmy sync
+```
+
 Just build and run the executable. It will create a `.timmy-entries` directory in your home directory and store all entries there.
 
 ```bash
@@ -23,4 +67,4 @@ go build
 
 ## Contributing
 
-Pull requests are always welcome. 
+Pull requests and issues are always welcome. 

cmd/current.go

@@ -0,0 +1,26 @@
+/*
+Copyright © 2024 Muratcan Senturk <[email protected]>
+*/
+package cmd
+
+import (
+	"fmt"
+	"github.com/snturk/timmy/internal/service"
+	"github.com/spf13/cobra"
+)
+
+var currentCmd = &cobra.Command{
+	Use:   "current",
+	Short: "Shows the current time entry, if any.",
+	Long:  `Shows the current time entry, if any.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		err := service.PrintCurrent()
+		if err != nil {
+			fmt.Println(err)
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(currentCmd)
+}

cmd/root.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+Copyright © 2024 Muratcan Senturk <[email protected]>
 */
 package cmd
 

cmd/start.go

@@ -14,7 +14,7 @@ import (
 var startCmd = &cobra.Command{
 	Use:   "start",
 	Short: "Start the time tracker",
-	Long:  `This will start the time tracker with provided task name.`,
+	Long:  `This will start the time tracker with provided task name. If there is a running time entry, it will return an error.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		// Task name is required
 		if len(args) < 1 {

cmd/stop.go

@@ -1,24 +1,20 @@
 /*
-Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+Copyright © 2024 Muratcan Senturk <[email protected]>
 */
 package cmd
 
 import (
 	"fmt"
+
 	"github.com/snturk/timmy/internal/service"
 	"github.com/spf13/cobra"
 )
 
 // stopCmd represents the stop command
 var stopCmd = &cobra.Command{
 	Use:   "stop",
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Short: "Stops the currently running time entry.",
+	Long:  `Stops the currently running time entry. If there is no running time entry, it will return an error.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		fmt.Print("Stopping time tracker... ")
 		err := service.StopTimeEntry()

cmd/sync.go

@@ -0,0 +1,39 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"fmt"
+	"github.com/snturk/timmy/internal/service"
+	"github.com/spf13/cobra"
+)
+
+// syncCmd represents the sync command
+var syncCmd = &cobra.Command{
+	Use:   "sync",
+	Short: "Sync local time entry file with Toggl.",
+	Long:  `Sync local time entry file with Toggl. Only the entries that are not fetched from Toggl will be fetched.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		err := service.FetchTodayToToggl()
+		if err != nil {
+			fmt.Printf("error while fetching today's time entries to Toggl: %v\n", err)
+		} else {
+			fmt.Println("successfully fetched today's time entries to Toggl")
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(syncCmd)
+
+	// Here you will define your flags and configuration settings.
+
+	// Cobra supports Persistent Flags which will work for this command
+	// and all subcommands, e.g.:
+	// syncCmd.PersistentFlags().String("foo", "", "A help for foo")
+
+	// Cobra supports local flags which will only run when this command
+	// is called directly, e.g.:
+	// syncCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+}

cmd/today.go

@@ -1,10 +1,11 @@
 /*
-Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+Copyright © 2024 Muratcan Senturk <[email protected]>
 */
 package cmd
 
 import (
 	"fmt"
+
 	"github.com/snturk/timmy/internal/service"
 	"github.com/spf13/cobra"
 )

internal/config/config.go

@@ -0,0 +1,32 @@
+package config
+
+import (
+	"os"
+	"strconv"
+)
+
+// Model represents the configurations of the application.
+type Model struct {
+	// Toggl API token.
+	TogglApiKey string `json:"toggl_api_key"`
+	// Toggl workspace ID.
+	TogglWorkspaceId int64 `json:"toggl_workspace_id"`
+}
+
+// GetConfig returns the configuration of the application.
+func GetConfig() (Model, error) {
+	var config Model
+	workspaceId, err := strconv.ParseInt(os.Getenv("TOGGL_WORKSPACE_ID"), 10, 64)
+	if err != nil {
+		return config, err
+	}
+
+	togglApiToken := os.Getenv("TOGGL_API_TOKEN")
+
+	config = Model{
+		TogglApiKey:      togglApiToken,
+		TogglWorkspaceId: workspaceId,
+	}
+
+	return config, nil
+}

internal/constants/common.go

@@ -1,6 +1,6 @@
 package constants
 
 const (
-	DateTimeFormat  = "2006-01-02 15:04:05"
+	DateTimeFormat  = "2006-01-02T15:04:05-07:00"
 	FileDataDivider = " | "
 )

internal/model/time-entry.go

@@ -2,9 +2,10 @@ package model
 
 import (
 	"bytes"
-	"github.com/snturk/timmy/internal/constants"
 	"strconv"
 	"time"
+
+	"github.com/snturk/timmy/internal/constants"
 )
 
 // TimeEntry represents a single time entry.
@@ -17,6 +18,8 @@ type TimeEntry struct {
 	Task string `json:"task"`
 	// Is the entry currently running?
 	Running bool `json:"running"`
+	// Is the entry fetched with Toggl?
+	Fetched bool `json:"fetched"`
 }
 
 // String returns a string representation of the time entry.
@@ -30,10 +33,21 @@ func (entry TimeEntry) String() string {
 	entryString.WriteString(entry.Task)
 	entryString.WriteString(constants.FileDataDivider)
 	entryString.WriteString(strconv.FormatBool(entry.Running))
+	entryString.WriteString(constants.FileDataDivider)
+	entryString.WriteString(strconv.FormatBool(entry.Fetched))
 
 	return entryString.String()
 }
 
+// GetDuration returns the duration of the time entry.
+func (entry TimeEntry) GetDuration() time.Duration {
+	if entry.Running {
+		return time.Now().Local().Sub(entry.Start)
+	} else {
+		return entry.End.Sub(entry.Start)
+	}
+}
+
 // ParseTimeEntry parses a string representation of a time entry.
 func ParseTimeEntry(entryString string) (TimeEntry, error) {
 	var entry TimeEntry
@@ -63,5 +77,11 @@ func ParseTimeEntry(entryString string) (TimeEntry, error) {
 		return entry, err
 	}
 
+	// Parse the fetched status.
+	entry.Fetched, err = strconv.ParseBool(string(entryData[4]))
+	if err != nil {
+		return entry, err
+	}
+
 	return entry, nil
 }

internal/model/toggl.go

@@ -0,0 +1,13 @@
+package model
+
+type TogglManualTimeRequest struct {
+	Description string   `json:"description"`
+	Tags        []string `json:"tags"`
+	/**
+	 * Duration in seconds.
+	 */
+	Duration    int    `json:"duration"`
+	Start       string `json:"start"`
+	WorkspaceId int    `json:"workspace_id"`
+	CreatedWith string `json:"created_with"`
+}