rallycat 0.2.0 → 0.3.0

data/.rspec

@@ -1,3 +1,3 @@
 --color
---format progress
+--format documentation
 --profile

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rallycat (0.2.0)
+    rallycat (0.3.0)
       builder
       nokogiri
       rally_rest_api

data/TODO

@@ -1,14 +1,8 @@
 # Rallycat TODO
 
-* add update behavior for stories
-* add update behavior for defects
-* add sub-command support (so we can use -p for in-progress)
-* give user friendly error messages
-  * when you don't pass in a task
-  * when task does not exist
-  * when owner cannot be found
-* update help
-* make "help" default output
+* update help (use option_parser help or custom help)
+* add update behavior for stories (maybe)
+* add update behavior for defects (maybe)
 * Slow as balls? Make nice wait messages
 * Add man page
 

data/lib/rallycat/cat.rb

@@ -2,6 +2,7 @@ require 'nokogiri'
 
 module Rallycat
   class Cat
+    class StoryNotFound < StandardError; end
 
     def initialize(rally_api)
       @rally_api = rally_api
@@ -14,7 +15,9 @@ module Rallycat
         equal :formatted_id, story_number
       end
 
-      return "Story (#{ story_number }) does not exist." if results.total_result_count == 0
+      if results.total_result_count == 0
+        raise StoryNotFound, "Story (#{ story_number }) does not exist."
+      end
 
       consolidate_newlines parse_story(results.first)
     end

data/lib/rallycat/cli.rb

@@ -9,7 +9,8 @@ module Rallycat
 
     def run
       options = {}
-      option_parser = OptionParser.new do |opts|
+
+      global = OptionParser.new do |opts|
         opts.on('-u USERNAME', '--username') do |user|
           options[:user] = user
         end
@@ -18,40 +19,67 @@ module Rallycat
           options[:password] = password
         end
 
-        opts.on('-b', '--blocked') do |blocked|
-          options[:blocked] = true
+        opts.on('-h', '--help') do
+          @stdout.puts Rallycat::Help.new
+          exit
         end
+      end
 
-        opts.on('-i', '--in-progress') do |in_progress|
-          options[:in_progress] = true
-        end
+      commands = {
+        'cat' => OptionParser.new,
 
-        opts.on('-c', '--completed') do |completed|
-          options[:completed] = true
-        end
+        'update' => OptionParser.new do |opts|
+          opts.banner = 'Usage: rallycat update <story number> [options]'
 
-        opts.on('-d', '--defined') do |defined|
-          options[:defined] = true
-        end
+          opts.on('-b', '--blocked') do |blocked|
+            options[:blocked] = true
+          end
 
-        opts.on('-o OWNER', '--owner') do |owner|
-          options[:owner] = owner
-        end
-      end
+          opts.on('-p', '--in-progress') do |in_progress|
+            options[:in_progress] = true
+          end
+
+          opts.on('-c', '--completed') do |completed|
+            options[:completed] = true
+          end
+
+          opts.on('-d', '--defined') do |defined|
+            options[:defined] = true
+          end
 
-      option_parser.parse! @argv
+          opts.on('-o OWNER', '--owner') do |owner|
+            options[:owner] = owner
+          end
+        end,
 
-      case @argv.shift
+        'help' => OptionParser.new
+      }
+
+      global.order! @argv
+
+      command = @argv.shift
+      commands[command].order! @argv if commands.has_key? command
+
+      case command
       when 'cat'
         api = Rallycat::Connection.new(options[:user], options[:password]).api
 
-        @stdout.puts Rallycat::Cat.new(api).story(@argv.shift)
+        story_number = @argv.shift
+
+        abort 'The "cat" command requires a story or defect number.' unless story_number
+
+        begin
+          @stdout.puts Rallycat::Cat.new(api).story(story_number)
+        rescue Rallycat::Cat::StoryNotFound => e
+          abort e.message
+        end
       when 'update'
         api = Rallycat::Connection.new(options[:user], options[:password]).api
 
-
         task_number = @argv.shift
 
+        abort 'The "update" command requires a task number.' unless task_number
+
         opts = {}
         opts[:blocked] = true            if options[:blocked]
         opts[:state]   = "In-Progress"   if options[:in_progress]
@@ -59,12 +87,16 @@ module Rallycat
         opts[:state]   = "Defined"       if options[:defined]
         opts[:owner]   = options[:owner] if options[:owner]
 
