more features

Author: sger

README.md

@@ -7,6 +7,71 @@
  Simple Dropbox v2 client for Elixir.
  work in progress
 
+## Features
+
+* file_requests
+  * /create
+  * /get
+  * /list
+  * /update
+* files
+  * /copy_batch
+  * /copy_batch/check
+  * /copy_reference/get
+  * /copy_reference/save
+  * /copy_v2
+  * /create_folder_v2
+  * /delete_batch
+  * /delete_batch/check
+  * /delete_v2
+  * /download
+  * /get_metadata
+  * /get_preview
+  * /get_temporary_link
+  * /get_thumbnail
+  * /get_thumbnail_batch
+  * /list_folder
+  * /list_folder/continue
+  * /list_folder/get_latest_cursor
+  * /list_folder/longpoll
+  * /list_revisions
+  * /move_batch
+  * /move_batch/check
+  * /move_v2
+  * /permanently_delete
+  * /restore
+  * /save_url
+  * /save_url/check_job_status
+  * /search
+  * /upload
+  * /upload_session/append_v2
+  * /upload_session/finish
+  * /upload_session/finish_batch
+  * /upload_session/finish_batch/check
+  * /upload_session/start
+* paper
+  * /docs/archive
+  * /docs/create
+  * /docs/download
+  * /docs/folder_users/list
+  * /docs/folder_users/list/continue
+  * /docs/get_folder_info
+  * /docs/list
+  * /docs/list/continue
+  * /docs/permanently_delete
+  * /docs/sharing_policy/get
+  * /docs/sharing_policy/set
+  * /docs/update
+  * /docs/users/add
+  * /docs/users/list
+  * /docs/users/list/continue
+  * /docs/users/remove
+* users
+  * /get_account
+  * /get_account_batch
+  * /get_current_account
+  * /get_space_usage
+
 ## Usage
 
 ```sh

lib/elixir_dropbox.ex

@@ -13,6 +13,11 @@ defmodule ElixirDropbox do
     post_request(client, "#{@base_url}#{url}", body, headers)
   end
 
+  def post_url(client, base_url, url, body \\ "") do
+    headers = json_headers()
+    post_request(client, "#{base_url}#{url}", body, headers)
+  end
+
   @spec upload_response(HTTPoison.Response.t) :: response
   def upload_response(%HTTPoison.Response{status_code: 200, body: body}), do: Poison.decode!(body)
   def upload_response(%HTTPoison.Response{status_code: status_code, body: body }) do
@@ -44,7 +49,7 @@ defmodule ElixirDropbox do
     headers = Map.merge(headers, headers(client))
     HTTPoison.post!("#{base_url}#{url}", data, headers) |> download_response
   end
-  
+
   def headers(client) do
     %{ "Authorization" => "Bearer #{client.access_token}" }
   end

lib/file_requests/create.ex

@@ -0,0 +1,62 @@
+defmodule ElixirDropbox.FileRequests do
+ import ElixirDropbox
+
+ @doc """
+ Creates a file request for this user.
+
+ ## Example
+   deadline = %{ "deadline" => "2020-10-12T17:00:00Z" }
+   ElixirDropbox.FileRequests.create client , "cool", "/Temp", deadline
+
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_requests-create
+ """
+ def create(client, title, destination, deadline, open \\ true) do
+   body = %{"title" => title, "destination" => destination, "deadline" => deadline, "open" => open}
+   result = to_string(Poison.Encoder.encode(body, []))
+   post(client, "/file_requests/create", result)
+ end
+
+ @doc """
+ Returns the specified file request.
+
+ ## Example
+   ElixirDropbox.FileRequests.get client , ""
+
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_requests-get
+ """
+ def get(client, id) do
+   body = %{"id" => id,}
+   result = to_string(Poison.Encoder.encode(body, []))
+   post(client, "/file_requests/get", result)
+ end
+
+ @doc """
+ Returns a list of file requests owned by this user.
+ For apps with the app folder permission, this
+ will only return file requests with
+ destinations in the app folder.
+
+ ## Example
+   ElixirDropbox.FileRequests.list client
+
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list
+ """
+ def list(client) do
+   post(client, "/file_requests/list", "null")
+ end
+
+ @doc """
+ Update a file request.
+
+ ## Example
+   deadline = %{ "deadline" => "2020-10-12T17:00:00Z" }
+   ElixirDropbox.FileRequests.create client, "", "cool", "/Temp", deadline
+
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#file_requests-list
+ """
+ def update(client, id, title, destination, deadline, open \\ true) do
+   body = %{"id" => id, "title" => title, "destination" => destination, "deadline" => deadline, "open" => open}
+   result = to_string(Poison.Encoder.encode(body, []))
+   post(client, "/file_requests/update", result)
+ end
+end

lib/file_requests/file_requests.ex

@@ -1,4 +1,8 @@
 defmodule ElixirDropbox.Files do
+  @moduledoc """
+  This module contains endpoints and data types
+  for basic file operations.
+  """
  import ElixirDropbox
  import ElixirDropbox.Utils
 
@@ -38,13 +42,17 @@ defmodule ElixirDropbox.Files do
   end
 
  @doc """
-  Delete folder returns map
+ Delete the file or folder at a given path.
+ If the path is a folder, all its contents will be deleted too.
+ A successful response indicates that the file or folder was deleted.
+ The returned metadata will be the corresponding FileMetadata
+ or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.
 
-   ## Example
+ ## Example
 
-    ElixirDropbox.Files.delete_folder client, "/Path"
+    ElixirDropbox.Files.delete_folder client, "/Homework/math/Prime_Numbers.txt"
 
-  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-delete
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-delete_v2
  """
   def delete_folder(client, path) do
     body = %{"path" => path}
@@ -102,12 +110,36 @@ defmodule ElixirDropbox.Files do
     post(client, "/files/move", result)
   end
 
+  @doc """
+  Restore a file to a specific revision.
+
+  ## Example
+
+    ElixirDropbox.Files.restore(client, "/root/word.docx", "a1c10ce0dd78")
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-restore
+  """
   def restore(client, path, rev) do
     body = %{"path" => path, "rev" => rev}
     result = to_string(Poison.Encoder.encode(body, []))
     post(client, "/files/restore", result)
   end
 
+  @doc """
+  Searches for files and folders.
+
+  ## Example
+
+    ElixirDropbox.Files.search(client, "/root", "word.docx")
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-search
+  """
+  def search(client, path, query, start \\ 0, max_results \\ 100, mode \\ "filename") do
+    body = %{"path" => path, "query" => query, "start" => start, "max_results" => max_results, "mode" => mode}
+    result = to_string(Poison.Encoder.encode(body, []))
+    post(client, "/files/search", result)
+  end
+
   @doc """
   Create a new file with the contents provided in the request.
 
@@ -128,6 +160,15 @@ defmodule ElixirDropbox.Files do
     upload_request(client, Application.get_env(:elixir_dropbox, :upload_url), "files/upload", file, headers)
   end
 
+  @doc """
+  Download a file from a user's Dropbox.
+
+  ## Example
+
+    ElixirDropbox.Files.download client, "/mypdf.pdf"
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-download
+  """
   def download(client, path) do
     dropbox_headers = %{
       :path => path
@@ -136,6 +177,15 @@ defmodule ElixirDropbox.Files do
     download_request(client, Application.get_env(:elixir_dropbox, :upload_url), "files/download", [], headers)
   end
 
+  @doc """
+  Get a thumbnail for an image.
+
+  ## Example
+
+    ElixirDropbox.Files.get_thumbnail client, "/image.jpg"
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail
+  """
   def get_thumbnail(client, path, format \\ "jpeg", size \\ "w64h64") do
     dropbox_headers = %{
       :path => path,
@@ -146,6 +196,31 @@ defmodule ElixirDropbox.Files do
     download_request(client, Application.get_env(:elixir_dropbox, :upload_url), "files/get_thumbnail", [], headers)
   end
 
+  @doc """
+  Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.
+
+  ## Example
+    batch = %{ "path" => "/image.jpg", "format" => "jpeg", "size" => "w64h64"}
+    entries = [batch]
+    ElixirDropbox.Files.get_thumbnail_batch client, entries
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail_batch
+  """
+  def get_thumbnail_batch(client, entries) do
+    body = %{"entries" => entries}
+    result = to_string(Poison.Encoder.encode(body, []))
+    post_url(client, Application.get_env(:elixir_dropbox, :upload_url), "/files/get_thumbnail_batch", result)
+  end
+
+  @doc """
+  Get a preview for a file.
+
+  ## Example
+
+    ElixirDropbox.Files.get_preview client, "/mypdf.pdf"
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview
+  """
   def get_preview(client, path) do
     dropbox_headers = %{
       :path => path
@@ -154,8 +229,32 @@ defmodule ElixirDropbox.Files do
     download_request(client, Application.get_env(:elixir_dropbox, :upload_url), "files/get_preview", [], headers)
   end
 
-  def get_metadata(client, path, include_media_info \\ false) do
-    body = %{"path" => path, "include_media_info" => include_media_info}
+  @doc """
+  Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. Content-Type of the link is determined automatically by the file's mime type.
+
+  ## Example
+
+    ElixirDropbox.Files.get_temporary_link client, "/video.mp4"
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-get_preview
+  """
+  def get_temporary_link(client, path) do
+    body = %{"path" => path}
+    result = to_string(Poison.Encoder.encode(body, []))
+    post(client, "/files/get_temporary_link", result)
+  end
+
+  @doc """
+  Returns the metadata for a file or folder.
+
+  ## Example
+
+    ElixirDropbox.Files.get_metadata client, "/mypdf.pdf"
+
+  More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata
+  """
+  def get_metadata(client, path, include_media_info \\ false, include_deleted \\ false, include_has_explicit_shared_members \\ false) do
+    body = %{"path" => path, "include_media_info" => include_media_info, "include_deleted" => include_deleted, "include_has_explicit_shared_members" => include_has_explicit_shared_members}
     result = to_string(Poison.Encoder.encode(body, []))
     post(client, "/files/get_metadata", result)
    end

lib/files.ex

@@ -0,0 +1,33 @@
+defmodule ElixirDropbox.Files.DeleteBatch do
+ import ElixirDropbox
+
+ @doc """
+ Delete multiple files/folders at once.
+
+ ## Example
+   path_entries = [ %{"path" => "/Temp1"}, %{"path" => "/Temp2" } ]
+   ElixirDropbox.Files.DeleteBatch.delete_batch(client, path_entries)
+
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch
+ """
+ def delete_batch(client, path_entries) do
+   body = %{"entries" => path_entries}
+   result = to_string(Poison.Encoder.encode(body, []))
+   post(client, "/files/delete_batch", result)
+ end
+
+ @doc """
+ Returns the status of an asynchronous job for delete_batch. If success, it returns list of result for each entry.
+
+ ## Example
+
+   ElixirDropbox.Files.DeleteBatch.check(client, "")
+
+ More info at: https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check
+ """
+ def check(client, async_job_id) do
+   body = %{"async_job_id" => async_job_id}
+   result = to_string(Poison.Encoder.encode(body, []))
+   post(client, "/files/delete_batch/check", result)
+ end
+end