rally_api 0.7.0 → 0.7.1

data/README.rdoc

@@ -18,6 +18,9 @@ RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-clien
     headers.vendor = "MyCompany"
     headers.version = "1.0"
 
+    #or one line custom header
+    headers = RallyAPI::CustomHttpHeader.new({:vendor => "Vendor", :name => "Custom Name", :version => "1.0"})
+
     config = {:base_url => "https://rally1.rallydev.com/slm"}
     config[:username]   = "user@company.com"
     config[:password]   = "password"
@@ -105,6 +108,8 @@ RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-clien
     #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)
+    story1.rank_to_bottom
+    story1.rank_to_top
 
 == License/Meta
 Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

data/lib/rally_api/custom_http_header.rb

@@ -5,6 +5,10 @@
 
 require_relative "version"
 
+#custom headers help Rally identify the integration you have written
+#  You can make custom headers by:
+#  ch = RallyAPI::CustomHttpHeader.new({:name => "CustomRoobyTool", :vendor => "acme inc", :version => "1.0"})
+#  or by calling with no hash in the arguments and setting ch.name, ch.vendor, and ch.version
 module RallyAPI
 
   class CustomHttpHeader
@@ -14,11 +18,17 @@ module RallyAPI
     HTTP_HEADER_FIELDS = [:name, :vendor, :version, :library, :platform, :os]
     HTTP_HEADER_PREFIX = 'X-RallyIntegration'
 
-    def initialize
+    def initialize(custom_vals = {})
       @os = RUBY_PLATFORM
       @platform = "Ruby #{RUBY_VERSION}"
-      @library = "RallyRestJson version #{VERSION}"
+      @library = "RallyRestJson version #{RallyAPI::VERSION}"
       @name = "RallyRestJson"
+
+      if custom_vals.keys.length > 0
+        @name    = custom_vals[:name]
+        @version = custom_vals[:version]
+        @vendor  = custom_vals[:vendor]
+      end
     end
 
     def headers

data/lib/rally_api/rally_json_connection.rb

@@ -16,6 +16,7 @@ module RallyAPI
     DEFAULT_PAGE_SIZE = 200
 
     attr_accessor :rally_headers, :low_debug, :logger
+    attr_reader :find_threads, :rally_http_client
 
     def initialize(headers, low_debug, proxy_info)
       @rally_headers = headers
@@ -25,6 +26,7 @@ module RallyAPI
       @rally_http_client = HTTPClient.new
       @rally_http_client.receive_timeout = 300
       @rally_http_client.send_timeout    = 300
+      @rally_http_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
       @rally_http_client.transparent_gzip_decompression = true
 
       #passed in proxy setup overrides env level proxy
@@ -33,12 +35,26 @@ module RallyAPI
         @rally_http_client.proxy = env_proxy
       end
       @rally_http_client.proxy = proxy_info unless !proxy_info.nil?
+
+      @find_threads = 4
     end
 
     def set_client_user(base_url, user, password)
       @rally_http_client.set_basic_auth(base_url, user, password)
     end
 
+    def set_ssl_verify_mode(mode = OpenSSL::SSL::VERIFY_NONE)
+      @rally_http_client.ssl_config.verify_mode = mode
+    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
+      num_threads = 4 if num_threads > 4
+      num_threads = 1 if num_threads < 1
+      @find_threads = num_threads
+    end
+
     def get_all_json_results(url, args, query_params, limit = 99999)
       all_results = []
       args[:method] = :get
@@ -104,7 +120,7 @@ module RallyAPI
     private
 
     def run_threads(query_array)
-      num_threads = 4
+      num_threads = @find_threads
       thr_queries = []
       (0...num_threads).each { |ind| thr_queries[ind] = [] }
       query_array.each { |query| thr_queries[query[:page_num] % num_threads].push(query) }

data/lib/rally_api/rally_object.rb

@@ -54,11 +54,23 @@ module RallyAPI
     end
 
     def rank_above(relative_rally_object)
-      @rally_rest.rank_above(@rally_object["_ref"],relative_rally_object["_ref"])
+      @rally_object = @rally_rest.rank_above(@rally_object["_ref"],relative_rally_object["_ref"]).rally_object
+      self
     end
 
     def rank_below(relative_rally_object)
-      @rally_rest.rank_below(@rally_object["_ref"],relative_rally_object["_ref"])
+      @rally_object = @rally_rest.rank_below(@rally_object["_ref"],relative_rally_object["_ref"]).rally_object
+      self
+    end
+
+    def rank_to_bottom
+      @rally_object = @rally_rest.rank_to(@rally_object["_ref"], "BOTTOM").rally_object
+      self
+    end
+
+    def rank_to_top
+      @rally_object = @rally_rest.rank_to(@rally_object["_ref"], "TOP").rally_object
+      self
     end
 
     def delete()

data/lib/rally_api/rally_rest_json.rb

@@ -47,10 +47,10 @@ module RallyAPI
     DEFAULT_WSAPI_VERSION = "1.37"
 
     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_headers, :rally_default_workspace, :rally_default_project, :low_debug, :proxy_info
     attr_accessor :rally_rest_api_compat, :logger
 
-    attr_reader   :rally_objects
+    attr_reader   :rally_connection, :rally_objects
 
     def initialize(args)
       @rally_url            = args[:base_url] || "https://rally1.rallydev.com/slm"
@@ -61,7 +61,7 @@ module RallyAPI
       @wsapi_version        = args[:version]  || DEFAULT_WSAPI_VERSION
       @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
@@ -70,7 +70,6 @@ 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.retries = @retries if @retries > 0
 
       @rally_objects = { :typedefinition => "TypeDefinition" }
       cache_rally_objects()
@@ -233,6 +232,10 @@ module RallyAPI
       RallyQueryResult.new(self, json_response)
     end
 
+    def adjust_find_threads(num_threads)
+      @rally_connection.set_find_threads(num_threads)
+    end
+
     #rankAbove=%2Fhierarchicalrequirement%2F4624552599
     #{"hierarchicalrequirement":{"_ref":"https://rally1.rallydev.com/slm/webservice/1.27/hierarchicalrequirement/4616818613.js"}}
     def rank_above(ref_to_rank, relative_ref)
@@ -255,7 +258,17 @@ module RallyAPI
       params[:fetch] = "true"
       json_update = { get_type_from_ref(ref_to_rank) => {"_ref" => ref_to_rank} }
       args = { :method => :put, :payload => json_update }
-      #update = @rally_connection.put_object(ref, args, params, json_update)
+      update = @rally_connection.send_request(ref, args, params)
+      RallyObject.new(self, update["OperationResult"]["Object"])
+    end
+
+    def rank_to(ref_to_rank, location = "TOP")
+      ref = ref_to_rank
+      params = {}
+      params[:rankTo] = location
+      params[:fetch]  = "true"
+      json_update = { get_type_from_ref(ref_to_rank) => {"_ref" => ref_to_rank} }
+      args = { :method => :put, :payload => json_update }
       update = @rally_connection.send_request(ref, args, params)
       RallyObject.new(self, update["OperationResult"]["Object"])
     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.0"
+  VERSION = "0.7.1"
 end

metadata

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