rally_api 0.8.5 → 0.9.0

data/lib/rally_api.rb

@@ -10,6 +10,7 @@ require "rally_api/rally_query"
 require "rally_api/rally_query_result"
 require "rally_api/rally_rest_json"
 require "rally_api/version"
+require "rally_api/rally_collection"
 
 module RallyAPI
 end

data/lib/rally_api/rally_collection.rb

@@ -0,0 +1,58 @@
+# :stopdoc:
+#Copyright (c) 2002-2012 Rally Software Development Corp. All Rights Reserved.
+#Your use of this Software is governed by the terms and conditions
+#of the applicable Subscription Agreement between your company and
+#Rally Software Development Corp.
+# :startdoc:
+
+module RallyAPI
+
+  class RallyCollection
+    include Enumerable
+
+    attr_reader :results
+    alias :values :results
+
+    def initialize(results)
+      @results = results
+    end
+
+    def [](index)
+      if (index.kind_of? Fixnum)
+        @results[index]
+      else
+        all = @results.find_all { |object| object.name == index }
+        all.length == 1 ? all[0] : all
+      end
+    end
+
+    def each(&block)
+      if (block.parameters.length == 2)
+        @results.each do |record|
+          block.call(record.to_s, record)
+        end
+      else
+        @results.each &block
+      end
+    end
+    alias :each_value :each
+
+    def size
+      length
+    end
+
+    def length
+      @results.count
+    end
+
+    def include?(name)
+      self[name.to_s] != []
+    end
+
+    def empty?
+      length == 0
+    end
+
+  end
+
+end

data/lib/rally_api/rally_object.rb

@@ -25,7 +25,7 @@ module RallyAPI
     end
 
     def to_s(*args)
-      rally_object.to_json
+      get_val('Name') || get_val('_refObjectName')
     end
 
     def to_json(*args)
@@ -45,6 +45,7 @@ module RallyAPI
       @rally_object = @rally_rest.reread(rally_object, params)
       self
     end
+    alias :refresh :read
 
     def getref
       ref
@@ -54,6 +55,58 @@ module RallyAPI
       rally_object["_ref"]
     end
 
+    def camel_case_word(sym)
+      RallyAPI::RallyRestJson.camel_case_word(sym)
+    end
+
+    def elements
+      @rally_object.inject({}) do |elements, (key, value)|
+        if key.to_s.starts_with?("c_")
+          key = key.to_s[2..-1]
+        end
+        elements[underscore(key).to_sym] = value
+        elements
+      end
+    end
+
+    def oid
+      object_i_d
+    end
+
+    def username
+      user_name || login_name
+    end
+
+    def password
+      @rally_rest.rally_password
+    end
+
+    def ==(object)
+      object.equal?(self) ||
+          (object.instance_of?(self.class) &&
+              object.ref == ref)
+    end
+
+    def eql?(object)
+      self == (object)
+    end
+
+    def <=>(object)
+      self.ref <=> object.ref
+    end
+
+    def hash
+      self.ref.hash
+    end
+
+    def name
+      get_val('Name') || get_val('_refObjectName')
+    end
+
+    def to_q
+      @rally_object["_ref"]
+    end
+
     def rank_above(relative_rally_object)
       @rally_object = @rally_rest.rank_above(rally_object["_ref"],relative_rally_object["_ref"]).rally_object
       self
@@ -90,21 +143,55 @@ module RallyAPI
       ret_val
     end
 
+    #def get_val(field)
+    #  return_val = rally_object[field]
+    #
+    #  if return_val.class == Hash
+    #    return RallyObject.new(@rally_rest, return_val)
+    #  end
+    #
+    #  if return_val.class == Array
+    #    make_object_array(field)
+    #    return_val = rally_object[field]
+    #  end
+    #
+    #  return_val
+    #end
+
     def get_val(field)
-      return_val = rally_object[field]
+      return_val = @rally_object[field]
+      return_val = @rally_object["c_#{field}"] if return_val.nil?
 
       if return_val.class == Hash
+        if return_val.has_key?("_ref")
+          return read_association return_val
+        end
         return RallyObject.new(@rally_rest, return_val)
       end
 
       if return_val.class == Array
         make_object_array(field)
-        return_val = rally_object[field]
+        return_val = @rally_object[field]
       end
 
       return_val
     end
 
+    def read_association(object_or_collection)
+      return read_collection(object_or_collection) if object_or_collection.has_key? 'Count'
+      return RallyObject.new(@rally_rest, @rally_rest.reread(object_or_collection)) if @rally_rest.rally_rest_api_compat
+      RallyObject.new(@rally_rest, object_or_collection)
+    end
+
+    def read_collection(collection)
+      results = @rally_rest.reread(collection)["Results"]
+      RallyCollection.new(results.collect { |object| RallyObject.new(@rally_rest, object) })
+    end
+
+    def underscore(camel_cased_word)
+      camel_cased_word.split(/(?=[A-Z])/).join('_').downcase
+    end
+
     def make_object_array(field)
       object_array = []
       rally_object[field].each do |rally_obj|
@@ -113,11 +200,6 @@ module RallyAPI
       rally_object[field] = object_array
     end
 
-    #taken from rally_rest_api - to try to help with backwards compatibility
-    def camel_case_word(sym)
-        sym.to_s.split("_").map { |word| word.capitalize }.join
-    end
-
   end
 
 end

data/lib/rally_api/rally_query.rb

@@ -28,6 +28,8 @@ module RallyAPI
     attr_accessor :type, :query_string, :fetch, :workspace, :project, :project_scope_up, :project_scope_down
     attr_accessor :order, :page_size, :limit
 
+    alias :pagesize :page_size
+
     def initialize(query_hash = nil)
       parse_query_hash(query_hash) if !query_hash.nil?
       @page_size          = 200 if @page_size.nil?

data/lib/rally_api/rally_query_result.rb

@@ -8,7 +8,7 @@ module RallyAPI
   class RallyQueryResult
     include Enumerable
 
-    attr_accessor :results, :total_result_count
+    attr_reader :results, :total_result_count
 
     def initialize(rally_rest, json_results)
       @results            = json_results["QueryResult"]["Results"]
@@ -34,5 +34,13 @@ module RallyAPI
       @results.length
     end
 
+    def empty?
+      length == 0
+    end
+
+    def results   #for compatiblity with code using rally_rest_api
+      self
+    end
+
   end
 end

data/lib/rally_api/rally_rest_json.rb

@@ -49,7 +49,6 @@ module RallyAPI
     attr_accessor :rally_url, :rally_user, :rally_password, :rally_workspace_name, :rally_project_name, :wsapi_version
     attr_accessor :rally_headers, :rally_default_workspace, :rally_default_project, :low_debug, :proxy_info
     attr_accessor :rally_rest_api_compat, :logger, :rally_alias_types
-
     attr_reader   :rally_connection
 
     def initialize(args)
@@ -143,9 +142,10 @@ module RallyAPI
       end
 
       ws_ref = fields["Workspace"]
-      ws_ref = ws_ref["_ref"] unless ws_ref.class == String
+      ws_ref = ws_ref["_ref"] unless ws_ref.class == String || ws_ref.nil?
       params = { :workspace => ws_ref }
 
+      fields = RallyAPI::RallyRestJson.fix_case(fields) if @rally_rest_api_compat
       object2create = { type => make_ref_fields(fields) }
       args = { :method => :post, :payload => object2create }
       #json_response = @rally_connection.create_object(make_create_url(rally_type), args, object2create)
@@ -183,10 +183,10 @@ module RallyAPI
       json_response[rally_type]
     end
 
-
     def update(type, obj_id, fields)
       type = check_type(type)
       ref = check_id(type.to_s, obj_id)
+      fields = RallyAPI::RallyRestJson.fix_case(fields) if @rally_rest_api_compat
       json_update = { type.to_s => make_ref_fields(fields) }
       args = { :method => :post, :payload => json_update }
       #json_response = @rally_connection.update_object(ref, args, json_update)
@@ -194,6 +194,7 @@ module RallyAPI
       #todo check for warnings on json_response["OperationResult"]
       RallyObject.new(self, reread({"_ref" => ref}))
     end
+    alias :update_ref :update
 
     ##-----
     #Querying Rally example
@@ -356,14 +357,15 @@ module RallyAPI
       false
     end
 
-    #expecting idstring to have "FormattedID|DE45" or the objectID
+    #expecting idstring to have "FormattedID|DE45" or the objectID or a ref itself
     def check_id(type, idstring)
       if idstring.class == Fixnum
         return make_read_url(type, idstring)
       end
 
-      if (idstring.class == String) && (idstring.index("FormattedID") == 0)
-        return ref_by_formatted_id(type, idstring.split("|")[1])
+      if (idstring.class == String)
+        return idstring if idstring.index("http") == 0
+        return ref_by_formatted_id(type, idstring.split("|")[1]) if idstring.index("FormattedID") == 0
       end
       make_read_url(type, idstring)
     end
@@ -387,14 +389,56 @@ module RallyAPI
     end
 
     def make_ref_fields(fields)
-      fields.each do |key,val|
-        if (val.class == RallyObject)
-          fields[key] = val.getref
-        end
+      fields.each do |key, val|
+        fields[key] = make_ref_field(val)
       end
       fields
     end
 
+    def make_ref_field(val)
+      return val.getref if val.kind_of? RallyObject
+      return val if val.kind_of? Hash
+      return val if val.is_a?(Hash)
+
+      if val.kind_of? Enumerable
+        return val.collect do |collection_element|
+          if collection_element.kind_of? RallyObject
+            {"_type" => collection_element.type, "_ref" => collection_element.getref}
+          else
+            collection_element
+          end
+        end
+      end
+
+      val
+    end
+
+    def self.fix_case(values)
+      values.inject({}) do |new_values, (key, value)|
+        new_values[camel_case_word(key)] = value.is_a?(Hash) ? fix_case(value) : value
+        new_values
+      end
+    end
+
+    def self.camel_case_word(sym)
+      word = sym.to_s
+
+      if word.start_with? ("c_")
+        custom_field_without_c = word.sub("c_", "")
+        camelized = camelize(custom_field_without_c)
+        camelized[0] = custom_field_without_c[0]
+        "c_#{camelized}"
+      else
+        camelize(word)
+      end
+    end
+
+    #implemented basic version here to not have to include ActiveSupport
+    def self.camelize(str)
+      str.split('_').map {|w| w.capitalize}.join
+    end
+
+
   end
 
 end

data/lib/rally_api/version.rb

@@ -4,5 +4,5 @@
 #of the applicable Subscription Agreement between your company and
 #Rally Software Development Corp.
 module RallyAPI
-  VERSION = "0.8.5"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rally_api
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000Z
+date: 2013-01-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70344430529800 !ruby/object:Gem::Requirement
+  requirement: &70127257258460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *70344430529800
+  version_requirements: *70127257258460
 description: API wrapper for Rally's JSON REST web services api
 email:
 - dsmith@rallydev.com
@@ -33,6 +33,7 @@ files:
 - Rakefile
 - lib/rally_api/custom_http_header.rb
 - lib/rally_api/lookback_api_query.rb
+- lib/rally_api/rally_collection.rb
 - lib/rally_api/rally_json_connection.rb
 - lib/rally_api/rally_object.rb
 - lib/rally_api/rally_query.rb