rally_rest_api 0.6.13 → 0.7.0

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/rally_rest_api/rest_builder.rb
 lib/rally_rest_api/timeout_catching_rest_builder.rb
 lib/rally_rest_api/rest_object.rb
 lib/rally_rest_api/typedef.rb
+lib/rally_rest_api/ruport.rb
 lib/rally_rest_api/version.rb
 Manifest.txt
 Rakefile
@@ -23,5 +24,3 @@ test/rest_object_spec.rb
 test/tc_rest_query.rb
 test/test_helper.rb
 test/rest_builder_spec.rb
-lib/rally_rest_api/timeout_catching_rest_builder.rb
-

data/README.txt

@@ -1,7 +1,7 @@
 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.
+Rally Software Development's on-demand agile software life-cycle management service 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 a rich interface to the query facility. An Enumerable interface is provided for the paginated query results.
 
@@ -16,13 +16,20 @@ RallyRestAPI is the entry point to the api. Each instance corresponds to one use
     :password         => Your Rally login password. Username and password will be remembered by this 
                          instance of the API and all objects created and read by this instance.
     :base_url         => The base url for the system you are talking to. Defaults to https://rally1.rallydev.com/slm/
-    :raise_on_warning => true|false or the exception class you would like raised. If true, RuntimeError will be raised.
     :logger           => A logger to log to. There is interesting logging info for DEBUG and INFO
+    :builder	      => A builder is the Class responsible for the HTTP level protocol. Defaults to RestBuilder
+    :version	      => The version of the API you want to talk to. Defaults to "current"
 
 == Rest Object:
-All rally resources referenced by the api are of type RestObject, there are no subclasses. In its initial form a RestObject is just a URL representing a resource. This URL is accessed using RestObject#ref. When more information is requested about the object, the API will read the content of that resource. This read is done lazily and transparently.
+All rally resources referenced by the api are of type RestObject, there only a few subclasses. In its initial form a RestObject is just a URL representing a resource. This URL is accessed using RestObject#ref. When more information is requested about the object, the API will read the content of that resource. This read is done lazily and transparently.
 
-Objects can reference other objects in Rally. When establishing these relationships using this API, they are done using RestObjects. For example, to associate a user story to a defect, you would use the 'requirement' association on defect to reference the User Story. Here 'defect' and 'user_story' already exist, and the variables contain RestObjects representing them:
+RestObject makes heavy use of method_missing to achieve its dynamism. The XML for each resource is parsed into a nested Hash where the keys of the Hash are the Ruby-ized Elements names of the XML, and the values of the hash are the string values of the elements, or other RestObjects (in the case of references between objects), or collections of both. This allows the API to respond to chained method invocations like:
+
+  rally.user.subscription.workspaces.first.projects.first.iterations.first.name
+
+Traversals across object references (RestObjects) cause a lazy read of that resource.
+
+When establishing object relationships between objects, during create or update, they are done using RestObjects. For example, to associate a user story to a defect, you would use the 'requirement' association on defect to reference the User Story. Here 'defect' and 'user_story' already exist, and the variables contain RestObjects representing them:
 
   defect.update(:requirement => user_story)
 
@@ -92,10 +99,15 @@ RallyRestAPI#find is the interface to the query syntax of Rally's webservice API
 In addition to the type, #find accepts other arguments as a hash:
 
   :pagesize => <number> - The number of results per page. Max of 100
-  :start => <number> - The record number to start with. Assuming more then page size records.
-  :fetch => <boolean> - If this is set to true then entire objects will be returned inside the query result. If set to false (the default) then only object references will be returned.
-  :workspace - If not present, then the query will run in the user's default workspace. If present, this should be the RestObject containing the workspace the user wants to search in.
-  :project - If not set, or specified as "null" then the "parent project" in the given workspace is used. If set, this should be the RestObject containing the project. Furthermore, if set you may omit the workspace parameter because the workspace will be inherited from the project.
+  :start => <number> - The record number to start with. Assuming more than page size records.
+  :fetch => <boolean> - If this is set to true then entire objects will be returned inside the query 
+   result. If set to false (the default) then only object references will be returned. Fetching full 
+   objects will prevent another read when utilizing the results.
+  :workspace - If not present, then the query will run in the user's default workspace. If present, 
+   this should be the RestObject containing the workspace the user wants to search in.
+  :project - If not set, or specified as "null" then the "parent project" in the given workspace is used. 
+   If set, this should be the RestObject containing the project. Furthermore, if set you may omit the workspace 
+   parameter because the workspace will be inherited from the project.
   :project_scope_up - Default is true. In addition to the specified project, include projects above the specified one.
   :project_scope_down - Default is true. In addition to the specified project, include child projects below the current one.
 
