Merge lp:~thisfred/desktopcouch/cut-gordian-knot into lp:desktopcouch

[Eric Casteleijn]

This cuts out all the dependencies on desktopcouch.application from desktopcouch.records.

This cuts out all the dependencies on desktopcouch.application from desktopcouch.records.

The tests still depend on it, because we need it to start and stop the test couchdb instance, and there is one deprecated class that imports from application, since I did not want to break bw compatibility. People who use desktopcouch.records as a library should simply switch to non-deprecated API.

[Vincenzo Di Somma (vds)]

review: Approve

[Chad Miller (cmiller)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~thisfred/desktopcouch/cut-gordian-knot into lp:desktopcouch failed. Below is the output from the failed tests.

Apache CouchDB has started, time to relax.
Browse your desktop CouchDB at file:///tmp/tmp_aNB1V/data/couchdb.html
desktopcouch.application.tests.test_start_local_couchdb
  TestUpdateDesignDocuments
    test_create_databases_and_design_docs ... [OK]
desktopcouch.application.tests.test_service
  TestService
    test_start_desktopcouch_replication ... [OK]
    test_start_new_desktopcouch_extensions ... [OK]
    test_start_new_desktopcouch_no_extensions ... [OK]
desktopcouch.application.tests.test_local_files
  TestKeyringIntegration
    test_with_auth ... [OK]
    test_with_no_auth ... [OK]
  TestLocalFiles
    test_all_files_returned ... [OK]
    test_bind_address ... [OK]
    test_couch_chain_ini_files ... [OK]
    test_xdg_overwrite_works ... [OK]
desktopcouch.application.tests.test_replication
  TestReplication
    test_creation ... Apache CouchDB has started, time to relax.
Browse your desktop CouchDB at file:///tmp/tmpJFAsvR/data/couchdb.html
                                                     [OK]
  TestUbuntuoneReplication
    test_exclusion ... Apache CouchDB has started, time to relax.
Browse your desktop CouchDB at file:///tmp/tmpBXpLld/data/couchdb.html
                                                    [OK]
desktopcouch.application.migration.tests.test_migration
  TestMigration
    test_migration_script_is_run ... [OK]
    test_migration_script_is_run_and_can_access_view ... [OK]
  TestRegistration
    test_register_migration_add_view_to_a_given_db ... [OK]
    test_register_migration_add_view_to_all_the_dbs ... [OK]
    test_register_migration_is_added_to_the_registry ... [OK]
desktopcouch.application.pair.tests.test_couchdb_io
  TestCouchdbIo
    test_get_database_names_replicatable ... [OK]
    test_get_my_host_unique_id ... [OK]
    test_mkuri ... [OK]
    test_obsfuscation ... [OK]
    test_put_dynamic_paired_host ... [OK]
    test_put_static_paired_service ... [OK]
desktopcouch.application.pair.tests.test_ubuntuone_pairing
  TestUbuntonePairing
    test_pair_with_ubuntuone_no_record ... [OK]
    test_pair_with_ubuntuone_no_view ... [OK]
    test_pair_with_ubuntuone_record_present ... [OK]
    test_pair_with_ubuntuone_user_deleted_record ... [...

[Ubuntu One Auto Pilot (otto-pilot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'bin/desktopcouch-pair'
--- bin/desktopcouch-pair	2010-11-22 21:36:06 +0000
+++ bin/desktopcouch-pair	2010-11-24 15:19:50 +0000
@@ -849,7 +849,7 @@
 
 def set_couchdb_bind_address():
     """Set a couchdb bind address."""
-    from desktopcouch.records.server import CouchDatabase
+    from desktopcouch.application.server import DesktopDatabase
     # FIXME I don't think this will reimport anything
     from desktopcouch import local_files  # pylint: disable=W0621,W0404
     bind_address = local_files.get_bind_address()
@@ -859,7 +859,7 @@
                 bind_address)
         return False
 
-    db = CouchDatabase("management", create=True)
+    db = DesktopDatabase("management", create=True)
     results = db.get_records(create_view=True)
     count = 0
     for row in results[pairing_record_type]:

=== modified file 'desktopcouch/application/migration/__init__.py'
--- desktopcouch/application/migration/__init__.py	2010-11-22 19:27:42 +0000
+++ desktopcouch/application/migration/__init__.py	2010-11-24 15:19:50 +0000
@@ -23,7 +23,8 @@
 
 from couchdb.client import  ResourceConflict
 
-from desktopcouch.records import server, server_base
+from desktopcouch.records import database
+from desktopcouch.application import server
 from desktopcouch.application.platform import find_port
 
 MIGRATION_DESIGN_DOCUMENT = 'dc_migration'
@@ -35,8 +36,7 @@
     """Get all the non private dbs from a server"""
     port = find_port(ctx=ctx)
     uri = "http://localhost:%s" % port
-    couchdb_server = server.OAuthCapableServer(
-        uri, oauth_tokens=None, ctx=ctx)
+    couchdb_server = server.DesktopServer(uri, oauth_tokens=None, ctx=ctx)
     return [x for x in couchdb_server.resource.get('/_all_dbs')[1]]
 
 
@@ -46,8 +46,8 @@
         dbs = _all_dbs(ctx)
     for db_name in [db for db in dbs if not db.startswith('_')]:
         try:
-            db = server.CouchDatabase(database=db_name, ctx=ctx)
-        except server_base.NoSuchDatabase:
+            db = server.DesktopDatabase(database=db_name, ctx=ctx)
+        except database.NoSuchDatabase:
             return
         try:
             db.add_view(view_name, map_js=view_code, reduce_js='',
@@ -79,6 +79,6 @@
         for db in dbs:
             try:
                 MIGRATIONS_REGISTRY[migration]['method'](
-                    server.CouchDatabase(database=db, ctx=ctx))
-            except server_base.NoSuchDatabase:
+                    server.DesktopDatabase(database=db, ctx=ctx))
+            except database.NoSuchDatabase:
                 pass

=== modified file 'desktopcouch/application/migration/tests/test_migration.py'
--- desktopcouch/application/migration/tests/test_migration.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/application/migration/tests/test_migration.py	2010-11-24 15:19:50 +0000
@@ -26,7 +26,7 @@
 
 from desktopcouch.application import migration
 import desktopcouch.application.tests as test_environment
-from desktopcouch.records.server import CouchDatabase
+from desktopcouch.application.server import DesktopDatabase
 from desktopcouch.records import Record
 from desktopcouch.application.stop_local_couchdb import stop_couchdb
 
@@ -35,6 +35,7 @@
     """Return test context."""
     return test_environment.test_context
 
+
 def fake_migration():
     """fake migration code"""
     pass
@@ -48,7 +49,7 @@
         super(MigrationBase, self).setUp()
         self.ctx = get_test_context()
         self.dbname = self._testMethodName
-        self.database = CouchDatabase(self.dbname, create=True, ctx=self.ctx)
+        self.database = DesktopDatabase(self.dbname, create=True, ctx=self.ctx)
         self.server = self.database._server
 
     def tearDown(self):
@@ -59,15 +60,15 @@
             stop_couchdb(ctx=this_context)
         super(MigrationBase, self).tearDown()
 
+
 class TestRegistration(MigrationBase):
     """Tests the registration of a migration script"""
 
     def setUp(self):
         """setup each test"""
         super(TestRegistration, self).setUp()
-        self.one_more_database = CouchDatabase('one_more_database',
-                                               create=True,
-                                               ctx=self.ctx)
+        self.one_more_database = DesktopDatabase(
+            'one_more_database', create=True, ctx=self.ctx)
 
     def tearDown(self):
         """tear down each test"""
@@ -85,9 +86,9 @@
                            ctx=self.ctx)
         self.assertEqual(
             {'method': fake_migration,
-             'dbs':[self.dbname]},
+             'dbs': [self.dbname]},
             migration.MIGRATIONS_REGISTRY[self.dbname])
-        self.assertEqual(size+1, len(migration.MIGRATIONS_REGISTRY))
+        self.assertEqual(size + 1, len(migration.MIGRATIONS_REGISTRY))
 
     def test_register_migration_add_view_to_a_given_db(self):
         """Test that the migration is correctly registered."""
@@ -111,10 +112,10 @@
                            ctx=self.ctx)
         self.assertEqual(
             {'method': fake_migration,
-             'dbs':[]},
+             'dbs': []},
             migration.MIGRATIONS_REGISTRY[self.dbname])
         for db in [db for db in self.server if not db.startswith('_')]:
