rally_rest_api 0.5.7 → 0.5.8

data/lib/rally_rest_api/query.rb

@@ -8,6 +8,10 @@ class String # :nodoc: all
   alias :to_q :to_s
 end
 
+class Fixnum
+  alias :to_q :to_s
+end
+
 class Symbol # :nodoc: all
     def to_q
       self.to_s.to_camel
@@ -66,22 +70,22 @@ end
 class RestQuery
   attr_reader :type
 
-  def initialize(type, *args, &block)
+  def initialize(type, args = {}, &block)
     @type = type
     @query_string = "query=" << URI.escape(QueryBuilder.new("and", &block).to_q) if block_given?
-    @query_params = process_args(args[0])
+    @query_params = process_args(args)
   end
 
-  def process_args(args) # :nodoc"
+  def process_args(args) # :nodoc:
     return if args.nil?
     query_string = ""
-    args.each do |key, value|
-      case key
+    args.each do |k, v|
+      case k
       when :order
 	# this is a hack, we need a better way to express descending
-	value = [value].flatten.map { |e| e.to_s.to_camel }.join(", ").gsub(", Desc", " desc")
+	v = [v].flatten.map { |e| e.to_s.to_camel }.join(", ").gsub(", Desc", " desc")
       end
-      query_string << "&#{key}=#{URI.escape(value.to_s)}" 
+      query_string << "&#{k}=#{URI.escape(v.to_q)}" 
     end
     query_string
   end

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,

data/lib/rally_rest_api/rally_rest.rb

@@ -71,13 +71,18 @@ class RallyRestAPI
   # Example :
   #   rally.find(:artifact, :page_size => 20, :start_index => 20) { equal :name, "name" }
   # See RestQuery for more info.
-  def find(type, *args, &query)
+  def find(type, args = {}, &query)
     # pass the args to RestQuery, make it generate the string and handle generating the query for the 
     # next page etc.
     query = RestQuery.new(type, args, &query)
     query(query)
   end
 
+  # 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
+
   # update - update an object
   def update(rest_object, attributes)
     rest_object.update(attributes)

data/lib/rally_rest_api/rest_object.rb

@@ -113,7 +113,8 @@ class RestObject
     return elements
   end
 
-  # lifted from rails
+  public
+
   def underscore(camel_cased_word)
     camel_cased_word.to_s.gsub(/::/, '/').
       gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
@@ -122,7 +123,6 @@ class RestObject
       downcase
   end
 
-  public
 
   # return the XML of the resource
   def body
@@ -150,13 +150,20 @@ class RestObject
     self.elements[:object_id]
   end
 
+  # return the typedef for this resource. 
+  def typedef
+    # this is a little ugly as we start to introduce some type specific info into this class.    
+    # All WorkspaceDomainObjects have a #workspace, that excludes user, workspace and subscription. 
+    return nil if self.type =~ /User|Workspace|Subscription/
+    TypeDefinition.cached_type_definition(self)
+  end
+
   # re-read the resource
   def refresh
     self.elements(true)
     self
   end
 
-  protected
   def elements(read = @elements.nil?) #:nodoc:
     if read
       @document_content = read_rest(self.ref, @username, @password)

data/lib/rally_rest_api/typedef.rb

@@ -1,23 +1,59 @@
 
-class TypeDefinition # :nodoc:
-  def initialize(type, value)
-    @type = type
-    @value = value
+require 'rally_rest_api/string_utils'
+require 'rally_rest_api/rest_object'
+
+class TypeDefinition < RestObject # :nodoc:
+
+  def self.cached_type_definition(workspace_domain_object)
+    # todo, actually cache the value
+    typedef = workspace_domain_object.workspace.type_definitions.values.find do |typedef|
+      puts "#{workspace_domain_object.type} == #{typedef.element_name}"
+      workspace_domain_object.type == typedef.element_name
+    end
+    TypeDefinition.new(typedef.rally_rest, typedef.body)
+  end
+
+  def collection_attributes(include_parent = false)
+    collect_attributes_of_type("COLLECTION", include_parent)
+  end
+
+  def object_attributes(include_parent = false)
+    collect_attributes_of_type("OBJECT", include_parent)
   end
 
-  def collection_attributes
-    value.attributes.values.collect do |attr_def|
-      attr_def.element_name if attr_def.attribute_type == "COLLECTION"
-    end.compact
+  def reference_attributes(include_parent = false)
+    collection_attributes(include_parent).merge object_attributes(include_parent)
   end
 
-  def attributes
-    all_attributes = []
-    value.parent.attributes
+  def collect_attributes_of_type(type, include_parent)
+    self.attributes(include_parent).inject({}) do |h, (element_name, attrdef)|
+      h[element_name] = attrdef if attrdef.attribute_type == type
+      h
+    end
+  end
+
+  def symbol_keyed_attributes(attribute_array)
+    attribute_array.inject({}) do |hash, attrdef|
+      hash[underscore(attrdef.element_name).intern] = attrdef
+      hash
+    end
+  end
+
+  def attributes(include_parent = false)
+    return symbol_keyed_attributes(self.elements[:attributes].values) unless include_parent
+
+    typedef = self
+    all_attributes = {}
+    until typedef.parent.nil?
+      all_attributes.merge! typedef.attributes(false)
+      typedef = typedef.parent
+    end
+    all_attributes
   end
 
   def parent
-    TypeDefinition.new(value.parent.name, value.parent)
+    return nil if self.elements[:parent].nil?
+    TypeDefinition.new(self.rally_rest, self.elements[:parent].body)
   end
   
 end

data/lib/rally_rest_api/version.rb

@@ -2,7 +2,7 @@ module RallyRestVersion #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 5
-    TINY  = 7
+    TINY  = 8
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   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.7
-date: 2006-11-28 00:00:00 -07:00
+  version: 0.5.8
+date: 2006-11-29 00:00:00 -07:00
 summary: A ruby-ized interface to Rally's REST webservices API
 require_paths: 
 - lib