Merge pull request #120 from klehman-rally/master

custom fields allowedValues retrieval, integration headers handling

Author: klehman-rally

PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 1.1
 Name: pyral
-Version: 1.3.0
-Summary: Python toolkit for Rally REST API
+Version: 1.3.1
+Summary: Python toolkit for Agile Central (Rally) REST API
 Home-page: https://github.com/RallyTools/RallyRestToolkitForPython
-Author: Kip Lehman (Rally Software Development)
+Author: Kip Lehman (CA Technologies, AgileCentral Business Unit)
 License: BSD
-Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dists/pyral-1.3.0.zip
+Download-URL: https://github.com/RallyTools/RallyRestToolkitForPython/raw/master/dists/pyral-1.3.1.zip
 Description: This is the README file for pyral, a package implementing a 
         Pythonic interface to the Agile Central (formerly Rally) REST API
 
@@ -28,18 +28,28 @@ Description: This is the README file for pyral, a package implementing a
         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.3.0) has been tested with requests 2.12.5.
+        The most recent release of pyral (1.3.1) has been tested with requests 2.12.5.
         The six module is also required.
 
 
         Installation
         ------------
 
+        If you want to pull down the latest release from standard Python package repository
+        (pypi.python.org) and install the package, the easiest way is to use
+        pip, the Python package installation utility.::
+        
+            pip install pyral
+        
+        Alternatively if you've got the tar.gz or zip distribution on hand, as long as you've
+        satisfied the dependency requirements on the six and requests packages, you can use
+        the setup mechanism.
         Once requests and six has been installed, run the setup.py program supplied with
         this distribution as::
 
             python setup.py install
 
+        
         Validation
         ----------
 
@@ -63,7 +73,7 @@ Description: This is the README file for pyral, a package implementing a
 
 Keywords: rally,agilecentral,api
 Requires: six
-Requires: requests>=2.8.1
+Requires: requests>=2.10.1
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
@@ -74,5 +84,6 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 2.6
 Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries

README.rst

@@ -35,11 +35,20 @@ The git repository is available at https://github.com/RallyTools/RallyRestToolki
 Installation
 ````````````
 
+If you want to pull down the latest release from standard Python package repository
+(pypi.python.org) and install the package, the easiest way is to use
+pip, the Python package installation utility.::
+
+    pip install pyral
+
+Alternatively, if you've got the tar.gz or zip distribution on hand, as long as you've
+satisfied the dependency requirements on the six and requests packages, you can use
+the setup mechanism.
 Obtain the requests_ package and install it according to that package's directions.
 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.3.0) has been tested using requests 2.12.5.
+The most recent release of pyral (1.3.1) has been tested using requests 2.12.5.
 
 Obtain and install the six_ module (available from PyPI at https://pypi.python.org/pypi/six)
 
@@ -67,7 +76,7 @@ relevant packages.
    >> import requests
    >> import pyral
    >> pyral.__version__
-   (1, 3, 0)
+   (1, 3, 1)
 
 
 
@@ -273,6 +282,17 @@ Prerequisites
 
 Versions
 --------
+   **1.3.1**
+       Adjusted getAllowedValues so that custom fields with an allowedValues endpoint get resolved.
+       Disqualifed a group of standard attributes whose allowedValue is of type COLLECTION when retrieving 
+       allowed values in SchemaItem.complete(). This is primarily relevant only to attributes defined as
+       Drop Down List or Multi Value Drop Down List.
+       Fixed mechanism of supplying headers dict to Rally instantiation so that the X-RallyIntegration* 
+       headers get overwritten with supplied headers (for name, vendor, version) to better identify the 
+       origin of the integration.
+       Updated official name to reference Agile Central in setup.py, mention threads keyword arg in the
+       get method in the the interface.rst file.
+
    **1.3.0**
        Introduced automatic multi-threading for Rally.get operation to speed up retrieval of large
        result sets.  Implemented step two of the Pinger deprecation plan, ping=False is the new default.

README.short

@@ -20,18 +20,28 @@ Requirements
 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.3.0) has been tested with requests 2.12.5.
+The most recent release of pyral (1.3.1) has been tested with requests 2.12.5.
 The six module is also required.
 
 
 Installation
 ------------
 
+If you want to pull down the latest release from standard Python package repository
+(pypi.python.org) and install the package, the easiest way is to use
+pip, the Python package installation utility.::
+
+    pip install pyral
+
+Alternatively if you've got the tar.gz or zip distribution on hand, as long as you've
+satisfied the dependency requirements on the six and requests packages, you can use
+the setup mechanism.
 Once requests and six has been installed, run the setup.py program supplied with
 this distribution as::
 
     python setup.py install
 
+
 Validation
 ----------
 

VERSIONS

@@ -111,3 +111,22 @@
     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.3.0 - Apr 2017