-        @stdout.puts Rallycat::Update.new(api).task(task_number, opts)
+        begin
+          @stdout.puts Rallycat::Update.new(api).task(task_number, opts)
+        rescue Rallycat::Update::UserNotFound, Rallycat::Update::TaskNotFound => e
+          abort e.message
+        end
       when 'help'
         # `puts` calls `to_s`
         @stdout.puts Rallycat::Help.new
       else
-        @stdout.puts 'only support for `cat` exists at the moment.'
+        @stdout.puts "'#{command}' is not a supported command. See 'rallycat help'."
       end
     end
   end

data/lib/rallycat/help.rb

@@ -13,13 +13,17 @@ Configuration:
   at runtime and will take higher precedence than the configuration file.
 
 Global Options:
-  -u [USERNAME]                   # The Rally user
-  -p [PASSWORD]                   # The password for the Rally user
-  -h, --help                      # Displays this help text
+  -u [USERNAME]                           # The Rally user
+  -p [PASSWORD]                           # The password for the Rally user
+  -h, --help                              # Displays this help text
 
 Commands:
-  rallycat cat [STORY NUMBER]     # Displays the user story
-  rallycat help                   # Displays this help text
+  rallycat cat <story number>             # Displays the user story or defect
+  rallycat update <task number>           # Displays the user story
+    [--blocked | -b] [--in-progress | -i]
+    [--completed | -c] [--defined | -d]
+    [--owner | -o <fullname>]
+  rallycat help                           # Displays this help text
 
 
       HELP

data/lib/rallycat/update.rb

@@ -1,38 +1,88 @@
 module Rallycat
   class Update
+    class UserNotFound < StandardError; end
+    class TaskNotFound < StandardError; end
+
     def initialize(api)
       @api = api
     end
 
     def task(task_number, attributes)
-      results = @api.find(:task) do
-        equal :formatted_id, task_number
-      end
-
-      task = results.first
+      task = find_task(task_number)
 
+      # When we set the state of the task and we don't explicitly set it to
+      # blocked we want to remove the block. In our workflow, when you change
+      # the state of the task it is also unblocked.
       if attributes[:state] && !attributes[:blocked]
         attributes[:blocked] = false
       end
 
-      user_name = attributes[:owner]
-
-      if user_name
-        user_results = @api.find(:user) do
-          equal :display_name, user_name
-        end
-        attributes[:owner] = user_results.first.login_name
+      # The value in attributes[:owner] should be equal to the desired owner's 
+      # display name in Rally. We need to fetch the user in order to get their
+      # login_name. The login_name is needed in order to set the owner
+      # attribute of a task.
+      # 
+      # We decided it would be easier for the user to enter 'John Smith'
+      # instead of 'john.smith@foobar.com'.
+      if display_name = attributes[:owner]
+        login_name = find_user(display_name)
+        attributes[:owner] = login_name
       end
 
       task.update(attributes)
 
       messages = []
 
