rallycat 0.3.1 → 0.4.0

data/Gemfile.lock

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

data/TODO

@@ -1,6 +1,5 @@
 # Rallycat TODO
 
-* update help (use option_parser help or custom help)
 * todo time
 * set todo time
 * set notes on a task (-n overwrite, -N to append)
@@ -8,26 +7,21 @@
 * add update behavior for defects (maybe)
 * Slow as balls? Make nice wait messages
 * Add man page
-* Ordering of arguments matters? (rallycat update TA1234 -b silently fails)
 * Create .rallycatrc file on first run?
 * Listing stories
   * Per iteration
   * Per project (project configured in rc or passed in?)
 * AC-only story view
+* consolidate spec styles
 
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 
 ## Ideas
 
-US666 - My Story
-=================
+rallycat list -s <search phrase>    # do a contains lookup for an iteration
 
-````
-rallycat update --complete --blocked [-cdpsb] -o "Adam Tanner" TA1932`
-
-rallycat update -p -o "Emilio Cavazos" TA9832
-rallycat update -b TA1823 -m "Fix specs."
-````
+Keep a log of last (n) stories typed into `cat` so the default action for
+  `rallycat cat` will list the last (n) stories for the user.
 
 ### Notes
 
@@ -36,13 +30,12 @@ rallycat update -b TA1823 -m "Fix specs."
 
 
 ## Stats
+
 * Stories in progress
 * Stories accepted
 * Stories not accepted
 * Total To-Do Hours
 
-
-
 rally.vim -> Making User Stories from Vim
 
 ## Rallycat Futures

data/lib/rallycat.rb

@@ -1,11 +1,20 @@
 require 'rallycat/cat'
 require 'rallycat/cli'
+require 'rallycat/config'
 require 'rallycat/connection'
 require 'rallycat/help'
 require 'rallycat/html_to_text_converter'
+require 'rallycat/list'
 require 'rallycat/update'
 require 'rallycat/version'
 
 module Rallycat
-  # Your code goes here...
+  class RallycatError           < StandardError; end
+  class StoryNotFound           < RallycatError; end
+  class InvalidConfigError      < RallycatError; end
+  class InvalidCredentialsError < RallycatError; end
+  class ProjectNotFound         < RallycatError; end
+  class IterationNotFound       < RallycatError; end
+  class UserNotFound            < RallycatError; end
+  class TaskNotFound            < RallycatError; end
 end

data/lib/rallycat/cat.rb

@@ -2,7 +2,6 @@ require 'nokogiri'
 
 module Rallycat
   class Cat
-    class StoryNotFound < StandardError; end
 
     def initialize(rally_api)
       @rally_api = rally_api

data/lib/rallycat/cli.rb

@@ -12,19 +12,66 @@ module Rallycat
       parse_command_options!
     end
 
+    def run
+      case @command
+      when 'cat'
+        api = Rallycat::Connection.new(options[:username], options[:password]).api
+
+        story_number = @argv.shift
+
+        abort 'The "cat" command requires a story or defect number.' unless story_number
+
+        @stdout.puts Rallycat::Cat.new(api).story(story_number)
+      when 'update'
+        api = Rallycat::Connection.new(options[:username], 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]
+        opts[:state]   = "Completed"     if options[:completed]
+        opts[:state]   = "Defined"       if options[:defined]
+        opts[:owner]   = options[:owner] if options[:owner]
+
+        @stdout.puts Rallycat::Update.new(api).task(task_number, opts)
+      when 'list'
+        api = Rallycat::Connection.new(options[:username], options[:password]).api
+        project = options[:project]
+
+        if options[:iteration]
+          @stdout.puts Rallycat::List.new(api).stories(project, options[:iteration])
+        else
+          @stdout.puts Rallycat::List.new(api).iterations(project)
+        end
+      when 'help'
+        # `puts` calls `to_s`
+        @stdout.puts Rallycat::Help.new
+      else
+        @stdout.puts "'#{@command}' is not a supported command. See 'rallycat help'."
+      end
+
+    rescue Rallycat::RallycatError, ArgumentError => e
+      abort e.message
+    end
+
+    private
+
     def parse_global_options!
       @options ||= {}
 
       global = OptionParser.new do |opts|
-        opts.on('-u USERNAME', '--username') do |username|
+        opts.on('-u USERNAME', '--username', 'Your Rally username') do |username|
           @options[:username] = username
         end
 
-        opts.on('-p PASSWORD', '--password') do |password|
+        opts.on('-p PASSWORD', '--password', 'Your Rally password') do |password|
           @options[:password] = password
         end
 
-        opts.on('-h', '--help') do
+        opts.on('-h', '--help', 'Show this message') do
           @stdout.puts Rallycat::Help.new
           exit
         end
@@ -37,78 +84,53 @@ module Rallycat
       @options ||= {}
 
       commands = {
-        'cat' => OptionParser.new,
+        'cat' => OptionParser.new do |opts|
+          opts.banner = 'Usage: rallycat story <story number>'
+        end,
 
         'update' => OptionParser.new do |opts|
-          opts.banner = 'Usage: rallycat update <story number> [options]'
+          opts.banner = 'Usage: rallycat update <task number> [options]'
 
-          opts.on('-b', '--blocked') do |blocked|
+          opts.on('-b', '--blocked', 'Block the current state of a task') do |blocked|
             @options[:blocked] = true
           end
 
-          opts.on('-p', '--in-progress') do |in_progress|
+          opts.on('-p', '--in-progress', 'Set the state of a task to "In-Progress"') do |in_progress|
             @options[:in_progress] = true
           end
 
-          opts.on('-c', '--completed') do |completed|
+          opts.on('-c', '--completed', 'Set the state of a task to "Completed"') do |completed|
             @options[:completed] = true
           end
 
-          opts.on('-d', '--defined') do |defined|
+          opts.on('-d', '--defined', 'Set the state of a task to "Defined"') do |defined|
             @options[:defined] = true
           end
 
-          opts.on('-o OWNER', '--owner') do |owner|
+          opts.on('-o OWNER', '--owner', 'Set the owner of a task') do |owner|
             @options[:owner] = owner
           end
         end,
 
-        'help' => OptionParser.new
-      }
+        'list' => OptionParser.new do |opts|
+          opts.banner = 'Usage: rallycat list [options]'
 
-      @command = @argv.shift
-      commands[@command].parse! @argv if commands.has_key? @command
-    end
-
-    def run
-      case @command
-      when 'cat'
-        api = Rallycat::Connection.new(options[:username], options[:password]).api
-
-        story_number = @argv.shift
+          opts.on('-p [PROJECT]', '--project', 'The project whose iterations you want to list') do |project|
+            @options[:project] = project
+          end
 
-        abort 'The "cat" command requires a story or defect number.' unless story_number
+          opts.on('-i ITERATION', '--iteration', 'The iteration whose stories you want to list') do |iteration|
+            @options[:iteration] = iteration
+          end
+        end,
 
-        begin
-          @stdout.puts Rallycat::Cat.new(api).story(story_number)
-        rescue Rallycat::Cat::StoryNotFound => e
-          abort e.message
+        'help' => OptionParser.new do |opts|
+          opts.banner = 'Usage: rallycat help'
         end
-      when 'update'
-        api = Rallycat::Connection.new(options[:username], 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]
-        opts[:state]   = "Completed"     if options[:completed]
-        opts[:state]   = "Defined"       if options[:defined]
-        opts[:owner]   = options[:owner] if options[:owner]
+      }
 
-        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 "'#{@command}' is not a supported command. See 'rallycat help'."
-      end
+      @command = @argv.shift
+      commands[@command].parse! @argv if commands.has_key? @command
     end
   end
 end

data/lib/rallycat/config.rb

@@ -0,0 +1,16 @@
+module Rallycat
+  class Config
+    def initialize
+      begin
+        @config = YAML.load_file File.expand_path('~/.rallycatrc')
+      rescue StandardError
+        message = "Your rallycat config file is missing or invalid. See 'rallycat help'."
+        raise InvalidConfigError.new message
+      end
+    end
+
+    def [](key)
+      @config[key]
+    end
+  end
+end

data/lib/rallycat/connection.rb

@@ -2,46 +2,29 @@ require 'yaml'
 require 'rally_rest_api'
 require 'logger'
 
-module Rallycat
-  class InvalidConfigError < StandardError; end
-  class InvalidCredentialsError < StandardError; end
-
+module Rallycat 
   class Connection
     attr_reader :api
 
     def initialize(username=nil, password=nil)
-      @username = username
-      @password = password
+      @config = Config.new
 
-      config = parse_config
+      username ||= @config['username']
+      password ||= @config['password']
 
       begin
+        logger = ENV['RALLY_DEBUG'] ? Logger.new(STDOUT) : Logger.new(nil)
+
         @api = RallyRestAPI.new \
          base_url: 'https://rally1.rallydev.com/slm',
-         username: config.fetch('username'),
-         password: config.fetch('password'),
-         logger: Logger.new(nil)
+         username: username,
+         password: password,
+         logger: logger
 
       rescue Rally::NotAuthenticatedError
         raise InvalidCredentialsError.new('Your Rally credentials are invalid.')
       end
     end
-
-    private
-
-    def parse_config
-      rc_file_path = File.expand_path '~/.rallycatrc'
-
-      if @username || @password
-        { 'username' => @username, 'password' => @password }
-      else
-        begin
-          YAML.load_file(rc_file_path)
-        rescue StandardError
-          message = "Your rallycat config file is missing or invalid. Please RTFM."
-          raise InvalidConfigError.new message
-        end
-      end
-    end
   end
 end
+

data/lib/rallycat/help.rb

@@ -2,27 +2,39 @@ module Rallycat
   class Help
     def to_s
       <<-HELP
-Rallycat is a command line utility for interacting with Rally.
+Rallycat is a command-line utility for interacting with Rally. It should be
+used to support a command-line centric workflow. Rallycat has the simple goal
+of being a lightweight alternative to Rally's web interface. It provides quick
+access to Rally features that are important to developers in their day-to-day
+work.
 
 Configuration:
   Configuration is available through a ~/.rallycatrc file formatted as YAML.
   The file should have two keys: `username` and `password` for authenticating
-  with the Rally API.
+  with the Rally API. An additional project attribute can be added to make some
+  commands easiser to use. Example:
+
+    username: email@host.com
+    password: pass1234
+    project:  SuperBad
 
   Additionally, the `-u [USERNAME]` and `-p [PASSWORD]` flags may be provided
   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
+  -u [USERNAME]                           # Your Rally username
+  -p [PASSWORD]                           # Your Rally password
   -h, --help                              # Displays this help text
 
 Commands:
-  rallycat cat <story number>             # Displays the user story or defect
-  rallycat update <task number>           # Displays the user story
-    [--blocked | -b] [--in-progress | -i]
+  rallycat cat <story number>             # Displays a user story or defect
+  rallycat update <task number>           # Updates the state of a task
+    [--blocked | -b] [--in-progress | -p]
     [--completed | -c] [--defined | -d]
     [--owner | -o <fullname>]
+  rallycat list                           # List iterations and stories
+    [--project | -p <project name>]
+    [--iteration | -i <iteration name>]
   rallycat help                           # Displays this help text
 
 

data/lib/rallycat/list.rb

@@ -0,0 +1,96 @@
+module Rallycat
+  class List
+
+    def initialize(api)
+      @api = api
+      @config = Config.new
+    end
+
+    def iterations(project_name)
+      project_name ||= @config['project']
+
+      validate_arg project_name, 'Project name is required.'
+
+      project = find_project(project_name)
+
+      iterations = @api.find_all(:iteration, {
+        project: project,
+        order: 'StartDate desc',
+        pagesize: 10
+      }).results
+
+      if iterations.count == 0
+        return "No iterations could be found for project #{project_name}."
+      end
+
+      iteration_names = iterations.map(&:name).uniq
+
+      <<-LIST
+# 5 Most recent iterations for "#{project_name}"
+
+#{iteration_names.join("\n")}
+
+      LIST
+    end
+
+    def stories(project_name, iteration_name)
+      project_name ||= @config['project']
+
+      validate_arg project_name,   'Project name is required.'
+      validate_arg iteration_name, 'Iteration name is required.'
+
+      project   = find_project(project_name)
+      iteration = find_iteration(iteration_name, project)
+
+      stories = @api.find(:hierarchical_requirement, {
+        project: project,
+        pagesize: 100,
+        fetch: true
+      }) { equal :iteration, iteration }.results
+
+      stories += @api.find(:defect, {
+        project: project,
+        pagesize: 100,
+        fetch: true
+      }) { equal :iteration, iteration }.results
+
+      if stories.count == 0
+        return %{No stories could be found for iteration "#{iteration_name}".}
+      end
+
+      list = %{# Stories for iteration "#{iteration_name}" - "#{project_name}"\n\n}
+
+      stories.each do |story|
+        state = story.schedule_state == 'In-Progress' ? 'P' : story.schedule_state[0]
+        list += "* [#{story.formatted_i_d}] [#{state}] #{story.name}\n"
+      end
+
+      list += "\n"
+    end
+
+    private
+
+    def validate_arg(val, message)
+      raise ArgumentError, message if val.nil? || val.empty?
+    end
+
+    def find_project(project_name)
+      project = @api.find(:project) { equal(:name, project_name) }.first
+
+      raise ProjectNotFound, "Project (#{project_name}) does not exist." unless project
+
+      project
+    end
+
+    def find_iteration(iteration_name, project)
+      iteration = @api.find(:iteration, :project => project) {
+        equal(:name, iteration_name)
+      }.first
+
+      raise IterationNotFound, "Iteration (#{iteration_name}) does not exist." unless iteration
+
+      iteration
+    end
+  end
+end
+

data/lib/rallycat/update.rb

@@ -1,7 +1,5 @@
 module Rallycat
   class Update
-    class UserNotFound < StandardError; end
-    class TaskNotFound < StandardError; end
 
     def initialize(api)
       @api = api

data/lib/rallycat/version.rb

@@ -1,3 +1,3 @@
 module Rallycat
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/integration_spec.rb

@@ -57,7 +57,7 @@ describe 'Rallycat' do
       expected = string_io.read
 
       expected.should include("rallycat cat <story number>")
-      expected.should include("Displays the user story")
+      expected.should include("Displays a user story or defect")
     end
   end
 
@@ -183,4 +183,108 @@ describe 'Rallycat' do
       end
     end
   end
+
+  context 'list' do
+
+    it 'outputs the last 5 iterations for the users configured project' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list }, sout
+
+      Artifice.activate_with RallyIterationsResponder.new do
+        rc_file = File.expand_path("~/.rallycatrc")
+        YAML.stub(:load_file).with(rc_file).and_return({
+          'project' => 'SuperBad'
+        })
+
+        cli.run
+      end
+
+      sout.rewind
+      sout.read.should include('# 5 Most recent iterations for "SuperBad"')
+    end
+
+    it 'outputs the last 5 iterations for the project provided' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list -p SuperBad }, sout
+
+      Artifice.activate_with RallyIterationsResponder.new do
+        cli.run
+      end
+
+      sout.rewind
+      sout.read.should include('# 5 Most recent iterations for "SuperBad"')
+    end
+
+    it 'outputs the stories for an iteration constrained by the configured project' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list -i 25\ (2012-05-01\ to\ 2012-05-05) }, sout
+
+      Artifice.activate_with RallyStoriesResponder.new do
+        rc_file = File.expand_path("~/.rallycatrc")
+        YAML.stub(:load_file).with(rc_file).and_return({
+          'project' => 'SuperBad'
+        })
+
+        cli.run
+      end
+
+      sout.rewind
+      sout.read.should include('# Stories for iteration "25 (2012-05-01 to 2012-05-05)" - "SuperBad"')
+    end
+
+    it 'outputs the stories for an iteration constrained by the project provided' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list -p SuperBad -i 25\ (2012-05-01\ to\ 2012-05-05) }, sout
+
+      Artifice.activate_with RallyStoriesResponder.new do
+        cli.run
+      end
+
+      sout.rewind
+      sout.read.should include('# Stories for iteration "25 (2012-05-01 to 2012-05-05)" - "SuperBad"')
+    end
+
+    it 'aborts when project is not found' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list -p WebFarts -i 25\ (2012-05-01\ to\ 2012-05-05) }, sout
+
+      lambda {
+        Artifice.activate_with RallyStoriesResponder.new do
+          cli.run
+        end
+      }.should raise_error(SystemExit, 'Project (WebFarts) does not exist.')
+    end
+
+    it 'aborts when iteration is not found' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list -p SuperBad -i Sprint\ 0 }, sout
+
+      lambda {
+        Artifice.activate_with RallyStoriesResponder.new do
+          cli.run
+        end
+      }.should raise_error(SystemExit, 'Iteration (Sprint 0) does not exist.')
+    end
+
+    it 'aborts when project is not configured or provided' do
+      sout = StringIO.new
+
+      cli = Rallycat::CLI.new %w{ -u foo.bar@rallycat.com -p password list }, sout
+
+      lambda {
+        Artifice.activate_with RallyStoriesResponder.new do
+          rc_file = File.expand_path("~/.rallycatrc")
+          YAML.stub(:load_file).with(rc_file).and_return({ })
+
+          cli.run
+        end
+      }.should raise_error(SystemExit, 'Project name is required.')
+    end
+  end
 end

data/spec/{lib/rallycat → rallycat}/cat_spec.rb

@@ -148,7 +148,7 @@ STORY
 
       lambda {
         cat.story(story_num)
-       }.should raise_error(Rallycat::Cat::StoryNotFound, 'Story (US9999) does not exist.')
+       }.should raise_error(Rallycat::StoryNotFound, 'Story (US9999) does not exist.')
     end
   end
 end

data/spec/{lib/rallycat → rallycat}/connection_spec.rb

@@ -23,7 +23,7 @@ describe Rallycat::Connection do
           @connection = Rallycat::Connection.new
         end
       }.should raise_error Rallycat::InvalidConfigError,
-        'Your rallycat config file is missing or invalid. Please RTFM.'
+        "Your rallycat config file is missing or invalid. See 'rallycat help'."
     end
 
     it "raises when the credentials are invalid" do
@@ -88,4 +88,4 @@ describe Rallycat::Connection do
     end
 
   end
-end
+end

data/spec/rallycat/list_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+describe Rallycat::List, '#iterations' do
+
+  before do
+    Artifice.activate_with RallyAuthResponder.new do
+      @api = Rallycat::Connection.new('foo.bar@rallycat.com', 'password').api
+    end
+  end
+
+  it 'returns last five iterations for the project provided' do
+    expected = <<-LIST
+# 5 Most recent iterations for "SuperBad"
+
+25 (2012-05-01 to 2012-05-05)
+24 (2012-04-01 to 2012-04-05)
+23 (2012-03-01 to 2012-03-05)
+22 (2012-02-01 to 2012-02-05)
+21 (2012-01-01 to 2012-01-05)
+
+    LIST
+
+    Artifice.activate_with RallyIterationsResponder.new do
+      project = 'SuperBad'
+      list = Rallycat::List.new(@api)
+      list.iterations(project).should == expected
+    end
+  end
+
+  it 'returns last five iterations for the configured project in .rallycatrc' do
+    expected = <<-LIST
+# 5 Most recent iterations for "SuperBad"
+
+25 (2012-05-01 to 2012-05-05)
+24 (2012-04-01 to 2012-04-05)
+23 (2012-03-01 to 2012-03-05)
+22 (2012-02-01 to 2012-02-05)
+21 (2012-01-01 to 2012-01-05)
+
+    LIST
+
+    Artifice.activate_with RallyIterationsResponder.new do
+      rc_file = File.expand_path("~/.rallycatrc")
+      YAML.stub(:load_file).with(rc_file).and_return({
+        'project' => 'SuperBad'
+      })
+      list = Rallycat::List.new(@api)
+      list.iterations(nil).should == expected
+    end
+  end
+
+  it 'raises when project name is empty' do
+    lambda {
+      list = Rallycat::List.new(@api)
+      list.iterations('').should == expected
+    }.should raise_error(ArgumentError, 'Project name is required.')
+  end
+
+  it 'raises when project name is nil' do
+    lambda {
+      rc_file = File.expand_path("~/.rallycatrc")
+      YAML.stub(:load_file).with(rc_file).and_return({})
+
+      list = Rallycat::List.new(@api)
+      list.iterations(nil).should == expected
+    }.should raise_error(ArgumentError, 'Project name is required.')
+  end
+
+  it 'raises when project cannot be found' do
+    Artifice.activate_with RallyNoResultsResponder.new do
+      lambda {
+        list = Rallycat::List.new(@api)
+        list.iterations('WebFarts').should == expected
+      }.should raise_error(Rallycat::ProjectNotFound, 'Project (WebFarts) does not exist.')
+    end
+  end
+
+  it 'returns a user friendly message when project has no iterations' do
+    Artifice.activate_with RallyIterationsResponder.new do
+      project = 'SuperAwful'
+      list = Rallycat::List.new(@api)
+      list.iterations(project).should == 'No iterations could be found for project SuperAwful.'
+    end
+  end
+end
+
+describe Rallycat::List, '#stories' do
+  before do
+    Artifice.activate_with RallyAuthResponder.new do
+      @api = Rallycat::Connection.new('foo.bar@rallycat.com', 'password').api
+    end
+  end
+
+  it 'returns the stories for an iteration filtered by sprint' do
+    expected = <<-LIST
+# Stories for iteration "25 (2012-05-01 to 2012-05-05)" - "SuperBad"
+
+* [US123] [C] This is story number one
+* [US456] [P] This is story number two
+* [DE789] [D] This is defect number one
+
+    LIST
+
+    Artifice.activate_with RallyStoriesResponder.new do
+      project = 'SuperBad'
+      iteration = '25 (2012-05-01 to 2012-05-05)'
+      list = Rallycat::List.new(@api)
+      list.stories(project, iteration).should == expected
+    end
+  end
+
+  it 'raises when project name is empty' do
+    lambda {
+      list = Rallycat::List.new(@api)
+      list.stories('', '25 (2012-05-01 to 2012-05-05)').should == expected
+    }.should raise_error(ArgumentError, 'Project name is required.')
+  end
+
+  it 'raises when project name is nil' do
+    lambda {
+      rc_file = File.expand_path("~/.rallycatrc")
+      YAML.stub(:load_file).with(rc_file).and_return({})
+
+      list = Rallycat::List.new(@api)
+      list.stories(nil, '25 (2012-05-01 to 2012-05-05)').should == expected
+    }.should raise_error(ArgumentError, 'Project name is required.')
+  end
+
+  it 'raises when iteration name is empty' do
+    lambda {
+      list = Rallycat::List.new(@api)
+      list.stories('SuperBad', '').should == expected
+    }.should raise_error(ArgumentError, 'Iteration name is required.')
+  end
+
+  it 'raises when iteration name is nil' do
+    lambda {
+      list = Rallycat::List.new(@api)
+      list.stories('SuperBad', nil).should == expected
+    }.should raise_error(ArgumentError, 'Iteration name is required.')
+  end
+
+  it 'raises when project cannot be found' do
+    Artifice.activate_with RallyNoResultsResponder.new do
+      lambda {
+        list = Rallycat::List.new(@api)
+        list.stories('WebFarts', '25 (2012-05-01 to 2012-05-05)')
+      }.should raise_error(Rallycat::ProjectNotFound, 'Project (WebFarts) does not exist.')
+    end
+  end
+
+  it 'raises when iteration cannot be found' do
+    Artifice.activate_with RallyStoriesResponder.new do
+      lambda {
+        list = Rallycat::List.new(@api)
+        list.stories('SuperBad', 'Sprint 0')
+      }.should raise_error(Rallycat::IterationNotFound, 'Iteration (Sprint 0) does not exist.')
+    end
+  end
+
+  it 'returns a user friendly message when iteration has no stories' do
+    Artifice.activate_with RallyStoriesResponder.new do
+      project = 'SuperBad'
+      iteration = '26 (2012-06-01 to 2012-06-05)'
+      list = Rallycat::List.new(@api)
+      list.stories(project, iteration).should == 'No stories could be found for iteration "26 (2012-06-01 to 2012-06-05)".'
+    end
+  end
+end
+

data/spec/{lib/rallycat → rallycat}/update_spec.rb

@@ -119,7 +119,7 @@ describe Rallycat::Update do
 
       lambda {
         update.task(task_num, state: 'Completed', owner: 'Norman Notreal')
-      }.should raise_error(Rallycat::Update::UserNotFound, 'User (Norman Notreal) does not exist.')
+      }.should raise_error(Rallycat::UserNotFound, 'User (Norman Notreal) does not exist.')
     end
   end
 
@@ -132,8 +132,8 @@ describe Rallycat::Update do
 
       lambda {
         update.task(task_num, state: 'Completed')
-      }.should raise_error(Rallycat::Update::TaskNotFound, 'Task (TA6666) does not exist.')
+      }.should raise_error(Rallycat::TaskNotFound, 'Task (TA6666) does not exist.')
     end
 
   end
-end
+end

data/spec/support/generic_responder.rb

@@ -10,6 +10,7 @@ class GenericResponder
   end
 
   def call(env)
+    # does not record the requests
     [200, {}, ['']]
   end
 end

data/spec/support/rally_auth_responder.rb

@@ -0,0 +1,11 @@
+class RallyAuthResponder < GenericResponder
+
+  def call(env)
+    @requests << request = Rack::Request.new(env)
+    if request.url == 'https://rally1.rallydev.com/slm/webservice/current/user'
+      [200, {}, ['<User><DisplayName></DisplayName></User>']]
+    else
+      [500, {}, ['oh noes']]
+    end
+  end
+end

data/spec/support/rally_iterations_responder.rb

@@ -0,0 +1,76 @@
+class RallyIterationsResponder < GenericResponder
+
+  def call(env)
+    @requests << request = Rack::Request.new(env)
+
+    case request.url
+    when 'https://rally1.rallydev.com/slm/webservice/current/Project?query=%28Name+%3D+SuperBad%29'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object ref="https://rally1.rallydev.com/slm/webservice/1.36/project/777555" type="Project">
+                <Name>SuperBad</Name>
+              </Object>
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/current/Iteration?query=%28ObjectID+%3E+0%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.36%2Fproject%2F777555&order=Startdate+desc&pagesize=10'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object type="Iteration">
+                <Name>25 (2012-05-01 to 2012-05-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>25 (2012-05-01 to 2012-05-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>24 (2012-04-01 to 2012-04-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>24 (2012-04-01 to 2012-04-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>23 (2012-03-01 to 2012-03-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>23 (2012-03-01 to 2012-03-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>22 (2012-02-01 to 2012-02-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>22 (2012-02-01 to 2012-02-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>21 (2012-01-01 to 2012-01-05)</Name>
+              </Object>
+              <Object type="Iteration">
+                <Name>21 (2012-01-01 to 2012-01-05)</Name>
+              </Object>
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/current/Project?query=%28Name+%3D+SuperAwful%29'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object ref="https://rally1.rallydev.com/slm/webservice/1.36/project/888444" type="Project">
+                <Name>SuperAwful</Name>
+              </Object>
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/current/Iteration?query=%28ObjectID+%3E+0%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.36%2Fproject%2F888444&order=Startdate+desc&pagesize=10'
+      RallyNoResultsResponder.new.call(env)
+    else
+      RallyNoResultsResponder.new.call(env)
+    end
+  end
+end

data/spec/support/rally_stories_responder.rb

@@ -0,0 +1,100 @@
+class RallyStoriesResponder < GenericResponder
+
+  def call(env)
+    @requests << request = Rack::Request.new(env)
+
+    case request.url
+    when 'https://rally1.rallydev.com/slm/webservice/current/Project?query=%28Name+%3D+SuperBad%29'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object ref="https://rally1.rallydev.com/slm/webservice/1.17/project/777555" type="Project" />
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/1.17/project/777555'
+      [200, {}, [
+        <<-XML
+          <Project ref="https://rally1.rallydev.com/slm/webservice/1.17/project/777555">
+            <Name>SuperBad</Name>
+          </Project>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/current/Iteration?query=%28Name+%3D+%2225+%282012-05-01+to+2012-05-05%29%22%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fproject%2F777555'
+      [200, {}, [
+        # NOTE: Always getting two results back from Rally, not sure why.
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object ref="https://rally1.rallydev.com/slm/webservice/1.17/iteration/1234" type="Iteration" />
+              <Object ref="https://rally1.rallydev.com/slm/webservice/1.17/iteration/4567" type="Iteration" />
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/1.17/iteration/1234'
+      [200, {}, [
+        <<-XML
+          <Iteration>
+            <Name>25 (2012-05-01 to 2012-05-05)</Name>
+          </Iteration>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/current/HierarchicalRequirement?query=%28Iteration+%3D+%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fproject%2F777555&pagesize=100&fetch=true'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object type="HierarchicalRequirement">
+                <FormattedID>US123</FormattedID>
+                <Name>This is story number one</Name>
+                <ScheduleState>Completed</ScheduleState>
+              </Object>
+              <Object type="HierarchicalRequirement">
+                <FormattedID>US456</FormattedID>
+                <Name>This is story number two</Name>
+                <ScheduleState>In-Progress</ScheduleState>
+              </Object>
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/current/Defect?query=%28Iteration+%3D+%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fproject%2F777555&pagesize=100&fetch=true'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object type="Defect">
+                <FormattedID>DE789</FormattedID>
+                <Name>This is defect number one</Name>
+                <ScheduleState>Defined</ScheduleState>
+              </Object>
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+
+    # These are for testing the not so happy path.
+    when 'https://rally1.rallydev.com/slm/webservice/current/Iteration?query=%28Name+%3D+%22Sprint+0%22%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fproject%2F777555'
+      RallyNoResultsResponder.new.call(env)
+    when 'https://rally1.rallydev.com/slm/webservice/current/Iteration?query=%28Name+%3D+%2226+%282012-06-01+to+2012-06-05%29%22%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fproject%2F777555'
+      [200, {}, [
+        <<-XML
+          <QueryResult>
+            <Results>
+              <Object ref="https://rally1.rallydev.com/slm/webservice/1.17/iteration/7890" type="Iteration" />
+            </Results>
+          </QueryResult>
+        XML
+      ]]
+    when 'https://rally1.rallydev.com/slm/webservice/1.17/iteration/7890'
+      # does nothing WTF(but will make tests fail if not here)???
+    when 'https://rally1.rallydev.com/slm/webservice/current/HierarchicalRequirement?query=%28Iteration+%3D+https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fiteration%2F7890%29&project=https%3A%2F%2Frally1.rallydev.com%2Fslm%2Fwebservice%2F1.17%2Fproject%2F777555&pagesize=100&fetch=true'
+      RallyNoResultsResponder.new.call(env)
+    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.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70357622298460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70357622298460
 - !ruby/object:Gem::Dependency
   name: rally_rest_api
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70357622297960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,15 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70357622297960
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70357622297540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,12 +44,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70357622297540
 description: The Rally website sucks. CLI is better.
 email:
 - adam@adamtanner.org
@@ -81,22 +66,28 @@ files:
 - lib/rallycat.rb
 - lib/rallycat/cat.rb
 - lib/rallycat/cli.rb
+- lib/rallycat/config.rb
 - lib/rallycat/connection.rb
 - lib/rallycat/help.rb
 - lib/rallycat/html_to_text_converter.rb
+- lib/rallycat/list.rb
 - lib/rallycat/update.rb
 - lib/rallycat/version.rb
 - rallycat.gemspec
 - spec/integration_spec.rb
-- spec/lib/rallycat/cat_spec.rb
-- spec/lib/rallycat/cli_spec.rb
-- spec/lib/rallycat/connection_spec.rb
-- spec/lib/rallycat/html_to_text_converter_spec.rb
-- spec/lib/rallycat/update_spec.rb
+- spec/rallycat/cat_spec.rb
+- spec/rallycat/cli_spec.rb
+- spec/rallycat/connection_spec.rb
+- spec/rallycat/html_to_text_converter_spec.rb
+- spec/rallycat/list_spec.rb
+- spec/rallycat/update_spec.rb
 - spec/spec_helper.rb
 - spec/support/generic_responder.rb
+- spec/support/rally_auth_responder.rb
 - spec/support/rally_defect_responder.rb
+- spec/support/rally_iterations_responder.rb
 - spec/support/rally_no_results_responder.rb
+- spec/support/rally_stories_responder.rb
 - spec/support/rally_story_responder.rb
 - spec/support/rally_task_update_responder.rb
 homepage: https://github.com/adamtanner/rallycat
@@ -113,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1844620157454279745
+      hash: -2821747029306890735
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,23 +113,27 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1844620157454279745
+      hash: -2821747029306890735
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: The Rally website sucks. CLI is better.
 test_files:
 - spec/integration_spec.rb
-- spec/lib/rallycat/cat_spec.rb
-- spec/lib/rallycat/cli_spec.rb
-- spec/lib/rallycat/connection_spec.rb
-- spec/lib/rallycat/html_to_text_converter_spec.rb
-- spec/lib/rallycat/update_spec.rb
+- spec/rallycat/cat_spec.rb
+- spec/rallycat/cli_spec.rb
+- spec/rallycat/connection_spec.rb
+- spec/rallycat/html_to_text_converter_spec.rb
+- spec/rallycat/list_spec.rb
+- spec/rallycat/update_spec.rb
 - spec/spec_helper.rb
 - spec/support/generic_responder.rb
+- spec/support/rally_auth_responder.rb
 - spec/support/rally_defect_responder.rb
+- spec/support/rally_iterations_responder.rb
 - spec/support/rally_no_results_responder.rb
+- spec/support/rally_stories_responder.rb
 - spec/support/rally_story_responder.rb
 - spec/support/rally_task_update_responder.rb