rally_rest_api 0.5.5 → 0.5.6

data/CHANGELOG.txt

@@ -1,3 +1,9 @@
+2006-11-28  Bob Cotton  <bcotton@england.f4tech.com>
+
+	* Rakefile: Changed version package
+
+	* lib/rally_rest_api/query_result.rb: Fixed paging with each operator
+
 2006-11-27  Bob Cotton  <bcotton@england.f4tech.com>
 
 	* lib/rally_rest_api/query.rb: Added docs.

data/README.txt

@@ -3,12 +3,12 @@ rally-rest-api -- A Ruby-ized interface to Rally's REST webservice API
 ==Introduction:
 Rally Software Development's on-demand agile software life-cycle management services offers webservices API's for its customers. The API comes in both SOAP and REST style interfaces. This library is for accessing the REST API using Ruby. For more information about Rally's webservice APIs see https://rally1.rallydev.com/slm/doc/webservice/index.jsp.
 
-This API provides full access to all CRUD operations and an rich interface to the query facility. An Enumerable interface is provided for the paginated query results.
+This API provides full access to all CRUD operations and a rich interface to the query facility. An Enumerable interface is provided for the paginated query results.
 
 == Rationale (i.e. Why not SOAP?):
 Your subscription in Rally can be partitioned into several isolated "Workspaces", where the only thing shared between workspaces are your users. Any custom attributes you create will be specific to each workspace. When using the SOAP interface, the WSDL generated is specific to the workspace you are working in. Therefore the name-space (e.g. package in Java) will be different for each workspace you are working with.
 
-Because REST webservices do not have WSDL (the XML schema is available for each workspace), there is no per-workspace interface. Combined with the dynamic nature of this API, you don't need to code to different Ruby namespaces when you are working with multiple workspaces. You will however, need to be aware of the workspaces your objects are in when working with multiple workspaces.
+Because REST webservices do not have WSDL (the XML schema is available for each workspace), there is no per-workspace interface. Combined with the dynamic nature of this API, you don't need to code to different Ruby namespaces when you are working with multiple workspaces. You will, however, need to be aware of the workspaces your objects are in when working with multiple workspaces.
 
 == Getting Started:
 RallyRestAPI is the entry point to the api. Each instance corresponds to one user logged into Rally. There are several options that may be passed to the constructor:

data/Rakefile

@@ -22,7 +22,7 @@ RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
 
 NAME = "rally_rest_api"
 REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (RallyRestAPI::VERSION::STRING + (REV ? ".#{REV}" : ""))
+VERS = ENV['VERSION'] || (RallyRestVersion::VERSION::STRING + (REV ? ".#{REV}" : ""))
 CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "rally_rest_api documentation",
     "--opname", "index.html",

data/lib/rally_rest_api/query_result.rb

@@ -36,6 +36,7 @@ class QueryResult < RestObject
     @start_index = elements[:start_index].to_i
   end
 
+require 'active_support/breakpoint'
   # fetch the next page of results. Uses the original query to generate the query string.
   def next_page
     @rally_rest.query(@query.next_page(:start => self.start_index + self.page_size,
@@ -45,14 +46,15 @@ class QueryResult < RestObject
   # Iteration all pages of the result
   def each
     current_result = self
-    while current_result.more_pages?
+    begin 
+      last_result = current_result
       current_result.elements[:results].each do |result|
 	# The collection of refs we are holding onto could grow without bounds, so dup
 	# the ref
 	yield result.dup
       end
-      current_result = current_result.next_page
-    end
+      current_result = current_result.next_page if current_result.more_pages?
+    end while last_result != current_result
   end
 
   # return the first element. Useful for queries that return only one result
@@ -68,6 +70,6 @@ class QueryResult < RestObject
 
   # Are there more pages?
   def more_pages?
-    (self.start_index + self.page_length) < self.total_result_count
+    (self.start_index + self.page_length) -1 < self.total_result_count
   end
 end

data/lib/rally_rest_api/rally_rest.rb

@@ -88,8 +88,7 @@ class RallyRestAPI
     rest_object.delete
   end
   
-  private
-  def query(query) 
+  def query(query) # :nodoc:
     query_url = "#{@base_url}/webservice/1.0/#{query.type.to_s.to_camel}?" << query.to_q
     xml = read_rest(query_url, @username, @password)
     QueryResult.new(query, self, xml)

data/lib/rally_rest_api/rest_builder.rb

@@ -1,10 +1,10 @@
+require 'net/https'
+require 'uri'
+require 'rexml/document'
+require 'rubygems'	
+require 'builder'
 
 module RestBuilder # :nodoc:
-  require 'net/https'
-  require 'uri'
-  require 'rexml/document'
-  require 'rubygems'	
-  require_gem 'builder'
 
   DEBUG = false
   

data/lib/rally_rest_api/version.rb

@@ -1,8 +1,8 @@
-module RallyRestAPI #:nodoc:
+module RallyRestVersion #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 5
-    TINY  = 5
+    TINY  = 6
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/tc_query_result.rb

@@ -18,22 +18,22 @@ class QueryResultTestCase < Test::Unit::TestCase
   end
   
   def test_basic_numbers
-    result_xml = make_result(20, 20, 0)
+    result_xml = make_result(20, 20, 1)
     result = QueryResult.new(nil, @api, result_xml)
     assert_equal(20, result.total_result_count)
     assert_equal(20, result.page_size)
-    assert_equal(0, result.start_index)
+    assert_equal(1, result.start_index)
     assert_equal(20, result.page_length)
   end
 
   def test_more_pages_when_no_pages
-    query_result_xml = make_result(20, 20, 0)
+    query_result_xml = make_result(20, 20, 1)
     result = QueryResult.new(nil, @api, query_result_xml)
     assert(! result.more_pages?, "No more pages when total == page size")
   end
 
   def test_more_pages_when_more_pages
-    query_result_xml = make_result(21, 20, 0)
+    query_result_xml = make_result(21, 20, 1)
     result = QueryResult.new(nil, @api, query_result_xml)
     assert(result.more_pages?, "Should have more pages when total != page size")
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rally_rest_api
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
-date: 2006-11-27 00:00:00 -07:00
+  version: 0.5.6
+date: 2006-11-28 00:00:00 -07:00
 summary: A ruby-ized interface to Rally's REST webservices API
 require_paths: 
 - lib