google_apis/drive/drive_api_url_generator.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef GOOGLE_APIS_DRIVE_DRIVE_API_URL_GENERATOR_H_
   6 #define GOOGLE_APIS_DRIVE_DRIVE_API_URL_GENERATOR_H_
   7
   8 #include <string>
   9
  10 #include "url/gurl.h"
  11
  12 namespace google_apis {
  13
  14 // This class is used to generate URLs for communicating with drive api
  15 // servers for production, and a local server for testing.
  16 class DriveApiUrlGenerator {
  17  public:
  18   // |base_url| is the path to the target drive api server.
  19   // Note that this is an injecting point for a testing server.
  20   DriveApiUrlGenerator(const GURL& base_url, const GURL& base_download_url);
  21   ~DriveApiUrlGenerator();
  22
  23   // The base URL for communicating with the production drive api server.
  24   static const char kBaseUrlForProduction[];
  25
  26   // The base URL for the file download server for production.
  27   static const char kBaseDownloadUrlForProduction[];
  28
  29   // Returns a URL to invoke "About: get" method.
  30   GURL GetAboutGetUrl() const;
  31
  32   // Returns a URL to invoke "Apps: list" method.
  33   // Set |use_internal_endpoint| to true if official Chrome's API key is used
  34   // and retrieving more information (related to App uninstall) is necessary.
  35   GURL GetAppsListUrl(bool use_internal_endpoint) const;
  36
  37   // Returns a URL to uninstall an app with the give |app_id|.
  38   GURL GetAppsDeleteUrl(const std::string& app_id) const;
  39
  40   // Returns a URL to fetch a file metadata.
  41   GURL GetFilesGetUrl(const std::string& file_id,
  42                       bool use_internal_endpoint,
  43                       const GURL& embed_origin) const;
  44
  45   // Returns a URL to authorize an app to access a file.
  46   GURL GetFilesAuthorizeUrl(const std::string& file_id,
  47                             const std::string& app_id) const;
  48
  49   // Returns a URL to create a resource.
  50   GURL GetFilesInsertUrl() const;
  51
  52   // Returns a URL to patch file metadata.
  53   GURL GetFilesPatchUrl(const std::string& file_id,
  54                         bool set_modified_date,
  55                         bool update_viewed_date) const;
  56
  57   // Returns a URL to copy a resource specified by |file_id|.
  58   GURL GetFilesCopyUrl(const std::string& file_id) const;
  59
  60   // Returns a URL to fetch file list.
  61   GURL GetFilesListUrl(int max_results,
  62                        const std::string& page_token,
  63                        const std::string& q) const;
  64
  65   // Returns a URL to delete a resource with the given |file_id|.
  66   GURL GetFilesDeleteUrl(const std::string& file_id) const;
  67
  68   // Returns a URL to trash a resource with the given |file_id|.
  69   GURL GetFilesTrashUrl(const std::string& file_id) const;
  70
  71   // Returns a URL to fetch a list of changes.
  72   GURL GetChangesListUrl(bool include_deleted,
  73                          int max_results,
  74                          const std::string& page_token,
  75                          int64 start_change_id) const;
  76
  77   // Returns a URL to add a resource to a directory with |folder_id|.
  78   GURL GetChildrenInsertUrl(const std::string& folder_id) const;
  79
  80   // Returns a URL to remove a resource with |child_id| from a directory
  81   // with |folder_id|.
  82   GURL GetChildrenDeleteUrl(const std::string& child_id,
  83                             const std::string& folder_id) const;
  84
  85   // Returns a URL to initiate "resumable upload" of a new file that uploads
  86   // chunked data by multiple HTTP posts.
  87   GURL GetInitiateUploadNewFileUrl(bool set_modified_date) const;
  88
  89   // Returns a URL to initiate "resumable upload" of an existing file specified
  90   // by |resource_id| that uploads chunked data by multiple HTTP posts.
  91   GURL GetInitiateUploadExistingFileUrl(const std::string& resource_id,
  92                                         bool set_modified_date) const;
  93
  94   // Returns a URL for "multipart upload" of a new file that sends both metadata
  95   // and file content in a single HTTP post.
  96   GURL GetMultipartUploadNewFileUrl(bool set_modified_date) const;
  97
  98   // Returns a URL for "multipart upload" of an existing file specified by
  99   // |resource_id| that sends both metadata and file content in a single HTTP
 100   // post.
 101   GURL GetMultipartUploadExistingFileUrl(const std::string& resource_id,
 102                                          bool set_modified_date) const;
 103
 104   // Generates a URL for downloading a file.
 105   GURL GenerateDownloadFileUrl(const std::string& resource_id) const;
 106
 107   // Generates a URL for adding permissions.
 108   GURL GetPermissionsInsertUrl(const std::string& resource_id) const;
 109
 110   // Generates a URL for a thumbnail with specified dimensions. Set |crop| to
 111   // true to get a cropped thumbnail in the dimensions.
 112   GURL GetThumbnailUrl(const std::string& resource_id,
 113                        int width,
 114                        int height,
 115                        bool crop) const;
 116
 117   // Generates a URL for batch upload.
 118   GURL GetBatchUploadUrl() const;
 119
 120  private:
 121   const GURL base_url_;
 122   const GURL base_download_url_;
 123
 124   // This class is copyable hence no DISALLOW_COPY_AND_ASSIGN here.
 125 };
 126
 127 }  // namespace google_apis
 128
 129 #endif  // GOOGLE_APIS_DRIVE_DRIVE_API_URL_GENERATOR_H_