abt-cli 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b24bcf0b7e31cf18b1f86381f6dabba6434e8dfbd4a077f5447afdd20f08d7e
-  data.tar.gz: a66846cb48a109ea21bb7366c1432c8f7d647b5384f42565c90fa609c51d8b6b
+  metadata.gz: 0cc34f7579a887a49ae83db56c8b3808a0e00b09c55631f9b4224228477a0762
+  data.tar.gz: 9c26a06c3af53ebe55ca5e53f93b5d6d73854962daebef31d131000657be1c63
 SHA512:
-  metadata.gz: b3610428c6ded90f53c49396d41b07fc54134dd88cb8019133c35dab230058b5506d93cfab0dc4b811b81161e45e24c1b0502dd7e03a8f3a65248db864886fb3
-  data.tar.gz: 6affbc39d2572a73b700367d8cdabbe84275faf663b66b0c020c1683a3ffc7f584d43b828674cc2d32f1f05a8e2695443f13c64a2d1727e7fdb7708f93a0bcf5
+  metadata.gz: 4fe10297a130b747d93dc1398bdf404996d5c07987680deac59a5365d6893ab3d0466ebd764ef087f5eb2409b99a7733dc55a869432d81286f3460ec510d247d
+  data.tar.gz: 3684a1d3113f9df06637a6c7294f334b48e2c8cd5e54d4334c1ec1884571519f6e5aedeec327d8292f5364d1251453d6a7a8131074f91b2f94935b7a3586ddb9

data/lib/abt/git_config.rb

@@ -32,6 +32,19 @@ module Abt
       set(key, value)
     end
 
+    def full_keys
+      if scope == 'local' && !self.class.local_available?
+        raise StandardError, 'Local configuration is not available outside a git repository'
+      end
+
+      `git config --#{scope} --get-regexp --name-only ^#{namespace}`.lines.map(&:strip)
+    end
+
+    def keys
+      offset = namespace.length + 1
+      full_keys.map { |key| key[offset..-1] }
+    end
+
     def local
       @local ||= begin
         if scope == 'local'

data/lib/abt/providers/asana/commands/harvest_time_entry_data.rb

@@ -13,7 +13,7 @@ module Abt
             'Print Harvest time entry data for Asana task as json. Used by harvest start script.'
           end
 
-          def call # rubocop:disable Metrics/MethodLength
+          def call
             ensure_current_is_valid!
 
             body = {
@@ -21,9 +21,7 @@ module Abt
               external_reference: {
                 id: task_gid.to_i,
                 group_id: project_gid.to_i,
-                permalink: task['permalink_url'],
-                service: 'app.asana.com',
-                service_icon_url: 'https://proxy.harvestfiles.com/production_harvestapp_public/uploads/platform_icons/app.asana.com.png'
+                permalink: task['permalink_url']
               }
             }
 

data/lib/abt/providers/asana/commands/init.rb

@@ -13,6 +13,11 @@ module Abt
             'Pick Asana project for current git repository'
           end
 
+          def initialize(cli:, **)
+            @config = Configuration.new(cli: cli)
+            @cli = cli
+          end
+
           def call
             cli.abort 'Must be run inside a git repository' unless config.local_available?
 

data/lib/abt/providers/asana/configuration.rb

@@ -67,8 +67,10 @@ module Abt
         end
 
         def clear_global
-          git.global['workspaceGid'] = nil
-          git.global['accessToken'] = nil
+          git.global.keys.each do |key|
+            cli.puts 'Deleting configuration: ' + key
+            git.global[key] = nil
+          end
         end
 
         def access_token

