rally_api 0.4.1 → 0.5.0

data/README.rdoc

@@ -1,102 +1,113 @@
-RallyAPI (rally_api)
+= RallyAPI (rally_api) -- a faster Rally REST api wrapper
 
-==Description
+== Description
 
-RallyAPI is a wrapper of Rally's Web Service API Json endpoints
+RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-client and native json parsing
 
 == Installation
-
-gem install rest-client
-gem install json
-gem install rally_api
-
-** Note if you are on Windows - you will need DevKit from http://rubyinstaller.org to properly install the json gem
-**  - that native compiled parsing gives us some speed.
-**  - Follow the instructions here to install DevKit:  https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
+    gem install rally_api
 
 == Usage
 
-require 'rally_api'
-
-#Setting custom headers
-headers = RallyAPI::CustomHttpHeader.new()
-headers.name = "My Utility"
-headers.vendor = "MyCompany"
-headers.version = "1.0"
-
-#==================== Making a connection to Rally ====================
-config = {:base_url => "https://rally1.rallydev.com/slm"}
-config[:username]   = "user@company.com"
-config[:password]   = "password"
-config[:workspace]  = "Workspace Name"
-config[:project]    = "Project Name"
-config[:headers]    = headers #from RallyAPI::CustomHttpHeader.new()
-
-@rally = RallyAPI::RallyRestJson.new(config)
-
-#==================== Querying Rally ==========================
-test_query = RallyAPI::RallyQuery.new()
-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
-test_query.page_size = 200       #optional - default is 200
-test_query.limit = 1000          #optional - default is 99999
-test_query.project_scope_up = false
-test_query.project_scope_down = true
-test_query.order = "Name Asc"
-test_query.query_string = "(Severity = \"High\")"
-
-results = @rally.find(test_query)
-
-#tip - set the fetch string of the query to the fields you need -
-#only resort to the read method if you want your code to be slow
-results.each do |defect|
-  puts defect.Name
-  defect.read    #read the whole defect from Rally to get all fields (eg Severity)
-  puts defect.Severity
-end
-
-#==================== Reading an Artifact ====================
-defect = @rally.read(:defect, 12345)      #by ObjectID
-#or
-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
-defect.read
-
-puts defect["Name"]
-#or - fields can be read by bracket artifact["FieldDisplayName"] or artifact.FieldDisplayName
-puts defect.Name
-
-#An Important note about reading fields and fetching:
-#If you query with a specific fetch string, for example query defect and fetch Name,Severity,Description
-#You will *only* get back those fields defect.Priority will be nil, but may not be null in Rally
-#Use object.read or @rally.read to make sure you read the whole object if you want what is in Rally
-#  This is done for speed - lazy loading (going back to get a value from Rally) can be unneccessarily slow
-#  *Pick you fetch strings wisely* fetch everything you need and don't rely on read if you don't need it the speed is worth it.
-
-#==================== Creating an Artifact ====================
-obj = {}
-obj["Name"] = "Test Defect created #{DateTime.now()}"
-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
-#or
-updated_defect = @rally.update(:defect, "FormattedID|DE42", fields)   #by FormattedID
-# or
-defect = @rally.read(:defect, 12345)      #by lookup then udpating via the object
-field_updates = {"Description" => "Changed Description"}
-defect.update(field_updates)
-
-
-#== License
+=== Making a connection to Rally
+    require 'rally_api'
+
+    #Setting custom headers
+    headers = RallyAPI::CustomHttpHeader.new()
+    headers.name = "My Utility"
+    headers.vendor = "MyCompany"
+    headers.version = "1.0"
+
+    config = {:base_url => "https://rally1.rallydev.com/slm"}
+    config[:username]   = "user@company.com"
+    config[:password]   = "password"
+    config[:workspace]  = "Workspace Name"
+    config[:project]    = "Project Name"
+    config[:headers]    = headers #from RallyAPI::CustomHttpHeader.new()
+
+    @rally = RallyAPI::RallyRestJson.new(config)
+
+
+=== Querying Rally
+    test_query = RallyAPI::RallyQuery.new()
+    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
+    test_query.page_size = 200       #optional - default is 200
+    test_query.limit = 1000          #optional - default is 99999
+    test_query.project_scope_up = false
+    test_query.project_scope_down = true
+    test_query.order = "Name Asc"
+    test_query.query_string = "(Severity = \"High\")"
+
+    results = @rally.find(test_query)
+
+    #tip - set the fetch string of the query to the fields you need -
+    #only resort to the read method if you want your code to be slow
+    results.each do |defect|
+      puts defect.Name   # or defect["Name"]
+      defect.read    #read the whole defect from Rally to get all fields (eg Severity)
+      puts defect.Severity
+    end
+
+    #for people comfortable passing around blocks:
+    results = @rally.find do |q|
+        q.type = :defect
+        q.fetch = "Name,FormattedID"
+        q.query_string = "(Priority = \"Low\")"
+    end
+
+
+=== Reading an Artifact
+    defect = @rally.read(:defect, 12345)      #by ObjectID
+    #or
+    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
+    defect.read
+
+    puts defect["Name"]
+    #or - fields can be read by bracket artifact["FieldDisplayName"] or artifact.FieldDisplayName
+    puts defect.Name
+
+    #An Important note about reading fields and fetching:
+    #If you query with a specific fetch string, for example query defect and fetch Name,Severity,Description
+    #You will *only* get back those fields defect.Priority will be nil, but may not be null in Rally
+    #Use object.read or @rally.read to make sure you read the whole object if you want what is in Rally
+    #  This is done for speed - lazy loading (going back to get a value from Rally) can be unneccessarily slow
+    #  *Pick you fetch strings wisely* fetch everything you need and don't rely on read if you don't need it the speed is worth it.
+
+=== Creating an Artifact
+    obj = {}
+    obj["Name"] = "Test Defect created #{DateTime.now()}"
+    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
+    #or
+    updated_defect = @rally.update(:defect, "FormattedID|DE42", fields)   #by FormattedID
+    # or
+    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")
+
+    #re-ranking:  rank_above and rank_below
+    story1.rank_above(story2)   #in a drag and drop workspace move story1 relative to story2
+    story1.rank_below(story2)
+
+#== License/Meta
+#Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
 #Copyright (c) 2002-2011 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

data/lib/rally_api/{time_machine_query.rb → lookback_api_query.rb}

@@ -1,39 +1,34 @@
+# :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
     # query is like:
     # query_hash = {}
-    # query_hash[:type] = Defect, Story, etc
-    # query_hash[:query_string] = "(State = \"Closed\")"
-    # query_hash[:fetch] = "Name,State,etc"
-    # query_hash[:workspace] = workspace json object or ref  #defaults to workspace passed in RallyRestJson.new if nil
-    # query_hash[:project] = project json object or ref      #defaults to project passed in RallyRestJson.new if nil
-    # query_hash[:project_scope_up] = true/false
-    # query_hash[:project_scope_down] = true/false
-    # query_hash[:order] = "ObjectID asc"
-    # query_hash[:page_size]
-    # query_hash[:stopafter]
-
-  class TimeMachineQuery
-    attr_accessor :workspace
+    # query_hash["find"] = { some json for a query} or true
+    # query_hash["fields"] = ["State", "PlanEstimate"]
+    # query_hash["pagesize"] = 1000
+    # query_hash["sort"] = { _id: 1 }
+    # query_hash["workspace"] = workspace oid for query uri
+
+  #query info is the master hash instead of a bunch of instance variables
+  class LookbackAPIQuery
+    attr_accessor :query_info
 
     def initialize(query_hash = nil)
+      @query_info = nil
       parse_query_hash(query_hash) if !query_hash.nil?
       self
     end
 
     def make_query_params
       query_params = {}
-      #query_params[:query]            = @query_string
-      #query_params[:fetch]            = @fetch
-      query_params[:workspace]        = @workspace["_ref"] if !@workspace.nil?
-      #query_params[:project]          = @project["_ref"] if !@project.nil?
-      #query_params[:projectScopeUp]   = @project_scope_up
-      #query_params[:projectScopeDown] = @project_scope_down
-      #query_params[:order]            = @order
-      #query_params[:pagesize]         = @page_size
+      query_params[:find]      = @query_string
+      query_params[:workspace]  = @workspace["_ref"] if !@workspace.nil?
+      query
 
       query_params
     end

data/lib/rally_api/rally_json_connection.rb

@@ -1,10 +1,13 @@
 require 'rest_client'
 require 'json'
 
+# :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
 
 
@@ -169,13 +172,13 @@ module RallyAPI
           @retry_list[req.url] += 1
           retry
         end
-        raise msg
+        raise StandardError, msg
       end
       @retry_list.delete(req.url)
       puts response if @low_debug
       json_obj = JSON.parse(response.body)   #todo handle null post error
       errs = check_for_errors(json_obj)
-      raise "\nError on request - #{url} - \n#{errs}" if errs[:errors].length > 0
+      raise StandardError, "\nError on request - #{url} - \n#{errs}" if errs[:errors].length > 0
       json_obj
     end
 

data/lib/rally_api/rally_object.rb

@@ -1,9 +1,18 @@
+# :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
 
+  #todo add rankTo bottom and top
+  #https://trial.rallydev.com/slm/webservice/x/defect/oid.js?rankTo=BOTTOM
+  #https://trial.rallydev.com/slm/webservice/x/defect/oid.js?rankTo=TOP
+
+  # RallyObject is a helper class that wraps the JSON.parsed hash
+  #
   class RallyObject
 
     attr_reader :rally_object
@@ -37,6 +46,10 @@ module RallyAPI
     end
 
     def getref
+      ref
+    end
+
+    def ref
       @rally_object["_ref"]
     end
 
@@ -54,22 +67,16 @@ module RallyAPI
 
     private
 
+    # An attempt to be rally_rest_api user friendly -
+    # you can get a field the old way with an underscored field name or the upcase name
     def method_missing(sym, *args)
-      get_val(sym.to_s)
+      ret_val = get_val(sym.to_s)
+      if @rally_rest.rally_rest_api_compat && ret_val.nil?
+        ret_val = get_val(camel_case_word(:sym))
+      end
+      ret_val
     end
 
-    #the magic of lazy loading is gone
-    #def method_missing(sym, *args)
-    #  return_val = get_val(sym.to_s)
-    #
-    #  if return_val.nil?
-    #    @rally_object = @rally_rest.reread(@rally_object)
-    #    return_val = get_val(sym.to_s)
-    #  end
-    #
-    #  return_val
-    #end
-
     def get_val(field)
       return_val = @rally_object[field]
 
@@ -93,6 +100,11 @@ 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

@@ -1,20 +1,28 @@
+# :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
-    # query is like:
-    # query_hash = {}
-    # query_hash[:type] = Defect, Story, etc
-    # query_hash[:query_string] = "(State = \"Closed\")"
-    # query_hash[:fetch] = "Name,State,etc"
-    # query_hash[:workspace] = workspace json object or ref  #defaults to workspace passed in RallyRestJson.new if nil
-    # query_hash[:project] = project json object or ref      #defaults to project passed in RallyRestJson.new if nil
-    # query_hash[:project_scope_up] = true/false
-    # query_hash[:project_scope_down] = true/false
-    # query_hash[:order] = "ObjectID asc"
-    # query_hash[:page_size]
-    # query_hash[:stopafter]
+
+# ===RallyAPI::RallyQuery - A helper class for making queries to Rally's REST API
+# Example:
+# new_query = RallyAPI::RallyQuery.new() and set query properties as needed
+#   --- or ---
+# new_query = RallyAPI::RallyQuery.new(query_hash) with a hash of attributes<br>
+# query_hash for example can be:<br>
+# query_hash = {}  <br>
+# query_hash[:type] = Defect, Story, etc  <br>
+# query_hash[:query_string] = "(State = \"Closed\")"   <br>
+# query_hash[:fetch] = "Name,State,etc"  <br>
+# query_hash[:workspace] = workspace json object or ref  #defaults to workspace passed in RallyRestJson.new if nil <br>
+# query_hash[:project] = project json object or ref      #defaults to project passed in RallyRestJson.new if nil   <br>
+# query_hash[:project_scope_up] = true/false    <br>
+# query_hash[:project_scope_down] = true/false  <br>
+# query_hash[:order] = "ObjectID asc" <br>
+# query_hash[:page_size]  <br>
+# query_hash[:limit]     <br>
 
   class RallyQuery
     attr_accessor :type, :query_string, :fetch, :workspace, :project, :project_scope_up, :project_scope_down

data/lib/rally_api/rally_query_result.rb

@@ -1,7 +1,9 @@
+# :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 RallyQueryResult
     include Enumerable

data/lib/rally_api/rally_rest_json.rb

@@ -4,29 +4,58 @@ require_relative "rally_object"
 require_relative "rally_query"
 require_relative "rally_query_result"
 
+# --
 #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.
+# ++
+
+#todo - raise exception if ws/project is not set on create?
+
+#   -----
+#   :title:RallyAPI
+#
+#   ===Getting Started
+#   RallyAPI::RallyRestJson is the starting point for working in Ruby with Rally's REST WSAPI
+#
+#   config = {:base_url => "https://rally1.rallydev.com/slm"}
+#
+#   config[:username]   = "user@company.com"
+#
+#   config[:password]   = "password"
+#
+#   config[:workspace]  = "Workspace Name"
+#
+#   config[:project]    = "Project Name"
+#
+#   config[:headers]    = headers #from RallyAPI::CustomHttpHeader.new()
+#
+#   @rally = RallyAPI::RallyRestJson.new(config)
+
+
 module RallyAPI
 
+  #--
   #this contstant is here - a tradeoff of speed vs completeness- right now speed wins because it is so
   #expensive to query typedef and read all attributes for "OBJECT" or "COLLECTION" types
+  #++
   RALLY_REF_FIELDS = { "Subscription" => :subscription, "Workspace" => :workspace, "Project" => :project,
                        "Iteration" => :iteration, "Release" => :release, "WorkProduct" => :artifact,
                        "Requirement" => :hierarchicalrequirement, "Owner" => :user, "Tester" => :user,
                        "RevisionHistory" => :revisionhistory, "Revision" => :revision, "Revisions" => :revision,
                        "Blocker" => :artifact, "SubmittedBy" => :user, "TestCaseResult" => :testcaseresult,
-                       "TestSet" => :testset, "Parent" => :hierarchicalrequirement, "TestFolder"=> :testfolder }
-
+                       "TestSet" => :testset, "Parent" => :hierarchicalrequirement, "TestFolder"=> :testfolder,
+                       "PortfolioItemType" => :type }
 
 
-  #Main Class to create from when using the tool
+  #Main Class to instantiate when using the tool
   class RallyRestJson
-    DEFAULT_WSAPI_VERSION = "1.25"
+    DEFAULT_WSAPI_VERSION = "1.30"
 
     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, :retries
+    attr_accessor :rally_rest_api_compat
 
     attr_reader   :rally_objects
 
@@ -40,6 +69,7 @@ module RallyAPI
       @rally_headers        = args[:headers]  || CustomHttpHeader.new
       @proxy_info           = args[:proxy]
       @retries              = args[:retries] || 0
+      @rally_rest_api_compat  = args[:rally_rest_api_compat] || false
 
       @low_debug = args[:debug] || false
 
@@ -53,12 +83,12 @@ module RallyAPI
 
       if !@rally_workspace_name.nil?
         @rally_default_workspace = find_workspace(@rally_workspace_name)
-        raise "unable to find default workspace #{@rally_workspace_name}" if @rally_default_workspace.nil?
+        raise StandardError, "unable to find default workspace #{@rally_workspace_name}" if @rally_default_workspace.nil?
       end
 
       if !@rally_project_name.nil?
         @rally_default_project = find_project(@rally_default_workspace, @rally_project_name)
-        raise "unable to find default project #{@rally_project_name}" if @rally_default_project.nil?
+        raise StandardError, "unable to find default project #{@rally_project_name}" if @rally_default_project.nil?
       end
 
       self
@@ -79,7 +109,7 @@ module RallyAPI
 
     def find_project(workspace_object, project_name)
       if workspace_object.nil?
-        raise "A workspace must be provided to find a project"
+        raise StandardError, "A workspace must be provided to find a project"
       end
 
       query = RallyQuery.new()
@@ -105,8 +135,8 @@ module RallyAPI
       rally_type = check_type(type)
 
       if (fields["Workspace"].nil? && fields["Project"].nil?)
-        fields["Workspace"] = @rally_default_workspace._ref
-        fields["Project"] = @rally_default_project._ref
+        fields["Workspace"] = @rally_default_workspace._ref unless @rally_default_workspace.nil?
+        fields["Project"] = @rally_default_project._ref unless @rally_default_project.nil?
       end
 
       args = {:user => @rally_user, :password => @rally_password }
@@ -144,23 +174,40 @@ module RallyAPI
       RallyObject.new(self, reread({"_ref" => ref}))
     end
 
-    #query_hash is a has like:
-    # query_hash = {}
-    # query_hash[:type] = Defect, Story, etc
-    # query_hash[:query_string] = "(State = \"Closed\")"
-    # query_hash[:fetch] = "Name,State,etc"
-    # query_hash[:workspace] = workspace json object or ref  #defaults to workspace passed in RallyRestJson.new if nil
-    # query_hash[:project] = project json object or ref      #defaults to project passed in RallyRestJson.new if nil
-    # query_hash[:project_scope_up] = true/false
-    # query_hash[:project_scope_down] = true/false
-    # query_hash[:order] = "ObjectID asc"
-    # query_hash[:pagesize]
-    # query_hash[:stopafter]
-    #todo default workspace and project if not set?
-    def find(query_obj)
+    ##-----
+    #Querying Rally example
+    #test_query = RallyAPI::RallyQuery.new()
+    #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
+    #test_query.page_size = 200       #optional - default is 200
+    #test_query.limit = 1000          #optional - default is 99999
+    #test_query.project_scope_up = false
+    #test_query.project_scope_down = true
+    #test_query.order = "Name Asc"
+    #test_query.query_string = "(Severity = \"High\")"
+    #
+    #results = @rally.find(test_query)
+    #
+    ##tip - set the fetch string of the query to the fields you need -
+    ##only resort to the read method if you want your code to be slow
+    #results.each do |defect|
+    #  puts defect.Name   # or defect["Name"]
+    #  defect.read    #read the whole defect from Rally to get all fields (eg Severity)
+    #  puts defect.Severity
+    #end
+    #query_obj is RallyQuery
+    def find(query_obj = RallyQuery.new)
+      yield query_obj if block_given?
+
+      if query_obj.workspace.nil?
+        query_obj.workspace = @rally_default_workspace unless @rally_default_workspace.nil?
+      end
+
       errs = query_obj.validate(@rally_objects)
       if errs.length > 0
-        raise "Errors making Rally Query: #{errs.to_s}"
+        raise StandardError, "Errors making Rally Query: #{errs.to_s}"
       end
 
       query_url = make_query_url(@rally_url, @wsapi_version, check_type(query_obj.type))
@@ -195,6 +242,30 @@ module RallyAPI
       RallyObject.new(self, update["Object"])
     end
 
+    def allowed_values(type, field)
+      if type.class == Symbol
+        query_type = @rally_objects[type]
+      else
+        query_type = type
+      end
+      type_defs_query             = RallyQuery.new()
+      type_defs_query.type        = :typedefinition
+      type_defs_query.fetch       = true
+      type_defs_query.query_string= "(Name = \"#{query_type}\")"
+      type_defs = find(type_defs_query)
+
+      allowed_vals = {}
+      type_defs[0]["Attributes"].each do |attr|
+        next if attr["ElementName"] != field
+        attr["AllowedValues"].each do |val_ref|
+          val = val_ref["StringValue"]
+          val = "Null" if val.nil? || val.empty?
+          allowed_vals[val] = true
+        end
+      end
+      allowed_vals
+    end
+
     private
 
     def make_get_url(type)
@@ -220,9 +291,9 @@ module RallyAPI
 
     def check_type(type_name)
       if @rally_objects[type_name].nil?
-        raise "The object type #{type_name} is not valid for the wsapi"
+        raise StandardError, "The object type #{type_name} is not valid for the wsapi"
       end
-      @rally_objects[type_name]
+      @rally_objects[type_name].gsub(" ", "")   #for wsapi no space is expected
     end
 
     #ref should be like https://rally1.rallydev.com/slm/webservice/1.25/defect/12345.js
@@ -282,16 +353,16 @@ module RallyAPI
       type_defs = find(type_defs_query)
       type_defs.each do |td|
         type_sym = td.Name.downcase.gsub(" ", "").to_sym
-        @rally_objects[type_sym] = td.Name.gsub(" ","")
+        @rally_objects[type_sym] = td.Name
       end
 
       #some convenience keys to help people - someday we'll fix the api and make HR called story
       @rally_objects[:artifact]               = "Artifact"
-      @rally_objects[:persistableobject]      = "PersistableObject"
-      @rally_objects[:useriterationcapacity]  = "UserIterationCapacity"
-      @rally_objects[:userpermission]         = "UserPermission"
-      @rally_objects[:story]                  = "HierarchicalRequirement"
-      @rally_objects[:userstory]              = "HierarchicalRequirement"
+      @rally_objects[:persistableobject]      = "Persistable Object"
+      @rally_objects[:useriterationcapacity]  = "User Iteration Capacity"
+      @rally_objects[:userpermission]         = "User Permission"
+      @rally_objects[:story]                  = "Hierarchical Requirement"
+      @rally_objects[:userstory]              = "Hierarchical Requirement"
 
     end
 

data/lib/rally_api/version.rb

@@ -1,7 +1,8 @@
+# :nodoc:
 #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.
 module RallyAPI
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rally_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000Z
+date: 2012-06-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70105132306080 !ruby/object:Gem::Requirement
+  requirement: &70134702100760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70105132306080
+  version_requirements: *70134702100760
 description: API wrapper for Rally's JSON REST web services api
 email:
 - dsmith@rallydev.com
@@ -32,12 +32,12 @@ files:
 - README.rdoc
 - Rakefile
 - lib/rally_api/custom_http_header.rb
+- lib/rally_api/lookback_api_query.rb
 - lib/rally_api/rally_json_connection.rb
 - lib/rally_api/rally_object.rb
 - lib/rally_api/rally_query.rb
 - lib/rally_api/rally_query_result.rb
 - lib/rally_api/rally_rest_json.rb
-- lib/rally_api/time_machine_query.rb
 - lib/rally_api/version.rb
 - lib/rally_api.rb
 homepage: http://developer.rallydev.com/help