-            target = CouchDatabase(database=db, ctx=self.ctx)
+            target = DesktopDatabase(database=db, ctx=self.ctx)
             self.assert_(target.view_exists(self.dbname, 'dc_migration'))
 
 
@@ -125,6 +126,7 @@
         """tear down each test"""
         super(TestMigration, self).tearDown()
         migration.MIGRATIONS_REGISTRY = {}
+
     def test_migration_script_is_run(self):
         """Test that the migration script is run."""
 
@@ -173,4 +175,3 @@
                            dbs=['db_that_doesnt_exixts'],
                            ctx=self.ctx)
         self.assertIs(None, migration.run_needed_migrations(ctx=self.ctx))
-

=== modified file 'desktopcouch/application/pair/couchdb_pairing/couchdb_io.py'
--- desktopcouch/application/pair/couchdb_pairing/couchdb_io.py	2010-11-22 20:33:58 +0000
+++ desktopcouch/application/pair/couchdb_pairing/couchdb_io.py	2010-11-24 15:19:50 +0000
@@ -27,7 +27,7 @@
 
 from desktopcouch.application import local_files
 from desktopcouch.application.platform import find_port
-from desktopcouch.records import server
+from desktopcouch.application import server
 from desktopcouch.records import Record
 
 RECTYPE_BASE = "http://www.freedesktop.org/wiki/Specifications/desktopcouch/"
@@ -68,7 +68,7 @@
 
 def _get_db(name, create=True, uri=None, ctx=local_files.DEFAULT_CONTEXT):
     """Get (and create?) a database."""
