tempest_time 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35061a30f433d5e3bd350345cebd9e360979284f
-  data.tar.gz: a9bd9bef56747b2b69a9966b2b0a2220c3ce8952
+  metadata.gz: a0741b1d3f1af0e3145fbcb9039d3856135c455d
+  data.tar.gz: f8c88a25127cfb070a31b6ad76da191306e49faf
 SHA512:
-  metadata.gz: 3d11c9b88e5d80415830c6d4bd919dd745a4e9558d0f0284d85913a0e3d429a13d57ac2e8fe5ca1f4301fc017f4fded2abaf31bd4df0b862803ee739faac7d8f
-  data.tar.gz: c988aa0a5a2db5423fe73932047b676afc95aea7a25e49efca5bcb982223f9193d3a492a5bb9e8c268bcd559f042c94f5de5a6322996090e6cce63febc61ea40
+  metadata.gz: 6243e1801cdcc99e376cc1a57ad36022c3ef7cd2077adbb584c5a6c3d505308523ad6e63fa2f4813d9aec99fe71261957834b1ac5a8fb914a6f6966a7b8ccd8e
+  data.tar.gz: f1fa740661e844fca870aa50848560e93eb5ec309a8ccaa9380ee94f5af4ef7f1e4180970958c52341f62d014b4f4be1bd2fbbf40003f9d887236bbc18f79e83

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

@@ -0,0 +1,40 @@
+require_relative '../request'
+require_relative '../responses/get_user_schedule'
+
+module TempoAPI
+  module Requests
+    class GetUserSchedule < 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 request_method
+        'get'
+      end
+
+      def request_path
+        "/user-schedule/#{requested_user}"
+      end
+
+      def query_params
+        {
+          "from": start_date.strftime(DATE_FORMAT),
+          "to": end_date.strftime(DATE_FORMAT),
+        }
+      end
+
+      def response_klass
+        TempoAPI::Responses::GetUserSchedule
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../response'
+require_relative '../../../helpers/time_helper'
+
+module TempoAPI
+  module Responses
+    class GetUserSchedule < TempoAPI::Response
+      include TempestTime::Helpers::TimeHelper
+
+      def required_seconds
+        results.map { |result| result['requiredSeconds'] }.reduce(:+)
+      end
+
+      private
+
+      def results
+        @results = raw_response['results'] || []
+      end
+    end
+  end
+end

data/lib/tempest_time/cli.rb

@@ -31,6 +31,12 @@ module TempestTime
              'issue', 'issue [SUBCOMMAND]',
              'View and modify Jira issues.'
 
+    desc 'setup', 'Perform initial Tempest setup.'
+    def setup(*)
+      require_relative 'commands/setup'
+      TempestTime::Commands::Setup.new(options).execute
+    end
+
     desc 'list', 'List worklogs for a specific date.'
     option :user, aliases: '-u', type: :string
     option :date, aliases: '-d', type: :string

data/lib/tempest_time/commands/config.rb

@@ -7,16 +7,16 @@ module TempestTime
     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
+      desc 'edit', 'Modify your jira/tempo authentication settings.'
+      def auth(*)
+        require_relative 'config/auth'
+        TempestTime::Commands::Config::Auth.new(options).execute
       end
 
-      desc 'edit', 'Modify your user credentials.'
-      def edit(*)
-        require_relative 'config/edit'
-        TempestTime::Commands::Config::Edit.new(options).execute
+      desc 'app', 'Modify your app settings.'
+      def app(*)
+        require_relative 'config/app'
+        TempestTime::Commands::Config::App.new(options).execute
       end
     end
   end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../settings/app'