@@ -108,4 +120,12 @@ The return from #find is always a QueryResult. The QueryResult provides an inter
 
 Because of the paginated nature of the result list, deleting elements while using #each is undefined.
 
+If you have Ruport installed (http://www.rubyreports.org), QueryResult will have a #to_table method included. #to_table takes an array of symbols that define the columns in the table:
+
+  defects = rally.find(:defect, :fetch => true) { equal :state, "Open }
+  table = defects.to_table([:name, :severity, :priority, :owner])
+  table.to_pdf
+
+See rubyreports.org for more information about creating reports with Ruport.
+
 See the rdoc for RestQuery for more query examples.

data/lib/rally_rest_api.rb

@@ -1 +1,7 @@
-Dir[File.join(File.dirname(__FILE__), 'rally_rest_api/**/*.rb')].sort.each { |lib| require lib }
+Dir[File.join(File.dirname(__FILE__), 'rally_rest_api/**/*.rb')].sort.each { |lib| require lib }
+begin
+  require 'rubygems'
+  require 'ruport'
+  require 'rally_rest_api/ruport'
+rescue LoadError
+end

data/lib/rally_rest_api/query.rb

@@ -8,27 +8,27 @@ class String # :nodoc: all
   alias :to_q :to_s
 end
 
-class Fixnum
+class Fixnum # :nodoc: all
   alias :to_q :to_s
 end
 
 class Symbol # :nodoc: all
-    def to_q
-      self.to_s.to_camel
-    end
+  def to_q
+    self.to_s.to_camel
+  end
 end
 
-class NilClass
+class NilClass # :nodoc: all
   def to_q
     "null"
   end
 end
 
-class TrueClass
+class TrueClass # :nodoc: all
   alias :to_q :to_s
 end
 
-class FalseClass
+class FalseClass # :nodoc: all
   alias :to_q :to_s
 end
 
@@ -81,6 +81,8 @@ end
 # \_or_ works in the same fashion. _and_s and _or_s may be nested as needed. See the test cases for RestQuery for
 # more complex examples
 #
+# If you have ruport installed, you may also call to_table on a QueryResult to convert the result to a Ruport::Data:Table
+#
 class RestQuery
   attr_reader :type
 

data/lib/rally_rest_api/query_result.rb

@@ -4,7 +4,7 @@ require File.dirname(__FILE__) + '/rest_object'
 #
 # QueryResult is a wrapper around the xml returned from a webservice
 # query operation. A query could result in a large number of hits
-# being returned, therefore the query result is paged into page_size
+# being returned, therefore the results are paged into page_size
 # chunks (20 by default). QueryResult will seamlessly deal with the
 # paging when using the #each iterator.
 #
@@ -76,7 +76,7 @@ class QueryResult < RestObject
   end
 
    protected
-   def parse_collections_as_hash?
+   def parse_collections_as_hash? # :nodoc:
      false
    end
 
@@ -85,7 +85,7 @@ class QueryResult < RestObject
       !element.attributes["ref"].nil?
   end
 
-  def terminal?(node)
+  def terminal?(node) # :nodoc:
     !node.has_elements? || ref?(node)
   end
 

data/lib/rally_rest_api/rally_rest.rb

@@ -8,7 +8,7 @@ require 'ostruct'
 #
 class RallyRestAPI
  
-  attr_reader :username, :password, :base_url, :raise_on_warning, :logger, :builder
+  attr_reader :username, :password, :base_url, :logger, :builder
   attr_accessor :parse_collections_as_hash
 
   ALLOWED_TYPES = %w[subscription workspace project iteration release defect defect_suite test_case
@@ -21,7 +21,8 @@ class RallyRestAPI
   # * username  - The Rally username
   # * password  - The password for the named user
   # * base_url  - The base url of the system. Defaults to https://rally1.rallydev.com/slm
-  # * raise_on_warn - true|false|Exception Class. If you want exceptions raised on warnings. Default is false. if 'true' RuntimeException will be raised. If ExceptionClass, then an instance of that will be raised.
+  # * version   - The RallyWebservices Version. Defaults to 'current', which will always be the most
+  #               recent version of the api. Pass the value as a String, "1.0", "1.01" for example.
   # * logger    - a Logger to log to.
   #
   def initialize(options = {})
@@ -32,30 +33,34 @@ class RallyRestAPI
     @username = options[:username]
     @password = options[:password]
     @base_url = options[:base_url] || "https://rally1.rallydev.com/slm"
-    @raise_on_warning = options[:raise_on_warning]
+    @version = options[:version] || "current"
     @logger = options[:logger]
     @parse_collections_as_hash = options[:parse_collections_as_hash] || false
 
     if options[:builder]
       builder = options[:builder]
     else
-      builder = RestBuilder.new(@base_url, @username, @password)
+      builder = RestBuilder.new(@base_url, @username, @password, @version)
     end
     builder.logger = @logger if @logger
     @builder = builder
   end
 
+  def marshal_dump
+    [@username, @password, @base_url, @version, @builder, @parse_collections_as_hash]
+  end
+
+  def marshal_load(stuff)
+    @username, @password, @base_url, @version, @builder, @parse_collections_as_hash = *stuff
+  end
+
+
   # return an instance of User, for the currently logged in user. 
   def user
-    RestObject.new(self, builder.read_rest("#{@base_url}/webservice/1.0/user", @username, @password))
+    RestObject.new(self, builder.read_rest("#{@base_url}/webservice/#{@version}/user", @username, @password))
   end
   alias :start :user # :nodoc:
 
-  # This is deprecated, use create instead
-  def method_missing(type, args, &block) # :nodoc:
-    raise "'#{type}' is not a supported method. Use create() instead"
-  end
-
   # Create an object.
   #  type   - The type to create, as a symbol (e.g. :test_case)
   #  values - The attributes of the new object.
@@ -82,7 +87,7 @@ class RallyRestAPI
     query(query)
   end
 
-  # find all object of a given type. Base types work also (.e.g :artifact)
+  # find all object of a given type. Base types work also (e.g. :artifact)
   def find_all(type, args = {})
     find(type, args) { gt :object_i_d, "0" }
   end
@@ -98,12 +103,12 @@ class RallyRestAPI
   end
   
   def query(query) # :nodoc:
-    query_url = "#{@base_url}/webservice/1.0/#{query.type.to_s.to_camel}?" << query.to_q
+    query_url = "#{@base_url}/webservice/#{@version}/#{query.type.to_s.to_camel}?" << query.to_q
     xml = builder.read_rest(query_url, @username, @password)
     QueryResult.new(query, self, xml)
   end
 
-  # Should rest_objects parse into hashes
+  # Should rest_objects collection parse into hashes
   def parse_collections_as_hash?
     @parse_collections_as_hash
   end

data/lib/rally_rest_api/rest_builder.rb

@@ -9,8 +9,16 @@ class RestBuilder # :nodoc:
   attr_reader :base_url, :username, :password
   attr_accessor :logger
 
-  def initialize(base_url, username, password)
-    @base_url, @username, @password = base_url, username, password
+  def initialize(base_url, username, password, version = "current")
+    @base_url, @username, @password, @version = base_url, username, password, version
+  end
+
+  def marshal_dump
+    [@username, @password, @base_url, @version]
+  end
+
+  def marshal_load(stuff)
+    @username, @password, @base_url, @version = *stuff
   end
 
   # create_rest - convert slm builder style:
@@ -27,7 +35,7 @@ class RestBuilder # :nodoc:
     b = create_builder
     xml = b.__send__(type, &builder_block(args))
 
-    result = post_xml("#{self.base_url}/webservice/1.0/#{type}/create", xml, username, password)
+    result = post_xml("#{self.base_url}/webservice/#{@version}/#{type}/create", xml, username, password)
     doc = REXML::Document.new result
     doc.root.elements["Object"].to_s
   end
@@ -99,12 +107,6 @@ class RestBuilder # :nodoc:
     sym.to_s.split("_").map { |word| word.capitalize }.join
   end
   
-#  def cameler(sym)
-#    cam = camel_case_word(sym).split("").to_a
-#    cam[0] = (cam.first.downcase)
-#    cam.to_s
-#  end
-
   # Because we are adapting to the xml builder as such:
   #  We say to the RallyRestAPI:
   #    slm.create(:feature, :name => "feature name")
@@ -163,6 +165,7 @@ class RestBuilder # :nodoc:
     end
   end
 
+
   # Convert the values of the hash passed to the RestApi appropiatly
   # RestObject --> a hash with the ref value
   # nil --> "null" ref values

data/lib/rally_rest_api/rest_object.rb

@@ -18,6 +18,13 @@ require 'builder/blankslate'
 # will be carried out as the same user as their RallyRestAPI.
 #
 #
+
+class FancyHash < Hash # :nodoc: all
+  def method_missing(sym, *args)
+    self[sym]
+  end
+end
+
 class RestObject
 
   attr_reader :username, :password, :rally_rest
@@ -26,6 +33,10 @@ class RestObject
     @rally_rest = rally_rest
     @document_content = document_content
     @username, @password = @rally_rest.username, @rally_rest.password
+    parse_document
+  end
+
+  def parse_document
     @document = REXML::Document.new @document_content
     if !ref?(@document.root)
       @elements = parse(@document.root)
@@ -34,6 +45,15 @@ class RestObject
     end
   end
 
+  def marshal_dump
+    [@rally_rest, @document_content, @username, @password]  
+  end
+
+  def marshal_load(stuff)
+    @rally_rest, @document_content, @username, @password = *stuff
+    parse_document
+  end
+
   private
   def terminal?(node)
     !node.has_elements?
@@ -57,13 +77,7 @@ class RestObject
     end
 
     # Convert nodes with children into Hashes
-    elements = {}
-    class << elements
-      def method_missing(sym, *args)
-	value = self[sym]
-	value
-      end
-    end
+    elements = FancyHash.new
 
     #Add all the element's children to the hash.
     node.each_element do |e|
@@ -141,9 +155,10 @@ class RestObject
   alias :to_q :ref
 
   # The name of the object, without having to read the entire body
-   def name
-     @document.root.attributes["refObjectName"]
-   end
+  def name
+    @document.root.attributes["refObjectName"]
+  end
+  alias :to_s :name
 
   # The type of the underlying resource
   def type
@@ -202,7 +217,6 @@ class RestObject
   # update the resource. This will re-read the resource after the update
   def update(args)
     builder.update_rest(self.type, self.ref, args, @username, @password)
-    # need to deal with the block, setting up contexts etc
     self.elements(true)
   end
 
@@ -212,9 +226,10 @@ class RestObject
   end
 
   def method_missing(sym, *args) # :nodoc:
-    value = self.elements[sym]
-#    raise "No matching element named #{sym}. Known values are #{self.elements.keys.join(' ')}." unless self.elements.has_key? sym
-    value
+    self.elements[sym]
+    # Sometimes the xml returned has no element for things that are simply null. Without
+    # asking the typedef, I have no way to know if the element exists, or has been ommited.
+    # It would not be hard to ask the typedef, but they are expensive to load. It should be an option
   end
 
 

data/lib/rally_rest_api/ruport.rb

@@ -0,0 +1,30 @@
+# Add Ruport (http://rubyreports.org/) support to the RallyRestAPI.
+# This will add a method, #to_table, to QueryResult
+#
+# For example:
+#  table = rally_api.find(:defect) { equal :state, "Open" }.to_table([:formatted_i_d, :name, :owner])
+#  table.to_pdf
+#
+begin
+  require 'rubygems'
+  require 'ruport'
+rescue LoadError ; raise "You must 'gem install ruport' to use rally_rest_api/ruport" ; end
+
+# Ruport can deal with anything that has a #to_hash
+class RestObject
+  def to_hash # :nodoc
+    elements
+  end
+end
+
+class QueryResult
+  # return a Ruport::Data::Table. Takes an array of columns for the report
+  #    defects = rally.find(:defect, :fetch => true) { equal :state, "Open }
+  #    table = defects.to_table([:name, :severity, :priority, :owner])
+  #    table.to_pdf
+  def to_table(columns = [])
+    table = Ruport::Data::Table.new(:column_names => columns)
+    self.each { |i| table << i }
+    table
+  end
+end

data/lib/rally_rest_api/timeout_catching_rest_builder.rb

@@ -1,5 +1,4 @@
-
-class TimeoutCatchingRestBuilder < RestBuilder
+class TimeoutCatchingRestBuilder < RestBuilder # :nodoc all
   def send_request(url, req, username, password)
     begin
       super

data/lib/rally_rest_api/typedef.rb

@@ -15,14 +15,17 @@ class TypeDefinition < RestObject # :nodoc:
   end
 
   def self.get_type_definition(workspace, type)
+    get_type_definitions(workspace).find { |td| td.element_name == type }
+  end
+
+  def self.get_type_definitions(workspace)
     # This is a hack - having to do with parse_collections_as_hash?
     typedefs = case workspace.type_definitions
-    	         when Hash : workspace.type_definitions.values.flatten
-	         when Array : workspace.type_definitions
+               when Hash : workspace.type_definitions.values.flatten
+               when Array : workspace.type_definitions
 	       end
-    typedef = typedefs.find { |td| td.element_name == type }
-    # end hack
-    TypeDefinition.new(typedef.rally_rest, typedef.body)
+    # end hack  
+    typedefs.map { |td| TypeDefinition.new(td.rally_rest, td.body) }
   end
 
   def self.make_key(workspace, type)
@@ -97,6 +100,10 @@ class TypeDefinition < RestObject # :nodoc:
     typedef
   end
 
+  def type_as_symbol
+    underscore(element_name).intern
+  end
+
   protected
   def parse_collections_as_hash?
     true

data/lib/rally_rest_api/version.rb

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

data/test/attribute_definition_spec.rb

@@ -6,9 +6,9 @@ require 'logger'
 require 'rally_rest_api'
 
 
-context "An attribute definition for a custom dropdown" do
+describe "An attribute definition for a custom dropdown" do
 
-  setup do
+  before(:each) do
     @b = Builder::XmlMarkup.new(:indent => 2)
     @b.instruct!
     
@@ -33,27 +33,27 @@ context "An attribute definition for a custom dropdown" do
     @attrdef = AttributeDefinition.new(fake_rally_rest, RestObject.new(fake_rally_rest, xml).elements)    
   end
 
-  specify "should have 'Custom Dropdown' as the name" do
+  it "should have 'Custom Dropdown' as the name" do
     @attrdef.name.should == "Custom Dropdown"
   end
 
-  specify "should return an arry of allowed values" do
-    @attrdef.allowed_values.should_be_instance_of Array
+  it "should return an arry of allowed values" do
+    @attrdef.allowed_values.should be_instance_of(Array)
   end
-
-  specify "should have 2 allowd values" do
+ 
+  it "should have 2 allowd values" do
     @attrdef.allowed_values.length.should == 2
   end
 
-  specify "should not return an array of hashes" do
-    @attrdef.allowed_values.each { |value| value.should_not_be_instance_of Hash }
+  it "should not return an array of hashes" do
+    @attrdef.allowed_values.each { |value| value.should_not be_instance_of(Hash) }
   end
   
-  specify "allowed_values should match" do
+  it "allowed_values should match" do
     @attrdef.allowed_values.should == [nil, "Actor"]
   end
 
-  specify "should have 'AttributeDefinition' as the type" do
+  it "should have 'AttributeDefinition' as the type" do
     @attrdef.type.should == "AttributeDefinition"
   end
 

data/test/query_result_spec.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
 
-context "A QueryResult" do
+describe "A QueryResult" do
 
-  setup do
+  before(:each) do
     @api = RallyRestAPI.new(:parse_collections_as_hash => true)
   end
 
@@ -27,59 +27,59 @@ context "A QueryResult" do
     QueryResult.new(nil, @api, xml)
   end
 
-  specify "should have the total result count" do
-    make_result(20, 20, 1).total_result_count.should_be 20
+  it "should have the total result count" do
+    make_result(20, 20, 1).total_result_count.should equal(20)
   end
 
-  specify "should have the page size" do
-    make_result(20, 20, 1).page_size.should_be 20
+  it "should have the page size" do
+    make_result(20, 20, 1).page_size.should equal(20)
   end
 
-  specify "should have the start_index" do
-    make_result(20, 20, 1).start_index.should_be 1
+  it "should have the start_index" do
+    make_result(20, 20, 1).start_index.should equal(1)
   end
 
-  specify "should have no more pages when no results are returned" do
-    make_result(0, 20, 0).more_pages?.should_be false
+  it "should have no more pages when no results are returned" do
+    make_result(0, 20, 0).more_pages?.should equal(false)
   end
 
-  specify "should have not more pages when the total result count is less then the page size" do
-    make_result(1, 20, 1).more_pages?.should_be false
-    make_result(19, 20, 1).more_pages?.should_be false
-    make_result(20, 20, 1).more_pages?.should_be false
+  it "should have not more pages when the total result count is less then the page size" do
+    make_result(1, 20, 1).more_pages?.should equal(false)
+    make_result(19, 20, 1).more_pages?.should equal(false)
+    make_result(20, 20, 1).more_pages?.should equal(false)
   end
 
-  specify "should have more pages when total result count is more then the page size" do
-    make_result(21, 20, 1).more_pages?.should_be true
-    make_result(39, 20, 1).more_pages?.should_be true
+  it "should have more pages when total result count is more then the page size" do
+    make_result(21, 20, 1).more_pages?.should equal(true)
+    make_result(39, 20, 1).more_pages?.should equal(true)
   end
 
-  specify "an empty query should not iteratate on each" do
+  it "an empty query should not iteratate on each" do
     start = 0
     make_result(0, 20, 0).each { start += 1 }
-    start.should_be 0
+    start.should equal(0)
   end
 
-  specify "a page of results should match the page size" do
-    make_result(20, 20, 1).results.length.should_be 20
+  it "a page of results should match the page size" do
+    make_result(20, 20, 1).results.length.should equal(20)
   end
 
-  specify "results should be in the same order as returned" do
+  it "results should be in the same order as returned" do
     result = make_result(20, 20, 1)
-    result.results.length.should_be 20
+    result.results.length.should equal(20)
     result.results[0].name.should == "name0"
     result.results[19].name.should == "name19"
   end
 
-  specify "should return RestObjects for results" do
-    make_result.each { |o| o.should_be_instance_of RestObject }
+  it "should return RestObjects for results" do
+    make_result.each { |o| o.should be_instance_of(RestObject) }
   end
 end
 
 
-context "A QueryResult with full objects" do
+describe "A QueryResult with full objects" do
 
-  setup do
+  before(:each) do
     @api = RallyRestAPI.new(:parse_collections_as_hash => true)
   end
 
@@ -116,11 +116,11 @@ context "A QueryResult with full objects" do
     yield Builder::XmlMarkup.new(:indent => 2)
   end
 
-  specify "should return RestObjects for results" do
-    make_result.each { |o| o.should_be_instance_of RestObject }
+  it "should return RestObjects for results" do
+    make_result.each { |o| o.should be_instance_of(RestObject) }
   end
 
-  specify "full object collections should lazy load only once" do
+  it "full object collections should lazy load only once" do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
@@ -156,8 +156,8 @@ context "A QueryResult with full objects" do
       }
     end
 
-    object.total_result_count.should_be 2
-    object.results.should_be_instance_of Array
+    object.total_result_count.should equal(2)
+    object.results.should be_instance_of(Array)
     object.each_with_index do |c, i| 
       c.name.should == "Card#{i + 1}"
       c.description.should == "Description#{i + 1}"

data/test/rest_builder_spec.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-context "a RestBuilder " do
+describe "a RestBuilder " do
 
   def xml
     b = Builder::XmlMarkup.new
@@ -8,13 +8,13 @@ context "a RestBuilder " do
     yield b
   end
 
-  setup do
+  before(:each) do
     @username = "username"
     @password = "password"
     @builder = RestBuilder.new(nil, @username, @password)
   end
   
-  specify "should produce correct xml for flat xml" do
+  it "should produce correct xml for flat xml" do
     expected_xml = xml do |b|
       b.defect(:ref => "url") {
 	b.Name "foo"
@@ -24,7 +24,7 @@ context "a RestBuilder " do
     @builder.update_rest(:defect, "url", {:name => "foo"}, @username, @password)
   end
   
-  specify "should produce correct xml for nested values" do
+  it "should produce correct xml for nested values" do
     expected_xml = xml do |b|
       b.defect(:ref => "url") {
 	b.Name "foo"

data/test/rest_object_spec.rb

@@ -1,9 +1,9 @@
 
 require 'test_helper'
 
-context "a RestObject" do
+describe RestObject do
 
-  setup do
+  before(:each) do
     @api = RallyRestAPI.new
   end
 
@@ -23,14 +23,14 @@ context "a RestObject" do
     yield Builder::XmlMarkup.new(:indent => 2)
   end
 
-  specify "should return the type of the resource from a ref" do
+  it "should return the type of the resource from a ref" do
     o = rest_object_xml do |b|
       b.Object(:refObjectName => "name", :ref => "ref", :type => "Defect")
     end
     o.type.should == "Defect"
   end
 
-  specify "should return the type of the resource from full object" do
+  it "should return the type of the resource from full object" do
     o = rest_object_xml do |b|
       b.Defect(:refObjectName => "name", :ref => "ref") {
 	b.Name("name")
@@ -39,7 +39,7 @@ context "a RestObject" do
     o.type.should == "Defect"
   end
 
-  specify "should return the ref of the resource " do
+  it "should return the ref of the resource " do
     o = rest_object_xml do |b|
       b.Defect(:refObjectName => "name", :ref => "ref") {
 	b.Name("name")
@@ -48,7 +48,7 @@ context "a RestObject" do
     o.ref.should == "ref"
   end
 
-  specify "should return the oid" do
+  it "should return the oid" do
     o = rest_object_xml do |b|
       b.Defect(:refObjectName => "name", :ref => "ref") {
 	b.Name("name")
@@ -58,31 +58,31 @@ context "a RestObject" do
     o.oid.should == "12345"
   end
 
-  specify "should underscore element names" do
+  it "should underscore element names" do
     o = rest_object(%Q(<Object ref="bla">
                               <TextNode>text</TextNode>
                             </Object>))
-    o.text_node.should_not_be nil
-    o.TextNode.should_be nil
-    o.Text_Node.should_be nil
-    o.textnode.should_be nil
+    o.text_node.should_not equal nil
+    o.TextNode.should equal(nil)
+    o.Text_Node.should equal(nil)
+    o.textnode.should equal(nil)
   end
 
-  specify "should underscore elements ending in 'ID' correctly" do
+  it "should underscore elements ending in 'ID' correctly" do
     o = rest_object(%Q(<Object ref="bla">
                               <SalesforceCaseID>12345</SalesforceCaseID>
                             </Object>))
     o.salesforce_case_i_d.should == "12345"
   end
 
-  specify "should return text nodes" do
+  it "should return text nodes" do
     xml = %Q(<Object ref="bla">
                <TextNode>text</TextNode>
              </Object>)
     rest_object(xml).text_node.should == "text"
   end
 
-  specify "should return nested text nodes" do
+  it "should return nested text nodes" do
     xml = %Q(<Object ref="bla">
                <Nested>
                  <TextNode>text</TextNode>
@@ -91,7 +91,7 @@ context "a RestObject" do
     rest_object(xml).nested.text_node.should == "text"
   end
 
-  specify "ref elements should lazy read" do
+  it "should lazy read ref elements" do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
@@ -111,7 +111,7 @@ context "a RestObject" do
     object.description.should == "Description"
   end
   
-  specify "nested ref elements should lazy read" do
+  it "should lazy read nested ref elements" do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
@@ -130,12 +130,12 @@ context "a RestObject" do
 	b.TestCase(:ref => "http", :refObjectName => "name1")
       }
     end
-    object.test_case.should_be_instance_of RestObject
+    object.test_case.should be_instance_of(RestObject)
     object.test_case.type.should == "TestCase"
     object.test_case.description.should == "Description"
   end
 
-  specify "nested ref elements should lazy read only once" do
+  it "should lazy read only once nested ref elements" do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
@@ -159,7 +159,7 @@ context "a RestObject" do
     object.test_case.description.should == "Description"
   end
 
-  specify "full object collections should lazy load only once" do
+  it "should lazy load only once full object collections" do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
@@ -191,14 +191,43 @@ context "a RestObject" do
       }
     end
 
-    object.results.length.should_be 2
-    object.results.should_be_instance_of Array
+    object.results.length.should equal(2)
+    object.results.should be_instance_of(Array)
     object.results.first.description.should == "Description1"
     object.results.first.iteration.start_date.should == "12/12/01"
     object.results.first.iteration.start_date.should == "12/12/01"
   end
 
-  specify "collections are parsed as arrays " do
+  it "should dump and load" do
+
+    @api = RallyRestAPI.new
+
+    object = rest_object_xml do |b| 
+      b.QueryResult {
+	b.Results {
+	  b.Card(:ref => "http", :refObjectName => "Card1") {
+	    b.Name("Card1")
+	    b.Description("Description1")
+	    b.Iteration(:ref => "http", :refObjectName => "name1")
+	  }
+	  b.Card(:ref => "http", :refObjectName => "Card2") {
+	    b.Name("Card2")
+	    b.Description("Description2")
+	    b.Iteration(:ref => "http", :refObjectName => "name1")
+	  }
+	}
+      }
+    end
+
+    new_object = Marshal.load(Marshal.dump(object))
+
+    new_object.results.length.should equal(2)
+    new_object.results.should be_instance_of(Array)
+    new_object.results.first.description.should == "Description1"
+  end
+
+
+  it "should parse collections as arrays " do
     @api = RallyRestAPI.new(:parse_collections_as_hash => false)
 
     object = rest_object_xml do |b|
@@ -210,11 +239,11 @@ context "a RestObject" do
 	}
       }
     end
-    object.tasks.should_be_instance_of Array
-    object.tasks.length.should_be 3
+    object.tasks.should be_instance_of(Array)
+    object.tasks.length.should equal(3)
   end
 
-  specify "collections are parsed as hashes " do
+  it "should parse collections as hashes " do
     @api = RallyRestAPI.new(:parse_collections_as_hash => true)
 
     object = rest_object_xml do |b|
@@ -226,11 +255,11 @@ context "a RestObject" do
 	}
       }
     end
-    object.tasks.should_be_instance_of Hash
-    object.tasks.length.should_be 3
+    object.tasks.should be_instance_of(Hash)
+    object.tasks.length.should equal(3)
   end
 
-  specify "when collections are parsed as hashes, dup names should be in arrays " do
+  it "should dup names into arrays, when collections are parsed as hashes" do
     @api = RallyRestAPI.new(:parse_collections_as_hash => true)
 
     object = rest_object_xml do |b|
@@ -242,13 +271,13 @@ context "a RestObject" do
 	}
       }
     end