-    return server.CouchDatabase(name, create=create, uri=uri, ctx=ctx)
+    return server.DesktopDatabase(name, create=create, uri=uri, ctx=ctx)
 
 
 def put_paired_host(oauth_data, uri=None,
@@ -141,7 +141,7 @@
     if not uri:
         port = find_port(ctx=ctx)
         uri = "http://localhost:%s" % port
-    couchdb_server = server.OAuthCapableServer(uri, oauth_tokens=oauth_tokens,
+    couchdb_server = server.DesktopServer(uri, oauth_tokens=oauth_tokens,
             ctx=ctx)
     try:
         if user_id is None:
@@ -248,7 +248,7 @@
                     oauth_tokens=None):
     """Given parts, create a database."""
     dst_url = mkuri(dst_host, dst_port, use_ssl)
-    return server.CouchDatabase(dst_name, dst_url, create=True,
+    return server.DesktopDatabase(dst_name, dst_url, create=True,
             oauth_tokens=oauth_tokens)
 
 
@@ -267,7 +267,7 @@
                 target_host, target_port, target_database, use_ssl=target_ssl,
                 oauth_tokens=target_oauth)
         else:
-            server.CouchDatabase(target_database, create=True, uri=local_uri)
+            server.DesktopDatabase(target_database, create=True, uri=local_uri)
         logging.debug("db exists, and we're ready to replicate")
     except:                             # pylint: disable=W0702
         logging.exception(
@@ -305,7 +305,7 @@
                 obsfuscate(source), obsfuscate(target),)
 
         # All until python-couchdb gets a Server.replicate() function
-        local_server = server.OAuthCapableServer(local_uri)
+        local_server = server.DesktopServer(local_uri)
         resp, data = local_server.resource.post(path='/_replicate',
                 content=record)
         logging.debug(

=== modified file 'desktopcouch/application/pair/couchdb_pairing/ubuntuone_pairing.py'
--- desktopcouch/application/pair/couchdb_pairing/ubuntuone_pairing.py	2010-11-22 20:33:58 +0000
+++ desktopcouch/application/pair/couchdb_pairing/ubuntuone_pairing.py	2010-11-24 15:19:50 +0000
@@ -21,7 +21,7 @@
 import logging
 from desktopcouch.application.pair.couchdb_pairing.couchdb_io import (
     put_static_paired_service)
-from desktopcouch.records.server import CouchDatabase
+from desktopcouch.application.server import DesktopDatabase
 
 U1_PAIR_RECORD = "ubuntu_one_pair_record"
 MAP_JS = """function(doc) {
@@ -41,7 +41,7 @@
 def pair_with_ubuntuone(management_db=None):
     """Adds a pairing record with ubuntu one when is needed."""
     if not management_db:
-        management_db = CouchDatabase("management", create=True)
+        management_db = DesktopDatabase("management", create=True)
     # we indeed have credentials to add to the pairing records
     # but first we ensure that the required view is present
     if not management_db.view_exists(U1_PAIR_RECORD, U1_PAIR_RECORD):

=== modified file 'desktopcouch/application/pair/tests/test_couchdb_io.py'
--- desktopcouch/application/pair/tests/test_couchdb_io.py	2010-11-22 20:33:58 +0000
+++ desktopcouch/application/pair/tests/test_couchdb_io.py	2010-11-24 15:19:50 +0000
@@ -22,7 +22,7 @@
 import desktopcouch.application.tests as test_environment
 
 from desktopcouch.application.pair.couchdb_pairing import couchdb_io
-from desktopcouch.records.server import CouchDatabase
+from desktopcouch.application.server import DesktopDatabase
 from desktopcouch.records import Record
 from desktopcouch.application.replication_services import ubuntuone
 import unittest
@@ -37,12 +37,12 @@
 
     def setUp(self):
         """setup each test"""
-        self.mgt_database = CouchDatabase('management', create=True, uri=URI,
+        self.mgt_database = DesktopDatabase('management', create=True, uri=URI,
                 ctx=test_environment.test_context)
-        self.foo_database = CouchDatabase('foo', create=True, uri=URI,
+        self.foo_database = DesktopDatabase('foo', create=True, uri=URI,
                 ctx=test_environment.test_context)
         #create some records to pull out and test
-        self.foo_database = CouchDatabase('bar', create=True, uri=URI,
+        self.foo_database = DesktopDatabase('bar', create=True, uri=URI,
                 ctx=test_environment.test_context)
         #create some records to pull out and test
         self.foo_database.put_record(Record({

=== modified file 'desktopcouch/application/platform/linux/__init__.py'
--- desktopcouch/application/platform/linux/__init__.py	2010-11-22 18:21:40 +0000
+++ desktopcouch/application/platform/linux/__init__.py	2010-11-24 15:19:50 +0000
@@ -73,7 +73,7 @@
         if start_if_not_running:
             # start CouchDB by running the startup script
             logging.info("Desktop CouchDB is not running; starting it.")
-            from desktopcouch import start_local_couchdb
+            from desktopcouch.application import start_local_couchdb
             pid = start_local_couchdb.start_couchdb(ctx=ctx)
             # now load the design documents and pair records updates,
             # because it's started

=== modified file 'desktopcouch/application/platform/windows/__init__.py'
--- desktopcouch/application/platform/windows/__init__.py	2010-11-22 18:21:40 +0000
+++ desktopcouch/application/platform/windows/__init__.py	2010-11-24 15:19:50 +0000
@@ -1,7 +1,7 @@
 """Windows platform specific code."""
 
+
 # FIXME make thisdo something or document why it does not
-
 def set_application_name(app_name):
     """Set the application name."""
     pass

=== modified file 'desktopcouch/application/replication_services/ubuntuone.py'
--- desktopcouch/application/replication_services/ubuntuone.py	2010-11-19 00:45:03 +0000
+++ desktopcouch/application/replication_services/ubuntuone.py	2010-11-24 15:19:50 +0000
@@ -113,7 +113,7 @@
 db_name_prefix = PrefixGetter()         # pylint: disable=C0103
 
 
-from desktopcouch.records.server import CouchDatabase
+from desktopcouch.application.server import DesktopDatabase
 from desktopcouch.application.pair.couchdb_pairing import couchdb_io
 from desktopcouch.application import local_files
 
@@ -128,8 +128,8 @@
     Ubuntu One cloud couchdb servers."""
     def __init__(self, url=None, ctx=local_files.DEFAULT_CONTEXT):
         super(ReplicationExclusion, self).__init__()
-        self.management_db = CouchDatabase("management", uri=url, create=True,
-                ctx=ctx)
+        self.management_db = DesktopDatabase(
+            "management", uri=url, create=True, ctx=ctx)
         all_pairing_records = self.management_db.get_all_records(
                 record_type=couchdb_io.PAIRED_SERVER_RECORD_TYPE)
         for result in all_pairing_records:

=== renamed file 'desktopcouch/records/server.py' => 'desktopcouch/application/server.py'
--- desktopcouch/records/server.py	2010-11-23 21:02:32 +0000
+++ desktopcouch/application/server.py	2010-11-24 15:19:50 +0000
@@ -21,35 +21,31 @@
 
 """The Desktop Couch Records API."""
 
-import copy
-import uuid
+import urlparse
+import warnings
 
 from couchdb import Server
 from couchdb.client import Resource
-import desktopcouch
-from desktopcouch.records import server_base
+
+from desktopcouch.application.local_files import (
+    DEFAULT_CONTEXT, get_oauth_tokens)
+from desktopcouch.records.database import Database, OAuthCapableHttp
 from desktopcouch.application.platform import find_port
-from desktopcouch.application.local_files import DEFAULT_CONTEXT
-import urlparse
-
-DCTRASH = 'dctrash'
-
-
-class OAuthCapableServer(Server):
+
+
+class DesktopServer(Server):
     """Subclass Server to provide oauth magic"""
     # pylint: disable=W0231
     # __init__ method from base class is not called
     def __init__(self, uri, oauth_tokens=None, ctx=None):
         """Subclass of couchdb.client.Server which creates a custom
            httplib2.Http subclass which understands OAuth"""
-        http = server_base.OAuthCapableHttp(scheme=urlparse.urlparse(uri)[0],
-                                            timeout=30)
+        http = OAuthCapableHttp(scheme=urlparse.urlparse(uri)[0], timeout=30)
         http.force_exception_to_status_code = False
         if ctx is None:
-            ctx = desktopcouch.application.local_files.DEFAULT_CONTEXT
+            ctx = DEFAULT_CONTEXT
         if oauth_tokens is None:
-            oauth_tokens = \
-                desktopcouch.application.local_files.get_oauth_tokens(ctx)
+            oauth_tokens = get_oauth_tokens(ctx)
         (consumer_key, consumer_secret, token, token_secret) = (
             oauth_tokens["consumer_key"], oauth_tokens["consumer_secret"],
             oauth_tokens["token"], oauth_tokens["token_secret"])
@@ -59,44 +55,31 @@
     # pylint: enable=W0231
 
 
-class CouchDatabase(server_base.CouchDatabaseBase):
-    """An small records specific abstraction over a couch db database."""
-
-    def __init__(self, database, uri=None, record_factory=None, create=False,
-                 server_class=OAuthCapableServer, oauth_tokens=None,
+class OAuthCapableServer(DesktopServer):
+    """Deprecated."""
+
+    def __init__(self, uri, oauth_tokens=None, ctx=None):
+        warnings.warn(
+            "OAuthCapableServer is deprecated, use DesktopServer "
+            "instead.", DeprecationWarning, stacklevel=2)
+        super(OAuthCapableServer, self).__init__(
+            uri, oauth_tokens=oauth_tokens, ctx=ctx)
+
+
+class DesktopDatabase(Database):
+    """A desktopcouch specific CouchDb database."""
+
+    def __init__(self, database, uri=None, record_factory=None,
+                 create=False, server_class=DesktopServer, oauth_tokens=None,
                  ctx=None):
         if ctx is None:
             ctx = DEFAULT_CONTEXT
         self.ctx = ctx
         self.server_uri = uri
-        super(CouchDatabase, self).__init__(
-                database, uri, record_factory=record_factory, create=create,
-                server_class=server_class, oauth_tokens=oauth_tokens, ctx=ctx)
-
-    # pylint: disable=W0212
-    #Access to a protected member
-    def delete_record(self, record_id):
-        """Delete record with given id"""
-        record = self.get_record(record_id)
-        new_record = copy.deepcopy(record)
-        dctrash = CouchDatabase(
-            database=DCTRASH,
-            uri=self.server_uri,
-            create=True,
-            **self._server_class_extras)
-        new_record.record_id = str(uuid.uuid4())
-        del new_record._data['_rev']
-        try:
-            del new_record._data['_attachments']
-        except KeyError:
-            pass
-        new_record.application_annotations['desktopcouch'] = {
-            'private_application_annotations':
-            {'original_database_name': self._database_name,
-             'original_id': record_id}}
-        del self.db[record_id]
-        return dctrash.put_record(new_record)
-    # pylint: enable=W0212
+        super(DesktopDatabase, self).__init__(
+            database, uri, record_factory=record_factory,
+            create=create, server_class=server_class,
+            oauth_tokens=oauth_tokens, ctx=ctx)
 
     # pylint: disable=W0221
     # Arguments number differs from overridden method
@@ -106,5 +89,20 @@
             uri = "http://localhost:%s" % port
         else:
             uri = self.server_uri
-        super(CouchDatabase, self)._reconnect(uri=uri)
+        super(DesktopDatabase, self)._reconnect(uri=uri)
     # pylint: enable=W0221
+
+
+class CouchDatabase(DesktopDatabase):
+    """Deprecated."""
+
+    def __init__(self, database, uri=None, record_factory=None,
+                 create=False, server_class=DesktopServer, oauth_tokens=None,
+                 ctx=None):
+        warnings.warn(
+            "CouchDatabase is deprecated, use DesktopDatabase instead.",
+            DeprecationWarning, stacklevel=2)
+        super(CouchDatabase, self).__init__(
+            database, uri=uri, record_factory=record_factory,
+            create=create, server_class=server_class,
+            oauth_tokens=oauth_tokens, ctx=ctx)

=== modified file 'desktopcouch/application/service.py'
--- desktopcouch/application/service.py	2010-11-19 16:23:47 +0000
+++ desktopcouch/application/service.py	2010-11-24 15:19:50 +0000
@@ -41,11 +41,11 @@
 import logging.handlers
 import signal
 
-import desktopcouch
 from desktopcouch.application import local_files
 from desktopcouch.application import replication
 from desktopcouch.application import stop_local_couchdb
-from desktopcouch.application.platform import PortAdvertiser
+from desktopcouch.application.platform import (
+    PortAdvertiser, find_pid, direct_access_find_port)
 
 MAIN_START_EXTENSION_ENTRY_POINT = "desktopcouch.service.start"
 
@@ -80,19 +80,14 @@
     """Host the services."""
 
     # pylint: disable=C0301
-    def __init__(self, main_loop,
-                 pid_finder=desktopcouch.application.platform.find_pid,
-                 port_finder=desktopcouch.application.platform.direct_access_find_port,
+    def __init__(self, main_loop, pid_finder=find_pid,
+                 port_finder=direct_access_find_port,
                  ctx=local_files.DEFAULT_CONTEXT,
                  stop_couchdb=stop_local_couchdb.stop_couchdb,
                  replication_actions=replication,
-                 advertiser_factory=PortAdvertiser,
-                 set_logging=set_up_logging,
-                 resources=pkg_resources,
-                 fork=os.fork,
-                 nice=os.nice,
-                 kill=os.kill,
-                 sleep=time.sleep):
+                 advertiser_factory=PortAdvertiser, set_logging=set_up_logging,
+                 resources=pkg_resources, fork=os.fork, nice=os.nice,
+                 kill=os.kill, sleep=time.sleep):
         self._mainloop = main_loop
         self._pid_finder = pid_finder
         self._port_finder = port_finder

=== modified file 'desktopcouch/application/start_local_couchdb.py'
--- desktopcouch/application/start_local_couchdb.py	2010-11-23 22:43:14 +0000
+++ desktopcouch/application/start_local_couchdb.py	2010-11-24 15:19:50 +0000
@@ -49,7 +49,7 @@
 from desktopcouch.application import local_files
 from desktopcouch.application.platform import (
     read_pidfile, process_is_couchdb, find_port)
-from desktopcouch.records.server import CouchDatabase
+from desktopcouch.application.server import DesktopDatabase
 import xdg.BaseDirectory
 
 
@@ -142,7 +142,7 @@
             database_name = os.path.split(database_root)[1]
             # Just the presence of database.cfg is enough to create
             # the database
-            db = CouchDatabase(database_name, create=True, ctx=ctx)
+            db = DesktopDatabase(database_name, create=True, ctx=ctx)
             # look for design documents
             dd_spec = os.path.join(
                 database_root, "_design", "*", "views", "*", "map.js")

=== modified file 'desktopcouch/application/tests/test_replication.py'
--- desktopcouch/application/tests/test_replication.py	2010-11-19 00:45:03 +0000
+++ desktopcouch/application/tests/test_replication.py	2010-11-24 15:19:50 +0000
@@ -21,11 +21,11 @@
 
     def test_creation(self):
         """Test creation."""
-        self.db_apple = desktopcouch.records.server.CouchDatabase("apple",
-                create=True, ctx=test_environment.test_context)
+        self.db_apple = desktopcouch.application.server.DesktopDatabase(
+            "apple", create=True, ctx=test_environment.test_context)
         other_context = test_environment.create_new_test_environment()
-        self.db_banana = desktopcouch.records.server.CouchDatabase("banana",
-                create=True, ctx=other_context)
+        self.db_banana = desktopcouch.application.server.DesktopDatabase(
+            "banana", create=True, ctx=other_context)
         # XXX: assert something.
 
 

=== modified file 'desktopcouch/application/tests/test_start_local_couchdb.py'
--- desktopcouch/application/tests/test_start_local_couchdb.py	2010-11-19 00:45:03 +0000
+++ desktopcouch/application/tests/test_start_local_couchdb.py	2010-11-24 15:19:50 +0000
@@ -92,9 +92,10 @@
     def test_create_databases_and_design_docs(self):  # pylint: disable=R0201
         """Are databases and design documents correctly
            created from the filesystem?"""
-        # Mock CouchDatabase
+        # Mock DesktopDatabase
         mocker = Mocker()
-        couchdb = mocker.replace("desktopcouch.records.server.CouchDatabase")
+        couchdb = mocker.replace(
+            "desktopcouch.application.server.DesktopDatabase")
 
         # databases that should be created
         couchdb("cfg", create=True, ctx=test_environment.test_context)

=== renamed file 'desktopcouch/records/server_base.py' => 'desktopcouch/records/database.py'
--- desktopcouch/records/server_base.py	2010-11-22 18:21:40 +0000
+++ desktopcouch/records/database.py	2010-11-24 15:19:50 +0000
@@ -25,6 +25,7 @@
 import cgi
 import copy
 import httplib2
+import uuid
 import urlparse
 import warnings
 
@@ -35,7 +36,7 @@
 from oauth import oauth
 
 from couchdb import Server
-from couchdb.client import ResourceNotFound, ResourceConflict
+from couchdb.client import ResourceConflict, ResourceNotFound
 from couchdb.design import ViewDefinition
 from desktopcouch.records import Record
 import logging
@@ -43,6 +44,7 @@
 import string                           # pylint: disable=W0402
 
 DEFAULT_DESIGN_DOCUMENT = None  # each view in its own eponymous design doc.
+DCTRASH = 'dc_trash'
 
 
 def base_n(num, base, numerals=string.printable):
@@ -170,8 +172,8 @@
         return False
 
 
-class CouchDatabaseBase(object):
-    """An small records specific abstraction over a couch db database."""
+class Database(object):
+    """A desktopcouch.records specific CouchDb database."""
 
     def __init__(self, database, uri, record_factory=None, create=False,
                  server_class=Server, **server_class_extras):
@@ -410,13 +412,30 @@
             return False
         return not row_is_deleted(record)
 
+    # pylint: disable=W0212
+    #Access to a protected member
     def delete_record(self, record_id):
         """Delete record with given id"""
-        record = self.db[record_id]
-        record.setdefault('application_annotations', {}).setdefault(
-            'Ubuntu One', {}).setdefault(
-            'private_application_annotations', {})['deleted'] = True
-        self.db[record_id] = record
+        record = self.get_record(record_id)
+        new_record = copy.deepcopy(record)
+        dctrash = self.__class__(
+            database=DCTRASH,
+            uri=self.server_uri,
+            create=True,
+            **self._server_class_extras)
+        new_record.record_id = str(uuid.uuid4())
+        del new_record._data['_rev']
+        try:
+            del new_record._data['_attachments']
+        except KeyError:
+            pass
+        new_record.application_annotations['desktopcouch'] = {
+            'private_application_annotations':
+            {'original_database_name': self._database_name,
+             'original_id': record_id}}
+        del self.db[record_id]
+        return dctrash.put_record(new_record)
+    # pylint: enable=W0212
 
     def delete_view(self, view_name, design_doc=DEFAULT_DESIGN_DOCUMENT):
         """Remove a view, given its name.  Raises a KeyError on a unknown
@@ -656,3 +675,16 @@
         self.db.resource.post(
             path='_ensure_full_commit',
             headers={'Content-Type': 'application/json'})
+
+
+class CouchDatabaseBase(Database):
+    """Deprecated."""
+
+    def __init__(self, database, uri, record_factory=None, create=False,
+                 server_class=Server, **server_class_extras):
+        warnings.warn(
+            "CouchDatabaseBase is deprecated, use Database instead.",
+            DeprecationWarning, stacklevel=2)
+        super(CouchDatabaseBase, self).__init__(
+            database, uri, record_factory=record_factory, create=create,
+            server_class=server_class, **server_class_extras)

=== modified file 'desktopcouch/records/doc/records.txt'
--- desktopcouch/records/doc/records.txt	2010-11-18 19:58:16 +0000
+++ desktopcouch/records/doc/records.txt	2010-11-24 15:19:50 +0000
@@ -1,6 +1,6 @@
 The Records API
 
->>> from desktopcouch.records.server import CouchDatabase
+>>> from desktopcouch.application.server import DesktopDatabase
 >>> from desktopcouch.records import Record
 
 Create a database object. Your database needs to exist. If it doesn't, you
@@ -8,7 +8,7 @@
 
 # for this doctest the db is created and passed in, to make it work
 # with the test couchdb instance, but normally you would have to do:
-# >>> db = CouchDatabase('testing', create=True)
+# >>> db = DesktopDatabase('testing', create=True)
 
 Create a Record object. Records have a record type, which should be a
 URL.  The URL should point to a human-readable document which

=== added file 'desktopcouch/records/server.py'
--- desktopcouch/records/server.py	1970-01-01 00:00:00 +0000
+++ desktopcouch/records/server.py	2010-11-24 15:19:50 +0000
@@ -0,0 +1,9 @@
+"""Deprecated."""
+
+import warnings
+warnings.warn(
+    'Deprecated import path; use desktopcouch.application.server '
+    'instead.', DeprecationWarning, stacklevel=2)
+
+# pylint: disable=W0401,W0614
+from desktopcouch.application.server import *

=== added file 'desktopcouch/records/server_base.py'
--- desktopcouch/records/server_base.py	1970-01-01 00:00:00 +0000
+++ desktopcouch/records/server_base.py	2010-11-24 15:19:50 +0000
@@ -0,0 +1,9 @@
+"""Deprecated."""
+
+import warnings
+warnings.warn(
+    'Deprecated import path; use desktopcouch.records.database '
+    'instead.', DeprecationWarning, stacklevel=2)
+
+# pylint: disable=W0401,W0614
+from desktopcouch.records.database import *

=== modified file 'desktopcouch/records/tests/__init__.py'
--- desktopcouch/records/tests/__init__.py	2009-09-01 22:29:01 +0000
+++ desktopcouch/records/tests/__init__.py	2010-11-24 15:19:50 +0000
@@ -13,5 +13,4 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with desktopcouch.  If not, see <http://www.gnu.org/licenses/>.
-"""Tests for Documents API"""
-
+"""Tests for Records API."""

=== modified file 'desktopcouch/records/tests/test_record.py'
--- desktopcouch/records/tests/test_record.py	2010-11-22 15:26:47 +0000
+++ desktopcouch/records/tests/test_record.py	2010-11-24 15:19:50 +0000
@@ -25,7 +25,7 @@
 from collections import MutableSequence, MutableMapping
 
 import desktopcouch
-from desktopcouch.records.server import CouchDatabase
+from desktopcouch.application.server import DesktopDatabase
 from desktopcouch.records import (
     Record, RecordDict, MergeableList, record_factory, IllegalKeyException,
     validate, NoRecordTypeSpecified, is_mergeable_list)
@@ -182,7 +182,7 @@
         self.assertRaises(AttributeError, set_rev, self.record)
 
         ctx = test_environment.test_context
-        db = CouchDatabase('testing', create=True, ctx=ctx)
+        db = DesktopDatabase('testing', create=True, ctx=ctx)
         record_id = db.put_record(self.record)
 
         db.get_record(record_id)
@@ -325,7 +325,7 @@
     def test_run_doctests(self):
         """Run all doc tests from here to set the proper context (ctx)"""
         ctx = test_environment.test_context
-        globs = {"db": CouchDatabase('testing', create=True, ctx=ctx)}
+        globs = {"db": DesktopDatabase('testing', create=True, ctx=ctx)}
 
         records_tests_path = os.path.dirname(
             desktopcouch.__file__) + '/records/doc/records.txt'

=== modified file 'desktopcouch/records/tests/test_server.py'
--- desktopcouch/records/tests/test_server.py	2010-11-22 20:33:58 +0000
+++ desktopcouch/records/tests/test_server.py	2010-11-24 15:19:50 +0000
@@ -25,9 +25,9 @@
 import time
 
 import desktopcouch.application.tests as test_environment
-from desktopcouch.records.server import CouchDatabase
-from desktopcouch.records.server_base import (
-    row_is_deleted, NoSuchDatabase, FieldsConflict, ResourceConflict)
+from desktopcouch.application.server import DesktopDatabase
+from desktopcouch.records.database import (
+    row_is_deleted, NoSuchDatabase, FieldsConflict, ResourceConflict, DCTRASH)
 from desktopcouch.records import Record
 from desktopcouch.application.stop_local_couchdb import stop_couchdb
 from desktopcouch.application.platform import find_pid
@@ -40,8 +40,6 @@
     from cStringIO import StringIO as StringIO
 # pylint: enable=F0401
 
-DCTRASH = 'dctrash'
-
 
 def get_test_context():
     """Return test context."""
@@ -59,7 +57,7 @@
         super(TestCouchDatabaseDeprecated, self).setUp()
         # Connect to CouchDB server
         self.dbname = self._testMethodName
-        self.database = CouchDatabase(self.dbname, create=True,
+        self.database = DesktopDatabase(self.dbname, create=True,
                 ctx=get_test_context())
         #create some records to pull out and test
         self.database.put_record(Record({
@@ -159,15 +157,15 @@
             KeyError, self.database.get_records, create_view=None)
 
 
-class TestCouchDatabase(testtools.TestCase):
-    """tests specific for CouchDatabase"""
+class TestDesktopDatabase(testtools.TestCase):
+    """Test case for DesktopDatabase."""
 
     def setUp(self):
         """setup each test"""
-        super(TestCouchDatabase, self).setUp()
+        super(TestDesktopDatabase, self).setUp()
         # Connect to CouchDB server
         self.dbname = self._testMethodName
-        self.database = CouchDatabase(self.dbname, create=True,
+        self.database = DesktopDatabase(self.dbname, create=True,
                 ctx=get_test_context())
         #create some records to pull out and test
         self.database.put_record(Record({
@@ -186,7 +184,7 @@
         this_context = get_test_context()
         if this_context != test_environment.test_context:
             stop_couchdb(ctx=this_context)
-        super(TestCouchDatabase, self).tearDown()
+        super(TestDesktopDatabase, self).tearDown()
 
     def maybe_die(self):
         """Method that could kill couchdb. Or could it? Or COULD it?"""
@@ -209,7 +207,8 @@
     def test_database_not_exists(self):
         """Test that the database does not exist."""
         self.assertRaises(
-            NoSuchDatabase, CouchDatabase, "this-must-not-exist", create=False)
+            NoSuchDatabase, DesktopDatabase, "this-must-not-exist",
+            create=False)
 
     def test_get_records_by_record_type_save_view(self):
         """Test getting mutliple records by type"""
@@ -273,7 +272,7 @@
         record_id = self.database.put_record(record)
         trash_record_id = self.database.delete_record(record_id)
         self.assertIn(DCTRASH, self.database._server)
-        dctrash = CouchDatabase(DCTRASH, create=False,
+        dctrash = DesktopDatabase(DCTRASH, create=False,
                                          ctx=get_test_context())
         deleted_record = dctrash.get_record(trash_record_id)
         self.assertNotEqual(record_id, deleted_record.record_id)

=== modified file 'desktopcouch/recordtypes/contacts/__init__.py'
--- desktopcouch/recordtypes/contacts/__init__.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/recordtypes/contacts/__init__.py	2010-11-24 15:19:50 +0000
@@ -54,4 +54,3 @@
     def __init__(self, data=None, record_id=None):
         super(Contact, self).__init__(
             record_id=record_id, data=data, record_type=CONTACT_RECORD_TYPE)
-

=== modified file 'desktopcouch/recordtypes/contacts/testing/create.py'
--- desktopcouch/recordtypes/contacts/testing/create.py	2010-11-19 00:45:03 +0000
+++ desktopcouch/recordtypes/contacts/testing/create.py	2010-11-24 15:19:50 +0000
@@ -24,7 +24,7 @@
 import uuid
 
 import desktopcouch.application.tests as test_environment
-from desktopcouch.records.server import OAuthCapableServer
+from desktopcouch.application.server import DesktopServer
 from desktopcouch.application.platform import find_port
 
 CONTACT_DOCTYPE = \
@@ -176,7 +176,7 @@
 
 def create_many_contacts(num_contacts=10, host='localhost', port=None,
                          db_name='contacts', doctype=CONTACT_DOCTYPE,
-                         app_annots=None, server_class=OAuthCapableServer):
+                         app_annots=None, server_class=DesktopServer):
     """Make many contacts and create their records"""
     if port is None:
         port = find_port(ctx=test_environment.test_context)

=== modified file 'desktopcouch/recordtypes/contacts/tests/test_record.py'
--- desktopcouch/recordtypes/contacts/tests/test_record.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/recordtypes/contacts/tests/test_record.py	2010-11-24 15:19:50 +0000
@@ -31,6 +31,7 @@
     'addresses', 'phone_numbers', 'email_addresses', 'urls', 'im_addresses'))
 ALL_FIELDS = SINGLE_FIELDS | LIST_FIELDS
 
+
 class TestContactRecord(testtools.TestCase):
     """Test the Contact Record object."""
 
@@ -47,4 +48,3 @@
         contact.first_name = first_name
         self.assertEqual(first_name, contact.first_name)
         self.assertEqual(set(['first_name']), set(contact.keys()))
-

=== modified file 'desktopcouch/recordtypes/contacts/tests/test_view.py'
--- desktopcouch/recordtypes/contacts/tests/test_view.py	2010-11-22 20:33:58 +0000
+++ desktopcouch/recordtypes/contacts/tests/test_view.py	2010-11-24 15:19:50 +0000
@@ -19,7 +19,7 @@
 """Test view."""
 
 import desktopcouch.application.tests as test_environment
-from desktopcouch.records import server
+from desktopcouch.application import server
 from desktopcouch.recordtypes.contacts import (
     CONTACT_RECORD_TYPE, view, Contact)
 
@@ -151,7 +151,7 @@
     def setUp(self):
         super(TestLocalFiles, self).setUp()
         self.dbname = "contacts"
-        self.db = server.CouchDatabase(
+        self.db = server.DesktopDatabase(
             self.dbname, create=True, ctx=test_environment.test_context)
         self.db.put_record(Contact(data=FRANCES_RECORD_DATA))
         self.db.put_records_batch(

=== modified file 'desktopcouch/recordtypes/contacts/view.py'
--- desktopcouch/recordtypes/contacts/view.py	2010-11-22 20:33:58 +0000
+++ desktopcouch/recordtypes/contacts/view.py	2010-11-24 15:19:50 +0000
@@ -24,48 +24,53 @@
 
 
 VIEW_MAP_PREFIXED_FIELDS = """
-    function(doc) {
-        function emit_dict(prefix, dict) {
-            for (var k in dict) {
-                var v = dict[k];
-                if (v == undefined)
-                    continue;
+function(doc) {
+    function emit_dict(prefix, dict) {
+        for (var k in dict) {
+            var v = dict[k];
+            if (v == undefined)
+                continue;
 
-                if (v.substring) {
-                    emit(prefix+k+":"+v, null);
-                    switch (prefix+k) {   // Weird cases that may be useful.
-                        case "birth_date":
-                        case "wedding_date":
-                            emit(prefix+k+":"+v.substring(v.indexOf("-")), null); break; // drop year
-                        case "email_addressesaddress":
-                            if (v.lastIndexOf("@") > -1) {
-                                emit(prefix+k+":"+v.substring(v.lastIndexOf("@")+1), null); break; // drop user part
-                            } else if (v.indexOf("!") > -1) {
-                                emit(prefix+k+":"+v.substring(0, v.indexOf("!")-1), null); break; // drop user part
-                            }
-                    }
-                } else {
-                    for (subk in v)
-                        emit_dict(prefix+k, v[subk])
+            if (v.substring) {
+                emit(prefix+k+":"+v, null);
+                switch (prefix+k) {   // Weird cases that may be useful.
+                    case "birth_date":
+                    case "wedding_date":
+                        emit(prefix+k+":"+v.substring(v.indexOf("-")), null);
+                        break; // drop year
+                    case "email_addressesaddress":
+                        if (v.lastIndexOf("@") > -1) {
+                            emit(prefix+k+":"+v.substring(
+                                v.lastIndexOf("@")+1), null);
+                            break; // drop user part
+                        } else if (v.indexOf("!") > -1) {
+                            emit(prefix+k+":"+v.substring(
+                                0, v.indexOf("!")-1), null);
+                            break; // drop user part
+                        }
                 }
+            } else {
+                for (subk in v)
+                    emit_dict(prefix+k, v[subk])
             }
         }
-
-        try {
-            if (doc['application_annotations']['Ubuntu One']
-                    ['private_application_annotations']['deleted'])
-                return;
-        } catch (e) {
-            // nothing
-        }
-
-        if (doc['record_type'] != '%(CONTACT_RECORD_TYPE)s')
-        {
+    }
+
+    try {
+        if (doc['application_annotations']['Ubuntu One']
+                ['private_application_annotations']['deleted'])
             return;
-        }
-
-        emit_dict("", doc);
-    }
+    } catch (e) {
+        // nothing
+    }
+
+    if (doc['record_type'] != '%(CONTACT_RECORD_TYPE)s')
+    {
+        return;
+    }
+
+    emit_dict("", doc);
+}
 """ % {'CONTACT_RECORD_TYPE': CONTACT_RECORD_TYPE}
 
 

=== modified file 'desktopcouch/recordtypes/notes.py'
--- desktopcouch/recordtypes/notes.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/recordtypes/notes.py	2010-11-24 15:19:50 +0000
@@ -24,6 +24,7 @@
 NOTE_RECORD_TYPE = \
           'http://www.freedesktop.org/wiki/Specifications/desktopcouch/note'
 
+
 class Note(Record):
     """Note record """
 

=== modified file 'desktopcouch/recordtypes/tasks.py'
--- desktopcouch/recordtypes/tasks.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/recordtypes/tasks.py	2010-11-24 15:19:50 +0000
@@ -25,6 +25,7 @@
 TASK_RECORD_TYPE = \
             'http://www.freedesktop.org/wiki/Specifications/desktopcouch/task'
 
+
 class Task(Record):
     """ Task records."""
 
@@ -33,4 +34,3 @@
     def __init__(self, data=None, record_id=None):
         super(Task, self).__init__(
             record_id=record_id, data=data, record_type=TASK_RECORD_TYPE)
-

=== modified file 'desktopcouch/recordtypes/tests/test_notes.py'
--- desktopcouch/recordtypes/tests/test_notes.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/recordtypes/tests/test_notes.py	2010-11-24 15:19:50 +0000
@@ -31,8 +31,8 @@
     'content': 'string',
     # Date fields
     'last_change_date': 'date',
-    'create_date': 'date'
-}
+    'create_date': 'date'}
+
 
 class TestNoteRecord(testtools.TestCase):
     """Test the Note Record object."""
@@ -50,6 +50,3 @@
         # different timezones so we remove the timezone value
         # before asserting equal
         self.assertEqual(now[0:-1], note.last_change_date[0:-1])
-
-
-

=== modified file 'desktopcouch/recordtypes/tests/test_tasks.py'
--- desktopcouch/recordtypes/tests/test_tasks.py	2010-11-18 19:58:16 +0000
+++ desktopcouch/recordtypes/tests/test_tasks.py	2010-11-24 15:19:50 +0000
@@ -23,6 +23,7 @@
 
 from desktopcouch.recordtypes.tasks import Task, TASK_RECORD_TYPE
 
+
 class TestTaskRecord(testtools.TestCase):
     """Test the Task Record object."""
 
@@ -34,4 +35,3 @@
         summary = "manuel"
         task.summary = summary
         self.assertEqual(summary, task.summary)
-