+
+module TempestTime
+  module Commands
+    class Config
+      class App < TempestTime::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute!
+          settings = TempestTime::Settings::App.new
+          setting = prompt.select(
+            "Which #{pastel.green('setting')} would you like to edit?",
+            available_options
+          )
+
+          current = settings.fetch(setting)
+          new_value = send(setting, current)
+
+          if new_value != settings.fetch(setting)
+            settings.set(setting, new_value)
+            prompt.say(pastel.green('Setting updated!'))
+          else
+            prompt.say('Nothing changed.')
+          end
+
+          execute if prompt.yes?('Keep editing?')
+        end
+
+        private
+
+        def available_options
+          [
+            'internal_projects',
+          ]
+        end
+
+        def internal_projects(current)
+          message =
+            'Please enter the ' + pastel.green('project codes') + ' of internal projects. '\
+            'This is used to calculate utilization percentage in reporting. (Comma-separated)'
+          prompt.ask(message, default: current&.join(', ')) do |q|
+            q.convert ->(input) { input.split(/,\s*/) }
+          end.sort
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/config/{edit.rb → auth.rb}

@@ -6,7 +6,7 @@ require_relative '../../settings/authorization'
 module TempestTime
   module Commands
     class Config
-      class Edit < TempestTime::Command
+      class Auth < TempestTime::Command
         def initialize(options)
           @options = options
         end

data/lib/tempest_time/commands/report.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require_relative '../command'
+require_relative '../settings/app'
 require_relative '../settings/teams'
 require_relative '../api/tempo_api/requests/list_worklogs'
+require_relative '../api/tempo_api/requests/get_user_schedule'
 require_relative '../models/report'
 
 module TempestTime
@@ -32,6 +34,7 @@ module TempestTime
                        "#{formatted_date(end_date)}"
           prompt.say("\nReport for #{pastel.green(date_range)}")
           puts table
+          display_warnings
         end
       end
 
@@ -69,34 +72,54 @@ module TempestTime
         @end_date ||= week_dates(@week).last
       end
 
+      def required_seconds
+        @required_seconds ||= TempoAPI::Requests::GetUserSchedule.new(
+          start_date: start_date,
+          end_date: end_date,
+          requested_user: @users.first
+        ).send_request.required_seconds
+      end
+
       def reports
         @reports ||= @users.map do |user|
-          list = TempoAPI::Requests::ListWorklogs.new(
+          worklogs = TempoAPI::Requests::ListWorklogs.new(
             start_date,
             end_date: end_date,
             requested_user: user
-          ).send_request
-          TempestTime::Models::Report.new(user, list.worklogs)
+          ).send_request.worklogs
+
+          TempestTime::Models::Report.new(
+            user: user,
+            required_seconds: required_seconds,
+            worklogs: worklogs,
+            internal_projects: internal_projects
+          )
         end || []
       end
 
       def aggregate
         @aggregate ||= TempestTime::Models::Report.new(
-          'TOTAL',
-          reports.flat_map(&:worklogs),
-          number_of_users: @users.count
+          user: 'TOTAL',
+          worklogs: reports.flat_map(&:worklogs),
+          required_seconds: required_seconds,
+          number_of_users: @users.count,
+          internal_projects: internal_projects
         )
       end
 
       def projects
         @projects ||= reports.flat_map(&:projects).uniq.sort.tap do |projects|
-          projects.delete('BCIT')
-          projects.unshift('BCIT')
+          # Put internal project codes at the front of the array.
+          internal_projects.reverse.each do |code|
+            next unless projects.include?(code)
+            projects.delete(code)
+            projects.unshift(code)
+          end
         end
       end
 
       def table_headings
-        %w(User COMP% UTIL%) + projects
+        %w(User COMP% UTIL%) + projects + ['TOTAL HOURS']
       end
 
       def render_table
@@ -123,6 +146,12 @@ module TempestTime
             )
           )
         end
+        row.push(
+          right_align(
+            formatted_time_for_input(data.total_seconds_logged).to_s +
+              ' / ' + formatted_time_for_input(data.required_seconds).to_s
+          )
+        )
         row
       end
 
@@ -134,6 +163,22 @@ module TempestTime
         return '' unless decimal.positive?
         (decimal * 100.0).round(1).to_s + '%'
       end
