rally_api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f088541d07551f9eeaaa0f67d0d041c051e9cb9d
-  data.tar.gz: 08086c868c3bd8a2c64a5676bdea99ec8aa9be8b
+  metadata.gz: ea0a19168c476d4b65823670994a6d071f565dea
+  data.tar.gz: 16f577b50c4f35b6eb1a6a76489c39bca5762e5c
 SHA512:
-  metadata.gz: 82c225cf0621301ab0e218e639bc6f6cafb16f680b391adc089900991f5f2a51b076a944967c2de48fbcec43d90ca6b73d76ecd2bcc719d22f1b843c231462a0
-  data.tar.gz: d3da317367171bb40b9c42262dc91d118f4a483b9c8f594a2a87ea598a965a445ab605ec1b07e97116331a416a0a941f04a64156e8b094ca3d9b50a2ea0dca2f
+  metadata.gz: e913f261c487f443dfacf0afb7996c914a64a76ce82d44645fffa36a52214e7d1cc828bf14b01284bae26dcba7f956e38cd4f9a363f6d67f907dd58b6334a079
+  data.tar.gz: cd9c6b9c511c777f9a239c08211115dd4a16178f2ceae0a8110c28639b6a0c00eceb2ab230ca9063ae5a563947e801c7860819e44a8f3af5f0a72a7e9363898f

data/README.md

@@ -56,6 +56,10 @@ Making a connection to Rally
     config[:headers]    = headers #from RallyAPI::CustomHttpHeader.new()
 
 
+#### User Authentication
+A Rally API Key can be used for user authentication. If an API Key is provided, the username and password are ignored. (This is true even if the API Key is invalid, blank, or nil.)
+
+
 ### Querying Rally
 
     #type names are stored in rally.rally_objects hash, you can inspect there for a list
@@ -141,3 +145,9 @@ Making a connection to Rally
     story1.rank_below(story2)
     story1.rank_to_bottom
     story1.rank_to_top
+
+### Revision History
+    Version 1.1.0 (September 2014) - Appends workspace to Rally API requests to enable correct retrieval
+      of allowed values from a user's non-default workspace. Updates gem development dependencies and 
+      test files structure.
+

data/Rakefile

@@ -7,11 +7,11 @@ end
 
 desc "run all api tests"
 RSpec::Core::RakeTask.new('api_tests') do |t|
-  t.pattern = ['test/*_spec.rb']
+  t.pattern = ['spec/*_spec.rb']
 end
 
 desc "run api create tests"
 RSpec::Core::RakeTask.new('api_create_tests') do |t|
-  t.pattern = ['test/*create_spec.rb']
+  t.pattern = ['spec/*create_spec.rb']
 end
 

data/lib/rally_api/rally_rest_json.rb

@@ -95,6 +95,32 @@ module RallyAPI
       self
     end
 
+    def send_request(url = nil, args = nil, params = {})
+      if params[:workspace].nil? && rally_workspace_object
+        params[:workspace] = rally_workspace_object['_ref']
+      end
+      if params[:workspace]
+        wksp_id = params[:workspace].match(/workspace\/(\d*)/)[1]
+        url += "?/workspace=/workspace/#{wksp_id}"
+      end
+      @rally_connection.send_request(url, args, params)
+    end
+
+
+    def rally_workspace_object(new_wksp = nil)
+      return @rally_default_workspace if new_wksp.nil?
+      if new_wksp.instance_of?(String)
+        if new_wksp.match(/rallydev.com/)
+          @rally_default_workspace = find_workspace(new_wksp, '_ref')
+        else
+          @rally_default_workspace = find_workspace(new_wksp, 'Name')  
+        end
+      else
+        @rally_default_workspace = new_wksp
+      end
+      return @rally_default_workspace
+    end
+
     def debug_logging_on
       @low_debug = true
       @rally_connection.low_debug = true
@@ -105,12 +131,13 @@ module RallyAPI
       @rally_connection.low_debug = false
     end
 
