rally_rest_api 0.6.2 → 0.6.3

data/lib/rally_rest_api/query_result.rb

@@ -72,4 +72,10 @@ class QueryResult < RestObject
     return false if start_index == 0
     (self.start_index + self.page_length) -1 < self.total_result_count
   end
+
+   protected
+   def parse_collections_as_hash?
+     false
+   end
+
 end

data/lib/rally_rest_api/rally_rest.rb

@@ -3,7 +3,6 @@ require 'uri'
 require 'rexml/document'
 require 'ostruct'
 
-
 #
 # RallyRestAPI - A Ruby-ized interface to Rally's REST webservice API
 #
@@ -11,6 +10,7 @@ class RallyRestAPI
   include RestBuilder
  
   attr_reader :username, :password, :base_url, :raise_on_warning, :logger
+  attr_accessor :parse_collections_as_hash
 
   ALLOWED_TYPES = %w[subscription workspace project iteration release defect defect_suite test_case
                      feature supplemental_requirement use_case story actor card
@@ -35,6 +35,7 @@ class RallyRestAPI
     @base_url = options[:base_url]
     @raise_on_warning = options[:raise_on_warning]
     @logger = options[:logger]
+    @parse_collections_as_hash = options[:parse_collections_as_hash] || false
   end
 
   # return an instance of User, for the currently logged in user. 
@@ -95,6 +96,17 @@ class RallyRestAPI
     QueryResult.new(query, self, xml)
   end
 
+  # Should rest_objects parse into hashes
+  def parse_collections_as_hash?
+    @parse_collections_as_hash
+  end
+
+  protected
+  def debug(message) 
+    @logger.debug(message) if @logger
+  end
+
 end
 
 
+

data/lib/rally_rest_api/rest_builder.rb

@@ -18,7 +18,7 @@ module RestBuilder # :nodoc:
   # then call create on the REST api
   def create_rest(artifact_type, args, username, password)
     type = camel_case_word(artifact_type)
-    puts "RestBuilder#create_rest artifact_type = #{type}" if DEBUG
+    debug "RestBuilder#create_rest artifact_type = #{type}"
     b = create_builder
     xml = b.__send__(type, &builder_block(args))
 
@@ -37,7 +37,7 @@ module RestBuilder # :nodoc:
   #    }
   # then call create on the REST api
   def update_rest(artifact_type, url, args, username, password)
-    puts "RestBuilder#update_rest url = #{url}" if DEBUG
+    debug  "RestBuilder#update_rest url = #{url}"
     b = create_builder
     # and pass that to the builder
     xml = b.__send__(artifact_type, :ref => url, &builder_block(args))
@@ -45,21 +45,21 @@ module RestBuilder # :nodoc:
   end
 
   def read_rest(ref_url, username, password)
-    puts "RestBuilder#read_rest ref_url = #{ref_url} username = #{ username } pass = #{ password }" if DEBUG
+    debug  "RestBuilder#read_rest ref_url = #{ref_url} username = #{ username } pass = #{ password }"
     url = URI.parse(ref_url)
     req = Net::HTTP::Get.new(url.path + (url.query ? "?" + url.query : ""))
     send_request(url, req, username, password)
   end
 
   def delete_rest(ref_url, username, password)
-    puts "RestBuilder#delete_rest ref_url = #{ref_url} username = #{ username } pass = #{ password }" if DEBUG
+    debug  "RestBuilder#delete_rest ref_url = #{ref_url} username = #{ username } pass = #{ password }"
     url = URI.parse(ref_url)
     req = Net::HTTP::Delete.new(url.path)
     send_request(url, req, username, password)
   end
 
   def post_xml(url, xml, username, password)
-    puts "RestBuilder#post_xml xml = #{xml} as user #{ self.username } pass = #{ self.password }" if DEBUG
+    debug  "RestBuilder#post_xml xml = #{xml} as user #{ self.username } pass = #{ self.password }"
     url = URI.parse(url)
     req = Net::HTTP::Post.new(url.path)
     req.body = xml
@@ -67,13 +67,13 @@ module RestBuilder # :nodoc:
   end
 
   def send_request(url, req, username, password)
-    puts "RestBuilder#send_request req = #{req.inspect}" if DEBUG
+    debug  "RestBuilder#send_request req = #{req.inspect}"
     req.basic_auth username, password
     req.content_type = 'text/xml'
     http = Net::HTTP.new(url.host, url.port)
     http.use_ssl = true if url.scheme == "https"
     body = http.start { |http| http.request(req) }.body
-    puts "RestBuilder#send_request result = #{body}" if DEBUG
+    debug  "RestBuilder#send_request result = #{body}"
     check_for_errors(body)
     body
   end

data/lib/rally_rest_api/rest_object.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require File.dirname(__FILE__) + '/rest_builder'
 
 # == An interface to a Rally resource
@@ -19,8 +20,6 @@ require File.dirname(__FILE__) + '/rest_builder'
 class RestObject
   include RestBuilder
 
-  DEBUG = false
-
   attr_reader :username, :password, :rally_rest
   alias :builder :rally_rest
 
@@ -36,17 +35,16 @@ class RestObject
     end
   end
 
-  
   private
   def parse(node)
-    puts "parse self = #{self.object_id} node = #{ node.to_s }" if DEBUG
+    debug  "parse self = #{self.object_id} node = #{ node.to_s }"
 
     if !node.has_elements?
       if ref?(node)
-	puts "Returning RestObject for #{ node.to_s}" if DEBUG
+	debug  "Returning RestObject for #{ node.to_s}"
 	return RestObject.new(@rally_rest, node.to_s)
       else
-	puts "Returning text #{ node.text }" if DEBUG
+	debug  "Returning text #{ node.text }"
 	return node.text
       end
     end
@@ -63,16 +61,16 @@ class RestObject
     #Add all the element's children to the hash.
     node.each_element do |e|
       name = underscore(e.name).to_sym
-      puts "Looking at name = #{ name }" if DEBUG
+      debug  "Looking at name = #{ name }"
       case elements[name]
 	# We've not seen this element before
       when NilClass
-	puts "NilClass name = #{ name }" if DEBUG
+	debug  "NilClass name = #{ name }"
 	# if we have a collection of things with refObjectName attributes, collect them into a hash 
-	# with the refObjectName as the key
-	if named_collection?(e)
-	  puts "Named collection #{ name }" if DEBUG
-	  elements[name] = {}  # We might want to decorate {} here to handle scoping
+	# with the refObjectName as the key, unless we're told not to make hashs out of collections.
+	if named_collection?(e) && parse_collections_as_hash?
+	  debug  "Named collection #{ name }"
+	  elements[name] = {}
 	  e.elements.each do |child|
 	    ref_name = child.attributes["refObjectName"]
 	    if elements[name][ref_name]
@@ -82,21 +80,21 @@ class RestObject
 	      elements[name][ref_name] =  parse(child)
 	    end
 	  end
-	elsif unnamed_collection?(e)
-	  puts "UnNamed collection #{ name }" if DEBUG
+	elsif collection?(e)
+	  debug  "Collection #{ name }"
 	  elements[name] = []
 	  e.elements.each do |child|
 	    elements[name] << parse(child)
 	  end
 	else # a fully dressed object, without a name
-	  puts "Fully Dressed object, without a name #{ name }" if DEBUG
+	  debug  "Fully Dressed object, without a name #{ name }"
 	  elements[name] = parse(e)
 	end
 
 	#Non-unique child elements become arrays: We've already
 	#created the array: just add the element.
       when Array
-	puts "Array name = #{ name }" if DEBUG
+	debug  "Array name = #{ name }"
 	elements[name] << parse(e)
 
 	#We haven't created the array yet: do so,
@@ -105,7 +103,7 @@ class RestObject
 #      when Hash
 #	raise "Don't know how to deail with a named collection we've already seen! element = #{e}"
       else
-	puts "creating and wrapping #{elements[name]}with an array name = #{ name }" if DEBUG
+	debug  "creating and wrapping #{elements[name]}with an array name = #{ name }"
 	elements[name] = [elements[name]]
 	elements[name] << parse(e)
       end
@@ -207,11 +205,15 @@ class RestObject
 
   protected 
   def named_collection?(element) # :nodoc:
-    element.elements.find_all { |e| e.attributes['ref'] && e.attributes['refObjectName'] }.length > 0
+    collection?(element) && element.elements.find_all { |e| e.attributes['ref'] && e.attributes['refObjectName'] }.length > 0
   end
 
   def unnamed_collection?(element) # :nodoc:
-    element.elements.find_all { |e| e.attributes['ref'] && e.attributes['refObjectName'] == nil }.length > 0
+    collection?(element) && element.elements.find_all { |e| e.attributes['ref'] && e.attributes['refObjectName'] == nil }.length > 0
+  end
+
+  def collection?(element) # :nodoc:
+    !element.has_attributes? && element.has_elements? && element.elements.find_all { |e| e.attributes['ref'] }.length == element.elements.size
   end
 
   def ref?(element) # :nodoc:
@@ -220,4 +222,12 @@ class RestObject
       !element.attributes["ref"].nil?
   end
 
+  def parse_collections_as_hash? # :nodoc:
+    self.rally_rest.parse_collections_as_hash?
+  end
+
+  def debug(message) 
+#    @rally_rest.logger.debug(message) if @rally_rest.logger
+  end
+
 end

data/lib/rally_rest_api/typedef.rb

@@ -15,19 +15,10 @@ class TypeDefinition < RestObject # :nodoc:
   end
 
   def self.get_type_definition(workspace, type)
-    mangle_type_definitions(workspace.type_definitions)
-    typedef = workspace.type_definitions[type]
+    typedef = workspace.type_definitions.find { |td| td.element_name == type }
     TypeDefinition.new(typedef.rally_rest, typedef.body)
   end
 
-  # This is a hack
-  # Strip spaces from the name, and put the values back in to the hash
-  def self.mangle_type_definitions(type_definitions)
-    type_definitions.each do |key, value|
-      type_definitions[key.gsub(" ", "")] = value if key.include? " "
-    end
-  end
-
   def self.make_key(workspace, type)
     # Parent typedefs don't have a workspace, so key them appropriately
     ref = workspace.ref rescue ""
@@ -101,5 +92,10 @@ class TypeDefinition < RestObject # :nodoc:
     end
     typedef
   end
+
+  protected
+  def parse_collections_as_hash?
+    true
+  end
   
 end

data/lib/rally_rest_api/version.rb

@@ -2,7 +2,7 @@ module RallyRestVersion #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 6
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/attribute_definition_spec.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'spec'
 require 'builder'
 require 'ostruct'
+require 'logger'
 require 'rally_rest_api'
 
 
@@ -28,7 +29,7 @@ context "An attribute definition for a custom dropdown" do
 	}
       }
     }