+
+      def internal_projects
+        @internal_projects ||= TempestTime::Settings::App.new.fetch('internal_projects') || []
+      end
+
+      def display_warnings
+        if internal_projects.empty?
+          prompt.say(
+            pastel.yellow(
+              'You have not set any internal projects. '\
+              'To calculate utilization percentage correctly, please add an internal project. '\
+              '(`tempest config app`)'
+            )
+          )
+        end
+      end
     end
   end
 end

data/lib/tempest_time/commands/setup.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../settings/authorization'
+require_relative '../settings/app'
+require_relative '../api/jira_api/requests/get_current_user'
+require_relative '../api/tempo_api/requests/list_worklogs'
+
+module TempestTime
+  module Commands
+    class Setup < TempestTime::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute!
+        check_for_completion
+        set_authorization_values
+        set_app_settings
+        with_spinner('Checking credentials...') do |spinner|
+          begin
+            check_for_validity
+            spinner.stop(pastel.green("Success! You're ready to go!"))
+          rescue StandardError
+            spinner.stop(
+              pastel.red("Something isn't right... please re-run setup.")
+            )
+          end
+        end
+      end
+
+      private
+
+      def credentials
+        @credentials ||= {
+          'email' => email,
+          'username' => username,
+          'subdomain' => subdomain,
+          'jira_token' => jira_token,
+          'tempo_token' => tempo_token,
+        }
+      end
+
+      def app_settings_values
+        @app_settings_values ||= {
+          'internal_projects' => internal_projects,
+        }
+      end
+
+      def authorization
+        @authorization ||= TempestTime::Settings::Authorization.new
+      end
+
+      def app_settings
+        @app_settings ||= TempestTime::Settings::App.new
+      end
+
+      def check_for_completion
+        return true unless credentials.any? { |_, value| value.nil? }
+        abort(
+          pastel.red('Setup failed!') + ' ' \
+          'One or more credentials were missing. Please try again.'
+        )
+      end
+
+      def set_authorization_values
+        credentials.map { |key, value| authorization.set(key, value) }
+      end
+
+      def set_app_settings
+        app_settings_values.map { |key, value| app_settings.set(key, value) }
+      end
+
+      def check_for_validity
+        jira = JiraAPI::Requests::GetCurrentUser.new
+        tempo = TempoAPI::Requests::ListWorklogs.new(Date.today)
+        raise StandardError unless jira.send_request.success?
+        raise StandardError unless tempo.send_request.success?
+      end
+
+      def email
+        prompt.ask(
+          'Please enter your Atlassian ID. '\
+          'This is typically your login email.',
+          default: authorization.fetch('email')
+        )
+      end
+
+      def username
+        prompt.ask(
+          'Please enter your Atlassian username.',
+          default: authorization.fetch('username')
+        )
+      end
+
+      def subdomain
+        prompt.ask(
+          'Please enter your Atlassian subdomain. '\
+          'i.e. [THIS VALUE].atlassian.net',
+          default: authorization.fetch('subdomain')
+        )
+      end
+
+      def jira_token
+        prompt.ask(
+          'Please enter your Atlassian API token. '\
+          'Your token can be generated at '\
+          'https://id.atlassian.com/manage/api-tokens',
+          default: authorization.fetch('jira_token')
+        )
+      end
+
+      def tempo_token
+        prompt.ask(
+          'Please enter your Tempo API token. '\
+          'Your token can be generated through '\
+          "your worksheet's settings page.",
+          default: authorization.fetch('tempo_token')
+        )
+      end
+
+      def internal_projects
+        current = app_settings.fetch('internal_projects')&.join(', ') || ''
+
+        prompt.ask(
+          'Please enter the project codes of internal projects. (Optional, comma-separated.) '\
+          'This is used to calculate utilization percentage in reporting.',
+          default: current
+        ) do |q|
+          q.convert ->(input) { input.split(/,\s*/) }
+        end.sort
+      end
+    end
+  end
+end

data/lib/tempest_time/models/report.rb

@@ -4,15 +4,14 @@ module TempestTime
   module Models
     class Report
       include TempestTime::Helpers::FormattingHelper
-      EXPECTED_SECONDS = (37.5 * 60 * 60).to_i.freeze
-      INTERNAL_PROJECT = 'BCIT'.freeze
+      attr_reader :user, :worklogs, :number_of_users, :required_seconds, :internal_projects
 
-      attr_reader :user, :worklogs, :number_of_users
-
-      def initialize(user, worklogs, number_of_users: 1)
+      def initialize(user:, worklogs:, required_seconds:, internal_projects:, number_of_users: 1)
         @user = user
         @worklogs = worklogs
         @number_of_users = number_of_users
+        @required_seconds = required_seconds * number_of_users
+        @internal_projects = internal_projects
       end
 
       def project_total_times
@@ -22,7 +21,7 @@ module TempestTime
       end
 
       def compliance_percentage(time)
-        (time.to_f / (EXPECTED_SECONDS * number_of_users))
+        (time.to_f / (required_seconds * number_of_users))
       end
 
       def project_compliance_percentages
@@ -38,11 +37,15 @@ module TempestTime
       def utilization_percentage
         @utilization_percentage ||=
           project_compliance_percentages.inject(0) do |memo, (project, percentage)|
-            memo += percentage unless project == INTERNAL_PROJECT
+            memo += percentage unless internal_projects.include?(project)
             memo
           end
       end
 
+      def total_seconds_logged
+        @total_seconds_logged ||= time_logged_seconds(worklogs)
+      end
+
       def time_logged_seconds(logs)
         logs.flat_map(&:seconds).reduce(:+)
       end

data/lib/tempest_time/setting.rb

@@ -44,6 +44,8 @@ module TempestTime
     def read_config
       config.read
       yield
+    rescue TTY::Config::ReadError
+      nil
     end
 
     def write_config

data/lib/tempest_time/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TempestTime
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/tempest_time.gemspec

@@ -14,6 +14,15 @@ Gem::Specification.new do |spec|
   spec.description   = %q(Log time and more... directly from the command line!)
   spec.homepage      = 'https://github.com/devanhurst/tempest_time'
 
+  spec.post_install_message = %q(
+    Thank you for installing Tempest!
+
+    If this is your first time installing, please run `tempest setup` to provide your Atlassian credentials.
+
+    UPDATE: v1.2.0 makes changes to how reports are calculated!
+    If you have been using this feature, please run `tempest config app` to set up your internal project codes.
+  )
+
   spec.required_ruby_version = '~> 2.3'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tempest_time
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Devan Hurst
@@ -262,26 +262,29 @@ files:
 - lib/tempest_time/api/tempo_api/request.rb
 - lib/tempest_time/api/tempo_api/requests/create_worklog.rb
 - lib/tempest_time/api/tempo_api/requests/delete_worklog.rb
+- lib/tempest_time/api/tempo_api/requests/get_user_schedule.rb
 - lib/tempest_time/api/tempo_api/requests/get_worklog.rb
 - lib/tempest_time/api/tempo_api/requests/list_worklogs.rb
 - lib/tempest_time/api/tempo_api/requests/submit_timesheet.rb
 - lib/tempest_time/api/tempo_api/response.rb
 - lib/tempest_time/api/tempo_api/responses/create_worklog.rb
 - lib/tempest_time/api/tempo_api/responses/delete_worklog.rb
+- lib/tempest_time/api/tempo_api/responses/get_user_schedule.rb
 - lib/tempest_time/api/tempo_api/responses/get_worklog.rb
 - lib/tempest_time/api/tempo_api/responses/list_worklogs.rb
 - lib/tempest_time/api/tempo_api/responses/submit_timesheet.rb
 - lib/tempest_time/cli.rb
 - lib/tempest_time/command.rb
 - lib/tempest_time/commands/config.rb
