tempest_time 0.5.0

data/lib/tempest_time/api/tempo_api/request.rb

@@ -0,0 +1,35 @@
+require 'httparty'
+require 'json'
+
+require_relative '../request'
+require_relative './response'
+require_relative './authorization'
+require 'byebug'
+module TempoAPI
+  class Request < TempestTime::API::Request
+    def send_request
+      @raw_response = self.class.send(
+        request_method,
+        request_path,
+        headers: headers,
+        body: request_body.empty? ? request_body : request_body.to_json,
+        query: query_params
+      )
+      response
+    end
+
+    private
+
+    def authorization_klass
+      Authorization
+    end
+
+    def headers
+      super.merge(authorization_header)
+    end
+
+    def response_klass
+      TempoAPI::Response
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/requests/create_worklog.rb

@@ -0,0 +1,51 @@
+require_relative '../request'
+require_relative '../responses/create_worklog'
+
+module TempoAPI
+  module Requests
+    class CreateWorklog < TempoAPI::Request
+      def initialize(seconds, options)
+        super
+        @seconds = seconds
+        @remaining = options['remaining']
+        @ticket = options['ticket']
+        @message = options['message']
+        @date = options['date'] ? Date.parse(options['date']) : Date.today
+        @billable = options['billable']
+      end
+
+      private
+
+      attr_reader :ticket, :remaining, :seconds, :message, :date, :billable
+
+      def request_method
+        'post'
+      end
+
+      def request_path
+        '/worklogs'
+      end
+
+      def response_klass
+        TempoAPI::Responses::CreateWorklog
+      end
+
+      def request_body
+        {
+          "issueKey": ticket,
+          "timeSpentSeconds": seconds,
+          "billableSeconds": billable_time,
+          "remainingEstimateSeconds": remaining,
+          "startDate": date.strftime('%Y-%m-%d'),
+          "startTime": '12:00:00',
+          "authorUsername": user,
+          "description": message
+        }
+      end
+
+      def billable_time
+        billable ? seconds : 0
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/requests/delete_worklog.rb

@@ -0,0 +1,29 @@
+require_relative '../request'
+require_relative '../responses/delete_worklog'
+
+module TempoAPI
+  module Requests
+    class DeleteWorklog < TempoAPI::Request
+      attr_reader :worklog_id
+
+      def initialize(worklog_id)
+        super
+        @worklog_id = worklog_id
+      end
+
+      private
+
+      def request_method
+        'delete'
+      end
+
+      def request_path
+        "/worklogs/#{worklog_id}"
+      end
+
+      def response_klass
+        TempoAPI::Responses::DeleteWorklog
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/requests/get_worklog.rb

@@ -0,0 +1,29 @@
+require_relative '../request'
+require_relative '../responses/get_worklog'
+
+module TempoAPI
+  module Requests
+    class GetWorklog < TempoAPI::Request
+      attr_reader :worklog_id
+
+      def initialize(worklog_id)
+        super
+        @worklog_id = worklog_id
+      end
+
+      private
+
+      def request_method
+        'get'
+      end
+
+      def request_path
+        "/worklogs/#{worklog_id}"
+      end
+
+      def response_klass
+        TempoAPI::Responses::GetWorklog
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/requests/list_worklogs.rb

@@ -0,0 +1,41 @@
+require_relative '../request'
+require_relative '../responses/list_worklogs'
+
+module TempoAPI
+  module Requests
+    class ListWorklogs < TempoAPI::Request
+      attr_reader :start_date, :end_date
+
+      def initialize(start_date, end_date, requested_user)
+        super
+        @start_date = start_date
+        @end_date = end_date || start_date
+        @requested_user = requested_user || user
+      end
+
+      private
+
+      attr_reader :requested_user
+
+      def response_klass
+        TempoAPI::Responses::ListWorklogs
+      end
+
+      def request_method
+        'get'
+      end
+
+      def request_path
+        "/worklogs/user/#{requested_user}"
+      end
+
+      def query_params
+        {
+          "from": start_date.strftime(DATE_FORMAT),
+          "to": end_date.strftime(DATE_FORMAT),
+          "limit": 1000
+        }
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/requests/submit_timesheet.rb

