viur-framework · tsteinruecken · Feb 9, 2018 · Jan 23, 2017 · Jan 23, 2017 · Jan 24, 2017
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,45 @@
 
 ## [Unreleased]
 
+## [2.1.0] - 2017-10-25
+
+### Added
+ - New edit form templates following the ViUR ignite standard
+ - Pass the error description of HTTPException to the underlying webob framework
+ - ignore/hide parameter to our renderEditForm jinja2 function
+ - New parameter "params" to explicitly pass additional values to the template / json response
+ - Retrieving the viewSkel Structure by calling modulePath/view/structure
+ - \_\_iter\_\_ function to skeletons
+ - embedSvg function to html render
+ - onLogout hook to the user module
+ - Expose the unique property in skel-structures in json render
+ - viur.emailHandler config variable for easy integration of 3rd party email services
+
+### Changed
+ - Pre-translate the descriptions of selectOne/selectMulti bones in add or edit calls (as done in views)
+ - Listing and calling user-callable tasks is now also possible for the vi render
+ - Internally switched to more efficient membership tests for dicts
+ - userBones with creation- or update-magic set are not forced to be invisible anymore
+ - Don't set skel["key"] to None if skel.delete() is called
+ - Relational bones can now include properties from ref-/rel-skel bones in search indexes
+ - Setting update- or creation-magic on userBones don't force them to be invisible anymore
+ - *[Breaking]* Internal representation of relations are now dicts, not instances of Ref- or Rel-Skels
+
+### Fixed
+ - handle ValueError in int() or float() in numericBone:buildDbFilter
+ - serializing a textBone failing in getSearchDocumentFields if valuesCache[name] is None
+ - Correctly handle None values in numericBones getSearchDocumentFields()
+ - Added missing imports to dbtransfer.py
+ - Several issues with writing search api indexes for relationalBones
+ - Usage of old Skeleton-API in orders module
+ - Users without access to the vi/admin render couldn't logout using these renders
+ - Call setSystemInitialized on all skeletons (not only skels having kindName set)
+ - Type-mismatch in html-render causing errors if a RelSkel is present
+ - Parsing dates containing non-unicode characters
+
+### Removed
+ - *[Breaking]* "key"-Parameter from skeleton.setValues()
+
 
 ## [2.0.3] - 2017-08-30
 

