@@ -1,10 +1,11 @@ ==================================================== Demisauce: An Integration as a Service Appliance ==================================================== -Demisauce is a collection of capability that can be used within your app via services instead of using native components. It is essentially a service oriented plug in tool. +Demisauce is a collection of capability that can be used within your app via services instead of using native components. It is essentially a service oriented plug in tool. There is a hosted version available at http://www.demisauce.com or you can install +it as an appliance in your environment, see below. INSTALL INSTRUCTIONS --------------------- -http://github.com/araddon/demisauce/tree/1d24ccb7c757a362441bb249d970525c34fc27a7/install +http://github.com/araddon/demisauce/tree/master/install README.rst @@ -119,7 +119,7 @@ class ServiceController(BaseController): def apps(self,id=0): c.apps = App.by_site(c.site_id) return render('/service/app.html') - + @requires_role('admin') def appeditform(self,id=0): c.item = App.get(-1,id) @@ -142,6 +142,7 @@ class ServiceController(BaseController): app.slug = slugify(sanitize(request.POST['app_name'])) app.name = sanitize(request.POST['app_name']) + app.authn = sanitize(request.POST['authn']) app.description = sanitize(request.POST['description']) app.base_url = sanitize(request.POST['base_url']) app.save() demisauce/trunk/demisauce/controllers/service.py @@ -101,37 +101,52 @@ app = ''' "slug": "demisauce", "url_format":"{base_url}/api/{format}/{service}/{key}?apikey={api_key}", "base_url": "http://localhost:4951", - "authn": "demisauce" + "authn": "0" },{ "site_id": "1", "owner_id": "1", "name": "demisauce.com alternate api", "slug": "demisauce", "base_url": "http://localhost:4951", - "authn": "demisauce" + "authn": "0" },{ "site_id": "2", "owner_id": "3", "name": "djangodemo", "slug": "djangodemo", "base_url": "http://djangodemo.test:8001", - "authn": "demisauce" + "authn": "3" },{ "site_id": "3", "owner_id": "4", "name": "phpdemo", "slug": "phpdemo", "base_url": "http://demisauce.test", - "authn": "demisauce" + "authn": "3" },{ "site_id": "1", "owner_id": "1", "name": "wordpress", "slug": "wordpress", "base_url": "http://192.168.125.133/blog/xmlrpc.php", - "authn": "demisauce" + "authn": "3" + },{ + "site_id": "1", + "owner_id": "1", + "name": "delicious.com", + "slug": "deliciouscom", + "base_url": "http://delicious.com", + "authn": "3" + },{ + "site_id": "1", + "owner_id": "1", + "name": "delicious feeds", + "slug": "deliciousfeeds", + "base_url": "http://feeds.delicious.com", + "authn": "3" }] }''' + service = ''' { "class": "demisauce.model.service.Service", @@ -140,7 +155,7 @@ service = ''' "site_id": "1", "app_id": "1", "owner_id": "1", - "list_public" : "1", + "list_public": "1", "name": "Poll Html Service", "key": "poll", "views": "", @@ -149,7 +164,7 @@ service = ''' "site_id": "1", "app_id": "1", "owner_id": "1", - "list_public" : "1", + "list_public": "1", "name": "Comment Html Service", "key": "comment", "views": "", @@ -158,7 +173,7 @@ service = ''' "site_id": "1", "app_id": "1", "owner_id": "1", - "list_public" : "1", + "list_public": "1", "name": "Email Template service", "method_url": "{base_url}/api/xml/email/{key}?apikey={api_key}", "key": "email", @@ -186,7 +201,7 @@ service = ''' "site_id": "1", "app_id": "1", "owner_id": "1", - "list_public" : "1", + "list_public": "1", "name": "Help/Idea/Feedback Submission widget.", "method_url": "help/feedback_service/{request}", "key": "feedback", @@ -194,6 +209,16 @@ service = ''' "description": "An Idea, Problem, Feedback set of services." },{ "site_id": "1", + "app_id": "7", + "owner_id": "1", + "list_public": "1", + "name": "Delicious Tags Html Page", + "method_url": "/tag/{key}", + "key": "tag", + "views": "", + "description": "Just gets a page on delicious" + },{ + "site_id": "1", "app_id": "5", "owner_id": "4", "name": "Wordpress content service", @@ -204,6 +229,7 @@ service = ''' "description": "Wordpress CMS extraction service" }] }''' + email = ''' { "class": "demisauce.model.email.Email", @@ -214,10 +240,10 @@ email = ''' "key":"welcome_to_demisauce", "from_email":"guest@demisauce.org", "from_name":"Demisauce Admin", - "template": "Welcome to Demisauce, Your account has been enabled, and you can start using services on demisauce. -\nTo verify your account you need to click and finish registering $link -\nThank You -\nDemisauce Team" + "template": "Welcome to Demisauce;\ +\\n\\nYour account has been enabled, and you can start using services on demisauce.\ +\\n\\nTo verify your account you need to click and finish registering $link\ +\\n\\nThank You\\n\\nDemisauce Team" }, { "site_id": "1", @@ -225,10 +251,10 @@ email = ''' "key":"invitation_to_demisauce", "from_email":"guest@demisauce.org", "from_name":"Demisauce Web", - "template": "Welcome to Demisauce, You have recieved an invite from $from , and an account has been created for you. -\nTo verify your account you need to click and finish registering $link -\nThank You -\nDemisauce Team" + "template": "Welcome to Demisauce;\ +\\n\\nYou have recieved an invite from $from , and an account has been created for you.\ +\\n\\nTo verify your account you need to click and finish registering $link\ +\\n\\nThank You\\n\\nDemisauce Team" }, { "site_id": "1", @@ -236,12 +262,13 @@ email = ''' "key":"thank_you_for_registering_with_demisauce", "from_email":"guest@demisauce.org", "from_name":"Demisauce Web", - "template": "Welcome to Demisauce, we are are currently allowing a few users to try out our hosted service, and will send you an invite when we can accept more testers. However, this is also an open source project so please feel free to download and try it out yourself. -\nMore info at http://www.demisauce.org -or at: http://demisauce.googlecode.com -\nYour Email address $email will not be used other than for logging in. -\nThank You -\nThe Demisauce Team" + "template": "Welcome to Demisauce;\ +\\n\\nWe are are currently allowing a few users to try out our hosted service, and will send you an invite \ +when we can accept more testers. However, this is also an open source project so please feel free to download \ +and try it out yourself.\ +\\n\\nMore info at http://www.demisauce.com\ +\\n\\nYour Email address $email will not be used other than for logging in.\ +\\n\\nThank You\\n\\nDemisauce Team" }, { "site_id": "1", @@ -249,23 +276,23 @@ or at: http://demisauce.googlecode.com "key":"a-new-user-has-registered", "from_email":"guest@demisauce.org", "from_name":"Demisauce Admin", - "template": "A new user has signed up at demisauce. -\nTheir Email address $email and $displayname -\n\nThank You -\n\nThe Demisauce Team" - }, + "template": "A new user has signed up at demisauce.\ +\\nTheir Email address $email and $displayname\ +\\n\\nThank You\\n\\nThe Demisauce Team" + }, { "site_id": "1", "subject":"Comment Notification", "key":"comment-notification", "from_email":"guest@demisauce.org", "from_name":"Demisauce Web", - "template": "Hello; -\n$email has Commented on your $sitename on page $url -\nThank You -\nDemisauce Team" + "template": "Hello;\ +\\n\\n$email has Commented on your $sitename on page $url\ +\\n\\nThank You\\n\\nDemisauce Team" }] }''' + + comment = ''' { "class": "demisauce.model.comment.Comment", demisauce/trunk/demisauce/fixture.py @@ -23,7 +23,7 @@ app_table = Table("app", meta.metadata, Column("slug", DBString(50)), Column("base_url", DBString(255)), Column("url_format", DBString(255),nullable=True), - Column("authn", DBString(50)), + Column("authn", DBString(50),default='None'), Column("description", DBText), ) demisauce/trunk/demisauce/model/service.py @@ -8,6 +8,7 @@ <authn>${item.app.authn}</authn> <method_url>${item.method_url and item.method_url or ''}</method_url> <slug>${item.app.slug }</slug> + <authn>${item.app.authn }</authn> <cache_time>${item.cache_time }</cache_time> <format>${item.format and item.format or ''}</format> <description><![CDATA[${item.description}]]></description> demisauce/trunk/demisauce/templates/api/service.xml @@ -143,9 +143,10 @@ <div class="optional"> <fieldset> <legend>Auth Method?</legend> - ${h.radio_button('authn', '0',checked=(item and item.authn == 0))} demisauce <br /> - ${h.radio_button('authn', '1',checked=(item and item.authn == 1))} oauth <br /> - ${h.radio_button('authn', '2',checked=(item and item.authn == 2))} CAS <br /> + ${h.radio_button('authn', 'demisauce',checked=(item and str(item.authn) == 'demisauce'))} demisauce <br /> + ${h.radio_button('authn', 'oauth',checked=(item and str(item.authn) == 'oauth'))} oauth <br /> + ${h.radio_button('authn', 'CAS',checked=(item and str(item.authn) == 'CAS'))} CAS <br /> + ${h.radio_button('authn', 'None',checked=(item and str(item.authn) == 'None'))} None <br /> </fieldset> </div> </div> @@ -209,6 +210,7 @@ <dt>Site:</dt> <dd>${h.link_to(item.site.name, h.url(controller="site",action="view", id=item.site_id))}</dd> <dt>Site URL:</dt> <dd>${item.app.base_url}</dd> <dt>App:</dt> <dd>${item.app.name}</dd> + <dt>AuthN:</dt> <dd>${item.app.authn}</dd> <dt>Service URL:</dt> <dd>${item.method_url or 'na'}</dd> <dt>View XML:</dt> <dd>${h.link_to('View Xml', "/api/xml/service/%s/%s" % (item.app.slug,item.key))}</dd> <dt>Description:</dt> <dd>${item.description}</dd> demisauce/trunk/demisauce/templates/service/service_bits.html @@ -26,7 +26,7 @@ DATABASE_HOST = '' # Set to empty string for localhost. Not used wit DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3. #CACHE_BACKEND = 'locmem:///' -CACHE_BACKEND = 'memcached://192.168.125.128:11211/' +CACHE_BACKEND = 'memcached://192.168.0.106:11211/' # Local time zone for this installation. Choices can be found here: demos/djangodemo/settings.py @@ -4,9 +4,9 @@ Demisauce Getting started with Django ================================================ This tutorial will walk through the creation of a simple blog using `Demisauce <http://www.demisauce.com/>`_ -services. First, step, go to Demisauce and *signup* (top right) on demisauce.com, OR `install demisauce <http://github.com/araddon/demisauce/tree/1cd6ec9b9743bade739bb36bbde5630f877c1848/install>`_. +services. First, go to Demisauce and *signup* (top right) on demisauce.com, OR `install demisauce <http://github.com/araddon/demisauce/tree/1cd6ec9b9743bade739bb36bbde5630f877c1848/install>`_. Currently signups on demisauce.com are limited so send an email to the -`Help group <http://groups.google.com/group/demisauce>`_ and I will enable your account. +`discussion group <http://groups.google.com/group/demisauce>`_ and I will enable your account. The full source code for this application can be found on `Github <http://github.com/araddon/demisauce/tree/1cd6ec9b9743bade739bb36bbde5630f877c1848/demos/djangodemo>`_ so you can also pull from there and view that application. @@ -18,7 +18,8 @@ Create a Django Demo Application Create Django App ------------------ See the documentation on `Django Docs <http://docs.djangoproject.com/en/dev/intro/tutorial01/#intro-tutorial01>`_ -and follow the part of installing and starting a new app, and where it says to create the app *polls* we will actually be running. +and follow the part of installing and starting a new app, and where it says to create the app *polls* we will actually be +createing an app called *blog*. It is easiest to use Sqlite as the db for this demo:: python manage.py startapp blog @@ -59,14 +60,15 @@ Then enter that apikey, and url to your *settings.py* like this:: # apikey from account page, service url of demisauce server. DEMISAUCE_APIKEY = 'a95c21ee8e64cb5ff585b5f9b761b39d7cb9a202' DEMISAUCE_URL = 'http://localhost:4951' + # your app name, used to make your urls unique DEMISAUCE_APPNAME = 'djangodemo' # if you have memcached CACHE_BACKEND = 'memcached://192.168.125.128:11211/' #CACHE_BACKEND = 'locmem:///' -Now Create a view following the `Django tuturial <http://docs.djangoproject.com/en/dev/intro/tutorial03/#intro-tutorial03>`_, -called *simple*, first add to the urls.py:: +Now Create a view following the `Django tuturial <http://docs.djangoproject.com/en/dev/intro/tutorial03/#intro-tutorial03>`_ +called *simple* by first adding to the urls.py:: urlpatterns = patterns('', (r'^simple/$', 'djangodemo.blog.views.simple'), @@ -97,7 +99,8 @@ and, your page should look like <img src="http://demisaucepub.s3.amazonaws.com/s3/firstbadge.png" border="0" /> -So, now we have the basics of how to use a service from Demisauce. +So, now we have the basics of how to use a service from Demisauce. The feedback badge is an +html service, to fully function it would need javascript as well. Creating a Demisauce Mapped Service ------------------------------------ @@ -106,7 +109,7 @@ Demisauce python library currently provides a mapping layer, to allow local mode to remote services, similar to ORM, where the service url's are automatically generated based on this relationship. We are going to add comments to our blog entry model, but first some style. -Download a css/template from `Free Css Templates <http://www.freecsstemplates.org/>` and +Download a css/template from `Free Css Templates <http://www.freecsstemplates.org/>`_ and start working on the blog, add 3 new lines to the to the *url.py*: .. code-block:: python @@ -151,6 +154,8 @@ Then run this from the command line to sync schema to DB:: python manage.py syncdb +Creating Views +--------------- And add the new methods to *blog/views.py*, see the source at `github <http://github.com/araddon/demisauce/blob/1cd6ec9b9743bade739bb36bbde5630f877c1848/demos/djangodemo/blog/views.py>`_ @@ -177,7 +182,7 @@ And add the new methods to *blog/views.py*, see the source at `github <http://gi }) return HttpResponse(t.render(rc)) -Now create the *index.html* view page. +Now create the *index.html* view page. .. code-block:: python docs/getstarted.rst fff80539032007ab0cdf6c37741dbd3af1b9f879 Aaron Raddon araddon@yahoo.com http://github.com/araddon/demisauce/commit/280b65e3ad0234dd0c55258f7cf72125777b1bfb 280b65e3ad0234dd0c55258f7cf72125777b1bfb 2009-01-23T21:54:53-08:00 2009-01-23T21:54:53-08:00 doc formatting, add authn to service, form cleanup for authn, fixture data formatting fixes 280e7a0406ff91ced81d30aeb093159cf0600abe Aaron Raddon araddon@yahoo.com