fogbugz 1.0.3 → 1.0.4

data/bin/fogbugz

@@ -1,78 +1,26 @@
 #!/usr/bin/env ruby
+require 'fogbugz/common'
 
-basename = File.basename(__FILE__)
-absolute = File.expand_path(__FILE__)
-
-usage = <<HERE
-usage: #{basename} <subcommand> [options]
-       #{basename} <case>
-
-The subcommands are:
-   areas        List active areas.
-   assign       Assign a case.
-   categories   List available categories.
-   close        Close a resolved case.
-   edit         Edit an existing case.
-   filter       Set the current default filter.
-   filters      List available filters.
-   list         List cases by the current filter or a search query.
-   login        Create an API token.
-   logoff       Invalidate an API token.
-   milestones   List active milestones.
-   new          Create a new case.
-   people       List active users.
-   priorities   List available priorities.
-   projects     List active projects.
-   reactivate   Reactivate a resolved case.
-   reopen       Reopen a closed case.
-   resolve      Resolve a case.
-   show         Show details on a case.
-   start        Start working on a case.
-   statuses     List available statuses.
-   stop         Stop working on a case.
-
-See '#{basename} help <commands>' for more information on a \
-specific command.
-HERE
-
-if ARGV.length == 0
-  puts usage
-  exit 1
-end
-
-case ARGV[0]
-when 'help'
-  if ARGV.length == 1
-    puts usage
-    exit 1
-  else
-    case ARGV[1]
-    when 'areas', 'assign', 'categories', 'close', 'edit', 'filter', 'filters',
-      'list', 'login', 'logoff', 'milestones', 'new', 'people', 'priorities',
-      'projects', 'reactivate', 'reopen', 'resolve', 'show', 'start',
-      'statuses', 'stop'
-      subcommand = ARGV[1]
-      ARGV.clear
-      ARGV.push '--help'
-      load "#{absolute}-#{subcommand}"
-      exit 0
-    else
-      puts usage
-      exit 1
-    end
-  end
-when 'areas', 'assign', 'categories', 'close', 'edit', 'filter', 'filters',
-  'list', 'login', 'logoff', 'milestones', 'new', 'people', 'priorities',
-  'projects', 'reactivate', 'reopen', 'resolve', 'show', 'start',
-  'statuses', 'stop'
-  load "#{absolute}-#{ARGV.shift}"
-  exit 0
-else
-  if ARGV[0].to_i.to_s == ARGV[0]
-    load "#{absolute}-show"
-    exit 0
-  else
-    puts usage
-    exit 1
-  end
-end
+dispatch_subcommand __FILE__,
+  :areas        => 'List active areas.',
+  :assign       => 'Assign a case.',
+  :categories   => 'List available categories.',
+  :close        => 'Close a resolved case.',
+  :edit         => 'Edit an existing case.',
+  :filter       => 'Set the current default filter.',
+  :filters      => 'List available filters.',
+  :list         => 'List cases by the current filter or a search query.',
+  :login        => 'Create an API token.',
+  :logoff       => 'Invalidate an API token.',
+  :milestones   => 'List active milestones.',
+  :open         => 'Open a new case.',
+  :people       => 'List active users.',
+  :priorities   => 'List available priorities.',
+  :projects     => 'List active projects.',
+  :reactivate   => 'Reactivate a resolved case.',
+  :reopen       => 'Reopen a closed case.',
+  :resolve      => 'Resolve a case.',
+  :show         => 'Show details on a case.',
+  :start        => 'Start working on a case.',
+  :statuses     => 'List available statuses.',
+  :stop         => 'Stop working on a case.'

data/bin/fogbugz-areas

@@ -1,54 +1,8 @@
 #!/usr/bin/env ruby
+require 'fogbugz/common'
 