-    fake_rally_rest = OpenStruct.new(:username => "", :password => "")
+    fake_rally_rest = OpenStruct.new(:username => "", :password => "", :logger => nil)
     @attrdef = AttributeDefinition.new(fake_rally_rest, RestObject.new(fake_rally_rest, xml).elements)    
   end
 
@@ -51,4 +52,9 @@ context "An attribute definition for a custom dropdown" do
   specify "allowed_values should match" do
     @attrdef.allowed_values.should == [nil, "Actor"]
   end
+
+  specify "should have 'AttributeDefinition' as the type" do
+    @attrdef.type.should == "AttributeDefinition"
+  end
+
 end

data/test/query_result_spec.rb

@@ -10,6 +10,8 @@ context "A QueryResult" do
     @api = mock("RallyRestAPI")
     @api.stub! :username
     @api.stub! :password
+    @api.stub!(:logger).and_return(nil)
+    @api.stub!(:parse_collections_as_hash?).and_return true
   end
 
   def make_result(total, page_size, start_index)
@@ -66,6 +68,17 @@ context "A QueryResult" do
     start.should_be 0
   end
 
+  specify "a page of results should match the page size" do
+    make_result(20, 20, 1).results.length.should_be 20
+  end
+
+  specify "results should be in the same order as returned" do
+    result = make_result(20, 20, 1)
+    result.results.length.should_be 20
+    result.results[0].name.should == "name0"
+    result.results[19].name.should == "name19"
+  end
+
 end
 
 context "A QueryResult with 2 pages" do