-      messages << %{Task (#{task_number}) was set to "#{attributes[:state]}".} if attributes[:state]
-      messages << "Task (#{task_number}) was blocked." if attributes[:blocked]
-      messages << %{Task (#{task_number}) was assigned to "#{user_name}".} if attributes[:owner]
+      if attributes[:state]
+        messages << state_message(task_number, attributes[:state])
+      end
+
+      if attributes[:blocked]
+        messages << blocked_message(task_number)
+      end
+
+      if attributes[:owner]
+        messages << owner_message(task_number, display_name)
+      end
 
       messages.join("\n")
     end
+
+    private
+    def find_task(task_number)
+      results = @api.find(:task) do
+        equal :formatted_id, task_number
+      end
+
+      if results.total_result_count == 0
+        raise TaskNotFound, "Task (#{task_number}) does not exist."
+      end
+
+      results.first
+    end
+
+    def find_user(display_name)
+      user_results = @api.find(:user) do
+        equal :display_name, display_name
+      end
+
+      if user_results.total_result_count == 0
+        raise UserNotFound, "User (#{display_name}) does not exist."
+      end
+
+      user_results.first.login_name
+    end
+
+    def state_message(task_number, state)
+      %{Task (#{task_number}) was set to "#{state}".}
+    end
+
+    def blocked_message(task_number)
+      "Task (#{task_number}) was blocked."
+    end
+
+    def owner_message(task_number, owner)
+      %{Task (#{task_number}) was assigned to "#{owner}".}
+    end
   end
 end

data/lib/rallycat/version.rb

@@ -1,3 +1,3 @@
 module Rallycat
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/integration_spec.rb

@@ -18,9 +18,34 @@ describe 'Rallycat' do
       sout.rewind
       sout.read.should include('# [US4567] - [Rework] Change link to button')
     end
+
+    it 'aborts when a story number is not given' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password cat }, sout
+
+      lambda {
+        Artifice.activate_with RallyStoryResponder.new do
+          cli.run
+        end
+      }.should raise_error(SystemExit, 'The "cat" command requires a story or defect number.')
+    end
+
+    it 'aborts when the story does not exist' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password cat US9999 }, sout
+
+      lambda {
+        Artifice.activate_with RallyNoResultsResponder.new do
+          cli.run
+        end
+      }.should raise_error(SystemExit, 'Story (US9999) does not exist.')
+    end
   end
 
   context 'help' do
+
     it 'displays a help screen to the user' do
       string_io = StringIO.new
 
@@ -31,7 +56,7 @@ describe 'Rallycat' do
       string_io.rewind
       expected = string_io.read
 
-      expected.should include("rallycat cat [STORY NUMBER]")
+      expected.should include("rallycat cat <story number>")
       expected.should include("Displays the user story")
     end
   end
@@ -43,7 +68,7 @@ describe 'Rallycat' do
       it 'sets the state to in-progress' do
         sout = StringIO.new
 
-        cli = Rallycat::CLI.new %w{ update -i TA6666 -u foo.bar@rallycat.com -p password }, sout
+        cli = Rallycat::CLI.new %w{ update -p TA6666 -u foo.bar@rallycat.com -p password }, sout
 
         task_responder = RallyTaskUpdateResponder.new
 
@@ -114,6 +139,48 @@ describe 'Rallycat' do
         sout.rewind
         sout.read.should include('Task (TA6666) was assigned to "Freddy Fender".')
       end
+
+      it 'aborts when the owner does not exist' do
+        sout = StringIO.new
+
+        cli = Rallycat::CLI.new %w{ update -o Norman\ Notreal TA6666 -u foo.bar@rallycat.com -p password }, sout
+
+        task_responder = RallyTaskUpdateResponder.new
+
+        lambda {
+          Artifice.activate_with task_responder do
+            cli.run
+          end
+        }.should raise_error(SystemExit, 'User (Norman Notreal) does not exist.')
+      end
+
+      it 'aborts when a task number is not given' do
+        sout = StringIO.new
+
+        cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password update }, sout
+
+        task_responder = RallyTaskUpdateResponder.new
+
+        lambda {
+          Artifice.activate_with task_responder do
+            cli.run
+          end
+        }.should raise_error(SystemExit, 'The "update" command requires a task number.')
+      end
+
+      it 'aborts when a task does not exist' do
+        sout = StringIO.new
+
+        cli = Rallycat::CLI.new %w{ update -i TA9999 -u foo.bar@rallycat.com -p password }, sout
+
+        task_responder = RallyNoResultsResponder.new
+
+        lambda {
+          Artifice.activate_with task_responder do
+            cli.run
+          end
+        }.should raise_error(SystemExit, 'Task (TA9999) does not exist.')
+      end
     end
   end
 end

data/spec/lib/rallycat/cat_spec.rb

@@ -129,5 +129,30 @@ STORY
     end
   end
 
+  it 'raises when the story does not exist' do
+    responder = lambda do |env|
+      [200, {}, [
+        <<-XML
+          <QueryResult rallyAPIMajor="1" rallyAPIMinor="17">
+          <Errors/>
+          <Warnings/>
+          <TotalResultCount>0</TotalResultCount>
+          <StartIndex>1</StartIndex>
+          <PageSize>20</PageSize>
+          <Results/>
+          </QueryResult>
+        XML
+      ]]
+    end
+
+    Artifice.activate_with responder do
+      story_num = "US9999"
+      cat = Rallycat::Cat.new(@api)
+
+      lambda {
+        cat.story(story_num)
+       }.should raise_error(Rallycat::Cat::StoryNotFound, 'Story (US9999) does not exist.')
+    end
+  end
 end
 

data/spec/lib/rallycat/cli_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Rallycat::CLI do
   it 'should default to STDOUT' do
-    STDOUT.should_receive(:puts).with 'only support for `cat` exists at the moment.'
+    STDOUT.should_receive(:puts).with "'' is not a supported command. See 'rallycat help'."
     cli = Rallycat::CLI.new []
     cli.run
   end
@@ -17,6 +17,6 @@ describe Rallycat::CLI, '#run' do
     cli.run
 
     sout.rewind
-    sout.read.should == "only support for `cat` exists at the moment.\n"
+    sout.read.should == "'foo' is not a supported command. See 'rallycat help'.\n"
   end
 end

data/spec/lib/rallycat/update_spec.rb

@@ -82,7 +82,6 @@ describe Rallycat::Update do
         message.should include('Task (TA6666) was assigned to "Freddy Fender"')
       end
 
-      # require "pry"; binding.pry
       post_request = responder.requests[4] # this is the request that actually updates the task
       post_request.should be_post
       post_request.url.should == 'https://rally1.rallydev.com/slm/webservice/1.17/task/12345'
@@ -92,4 +91,31 @@ describe Rallycat::Update do
       body.should include('<Owner>fred.fender@testing.com</Owner>')
     end
   end
+
+  it 'raises when the user could not be found' do
+    responder = RallyTaskUpdateResponder.new
+
+    Artifice.activate_with responder do
+      task_num = "TA6666"
+      update = Rallycat::Update.new(@api)
+
+      lambda {
+        update.task(task_num, state: 'Completed', owner: 'Norman Notreal')
+      }.should raise_error(Rallycat::Update::UserNotFound, 'User (Norman Notreal) does not exist.')
+    end
+  end
+
+  it 'raises when the task could not be found' do
+    responder = RallyNoResultsResponder.new
+
+    Artifice.activate_with responder do
+      task_num = "TA6666"
+      update = Rallycat::Update.new(@api)
+
+      lambda {
+        update.task(task_num, state: 'Completed')
+      }.should raise_error(Rallycat::Update::TaskNotFound, 'Task (TA6666) does not exist.')
+    end
+
+  end
 end

data/spec/support/rally_no_results_responder.rb

@@ -0,0 +1,28 @@
+class RallyNoResultsResponder
+  attr_reader :requests
+
+  def initialize
+    @requests = []
+  end
+
+  def last_request
+    @requests.last
+  end
+
+  def call(env)
+    @requests << request = Rack::Request.new(env)
+
+    [200, {}, [
+      <<-XML
+        <QueryResult rallyAPIMajor="1" rallyAPIMinor="17">
+        <Errors/>
+        <Warnings/>
+        <TotalResultCount>0</TotalResultCount>
+        <StartIndex>1</StartIndex>
+        <PageSize>20</PageSize>
+        <Results/>
+        </QueryResult>
+      XML
+    ]]
+  end
+end

data/spec/support/rally_task_update_responder.rb

@@ -82,7 +82,7 @@ class RallyTaskUpdateResponder
         XML
       ]]
     else
-      [200, {}, ['<else />']]
+      RallyNoResultsResponder.new.call(env)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rallycat
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70176499099720 !ruby/object:Gem::Requirement
+  requirement: &70303674111620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176499099720
+  version_requirements: *70303674111620
 - !ruby/object:Gem::Dependency
   name: rally_rest_api
-  requirement: &70176499099160 !ruby/object:Gem::Requirement
+  requirement: &70303674111020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176499099160
+  version_requirements: *70303674111020
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70176499098740 !ruby/object:Gem::Requirement
+  requirement: &70303674110340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176499098740
+  version_requirements: *70303674110340
 description: The Rally website sucks. CLI is better.
 email:
 - adam@adamtanner.org
@@ -80,6 +80,7 @@ files:
 - spec/lib/rallycat/update_spec.rb
 - spec/spec_helper.rb
 - spec/support/rally_defect_responder.rb
+- spec/support/rally_no_results_responder.rb
 - spec/support/rally_story_responder.rb
 - spec/support/rally_task_update_responder.rb
 homepage: https://github.com/adamtanner/rallycat
@@ -96,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 333992134023580695
+      hash: 4474919884476792167
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 333992134023580695
+      hash: 4474919884476792167
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.7
@@ -121,5 +122,6 @@ test_files:
 - spec/lib/rallycat/update_spec.rb
 - spec/spec_helper.rb
 - spec/support/rally_defect_responder.rb
+- spec/support/rally_no_results_responder.rb
 - spec/support/rally_story_responder.rb
 - spec/support/rally_task_update_responder.rb