-require 'rubygems'
-require 'net/https'
-require 'uri'
-require 'rexml/document'
-require 'optparse'
-
-api_url = ENV['FOGBUGZ_API_URL']
-unless api_url
-  puts "Environment variable FOGBUGZ_API_URL must be set."
-  exit 1
-end
-
-api_token = ENV['FOGBUGZ_API_TOKEN']
-unless api_token
-  puts "Environment variable FOGBUGZ_API_TOKEN must be set."
-  exit 1
-end
-
-options = {}
-optparse = OptionParser.new do |opts|
-  opts.banner = "usage: #{File::basename(__FILE__)} [options]"
-
-  opts.on_tail('-h', '--help') do
-    puts optparse.help
-    exit 1
-  end
-end
-optparse.parse!
-
-uri = URI format("#{api_url}?cmd=listAreas&token=%s", URI.escape(api_token))
-http = Net::HTTP.new(uri.host, uri.port)
-if uri.scheme == 'https'
-  http.use_ssl = true
-  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-end
-response = http.start { |h| h.request Net::HTTP::Get.new(uri.request_uri) }
-if response.code != '200'
-  puts "HTTP request to #{api_url} failed with code #{response.code}."
-  exit 1
-end
-
-result = REXML::Document.new(response.body)
-error = result.elements['/response/error']
-if error
-  puts "Failed with error: #{error.text}."
-  exit 1
-end
-
-result.elements.each('/response/areas/area') do |area|
+parse_opts "usage: #{File::basename(__FILE__)} [options]", 0
+do_api('listAreas').elements.each('/response/areas/area') do |area|
   puts format("%-20.20s  %-20.20s  %s\n",
               area.elements['sPersonOwner'].text,
               area.elements['sProject'].text,

data/bin/fogbugz-assign

@@ -1,56 +1,5 @@
 #!/usr/bin/env ruby
+require 'fogbugz/common'
 
-require 'rubygems'
-require 'net/https'
-require 'uri'
-require 'rexml/document'
-require 'optparse'
-
-api_url = ENV['FOGBUGZ_API_URL']
-unless api_url
-  puts "Environment variable FOGBUGZ_API_URL must be set."
-  exit 1
-end
-
-api_token = ENV['FOGBUGZ_API_TOKEN']
-unless api_token
-  puts "Environment variable FOGBUGZ_API_TOKEN must be set."
-  exit 1
-end
-
-options = {}
-optparse = OptionParser.new do |opts|
-  opts.banner = "usage: #{File::basename(__FILE__)} [options] <case> <assignee>"
-
-  opts.on_tail('-h', '--help') do
-    puts optparse.help
-    exit 1
-  end
-end
-optparse.parse!
-
-unless ARGV.length == 2
-  puts optparse.help
-  exit 1
-end
-
-uri = URI format("#{api_url}?cmd=assign&token=%s&ixBug=%s&sPersonAssignedTo=%s",
-                 URI.escape(api_token), URI.escape(ARGV[0]),
-                 URI.escape(ARGV[1]))
-http = Net::HTTP.new(uri.host, uri.port)
-if uri.scheme == 'https'
-  http.use_ssl = true
-  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-end
-response = http.start { |h| h.request Net::HTTP::Get.new(uri.request_uri) }
-if response.code != '200'
-  puts "HTTP request to #{api_url} failed with code #{response.code}."
-  exit 1
-end
-
-result = REXML::Document.new(response.body)
-error = result.elements['/response/error']
-if error
-  puts "Failed with error: #{error.text}."
-  exit 1
-end
+parse_opts "usage: #{File::basename(__FILE__)} [options] <case> <assignee>", 2
+do_api('assign', :ixBug => ARGV[0], :sPersonAssignedTo => ARGV[1])

data/bin/fogbugz-categories

@@ -1,53 +1,7 @@
 #!/usr/bin/env ruby
+require 'fogbugz/common'
 
-require 'rubygems'
-require 'net/https'
-require 'uri'
-require 'rexml/document'
-require 'optparse'
-
-api_url = ENV['FOGBUGZ_API_URL']
-unless api_url
-  puts "Environment variable FOGBUGZ_API_URL must be set."
-  exit 1
-end
-
-api_token = ENV['FOGBUGZ_API_TOKEN']
-unless api_token
-  puts "Environment variable FOGBUGZ_API_TOKEN must be set."
-  exit 1
-end
-
-options = {}
-optparse = OptionParser.new do |opts|
-  opts.banner = "usage: #{File::basename(__FILE__)} [options]"
-
-  opts.on_tail('-h', '--help') do
-    puts optparse.help
-    exit 1
-  end
-end
-optparse.parse!
-
-uri = URI format("#{api_url}?cmd=listCategories&token=%s", URI.escape(api_token))
-http = Net::HTTP.new(uri.host, uri.port)
-if uri.scheme == 'https'
-  http.use_ssl = true
-  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-end
-response = http.start { |h| h.request Net::HTTP::Get.new(uri.request_uri) }
-if response.code != '200'
-  puts "HTTP request to #{api_url} failed with code #{response.code}."
-  exit 1
-end
-
-result = REXML::Document.new(response.body)
-error = result.elements['/response/error']
-if error
-  puts "Failed with error: #{error.text}."
-  exit 1
-end
-
-result.elements.each('/response/categories/category') do |category|
-  puts category.elements['sCategory'].text
+parse_opts "usage: #{File::basename(__FILE__)} [options]", 0
+do_api('listCategories').elements.each('/response/categories/category') do |c|
+  puts c.elements['sCategory'].text
 end

data/bin/fogbugz-close

@@ -29,7 +29,7 @@ optparse = OptionParser.new do |opts|
 end
 optparse.parse!
 
-unless ARGV[0]
+unless ARGV.length == 1
   puts optparse.help
   exit 1
 end

data/bin/fogbugz-edit

@@ -1,293 +1,54 @@
 #!/usr/bin/env ruby
+require 'fogbugz/common'
 
-require 'rubygems'
-require 'net/https'
-require 'uri'
-require 'rexml/document'
-require 'tempfile'
-require 'optparse'
-require 'yaml'
-require 'English'
-require 'time'
+options = parse_stdin_opts "usage: #{File::basename(__FILE__)} [options] <case> [-]", 1
 
-api_url = ENV['FOGBUGZ_API_URL']
-unless api_url
-  puts "Environment variable FOGBUGZ_API_URL must be set."
-  exit 1
-end
-
-api_token = ENV['FOGBUGZ_API_TOKEN']
-unless api_token
-  puts "Environment variable FOGBUGZ_API_TOKEN must be set."
-  exit 1
-end
-
-editor = ENV['EDITOR'] || 'vim'
-
-options = {}
-optparse = OptionParser.new do |opts|
-  opts.banner = "usage: #{File::basename(__FILE__)} [options] <case>"
-
-  opts.on_tail('-h', '--help') do
-    puts optparse.help
-    exit 1
-  end
-
-  options[:file] = nil
-  opts.on('-f', '--file=<file>',
-          'Take the case content from the given file. Use - to read from STDIN.') do |file|
-    options[:file] = file
-  end
-
-  options[:template] = nil
-  opts.on('-t', '--template=<template>',
-          'Use the file content or - for STDIN as the initial case content.') do |template|
-    options[:template] = template
-  end
-end
-optparse.parse!
-
-unless ARGV.length == 1
-  puts optparse.help
-  exit 1
-end
-case_id = ARGV[0]
-
-uri = URI format("#{api_url}?cmd=search&token=%s&cols=%s&q=%s&max=1",
-                 URI.escape(api_token), URI.escape('ixBug,ixBugParent,tags,sTitle,sProject,sArea,sFixFor,sCategory,sPersonAssignedTo,sPriority,hrsCurrEst,events'),
-                 URI.escape(case_id))
-http = Net::HTTP.new(uri.host, uri.port)
-if uri.scheme == 'https'
-  http.use_ssl = true
-  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-end
-response = http.start { |h| h.request Net::HTTP::Get.new(uri.request_uri) }
-if response.code != '200'
-  puts "HTTP request to #{api_url} failed with code #{response.code}."
-  exit 1
-end
-
-result = REXML::Document.new(response.body)
-error = result.elements['/response/error']
-if error
-  puts "Failed with error: #{error.text}."
-  exit 1
-end
-
-bug = result.elements["/response/cases/case[@ixBug='#{case_id}']"]
+result = do_api('search', :max => 1, :q => ARGV[0],
+                :cols => 'ixBug,ixBugParent,tags,sTitle,sProject,sArea,sFixFor,sCategory,sPersonAssignedTo,sPriority,hrsCurrEst,dtDue,events')
+bug = result.elements["/response/cases/case[@ixBug='#{ARGV[0]}']"]
 unless bug
-  puts "Case #{case_id} does not exist."
-  exit 1
-end
-
-invoke_editor = true
-if options[:file]
-  if options[:file] == '-'
-    ARGV.replace []
-  else
-    ARGV.replace [options[:file]]
-  end
-  template = ARGF.read
-  invoke_editor = false
-elsif options[:template]
-  if options[:template] == '-'
-    ARGV.replace []
-  else
-    ARGV.replace [options[:template]]
-  end
-  template = ARGF.read
-else
-  template = ''
-  template << <<HERE
-# Fill in metadata for the case.
-HERE
-
-  sTitle = bug.elements['sTitle']
-  if sTitle and sTitle.text and not sTitle.text.empty?
-    template << "# title: #{sTitle.text}\n"
-  else
-    template << "# title: <title>\n"
-  end
-
-  sPersonAssignedTo = bug.elements['sPersonAssignedTo']
-  if sPersonAssignedTo and sPersonAssignedTo.text and
-      not sPersonAssignedTo.text.empty?
-    template << "# assignee: #{sPersonAssignedTo.text}\n"
-  else
-    template << "# assignee: <person>\n"
-  end
-
-  ixBugParent = bug.elements['ixBugParent']
-  if ixBugParent and ixBugParent.text and not ixBugParent.text.empty? and
-      ixBugParent.text != '0'
-    template << "# parent: #{ixBugParent.text}\n"
-  else
-    template << "# parent: <case>\n"
-  end
-
-  tags = bug.elements.collect('tags/tag') { |tag| tag.text }
-  if tags and not tags.empty?
-    template << "# tags: [#{tags.join(', ')}]\n"
-  else
-    template << "# tags: [bug, enhancement]\n"
-  end
-
-  sProject = bug.elements['sProject']
-  if sProject and sProject.text and not sProject.text.empty?
-    template << "# project: #{sProject.text}\n"
-  else
-    template << "# project: <project>\n"
-  end
-
-  sArea = bug.elements['sArea']
-  if sArea and sArea.text and not sArea.text.empty?
-    template << "# area: #{sArea.text}\n"
-  else
-    template << "# area: <area>\n"
-  end
-
-  sFixFor = bug.elements['sFixFor']
-  if sFixFor and sFixFor.text and not sFixFor.text.empty?
-    template << "# milestone: #{sFixFor.text}\n"
-  else
-    template << "# milestone: <milestone>"
-  end
-
-  sCategory = bug.elements['sCategory']
-  if sCategory and sCategory.text and not sCategory.text.empty?
-    template << "# category: #{sCategory.text}\n"
-  else
-    template << "# category: <category>"
-  end
-
-  sPriority = bug.elements['sPriority']
-  if sPriority and sPriority.text and not sPriority.text.empty?
-    template << "# priority: #{sPriority.text}\n"
-  else
-    template << "# priority: <priority>"
-  end
-
-  hrsCurrEst = bug.elements['hrsCurrEst']
-  if hrsCurrEst and hrsCurrEst.text and not hrsCurrEst.text.empty? and
-      hrsCurrEst.text != '0'
-    template << "# estimate: #{hrsCurrEst.text}\n"
-  else
-    template << "# estimate: <estimate>\n"
-  end
-
+  puts "Case #{ARGV[0]} does not exist."
+  exit 1
+end
+
+template = "# Fill in metadata for the case.\n"
+template << maybe_append('title', bug.elements['sTitle'])
+template << maybe_append('assignee', bug.elements['sPersonAssignedTo'])
+template << maybe_append('parent', bug.elements['ixBugParent'])
+template << maybe_array('tags', bug.elements.collect('tags/tag') { |t| t.text })
+template << maybe_append('project', bug.elements['sProject'])
+template << maybe_append('area', bug.elements['sArea'])
+template << maybe_append('milestone', bug.elements['sFixFor'])
+template << maybe_append('category', bug.elements['sCategory'])
+template << maybe_append('priority', bug.elements['sPriority'])
+template << maybe_time('due', bug.elements['dtDue'])
+template << maybe_append('estimate', bug.elements['hrsCurrEst'])
+
+template << "\n"
+bug.elements.each('events/event') do |event|
+  template << maybe_event(event.elements['evtDescription'], event.elements['dt'])
+  template << maybe_literal(event.elements['sChanges'])
+  template << maybe_literal(event.elements['s'])
   template << "\n"
-  bug.elements.each('events/event') do |event|
-    evtDescription = event.elements['evtDescription']
-    if evtDescription and evtDescription.text and
-        not evtDescription.text.empty?
-      time = Time.parse(event.elements['dt'].text).localtime
-      template << format("# %s at %s on %s.\n", evtDescription.text,
-                         time.strftime('%-l:%M %p'),
-                         time.strftime('%A, %B %e %Y'))
-    end
-
-    sChanges = event.elements['sChanges']
-    if sChanges and sChanges.text and not sChanges.text.empty?
-      commented = sChanges.text.gsub(/\n/, "\n# ")
-      template << "# #{commented}\n"
-    end
-
-    summary = event.elements['s']
-    if summary and summary.text and not summary.text.empty?
-      commented = summary.text.gsub(/\n/, "\n# ")
-      template << "# #{commented}\n"
-    end
-    template << "\n"
-  end
-  template << <<HERE
+end
+template << <<HERE
 # Enter an additional note for the case after the dashes.
 ---
 HERE
-end
-
-content = template
-if invoke_editor
-  tempfile = Tempfile.new ['case', '.md']
-  tempfile.write template
-  tempfile.close
-  rc = system "#{editor} #{tempfile.path}"
-  unless rc
-    puts "Editor exited with non-zero status. Aborting."
-    exit 1
-  end
-  tempfile.open
-  content = tempfile.read
-  tempfile.close
-  tempfile.delete
-end
-
-data = {}
-if content =~ /(.*?\n?)^(---\s*$\n?)/m
-  # Combined YAML front matter with text content.
-  begin
-    data = YAML.load($1) || {}
-    data['body'] = $POSTMATCH if $POSTMATCH and not $POSTMATCH.empty?
-  rescue => e
-    puts "Exception reading YAML front matter. #{e.inspect}"
-    exit 1
-  end
-else
-  begin
-    # YAML only content.
-    data = YAML.load(content)
-    was_yaml = true if data and not data.empty?
-    if data.instance_of? String
-      # Text only content.
-      data = { 'body' => data }
-    end
-  rescue => e
-    data = {}
-  end
-end
-
-if not data or data.empty?
-  puts "No changes to case. Aborting."
-  exit 1
-end
-
-sTitle = data['title'] ? "&sTitle=#{URI.escape(data['title'].to_s)}" : ''
-ixBugParent = (data['parent'] ?
-               "&ixBugParent=#{URI.escape(data['parent'].to_s)}" : '')
-sTags = data['tags'] ? "&sTags=#{URI.escape(data['tags'].join(','))}" : ''
-sProject = (data['project'] ?
-            "&sProject=#{URI.escape(data['project'].to_s)}" : '')
-sArea = data['area'] ? "&sArea=#{URI.escape(data['area'].to_s)}" : ''
-sFixFor = (data['milestone'] ?
-           "&sFixFor=#{URI.escape(data['milestone'].to_s)}" : '')
-sCategory = (data['category'] ?
-             "&sCategory=#{URI.escape(data['category'].to_s)}" : '')
-sPersonAssignedTo = (data['assignee'] ?
-                     "&sPersonAssignedTo=#{URI.escape(data['assignee'].to_s)}" :
-                     '')
-sPriority = (data['priority'] ?
-             "&sPriority=#{URI.escape(data['priority'].to_s)}" : '')
-hrsCurrEst = (data['estimate'] ?
-              "&hrsCurrEst=#{URI.escape(data['estimate'].to_s)}" : '')
-sEvent = data['body'] ? "&sEvent=#{URI.escape(data['body'].to_s)}" : ''
-
-uri = URI format("#{api_url}?cmd=edit&token=%s&ixBug=%s%s%s%s%s%s%s%s%s%s%s%s",
-                 URI.escape(api_token), URI.escape(case_id),
-                 sTitle, ixBugParent, sTags, sProject, sArea, sFixFor, sCategory,
-                 sPersonAssignedTo, sPriority, hrsCurrEst, sEvent)
-http = Net::HTTP.new(uri.host, uri.port)
-if uri.scheme == 'https'
-  http.use_ssl = true
-  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-end
-response = http.start { |h| h.request Net::HTTP::Get.new(uri.request_uri) }
-if response.code != '200'
-  puts "HTTP request to #{api_url} failed with code #{response.code}."
-  exit 1
-end
-
-result = REXML::Document.new(response.body)
-error = result.elements['/response/error']
-if error
-  puts "Failed with error: #{error.text}."
-  exit 1
-end
+data = get_editor_content options, template
+
+params = { :ixBug => ARGV[0] }
+params[:sTitle] = data['title'] if data['title']
+params[:ixBugParent] = data['parent'] if data['parent']
+params[:sTags] = data['tags'].join(',') if data['tags']
+params[:sProject] = data['project'] if data['project']
+params[:sArea] = data['area'] if data['area']
+params[:sFixFor] = data['milestone'] if data['milestone']
+params[:sCategory] = data['category'] if data['category']
+params[:sPersonAssignedTo] = data['assignee'] if data['assignee']
+params[:sPriority] = data['priority'] if data['priority']
+params[:dtDue] = parse_time(data['due']) if parse_time(data['due'])
+params[:hrsCurrEst] = data['estimate'] if data['estimate']
+params[:sEvent] = data['body'] if data['body']
+
+do_api('edit', params)