Merge pull request #63 from vladcalin/devel

Various bug fixes
vladcalin · Apr 22, 2017 · 325a49d · 325a49d
2 parents 54480d9 + 31600f8
commit 325a49d
Show file tree

Hide file tree

Showing 54 changed files with 629 additions and 408 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -1,6 +1,13 @@
 Changes
 =======
 
+0.12.0 (22.04.2017)
+~~~~~~~~~~~~~~~~~~~
+
+- restructured modules
+- bug fixes
+- improved documentation
+- improved tests
 
 0.11.0 (08.04.2017)
 ~~~~~~~~~~~~~~~~~~~

diff --git a/docs/index.rst b/docs/index.rst
@@ -32,6 +32,7 @@ Installation
 ------------
 
 ::
+
     pip install gemstone
     # or
     pip install gemstone[redis] # to use the Redis features
@@ -46,14 +47,14 @@ In a script ``hello_world.py`` write the following:
 
 ::
 
-    import gemstone
+    import gemstone.core
 
-    class HelloWorldService(gemstone.MicroService):
+    class HelloWorldService(gemstone.core.MicroService):
         name = "hello_world_service"
         host = "127.0.0.1"
         port = 8000
 
-        @gemstone.exposed_method()
+        @gemstone.core.exposed_method()
         def say_hello(self, name):
             return "hello {}".format(name)
 
@@ -81,7 +82,7 @@ To run it, run script
 
 Now we have the service listening on ``http://localhost:8000/api`` (the default configuration
 for the URL endpoint). In order to test it, you have to do a HTTP ``POST`` request to
-that address with the content:
+that URL with the content:
 
 ::
 
@@ -104,7 +105,7 @@ Table of contents:
     :maxdepth: 2
 
     topics/index
-    reference/index
+    reference/modules
     changes
 
 

diff --git a/docs/reference/client.rst b/docs/reference/client.rst
diff --git a/docs/reference/config.rst b/docs/reference/config.rst
diff --git a/docs/reference/discovery.rst b/docs/reference/discovery.rst
diff --git a/docs/reference/event_transport.rst b/docs/reference/event_transport.rst
diff --git a/docs/reference/gemstone.client.rst b/docs/reference/gemstone.client.rst
@@ -0,0 +1,31 @@
+The gemstone.client module
+==========================
+
+.. py:currentmodule:: gemstone.client
+.. automodule:: gemstone.client
+
+The gemstone.client.RemoteService class
+---------------------------------------
+
+    .. autoclass:: RemoteService
+        :members:
+
+
+Various structures
+------------------
+
+    .. autoclass:: AsyncMethodCall
+        :members:
+
+    .. autoclass:: MethodCall
+        :members:
+
+    .. autoclass:: Notification
+        :members:
+
+    .. autoclass:: Result
+        :members:
+
+    .. autoclass:: BatchResult
+        :members:
+
diff --git a/docs/reference/gemstone.config.rst b/docs/reference/gemstone.config.rst
@@ -0,0 +1,22 @@
+The gemstone.config module
+==========================
+
+.. py:currentmodule:: gemstone.config
+
+.. automodule:: gemstone.config
+
+
+Configurables
+-------------
+
+    .. autoclass:: Configurable
+        :members:
+
+Configurators
+-------------
+
+    .. autoclass:: BaseConfigurator
+        :members:
+
+    .. autoclass:: CommandLineConfigurator
+        :members:
diff --git a/docs/reference/gemstone.core.rst b/docs/reference/gemstone.core.rst
@@ -0,0 +1,64 @@
+The gemstone.core module
+========================
+
+
+.. automodule:: gemstone.core
+
+The gemstone.core.MicroService class
+------------------------------------
+
+    .. autoclass:: gemstone.core.MicroService
+
+        .. autoattribute:: gemstone.core.MicroService.name
+        .. autoattribute:: gemstone.core.MicroService.host
+        .. autoattribute:: gemstone.core.MicroService.port
+        .. autoattribute:: gemstone.core.MicroService.accessible_at
+        .. autoattribute:: gemstone.core.MicroService.endpoint
+        .. autoattribute:: gemstone.core.MicroService.template_dir
+        .. autoattribute:: gemstone.core.MicroService.static_dirs
+        .. autoattribute:: gemstone.core.MicroService.extra_handlers
+        .. autoattribute:: gemstone.core.MicroService.plugins
+        .. autoattribute:: gemstone.core.MicroService.discovery_strategies
+        .. autoattribute:: gemstone.core.MicroService.service_registry_ping_interval
+        .. autoattribute:: gemstone.core.MicroService.periodic_tasks
+        .. autoattribute:: gemstone.core.MicroService.event_transports
+        .. autoattribute:: gemstone.core.MicroService.configurables
+        .. autoattribute:: gemstone.core.MicroService.configurators
+        .. autoattribute:: gemstone.core.MicroService.max_parallel_blocking_tasks
+
+Can be called
+"""""""""""""
+
+        .. automethod:: gemstone.core.MicroService.get_service
+        .. automethod:: gemstone.core.MicroService.emit_event
+        .. automethod:: gemstone.core.MicroService.get_io_loop
+        .. automethod:: gemstone.core.MicroService.get_executor
+        .. automethod:: gemstone.core.MicroService.start
+        .. automethod:: gemstone.core.MicroService.configure
+        .. automethod:: gemstone.core.MicroService.register_plugin
+        .. automethod:: gemstone.core.MicroService.get_plugin
+        .. automethod:: gemstone.core.MicroService.start_thread
+        .. automethod:: gemstone.core.MicroService.make_tornado_app
+
+Can be overridden
+"""""""""""""""""
+
+        .. automethod:: gemstone.core.MicroService.get_logger
+        .. automethod:: gemstone.core.MicroService.authenticate_request
+        .. automethod:: gemstone.core.MicroService.on_service_start
+
+The gemstone.core.Container class
+---------------------------------
+
+
+    .. autoclass:: gemstone.core.Container
+        :members:
+
+        .. py:attribute:: microservice
+
+Decorators
+----------
+
+    .. autofunction:: gemstone.core.exposed_method
+    .. autofunction:: gemstone.core.event_handler
+
diff --git a/docs/reference/gemstone.discovery.rst b/docs/reference/gemstone.discovery.rst
@@ -0,0 +1,27 @@
+The gemstone.discovery module
+=============================
+
+.. py:currentmodule:: gemstone.discovery
+
+.. automodule:: gemstone.discovery
+
+Discovery strategies
+--------------------
+
+    .. autoclass:: BaseDiscoveryStrategy
+        :members:
+
+    .. autoclass:: HttpDiscoveryStrategy
+        :members:
+
+    .. autoclass:: RedisDiscoveryStrategy
+        :members:
+
+Caches
+------
+
+    .. autoclass:: ServiceDiscoveryCache
+        :members:
+
+    .. autoclass:: DummyCache
+        :members:
diff --git a/docs/reference/gemstone.event.rst b/docs/reference/gemstone.event.rst
@@ -0,0 +1,18 @@
+The gemstone.event module
+=========================
+
+.. py:currentmodule:: gemstone.event
+
+.. automodule:: gemstone.event
+
+Event transports
+----------------
+
+    .. autoclass:: BaseEventTransport
+        :members:
+
+    .. autoclass:: RedisEventTransport
+        :members:
+
+    .. autoclass:: RabbitMqEventTransport
+        :members:
diff --git a/docs/reference/gemstone.plugins.rst b/docs/reference/gemstone.plugins.rst
@@ -0,0 +1,21 @@
+The gemstone.plugins module
+===========================
+
+.. py:currentmodule:: gemstone.plugins
+.. automodule:: gemstone.plugins
+
+The gemstone.plugins.BasePlugin class
+-------------------------------------
+
+    .. autoclass:: BasePlugin
+        :members:
+
+Exceptions
+----------
+
+    .. autoexception:: PluginError
+        :members:
+
+
+    .. autoexception:: MissingPluginNameError
+        :members: