rally_rest_api 0.6.6 → 0.6.12

data/Manifest.txt

@@ -6,6 +6,7 @@ lib/rally_rest_api/query_result.rb
 lib/rally_rest_api/rally_rest.rb
 lib/rally_rest_api.rb
 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/version.rb
@@ -21,3 +22,6 @@ test/tc_rest_api.rb
 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/lib/rally_rest_api/rally_rest.rb

@@ -37,7 +37,7 @@ class RallyRestAPI
     @parse_collections_as_hash = options[:parse_collections_as_hash] || false
 
     if options[:builder]
-      builder = options[:builder] 
+      builder = options[:builder]
     else
       builder = RestBuilder.new(@base_url, @username, @password)
     end
@@ -65,7 +65,8 @@ class RallyRestAPI
   # returns the created object as a RestObject.
   def create(type, values) # :yields: new_object
 #    raise "'#{type}' is not a supported type. Supported types are: #{ALLOWED_TYPES.inspect}" unless ALLOWED_TYPES.include?(type.to_s)
-    object = builder.create_rest(type, values, @username, @password)
+    xml = builder.create_rest(type, values, @username, @password)
+    object = RestObject.new(self, xml)
     yield object if block_given?
     object
   end

data/lib/rally_rest_api/rest_builder.rb

@@ -14,7 +14,7 @@ class RestBuilder # :nodoc:
   end
 
   # create_rest - convert slm builder style:
-  #    slm.feature(:name => "feature name")
+  #    slm.create(:feature, :name => "feature name")
   #
   # Into xml builder style:
   #    b.feature {
@@ -29,8 +29,7 @@ class RestBuilder # :nodoc:
 
     result = post_xml("#{self.base_url}/webservice/1.0/#{type}/create", xml, username, password)
     doc = REXML::Document.new result
-    created_object = doc.root.elements["Object"]
-    RestObject.new(self, created_object.to_s)
+    doc.root.elements["Object"].to_s
   end
 
   # update_rest - convert slm builder style:
@@ -108,7 +107,7 @@ class RestBuilder # :nodoc:
 
   # Because we are adapting to the xml builder as such:
   #  We say to the RallyRestAPI:
-  #    slm.feature(:name => "feature name")
+  #    slm.create(:feature, :name => "feature name")
   #
   #  We tell the xml builder:
   #    b.feature {
@@ -116,9 +115,9 @@ class RestBuilder # :nodoc:
   #    }
   #
   # in the case where one element is a collection, RallyRest would look like
-  #    slm.feature(:name => "name", :dependancies => [sr1, sr2])
+  #    slm.create(:feature, :name => "name", :dependancies => [sr1, sr2])
   # 
-  # This need to be converted to 
+  # This needs to be converted to 
   #
   #    b.feature {
   #       b.name("name")
@@ -129,6 +128,17 @@ class RestBuilder # :nodoc:
   #    }
   # in this case we need to create a block to handle the nested calls (b.Supp...)
   #
+  #
+  # There are also nested/complex values, for example
+  # slm.create(:defect, :web_link => {:id => "123", :description => "foo"} )
+  #
+  #     b.defect {
+  #       b.web_link {
+  #         b.id "123"
+  #         b.description "foo"
+  #       }
+  #     }
+  # 
   # We need to convert the args hash into a block that can be fed to the builder.
   # This will send the keys of the map as "methods" (b.name) and the values of
   # map as the arguments to the method ("feature name"). 
@@ -137,13 +147,15 @@ class RestBuilder # :nodoc:
   # #convert_arg_for_builder will convert the value portion of the hash to the appropiate
   # string, or block for the xml builder
   def builder_block(args)
+    sort_block = lambda { |a,b| a.to_s <=> b.to_s }  # Sort the keys, for testing
     lambda do |builder|
-      args.each do |attr, value|
-	case attr
-	when *COLLECTION_TYPES
+      args.sort(&sort_block).each do |(attr, value)|
+	if COLLECTION_TYPES.include? attr
 	  # The call to builder with only a type and a block needs to be marked as such
 	  # note the '&'
 	  builder.__send__(camel_case_word(attr), &convert_arg_for_builder([value].flatten))
+	elsif value.instance_of? Hash
+	  builder.__send__(camel_case_word(attr), &builder_block(value))
 	else
 	  builder.__send__(camel_case_word(attr), convert_arg_for_builder(value))
 	end

data/lib/rally_rest_api/rest_object.rb

@@ -157,7 +157,7 @@ class RestObject
 
   # The oid of the underlying resource
   def oid
-    self.elements[:object_id]
+    self.elements[:object_i_d]
   end
 
   # return the typedef for this resource. 
@@ -183,11 +183,19 @@ class RestObject
     @elements
   end
 
-   def ==(other)
-     return true if self.equal other
-     return false unless other.kind_of? RestObject
-     other.ref == self.ref
-   end
+  def ==(object)
+    object.equal?(self) ||
+      (object.instance_of?(self.class) &&
+       object.ref == ref)
+  end
+
+  def hash
+    ref.hash
+  end
+  
+  def eql?(object)
+    self == (object)
+  end
 
   public 
   

data/lib/rally_rest_api/timeout_catching_rest_builder.rb