-- lib/tempest_time/commands/config/edit.rb
-- lib/tempest_time/commands/config/setup.rb
+- lib/tempest_time/commands/config/app.rb
+- lib/tempest_time/commands/config/auth.rb
 - lib/tempest_time/commands/delete.rb
 - lib/tempest_time/commands/issue.rb
 - lib/tempest_time/commands/issue/list.rb
 - lib/tempest_time/commands/issue/open.rb
 - lib/tempest_time/commands/list.rb
 - lib/tempest_time/commands/report.rb
+- lib/tempest_time/commands/setup.rb
 - lib/tempest_time/commands/submit.rb
 - lib/tempest_time/commands/teams.rb
 - lib/tempest_time/commands/teams/add.rb
@@ -324,7 +327,11 @@ homepage: https://github.com/devanhurst/tempest_time
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n    Thank you for installing Tempest!\n\n    If this is your
+  first time installing, please run `tempest setup` to provide your Atlassian credentials.\n\n
+  \   UPDATE: v1.2.0 makes changes to how reports are calculated!\n    If you have
+  been using this feature, please run `tempest config app` to set up your internal
+  project codes.\n  "
 rdoc_options: []
 require_paths:
 - lib

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

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../command'
-require_relative '../../settings/authorization'
-require_relative '../../api/jira_api/requests/get_current_user'
-require_relative '../../api/tempo_api/requests/list_worklogs'
-
-module TempestTime
-  module Commands
-    class Config
-      class Setup < TempestTime::Command
-        def initialize(options)
-          @options = options
-        end
-
-        def execute!
-          check_for_completion
-          set_authorization_values
-          with_spinner('Checking credentials...') do |spinner|
-            begin
-              check_for_validity
-              spinner.stop(pastel.green("Success! You're ready to go!"))
-            rescue StandardError
-              spinner.stop(
-                pastel.red("Something isn't right... please re-run setup.")
-              )
-            end
-          end
-        end
-
-        private
-
-        def credentials
-          @credentials ||= {
-            'email' => email,
-            'username' => username,
-            'subdomain' => subdomain,
-            'jira_token' => jira_token,
-            'tempo_token' => tempo_token,
-          }
-        end
-
-        def authorization
-          @authorization ||= TempestTime::Settings::Authorization.new
-        end
-
-        def check_for_completion
-          return true unless credentials.any? { |_, value| value.nil? }
-          abort(
-            pastel.red('Setup failed!') + ' ' \
-            'One or more credentials were missing. Please try again.'
-          )
-        end
-
-        def set_authorization_values
-          credentials.map { |key, value| authorization.set(key, value) }
-        end
-
-        def check_for_validity
-          jira = JiraAPI::Requests::GetCurrentUser.new
-          tempo = TempoAPI::Requests::ListWorklogs.new(Date.today)
-          raise StandardError unless jira.send_request.success?
-          raise StandardError unless tempo.send_request.success?
-        end
-
-        def email
-          prompt.ask(
-            'Please enter your Atlassian ID. '\
-            'This is typically your login email.'
-          )
-        end
-
-        def username
-          prompt.ask('Please enter your Atlassian username.')
-        end
-
-        def subdomain
-          prompt.ask(
-            'Please enter your Atlassian subdomain. '\
-            'i.e. [THIS VALUE].atlassian.net'
-          )
-        end
-
-        def jira_token
-          prompt.ask(
-            'Please enter your Atlassian API token. '\
-            'Your token can be generated at '\
-            'https://id.atlassian.com/manage/api-tokens'
-          )
-        end
-
-        def tempo_token
-          prompt.ask(
-            'Please enter your Tempo API token. '\
-            'Your token can be generated through '\
-            "your worksheet's settings page."
-          )
-        end
-      end
-    end
-  end
-end