data/lib/abt/providers/devops.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.expand_path(__dir__)}/devops/*.rb").sort.each { |file| require file }
+Dir.glob("#{File.expand_path(__dir__)}/devops/commands/*.rb").sort.each { |file| require file }
+
+module Abt
+  module Providers
+    module Devops
+      def self.command_names
+        Commands.constants.sort.map { |constant_name| Helpers.const_to_command(constant_name) }
+      end
+
+      def self.command_class(name)
+        const_name = Helpers.command_to_const(name)
+        Commands.const_get(const_name) if Commands.const_defined?(const_name)
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/api.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      class Api
+        VERBS = %i[get post put].freeze
+
+        attr_reader :organization_name, :project_name, :username, :access_token
+
+        def initialize(organization_name:, project_name:, username:, access_token:)
+          @organization_name = organization_name
+          @project_name = project_name
+          @username = username
+          @access_token = access_token
+        end
+
+        VERBS.each do |verb|
+          define_method(verb) do |*args|
+            request(verb, *args)
+          end
+        end
+
+        def get_paged(path, query = {})
+          result = request(:get, path, query)
+          result['value']
+
+          # TODO: Loop if necessary
+        end
+
+        def request(*args)
+          response = connection.public_send(*args)
+
+          if response.success?
+            Oj.load(response.body)
+          else
+            error_class = Abt::HttpError.error_class_for_status(response.status)
+            encoded_response_body = response.body.force_encoding('utf-8')
+            raise error_class, "Code: #{response.status}, body: #{encoded_response_body}"
+          end
+        end
+
+        def base_url
+          "https://#{organization_name}.visualstudio.com/#{project_name}"
+        end
+
+        def api_endpoint
+          "#{base_url}/_apis"
+        end
+
+        def url_for_work_item(work_item)
+          "#{base_url}/_workitems/edit/#{work_item['id']}"
+        end
+
+        def connection
+          @connection ||= Faraday.new(api_endpoint) do |connection|
+            connection.basic_auth username, access_token
+            connection.headers['Content-Type'] = 'application/json'
+            connection.headers['Accept'] = 'application/json; api-version=6.0'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/base_command.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      class BaseCommand
+        attr_reader :arg_str, :organization_name, :project_name, :board_id, :work_item_id, :cli, :config
+
+        def initialize(arg_str:, cli:)
+          @arg_str = arg_str
+
+          @config = Configuration.new(cli: cli)
+          @cli = cli
+
+          if arg_str.nil?
+            use_current_args
+          else
+            use_arg_str(arg_str)
+          end
+        end
+
+        private
+
+        def sanitize_work_item(work_item)
+          return nil if work_item.nil?
+
+          work_item.merge(
+            'id' => work_item['id'].to_s,
+            'name' => work_item['fields']['System.Title'],
+            'url' => api.url_for_work_item(work_item)
+          )
+        end
+
+        def same_args_as_config?
+          organization_name == config.organization_name &&
+            project_name == config.project_name &&
+            board_id == config.board_id &&
+            work_item_id == config.work_item_id
+        end
+
+        def print_board(organization_name, project_name, board)
+          arg_str = "#{organization_name}/#{project_name}/#{board['id']}"
+
+          cli.print_provider_command('devops', arg_str, board['name'])
+          # cli.warn board['url'] if board.key?('url') && cli.output.isatty # TODO: Web URL
+        end
+
+        def print_work_item(organization, project, board, work_item)
+          arg_str = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
+
+          cli.print_provider_command('devops', arg_str, work_item['name'])
+          cli.warn work_item['url'] if work_item.key?('url') && cli.output.isatty
+        end
+
+        def use_current_args
+          @organization_name = config.organization_name
+          @project_name = config.project_name
+          @board_id = config.board_id
+          @work_item_id = config.work_item_id
+        end
+
+        def use_arg_str(arg_str)
+          args = arg_str.to_s.split('/')
+
+          if args.length < 3
+            cli.abort 'Argument format is <organization>/<project>/<board-id>[/<work-item-id>]'
+          end
+
+          (@organization_name, @project_name, @board_id, @work_item_id) = args
+        end
+
+        def api
+          Abt::Providers::Devops::Api.new(organization_name: organization_name,
+                                          project_name: project_name,
+                                          username: config.username_for_organization(organization_name),
+                                          access_token: config.access_token_for_organization(organization_name))
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/clear.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Clear < BaseCommand
+          def self.command
+            'clear devops'
+          end
+
+          def self.description
+            'Clear DevOps config for current git repository'
+          end
+
+          def call
+            cli.warn 'Clearing configuration'
+            config.clear_local
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/clear_global.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class ClearGlobal < BaseCommand
+          def self.command
+            'clear-global devops'
+          end
+
+          def self.description
+            'Clear all global configuration'
+          end
+
+          def call
+            cli.warn 'Clearing global DevOps configuration'
+            config.clear_global
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/current.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Current < BaseCommand
+          def self.command
+            'current devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
+          end
+
+          def self.description
+            'Get or set DevOps configuration for current git repository'
+          end
+
+          def call
+            if same_args_as_config? || !config.local_available?
+              show_current_configuration
+            else
+              cli.warn 'Updating configuration'
+              update_configuration
+            end
+          end
+
+          private
+
+          def show_current_configuration
+            if organization_name.nil?
+              cli.warn 'No organization selected'
+            elsif project_name.nil?
+              cli.warn 'No project selected'
+            elsif board_id.nil?
+              cli.warn 'No board selected'
+            elsif work_item_id.nil?
+              print_board(organization_name, project_name, board)
+            else
+              print_work_item(organization_name, project_name, board, work_item)
+            end
+          end
+
+          def update_configuration
+            ensure_board_is_valid!
+
+            if work_item_id.nil?
+              update_board_config
+              config.work_item_id = nil
+
+              print_board(organization_name, project_name, board)
+            else
+              ensure_work_item_is_valid!
+
+              update_board_config
+              config.work_item_id = work_item_id
+
+              print_work_item(organization_name, project_name, board, work_item)
+            end
+          end
+
+          def update_board_config
+            config.organization_name = organization_name
+            config.project_name = project_name
+            config.board_id = board_id
+          end
+
+          def ensure_board_is_valid!
+            if board.nil?
+              cli.abort 'Board could not be found, ensure that settings for organization, project, and board are correct'
+            end
+          end
+
+          def ensure_work_item_is_valid!
+            cli.abort "No such work item: ##{work_item_id}" if work_item.nil?
+          end
+
+          def board
+            @board ||= begin
+                         cli.warn 'Fetching board...'
+                         api.get("work/boards/#{board_id}")
+                       rescue HttpError::NotFoundError
+                         nil
+                       end
+          end
+
+          def work_item
+            @work_item ||= begin
+                             cli.warn 'Fetching work item...'
+                             work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+                             sanitize_work_item(work_item)
+                           rescue HttpError::NotFoundError
+                             nil
+                           end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/harvest_time_entry_data.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class HarvestTimeEntryData < BaseCommand
+          def self.command
+            'harvest-time-entry-data devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+          end
+
+          def self.description
+            'Print Harvest time entry data for DevOps work item as json. Used by harvest start script.'
+          end
+
+          def call
+            body = {
+              notes: notes,
+              external_reference: {
+                id: work_item['id'],
+                group_id: 'AzureDevOpsWorkItem',
+                permalink: work_item['url']
+              }
+            }
+
+            cli.puts Oj.dump(body, mode: :json)
+          end
+
+          private
+
+          def notes
+            [
+              'Azure DevOps',
+              work_item['fields']['System.WorkItemType'],
+              "##{work_item['id']}",
+              '-',
+              work_item['name']
+            ].join(' ')
+          end
+
+          def work_item
+            @work_item ||= begin
+              work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+              sanitize_work_item(work_item)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/init.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Init < BaseCommand
+          AZURE_DEV_URL_REGEX = %r{^https://dev\.azure\.com/(?<organization>[^/]+)/(?<project>[^/]+)}.freeze
+          VS_URL_REGEX = %r{^https://(?<organization>[^.]+)\.visualstudio\.com/(?<project>[^/]+)}.freeze
+
+          def self.command
+            'init devops'
+          end
+
+          def self.description
+            'Pick DevOps board for current git repository'
+          end
+
+          def call
+            cli.abort 'Must be run inside a git repository' unless config.local_available?
+
+            @organization_name = config.organization_name = organization_name_from_url
+            @project_name = config.project_name = project_name_from_url
+
+            board = cli.prompt_choice 'Select a project work board', boards
+
+            config.board_id = board['id']
+
+            print_board(organization_name, project_name, board)
+          end
+
+          private
+
+          def boards
+            @boards ||= api.get_paged('work/boards')
+          end
+
+          def project_name_from_url
+            if (match = AZURE_DEV_URL_REGEX.match(project_url)) ||
+               (match = VS_URL_REGEX.match(project_url))
+              match[:project]
+            end
+          end
+
+          def organization_name_from_url
+            if (match = AZURE_DEV_URL_REGEX.match(project_url)) ||
+               (match = VS_URL_REGEX.match(project_url))
+              match[:organization]
+            end
+          end
+
+          def project_url
+            @project_url ||= begin
+              loop do
+                url = cli.prompt([
+                  'Please provide the URL for the devops project',
+                  'For instance https://{organization}.visualstudio.com/{project} or https://dev.azure.com/{organization}/{project}',
+                  '',
+                  'Enter URL'
+                ].join("\n"))
+
+                break url if AZURE_DEV_URL_REGEX =~ url || VS_URL_REGEX =~ url
+
+                cli.warn 'Invalid URL'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/pick.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Pick < BaseCommand
+          def self.command
+            'pick devops[:<organization-name>/<project-name>/<board-id>]'
+          end
+
+          def self.description
+            'Pick work item for current git repository'
+          end
+
+          def call
+            cli.abort 'Must be run inside a git repository' unless config.local_available?
+
+            cli.warn "#{project_name} - #{board['name']}"
+
+            work_item = select_work_item
+
+            # We might have gotten org, project, board as arg str
+            config.organization_name = organization_name
+            config.project_name = project_name
+            config.board_id = board_id
+            config.work_item_id = work_item['id']
+
+            print_work_item(organization_name, project_name, board, work_item)
+          end
+
+          private
+
+          def select_work_item
+            loop do
+              column = cli.prompt_choice 'Which column?', columns
+              cli.warn 'Fetching work items...'
+              work_items = work_items_in_column(column)
+
+              if work_items.length.zero?
+                cli.warn 'Section is empty'
+                next
+              end
+
+              work_item = cli.prompt_choice 'Select a work item', work_items, true
+              return work_item if work_item
+            end
+          end
+
+          def work_items_in_column(column)
+            wiql = <<~WIQL
+              SELECT [System.Id]
+              FROM WorkItems
+              WHERE [System.BoardColumn] = '#{column['name']}'
+              ORDER BY [Microsoft.VSTS.Common.BacklogPriority] ASC
+            WIQL
+
+            response = api.post('wit/wiql', Oj.dump({ query: wiql }, mode: :json))
+            ids = response['workItems'].map { |work_item| work_item['id'] }
+            work_items = api.get_paged('wit/workitems', ids: ids.join(','))
+
+            work_items.map { |work_item| sanitize_work_item(work_item) }
+          end
+
+          def columns
+            board['columns']
+          end
+
+          def board
+            @board ||= api.get("work/boards/#{board_id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/share.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Share < BaseCommand
+          def self.command
+            'share devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
+          end
+
+          def self.description
+            'Print DevOps config string'
+          end
+
+          def call
+            if organization_name.nil?
+              cli.warn 'No organization selected'
+            elsif project_name.nil?
+              cli.warn 'No project selected'
+            elsif board_id.nil?
+              cli.warn 'No board selected'
+            else
+              args = [organization_name, project_name, board_id, work_item_id].compact
+              cli.print_provider_command('devops', args.join('/'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/configuration.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      class Configuration
+        attr_accessor :cli
+
+        def initialize(cli:)
+          @cli = cli
+          @git = GitConfig.new(namespace: 'abt.devops')
+        end
+
+        def local_available?
+          GitConfig.local_available?
+        end
+
+        def organization_name
+          local_available? ? git['organizationName'] : nil
+        end
+
+        def project_name
+          local_available? ? git['projectName'] : nil
+        end
+
+        def board_id
+          local_available? ? git['boardId'] : nil
+        end
+
+        def work_item_id
+          local_available? ? git['workItemId'] : nil
+        end
+
+        def organization_name=(value)
+          return if organization_name == value
+
+          clear_local
+          git['organizationName'] = value unless value.nil?
+        end
+
+        def project_name=(value)
+          return if project_name == value
+
+          git['projectName'] = value unless value.nil?
+          git['boardId'] = nil
+          git['workItemId'] = nil
+        end
+
+        def board_id=(value)
+          return if board_id == value
+
+          git['boardId'] = value unless value.nil?
+          git['workItemId'] = nil
+        end
+
+        def work_item_id=(value)
+          git['workItemId'] = value
+        end
+
+        def clear_local
+          cli.abort 'No local configuration was found' unless local_available?
+
+          git['organizationName'] = nil
+          git['projectName'] = nil
+          git['boardId'] = nil
+          git['workItemId'] = nil
+        end
+
+        def clear_global
+          git.global.keys.each do |key|
+            cli.puts 'Deleting configuration: ' + key
+            git.global[key] = nil
+          end
+        end
+
+        def username_for_organization(organization_name)
+          username_key = "organizations.#{organization_name}.username"
+
+          return git.global[username_key] unless git.global[username_key].nil?
+
+          git.global[username_key] = cli.prompt([
+            "Please provide your username for the DevOps organization (#{organization_name}).",
+            '',
+            'Enter username'
+          ].join("\n"))
+        end
+
+        def access_token_for_organization(organization_name)
+          access_token_key = "organizations.#{organization_name}.accessToken"
+
+          return git.global[access_token_key] unless git.global[access_token_key].nil?
+
+          git.global[access_token_key] = cli.prompt([
+            "Please provide your personal access token for the DevOps organization (#{organization_name}).",
+            'If you don\'t have one, follow the guide here: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate',
+            '',
+            'The token MUST have "Read" permission for Work Items',
+            'Future features will likely require "Write" or "Manage"',
+            '',
+            'Enter access token'
+          ].join("\n"))
+        end
+
+        private
+
+        attr_reader :git
+      end
+    end
+  end
+end

data/lib/abt/providers/harvest/configuration.rb

@@ -44,9 +44,10 @@ module Abt
         end
 
         def clear_global
-          git.global['userId'] = nil
-          git.global['accountId'] = nil
-          git.global['accessToken'] = nil
+          git.global.keys.each do |key|
+            cli.puts 'Deleting configuration: ' + key
+            git.global[key] = nil
+          end
         end
 
         def access_token

data/lib/abt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Abt
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abt-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Jesper Sørensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -100,6 +100,17 @@ files:
 - "./lib/abt/providers/asana/commands/start.rb"
 - "./lib/abt/providers/asana/commands/tasks.rb"
 - "./lib/abt/providers/asana/configuration.rb"
+- "./lib/abt/providers/devops.rb"
+- "./lib/abt/providers/devops/api.rb"
+- "./lib/abt/providers/devops/base_command.rb"
+- "./lib/abt/providers/devops/commands/clear.rb"
+- "./lib/abt/providers/devops/commands/clear_global.rb"
+- "./lib/abt/providers/devops/commands/current.rb"
+- "./lib/abt/providers/devops/commands/harvest_time_entry_data.rb"
+- "./lib/abt/providers/devops/commands/init.rb"
+- "./lib/abt/providers/devops/commands/pick.rb"
+- "./lib/abt/providers/devops/commands/share.rb"
+- "./lib/abt/providers/devops/configuration.rb"
 - "./lib/abt/providers/harvest.rb"
 - "./lib/abt/providers/harvest/api.rb"
 - "./lib/abt/providers/harvest/base_command.rb"