@@ -0,0 +1,49 @@
+require_relative '../request'
+require_relative '../../../helpers/time_helper'
+require_relative '../responses/submit_timesheet'
+
+module TempoAPI
+  module Requests
+    class SubmitTimesheet < TempoAPI::Request
+      include TempestTime::Helpers::TimeHelper
+
+      attr_reader :reviewer
+
+      def initialize(reviewer)
+        super
+        @reviewer = reviewer
+      end
+
+      private
+
+      def request_method
+        'post'
+      end
+
+      def request_path
+        "/timesheet-approvals/user/#{user}/submit"
+      end
+
+      def response_klass
+        TempoAPI::Responses::SubmitTimesheet
+      end
+
+      def query_params
+        {
+          from: week_dates.first.strftime(DATE_FORMAT),
+          to: week_dates.last.strftime(DATE_FORMAT)
+        }
+      end
+
+      def request_body
+        {
+          reviewerUsername: reviewer
+        }
+      end
+
+      def week_dates
+        parsed_date_input('week')
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/response.rb

@@ -0,0 +1,5 @@
+require_relative '../response'
+
+module TempoAPI
+  class Response < TempestTime::API::Response; end
+end

data/lib/tempest_time/api/tempo_api/responses/create_worklog.rb

@@ -0,0 +1,28 @@
+require_relative '../response'
+require_relative '../../../helpers/time_helper'
+
+module TempoAPI
+  module Responses
+    class CreateWorklog < TempoAPI::Response
+      include TempestTime::Helpers::TimeHelper
+
+      private
+
+      def worklog_id
+        @worklog_id ||= raw_response['tempoWorklogId']
+      end
+
+      def seconds
+        @seconds ||= raw_response['timeSpentSeconds']
+      end
+
+      def issue_key
+        @issue_key ||= raw_response['issue']['key']
+      end
+
+      def success_message
+        "Worklog #{worklog_id} created!"
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/responses/delete_worklog.rb

@@ -0,0 +1,8 @@
+require_relative '../response'
+
+module TempoAPI
+  module Responses
+    class DeleteWorklog < TempoAPI::Response
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/responses/get_worklog.rb

@@ -0,0 +1,22 @@
+require_relative '../response'
+
+module TempoAPI
+  module Responses
+    class GetWorklog < TempoAPI::Response
+      private
+
+      def worklog
+        @worklog ||= TempoAPI::Models::Worklog.new(
+          id: raw_response['tempoWorklogId'],
+          issue: raw_response.dig('issue', 'key'),
+          seconds: raw_response['timeSpentSeconds'],
+          description: raw_response['description']
+        )
+      end
+
+      def success_message
+        worklog.to_s
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/responses/list_worklogs.rb

@@ -0,0 +1,40 @@
+require_relative '../response'
+require_relative '../models/worklog'
+require_relative '../../../helpers/time_helper'
+
+module TempoAPI
+  module Responses
+    class ListWorklogs < TempoAPI::Response
+      include TempestTime::Helpers::TimeHelper
+
+      attr_reader :worklogs
+
+      def worklogs
+        @worklogs ||= raw_response['results'].map do |worklog|
+          TempoAPI::Models::Worklog.new(
+            id: worklog['tempoWorklogId'],
+            issue: worklog.dig('issue', 'key'),
+            seconds: worklog['timeSpentSeconds'],
+            description: worklog['description']
+          )
+        end
+      end
+
+      private
+
+      def success_message
+        output = ""
+        output << worklogs_output
+        output << "\nTOTAL TIME LOGGED: #{total_hours_spent} hours."
+      end
+
+      def worklogs_output
+        worklogs.map(&:to_s).join("\n")
+      end
+
+      def total_hours_spent
+        worklogs.map(&:hours).reduce(:+)&.round(2) || 0
+      end
+    end
+  end
+end

data/lib/tempest_time/api/tempo_api/responses/submit_timesheet.rb

@@ -0,0 +1,13 @@
+require_relative '../response'
+
+module TempoAPI
+  module Responses
+    class SubmitTimesheet < TempoAPI::Response
+      private
+
+      def success_message
+        "Timesheet submitted successfully to #{request.reviewer}!"
+      end
+    end
+  end
+end

