abt-cli 0.0.18 → 0.0.23

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

@@ -6,11 +6,11 @@ module Abt
       module Commands
         class Tasks < BaseCommand
           def self.usage
-            'abt tasks asana'
+            "abt tasks asana"
           end
 
           def self.description
-            'List available tasks on project - useful for piping into grep etc.'
+            "List available tasks on project - useful for piping into grep etc."
           end
 
           def perform
@@ -25,14 +25,15 @@ module Abt
 
           def project
             @project ||= begin
-              api.get("projects/#{project_gid}")
+              api.get("projects/#{project_gid}", opt_fields: "name")
             end
           end
 
           def tasks
             @tasks ||= begin
-              cli.warn 'Fetching tasks...'
-              api.get_paged('tasks', project: project['gid'], opt_fields: 'name')
+              warn("Fetching tasks...")
+              tasks = api.get_paged("tasks", project: project["gid"], opt_fields: "name,completed")
+              tasks.reject { |task| task["completed"] }
             end
           end
         end

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

@@ -8,26 +8,25 @@ module Abt
 
         def initialize(cli:)
           @cli = cli
-          @git = GitConfig.new(namespace: 'abt.asana')
         end
 
         def local_available?
-          GitConfig.local_available?
+          git.available?
         end
 
-        def project_gid
-          local_available? ? git['projectGid'] : nil
+        def path
+          Path.new(local_available? && git["path"] || "")
         end
 
-        def task_gid
-          local_available? ? git['taskGid'] : nil
+        def path=(new_path)
+          git["path"] = new_path
         end
 
         def workspace_gid
           @workspace_gid ||= begin
-            current = git.global['workspaceGid']
+            current = git_global["workspaceGid"]
             if current.nil?
-              prompt_workspace['gid']
+              prompt_workspace_gid
             else
               current
             end
@@ -37,24 +36,13 @@ module Abt
         def wip_section_gid
           return nil unless local_available?
 
-          @wip_section_gid ||= git['wipSectionGid'] || prompt_wip_section['gid']
+          @wip_section_gid ||= git["wipSectionGid"] || prompt_wip_section["gid"]
         end
 
         def finalized_section_gid
           return nil unless local_available?
 
-          @finalized_section_gid ||= git['finalizedSectionGid'] || prompt_finalized_section['gid']
-        end
-
-        def project_gid=(value)
-          return if project_gid == value
-
-          clear_local(verbose: false)
-          git['projectGid'] = value unless value.nil?
-        end
-
-        def task_gid=(value)
-          git['taskGid'] = value
+          @finalized_section_gid ||= git["finalizedSectionGid"] || prompt_finalized_section["gid"]
         end
 
         def clear_local(verbose: true)
@@ -62,56 +50,70 @@ module Abt
         end
 
         def clear_global(verbose: true)
-          git.global.clear(output: verbose ? cli.err_output : nil)
+          git_global.clear(output: verbose ? cli.err_output : nil)
         end
 
         def access_token
-          return git.global['accessToken'] unless git.global['accessToken'].nil?
+          return git_global["accessToken"] unless git_global["accessToken"].nil?
 
