Merge branch 'master' into json-renderer-decorator

.landscape.yml

@@ -0,0 +1,5 @@
+ignore-patterns:
+    - ^bootstrap.*\.py$
+pylint:
+  disable:
+    - inherit-non-class  # zope.interface

CHANGES.rst

@@ -1,8 +1,14 @@
 Changelog
 =========
 
-1.0a1 (unreleased)
+1.0a2 (unreleased)
+------------------
+
+- Nothing changed yet.
+
+
+1.0a1 (2015-08-01)
 ------------------
 
 - Initial release.
-  [bloodbare,timo]
+  [bloodbare, timo]

README.rst

@@ -1,10 +1,38 @@
-==============================================================================
+.. image:: https://secure.travis-ci.org/plone/plone.rest.png?branch=master
+  :target: http://travis-ci.org/plone/plone.rest
+
+.. image:: https://coveralls.io/repos/plone/plone.rest/badge.png?branch=master
+  :target: https://coveralls.io/r/plone/plone.rest
+
+.. image:: https://landscape.io/github/plone/plone.rest/master/landscape.svg?style=plastic
+  :target: https://landscape.io/github/plone/plone.rest/master
+  :alt: Code Health
+
+
+==========
 Plone REST
-==============================================================================
+==========
 
-plone.rest allows you to use HTTP verbs such as GET, POST, PUT, DELETE, etc. in Plone.
+Purpose
+-------
 
-REST stands for `Representational State Transfer`_. It is a software architectural principle to create loosely coupled web APIs. plone.rest just provides the basic infrastructure that allows us to build RESTful endpoints on top of it. If you are looking for a full RESTful Plone API, please have a look at `plone.restapi`_.
+plone.rest allows you to use HTTP verbs such as GET, POST, PUT, DELETE, etc. in `Plone <https://www.plone.org>`_.
+
+REST stands for `Representational State Transfer <http://en.wikipedia.org/wiki/Representational_state_transfer>`_.
+It is a software architectural principle to create loosely coupled web APIs.
+
+plone.rest provides the basic infrastructure that allows us to build RESTful endpoints in Plone.
+
+The reason for separating this infrastructure into a separate package from the 'main' full `Plone REST API <https://github.com/plone/plone.restapi>`_ is so you can create alternative endpoints tailored to specific usecases. A number of these specific end points are already in active use.
+
+
+Audience
+--------
+
+plone.rest is for experienced web developers who want to build their own endpoints on top of Plone.
+
+If you want to **use** a ready-made full RESTful Plone API, you should use `plone.restapi <https://github.com/plone/plone.restapi>`_.
+That package uses, and depends upon, this one.
 
 
 Features
@@ -27,12 +55,14 @@ Registering RESTful Service Endpoints
 
 plone.rest allows you to register HTTP verbs for Plone content with ZCML.
 
-This is how you would register a PATCH request on Dexterity content::
+This is how you would register a PATCH request on Dexterity content:
+
+.. code-block:: xml
 
   <plone:service
     method="PATCH"
     for="plone.dexterity.interfaces.IDexterityContent"
-    factory=".service.PATCH"
+    factory=".service.Patch"
     />
 
 You have to specify the HTTP verb (GET, POST, PUT, DELETE, HEAD, OPTIONS), the interface for the content objects and the factory class that actually returns the content.
@@ -68,13 +98,15 @@ The server then will respond with '200 OK'::
     'message': 'PATCH: Hello World!'
   }
 
-You can try this out on the command line::
+You can try this out on the command line:
+
+.. code-block:: console
 
-  $ http --auth admin:admin PATCH localhost:8080/Plone/doc1 Accept:application/json
+    $ http --auth admin:admin PATCH localhost:8080/Plone/doc1 Accept:application/json
 
 .. note:: You have to install httpie (pip install httpie) to make this example work.
 
-Here is a list of examples for all HTTP verbs.
+Here is a list of examples for all supported HTTP verbs:
 
 GET::
 
@@ -129,16 +161,11 @@ Support
 
 This package is maintained by Timo Stollenwerk <tisto@plone.org> and Ramon Navarro Bosch <ramon.nb@gmail.com>.
 
-If you are having issues, please `let us know`_.
+If you are having issues, please `let us know <https://github.com/plone/plone.rest/issues>`_.
 
 
 License
 -------
 
 The project is licensed under the GPLv2.
 
-.. _`Representational State Transfer`: http://en.wikipedia.org/wiki/Representational_state_transfer
-
-.. _`plone.restapi`: https://github.com/plone/plone.rest
-
-.. _`let us know`: https://github.com/plone/plone.rest/issues

bootstrap.py

@@ -0,0 +1,189 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os
+import shutil
+import sys
+import tempfile
+
+from optparse import OptionParser
+
+tmpeggs = tempfile.mkdtemp()
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --find-links to point to local resources, you can keep
+this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", help="use a specific zc.buildout version")
+
+parser.add_option("-t", "--accept-buildout-test-releases",
+                  dest='accept_buildout_test_releases',
+                  action="store_true", default=False,
+                  help=("Normally, if you do not specify a --version, the "
+                        "bootstrap script and buildout gets the newest "
+                        "*final* versions of zc.buildout and its recipes and "
+                        "extensions for you.  If you use this flag, "
+                        "bootstrap and buildout will get the newest releases "
+                        "even if they are alphas or betas."))
+parser.add_option("-c", "--config-file",
+                  help=("Specify the path to the buildout configuration "
+                        "file to be used."))
+parser.add_option("-f", "--find-links",
+                  help=("Specify a URL to search for buildout releases"))
+parser.add_option("--allow-site-packages",
+                  action="store_true", default=False,
+                  help=("Let bootstrap.py use existing site packages"))
+parser.add_option("--setuptools-version",
+                  help="use a specific setuptools version")
+
+
+options, args = parser.parse_args()
+
+######################################################################
+# load/install setuptools
+
+try:
+    if options.allow_site_packages:
+        import setuptools
+        import pkg_resources
+    from urllib.request import urlopen
+except ImportError:
+    from urllib2 import urlopen
+
+ez = {}
+exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
+
+if not options.allow_site_packages:
+    # ez_setup imports site, which adds site packages
+    # this will remove them from the path to ensure that incompatible versions
+    # of setuptools are not in the path
+    import site
+    # inside a virtualenv, there is no 'getsitepackages'.
+    # We can't remove these reliably
+    if hasattr(site, 'getsitepackages'):
+        for sitepackage_path in site.getsitepackages():
+            sys.path[:] = [x for x in sys.path if sitepackage_path not in x]
+
+setup_args = dict(to_dir=tmpeggs, download_delay=0)
+
+if options.setuptools_version is not None:
+    setup_args['version'] = options.setuptools_version
+
+ez['use_setuptools'](**setup_args)
+import setuptools
+import pkg_resources
+
+# This does not (always?) update the default working set.  We will
+# do it.
+for path in sys.path:
+    if path not in pkg_resources.working_set.entries:
+        pkg_resources.working_set.add_entry(path)
+
+######################################################################
+# Install buildout
+
+ws = pkg_resources.working_set
+
+cmd = [sys.executable, '-c',
+       'from setuptools.command.easy_install import main; main()',
+       '-mZqNxd', tmpeggs]
+
+find_links = os.environ.get(
+    'bootstrap-testing-find-links',
+    options.find_links or
+    ('http://downloads.buildout.org/'
+     if options.accept_buildout_test_releases else None)
+    )
+if find_links:
+    cmd.extend(['-f', find_links])
+
+setuptools_path = ws.find(
+    pkg_resources.Requirement.parse('setuptools')).location
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+    # Figure out the most recent final version of zc.buildout.
+    import setuptools.package_index
+    _final_parts = '*final-', '*final'
+
+    def _final_version(parsed_version):
+        try:
+            return not parsed_version.is_prerelease
+        except AttributeError:
+            # Older setuptools
+            for part in parsed_version:
+                if (part[:1] == '*') and (part not in _final_parts):
+                    return False
+            return True
+
+    index = setuptools.package_index.PackageIndex(
+        search_path=[setuptools_path])
+    if find_links:
+        index.add_find_links((find_links,))
+    req = pkg_resources.Requirement.parse(requirement)
+    if index.obtain(req) is not None:
+        best = []
+        bestv = None
+        for dist in index[req.project_name]:
+            distv = dist.parsed_version
+            if _final_version(distv):
+                if bestv is None or distv > bestv:
+                    best = [dist]
+                    bestv = distv
+                elif distv == bestv:
+                    best.append(dist)
+        if best:
+            best.sort()
+            version = best[-1].version
+if version:
+    requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+import subprocess
+if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
+    raise Exception(
+        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
+
+######################################################################
+# Import and run buildout
+
+ws.add_entry(tmpeggs)
+ws.require(requirement)
+import zc.buildout.buildout
+
+if not [a for a in args if '=' not in a]:
+    args.append('bootstrap')
+
+# if -c was provided, we push it back into args for buildout' main function
+if options.config_file is not None:
+    args[0:0] = ['-c', options.config_file]
+
+zc.buildout.buildout.main(args)
+shutil.rmtree(tmpeggs)

buildout.cfg

@@ -0,0 +1,3 @@
+[buildout]
+extends = plone-4.3.x.cfg
+

heroku.cfg

@@ -0,0 +1,39 @@
+[buildout]
+extends = buildout.cfg
+relative-paths = true
+parts =
+    instance
+    demosite
+
+[instance]
+relative-paths = true
+eggs +=
+    RelStorage
+    psycopg2
+    plone.rest
+rel-storage =
+    keep-history false
+    blob-dir /tmp/blobcache
+    shared-blob-dir false
+    type postgresql
+    host PG_HOST
+    dbname PG_DBNAME
+    user PG_USER
+    password PG_PASS
+
+[demosite]
+recipe = collective.recipe.plonesite
+site-id = Plone
+instance = instance
+profiles-initial =
+    Products.CMFPlone:plone-content
+
+
+[versions]
+#zc.buildout = 1.7.1
+#plone.app.jquery = 1.8.3
+#docutils = 0.12
+#six = 1.8.0
+#pytz = 2012rc0
+#pep8 = 1.6.1
+#Pygments = 2.0

plone-5.0.x.cfg

@@ -1,6 +1,6 @@
 [buildout]
 extends =
     base.cfg
-    http://dist.plone.org/release/5.0b3-pending/versions.cfg
+    http://dist.plone.org/release/5.0b3/versions.cfg
     versions.cfg
 

setup.py

@@ -5,7 +5,7 @@
 def read(*rnames):
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
-version = '1.0a1'
+version = '1.0a2.dev0'
 
 long_description = (
     read('README.rst')