+    Introduced automatic multi-threading for Rally.get operation to speed up retrieval of large
+    result sets.  Implemented step two of the Pinger deprecation plan, ping=False is the new default.
+    Increased default page size to 500.  Maximum useful page size limit is 2000 but 1000 seems
+    to be the sweet spot for multithreading requests.
+    Fixed Rally.getAllUsers so that non subscription admin accounts can see the user list.
+    Updated recommendation for version of requests package.
+
+1.3.1 - Apr 2017
+    Adjusted getAllowedValues so that custom fields with an allowedValues endpoint get resolved.
+    Disqualifed a group of standard attributes whose allowedValue is of type COLLECTION when retrieving 
+    allowed values in SchemaItem.complete(). This is primarily relevant only to attributes defined as
+    Drop Down List or Multi Value Drop Down List. 
+    Fixed mechanism of supplying headers dict to Rally instantiation so that the X-RallyIntegration*
+    headers get overwritten with supplied headers (for name, vendor, version) to better identify the 
+    origin of the integration.
+    Updated official name to reference Agile Central in setup.py, mention threads keyword arg in the
+    get method in the the interface.rst file.

build_dist.py

@@ -7,13 +7,14 @@
 #############################################################################
 
 import sys, os
+import types
 import tarfile
 import zipfile
 import shutil
 import re
 
 PACKAGE_NAME = "pyral"
-VERSION      = "1.3.0"
+VERSION      = "1.3.1"
 
 AUX_FILES  = ['MANIFEST.in', 
               'PKG-INFO', 
@@ -71,6 +72,7 @@
               'test/test_inflation.py',
               'test/test_field_access.py',
               'test/test_workspaces.py'
+              'test/test_allowed_values.py',
               'test/test_wksprj_setting.py',
               'test/test_query.py',
               'test/test_big_query.py',
@@ -103,28 +105,36 @@ def main(args):
         reduction_pct = int(reduction_fraction * 100)
         print("%-52.52s   %6d (%2d%%)" % (info.filename, info.compress_size, reduction_pct))
 
-    # got to use Python 2.7 to be able to run python setup.py bdist_wheel
-    os.system('/usr/local/bin/python setup.py bdist_wheel')
+    # in order to get a wheel file built, the python used has to have available a setup.py
+    # that exposes a bdist_wheel method, which in versions of python beyond 2.7, like 3.5., 3.6, etc
+    # you'll need to have done a 'pip install wheel' which sets up the necessary infrastructure.
+    os.system('python setup.py bdist_wheel')
     wheel_file = "%s-%s-py2.py3-none-any.whl" % (PACKAGE_NAME, VERSION)
     # the wheel_file gets written into the dist  subdir by default, no need for a copy...
 
     store_packages('dist',  [tarball])
     store_packages('dists', [tarball, zipped])
 
+    doc_dir = 'doc/build/html'
+    doc_files = [path.split('/')[-1] for path in DOC_FILES if path.startswith(doc_dir)]
+    webdocs_zip = make_online_docs_zipfile(PACKAGE_NAME, VERSION, doc_dir, doc_files)
+    webdocs_location = os.path.join(doc_dir, webdocs_zip)
+    store_packages('dist', [webdocs_location])
+
 ################################################################################
 
 def store_packages(subdir, files):
     for file in files:
         if os.path.exists(file):
-            shutil.copy(file, '%s/%s' % (subdir, file))
+            leaf_name = os.path.basename(file)
+            shutil.copy(file, '%s/%s' % (subdir, leaf_name))
         else:
             problem = "No such file found: {0} to copy into {1}".format(file, subdir)
             sys.stderr.write(problem)
 
 ################################################################################
 
 def package_meta(filename):
-    import imp
 
     if not os.path.exists(filename):
         raise Exception('No such file: %s' % filename)
@@ -136,8 +146,8 @@ def package_meta(filename):
     assignments = "\n".join(consties)
 
     #print(assignments)
-    pkgcfg = imp.new_module('pkgcfg')
-    exec(assignments, pkgcfg.__dict__)
+    pkgcfg = types.ModuleType('pkgcfg')  # make a new empty module, internally.. no file created
+    exec(assignments, pkgcfg.__dict__)   # now populate the module with our assignments
     sys.modules['pkgcfg'] = pkgcfg
     return pkgcfg
 
@@ -220,6 +230,25 @@ def make_tarball(pkg_name, pkg_version, base_files, example_files, doc_files):
 
 ################################################################################
 
+def make_online_docs_zipfile(pkg_name, pkg_version, doc_dir, doc_files):
+    zf_name = '%s-%s.docs.html.zip' % (pkg_name, pkg_version)
+    cur_dir = os.getcwd()
+    os.chdir(doc_dir)
+    zf = zipfile.ZipFile(zf_name, 'w')
+    for fn in doc_files:
+        zf.write(fn, fn, zipfile.ZIP_DEFLATED)
+    zf.close()
+
+    ##  The following is what has been done before on the command line, when you
+    ## get the recursion opt on the above logic you can drop the os.system call
+    os.system("zip %s -r %s" % (zf_name, " ".join(doc_files)))
+    ##
+
+    os.chdir(cur_dir)
+    return zf_name
+
+################################################################################
+
 def make_zipfile(pkg_name, pkg_version, base_files, example_files, doc_files):
     base_dir = '%s-%s' % (pkg_name, pkg_version)