Initial import soaplib project, a python library for writing SOAP clients and web services.

git-svn-id: https://svn.optio.webfactional.com/soaplib/trunk@6 a22a5828-bd28-0410-b187-c4590219e950

Author: abickell

.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>soaplib</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

LICENSE

@@ -0,0 +1,41 @@
+from soaplib.wsgi_soap import SimpleWSGISoapApp
+from soaplib.service import soapmethod
+from soaplib.serializers.primitive import String, Integer, Array
+from soaplib.serializers.binary import Attachment
+from soaplib.util import get_callback_info
+ 
+from threading import Thread
+from tempfile import mkstemp
+import time
+
+'''
+This is a very simple async service that sleeps for a specified 
+number of seconds and then call back the caller with a message.
+This kicks off a new Thread for each request, which is not recommended
+for a real-world application.  Soaplib does not provide any thread
+management or scheduling mechanism, the service is responsible for the
+execution of the async. process.
+'''
+
+class SleepingService(SimpleWSGISoapApp):
+    
+    @soapmethod(Integer,_isAsync=True)
+    def sleep(self,seconds):
+        msgid, replyto = get_callback_info()
+        
+        def run():
+            time.sleep(seconds)
+            
+            client = create_service_client(replyto, self)
+            client.woke_up('good morning',msgid=msgid)
+
+        Thread(target=run).start()
+
+    @soapmethod(String,_isCallback=True)
+    def woke_up(self,message):
+        pass
+        
+if __name__=='__main__':
+    from cherrypy._cpwsgiserver import CherryPyWSGIServer
+    server = CherryPyWSGIServer(('192.168.1.101',7789),SleepingService())
+    server.start()

examples/._helloworld.py

@@ -0,0 +1,51 @@
+from soaplib.wsgi_soap import SimpleWSGISoapApp
+from soaplib.service import soapmethod
+from soaplib.serializers.primitive import String, Integer, Array
+from soaplib.serializers.binary import Attachment
+
+from tempfile import mkstemp
+import os
+
+class DocumentArchiver(SimpleWSGISoapApp):
+    
+    @soapmethod(Attachment,_returns=String)
+    def archive_document(self,document):
+        '''
+        This method accepts an Attachment object, and returns the filename of the
+        archived file
+        '''
+        fd,fname = mkstemp()
+        os.close(fd)
+        
+        document.fileName = fname
+        document.save_to_file()
+        
+        return fname
+
+    @soapmethod(String,_returns=Attachment)
+    def get_archived_document(self,file_path):
+        '''
+        This method loads a document from the specified file path
+        and returns it.  If the path isn't found, an exception is
+        raised.
+        '''
+        if not os.path.exists(file_path):
+            raise Exception("File [%s] not found"%file_path)
+        
+        document = Attachment(fileName=file_path)
+        # the service automatically loads the data from the file.
+        # alternatively, The data could be manually loaded into memory
+        # and loaded into the Attachment like:
+        #   document = Attachment(data=data_from_file)
+        return document
+        
+
+def make_client():
+    from soaplib.client import make_service_client
+    client = make_service_client('http://localhost:7889/',DocumentArchiver())
+    return client
+    
+if __name__=='__main__':
+    from cherrypy._cpwsgiserver import CherryPyWSGIServer
+    server = CherryPyWSGIServer(('localhost',7889),DocumentArchiver())
+    server.start()

examples/__init__.py