-    object.tasks.should_be_instance_of Hash
-    object.tasks.length.should_be 2
-    object.tasks["task2"].should_be_instance_of Array
-    object.tasks["task2"].length.should_be 2
+    object.tasks.should be_instance_of(Hash)
+    object.tasks.length.should equal(2)
+    object.tasks["task2"].should be_instance_of(Array)
+    object.tasks["task2"].length.should equal(2)
   end
 
-  specify "when collections are parsed as hashes, unnamed elements should be in arrays " do
+  it "should parse unnamed elements into arrays when collections are parsed as hashes" do
     @api = RallyRestAPI.new(:parse_collections_as_hash => true)
 
     object = rest_object_xml do |b|
@@ -260,12 +289,12 @@ context "a RestObject" do
 	}
       }
     end
-    object.tasks.should_be_instance_of Array
-    object.tasks.length.should_be 3
+    object.tasks.should be_instance_of(Array)
+    object.tasks.length.should equal(3)
   end
 
 
-  specify "should lazy read from collections" do
+  it "should lazy read from collections" do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).

data/test/spec_typedef.rb

@@ -4,9 +4,9 @@ require 'logger'
 require 'rally_rest_api'
 
 
-context "A Test Case type definition with 2 collection attribues, 1 object attributes, and 1 string attribute" do
+describe "A Test Case type definition with 2 collection attribues, 1 object attributes, and 1 string attribute" do
   