diff --git a/README.md b/README.md
@@ -1,104 +1,56 @@
-ViUR® is a free software development framework for the Google App Engine™.
-More about ViUR can be found at http://www.viur.is/.
-
-DESCRIPTION
-===========
-
-**ViUR®** is an application development framework that mainly focuses to
-implement cloud-based information systems on top of the
-[Google AppEngine™ platform](http://appengine.google.com).
-
-By design, ViUR-based applications are build upon simple, clear, flexible,
-extendible, versatile, high-scalable and easy-to-use concepts. To fit the
-requirements of modern agile software development workflows, ViUR is entirely
-written in the [Python programming language](http://www.python.org/).
-
-Applications implemented in ViUR are not only limited to websites or any other
-kind of specialized web-application. Therefore, we call ViUR an information
-system, because it goes beyond the limitations of a content-management-system
-or other kinds of specialized web-application software.
-
-ViUR helps to manage any kind of information. It comes with a set of four
-pre-defined application kinds which can be used to build modules for any
-desired tasks. The system comes with a variety of pre-defined modules, which
-can easily be adapted for particular goals. New modules are simply created or
-extended from other ones. Data structures can be defined, extended and changed
-during the development workflow. Input masks and data management interfaces
-for all informations hold in the information system are dynamically created
-within the administration tools.
-
-ViUR currently exists of three parts:
-
-- The **server** is the core of a ViUR application. It provides the
-  server-library of the web-application, providing pre-defined data-models,
-  modules, tools and libraries for data management and much more, and several
-  renders to support different output kinds.
-  (Download it at https://bitbucket.org/viur/server)
-- The **vi** (visual interface), is the web-based administration backend for
-  ViUR written in pure HTML5, to provide an easy-to-access management tool
-  that directly runs system-independently in the web-browser of any desktop or
-  even mobile devices. (Download it at https://bitbucket.org/viur/vi)
-- The **admin** is the client-based, cross-platform administration backend to
-  manage a ViUR application. It focuses on power-users that want to manage
-  their applications with the full power of a desktop client computer.
-  (Download it at https://bitbucket.org/viur/admin)
-
-Both administration tools support the integration of application-specific
-plug-ins and can be used independently, depending on what is wanted and
-required.
-
-PREREQUISITES
-=============
-
-The server components of ViUR are written in **Python 2.7** because they are
-based on the Google App Engine SDK. The [Google App Engine SDK](https://cloud.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python)
-is required for testing and deployment in the latest version.
-
-As client system, Windows, OS X and Linux are supported, but Linux will give
-you the best platform for development tasks with ViUR.
-
-QUICK START
-===========
+# ViUR server
+
+**ViUR** is a free software development framework for the [Google App Engine](https://appengine.google.com).
+
+## About
+
+ViUR provides a clear concept for implementing agile data management software that runs on top of the [Google App Engine](https://appengine.google.com) platform. It is written in the [Python programming language](https://python.org) for a maximum flexibility and easy-to-manage code. Its underlying database is Googles Cloud Datastore, which is a scalable document database.
+
+The ViUR framework targets to the implementation of information systems, which are integrated, web-based applications or services performing data management and deployment operations of any kind. Therefore, ViUR is explicitly not claimed to be a content management system, although content management can be a part of a ViUR information system.
+
+## Quick Start
 
 To quickly setup a running ViUR web-application from scratch, follow these
 simple steps:
 
-1. Install the prerequisites (Python and Google App Engine SDK for your
-   operating system).
+1. Install the prerequisites Python and [Google Cloud SDK for Python](https://cloud.google.com/sdk) for your operating system.
 2. Create an empty folder for your project.
-3. Download setup.py from http://www.viur.is/package/download/setup/latest and
-   save it into the newly created folder.
+3. Download setup.py from https://www.viur.is/package/download/setup/latest and save it into the newly created folder.
 4. Run ``setup.py`` from that folder - it will do the rest for you!
-5. Locally run the development server with ``dev_appserver.py <project-dir>``
-   or deploy it to the world with ``appcfg.py update <project-dir>``.
+5. Locally run the development server with ``dev_appserver.py -A <your-project-key> <project-dir>``
+   or deploy it to the world with ``gcloud app deploy --project <your-project-key> <your-project-dir>``.
 
-Visit the official ViUR online documentation at http://docs.viur.is/latest for
-more information.
+All quick start steps as shell command snippet:
 
-WHO CREATES VIUR?
-=================
+```sh
+mkdir hello-viur                                                      # Setup project folder
+cd hello-viur                                                         # Change into this folder
+wget -qO setup.py https://www.viur.is/package/download/setup/latest   # Download latest setup
+python setup.py                                                       # Run ViUR setup tool
+dev_appserver.py -A hello-viur .                                      # Start Google App Engine
+```
 
-ViUR is developed and maintained by mausbrand Informationssysteme GmbH,
-from Dortmund, Germany.
+Visit the official [ViUR online documentation](https://docs.viur.is/latest) for more information.
 
-We are a software company consisting of young, enthusiastic software
-developers, designers and social media experts, working on exciting
-projects for different kinds of customers. All of our newer projects are
-implemented with ViUR, from tiny web-pages to huge company intranets with
-hundreds of users.
+## Contributing
 
-Help of any kind to extend and improve or enhance this project in any kind or 
-way is always appreciated.
+We take a great interest in your opinion about ViUR. We appreciate your feedback and are looking forward to hear about your ideas. Share your visions or questions with us and participate in ongoing discussions.
 
-LICENSING
-=========
+- [ViUR on the web](https://www.viur.is)
+- [#ViUR on freenode IRC](https://webchat.freenode.net/?channels=viur)
+- [ViUR on Google Community](https://plus.google.com/communities/102034046048891029088)
+- [ViUR on Twitter](https://twitter.com/weloveViUR)
 
-ViUR is Copyright (C) 2012-2017 by Mausbrand Informationssysteme GmbH.
+## Credits
+
+ViUR is developed and maintained by [Mausbrand Informationssysteme GmbH](https://www.mausbrand.de/en), from Dortmund in Germany. We are a software company consisting of young, enthusiastic software developers, designers and social media experts, working on exciting projects for different kinds of customers. All of our newer projects are implemented with ViUR, from tiny web-pages to huge company intranets with hundreds of users.
+
+Help of any kind to extend and improve or enhance this project in any kind or way is always appreciated.
 
-Mausbrand and ViUR are registered trademarks of
-Mausbrand Informationssysteme GmbH.
+## License
+
+ViUR is Copyright (C) 2012-2017 by Mausbrand Informationssysteme GmbH.
 
-You may use, modify and distribute this software under the terms and
-conditions of the GNU Lesser General Public License (LGPL).
+Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.
 
-See the file LICENSE provided in this package for more information.
+You may use, modify and distribute this software under the terms and conditions of the GNU Lesser General Public License (LGPL). See the file LICENSE provided within this package for more information.
diff --git a/__init__.py b/__init__.py
@@ -25,7 +25,7 @@
  See file LICENSE for more information.
 """
 
-__version__ = (2, 0, 3)  # Which API do we expose to our application
+__version__ = (2, 1, 0)  # Which API do we expose to our application
 
 import sys, traceback, os, inspect
 
@@ -132,22 +132,22 @@ def translate( key, **kwargs ):
 	res = None
 	lang = lang or conf["viur.defaultLanguage"]
 
-	if "_lang" in kwargs.keys():
+	if "_lang" in kwargs:
 		lang = kwargs[ "_lang" ]
 
-	if lang in conf["viur.languageAliasMap"].keys():
+	if lang in conf["viur.languageAliasMap"]:
 		lang = conf["viur.languageAliasMap"][ lang ]
 
 	if lang and lang in dir( translations ):
 		langDict = getattr(translations,lang)
 
-		if key.lower() in langDict.keys():
+		if key.lower() in langDict:
 			res = langDict[ key.lower() ]
 
 	if res is None and lang and lang in dir( servertrans ):
 		langDict = getattr(servertrans,lang)
 
-		if key.lower() in langDict.keys():
+		if key.lower() in langDict:
 			res = langDict[ key.lower() ]
 
 	if res is None and conf["viur.logMissingTranslations"]:
@@ -182,7 +182,7 @@ def setDefaultDomainLanguage( domain, lang ):
 		host = host[ 4: ]
 	conf["viur.domainLanguageMapping"][host] = lang.lower()
 
-### Multi-Language Part: END 
+### Multi-Language Part: END
 
 from server import session, errors
 from server.tasks import TaskHandler, runStartupTasks
@@ -234,7 +234,7 @@ def buildApp( config, renderers, default=None, *args, **kwargs ):
 	"""
 	class ExtendableObject( object ):
 		pass
-		
+
 	if isinstance( renderers,  dict ):
 		rendlist = renderers
 	else: # build up the dict from server.render
@@ -330,7 +330,7 @@ class BrowseHandler(webapp.RequestHandler):
 
 		:warning: Don't instantiate! Don't subclass! DON'T TOUCH! ;)
 	"""
-	
+
 	def get(self, path="/", *args, **kwargs): #Accept a HTTP-GET request
 		t1 = time()
 		if path=="_ah/start" or path=="_ah/warmup": #Warmup request
@@ -350,7 +350,7 @@ def post(self, path="/", *args, **kwargs): #Accept a HTTP-POST request
 	def head(self, path="/", *args, **kwargs): #Accept a HTTP-HEAD request
 		self.isPostRequest = False
 		self.processRequest( path, *args, **kwargs )
-		
+
 	def selectLanguage( self, path ):
 		"""
 			Tries to select the best language for the current request.
@@ -361,7 +361,7 @@ def selectLanguage( self, path ):
 		if conf["viur.languageMethod"] == "session":
 			# We store the language inside the session, try to load it from there
 			if not session.current.getLanguage():
-				if "X-Appengine-Country" in self.request.headers.keys():
+				if "X-Appengine-Country" in self.request.headers:
 					lng = self.request.headers["X-Appengine-Country"].lower()
 					if lng in conf["viur.availableLanguages"]+list( conf["viur.languageAliasMap"].keys() ):
 						session.current.setLanguage( lng )
@@ -375,7 +375,7 @@ def selectLanguage( self, path ):
 			host = host[ host.find("://")+3: ].strip(" /") #strip http(s)://
 			if host.startswith("www."):
 				host = host[ 4: ]
-			if host in conf["viur.domainLanguageMapping"].keys():
+			if host in conf["viur.domainLanguageMapping"]:
 				self.language = conf["viur.domainLanguageMapping"][ host ]
 			else: # We have no language configured for this domain, try to read it from session
 				if session.current.getLanguage():
@@ -471,7 +471,7 @@ def processRequest( self, path, *args, **kwargs ): #Bring up the enviroment for
 			if conf["viur.debug.traceExceptions"]:
 				raise
 			self.response.clear()
-			self.response.set_status( e.status )
+			self.response.set_status(e.status, e.descr)
 			res = None
 			if conf["viur.errorHandler"]:
 				try:
@@ -508,7 +508,7 @@ def processRequest( self, path, *args, **kwargs ): #Bring up the enviroment for
 			self.response.out.write( res )
 			if bugsnag and conf["bugsnag.apiKey" ]:
 				bugsnag.configure( api_key=conf["bugsnag.apiKey" ] )
-				try: 
+				try:
 					user = conf["viur.mainApp"].user.getCurrentUser()
 				except:
 					user = "-unknown-"
@@ -520,7 +520,7 @@ def processRequest( self, path, *args, **kwargs ): #Bring up the enviroment for
 				bugsnag.notify( e )
 		finally:
 			self.saveSession( )
-	
+
 
 	def findAndCall( self, path, *args, **kwargs ): #Do the actual work: process the request
 		# Prevent Hash-collision attacks
@@ -530,7 +530,7 @@ def findAndCall( self, path, *args, **kwargs ): #Do the actual work: process the
 		for key in tmpArgs.keys()[ : ]:
 			if len( tmpArgs[ key ] ) == 0:
 				continue
-			if not key in kwargs.keys():
+			if not key in kwargs:
 				if len( tmpArgs[ key ] ) == 1:
 					kwargs[ key ] = tmpArgs[ key ][0]
 				else:
@@ -541,7 +541,7 @@ def findAndCall( self, path, *args, **kwargs ): #Do the actual work: process the
 				else:
 					kwargs[key] = [ kwargs[key] ] + tmpArgs[key]
 		del tmpArgs
-		if "self" in kwargs.keys(): #self is reserved for bound methods
+		if "self" in kwargs: #self is reserved for bound methods
 			raise errors.BadRequest()
 		#Parse the URL
 		path = urlparse.urlparse( path ).path
@@ -670,7 +670,7 @@ def setup( modules, render=None, default="html" ):
 				if not skel.kindName:
 					# Looks like a common base-class for skeletons
 					continue
-				if skel.kindName in conf["viur.skeletons"].keys() and skel!=conf["viur.skeletons"][ skel.kindName ]:
+				if skel.kindName in conf["viur.skeletons"] and skel!=conf["viur.skeletons"][ skel.kindName ]:
 					# We have a conflict here, lets see if one skeleton is from server.*, and one from skeletons.*
 					relNewFileName = inspect.getfile(skel).replace( os.getcwd(),"" )
 					relOldFileName = inspect.getfile(conf["viur.skeletons"][ skel.kindName ]).replace( os.getcwd(),"" )
@@ -714,7 +714,7 @@ def setup( modules, render=None, default="html" ):
 			uri.lower().startswith("https://") or uri.lower().startswith("http://"))
 	runStartupTasks() #Add a deferred call to run all queued startup tasks
 	return( conf["viur.wsgiApp"] )
-	
+
 
 def run():
 	"""