@@ -0,0 +1,69 @@
+from soaplib.wsgi_soap import SimpleWSGISoapApp
+from soaplib.service import soapmethod
+from soaplib.serializers.primitive import String, Integer, Array
+from soaplib.serializers.clazz import ClassSerializer
+
+'''
+This example shows how to define and use complex structures
+in soaplib.  This example uses an extremely simple in-memory
+dictionary to store the User objects.
+'''
+
+user_database = {}
+userid_seq = 1
+
+from soaplib.serializers.primitive import String, Integer, Array
+from soaplib.serializers.clazz import ClassSerializer
+class Permission(ClassSerializer):
+    class types:
+        application = String
+        feature = String
+        
+    @classmethod
+    def to_xml(cls,value,name):
+        print 'hello'
+        return 'asdf'
+
+class User(ClassSerializer):
+    class types:
+        userid = Integer
+        username = String
+        firstname = String
+        lastname = String
+        permissions = Array(Permission)
+
+class UserManager(SimpleWSGISoapApp):
+    
+    @soapmethod(User,_returns=Integer)
+    def add_user(self,user):
+        global user_database
+        global userid_seq
+        user.userid = userid_seq
+        userid_seq = userid_seq+1
+        user_database[user.userid] = user
+        return user.userid
+        
+    @soapmethod(Integer,_returns=User)
+    def get_user(self,userid):
+        global user_database
+        return user_database[userid]
+        
+    @soapmethod(User)
+    def modify_user(self,user):
+        global user_database
+        user_database[user.userid] = user
+        
+    @soapmethod(Integer)
+    def delete_user(self,userid):
+        global user_database
+        del user_database[userid]
+        
+    @soapmethod(_returns=Array(User))
+    def list_users(self):
+        global user_database
+        return [v for k,v in user_database.items()]
+
+if __name__=='__main__':
+    from cherrypy._cpwsgiserver import CherryPyWSGIServer
+    server = CherryPyWSGIServer(('192.168.1.101',7789),UserManager())
+    server.start()

examples/__init__.pyc

@@ -0,0 +1,28 @@
+from soaplib.wsgi_soap import SimpleWSGISoapApp
+from soaplib.service import soapmethod
+from soaplib.serializers.primitive import String, Integer, Array
+
+'''
+This is a simple HelloWorld example to show the basics of writing
+a webservice using soaplib, starting a server, and creating a service
+client. 
+'''
+
+class HelloWorldService(SimpleWSGISoapApp):
+    
+    @soapmethod(String,Integer,_returns=Array(String))
+    def say_hello(self,name,times):
+        results = []
+        for i in range(0,times):
+            results.append('Hello, %s'%name)
+        return results
+
+def make_client():
+    from soaplib.client import make_service_client
+    client = make_service_client('http://localhost:7889/',HelloWorldService())
+    return client
+    
+if __name__=='__main__':
+    from cherrypy._cpwsgiserver import CherryPyWSGIServer
+    server = CherryPyWSGIServer(('localhost',7889),HelloWorldService())
+    server.start()

examples/async.py

@@ -0,0 +1,66 @@
+from soaplib.wsgi_soap import SimpleWSGISoapApp
+from soaplib.service import soapmethod
+from soaplib.serializers.primitive import String, Integer, Array
+
+from soaplib.wsgi_soap import request
+from time import time
+
+'''
+This example is an enhanced version of the HelloWorld example that
+uses service 'hooks' to apply cross-cutting behavior to the service.
+In this example, the service hooks are used to gather performance 
+information on both the method execution as well as the duration 
+of the entire call, including serialization and deserialization. The
+available hooks are:
+
+    * onCall
+    * onWsdl
+    * onWsdlException
+    * onMethodExec
+    * onResults
+    * onException
+    * onReturn
+    
+These method can be used to easily apply cross-cutting functionality
+accross all methods in the service to do things like database transaction
+management, logging and measuring performance.  This example also 
+employs the threadlocal request (soaplib.wsgi_soap.request) object
+to hold the data points for this request.
+'''
+
+class HelloWorldService(SimpleWSGISoapApp):
+    
+    @soapmethod(String,Integer,_returns=Array(String))
+    def say_hello(self,name,times):
+        results = []
+        for i in range(0,times):
+            results.append('Hello, %s'%name)
+        return results
+    
+    def onCall(self,environ):
+        request.additional['call_start'] = time()
+
+    def onMethodExec(self,environ,body,py_params,soap_params):
+        request.additional['method_start'] = time()
+
+    def onResults(self,environ,py_results,soap_results):
+        request.additional['method_end'] = time()
+
+    def onReturn(self,environ,returnString):
+        call_start = request.additional['call_start']
+        call_end = time()
+        method_start = request.additional['method_start']
+        method_end = request.additional['method_end']
+        
+        print 'Method took [%s] - total execution time[%s]'%(method_end-method_start,call_end-call_start)
+        
+
+def make_client():
+    from soaplib.client import make_service_client
+    client = make_service_client('http://localhost:7889/',HelloWorldService())
+    return client
+    
+if __name__=='__main__':
+    from cherrypy._cpwsgiserver import CherryPyWSGIServer
+    server = CherryPyWSGIServer(('localhost',7889),HelloWorldService())
+    server.start()