data/lib/tempest_time/cli.rb

@@ -0,0 +1,92 @@
+require 'thor'
+require 'git'
+
+module TempestTime
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'Show version number.'
+    def version
+      require_relative 'version'
+      puts "v#{TempestTime::VERSION}"
+    end
+    map %w(--version -v) => :version
+
+    require_relative 'commands/config'
+    register TempestTime::Commands::Config,
+             'config', 'config [SUBCOMMAND]',
+             'Setup or modify user settings.'
+
+    require_relative 'commands/teams'
+    register TempestTime::Commands::Teams,
+             'teams', 'teams [SUBCOMMAND]',
+             'Add or modify teams.'
+
+    desc 'list [DATE]', 'List worklogs for given date. (Defaults to today.)'
+    long_desc <<-LONGDESC
+      `tempest list` will list a day's worklogs.\n
+      e.g. `tempest list today`\n
+      e.g. `tempest list yesterday`\n
+      e.g. `tempest list 2019-01-31`\n
+      e.g. `tempest list 2019-01-31 --user=jsmith`
+    LONGDESC
+    def list(date = nil)
+      require_relative 'commands/list'
+      TempestTime::Commands::List.new(date, options).execute
+    end
+
+
+    desc 'submit', 'Submit your timesheet to a supervisor.'
+    def submit(*)
+      require_relative 'commands/submit'
+      TempestTime::Commands::Submit.new(options).execute
+    end
+
+    desc 'report', 'Generate a user or team report.'
+    option :week, aliases: '-w', type: :numeric
+    option :team, aliases: '-t', type: :string
+    def report(*users)
+      require_relative 'commands/report'
+      TempestTime::Commands::Report.new(users, options).execute
+    end
+
+    desc 'delete [WORKLOG(S)]', 'Delete worklogs.'
+    long_desc <<-LONGDESC
+      `tempest_time delete` will delete the specified worklogs.\n
+      e.g. `tempest delete 12345`\n
+      e.g. `tempest delete 12345 12346 12347`\n
+    LONGDESC
+    option :autoconfirm, type: :boolean
+    def delete(*worklogs)
+      require_relative 'commands/delete'
+      TempestTime::Commands::Delete.new(worklogs, options).execute
+    end
+
+    desc 'issues', "View a list of a user's assigned tickets. (Defaults to you.)"
+    def issues(user = nil)
+      require_relative 'commands/issues'
+      TempestTime::Commands::Issues.new(user, options).execute
+    end
+
+    desc "track [TIME] [TICKET(S)]", 'Track time to Tempo.'
+    long_desc <<-LONGDESC
+            `tempest track` or `tempest log` will track the specified number of hours or minutes to the ticket(s) specified.\n
+            If not specified, it will check the name of the current git branch and automatically track the logged time to that ticket, if found.\n
+            You can also split a bank of time evenly across multiple tickets with the --split flag.\n
+            e.g. tempest track 1.5h BCIT-1 --message='Tracking 1.5 hours.'\n
+            e.g. tempest log 90m BCIT-1 BCIT-2 --message='Tracking 90 minutes.'\n
+            e.g. tempest track 3h BCIT-1 BCIT-2 BCIT-3 --message='Tracking 1 hour.'\n
+    LONGDESC
+    option :message, aliases: '-m', type: :string
+    option :date, aliases: '-d', type: :string
+    option :remaining, aliases: '-r', type: :string
+    option :billable, aliases: '-b', type: :boolean, default: true
+    option :split, aliases: '-s', type: :boolean, default: false
+    option :autoconfirm, type: :boolean, default: false
+    def track(time, *tickets)
+      require_relative 'commands/track'
+      TempestTime::Commands::Track.new(time, tickets, options).execute
+    end
+  end
+end

