Merge branch 'arangoV3'

Author: tariqdaouda

CHANGELOG.rst

@@ -0,0 +1,9 @@
+1.1.0
+======
+
+* Support for ArangoDB 3.X, pyArango no longer supports 2.X versions
+* Support for anthentification
+* Adedd AikidoSession to seemlessly manage request sessions
+* AikidoSession stores basic stats about the requests
+* save() and patch() functions now empty _patchStore is succesfull
+* _from and _to are are no longer private object attribute, they are now accessed using ["_from"] and ["_to"].

pyArango/collection.py

@@ -232,7 +232,6 @@ def __init__(self, database, jsonData) :
 		self.documentClass = Document
 		self.indexes = {
 			"primary" : {},
-			"cap" : {},
 			"hash" : {},
 			"skiplist" : {},
 			"geo" : {},
@@ -268,19 +267,6 @@ def createDocument(self, initValues = {}) :
 		"create and returns a document"
 		return self.documentClass(self, initValues)
 
-	def ensureCapConstraint(self, size, byteSize = None) :
-		"""Ensures that there's a cap constraint in the collection, and returns it"""
-		data = { 
-			"type" : "cap",
-			"size" : size,
-		}
-		if byteSize is not None :
-			data["byteSize"] = byteSize
-
-		ind = Index(self, creationData = data)
-		self.indexes["cap"][ind.infos["id"]] = ind
-		return ind
-
 	def ensureHashIndex(self, fields, unique = False, sparse = True) :
 		"""Creates a hash index if it does not already exist, and returns it"""
 		data = { 
@@ -403,14 +389,6 @@ def fetchByExample(self, exampleDict, batchSize, rawResults = False, **queryArgs
 		"exampleDict should be something like {'age' : 28}"
 		return self.simpleQuery('by-example', rawResults, example = exampleDict, batchSize = batchSize, **queryArgs)
 
-	def fetchFirst(self, count, rawResults = False) :
-		"""Returns the first document inserted in a collection"""
-		return self.simpleQuery('first', rawResults = rawResults, count = count)
-
-	def fetchLast(self, count, rawResults = False) :
-		"""Returns the last document inserted in a collection"""
-		return self.simpleQuery('last', rawResults = rawResults, count = count)
-
 	def fetchFirstExample(self, exampleDict, rawResults = False) :
 		"""exampleDict should be something like {'age' : 28}. returns only a single element but still in a SimpleQuery object.
 		returns the first example found that matches the example"""
@@ -529,11 +507,9 @@ class Edges(Collection) :
 	def __init__(self, database, jsonData) :
 		"This one is meant to be called by the database"
 		Collection.__init__(self, database, jsonData)
-		self.arangoPrivates.extend(["_to", "_from"])
 		self.documentClass = Edge
-		self.documentsURL = "%s/edge" % (self.database.URL)
-		self.edgesURL = "%ss/%s" % (self.documentsURL, self.name)
-
+		self.edgesURL = "%s/edges/%s" % (self.database.URL, self.name)
+		
 	def createEdge(self, initValues = {}) :
 		"alias for createDocument, both functions create an edge"
 		return self.createDocument(initValues)

pyArango/connection.py

@@ -4,9 +4,51 @@
 from database import Database, DBHandle
 from theExceptions import SchemaViolation, CreationError, ConnectionError
 
+class AikidoSession(object) :
+	"""Magical Aikido being that you probably do not need to access directly that deflects every http request to requests in the most graceful way.
+	It will also save basic stats on requests in it's attribute '.log'.
+	"""
+
+	class Holder(object) :
+		def __init__(self, session, fct) :
+			self.session = session
+			self.fct = fct
+
+		def __call__(self, *args, **kwargs) :
+			if self.session.auth :
+				kwargs["auth"] = self.session.auth
+			return self.fct(*args, **kwargs)
+
+	def __init__(self, username, password) :
+		if username and password :
+			self.auth = (username, password)
+		else :
+			self.auth = None
+
+		self.session = requests.Session()
+		self.log = {}
+		self.log["nb_request"] = 0
+		self.log["requests"] = {}
+
+	def __getattr__(self, k) :
+		try :
+			reqFct = getattr(object.__getattribute__(self, "session"), k)
+		except :
+			raise AttributeError("Attribute '%s' not found (no Aikido move available)" % k)
+		
+		holdClass = object.__getattribute__(self, "Holder")
+		log = object.__getattribute__(self, "log")
+		log["nb_request"] += 1
+		try :
+			log["requests"][reqFct.__name__] += 1
+		except :
+			log["requests"][reqFct.__name__] = 1
+
+		return holdClass(self, reqFct)
+
 class Connection(object) :
 	"""This is the entry point in pyArango and direcltt handles databases."""
-	def __init__(self, arangoURL = 'http://localhost:8529') :
+	def __init__(self, arangoURL = 'http://localhost:8529', username=None, password=None) :
 		self.databases = {}
 		if arangoURL[-1] == "/" :
 			self.arangoURL = url[:-1]
@@ -17,19 +59,21 @@ def __init__(self, arangoURL = 'http://localhost:8529') :
 		self.databasesURL = '%s/database' % self.URL
 
 		self.session = None
-		self.resetSession()
+		self.resetSession(username, password)
 		self.reload()
 
-	def resetSession(self) :
+	def resetSession(self, username=None, password=None) :
 		"""resets the session"""
-		self.session = requests.Session()
+		self.session = AikidoSession(username, password)
 
 	def reload(self) :
 		"""Reloads the database list.
 		Because loading a database triggers the loading of all collections and graphs within,
 		only handles are loaded when this function is called. The full databases are loaded on demand when accessed
 		"""
+
 		r = self.session.get(self.databasesURL)
+
 		data = r.json()
 		if r.status_code == 200  and not data["error"] :
 			self.databases = {}

pyArango/database.py

@@ -39,14 +39,13 @@ def reloadCollections(self) :
 		if r.status_code == 200 :
 			self.collections = {}
 
-			for colData in data["collections"] :
+			for colData in data["result"] :
 				colName = colData['name']
 				if colData['isSystem'] :
 					colObj = COL.SystemCollection(self, colData)
 				else :
 					try :
 						colClass = COL.getCollectionClass(colName)
-						# if colName[0] != "_" :
 						colObj = colClass(self, colData)
 					except KeyError :
 						if colData["type"] == COL.COLLECTION_EDGE_TYPE :
@@ -156,19 +155,13 @@ def _checkCollectionList(lst) :
 		payload = json.dumps(payload)
 		r = self.connection.session.post(self.graphsURL, data = payload)
 		data = r.json()
-		if r.status_code == 201 :
+
+		if r.status_code == 201 or r.status_code == 202 :
 			self.graphs[name] = graphClass(self, data["graph"])
 		else :
 			raise CreationError(data["errorMessage"], data)		
 		return self.graphs[name]
 
-	# def _checkGraphCollections(self, edgeDefinitions, orphanCollections) :
-	# 	for ed in edgeDefinitions :	
-	# 		checkList(ed["from"])
-	# 		checkList(ed["to"])
-		
-	# 	checkList(orphanCollections)
-
 	def hasCollection(self, name) :
 		"""returns true if the databse has a collection by the name of 'name'"""
 		return name in self.collections

pyArango/document.py

@@ -82,7 +82,8 @@ def save(self, waitForSync = False, **docArgs) :
 				update = True
 
 			data = r.json()
-			if (r.status_code == 201 or r.status_code == 202) and not data['error'] :
+			
+			if (r.status_code == 201 or r.status_code == 202) and "error" not in data :
 				if update :
 					self._rev = data['_rev']
 				else :
@@ -95,6 +96,8 @@ def save(self, waitForSync = False, **docArgs) :
 
 			self.modified = False
 
+		self._patchStore = {}
+
 	def forceSave(self, **docArgs) :
 		"saves even if the document has not been modified since the last save"
 		self.modified = True
@@ -125,20 +128,23 @@ def patch(self, keepNull = True, **docArgs) :
 
 			r = self.connection.session.patch(self.URL, params = params, data = payload)
 			data = r.json()
-			if (r.status_code == 201 or r.status_code == 202) and not data['error'] :
+			if (r.status_code == 201 or r.status_code == 202) and "error" not in data :
 				self._rev = data['_rev']
 			else :
 				raise UpdateError(data['errorMessage'], data)
 
 			self.modified = False
 
+		self._patchStore = {}
+	
 	def delete(self) :
 		"deletes the document from the database"
 		if self.URL is None :
 			raise DeletionError("Can't delete a document that was not saved") 
 		r = self.connection.session.delete(self.URL)
 		data = r.json()
-		if (r.status_code != 200 and r.status_code != 202) or data['error'] :
+
+		if (r.status_code != 200 and r.status_code != 202) or 'error' in data :
 			raise DeletionError(data['errorMessage'], data)
 		self.reset(self.collection)
 
@@ -218,52 +224,37 @@ def reset(self, edgeCollection, jsonFieldInit = {}) :
 		Document.reset(self, edgeCollection, jsonFieldInit)
 		self.typeName = "ArangoEdge"
 
-	def setPrivates(self, jsonFieldInit) :
-		try :
-			self._from = jsonFieldInit["_from"]
-			del(jsonFieldInit["_from"])
-			self._to = jsonFieldInit["_to"]
-			del(jsonFieldInit["_to"])
-		except KeyError :
-			self._from, self._to = None, None
-		Document.setPrivates(self, jsonFieldInit)
-
 	def links(self, fromVertice, toVertice, **edgeArgs) :
-		"An alias of save that works only for first saves. It will also trigger the saving of fromVertice and toVertice"
-		if self.URL is not None :
-			raise AttributeError("It appears that the edge has already been saved. You can now use save() and patch()")
-		
-		fromVertice.save()
-		toVertice.save()
-
-		self.save(fromVertice, toVertice, **edgeArgs)
-
-	def save(self, fromVertice = None, toVertice = None, **edgeArgs) :
-		"""Works like Document's except that the first time you save an Edge you must specify the 'from' and 'to' vertices.
-		There's also a links() function especially for first saves"""
-		import types
-
-		if self.URL is None and (fromVertice is None or toVertice is None) :
-			raise ValueError("The first time you save an Edge you must specify the 'from' and 'to' vertices")
+		"""
+		An alias to save that updates the _from and _to attributes.
+		fromVertice and toVertice, can be either strings or documents. It they are unsaved documents, they will be automatically saved.
+		"""
 
 		if fromVertice.__class__ is Document :
-			edgeArgs["from"] = fromVertice._id
-			self._from = edgeArgs["from"]
+			if not fromVertice._id :
+				fromVertice._id.save()
+
+			self["_from"] = fromVertice._id
 		elif (type(fromVertice) is types.StringType) or (type(fromVertice) is types.UnicodeType) :
-			edgeArgs["from"] = fromVertice
-			self._from = edgeArgs["from"]
-		else :
-			if not self._from :
-				raise ValueError("fromVertice must be either a Document or a String, got: %s" % fromVertice)
+			self["_from"] = fromVertice
 
 		if toVertice.__class__ is Document :
-			edgeArgs["to"] = toVertice._id
-			self._to = edgeArgs["to"]
+			if not toVertice._id :
+				toVertice._id.save()
+
+			self["_to"] = toVertice._id
 		elif (type(toVertice) is types.StringType) or (type(toVertice) is types.UnicodeType) :
-			edgeArgs["to"] = toVertice
-			self._to = edgeArgs["to"]
-		else :
-			if not self._to :
-				raise ValueError("toVertice must be either a Document or a String, got: %s" % fromVertice)
+			self["_to"] = toVertice
+
+		self.save(**edgeArgs)
+
+	def save(self, **edgeArgs) :
+		"""Works like Document's except that you must specify '_from' and '_to' vertices before.
+		There's also a links() function especially for first saves."""
+		
+		import types
+
+		if "_from" not in self._store or "_to" not in self._store :
+			raise AttributeError("You must specify '_from' and '_to' attributes before saving. You can also use the function 'links()'")
 
 		Document.save(self, **edgeArgs)

pyArango/graph.py

@@ -92,20 +92,6 @@ def __init__(self, database, jsonInit) :
 				raise KeyError("'%s' is not a valid edge collection" % de.name)
 			self.definitions[de.name] = de
 
-		# for e in jsonInit["edgeDefinitions"] :
-		# 	if e["collection"] not in self._edgeDefinitions :
-		# 		raise CreationError("Collection '%s' is not mentioned in the definition of graph '%s'" % (e["collection"], self.__class__,__name__))
-		# 	if e["from"] != self._edgeDefinitions[e["collection"]]["from"] :
-		# 		vals = (e["collection"], self.__class__,__name__, self._edgeDefinitions[e["collection"]]["from"], e["from"])
-		# 		raise CreationError("Edge definition '%s' of graph '%s' mismatch for 'from':\npython:%s\narangoDB:%s" % vals)
-		# 	if e["to"] != self._edgeDefinitions[e["collection"]]["to"] :
-		# 		vals = (e["collection"], self.__class__,__name__, self._edgeDefinitions[e["collection"]]["to"], e["to"])
-		# 		raise CreationError("Edge definition '%s' of graph '%s' mismatch for 'to':\npython:%s\narangoDB:%s" % vals )
-		# 	defs.append(e["collection"])
-
-		# if jsonInit["orphanCollections"] != self._orphanCollections :
-		# 	raise CreationError("Orphan collection '%s' of graph '%s' mismatch:\npython:%s\narangoDB:%s" (e["collection"], self.__class__,__name__, self._orphanCollections, jsonInit["orphanCollections"]))
-			
 		self.URL = "%s/%s" % (self.database.graphsURL, self._key)
 
 	def createVertex(self, collectionName, docAttributes, waitForSync = False) :
@@ -171,7 +157,7 @@ def delete(self) :
 		"""deletes the graph"""
 		r = self.connection.session.delete(self.URL)
 		data = r.json()
-		if not r.status_code == 200 or data["error"] :
+		if r.status_code < 200 or r.status_code > 202 or data["error"] :
 			raise DeletionError(data["errorMessage"], data)
 
 	def traverse(self, startVertex, **kwargs) :
@@ -192,7 +178,7 @@ def traverse(self, startVertex, **kwargs) :
 
 		r = self.connection.session.post(url, data = json.dumps(payload))
 		data = r.json()
-		if not r.status_code == 200 or data["error"] :
+		if r.status_code < 200 or r.status_code > 202 or data["error"] :
 			raise TraversalError(data["errorMessage"], data)
 
 		return data["result"]