-          git.global['accessToken'] = cli.prompt.text([
-            'Please provide your personal access token for Asana.',
-            'If you don\'t have one, create one here: https://app.asana.com/0/developer-console',
-            '',
-            'Enter access token'
+          git_global["accessToken"] = cli.prompt.text([
+            "Please provide your personal access token for Asana.",
+            "If you don't have one, create one here: https://app.asana.com/0/developer-console",
+            "",
+            "Enter access token"
           ].join("\n"))
         end
 
         private
 
-        attr_reader :git
+        def git
+          @git ||= GitConfig.new("local", "abt.asana")
+        end
+
+        def git_global
+          @git_global ||= GitConfig.new("global", "abt.asana")
+        end
 
         def prompt_finalized_section
           section = prompt_section('Select section for finalized tasks (E.g. "Merged")')
-          git['finalizedSectionGid'] = section['gid']
+          git["finalizedSectionGid"] = section["gid"]
           section
         end
 
         def prompt_wip_section
-          section = prompt_section('Select WIP (Work In Progress) section')
-          git['wipSectionGid'] = section['gid']
+          section = prompt_section("Select WIP (Work In Progress) section")
+          git["wipSectionGid"] = section["gid"]
           section
         end
 
         def prompt_section(message)
-          cli.warn 'Fetching sections...'
-          sections = api.get_paged("projects/#{project_gid}/sections")
+          cli.warn("Fetching sections...")
+          sections = api.get_paged("projects/#{path.project_gid}/sections", opt_fields: "name")
           cli.prompt.choice(message, sections)
         end
 
-        def prompt_workspace
-          cli.warn 'Fetching workspaces...'
-          workspaces = api.get_paged('workspaces')
-          if workspaces.empty?
-            cli.abort 'Your asana access token does not have access to any workspaces'
-          elsif workspaces.one?
+        def prompt_workspace_gid
+          cli.abort("Your asana access token does not have access to any workspaces") if workspaces.empty?
+
+          if workspaces.one?
             workspace = workspaces.first
-            cli.warn "Selected Asana workspace #{workspace['name']}"
+            cli.warn("Selected Asana workspace: #{workspace['name']}")
           else
-            workspace = cli.prompt.choice('Select Asana workspace', workspaces)
+            workspace = pick_workspace
           end
 
-          git.global['workspaceGid'] = workspace['gid']
-          workspace
+          git_global["workspaceGid"] = workspace["gid"]
+        end
+
+        def pick_workspace
+          cli.prompt.choice("Select Asana workspace", workspaces)
+        end
+
+        def workspaces
+          @workspaces ||= begin
+            cli.warn("Fetching workspaces...")
+            api.get_paged("workspaces", opt_fields: "name")
+          end
         end
 
         def api

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Asana
+      class Path < String
+        PATH_REGEX = %r{^(?<project_gid>\d+)?/?(?<task_gid>\d+)?$}.freeze
+
+        def self.from_ids(project_gid: nil, task_gid: nil)
+          path = project_gid ? [project_gid, *task_gid].join("/") : ""
+          new(path)
+        end
+
+        def initialize(path = "")
+          raise Abt::Cli::Abort, "Invalid path: #{path}" unless PATH_REGEX.match?(path)
+
+          super
+        end
+
+        def project_gid
+          match[:project_gid]
+        end
+
+        def task_gid
+          match[:task_gid]
+        end
+
+        private
+
+        def match
+          @match ||= PATH_REGEX.match(self)
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,9 @@ module Abt
   module Providers
     module Devops
       class Api
-        VERBS = %i[get post put].freeze
+        VERBS = [:get, :post, :put].freeze
 
-        CONDITIONAL_ACCESS_POLICY_ERROR_CODE = 'VS403463'
+        CONDITIONAL_ACCESS_POLICY_ERROR_CODE = "VS403463"
 
         attr_reader :organization_name, :project_name, :username, :access_token, :cli
 
@@ -26,18 +26,18 @@ module Abt
 
         def get_paged(path, query = {})
           result = request(:get, path, query)
-          result['value']
+          result["value"]
 
           # TODO: Loop if necessary
         end
 
         def work_item_query(wiql)
-          response = post('wit/wiql', Oj.dump({ query: wiql }, mode: :json))
-          ids = response['workItems'].map { |work_item| work_item['id'] }
+          response = post("wit/wiql", Oj.dump({ query: wiql }, mode: :json))
+          ids = response["workItems"].map { |work_item| work_item["id"] }
 
           work_items = []
           ids.each_slice(200) do |page_ids|
-            work_items += get_paged('wit/workitems', ids: page_ids.join(','))
+            work_items += get_paged("wit/workitems", ids: page_ids.join(","))
           end
 
           work_items
@@ -50,7 +50,7 @@ module Abt
             Oj.load(response.body)
           else
             error_class = Abt::HttpError.error_class_for_status(response.status)
-            encoded_response_body = response.body.force_encoding('utf-8')
+            encoded_response_body = response.body.force_encoding("utf-8")
             raise error_class, "Code: #{response.status}, body: #{encoded_response_body}"
           end
         rescue Abt::HttpError::ForbiddenError => e
@@ -69,20 +69,32 @@ module Abt
           "#{base_url}/_workitems/edit/#{work_item['id']}"
         end
 
+        def url_for_board(board)
+          "#{base_url}/_boards/board/#{rfc_3986_encode_path_segment(board['name'])}"
+        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'
+            connection.basic_auth(username, access_token)
+            connection.headers["Content-Type"] = "application/json"
+            connection.headers["Accept"] = "application/json; api-version=6.0"
           end
         end
 
         private
 
+        # Shamelessly copied from ERB::Util.url_encode
+        # https://apidock.com/ruby/ERB/Util/url_encode
+        def rfc_3986_encode_path_segment(string)
+          string.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/) do |match|
+            format("%%%02X", match.unpack1("C"))
+          end
+        end
+
         def handle_denied_by_conditional_access_policy!(exception)
           raise exception unless exception.message.include?(CONDITIONAL_ACCESS_POLICY_ERROR_CODE)
 
-          cli.abort <<~TXT
+          cli.abort(<<~TXT)
             Access denied by conditional access policy.
             Try logging into the board using the URL below, then retry the command.
 

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

@@ -3,85 +3,64 @@
 module Abt
   module Providers
     module Devops
-      class BaseCommand < Abt::Cli::BaseCommand
-        attr_reader :organization_name, :project_name, :board_id, :work_item_id, :config
+      class BaseCommand < Abt::BaseCommand
+        extend Forwardable
 
-        def initialize(path:, cli:, **)
+        attr_reader :config, :path
+
+        def_delegators(:@path, :organization_name, :project_name, :board_id, :work_item_id)
+
+        def initialize(ari:, cli:)
           super
 
           @config = Configuration.new(cli: cli)
-
-          if path.nil?
-            use_current_path
-          else
-            use_path(path)
-          end
+          @path = ari.path ? Path.new(ari.path) : config.path
         end
 
         private
 
+        def require_local_config!
+          abort("Must be run inside a git repository") unless config.local_available?
+        end
+
         def require_board!
           return if organization_name && project_name && board_id
 
-          cli.abort 'No current/specified board. Did you initialize DevOps?'
+          abort("No current/specified board. Did you initialize DevOps?")
         end
 
         def require_work_item!
           unless organization_name && project_name && board_id
-            cli.abort 'No current/specified board. Did you initialize DevOps and pick a work item?'
+            abort("No current/specified board. Did you initialize DevOps and pick a work item?")
           end
 
           return if work_item_id
 
-          cli.abort 'No current/specified work item. Did you pick a DevOps work item?'
+          abort("No current/specified work item. Did you pick a DevOps work item?")
         end
 
         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)