-    def find_workspace(workspace_name)
+    def find_workspace(workspace_name, matcher_ref = 'Name')
+      # use matcher_ref to search for 'Name' or '_ref'
       sub = self.user["Subscription"].read({:fetch => "Workspaces,Name,State"})
       workspace = nil
       sub.Workspaces.each do |ws|
         #ws.read
-        if (ws["Name"] == workspace_name) && (ws["State"] == "Open")
+        if (ws[matcher_ref] == workspace_name) && (ws["State"] == "Open")
           workspace = ws
           break  #doing a break for performance some customers have 100+ workspaces - no need to do the others
         end
@@ -137,7 +164,7 @@ module RallyAPI
 
     def user(params = {})
       args = { :method => :get }
-      json_response = @rally_connection.send_request(make_get_url("user"), args, params)
+      json_response = send_request(make_get_url("user"), args, params)
       rally_type = json_response.keys[0]
       RallyObject.new(self, json_response[rally_type], warnings(json_response))
     end
@@ -145,7 +172,7 @@ module RallyAPI
     def create(type, fields, params = {})
       type = check_type(type)
       if (fields["Workspace"].nil? && fields["Project"].nil?)
-        fields["Workspace"] = @rally_default_workspace._ref unless @rally_default_workspace.nil?
+        fields["Workspace"] = rally_workspace_object._ref unless rally_workspace_object.nil?
         fields["Project"] = @rally_default_project._ref unless @rally_default_project.nil?
       end
 
@@ -157,7 +184,7 @@ module RallyAPI
       object2create = { type => check_fields(fields) }
       args = { :method => :post, :payload => object2create }
       #json_response = @rally_connection.create_object(make_create_url(rally_type), args, object2create)
-      json_response = @rally_connection.send_request(make_create_url(type), args, params)
+      json_response = send_request(make_create_url(type), args, params)
       #todo - check for warnings
       RallyObject.new(self, json_response["CreateResult"]["Object"], warnings(json_response)).read()
     end
@@ -166,9 +193,9 @@ module RallyAPI
     def read(type, obj_id, params = {})
       type = check_type(type)
       ref = check_id(type.to_s, obj_id)
-      params[:workspace] = @rally_default_workspace.ref if params[:workspace].nil?
+      params[:workspace] = rally_workspace_object.ref if params[:workspace].nil?
       args = { :method => :get }
-      json_response = @rally_connection.send_request(ref, args, params)
+      json_response = send_request(ref, args, params)
       rally_type = json_response.keys[0]
       RallyObject.new(self, json_response[rally_type], warnings(json_response))
     end
@@ -176,7 +203,7 @@ module RallyAPI
     def delete(ref_to_delete)
       args = { :method => :delete }
       #json_response = @rally_connection.delete_object(ref_to_delete, args)
-      json_response = @rally_connection.send_request(ref_to_delete, args)
+      json_response = send_request(ref_to_delete, args)
       json_response["OperationResult"]
     end
 
@@ -186,7 +213,7 @@ module RallyAPI
         params[:workspace] = json_object['Workspace']['_ref']
       end
       #json_response = @rally_connection.read_object(json_object["_ref"], args, params)
-      json_response = @rally_connection.send_request(json_object["_ref"], args, params)
+      json_response = send_request(json_object["_ref"], args, params)
       rally_type = json_response.keys[0]
       json_response[rally_type]
     end
@@ -209,7 +236,7 @@ module RallyAPI
       fields = RallyAPI::RallyRestJson.fix_case(fields) if @rally_rest_api_compat
       json_update = {type.to_s => check_fields(fields)}
       args = {:method => :post, :payload => json_update}
-      json_response = @rally_connection.send_request(ref, args, params)
+      json_response = send_request(ref, args, params)
       #todo check for warnings on json_response["OperationResult"]
       RallyObject.new(self, reread({"_ref" => ref}), warnings(json_response))
     end
@@ -243,7 +270,7 @@ module RallyAPI
       yield query_obj if block_given?
 
       if query_obj.workspace.nil?
-        query_obj.workspace = @rally_default_workspace unless @rally_default_workspace.nil?
+        query_obj.workspace = rally_workspace_object unless rally_workspace_object.nil?
       end
 
       errs = query_obj.validate()
@@ -272,7 +299,7 @@ module RallyAPI
       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)
-      json_response = @rally_connection.send_request(ref, args, params)
+      json_response = send_request(ref, args, params)
       RallyObject.new(self, json_response["OperationResult"]["Object"], warnings(json_response))
     end
 
@@ -284,7 +311,7 @@ module RallyAPI
       params[:fetch] = "true"
       json_update = { get_type_from_ref(ref_to_rank) => {"_ref" => ref_to_rank} }
       args = { :method => :put, :payload => json_update }
-      json_response = @rally_connection.send_request(ref, args, params)
+      json_response = send_request(ref, args, params)
       RallyObject.new(self, json_response["OperationResult"]["Object"], warnings(json_response))
     end
 
@@ -295,11 +322,11 @@ module RallyAPI
       params[:fetch]  = "true"
       json_update = { get_type_from_ref(ref_to_rank) => {"_ref" => ref_to_rank} }
       args = { :method => :put, :payload => json_update }
-      json_response = @rally_connection.send_request(ref, args, params)
+      json_response = send_request(ref, args, params)
       RallyObject.new(self, json_response["OperationResult"]["Object"], warnings(json_response))
     end
 
-    def get_typedef_for(type, workspace = @rally_default_workspace)
+    def get_typedef_for(type, workspace = rally_workspace_object)
       type = type.to_s if type.class == Symbol
       type = check_type(type)
       type_def_query             = RallyQuery.new()
@@ -311,7 +338,7 @@ module RallyAPI
       type_def.first
     end
 
-    def get_fields_for(type, workspace = @rally_default_workspace)
+    def get_fields_for(type, workspace = rally_workspace_object)
       type_def = get_typedef_for(type, workspace)
       return nil if type_def.nil?
       fields = {}
@@ -323,7 +350,9 @@ module RallyAPI
     end
 
     #todo - check support for portfolio item fields
-    def allowed_values(type, field, workspace = @rally_default_workspace)
+    def allowed_values(type, field, workspace = nil)
+      rally_workspace_object(workspace)
+  
       type_def = get_typedef_for(type, workspace)
       allowed_vals = {}
       type_def["Attributes"].each do |attr|
@@ -337,7 +366,7 @@ module RallyAPI
       allowed_vals
     end
 
-    def custom_fields_for(type, workspace = @rally_default_workspace)
+    def custom_fields_for(type, workspace = rally_workspace_object)
       @custom_fields_for_type[workspace.ObjectID] = {} if @custom_fields_for_type[workspace.ObjectID].nil?
       if @custom_fields_for_type[workspace.ObjectID][type].nil?
         @custom_fields_for_type[workspace.ObjectID][type] = {}
@@ -424,7 +453,7 @@ module RallyAPI
       query.query_string  = "(FormattedID = #{fid})"
       query.limit         = 20
       query.fetch         = "FormattedID"
-      query.workspace     = @rally_default_workspace
+      query.workspace     = rally_workspace_object
 
       results = find(query)
       return results.first["_ref"] if results.length > 0

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 = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rally_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Dave Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -16,84 +16,70 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
 description: API wrapper for Rally's JSON REST web services api
 email:
 - dsmith@rallydev.com
@@ -103,6 +89,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- lib/rally_api.rb
 - lib/rally_api/custom_http_header.rb
 - lib/rally_api/lookback_api_query.rb
 - lib/rally_api/rally_collection.rb
@@ -112,7 +99,6 @@ files:
 - lib/rally_api/rally_query_result.rb
 - lib/rally_api/rally_rest_json.rb
 - lib/rally_api/version.rb
-- lib/rally_api.rb
 homepage: https://github.com/RallyTools/RallyRestToolkitForRuby
 licenses:
 - MIT
@@ -133,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rally_api
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Rally Web Services API using json