-  setup do
+  before(:each) do
     @b = Builder::XmlMarkup.new(:indent => 2)
     @b.instruct!
     
@@ -36,48 +36,53 @@ context "A Test Case type definition with 2 collection attribues, 1 object attri
     @typedef = TypeDefinition.new(OpenStruct.new(:username => "", :password => "", :logger => nil), xml)
   end
 
-  specify "all attribute keys are symbols" do
-    @typedef.attributes.keys.each { |a| a.should_be_instance_of Symbol }
+  it "all attribute keys are symbols" do
+    @typedef.attributes.keys.each { |a| a.should be_instance_of(Symbol) }
   end
 
-  specify "there should be 2 collection attributes" do
+  it "there should be 2 collection attributes" do
     @typedef.collection_attributes.size.should == 2
   end
   
-  specify "the :test_case_result attribute should exist" do
-    @typedef.collection_attributes[:test_case_result].should_not_be_nil
+  it "the :test_case_result attribute should exist" do
+    @typedef.collection_attributes[:test_case_result].should_not be_nil
   end
 
-  specify "All the collection attributes keys should be symbols" do
-    @typedef.collection_attributes.keys.each { |a| a.should_be_instance_of Symbol }
+  it "All the collection attributes keys should be symbols" do
+    @typedef.collection_attributes.keys.each { |a| a.should be_instance_of(Symbol) }
   end
   
-  specify "there should be 1 object attribute" do
+  it "there should be 1 object attribute" do
     @typedef.object_attributes.size.should == 1
   end
 
-  specify "the :requirement attribute should exist" do
-    @typedef.object_attributes[:requirement].should_not_be_nil
+  it "the :requirement attribute should exist" do
+    @typedef.object_attributes[:requirement].should_not be_nil
   end
 
-  specify "should have 2 constrained attributes" do
+  it "should have 2 constrained attributes" do
     @typedef.constrained_attributes.size.should == 2
   end
 
-  specify "should have 2 cusom attributes" do
+  it "should have 2 cusom attributes" do
     @typedef.custom_attributes.size.should == 2
   end
 
-  specify "should have 1 custom_constrained_attributes" do
-    @typedef.custom_constrained_attributes.size.should_be 1
-    @typedef.custom_dropdown_attributes.size.should_be 1
+  it "should have 1 custom_constrained_attributes" do
+    @typedef.custom_constrained_attributes.size.should equal(1)
+    @typedef.custom_dropdown_attributes.size.should equal(1)
   end
 
-  specify "#attributes should return instances of AttributeDefinitions" do
-    @typedef.attributes.values.each { |attrdef| attrdef.should_be_instance_of AttributeDefinition }
+  it "#attributes should return instances of AttributeDefinitions" do
+    @typedef.attributes.values.each { |attrdef| attrdef.should be_instance_of(AttributeDefinition) }
   end
 
-  specify  "parent should be nil" do
-    @typedef.parent.should_be_nil
+  it "should have a nil parent" do
+    @typedef.parent.should be_nil
   end
+
+  it "should not throw exception Marshalling" do
+    lambda { Marshal.dump(@typedef) }.should_not raise_error Exception
+  end
+  
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: rally_rest_api
 version: !ruby/object:Gem::Version 
-  version: 0.6.13
-date: 2007-03-08 00:00:00 -07:00
+  version: 0.7.0
+date: 2007-06-04 00:00:00 -06:00
 summary: A ruby-ized interface to Rally's REST webservices API
 require_paths: 
 - lib
@@ -40,6 +40,7 @@ files:
 - lib/rally_rest_api/timeout_catching_rest_builder.rb
 - lib/rally_rest_api/rest_object.rb
 - lib/rally_rest_api/typedef.rb
+- lib/rally_rest_api/ruport.rb
 - lib/rally_rest_api/version.rb
 - Manifest.txt
 - Rakefile
@@ -91,5 +92,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.7
+        version: 1.2.0
     version: