rally_rest_api 0.7.10 → 0.8.0

data/Manifest.txt

@@ -16,10 +16,18 @@ lib/rally_rest_api/timeout_catching_rest_builder.rb
 lib/rally_rest_api/typedef.rb
 lib/rally_rest_api/version.rb
 setup.rb
+spec/rally_rest_api/attribute_definition_spec.rb
+spec/rally_rest_api/custom_http_header_spec.rb
+spec/rally_rest_api/query_result_spec.rb
+spec/rally_rest_api/rest_builder_spec.rb
+spec/rally_rest_api/rest_object_spec.rb
+spec/rally_rest_api/tc_query_result.rb
+spec/rally_rest_api/tc_rest_api.rb
+spec/rally_rest_api/tc_rest_query.rb
+spec/rally_rest_api/typedef_spec.rb
+spec/test_helper.rb
 tasks/ann.rake
-tasks/annotations.rake
 tasks/bones.rake
-tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
 tasks/post_load.rake
@@ -28,13 +36,3 @@ tasks/setup.rb
 tasks/spec.rake
 tasks/svn.rake
 tasks/test.rake
-test/attribute_definition_spec.rb
-test/custom_http_header_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

data/Rakefile

@@ -2,6 +2,7 @@
 # configured in this Rakefile. The .rake files in the tasks directory
 # are where the options are used.
 
+
 load 'tasks/setup.rb'
 
 ensure_in_path 'lib'
@@ -13,14 +14,14 @@ PROJ.name = 'rally_rest_api'
 PROJ.authors = 'Bob Cotton'
 PROJ.email = 'bob.cotton@rallydev.com'
 PROJ.url = 'http://rally-rest-api.rubyforge.org/rally_rest_api'
-PROJ.rubyforge_name = 'rally-rest-api'
+PROJ.rubyforge.name = 'rally-rest-api'
 PROJ.summary = "A Ruby interface to the Rally REST API"
 PROJ.version = RallyRestVersion::LIBRARY_VERSION::STRING
 
 PROJ.exclude = ['.git/*', 'pkg/*']
 
-PROJ.rdoc_dir = 'doc/output/rally_rest_api'
+PROJ.rdoc.dir = 'doc/output/rally_rest_api'
 
-PROJ.spec_opts << '--color'
+PROJ.spec.opts << '--color'
 
 # EOF

data/lib/rally_rest_api/attribute_definition.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/rest_object'
 class AttributeDefinition < RestObject # :nodoc:
 
   def initialize(rally_rest, values)
-    @rally_rest = rally_rest
+    super(rally_rest)
     @elements = values
   end
 

data/lib/rally_rest_api/rally_rest.rb

@@ -32,6 +32,7 @@ class RallyRestAPI
   #
   def initialize(options = {})
     parse_options(options)
+    user
   end
 
   def parse_options(options)

data/lib/rally_rest_api/rest_object.rb

@@ -1,6 +1,7 @@
 require 'logger'
 require File.dirname(__FILE__) + '/rest_builder'
 require 'builder/blankslate'
+require 'forwardable'
 
 # == An interface to a Rally resource
 # RestObject is an adapter that is initialized with a resource ref (URL) that represents a Rally object. The adapter
@@ -26,14 +27,17 @@ class FancyHash < Hash # :nodoc: all
 end
 
 class RestObject
+  extend Forwardable
 
-  attr_reader :username, :password, :rally_rest
+  attr_accessor :rally_rest
+  def_delegator(:rally_rest, :username)
+  def_delegator(:rally_rest, :password)
 
-  def initialize(rally_rest, document_content)
+  def initialize(rally_rest = nil, document_content = nil)
+	@changed_values = {} 
     @rally_rest = rally_rest
     @document_content = document_content
-    @username, @password = @rally_rest.username, @rally_rest.password
-    parse_document
+    parse_document if document_content
   end
 
   def parse_document
@@ -46,14 +50,14 @@ class RestObject
   end
 
   def marshal_dump
-    [@rally_rest, @document_content, @username, @password]  
+    [@rally_rest, @document_content, @changed_values]  
   end
 
   def marshal_load(stuff)
-    @rally_rest, @document_content, @username, @password = *stuff
+    @rally_rest, @document_content, @changed_values = *stuff
     parse_document
   end
-
+  
   private
   def terminal?(node)
     !node.has_elements?
@@ -156,14 +160,19 @@ class RestObject
 
   # The name of the object, without having to read the entire body
   def name
-    @document.root.attributes["refObjectName"]
+    @changed_values[:name] || @document.root.attributes["refObjectName"]
   end
   alias :to_s :name
 
   # The type of the underlying resource
   def type
-    @document.root.attributes["type"] || @document.root.name
+    @type || @document.root.attributes["type"] || @document.root.name
+  end
+
+  def type=(type)
+  	@type = type
   end
+  alias :artifact_type= :type=
 
   # the type as symbol
   def type_as_symbol
@@ -191,7 +200,7 @@ class RestObject
 
   def elements(read = @elements.nil?) #:nodoc:
     if read
-      @document_content = builder.read_rest(self.ref, @username, @password)
+      @document_content = builder.read_rest(self.ref, username, password)
       @document = REXML::Document.new @document_content
       @elements = parse(@document.root)
     end
@@ -217,20 +226,33 @@ class RestObject
   end
 
   public 
+
+  def save!
+    raise 'missing RallyRestAPI instance' unless rally_rest
+    raise 'missing object type' unless @type
+	@document_content = builder.create_rest(type, @changed_values, username, password)
+    parse_document
+  end
   
   # 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)
+    builder.update_rest(type, ref, args, username, password)
     self.elements(true)
   end
 
   # delete the resource
   def delete
-    builder.delete_rest(self.ref, @username, @password)
+    builder.delete_rest(ref, username, password)
   end
 
   def method_missing(sym, *args) # :nodoc:
-    self.elements[sym]
+    method = sym
+    if sym.to_s.match(/(.*)=$/)
+	  method = $1.intern 
+	  return @changed_values[method] = args.first
+	end
+
+    @changed_values[method] || self.elements[method]
     # 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

data/lib/rally_rest_api/version.rb

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

data/{test → spec/rally_rest_api}/attribute_definition_spec.rb

@@ -1,9 +1,7 @@
-require 'rubygems'
-require 'spec'
-require 'builder'
+require File.dirname(__FILE__) + '/../test_helper'
+
 require 'ostruct'
 require 'logger'
-require 'rally_rest_api'
 
 
 describe "An attribute definition for a custom dropdown" do

data/{test → spec/rally_rest_api}/custom_http_header_spec.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/../test_helper'
 
 describe "A CustomHttpHeader" do
 

data/{test → spec/rally_rest_api}/query_result_spec.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/../test_helper'
 
 describe "A QueryResult" do
 
@@ -125,7 +125,7 @@ describe "A QueryResult with full objects" do
     rest_builder.
       should_receive(:read_rest).
       twice.
-      with(:any_args).
+      with(any_args(), nil, nil).
       and_return( xml do |b| 
 		   b.iteration { 
 		     b.Name("name1")

data/{test → spec/rally_rest_api}/rest_builder_spec.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/../test_helper'
 
 describe "a RestBuilder " do
 
@@ -20,7 +20,7 @@ describe "a RestBuilder " do
 	b.Name "foo"
       }
     end
-    @builder.should_receive(:post_xml).with(:anything, expected_xml, @username, @password)
+    @builder.should_receive(:post_xml).with(anything(), expected_xml, @username, @password)
     @builder.update_rest(:defect, "url", {:name => "foo"}, @username, @password)
   end
   
@@ -35,7 +35,7 @@ describe "a RestBuilder " do
       }
     end
 
-    @builder.should_receive(:post_xml).with(:anything, expected_xml, @username, @password)
+    @builder.should_receive(:post_xml).with(anything(), expected_xml, @username, @password)
     @builder.update_rest(:defect, "url", 
 			 {
 			   :name => "foo", 

data/{test → spec/rally_rest_api}/rest_object_spec.rb

@@ -1,5 +1,4 @@
-
-require 'test_helper'
+require File.dirname(__FILE__) + '/../test_helper'
 
 describe RestObject do
 
@@ -95,7 +94,7 @@ describe RestObject do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
-      with(:any_args).
+      with(any_args()).
       and_return( xml do |b| 
 		   b.TestCase { 
 		     b.Name("name1")
@@ -115,7 +114,7 @@ describe RestObject do
     rest_builder = mock("RestBuilder")
     rest_builder.
       should_receive(:read_rest).
-      with(:any_args).
+      with(any_args()).
       and_return( xml do |b| 
 		   b.TestCase { 
 		     b.Name("name1")
@@ -140,7 +139,7 @@ describe RestObject do
     rest_builder.
       should_receive(:read_rest).
       once.
-      with(:any_args).
+      with(any_args()).
       and_return( xml do |b| 
 		   b.TestCase { 
 		     b.Name("name1")
@@ -164,7 +163,7 @@ describe RestObject do
     rest_builder.
       should_receive(:read_rest).
       once.
-      with(:any_args).
+      with(any_args()).
       and_return( xml do |b| 
 		   b.iteration { 
 		     b.Name("name1")
@@ -299,7 +298,7 @@ describe RestObject do
     rest_builder.
       should_receive(:read_rest).
       twice.
-      with(:any_args).
+      with(any_args()).
       and_return( xml do |b| 
 		   b.Task { 
 		     b.Name("name1")
@@ -323,5 +322,63 @@ describe RestObject do
     object.tasks.first.description.should == "Description"
     object.tasks.last.description.should == "Description"
   end
+   
+  it "should allow getting and setting rally_rest" do
+    rally_rest = RallyRestAPI.new
+	rest_object = RestObject.new
+	rest_object.rally_rest = rally_rest
+	rest_object.rally_rest.should equal(rally_rest)
+  end
 
+  it "should allow the type to be set" do
+    rest_object = RestObject.new
+	rest_object.type = :defect
+	rest_object.type.should == :defect
+  end
+
+  it "should allow the name to be set" do
+    rest_object = RestObject.new
+	rest_object.name = "name"
+	rest_object.name.should == "name"
+  end
+
+  it "should allow the setting and getting of any value" do
+    rest_object = RestObject.new
+	rest_object.description = "description"
+	rest_object.description.should == "description"
+  end
+
+  it "should pass the type and set value to create on rally_rest" do
+    builder = mock("builder")
+	rally_rest = RallyRestAPI.new(:builder => builder)
+	args = {:name => "name", :description => "description"}
+    xml = %Q(<Object ref="bla" refObjectName="name">
+               <Name>name</Name>
+               <Description>description</Description>
+             </Object>)
+
+	builder.should_receive(:create_rest).with(:defect, args, nil, nil).and_return(xml)
+
+    rest_object = RestObject.new
+	rest_object.rally_rest = rally_rest
+	rest_object.type = :defect
+	rest_object.name = "name"
+	rest_object.description = "description"
+	rest_object.save!
+
+    rest_object.ref.should == "bla"
+	rest_object.name.should == "name"
+    rest_object.description.should == "description"
+  end
+  
+  it "should not try to save if there is no rally_rest" do
+    rest_object = RestObject.new
+	lambda { rest_object.save! }.should raise_error(StandardError, /missing RallyRestAPI instance/)
+  end
+
+  it "should not try to save if there is no type" do
+    rally_rest = stub!("RallyRest")
+    rest_object = RestObject.new(rally_rest)
+	lambda { rest_object.save! }.should raise_error(StandardError, /missing object type/)
+  end
 end

data/{test → spec/rally_rest_api}/tc_query_result.rb

@@ -1,8 +1,7 @@
+require File.dirname(__FILE__) + '/../test_helper'
 require 'test/unit'
 require 'test/unit/testcase'
 
-require 'rubygems'
-require 'rally_rest_api'
 
 class QueryResultTestCase < Test::Unit::TestCase
   

data/{test → spec/rally_rest_api}/tc_rest_api.rb

@@ -1,9 +1,4 @@
-require 'test/unit'
-require 'test/unit/testcase'
-
-require 'rubygems'
-require 'rally_rest_api'
-
+require File.dirname(__FILE__) + '/../test_helper'
 class RestApiTestCase < Test::Unit::TestCase
 
   # We need to override post_xml from RestBuilder, So redefine it here

data/{test → spec/rally_rest_api}/tc_rest_query.rb

@@ -1,8 +1,4 @@
-
-require "test/unit"
-
-require 'rubygems'
-require 'rally_rest_api'
+require File.dirname(__FILE__) + '/../test_helper'
 
 class TestRestQuery < Test::Unit::TestCase
   # RestQuery.find(:feature).where {  # default is and

data/{test/spec_typedef.rb → spec/rally_rest_api/typedef_spec.rb}

@@ -1,7 +1,5 @@
-require 'spec'
+require File.dirname(__FILE__) + '/../test_helper'
 require 'ostruct'
-require 'logger'
-require 'rally_rest_api'
 
 
 describe "A Test Case type definition with 2 collection attribues, 1 object attributes, and 1 string attribute" do
@@ -15,11 +13,11 @@ describe "A Test Case type definition with 2 collection attribues, 1 object attr
 		      :type => "TypeDefinition") {
       @b.ElementName("TestCase")
       @b.Attributes {
-	{"Notes"             => {:type => "TEXT", :element_name => "Notes", :constrained => "false", :custom => "false"},
-	  "Test Case Result" => {:type => "COLLECTION", :element_name => "TestCaseResult", :constrained => "false", :custom => "false"},
+	 {"Notes"             => {:type => "TEXT", :element_name => "Notes", :constrained => "false", :custom => "false"},
+      "Test Case Result" => {:type => "COLLECTION", :element_name => "TestCaseResult", :constrained => "false", :custom => "false"},
 	  "Foo Bar"          => {:type => "COLLECTION", :element_name => "FooBar", :constrained => "false", :custom => "false"},
 	  "Requirement"      => {:type => "OBJECT", :element_name => "Requirement", :constrained => "false", :custom => "false"},
-          "Constrained"      => {:type => "STRING", :element_name => "Constrained", :constrained => "true", :custom => "false"},
+      "Constrained"      => {:type => "STRING", :element_name => "Constrained", :constrained => "true", :custom => "false"},
 	  "Custom"           => {:type => "STRING", :element_name => "Custom", :constrained => "false", :custom => "true"},
 	  "ConstainedCustom" => {:type => "STRING", :element_name => "ConstrainedCustom", :constrained => "true", :custom => "true"}
 	}.each do |name, type|

data/spec/test_helper.rb

@@ -0,0 +1,13 @@
+dir = File.dirname(__FILE__)
+app_path = File.expand_path("#{dir}/../lib")
+$LOAD_PATH.unshift app_path unless $LOAD_PATH.include?(app_path)
+require 'test/unit'
+require 'rubygems'
+require 'spec'
+require 'net/http'
+require 'rally_rest_api'
+
+class RallyRestAPI
+  def user; end
+end
+