@@ -0,0 +1,11 @@
+
+class TimeoutCatchingRestBuilder < RestBuilder
+  def send_request(url, req, username, password)
+    begin
+      super
+    rescue Timeout::Error => e
+      @logger.warn "Caught Timeout Exception. Trying again..."
+      retry
+    end
+  end
+end

data/lib/rally_rest_api/typedef.rb

@@ -15,7 +15,7 @@ class TypeDefinition < RestObject # :nodoc:
   end
 
   def self.get_type_definition(workspace, type)
-    # This is a hack
+    # 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
@@ -50,9 +50,7 @@ class TypeDefinition < RestObject # :nodoc:
   end
 
   def object_attributes(include_parent = false)
-    collect_attributes(include_parent) do |element_name, attrdef| 
-      attrdef.attribute_type == "OBJECT" 
-    end
+    collect_attributes(include_parent) { |element_name, attrdef|  attrdef.attribute_type == "OBJECT" }
   end
 
   def reference_attributes(include_parent = false)

data/lib/rally_rest_api/version.rb

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

data/test/query_result_spec.rb

@@ -3,11 +3,7 @@ require 'test_helper'
 context "A QueryResult" do
 
   setup 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
+    @api = RallyRestAPI.new(:parse_collections_as_hash => true)
   end
 
   def make_result(total = 20, page_size = 20, start_index = 1)
@@ -84,11 +80,7 @@ end
 context "A QueryResult with full objects" do
 
   setup 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
+    @api = RallyRestAPI.new(:parse_collections_as_hash => true)
   end
 
   def make_result(total = 20, page_size = 20, start_index = 1)

data/test/rest_builder_spec.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+context "a RestBuilder " do
+
+  def xml
+    b = Builder::XmlMarkup.new
+    b.instruct!
+    yield b
+  end
+
+  setup do
+    @username = "username"
+    @password = "password"
+    @builder = RestBuilder.new(nil, @username, @password)
+  end
+  
+  specify "should produce correct xml for flat xml" do
+    expected_xml = xml do |b|
+      b.defect(:ref => "url") {
+	b.Name "foo"
+      }
+    end
+    @builder.should_receive(:post_xml).with(:anything, expected_xml, @username, @password)
+    @builder.update_rest(:defect, "url", {:name => "foo"}, @username, @password)
+  end
+  
+  specify "should produce correct xml for nested values" do
+    expected_xml = xml do |b|
+      b.defect(:ref => "url") {
+	b.Name "foo"
+	b.WebLink {
+	  b.DisplayString "desc"
+	  b.LinkID "12345"
+	}
+      }
+    end
+
+    @builder.should_receive(:post_xml).with(:anything, expected_xml, @username, @password)
+    @builder.update_rest(:defect, "url", 
+			 {
+			   :name => "foo", 
+			   :web_link => {
+			     :display_string => "desc",
+			     :link_i_d => "12345"
+			   }
+			 }, @username, @password)
+  end
+
+end

data/test/rest_object_spec.rb

@@ -48,6 +48,16 @@ context "a RestObject" do
     o.ref.should == "ref"
   end
 
+  specify "should return the oid" do
+    o = rest_object_xml do |b|
+      b.Defect(:refObjectName => "name", :ref => "ref") {
+	b.Name("name")
+	b.ObjectID("12345")
+      }
+    end
+    o.oid.should == "12345"
+  end
+
   specify "should underscore element names" do
     o = rest_object(%Q(<Object ref="bla">
                               <TextNode>text</TextNode>

data/test/tc_rest_api.rb

@@ -41,6 +41,12 @@ class RestApiTestCase < Test::Unit::TestCase
     assert_equal(xml, @xml)
   end
 
+  def test_basic_create
+    xml = "#{preamble}<Feature><Name>name</Name></Feature>"
+    object = @api.create(:feature, :name => "name")
+    assert_equal(RallyRestAPI, object.rally_rest.class)
+  end
+
   # test that types and keys are camel cased (at least with one underscore)
   def test_camel_case
     xml = "#{preamble}<UseCase><NameName>name</NameName></UseCase>"

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: rally_rest_api
 version: !ruby/object:Gem::Version 
-  version: 0.6.6
-date: 2007-02-06 00:00:00 -07:00
+  version: 0.6.12
+date: 2007-02-23 00:00:00 -07:00
 summary: A ruby-ized interface to Rally's REST webservices API
 require_paths: 
 - lib
@@ -37,6 +37,7 @@ files:
 - lib/rally_rest_api/rally_rest.rb
 - lib/rally_rest_api.rb
 - 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/version.rb
@@ -52,15 +53,17 @@ files:
 - test/rest_object_spec.rb
 - test/tc_rest_query.rb
 - test/test_helper.rb
+- test/rest_builder_spec.rb
 test_files: 
-- test/tc_rest_api.rb
+- test/attribute_definition_spec.rb
 - test/query_result_spec.rb
+- test/rest_builder_spec.rb
+- test/rest_object_spec.rb
+- test/spec_typedef.rb
+- test/tc_query_result.rb
+- test/tc_rest_api.rb
 - test/tc_rest_query.rb
 - test/test_helper.rb
-- test/tc_query_result.rb
-- test/spec_typedef.rb
-- test/attribute_definition_spec.rb
-- test/rest_object_spec.rb
 rdoc_options: []
 
 extra_rdoc_files: []
@@ -81,3 +84,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: