rally_api 0.9.6 → 0.9.7

data/lib/rally_api/custom_http_header.rb

@@ -23,7 +23,7 @@ module RallyAPI
       @name = "RallyRestJsonRuby"
 
       if custom_vals.keys.length > 0
-        @name    = custom_vals[:name]
+        @name    = custom_vals[:name]     unless custom_vals[:name].nil?
         @version = custom_vals[:version]
         @vendor  = custom_vals[:vendor]
       end

data/lib/rally_api/rally_json_connection.rb

@@ -29,6 +29,7 @@ module RallyAPI
       @rally_http_client.send_timeout    = 300
       @rally_http_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
       @rally_http_client.transparent_gzip_decompression = true
+      #@rally_http_client.debug_dev = STDOUT
 
       #passed in proxy setup overrides env level proxy
       env_proxy = ENV["http_proxy"]
@@ -48,6 +49,23 @@ module RallyAPI
       @rally_http_client.ssl_config.verify_mode = mode
     end
 
+    #[]todo - handle token expiration more gracefully  - eg handle renewing
+    def setup_security_token(security_url)
+      reset_cookies
+      begin
+        json_response = send_request(security_url, { :method => :get })
+        @security_token = json_response[json_response.keys[0]]["SecurityToken"]
+      rescue StandardError => ex
+        raise unless ex.message.include?("RallyAPI - HTTP-404") #for on-prem not on wsapi 2.x
+      end
+      true
+    end
+
+    #may be needed for session issues
+    def reset_cookies
+      @rally_http_client.cookie_manager.cookies = []
+    end
+
     #you can have any number you want as long as it is between 1 and 4
     def set_find_threads(num_threads = 2)
       return if num_threads.class != Fixnum
@@ -88,10 +106,11 @@ module RallyAPI
     end
 
     #args should have :method
-    def send_request(url, args, url_params = nil)
+    def send_request(url, args, url_params = {})
       method = args[:method]
       req_args = {}
-      req_args[:query] = url_params unless url_params.nil?
+      url_params[:key] = @security_token unless @security_token.nil?
+      req_args[:query] = url_params if url_params.keys.length > 0
 
       req_headers = @rally_headers.headers
       if (args[:method] == :post) || (args[:method] == :put)
@@ -103,7 +122,7 @@ module RallyAPI
       req_args[:header] = req_headers
 
       begin
-        log_info("Rally API calling #{method} - #{url} with #{req_args}")
+        log_info("Rally API calling #{method} - #{url} with #{req_args}\n With cookies: #{@rally_http_client.cookie_manager.cookies}")
         response = @rally_http_client.request(method, url, req_args)
       rescue Exception => ex
         msg =  "RallyAPI: - rescued exception - #{ex.message} on request to #{url} with params #{url_params}"
@@ -113,7 +132,7 @@ module RallyAPI
 
       log_info("RallyAPI response was - #{response.inspect}")
       if response.status_code != 200
-        msg = "RallyAPI - An issue occurred (HTTP-#{response.status_code}) on request - #{url}."
+        msg = "RallyAPI - HTTP-#{response.status_code} on request - #{url}."
         msg << "\nResponse was: #{response.body}"
         raise StandardError, msg
       end
@@ -128,14 +147,14 @@ module RallyAPI
       errors = []
       warnings = []
       if !result["OperationResult"].nil?
-        errors    = result["OperationResult"]["Errors"]
-        warnings  = result["OperationResult"]["Warnings"]
+        errors    = result["OperationResult"]["Errors"] || []
+        warnings  = result["OperationResult"]["Warnings"] || []
       elsif !result["QueryResult"].nil?
-        errors    = result["QueryResult"]["Errors"]
-        warnings  = result["QueryResult"]["Warnings"]
+        errors    = result["QueryResult"]["Errors"] || []
+        warnings  = result["QueryResult"]["Warnings"] || []
       elsif !result["CreateResult"].nil?
-        errors    = result["CreateResult"]["Errors"]
-        warnings  = result["CreateResult"]["Warnings"]
+        errors    = result["CreateResult"]["Errors"] || []
+        warnings  = result["CreateResult"]["Warnings"] || []
       end
       {:errors => errors, :warnings => warnings}
     end

data/lib/rally_api/rally_object.rb

@@ -20,7 +20,7 @@ module RallyAPI
       @warnings = warnings[:warnings]
     end
 
-    def update(fields, params = nil)
+    def update(fields, params = {})
       oid = @rally_object["ObjectID"] || @rally_object["_ref"].split("/")[-1].split(".")[0]
       @rally_object = @rally_rest.update(@type.downcase.to_sym, oid, fields, params).rally_object
     end

data/lib/rally_api/rally_rest_json.rb

@@ -30,8 +30,8 @@
 module RallyAPI
 
   #--
-  #this contstant is here as 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
+  #This constant is here as a trade off 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,
@@ -44,11 +44,11 @@ module RallyAPI
 
   #Main Class to instantiate when using the tool
   class RallyRestJson
-    DEFAULT_WSAPI_VERSION = "1.39"
+    DEFAULT_WSAPI_VERSION = "1.42"
 
-    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_accessor :rally_url, :rally_user, :rally_password, :rally_workspace_name, :rally_project_name, :wsapi_version,
+                  :rally_headers, :rally_default_workspace, :rally_default_project, :low_debug, :proxy_info,
+                  :rally_rest_api_compat, :logger, :rally_alias_types
     attr_reader   :rally_connection
 
     def initialize(args)
@@ -72,6 +72,7 @@ module RallyAPI
       @rally_connection = RallyJsonConnection.new(@rally_headers, @low_debug, @proxy_info)
       @rally_connection.set_client_user(@rally_url, @rally_user, @rally_password)
       @rally_connection.logger  = @logger unless @logger.nil?
+      @rally_connection.setup_security_token(security_url)
 
       if !@rally_workspace_name.nil?
         @rally_default_workspace = find_workspace(@rally_workspace_name)
@@ -133,7 +134,6 @@ module RallyAPI
       RallyObject.new(self, json_response[rally_type], warnings(json_response))
     end
 
-
     def create(type, fields, params = {})
       type = check_type(type)
       if (fields["Workspace"].nil? && fields["Project"].nil?)
@@ -183,7 +183,7 @@ module RallyAPI
       json_response[rally_type]
     end
 
-    def update(type, obj_id, fields, params = nil)
+    def update(type, obj_id, fields, params = {})
       type = check_type(type)
       ref = check_id(type.to_s, obj_id)
       fields = RallyAPI::RallyRestJson.fix_case(fields) if @rally_rest_api_compat
@@ -322,6 +322,10 @@ module RallyAPI
       "#{@rally_url}/webservice/#{@wsapi_version}/#{type}.js"
     end
 
+    def security_url
+      "#{@rally_url}/webservice/#{@wsapi_version}/security/authorize.js"
+    end
+
     def make_read_url(type,oid)
       "#{@rally_url}/webservice/#{@wsapi_version}/#{type}/#{oid}.js"
     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.9.6"
+  VERSION = "0.9.7"
 end

metadata

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