Make document service an interface

chrome/browser/chromeos/gdata/gdata.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_CHROMEOS_GDATA_GDATA_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 165 matching lines @@
   std::string refresh_token_;
   std::string auth_token_;
   ObserverList<Observer> observers_;
 
   content::NotificationRegistrar registrar_;
   base::WeakPtrFactory<GDataAuthService> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GDataAuthService);
 };
 
+// This defines an interface for sharing by DocumentService and
+// MockDocumentService so that we can do testing of clients of DocumentService.
+class DocumentsServiceInterface {
+ public:
+  DocumentsServiceInterface();
+  virtual ~DocumentsServiceInterface();
+
+  // Initializes the documents service tied with |profile|.
+  virtual void Initialize(Profile* profile) = 0;
+
+  // Cancels all in-flight operations.
+  virtual void CancelAll() = 0;
+
+  // needed. |callback| will be run with the error code and the auth

[zel, 2012/03/08 00:02:03]

bad cat and paste, make sure this matches the correct comment from
DocumentsService::Authenticate() before your CL

[Greg Spencer (Chromium), 2012/03/08 01:10:39]

Done.

+  // token, on the thread this function is run.
+  virtual void Authenticate(const AuthStatusCallback& callback) = 0;
+
+  // Gets the document feed from |feed_url|. If this URL is empty, the
+  // call will fetch the default ('root') document feed. Upon
+  // completion, invokes |callback| with results.
+  virtual void GetDocuments(const GURL& feed_url,
+                            const GetDataCallback& callback) = 0;
+
+  // Delete a document identified by its 'self' |url| and |etag|.
+  // Upon completion, invokes |callback| with results.
+  virtual void DeleteDocument(const GURL& document_url,
+                              const EntryActionCallback& callback) = 0;
+
+  // Downloads a document identified by its |content_url| in a given
+  // |format|.  Upon completion, invokes |callback| with results.
+  virtual void DownloadDocument(const GURL& content_url,
+                                DocumentExportFormat format,
+                                const DownloadActionCallback& callback) = 0;
+
+  // Creates new collection with |directory_name| under parent
+  // directory identified with |parent_content_url|. If
+  // |parent_content_url| is empty, the new collection will be created
+  // in the root. Upon completion, invokes |callback| and passes newly
+  // created entry.
+  virtual void CreateDirectory(const GURL& parent_content_url,
+                               const FilePath::StringType& directory_name,
+                               const GetDataCallback& callback) = 0;
+
+  // Downloads a file identified by its |content_url|. Upon
+  // completion, invokes |callback| with results.
+  virtual void DownloadFile(const GURL& content_url,
+                            const DownloadActionCallback& callback) = 0;
+
+  // Initiate uploading of a document/file.
+  virtual void InitiateUpload(const InitiateUploadParams& upload_file_info,
+                              const InitiateUploadCallback& callback) = 0;
+
+  // Resume uploading of a document/file.
+  virtual void ResumeUpload(const ResumeUploadParams& upload_file_info,
+                            const ResumeUploadCallback& callback) = 0;
+};
+
 // This class provides documents feed service calls.
-class DocumentsService : public GDataAuthService::Observer {
+class DocumentsService
+    : public DocumentsServiceInterface,
+      public GDataAuthService::Observer {
  public:
   // DocumentsService is usually owned and created by GDataFileSystem.
   DocumentsService();
   virtual ~DocumentsService();
 
   // Initializes the documents service tied with |profile|.
   void Initialize(Profile* profile);
 
   // Cancels all in-flight operations.
   void CancelAll();
 
   // Authenticates the user by fetching the auth token as
   // needed. |callback| will be run with the error code and the auth
   // token, on the thread this function is run.
   //
   // Must be called on UI thread.
   void Authenticate(const AuthStatusCallback& callback);

[zel, 2012/03/08 00:02:03]

1. add comments that you are overriding DocumentsServiceInterface here

2. For this and all other methods below that are overrides from
DocumentsServiceInterface:
- remove function description comments since they are defined in
DocumentsServiceInterface
- add OVERRIDE at the end of each declaration

[Greg Spencer (Chromium), 2012/03/08 01:10:39]

Yeah, I had it this way, and lost it all in the last merge.

Fixed.

 
   // Gets the document feed from |feed_url|. If this URL is empty, the call
   // will fetch the default ('root') document feed. Upon completion,
   // invokes |callback| with results on the calling thread.
   //
   // Can be called on any thread.
   void GetDocuments(const GURL& feed_url, const GetDataCallback& callback);
 
   // Delete a document identified by its 'self' |url| and |etag|.
   // Upon completion, invokes |callback| with results on the calling thread.
@@ skipping 77 matching lines @@
   scoped_ptr<GDataOperationRegistry> operation_registry_;
   base::WeakPtrFactory<DocumentsService> weak_ptr_factory_;
   base::WeakPtr<DocumentsService> weak_ptr_bound_to_ui_thread_;
 
   DISALLOW_COPY_AND_ASSIGN(DocumentsService);
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_H_