rally_api 0.7.2 → 0.7.3

data/README.rdoc

@@ -32,8 +32,14 @@ RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-clien
 
 
 === Querying Rally
+
+    #type names are stored in rally.rally_objects hash, you can inspect there for a list
+    #Look at the TypePath for all typedefs and this is the key to each hash.
+    #If you pass in a symbol (for code using versions prior to 0.7.3), it will be downcased and turned into a string
+    # examples are:   "defect", "hierarchicalrequirement", "portfolioitem/feature"
+
     test_query = RallyAPI::RallyQuery.new()
-    test_query.type = :defect
+    test_query.type = "defect"
     test_query.fetch = "Name"
     test_query.workspace = {"_ref" => "https://rally1.rallydev.com/slm/webservice/1.25/workspace/12345.js" } #optional
     test_query.project = {"_ref" => "https://rally1.rallydev.com/slm/webservice/1.25/project/12345.js" }     #optional
@@ -56,16 +62,16 @@ RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-clien
 
     #for people comfortable passing around blocks:
     results = @rally.find do |q|
-        q.type = :defect
+        q.type = "defect"
         q.fetch = "Name,FormattedID"
         q.query_string = "(Priority = \"Low\")"
     end
 
 
 === Reading an Artifact
-    defect = @rally.read(:defect, 12345)      #by ObjectID
+    defect = @rally.read("defect", 12345)      #by ObjectID
     #or
-    defect = @rally.read(:defect, "FormattedID|DE42")      #by FormattedID
+    defect = @rally.read("defect", "FormattedID|DE42")      #by FormattedID
     #or if you already have an object like from a query
     results = @rally.find(RallyAPI::RallyQuery.new({:type => :defect, :query_string => "(FormattedID = DE42)"}))
     defect = results.first
@@ -85,25 +91,25 @@ RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-clien
 === Creating an Artifact
     obj = {}
     obj["Name"] = "Test Defect created #{DateTime.now()}"
-    new_de = @rally.create(:defect, obj)
+    new_de = @rally.create("defect", obj)
     puts new_de["FormattedID"]
 
 === Updating an Artifact
     fields = {}
     fields["Severity"] = "Critical"
     fields["Description"] = "Description for the issue"
-    updated_defect = @rally.update(:defect, 12345, fields)    #by ObjectID
+    updated_defect = @rally.update("defect", 12345, fields)    #by ObjectID
     #or
-    updated_defect = @rally.update(:defect, "FormattedID|DE42", fields)   #by FormattedID
+    updated_defect = @rally.update("defect", "FormattedID|DE42", fields)   #by FormattedID
     # or
-    defect = @rally.read(:defect, 12345)      #by lookup then udpating via the object
+    defect = @rally.read("defect", 12345)      #by lookup then udpating via the object
     field_updates = {"Description" => "Changed Description"}
     defect.update(field_updates)
 
 === Utils
     #allowed values:  pass the Artifact type string or downcased symbol and the Display Name of the field
     @rally.allowed_values("Defect", "Severity")
-    @rally.allowed_values(:story, "ScheduleState")
+    @rally.allowed_values("story", "ScheduleState")
 
     #re-ranking:  rank_above and rank_below
     story1.rank_above(story2)   #in a drag and drop workspace move story1 relative to story2

data/lib/rally_api/custom_http_header.rb

@@ -22,7 +22,7 @@ module RallyAPI
       @os = RUBY_PLATFORM
       @platform = "Ruby #{RUBY_VERSION}"
       @library = "RallyRestJson version #{RallyAPI::VERSION}"
-      @name = "RallyRestJson"
+      @name = "RallyRestJsonRuby"
 
       if custom_vals.keys.length > 0
         @name    = custom_vals[:name]

data/lib/rally_api/rally_object.rb

@@ -40,6 +40,11 @@ module RallyAPI
       get_val(field_name)
     end
 
+    def []=(field_name, value)
+      return if field_name.nil?
+      @rally_object[field_name] = value
+    end
+
     def read(params = nil)
       @rally_object = @rally_rest.reread(@rally_object, params)
       self

data/lib/rally_api/rally_query.rb

@@ -74,7 +74,7 @@ module RallyAPI
         errors.push("Project - #{@project} - must have a ref") if @project["_ref"].nil?
       end
 
-      if (allowed_objects[@type].nil?)
+      if (allowed_objects[@type.to_s].nil?)
         errors.push( "Object Type #{@type} is not query-able: inspect RallyRestJson.rally_objects for allowed types" )
       end
 
@@ -84,7 +84,7 @@ module RallyAPI
     private
 
     def parse_query_hash(query_hash)
-      @type               = query_hash[:type]
+      @type               = query_hash[:type].to_s
       @query_string       = query_hash[:query_string]
       @fetch              = query_hash[:fetch]
       @project_scope_down = query_hash[:project_scope_down]

data/lib/rally_api/rally_rest_json.rb

@@ -71,8 +71,8 @@ module RallyAPI
       @rally_connection.set_client_user(@rally_url, @rally_user, @rally_password)
       @rally_connection.logger  = @logger unless @logger.nil?
 
-      @rally_objects = { :typedefinition => "TypeDefinition", :user => "User", :subscription => "Subscription",
-                         :workspace => "Workspace", :project => "Project" }
+      @rally_objects = { "typedefinition" => "TypeDefinition", "user" => "User", "subscription" => "Subscription",
+                         "workspace" => "Workspace", "project" => "Project" }
 
       if !@rally_workspace_name.nil?
         @rally_default_workspace = find_workspace(@rally_workspace_name)
@@ -131,7 +131,7 @@ module RallyAPI
 
     def user
       args = { :method => :get }
-      json_response = @rally_connection.send_request(make_get_url(@rally_objects[:user]), args)
+      json_response = @rally_connection.send_request(make_get_url(@rally_objects["user"]), args)
       rally_type = json_response.keys[0]
       RallyObject.new(self, json_response[rally_type])
     end
@@ -278,12 +278,12 @@ module RallyAPI
     #todo - check support for portfolio item fields
     def allowed_values(type, field)
       if type.class == Symbol
-        query_type = @rally_objects[type]
+        query_type = @rally_objects[type.to_s]
       else
         query_type = type
       end
       type_defs_query             = RallyQuery.new()
-      type_defs_query.type        = :typedefinition
+      type_defs_query.type        = "typedefinition"
       type_defs_query.fetch       = true
       type_defs_query.query_string= "(ElementName = \"#{query_type}\")"
       type_defs = find(type_defs_query)
@@ -324,10 +324,11 @@ module RallyAPI
     end
 
     def check_type(type_name)
-      if @rally_objects[type_name].nil?
+      type = @rally_objects[type_name.to_s]
+      if type.nil?
         raise StandardError, "The object type #{type_name} is not valid for the wsapi"
       end
-      @rally_objects[type_name].gsub(" ", "")   #for wsapi no space is expected
+      type.gsub(" ", "")   #for wsapi no space is expected
     end
 
     #ref should be like https://rally1.rallydev.com/slm/webservice/1.25/defect/12345.js
@@ -353,7 +354,7 @@ module RallyAPI
 
     def ref_by_formatted_id(type, fid)
       query = RallyQuery.new()
-      query.type          = type.downcase.to_sym
+      query.type          = type.downcase
       query.query_string  = "(FormattedID = #{fid})"
       query.limit         = 20
       query.fetch         = "FormattedID"
@@ -378,32 +379,29 @@ module RallyAPI
       fields
     end
 
-
     def cache_rally_objects()
       type_defs_query = RallyQuery.new()
-      type_defs_query.type = :typedefinition
+      type_defs_query.type = "typedefinition"
       type_defs_query.fetch = "Name,Parent,TypePath"
       type_defs_query.workspace = @rally_default_workspace unless @rally_default_workspace.nil?
 
       type_defs = find(type_defs_query)
       type_defs.each do |td|
-        type_sym = td.Name.downcase.gsub(" ", "").to_sym
-        url_path = td.TypePath.nil? ? td.Name : td.TypePath
-        @rally_objects[type_sym] = url_path
+        url_path = td.TypePath.nil? ? td.ElementName : td.TypePath
+        @rally_objects[url_path.downcase] = url_path
 
         parent_type = td.Parent
-        if !parent_type.nil? && (@rally_objects[parent_type.Name].nil?)
-          url_path = parent_type.TypePath.nil? ? parent_type.Name : parent_type.TypePath
-          @rally_objects[parent_type.Name.downcase.gsub(" ", "").to_sym] = url_path
+        if !parent_type.nil? && (@rally_objects[parent_type.TypePath].nil?)
+          url_path = parent_type.TypePath.nil? ? parent_type.ElementName : parent_type.TypePath
+          @rally_objects[url_path.downcase] = url_path
         end
       end
 
       #some convenience keys to help people - someday we'll fix the api and make HR called story
-      @rally_objects[:useriterationcapacity]  = "User Iteration Capacity"
-      @rally_objects[:userpermission]         = "User Permission"
-      @rally_objects[:story]                  = "Hierarchical Requirement"
-      @rally_objects[:userstory]              = "Hierarchical Requirement"
-
+      @rally_objects["useriterationcapacity"]  = "User Iteration Capacity"
+      @rally_objects["userpermission"]         = "User Permission"
+      @rally_objects["story"]                  = "Hierarchical Requirement"
+      @rally_objects["userstory"]              = "Hierarchical Requirement"
     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.7.2"
+  VERSION = "0.7.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rally_api
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000Z
+date: 2012-10-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70183353654620 !ruby/object:Gem::Requirement
+  requirement: &70253413466180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *70183353654620
+  version_requirements: *70253413466180
 description: API wrapper for Rally's JSON REST web services api
 email:
 - dsmith@rallydev.com