Merge pull request #322 from cloudant/127-change-posix-path-to-str-join

Use `'/'.join()` to concatenate URL parts

Author: smithsz

CHANGES.rst

@@ -1,5 +1,6 @@
 Unreleased
 ==========
+- [IMPROVED] Updated ``posixpath.join`` references to use ``'/'.join`` when concatenating URL parts.
 
 2.6.0 (2017-08-10)
 ==================

src/cloudant/client.py

@@ -18,7 +18,6 @@
 """
 import base64
 import json
-import posixpath
 
 from ._2to3 import bytes_, unicode_
 from .database import CloudantDatabase, CouchDatabase
@@ -138,7 +137,7 @@ def session(self):
         """
         if self.admin_party:
             return None
-        sess_url = posixpath.join(self.server_url, '_session')
+        sess_url = '/'.join((self.server_url, '_session'))
         resp = self.r_session.get(sess_url)
         resp.raise_for_status()
         sess_data = resp.json()
@@ -164,7 +163,7 @@ def session_login(self, user, passwd):
         """
         if self.admin_party:
             return
-        sess_url = posixpath.join(self.server_url, '_session')
+        sess_url = '/'.join((self.server_url, '_session'))
         resp = self.r_session.post(
             sess_url,
             data={
@@ -182,7 +181,7 @@ def session_logout(self):
         """
         if self.admin_party:
             return
-        sess_url = posixpath.join(self.server_url, '_session')
+        sess_url = '/'.join((self.server_url, '_session'))
         resp = self.r_session.delete(sess_url)
         resp.raise_for_status()
 
@@ -207,7 +206,7 @@ def all_dbs(self):
 
         :returns: List of database names for the client
         """
-        url = posixpath.join(self.server_url, '_all_dbs')
+        url = '/'.join((self.server_url, '_all_dbs'))
         resp = self.r_session.get(url)
         resp.raise_for_status()
         return resp.json()
@@ -560,9 +559,7 @@ def _usage_endpoint(self, endpoint, year=None, month=None):
             try:
                 if int(year) > 0 and int(month) in range(1, 13):
                     resp = self.r_session.get(
-                        posixpath.join(
-                            endpoint, str(int(year)), str(int(month)))
-                    )
+                        '/'.join((endpoint, str(int(year)), str(int(month)))))
                 else:
                     err = True
             except (ValueError, TypeError):
@@ -587,7 +584,7 @@ def bill(self, year=None, month=None):
 
         :returns: Billing data in JSON format
         """
-        endpoint = posixpath.join(self.server_url, '_api', 'v2', 'bill')
+        endpoint = '/'.join((self.server_url, '_api', 'v2', 'bill'))
         return self._usage_endpoint(endpoint, year, month)
 
     def volume_usage(self, year=None, month=None):
@@ -604,9 +601,8 @@ def volume_usage(self, year=None, month=None):
 
         :returns: Volume usage data in JSON format
         """
-        endpoint = posixpath.join(
-            self.server_url, '_api', 'v2', 'usage', 'data_volume'
-        )
+        endpoint = '/'.join((
+            self.server_url, '_api', 'v2', 'usage', 'data_volume'))
         return self._usage_endpoint(endpoint, year, month)
 
     def requests_usage(self, year=None, month=None):
@@ -623,9 +619,8 @@ def requests_usage(self, year=None, month=None):
 
         :returns: Requests usage data in JSON format
         """
-        endpoint = posixpath.join(
-            self.server_url, '_api', 'v2', 'usage', 'requests'
-        )
+        endpoint = '/'.join((
+            self.server_url, '_api', 'v2', 'usage', 'requests'))
         return self._usage_endpoint(endpoint, year, month)
 
     def shared_databases(self):
@@ -635,9 +630,8 @@ def shared_databases(self):
 
         :returns: List of database names
         """
-        endpoint = posixpath.join(
-            self.server_url, '_api', 'v2', 'user', 'shared_databases'
-        )
+        endpoint = '/'.join((
+            self.server_url, '_api', 'v2', 'user', 'shared_databases'))
         resp = self.r_session.get(endpoint)
         resp.raise_for_status()
         data = resp.json()
@@ -649,9 +643,7 @@ def generate_api_key(self):
 
         :returns: API key/pass pair in JSON format
         """
-        endpoint = posixpath.join(
-            self.server_url, '_api', 'v2', 'api_keys'
-        )
+        endpoint = '/'.join((self.server_url, '_api', 'v2', 'api_keys'))
         resp = self.r_session.post(endpoint)
         resp.raise_for_status()
         return resp.json()
@@ -662,9 +654,8 @@ def cors_configuration(self):
 
         :returns: CORS data in JSON format
         """
-        endpoint = posixpath.join(
-            self.server_url, '_api', 'v2', 'user', 'config', 'cors'
-        )
+        endpoint = '/'.join((
+            self.server_url, '_api', 'v2', 'user', 'config', 'cors'))
         resp = self.r_session.get(endpoint)
         resp.raise_for_status()
 
@@ -754,9 +745,8 @@ def _write_cors_configuration(self, config):
 
         :returns: CORS configuration update status in JSON format
         """
-        endpoint = posixpath.join(
-            self.server_url, '_api', 'v2', 'user', 'config', 'cors'
-        )
+        endpoint = '/'.join((
+            self.server_url, '_api', 'v2', 'user', 'config', 'cors'))
         resp = self.r_session.put(
             endpoint,
             data=json.dumps(config, cls=self.encoder),

src/cloudant/database.py

@@ -17,7 +17,6 @@
 """
 import json
 import contextlib
-import posixpath
 
 from requests.exceptions import HTTPError
 
@@ -84,10 +83,8 @@ def database_url(self):
 
         :returns: Database URL
         """
-        return posixpath.join(
-            self._database_host,
-            url_quote_plus(self.database_name)
-        )
+        return '/'.join((
+            self._database_host, url_quote_plus(self.database_name)))
 
     @property
     def creds(self):
@@ -189,7 +186,7 @@ def design_documents(self):
 
         :returns: All design documents found in this database in JSON format
         """
-        url = posixpath.join(self.database_url, '_all_docs')
+        url = '/'.join((self.database_url, '_all_docs'))
         query = "startkey=\"_design\"&endkey=\"_design0\"&include_docs=true"
         resp = self.r_session.get(url, params=query)
         resp.raise_for_status()
@@ -203,7 +200,7 @@ def list_design_documents(self):
 
         :returns: List of names for all design documents in this database
         """
-        url = posixpath.join(self.database_url, '_all_docs')
+        url = '/'.join((self.database_url, '_all_docs'))
         query = "startkey=\"_design\"&endkey=\"_design0\""
         resp = self.r_session.get(url, params=query)
         resp.raise_for_status()
@@ -675,7 +672,7 @@ def bulk_docs(self, docs):
 
         :returns: Bulk document creation/update status in JSON format
         """
-        url = posixpath.join(self.database_url, '_bulk_docs')
+        url = '/'.join((self.database_url, '_bulk_docs'))
         data = {'docs': docs}
         headers = {'Content-Type': 'application/json'}
         resp = self.r_session.post(
@@ -698,7 +695,7 @@ def missing_revisions(self, doc_id, *revisions):
 
         :returns: List of missing document revision values
         """
-        url = posixpath.join(self.database_url, '_missing_revs')
+        url = '/'.join((self.database_url, '_missing_revs'))
         data = {doc_id: list(revisions)}
 
         resp = self.r_session.post(
@@ -727,7 +724,7 @@ def revisions_diff(self, doc_id, *revisions):
 
         :returns: The revision differences in JSON format
         """
-        url = posixpath.join(self.database_url, '_revs_diff')
+        url = '/'.join((self.database_url, '_revs_diff'))
         data = {doc_id: list(revisions)}
 
         resp = self.r_session.post(
@@ -746,7 +743,7 @@ def get_revision_limit(self):
 
         :returns: Revision limit value for the current remote database
         """
-        url = posixpath.join(self.database_url, '_revs_limit')
+        url = '/'.join((self.database_url, '_revs_limit'))
         resp = self.r_session.get(url)
         resp.raise_for_status()
 
@@ -767,7 +764,7 @@ def set_revision_limit(self, limit):
 
         :returns: Revision limit set operation status in JSON format
         """
-        url = posixpath.join(self.database_url, '_revs_limit')
+        url = '/'.join((self.database_url, '_revs_limit'))
 
         resp = self.r_session.put(url, data=json.dumps(limit, cls=self.client.encoder))
         resp.raise_for_status()
@@ -781,7 +778,7 @@ def view_cleanup(self):
 
         :returns: View cleanup status in JSON format
         """
-        url = posixpath.join(self.database_url, '_view_cleanup')
+        url = '/'.join((self.database_url, '_view_cleanup'))
         resp = self.r_session.post(
             url,
             headers={'Content-Type': 'application/json'}
@@ -958,8 +955,8 @@ def security_url(self):
 
         :returns: Security document URL
         """
-        parts = ['_api', 'v2', 'db', self.database_name, '_security']
-        url = posixpath.join(self._database_host, *parts)
+        url = '/'.join((self._database_host, '_api', 'v2', 'db',
+                        self.database_name, '_security'))
         return url
 
     def share_database(self, username, roles=None):
@@ -1040,7 +1037,7 @@ def shards(self):
 
         :returns: Shard information retrieval status in JSON format
         """
-        url = posixpath.join(self.database_url, '_shards')
+        url = '/'.join((self.database_url, '_shards'))
         resp = self.r_session.get(url)
         resp.raise_for_status()
 
@@ -1059,7 +1056,7 @@ def get_query_indexes(self, raw_result=False):
         :returns: The query indexes in the database
         """
 
-        url = posixpath.join(self.database_url, '_index')
+        url = '/'.join((self.database_url, '_index'))
         resp = self.r_session.get(url)
         resp.raise_for_status()
 

src/cloudant/document.py

@@ -16,7 +16,6 @@
 API module/class for interacting with a document in a database.
 """
 import json
-import posixpath
 import requests
 from requests.exceptions import HTTPError
 
@@ -87,19 +86,19 @@ def document_url(self):
 
         # handle design document url
         if self._document_id.startswith('_design/'):
-            return posixpath.join(
+            return '/'.join((
                 self._database_host,
                 url_quote_plus(self._database_name),
                 '_design',
                 url_quote(self._document_id[8:], safe='')
-            )
+            ))
 
         # handle document url
-        return posixpath.join(
+        return '/'.join((
             self._database_host,
             url_quote_plus(self._database_name),
             url_quote(self._document_id, safe='')
-        )
+        ))
 
     def exists(self):
         """
@@ -389,7 +388,7 @@ def get_attachment(
         """
         # need latest rev
         self.fetch()
-        attachment_url = posixpath.join(self.document_url, attachment)
+        attachment_url = '/'.join((self.document_url, attachment))
         if headers is None:
             headers = {'If-Match': self['_rev']}
         else:
@@ -432,7 +431,7 @@ def delete_attachment(self, attachment, headers=None):
         """
         # need latest rev
         self.fetch()
-        attachment_url = posixpath.join(self.document_url, attachment)
+        attachment_url = '/'.join((self.document_url, attachment))
         if headers is None:
             headers = {'If-Match': self['_rev']}
         else:
@@ -473,7 +472,7 @@ def put_attachment(self, attachment, content_type, data, headers=None):
         """
         # need latest rev
         self.fetch()
-        attachment_url = posixpath.join(self.document_url, attachment)
+        attachment_url = '/'.join((self.document_url, attachment))
         if headers is None:
             headers = {
                 'If-Match': self['_rev'],

src/cloudant/index.py

@@ -16,7 +16,6 @@
 API module for managing/viewing query indexes.
 """
 
-import posixpath
 import json
 
 from ._2to3 import STRTYPE, iteritems_
@@ -60,7 +59,7 @@ def index_url(self):
 
         :returns: Index URL
         """
-        return posixpath.join(self._database.database_url, '_index')
+        return '/'.join((self._database.database_url, '_index'))
 
     @property
     def design_document_id(self):
@@ -166,7 +165,7 @@ def delete(self):
         ddoc_id = self._ddoc_id
         if ddoc_id.startswith('_design/'):
             ddoc_id = ddoc_id[8:]
-        url = posixpath.join(self.index_url, ddoc_id, self._type, self._name)
+        url = '/'.join((self.index_url, ddoc_id, self._type, self._name))
         resp = self._r_session.delete(url)
         resp.raise_for_status()
         return

src/cloudant/query.py

@@ -16,7 +16,6 @@
 API module for composing and executing Cloudant queries.
 """
 
-import posixpath
 import json
 import contextlib
 
@@ -105,7 +104,7 @@ def url(self):
 
         :returns: Query URL
         """
-        return posixpath.join(self._database.database_url, '_find')
+        return '/'.join((self._database.database_url, '_find'))
 
     def __call__(self, **kwargs):
         """

src/cloudant/view.py

@@ -16,7 +16,6 @@
 API module for interacting with a view in a design document.
 """
 import contextlib
-import posixpath
 
 from ._2to3 import STRTYPE
 from ._common_util import codify, get_docs
@@ -168,11 +167,11 @@ def url(self):
 
         :returns: View URL
         """
-        return posixpath.join(
+        return '/'.join((
             self.design_doc.document_url,
             '_view',
             self.view_name
-        )
+        ))
 
     def __call__(self, **kwargs):
         """