+            "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)
           path = "#{organization_name}/#{project_name}/#{board['id']}"
 
-          cli.print_ari('devops', path, board['name'])
-          # cli.warn board['url'] if board.key?('url') && cli.output.isatty # TODO: Web URL
+          cli.print_ari("devops", path, board["name"])
+          warn(api.url_for_board(board)) if cli.output.isatty
         end
 
         def print_work_item(organization, project, board, work_item)
           path = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
 
-          cli.print_ari('devops', path, work_item['name'])
-          cli.warn work_item['url'] if work_item.key?('url') && cli.output.isatty
-        end
-
-        def use_current_path
-          @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_path(path)
-          args = path.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
+          cli.print_ari("devops", path, work_item["name"])
+          warn(work_item["url"]) if work_item.key?("url") && cli.output.isatty
         end
 
         def api

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

@@ -6,18 +6,16 @@ module Abt
       module Commands
         class Boards < BaseCommand
           def self.usage
-            'abt boards devops'
+            "abt boards devops"
           end
 
           def self.description
-            'List all boards - useful for piping into grep etc'
+            "List all boards - useful for piping into grep etc"
           end
 
           def perform
-            if organization_name.nil?
-              cli.abort 'No organization selected. Did you initialize DevOps?'
-            end
-            cli.abort 'No project selected. Did you initialize DevOps?' if project_name.nil?
+            abort("No organization selected. Did you initialize DevOps?") if organization_name.nil?
+            abort("No project selected. Did you initialize DevOps?") if project_name.nil?
 
             boards.map do |board|
               print_board(organization_name, project_name, board)
@@ -27,7 +25,7 @@ module Abt
           private
 
           def boards
-            @boards ||= api.get_paged('work/boards')
+            @boards ||= api.get_paged("work/boards")
           end
         end
       end

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

@@ -6,35 +6,39 @@ module Abt
       module Commands
         class BranchName < BaseCommand
           def self.usage
-            'abt branch-name devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+            "abt branch-name devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]"
           end
 
           def self.description
-            'Suggest a git branch name for the current/specified work-item.'
+            "Suggest a git branch name for the current/specified work-item."
           end
 
           def perform
             require_work_item!
 
-            cli.puts name
+            puts name
           rescue HttpError::NotFoundError
             args = [organization_name, project_name, board_id, work_item_id].compact
-            cli.warn 'Unable to find work item for configuration:'
-            cli.abort "devops:#{args.join('/')}"
+
+            error_message = [
+              "Unable to find work item for configuration:",
+              "devops:#{args.join('/')}"
+            ].join("\n")
+            abort(error_message)
           end
 
           private
 
           def name
-            str = work_item['id']
-            str += '-'
-            str += work_item['name'].downcase.gsub(/[^\w]/, '-')
-            str.gsub(/-+/, '-')
+            str = work_item["id"]
+            str += "-"
+            str += work_item["name"].downcase.gsub(/[^\w]/, "-")
+            str.squeeze("-").gsub(/(^-|-$)/, "")
           end
 
           def work_item
             @work_item ||= begin
-              work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+              work_item = api.get_paged("wit/workitems", ids: work_item_id)[0]
               sanitize_work_item(work_item)
             end
           end