rally_api 0.9.17.pre → 0.9.18

data/{README.rdoc → README.md}

@@ -1,16 +1,31 @@
-= RallyAPI (rally_api) -- a wrapper for Rally's REST Web Services API
+## License
 
-== Description
+Copyright (c) Rally Software Development Corp. 2013 Distributed under the MIT License.
+
+## Warranty
+
+The Ruby Toolkit for Rally REST API is available on an as-is basis. 
+
+## Support
+
+Rally Software does not actively maintain this toolkit.  If you have a question or problem, we recommend posting it to Stack Overflow: http://stackoverflow.com/questions/ask?tags=rally 
+
+## Introduction
+
+RallyAPI (rally_api) -- a wrapper for Rally's REST Web Services API  
+
+[![Stories in Ready](http://badge.waffle.io/RallyTools/RallyRestToolkitForRuby.png)](http://waffle.io/RallyTools/RallyRestToolkitForRuby)
 
 RallyAPI is a wrapper of Rally's Web Service API Json endpoints using rest-client and native json parsing
 Check the examples directory for more detailed samples.
 
-== Installation
-    gem install rally_api
+### Installation
+
+gem install rally_api
 
-== Usage
+### Usage
 
-=== Making a connection to Rally
+Making a connection to Rally
     require 'rally_api'
 
     #Setting custom headers
@@ -32,7 +47,7 @@ Check the examples directory for more detailed samples.
     @rally = RallyAPI::RallyRestJson.new(config)
 
 
-=== Querying Rally
+### Querying Rally
 
     #type names are stored in rally.rally_objects hash, you can inspect there for a list
     #Look at the TypePath for all typedefs and this is the key to each hash.
@@ -69,7 +84,7 @@ Check the examples directory for more detailed samples.
     end
 
 
-=== Reading an Artifact
+### Reading an Artifact
     defect = @rally.read("defect", 12345)      #by ObjectID
     #or
     defect = @rally.read("defect", "FormattedID|DE42")      #by FormattedID
@@ -89,13 +104,13 @@ Check the examples directory for more detailed samples.
     #  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
+### Creating an Artifact
     obj = {}
     obj["Name"] = "Test Defect created #{DateTime.now()}"
     new_de = @rally.create("defect", obj)
     puts new_de["FormattedID"]
 
-=== Updating an Artifact
+### Updating an Artifact
     fields = {}
     fields["Severity"] = "Critical"
     fields["Description"] = "Description for the issue"
@@ -107,7 +122,7 @@ Check the examples directory for more detailed samples.
     field_updates = {"Description" => "Changed Description"}
     defect.update(field_updates)
 
-=== Utils
+### 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")
@@ -117,9 +132,3 @@ Check the examples directory for more detailed samples.
     story1.rank_below(story2)
     story1.rank_to_bottom
     story1.rank_to_top
-
-== License/Meta
-Copyright (c) 2002-2013 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.
-

data/lib/rally_api/rally_json_connection.rb

@@ -1,6 +1,5 @@
-require 'httpclient'
+require "httpclient"
 require 'json'
-require 'nokogiri'
 
 # :stopdoc:
 #Copyright (c) 2002-2012 Rally Software Development Corp. All Rights Reserved.
@@ -68,63 +67,6 @@ module RallyAPI
       @security_token = keyval
     end
 
-    #==========================================================================================================
-    #new sso auth method - experimental
-    def do_sso_auth(rally_sso_url, sso_user, sso_password)
-      step1res = @rally_http_client.request(:get, rally_sso_url, {:follow_redirect => true})
-      step1action = get_sso_form_info(step1res)
-
-      post_content2 = {:body => step1action[:inputs], :follow_redirect => true}
-      step2res = @rally_http_client.post(step1action[:action_url], post_content2)
-      step2action = get_sso_form_info(step2res)
-      step2formdata = {}
-      step2action[:inputs].each_key do |nm|
-        if nm.downcase.include?("name")
-          step2formdata[nm] = sso_user
-        elsif nm.downcase.include?("pass")
-          step2formdata[nm] = sso_password
-        end
-      end
-
-      base_url = URI.parse(step1action[:action_url])
-
-      step3_url = "#{base_url.scheme}://#{base_url.host}#{step2action[:action_url]}"
-      post_content3 = {:body => step2formdata, :follow_redirect => true}
-      step3res = @rally_http_client.post(step3_url, post_content3)
-      step3action = get_sso_form_info(step3res)
-      post_content4 = {:body => step3action[:inputs], :follow_redirect => true}
-
-      #step4_url = "#{base_url.scheme}://#{base_url.host}#{step3action[:action_url]}"
-      step4res = @rally_http_client.post(step3action[:action_url], post_content4)
-      log_info("got step4 #{step4res.body}")
-
-      step4action = get_sso_form_info(step4res)
-      post_content5 = {:body => step4action[:inputs], :follow_redirect => true}
-      step5res = @rally_http_client.post(step4action[:action_url], post_content5)
-      log_info("got step5 #{step5res.body}")
-
-      res = @rally_http_client.get("https://rally1.rallydev.com/slm/webservice/1.42/user.js")
-      log_info("final result: #{res.body}")
-      true
-    end
-
-    def get_sso_form_info(form_html)
-      log_info ("===================\nparsing #{form_html.body}\n======================")
-      parsed_html = Nokogiri::HTML(form_html.body)
-      inputs = {}
-      parsed_html.css("//input").each do |inp|
-        next if inp["name"].nil?
-        inputs[inp["name"]] = inp["value"]
-      end
-
-      form = parsed_html.at("//form")
-      form_action = form["action"]
-      return_val = {:action_url => form_action, :inputs => inputs}
-      log_info("\n==========================\n#{return_val}\n============================\n")
-      return_val
-    end
-    #==========================================================================================================
-
     def logger=(log_dev)
       @logger = log_dev
       @rally_http_client.debug_dev = log_dev

data/lib/rally_api/rally_object.rb

@@ -14,7 +14,12 @@ module RallyAPI
     attr_reader :rally_object, :type, :warnings
 
     def initialize(rally_rest, json_hash, warnings = {})
-      @type = json_hash["_type"] || json_hash["_ref"].split("/")[-2]
+      # handle that we might not get a _ref or a _type
+      if !json_hash["_type"].nil? || !json_hash["_ref"].nil?
+        @type = json_hash["_type"] || json_hash["_ref"].split("/")[-2]
+      else
+        @type = "unknown"
+      end
       @rally_object = json_hash
       @rally_rest = rally_rest
       @warnings = warnings[:warnings]
@@ -63,7 +68,7 @@ module RallyAPI
 
     def elements
       @rally_object.inject({}) do |elements, (key, value)|
-        if key.to_s.starts_with?("c_")
+        if key.to_s.start_with?("c_")
           key = key.to_s[2..-1]
         end
         elements[underscore(key).to_sym] = value

data/lib/rally_api/rally_rest_json.rb

@@ -48,14 +48,13 @@ module RallyAPI
 
     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, :rally_sso_url
+                  :rally_rest_api_compat, :logger, :rally_alias_types
     attr_reader   :rally_connection
 
     def initialize(args)
       @rally_alias_types     = { "story" => "HierarchicalRequirement", "userstory" => "HierarchicalRequirement" }
 
       @rally_url            = args[:base_url] || "https://rally1.rallydev.com/slm"
-      @rally_sso_url        = args[:rally_sso_url]
       @rally_user           = args[:username]
       @rally_password       = args[:password]
       @rally_workspace_name = args[:workspace]
@@ -64,12 +63,20 @@ module RallyAPI
       @rally_headers        = args[:headers]  || CustomHttpHeader.new
       @proxy_info           = args[:proxy]
       @skip_sec_key         = args[:skip_sec_key]
+
       #flag to help RallyRestAPI users to use snake case field names eg Defect.fixed_in_build vs Defect["FixedInBuild"]
-      @rally_rest_api_compat = args[:rally_rest_api_compat] || false
-      @low_debug             = args[:debug]  || false
-      @logger                = args[:logger] || nil    #assumes this is an instance of Logger
+      @rally_rest_api_compat  = args[:rally_rest_api_compat] || false
 
-      setup_rally_connection
+      @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)
+      @rally_connection.set_client_user(@rally_url, @rally_user, @rally_password)
+      @rally_connection.logger  = @logger unless @logger.nil?
+
+      if @wsapi_version.to_s.include?("v2.") && !@skip_sec_key
+        @rally_connection.setup_security_token(security_url)
+      end
 
       if !@rally_workspace_name.nil?
         @rally_default_workspace = find_workspace(@rally_workspace_name)
@@ -84,20 +91,6 @@ module RallyAPI
       self
     end
 
-    def setup_rally_connection
-      @rally_connection = RallyJsonConnection.new(@rally_headers, @low_debug, @proxy_info)
-      @rally_connection.logger  = @logger unless @logger.nil?
-      if @rally_sso_url.nil?
-        @rally_connection.set_client_user(@rally_url, @rally_user, @rally_password)
-      else
-        @rally_connection.do_sso_auth(@rally_sso_url, @rally_user, @rally_password)
-      end
-
-      if @wsapi_version.to_s.include?("v2.") && !@skip_sec_key
-        @rally_connection.setup_security_token(security_url)
-      end
-    end
-
     def debug_logging_on
       @low_debug = true
       @rally_connection.low_debug = true

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.17.pre"
+  VERSION = "0.9.18"
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rally_api
 version: !ruby/object:Gem::Version
-  version: 0.9.17.pre
-  prerelease: 7
+  version: 0.9.18
+  prerelease: 
 platform: ruby
 authors:
 - Dave Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000Z
+date: 2013-07-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70356434093580 !ruby/object:Gem::Requirement
+  requirement: &70250729329280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,10 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70356434093580
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &70356434093080 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70356434093080
+  version_requirements: *70250729329280
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70356434092700 !ruby/object:Gem::Requirement
+  requirement: &70250729355980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70356434092700
+  version_requirements: *70250729355980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70356434092220 !ruby/object:Gem::Requirement
+  requirement: &70250729355520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70356434092220
+  version_requirements: *70250729355520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70356434091800 !ruby/object:Gem::Requirement
+  requirement: &70250729355100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70356434091800
+  version_requirements: *70250729355100
 description: API wrapper for Rally's JSON REST web services api
 email:
 - dsmith@rallydev.com
@@ -73,7 +62,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rdoc
+- README.md
 - Rakefile
 - lib/rally_api/custom_http_header.rb
 - lib/rally_api/lookback_api_query.rb
@@ -100,9 +89,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: rally_api
 rubygems_version: 1.8.6