data/lib/tempest_time/command.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module TempestTime
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    def execute(*)
+      raise(
+          NotImplementedError,
+          "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    def command
+      require 'tty-command'
+      TTY::Command.new
+    end
+
+    def pastel(**options)
+      require 'pastel'
+      Pastel.new(options)
+    end
+
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    def spinner
+      require 'tty-spinner'
+      TTY::Spinner
+    end
+
+    def table
+      require 'tty-table'
+      TTY::Table
+    end
+
+    def with_spinner(message, format = :pong)
+      s = spinner.new(":spinner #{message}", format: format)
+      s.auto_spin
+      yield(s)
+    end
+
+    def with_success_fail_spinner(message, format = :spin_3)
+      s = spinner.new(":spinner #{message}", format: format)
+      s.auto_spin
+      response = yield
+      if response.success?
+        s.success(pastel.green(response.message))
+      else
+        s.error(pastel.red(response.message))
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/config/edit.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../settings/authorization'
+
+module TempestTime
+  module Commands
+    class Config
+      class Edit < TempestTime::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          settings = TempestTime::Settings::Authorization
+          setting = prompt.select(
+            "Which #{pastel.green('setting')} would you like to edit?",
+            settings.keys
+          )
+
+          new_value = prompt.ask(
+            "Enter the #{pastel.green('new value')}.",
+            default: settings.read(setting)
+          )
+
+          if new_value != settings.read(setting)
+            settings.update(setting, new_value)
+            prompt.say(pastel.green('Setting updated!'))
+          else
+            prompt.say('Nothing changed.')
+          end
+
+          execute if prompt.yes?('Keep editing?')
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/config/setup.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../settings/authorization'
+
+module TempestTime
+  module Commands
+    class Config
+      class Setup < TempestTime::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          email = prompt.ask(
+            'Please enter your Atlassian ID. '\
+            'This is typically your login email.'
+          )
+          username = prompt.ask(
+            'Please enter your Atlassian username.'
+          )
+          subdomain = prompt.ask(
+            'Please enter your Atlassian subdomain. '\
+            'i.e. [THIS VALUE].atlassian.net'
+          )
+          jira_token = prompt.ask(
+            'Please enter your Atlassian API token. '\
+            'Your token can be generated at https://id.atlassian.com/manage/api-tokens'
+          )
+          tempo_token = prompt.ask(
+            'Please enter your Tempo API token. '\
+            "Your token can be generated through your worksheet's settings page."
+          )
+
+          if [email, username, subdomain, jira_token, tempo_token].any?(&:nil?)
+            abort(
+              pastel.red('Setup failed!') + ' ' +
+              'One or more credentials were missing. Please try again.'
+            )
+          end
+
+          authorization = TempestTime::Settings::Authorization
+
+          authorization.update('email', email)
+          authorization.update('username', username)
+          authorization.update('subdomain', subdomain)
+          authorization.update('jira_token', jira_token)
+          authorization.update('tempo_token', tempo_token)
+
+          puts pastel.green('Setup complete!')
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/config.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module TempestTime
+  module Commands
+    class Config < Thor
+
+      namespace :config
+
+      desc 'setup', 'Set up Tempest with your credentials.'
+      def setup(*)
+        require_relative 'config/setup'
+        TempestTime::Commands::Config::Setup.new(options).execute
+      end
+
+      desc 'edit', 'Modify your user credentials.'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def edit(*)
+        if options[:help]
+          invoke :help, ['auth']
+        else
+          require_relative 'config/edit'
+          TempestTime::Commands::Config::Edit.new(options).execute
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/delete.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../api/tempo_api/requests/delete_worklog'
+
+module TempestTime
+  module Commands
+    class Delete < TempestTime::Command
+      def initialize(worklogs, options)
+        @worklogs = worklogs
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        pluralized = @worklogs.length > 1 ? 'worklogs' : 'worklog'
+        confirm_message =
+          "Delete #{pluralized} #{pastel.green(@worklogs.join(', '))}?"
+        abort unless prompt.yes?(confirm_message)
+        @worklogs.each { |worklog| delete_worklog(worklog) }
+      end
+
+      private
+
+      def delete_worklog(worklog)
+        with_success_fail_spinner("Deleting worklog #{worklog}...", :spin_3) do
+          TempoAPI::Requests::DeleteWorklog.new(worklog).send_request
+        end
+      end
+    end
+  end
+end