examples/binary.py

@@ -0,0 +1,3 @@
+[egg_info]
+tag_build = dev
+tag_svn_revision = true

examples/binary.pyc

@@ -0,0 +1,34 @@
+from setuptools import setup, find_packages
+version = '0.7.0'
+
+setup(name='soaplib',
+      version=version,
+      description="A simple library for writing soap web services",
+      long_description="""\
+      This is a simple, easily extendible soap library that provides several useful tools for 
+      creating and publishing soap web services in python.  This package features on-demand
+      wsdl generation for the published services, a wsgi-compliant web application, support for
+      complex class structures, binary attachments, simple framework for creating additional
+      serialization mechanisms and a client library.
+      """,
+      classifier7s=[
+      'Programming Language :: Python',
+      'Operating System :: OS Independent',
+      'Natural Language :: English',
+      'Development Status :: 2 - Pre-Alpha',
+      'Intended Audience :: Developers',
+      'Topic :: Internet :: WWW/HTTP :: Dynamic Content'
+      ],
+      keywords='soap',
+      author='Aaron Bickell',
+      author_email='[email protected]',
+      url='http://trac.optio.webfactional.com',
+      license='LGPL',
+      packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
+      zip_safe=False,
+      install_requires=['cElementTree','pytz'],
+	  test_suite='tests.test_suite',
+      entry_points="""
+      """,
+      )
+      

examples/classserializer.py

@@ -0,0 +1,16 @@
+Metadata-Version: 1.0
+Name: soaplib
+Version: 0.7.0dev-r21909
+Summary: A simple library for writing soap web services
+Home-page: http://trac.optio.webfactional.com
+Author: Aaron Bickell
+Author-email: [email protected]
+License: LGPL
+Description: This is a simple, easily extendible soap library that provides several useful tools for
+        creating and publishing soap web services in python.  This package features on-demand
+        wsdl generation for the published services, a wsgi-compliant web application, support for
+        complex class structures, binary attachments, simple framework for creating additional
+        serialization mechanisms and a client library.
+        
+Keywords: soap
+Platform: UNKNOWN

examples/classserializer.pyc

@@ -0,0 +1,44 @@
+.project
+setup.cfg
+setup.py
+soaplib_docs.markdown
+examples/._helloworld.py
+examples/__init__.py
+examples/__init__.pyc
+examples/async.py
+examples/binary.py
+examples/classserializer.py
+examples/classserializer.pyc
+examples/helloworld.py
+examples/helloworld.pyc
+examples/hooks.py
+soaplib/__init__.py
+soaplib/client.py
+soaplib/service.py
+soaplib/soap.py
+soaplib/util.py
+soaplib/wsgi_soap.py
+soaplib.egg-info/PKG-INFO
+soaplib.egg-info/SOURCES.txt
+soaplib.egg-info/dependency_links.txt
+soaplib.egg-info/entry_points.txt
+soaplib.egg-info/not-zip-safe
+soaplib.egg-info/requires.txt
+soaplib.egg-info/top_level.txt
+soaplib/ext/__init__.py
+soaplib/ext/comproxy.py
+soaplib/ext/wsdl2py.py
+soaplib/ext/wsgi_xml.py
+soaplib/serializers/__init__.py
+soaplib/serializers/binary.py
+soaplib/serializers/clazz.py
+soaplib/serializers/primitive.py
+tests/__init__.py
+tests/client_test.py
+tests/interop_service.py
+tests/service_test.py
+tests/soap_test.py
+tests/serializers/__init__.py
+tests/serializers/binary_test.py
+tests/serializers/clazz_test.py
+tests/serializers/primitive_test.py

examples/helloworld.py

@@ -0,0 +1 @@
+

examples/helloworld.pyc

@@ -0,0 +1,2 @@
+
+      

examples/hooks.py

@@ -0,0 +1,2 @@
+cElementTree
+pytz

examples/hooks.pyc

@@ -0,0 +1,2 @@
+soaplib
+tests

setup.cfg

@@ -0,0 +1 @@
+#