rally_api 0.5.0 → 0.5.1

data/lib/rally_api/rally_json_connection.rb

@@ -15,11 +15,13 @@ module RallyAPI
 
     DEFAULT_PAGE_SIZE = 200
 
-    attr_accessor :rally_headers, :retries, :retry_list
+    attr_accessor :rally_headers, :retries, :retry_list, :low_debug, :logger
 
     def initialize(headers, low_debug, proxy_info)
       @rally_headers = headers
       @low_debug = low_debug
+      @logger = nil
+
       @retries = 0
       @retry_list = {}
 
@@ -36,7 +38,7 @@ module RallyAPI
     def read_object(url, args, params = nil)
       args[:method] = :get
       result = send_json_request(url, args, params)
-      puts result if @low_debug
+      log_info(result) if @low_debug
       rally_type = result.keys[0]
       result[rally_type]
     end
@@ -45,9 +47,9 @@ module RallyAPI
       args[:method] = :post
       text_json = rally_object.to_json
       args[:payload] = text_json
-      puts "payload json: #{text_json}" if @low_debug
+      log_info("create - payload json: #{text_json}") if @low_debug
       result = send_json_request(url, args)
-      puts result if @low_debug
+      log_info("create - result: #{result}") if @low_debug
       result["CreateResult"]["Object"]
     end
 
@@ -55,9 +57,9 @@ module RallyAPI
       args[:method] = :post
       text_json = rally_fields.to_json
       args[:payload] = text_json
-      puts "payload json: #{text_json}" if @low_debug
+      log_info("update payload json: #{text_json}") if @low_debug
       result = send_json_request(url, args)
-      puts result if @low_debug
+      log_info("update - result: #{result}") if @low_debug
       result["OperationResult"]
     end
 
@@ -72,7 +74,7 @@ module RallyAPI
     def delete_object(url,args)
       args[:method] = :delete
       result = send_json_request(url,args)
-      puts result if @low_debug
+      log_info("delete result - #{result}") if @low_debug
       result["OperationResult"]
     end
 
@@ -160,11 +162,11 @@ module RallyAPI
 
       begin
         req = RestClient::Request.new(request_args)
-        puts req.url if @low_debug
+        log_info(req.url) if @low_debug
         response = req.execute
       rescue => ex
         msg =  "Rally Rest Json: - rescued exception - #{ex.message} on request to #{url} with params #{url_params}"
-        puts msg
+        log_info(msg)
         if !@retry_list.has_key?(req.url)
           @retry_list[req.url] = 0
         end
@@ -175,13 +177,17 @@ module RallyAPI
         raise StandardError, msg
       end
       @retry_list.delete(req.url)
-      puts response if @low_debug
+      log_info(response) if @low_debug
       json_obj = JSON.parse(response.body)   #todo handle null post error
       errs = check_for_errors(json_obj)
       raise StandardError, "\nError on request - #{url} - \n#{errs}" if errs[:errors].length > 0
       json_obj
     end
 
+    def log_info(message)
+      puts message
+      @logger.debug(message) unless @logger.nil?
+    end
 
     def check_for_errors(result)
       errors = []

data/lib/rally_api/rally_rest_json.rb

@@ -18,19 +18,12 @@ require_relative "rally_query_result"
 #
 #   ===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)
 
 
@@ -55,7 +48,7 @@ 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, :retries
-    attr_accessor :rally_rest_api_compat
+    attr_accessor :rally_rest_api_compat, :logger
 
     attr_reader   :rally_objects
 
@@ -71,12 +64,12 @@ module RallyAPI
       @retries              = args[:retries] || 0
       @rally_rest_api_compat  = args[:rally_rest_api_compat] || false
 
-      @low_debug = args[:debug] || false
+      @low_debug = args[:debug]  || false
+      @logger    = args[:logger] || nil    #assumes this is an instance of Logger
 
       @rally_connection = RallyJsonConnection.new(@rally_headers, @low_debug, @proxy_info)
-      if @retries > 0
-        @rally_connection.retries = @retries
-      end
+      @rally_connection.logger  = @logger unless @logger.nil?
+      @rally_connection.retries = @retries if @retries > 0
 
       @rally_objects = { :typedefinition => "TypeDefinition" }
       cache_rally_objects()
@@ -94,6 +87,16 @@ module RallyAPI
       self
     end
 
+    def debug_logging_on
+      @low_debug = true
+      @rally_connection.low_debug = true
+    end
+
+    def debug_logging_off
+      @low_debug = false
+      @rally_connection.low_debug = false
+    end
+
     def find_workspace(workspace_name)
       sub = self.user["Subscription"].read({:fetch => "Workspaces,Name,State"})
       workspace = nil

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.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rally_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-28 00:00:00.000000000Z
+date: 2012-08-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70134702100760 !ruby/object:Gem::Requirement
+  requirement: &70123374137900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70134702100760
+  version_requirements: *70123374137900
 description: API wrapper for Rally's JSON REST web services api
 email:
 - dsmith@rallydev.com
@@ -40,7 +40,7 @@ files:
 - lib/rally_api/rally_rest_json.rb
 - lib/rally_api/version.rb
 - lib/rally_api.rb
-homepage: http://developer.rallydev.com/help
+homepage: https://github.com/RallyTools/RallyRestToolkitForRuby
 licenses: []
 post_install_message: 
 rdoc_options: []