data/test/spec_typedef.rb

@@ -1,6 +1,6 @@
-require 'rubygems'
 require 'spec'
 require 'ostruct'
+require 'logger'
 require 'rally_rest_api'
 
 
@@ -33,7 +33,7 @@ context "A Test Case type definition with 2 collection attribues, 1 object attri
 	end
       }
     }
-    @typedef = TypeDefinition.new(OpenStruct.new(:username => "", :password => ""), xml)
+    @typedef = TypeDefinition.new(OpenStruct.new(:username => "", :password => "", :logger => nil), xml)
   end
 
   specify "all attribute keys are symbols" do
@@ -69,8 +69,8 @@ context "A Test Case type definition with 2 collection attribues, 1 object attri
   end
 
   specify "should have 1 custom_constrained_attributes" do
-    @typedef.custom_constrained_attributes.size.should == 1
-    @typedef.custom_dropdown_attributes.size.should == 1
+    @typedef.custom_constrained_attributes.size.should_be 1
+    @typedef.custom_dropdown_attributes.size.should_be 1
   end
 
   specify "#attributes should return instances of AttributeDefinitions" do

data/test/tc_rest_api.rb

@@ -48,20 +48,20 @@ class RestApiTestCase < Test::Unit::TestCase
   # test that types and keys are camel cased (at least with one underscore)
   def test_camel_case
     xml = "#{preamble}<UseCase><NameName>name</NameName></UseCase>"
-    @api.use_case(:name_name => "name")
+    @api.create(:use_case, :name_name => "name")
     assert_equal(xml, @xml)
   end
 
   def test_nil_value
     xml = %Q(#{preamble}<UseCase><Name ref="null"/></UseCase>)
-    @api.use_case(:name => nil)
+    @api.create(:use_case, :name => nil)
     assert_equal(xml, @xml)
   end
 
   def test_time_value
     time = Time.now
     xml = "#{preamble}<UseCase><Time>#{time.iso8601}</Time></UseCase>"
-    @api.use_case(:time => time)
+    @api.create(:use_case, :time => time)
     assert_equal(xml, @xml)
   end
 
@@ -71,7 +71,7 @@ class RestApiTestCase < Test::Unit::TestCase
     rest_object = RestObject.new(@api, rest_object_xml)
 
     xml = %Q(#{preamble}<Feature><UseCase ref="url"/></Feature>)
-    @api.feature(:use_case => rest_object)
+    @api.create(:feature, :use_case => rest_object)
     assert_equal(xml, @xml)
   end
 
@@ -81,7 +81,7 @@ class RestApiTestCase < Test::Unit::TestCase
     uc1 = RestObject.new(@api, rest_object_xml)
 
     xml = %Q(#{preamble}<Feature><Dependents><UseCase ref="url"/></Dependents></Feature>)
-    @api.feature(:dependents => uc1)
+    @api.create(:feature, :dependents => uc1)
     assert_equal(xml, @xml)
   end
 
@@ -92,7 +92,7 @@ class RestApiTestCase < Test::Unit::TestCase
     uc2 = RestObject.new(@api, rest_object_xml)
 
     xml = %Q(#{preamble}<Feature><Dependents><UseCase ref="url"/><UseCase ref="url"/></Dependents></Feature>)
-    @api.feature(:dependents => [uc1, uc2])
+    @api.create(:feature, :dependents => [uc1, uc2])
     assert_equal(xml, @xml)
   end
 

data/test/tc_rest_object.rb

@@ -1,6 +1,7 @@
 
 require 'test/unit'
 require 'test/unit/testcase'
+require 'logger'
 
 require 'rubygems'
 require 'rally_rest_api'
@@ -68,13 +69,13 @@ class RestObjectTestCase < Test::Unit::TestCase
   end
   
   def test_equal_same_instance
-    xml = %Q(<Object><TextNode>text</TextNode></Object>)
+    xml = %Q(<Object ref="http"><TextNode>text</TextNode></Object>)
     r1 = r2 = rest_object(xml)
     assert(r1 == r2)
   end
 
   def test_equal_with_nil
-    xml = %Q(<Object><TextNode>text</TextNode></Object>)
+    xml = %Q(<Object ref="http"><TextNode>text</TextNode></Object>)
     r1 = rest_object(xml)
     assert(r1 != nil)
   end
@@ -87,23 +88,23 @@ class RestObjectTestCase < Test::Unit::TestCase
 
 
   def test_basic_text_node
-    xml = %Q(<Object><TextNode>text</TextNode></Object>)
+    xml = %Q(<Object ref="bla"><TextNode>text</TextNode></Object>)
     assert_equal("text", rest_object(xml).text_node)
   end
 
   def test_nested_text_node
-    xml = %Q(<Object><Nested><TextNode>text</TextNode></Nested></Object>)
+    xml = %Q(<Object ref="bla"><Nested ref="bla/nested"><TextNode>text</TextNode></Nested></Object>)
     assert_equal("text", rest_object(xml).nested.text_node)
   end
   
   # make sure RestObject are being created
   def test_ref_node
-    xml = %Q(<Object><Top><RefElement ref="http" refObjectName="name1"/></Top></Object>)
-    assert_equal(RestObject, rest_object(xml).top['name1'].class)
+    xml = %Q(<Object ref="http"><RefElement ref="http" refObjectName="name1"/></Object>)
+    assert_equal(RestObject, rest_object(xml).class)
   end
 
   def test_ref_node_reading
-    xml = %Q(<Object><Top><RefElement ref="http" refObjectName="name1"/></Top></Object>)
+    xml = %Q(<Object ref="bla"><Top ref="blabla"><RefElement ref="http" refObjectName="name1"/></Top></Object>)
     # This will be the xml returned from read_rest
     class << self
       def read_xml
@@ -111,11 +112,11 @@ class RestObjectTestCase < Test::Unit::TestCase
       end
     end
 
-    assert_equal("foo", rest_object(xml).top['name1'].foo)
+    assert_equal("foo", rest_object(xml).top.ref_element.foo)
   end
 
   def test_ref_node_collection_reading
-    xml = %Q(<Object><Top><RefElements><RefElement ref="http1" refObjectName="name1"/><RefElement ref="http2" refObjectName="name2"/></RefElements></Top></Object>)
+    xml = %Q(<Object ref="bla"><Top ref="bla"><RefElements><RefElement ref="http1" refObjectName="name1"/><RefElement ref="http2" refObjectName="name2"/></RefElements></Top></Object>)
     # This will be the xml returned from read_rest
     class << self
       def read_xml
@@ -124,7 +125,7 @@ class RestObjectTestCase < Test::Unit::TestCase
     end
 
     assert_equal(2, rest_object(xml).top.ref_elements.length)
-    ref_element = rest_object(xml).top.ref_elements["name1"]
+    ref_element = rest_object(xml).top.ref_elements[0]
 
     assert_equal("http1", ref_element.ref)
     assert_equal("Desc", ref_element.description) # Force a read
@@ -132,7 +133,7 @@ class RestObjectTestCase < Test::Unit::TestCase
   end
 
   def test_ref_collection_with_dups_is_array
-    xml = %Q(<Object><Top><RefElements><RefElement ref="http1" refObjectName="name1"/><RefElement ref="http2" refObjectName="name2"/><RefElement ref="http3" refObjectName="name2"/><RefElement ref="http3" refObjectName="name2"/></RefElements></Top></Object>)
+    xml = %Q(<Object ref="bla"><Top ref="bla"><RefElements><RefElement ref="http1" refObjectName="name1"/><RefElement ref="http2" refObjectName="name2"/><RefElement ref="http3" refObjectName="name2"/><RefElement ref="http3" refObjectName="name2"/></RefElements></Top></Object>)
     # This will be the xml returned from read_rest
     class << self
       def read_xml
@@ -140,24 +141,22 @@ class RestObjectTestCase < Test::Unit::TestCase
       end
     end
 
-    assert_equal(2, rest_object(xml).top.ref_elements.length)
-    assert_equal(Array, rest_object(xml).top.ref_elements["name2"].class)
-    assert_equal(3, rest_object(xml).top.ref_elements["name2"].length)
+    assert_equal(4, rest_object(xml).top.ref_elements.length)
   end
 
   def test_named_collection_reading
-    xml = %Q(<Object><Top><NamedElements><NamedElement ref="http1" refObjectName="name1"><Name>name1</Name></NamedElement><NamedElement ref="http2" refObjectName="name2"><Name>name2</Name></NamedElement></NamedElements></Top></Object>)
+    xml = %Q(<Object ref="bla"><Top ref="bla"><NamedElements><NamedElement ref="http1" refObjectName="name1"><Name>name1</Name></NamedElement><NamedElement ref="http2" refObjectName="name2"><Name>name2</Name></NamedElement></NamedElements></Top></Object>)
 
     assert_equal(2, rest_object(xml).top.named_elements.length)
-    named_element1 = rest_object(xml).top.named_elements["name1"]
+    named_element1 = rest_object(xml).top.named_elements[0]
     assert_equal("name1", named_element1.name)
 
-    named_element2 = rest_object(xml).top.named_elements["name2"]
+    named_element2 = rest_object(xml).top.named_elements[1]
     assert_equal("name2", named_element2.name)
   end
 
   def test_unnamed_collection_reading
-    xml = %Q(<Object><Top><NamedElements><NamedElement ref="http1"><Name>name1</Name></NamedElement><NamedElement ref="http2"><Name>name2</Name></NamedElement></NamedElements></Top></Object>)
+    xml = %Q(<Object ref="bla"><Top ref="bla"><NamedElements><NamedElement ref="http1"><Name>name1</Name></NamedElement><NamedElement ref="http2"><Name>name2</Name></NamedElement></NamedElements></Top></Object>)
 
     assert_equal(2, rest_object(xml).top.named_elements.length)
     assert_equal("name1", rest_object(xml).top.named_elements[0].name)

data/test/tc_rest_query.rb

@@ -20,6 +20,10 @@ class TestRestQuery < Test::Unit::TestCase
   def test_name_with_spaces
     assert_equal("(Name = \"name name\")", RestQuery.query { equal :name, "name name"} )
   end
+
+  def test_null_parameter
+    assert_equal("(Name = null)", RestQuery.query { equal :name, nil} )
+  end
   
   def test_attribute_camelized
     assert_equal("(IterationName != iteration)", 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rally_rest_api
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
-date: 2006-12-18 00:00:00 -07:00
+  version: 0.6.3
+date: 2007-01-03 00:00:00 -07:00
 summary: A ruby-ized interface to Rally's REST webservices API
 require_paths: 
 - lib