Merge pull request #114 from klehman-rally/master

fixed project scoping, fixed RallyRESTResponse __repr__ for empty res…

Author: klehman-rally

LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2016, CA Technologies; 2010-2015, Rally Software Development Corp.  Boulder, Colorado USA
+Copyright © 2015-2017, CA Technologies; 2010-2015, Rally Software Development Corp.  Boulder, Colorado USA
 All rights reserved.
 
 License for pyral (a Python toolkit for the Rally REST API)

PKG-INFO

@@ -1,21 +1,21 @@
 Metadata-Version: 1.1
 Name: pyral
-Version: 1.2.3
+Version: 1.2.4
 Summary: Python toolkit for Rally REST API
 Home-page: https://github.com/RallyTools/RallyRestToolkitForPython
 Author: Kip Lehman (Rally Software Development)
 License: BSD
-Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dist/pyral-1.2.3.zip
+Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dists/pyral-1.2.4.zip
 Description: This is the README file for pyral, a package implementing a 
-        Pythonic interface to the Rally REST API
+        Pythonic interface to the Agile Central (formerly Rally) REST API
 
         Description
         -----------
 
         The Rally REST Tookit for Python consists of a package that provides a means
         to interact with entities and artifacts in your Rally subscription.  The full
-        spectrum of CRUD operations is available in your Rally Workspaces and Projects,
-        providing of course that your Rally subscription credentials enable you to perform
+        spectrum of CRUD operations is available in your Agile Central (Rally) Workspaces and Projects,
+        providing of course that your Agile Central (Rally) subscription credentials enable you to perform
          those operations.  The toolkit insulates the package user from having to make 
         multiple requests to obtain the full set of qualifying items by performing any 
         subsequent "page" requests automatically.  
@@ -25,10 +25,10 @@ Description: This is the README file for pyral, a package implementing a
         Requirements
         ------------
 
-        The pyral package requires the use of Kenneth Reitz's requests package using version 2.0.0 or better.
+        The pyral package requires the use of Kenneth Reitz's requests package using version 2.8.0 or better.
         As of requests version 2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
         The requests package can be found via the Python Package Index site (http://pypi/python.org/index).
-        The most recent release of pyral (1.2.3) has been tested with requests 2.8.1.
+        The most recent release of pyral (1.2.4) has been tested with requests 2.8.1.
         The six module is also required.
 
 
@@ -55,9 +55,10 @@ Description: This is the README file for pyral, a package implementing a
         -------------
 
         Obtain the zip file containing the HTML and CSS files comprising the document set for pyral.
-        Unzip in a suitable location and point your web browser to the doc/build/html/index.html file
+        Unzip in a suitable location and point your web browser to the doc/build/html/index.html file.
 
-          The rendered documentation is also available at http://pyral.readthedocs.io/en/latest/
+        The rendered documentation is also available at http://pyral.readthedocs.io/en/latest/
+        and http://pythonhosted.org/pyral
 
 
 Keywords: rally,agilecentral,api

README.rst

@@ -1,12 +1,12 @@
-pyral - A Python toolkit for the Rally REST API
-===============================================
+pyral - A Python toolkit for the Agile Central (Rally) REST API
+===============================================================
 
 
 The `pyral <http://github.com/RallyTools/RallyRestToolkitForPython>`_ package enables you to push, pull
-and otherwise wrangle the data in your Rally subscription using the popular
+and otherwise wrangle the data in your Agile Central (formerly named Rally) subscription using the popular
 and productive Python language.
 The ``pyral`` package provides a smooth and easy to use veneer on top
-of the Rally REST Web Services API using JSON.
+of the Agile Central (Rally) REST Web Services API using JSON.
 
 As of July 2015, the Rally Software Development company was acquired by CA Technologies.
 The Rally product itself has been rebranded as 'Agile Central'.  Over time, the documentation
@@ -18,9 +18,9 @@ will transition from using the term 'Rally' to using 'Agile Central'.
 Getting started
 ---------------
 
-Rally has created a Python package that you can quickly leverage to interact with the data in your 
+Agile Central (Rally) has created a Python package that you can quickly leverage to interact with the data in your
 subscription via the REST web services API.  You can create, read, update, and delete the common 
-artifacts and other entities via the Python toolkit for Rally.
+artifacts and other entities via the Python toolkit for Agile Central (Rally).
 
 Download
 ````````
@@ -39,7 +39,7 @@ Obtain the requests_ package and install it according to that package's directio
 As of requests-2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
 Use of requests-2.x or better is recommended for use with pyral.
 The requests_ package can be found via the Python Package Index site (http://pypi/python.org/index).
-The most recent release of pyral (1.2.3) has been tested using requests 2.8.1.
+The most recent release of pyral (1.2.4) has been tested using requests 2.8.1.
 
 Obtain and install the six_ module (available from PyPI at https://pypi.python.org/pypi/six)
 
@@ -63,11 +63,11 @@ relevant packages.
 :: 
 
    $ python
-   Python 3.5.1 [other Python interpreter info elided ...]
+   Python 3.5.2 [other Python interpreter info elided ...]
    >> import requests
    >> import pyral
    >> pyral.__version__
-   (1, 2, 3)
+   (1, 2, 4)
 
 
 
@@ -85,13 +85,13 @@ assigned to the name **story**, the following code iterates over the tasks.
 
 There is no need to make a separate call to fetch all the tasks for the story.
 When you follow domain model attributes in the Python code, the Python toolkit for 
-Rally REST API machinery automatically loads in the necessary objects for you.
+Agile Central (Rally) REST API machinery automatically loads in the necessary objects for you.
 
 
 Full Documentation
 ``````````````````
 
-The complete documentation for the Python toolkit for Rally REST API 
+The complete documentation for the Python toolkit for Agile Central (Rally) REST API
 is in the doc/build/html subdirectory in the repository.  
 The rendered version of this is also available at 
 http://pyral.readthedocs.io/en/latest/
@@ -102,13 +102,13 @@ Sample code
 
 Common setup code ::
 
-  import sys
-  from pyral import Rally, rallyWorkset
-  options = [arg for arg in sys.argv[1:] if arg.startswith('--')]
-  args    = [arg for arg in sys.argv[1:] if arg not in options] 
-  server, user, password, apikey, workspace, project = rallyWorkset(options)
-  rally = Rally(server, user, password, apikey=apikey, workspace=workspace, project=project)
-  rally.enableLogging('mypyral.log')
+    import sys
+    from pyral import Rally, rallyWorkset
+    options = [arg for arg in sys.argv[1:] if arg.startswith('--')]
+    args    = [arg for arg in sys.argv[1:] if arg not in options]
+    server, user, password, apikey, workspace, project = rallyWorkset(options)
+    rally = Rally(server, user, password, apikey=apikey, workspace=workspace, project=project)
+    rally.enableLogging('mypyral.log')
 
 Show a TestCase identified by the **FormattedID** value.
   Copy the above boilerplate and the following code fragment and save it in a file named gettc.py
@@ -133,12 +133,12 @@ Get a list of workspaces and projects for your subscription
 
 ::
 
-   workspaces = rally.getWorkspaces()
-   for wksp in workspaces:
-       print "%s %s" % (wksp.oid, wksp.Name)
-       projects = rally.getProjects(workspace=wksp.Name)
-       for proj in projects:
-           print "    %12.12s  %s" % (proj.oid, proj.Name)
+    workspaces = rally.getWorkspaces()
+    for wksp in workspaces:
+        print "%s %s" % (wksp.oid, wksp.Name)
+        projects = rally.getProjects(workspace=wksp.Name)
+        for proj in projects:
+            print "    %12.12s  %s" % (proj.oid, proj.Name)
 
 - Run the script
 
@@ -149,12 +149,12 @@ Get a list of all users in a specific workspace
 
 ::
 
-   all_users = rally.getAllUsers() 
-       for user in all_users:
-           tz   = user.UserProfile.TimeZone or 'default' 
-           role = user.Role or '-No Role-'  
-           values = (int(user.oid), user.Name, user.UserName, role, tz) 
-           print("%12.12d %-24.24s %-30.30s %-12.12s" % values)
+    all_users = rally.getAllUsers()
+        for user in all_users:
+            tz   = user.UserProfile.TimeZone or 'default'
+            role = user.Role or '-No Role-'
+            values = (int(user.oid), user.Name, user.UserName, role, tz)
+            print("%12.12d %-24.24s %-30.30s %-12.12s" % values)
 
 - Run the script
 
@@ -201,11 +201,11 @@ Update an existing Defect
                     "TargetDate"  : target_date, 
                     "Notes"       : notes 
                   } 
-   try:
-       defect = rally.update('Defect', defect_data)
-   except Exception, details: 
-       sys.stderr.write('ERROR: %s \n' % details) 
-       sys.exit(1)
+    try:
+        defect = rally.update('Defect', defect_data)
+    except Exception, details:
+        sys.stderr.write('ERROR: %s \n' % details)
+        sys.exit(1)
 
    print "Defect %s updated" % defect.FormattedID
 
@@ -262,18 +262,26 @@ The item names in config files **are** case sensitive.
 Prerequisites
 -------------
 
- * Python 2.6 or 2.7 (2.7 is preferred) OR
- * Python 3.5 (this package not tested with earlier versions of Python 3.x)
+ * Python 3.5 (this package not tested with earlier versions of Python 3.x) OR
+ * Python 2.6 or 2.7 (2.7 is preferred)
  * The requests_ package, 2.0.0 or better (2.0.0 finally includes support for https proxy),
    requests 2.8.1 is recommended.
  * The six_ package.
 
 .. _requests: http://github.com/kennethreitz/requests
-.. _six: https://bitbucket/gutworth/six
+.. _six: https://bitbucket.org/gutworth/six
 
 Versions
 --------
 
+   **1.2.4**
+       Fixed handling of projectScopeUp and projectScopeDown keyword arguments for get operation.
+       Fixed Peristable's __getattr__ method to more properly handle getting the salient item
+       out of a response to a getResourceByOID request when the item retrieved is a PortfolioItem sub-type.
+       Fixed defect in SchemaItemAttribute where self._allowed_values_resolved was not always set.
+       Fixed defect in RallyRestResponse in __repr__ method where on a response that has no qualifying items
+       an attempt is made to get the Results out of the returned response without going through the QueryResult key.
+
    **1.2.3**
        Fixed restapi.py Rally.getAllowedValues method to accommodate custom fields
        Allow attribute payload for put and post to have a list of pyral.Entity instances
@@ -310,22 +318,39 @@ Versions
 
 TODO
 ----
-* Investigate permanent location for web-access to rendered documentation
-* Dynamically construct the Rally schema hierarchy economically.
+* Dynamically construct the Agile Central (Rally) schema class hierarchy economically.
 
 
 License
 -------
 
-BSD3-style license. Copyright (c) 2015-2016 CA Technologies, 2010-2015 Rally Software Development.
+BSD3-style license. Copyright (c) 2015-2017 CA Technologies, 2010-2015 Rally Software Development.
 
 See the LICENSE file provided with the source distribution for full details.
 
+
+Warranty
+--------
+None. See the LICENSE file for full text regarding this issue.
+
+
+Support
+-------
+
+The use of this package is on an *as-is* basis and there is no official support offered by CA Technologies.
+The author of this module periodically checks the GitHub repository issues for this package in the
+ interests of providing defect fixes and small feature enhancements as time permits, but is not obligated to
+ respond or take action.
+Posts to Stack Overflow (http://stackoverflow.com/questions/ask?tags=rally) are another avenue to engage
+others who have some exposure to ``pyral`` and might be able to offer useful information.
+
+
 Author
 ------
 
 * Kip Lehman  <[email protected]>
 
+
 Additional Credits
 ------------------
 

README.short

@@ -1,13 +1,13 @@
 This is the README file for pyral, a package implementing a 
-Pythonic interface to the Rally REST API
+Pythonic interface to the Agile Central (formerly Rally) REST API
 
 Description
 -----------
 
 The Rally REST Tookit for Python consists of a package that provides a means
 to interact with entities and artifacts in your Rally subscription.  The full
-spectrum of CRUD operations is available in your Rally Workspaces and Projects,
-providing of course that your Rally subscription credentials enable you to perform
+spectrum of CRUD operations is available in your Agile Central (Rally) Workspaces and Projects,
+providing of course that your Agile Central (Rally) subscription credentials enable you to perform
  those operations.  The toolkit insulates the package user from having to make 
 multiple requests to obtain the full set of qualifying items by performing any 
 subsequent "page" requests automatically.  
@@ -17,10 +17,10 @@ that may be references or collections via the familiar dot '.' notation.
 Requirements
 ------------
 
-The pyral package requires the use of Kenneth Reitz's requests package using version 2.0.0 or better.
+The pyral package requires the use of Kenneth Reitz's requests package using version 2.8.0 or better.
 As of requests version 2.0.0, there is support for HTTPS over HTTP proxy via the CONNECT request.
 The requests package can be found via the Python Package Index site (http://pypi/python.org/index).
-The most recent release of pyral (1.2.3) has been tested with requests 2.8.1.
+The most recent release of pyral (1.2.4) has been tested with requests 2.8.1.
 The six module is also required.
 
 
@@ -47,7 +47,8 @@ Documentation
 -------------
 
 Obtain the zip file containing the HTML and CSS files comprising the document set for pyral.
-Unzip in a suitable location and point your web browser to the doc/build/html/index.html file
+Unzip in a suitable location and point your web browser to the doc/build/html/index.html file.
 
-  The rendered documentation is also available at http://pyral.readthedocs.io/en/latest/
+The rendered documentation is also available at http://pyral.readthedocs.io/en/latest/
+and http://pythonhosted.org/pyral
 

VERSIONS

@@ -104,3 +104,10 @@
     Allow attribute payload for put and post to have a list of pyral.Entity instances
     as values for an attribute that is of type COLLECTION.
 
+1.2.4 - Mar 2017
+    Fixed handling of projectScopeUp and projectScopeDown keyword arguments in Rally.get operation.
+    Fixed Peristable's __getattr__ method to more properly handle getting the salient item
+    out of a response to a getResourceByOID request when the item retrieved is a PortfolioItem sub-type.
+    Fixed defect in SchemaItemAttribute where self._allowed_values_resolved was not always set.
+    Fixed defect in RallyRestResponse in __repr__ method where on a response that has no qualifying items
+    an attempt is made to get the Results out of the returned response without going through the QueryResult key.

build_dist.py

@@ -13,7 +13,7 @@
 import re
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.2.3"
+VERSION      = "1.2.4"
 
 AUX_FILES  = ['MANIFEST.in', 
               'PKG-INFO', 
@@ -87,10 +87,10 @@ def main(args):
     pifi = save_pkg_info(".", 'PKG-INFO', pkg_info)
 
     tarball = make_tarball(PACKAGE_NAME, VERSION, AUX_FILES, EXAMPLES, DOC_FILES)
-    print tarball
+    print(tarball)
 
     zipped = make_zipfile(PACKAGE_NAME, VERSION, AUX_FILES, EXAMPLES, DOC_FILES)
-    print zipped
+    print(zipped)
 
     zf = zipfile.ZipFile(zipped, 'r')
     for info in zf.infolist():