Metadata-Version: 1.1
Name: senaite.jsonapi
Version: 1.1.0
Summary: SENAITE JSON API
Home-page: https://github.com/senaite/senaite.jsonapi
Author: SENAITE Foundation
Author-email: hello@senaite.com
License: GPLv3
Description-Content-Type: UNKNOWN
Description: SENAITE JSON API
        ================
        
        The JSON API provides a RESTful JSON interface to SENAITE LIMS.
        
        
        SENAITE JSON API v1
        ===================
        
        Running this test from the buildout directory::
        
            bin/test test_doctests -t JSONAPIv1
        
        
        Test Setup
        ----------
        
        Needed Imports::
        
            >>> import transaction
        
            >>> from plone.app.testing import TEST_USER_ID
            >>> from plone.app.testing import TEST_USER_PASSWORD
        
            >>> from senaite import api
        
        Functional Helpers::
        
            >>> def start_server():
            ...     from Testing.ZopeTestCase.utils import startZServer
            ...     ip, port = startZServer()
            ...     return "http://{}:{}/{}".format(ip, port, portal.id)
        
            >>> def login(user=TEST_USER_ID, password=TEST_USER_PASSWORD):
            ...     browser.open(portal_url + "/login_form")
            ...     browser.getControl(name='__ac_name').value = user
            ...     browser.getControl(name='__ac_password').value = password
            ...     browser.getControl(name='submit').click()
            ...     assert("__ac_password" not in browser.contents)
        
            >>> def logout():
            ...     browser.open(portal_url + "/logout")
            ...     assert("You are now logged out" in browser.contents)
        
        Variables::
        
            >>> portal = self.portal
            >>> portal_url = portal.absolute_url()
            >>> bika_setup = portal.bika_setup
            >>> bika_setup_url = portal_url + "/bika_setup"
            >>> browser = self.getBrowser()
        
        JSON API::
        
            >>> api_base_url = portal_url + "/@@API/senaite/v1"
        
        
        Version
        -------
        
        Ensure we are logged out::
        
            >>> logout()
        
        The version route should be visible to unauthenticated users::
        
            >>> browser.open(api_base_url + "/version")
            >>> browser.contents
            '{"url": "http://nohost/plone/@@API/senaite/v1/version", "date": "...", "version": ..., "_runtime": ...}'
        
        
        Changelog
        =========
        1.1.0 (2017-11-04)
        ------------------
        
        - Merged PR https://github.com/collective/plone.jsonapi.routes/pull/90
        - Get object by UID catalog
        
        
        1.0.1 (2017-09-30)
        ------------------
        
        - Fixed broken release (missing MANIFEST.in)
        
        
        1.0.0 (2017-09-30)
        ------------------
        
        - First release
        
        
        
        Authors and maintainers
        -----------------------
        
        - Ramon Bartl (RIDING BYTES) <rb@ridingbytes.com>
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Framework :: Plone
Classifier: Framework :: Zope2
