brick_ftp 0.8.4 → 1.0.0.beta

data/lib/brick_ftp/restful_api/continue_upload.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Requesting additional upload URLs
+    #
+    # @see https://developers.brickftp.com/#requesting-additional-upload-urls Requesting additional upload URLs
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE    | DESCRIPTION
+    # --------- | ------- | -----------
+    # ref       | string  | Unique identifier to reference this file upload. This identifier is needed for subsequent requests to the REST API to complete the upload or request more upload URLs.
+    # part      | integer | part number of multi part uploads.
+    #
+    class ContinueUpload
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'ContinueUploadParams',
+        :ref,
+        :part,
+        keyword_init: true
+      )
+
+      # Once an upload has been opened and before it is completed,
+      # additional upload URLs can be requested from the REST API.
+      #
+      # Send a POST request to `/files/PATH_AND_FILENAME.EXT` with parameter `action` set to `put`, parameter `ref` set to
+      # the reference ID returned at the start of the upload, and parameter `part` set to the part number the upload URL
+      # should refer to. The part number can be the same as one previously used if a new URL is required, either
+      # because the part is to be re-uploaded or because a prior upload attempt failed and the prior URL's signature
+      # has expired.
+      #
+      # @param [String] path Full path of the file or folder. Maximum of 550 characters.
+      # @param [BrickFTP::RESTfulAPI::ContinueUpload::Params] params parameters
+      # @return [BrickFTP::Types::Upload] Upload object
+      #
+      def call(path, params)
+        res = client.post("/api/rest/v1/files/#{ERB::Util.url_encode(path)}", params.to_h.compact.merge(action: 'put'))
+
+        BrickFTP::Types::Upload.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/copy_folder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Copy a file or folder
+    #
+    # @see https://developers.brickftp.com/#copy-a-file-or-folder Copy a file or folder
+    #
+    # ### Params
+    #
+    # PARAMETER        | TYPE   | DESCRIPTION
+    # ---------------- | ------ | -----------
+    # copy-destination | string | Full path of the file or folder. Maximum of 550 characters.
+    # structure        | any    | Optionally, provide the parameter `structure` and set it to any value to only copy the folder structure without copying any files.
+    #
+    class CopyFolder
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CopyFolderParams',
+        :'copy-destination',
+        :structure,
+        keyword_init: true
+      )
+
+      # Copies a file or folder to the destination provided in the
+      # `copy-destination` parameter in the request body.
+      # Note that a copy will fail if the destination already exists.
+      #
+      # Optionally, provide the parameter `structure` and set it to any value
+      # to only copy the folder structure without copying any files.
+      #
+      # @param [String] path Full path of the file or folder. Maximum of 550 characters.
+      # @param [BrickFTP::RESTfulAPI::CopyFolder::Params] params parameters
+      #
+      def call(path, params)
+        client.post("/api/rest/v1/files/#{ERB::Util.url_encode(path)}", params.to_h.compact)
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/count_folder_contents.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Count folder contents
+    #
+    # @see https://developers.brickftp.com/#count-folder-contents-recursively Count folder contents recursively
+    # @see https://developers.brickftp.com/#count-folder-contents-non-recursively Count folder contents non-recursively
+    #
+    class CountFolderContents
+      include Command
+
+      # Returns number of files and folders.
+      #
+      # - Returns the combined total number of files and subfolders in a given folder recursively.
+      # - Returns the number of files and folders, separately, located inside a given folder (non-recursively).
+      #
+      # @param [String] path
+      # @param [Boolean] recursive
+      # @return [BrickFTP::Types::FolderContentsCount] count
+      #
+      def call(path, recursive: false)
+        action = recursive ? 'count' : 'count_nrs'
+        res = client.get("/api/rest/v1/folders/#{ERB::Util.url_encode(path)}?action=#{action}")
+
+        if recursive
+          BrickFTP::Types::FolderContentsCount.new(total: res['data']['count'])
+        else
+          BrickFTP::Types::FolderContentsCount.new(res['data']['count'].symbolize_keys)
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/count_users.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Count users
+    #
+    # @see https://developers.brickftp.com/#count-users Count users
+    #
+    class CountUsers
+      include Command
+
+      # Returns a count of the number of users for the current site.
+      #
+      # @return [Integer] count
+      #
+      def call
+        res = client.get('/api/rest/v1/users.json?action=count')
+        res['data']['count']
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_api_key.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create an API key
+    #
+    # @see https://developers.brickftp.com/#create-an-api-key Create an API key
+    #
+    # ### Params
+    #
+    # PARAMETER      | TYPE     | DESCRIPTION
+    # -------------- | -------- | -----------
+    # name           | string   | Name to identify the user API key. For your reference. Maximum of 100 characters.
+    # permission_set | string   | The permission set for the user API key. Can be desktop_app or full.
+    # platform       | string   | The platform for the user API key. Can be win32, macos, linux, or none. Applies only to API keys with a permission_set of desktop_app.
+    # expires_at     | datetime | The date that this API key is valid through.
+    #
+    class CreateAPIKey
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateAPIKeyParams',
+        :name,
+        :permission_set,
+        :platform,
+        :expires_at,
+        keyword_init: true
+      )
+
+      # Creates a new API key for a user on the current site.
+      #
+      # @param [Integer] id Globally unique identifier of each user.
+      #   Each user is given an ID automatically upon creation.
+      # @param [BrickFTP::RESTfulAPI::CreateAPIKey::Params] params parameters for creating an API key
+      # @return [BrickFTP::Types::UserAPIKey] User's API key
+      #
+      def call(id, params)
+        res = client.post("/api/rest/v1/users/#{id}/api_keys.json", params.to_h.compact)
+
+        BrickFTP::Types::UserAPIKey.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_behavior.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a behavior
+    #
+    # @see https://developers.brickftp.com/#create-a-behavior Create a behavior
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE   | DESCRIPTION
+    # --------- | ------ | -----------
+    # path      | string | Folder path for behaviors. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    # behavior  | string | The behavior type. Can be one of the following: webhook, file_expiration, auto_encrypt, lock_subfolders.
+    # value     | array  | Array of values associated with the behavior.
+    #
+    class CreateBehavior
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateBehaviorParams',
+        :path,
+        :behavior,
+        :value,
+        keyword_init: true
+      )
+
+      # Creates a new behavior.
+      #
+      # @param [BrickFTP::RESTfulAPI::CreateBehavior::Params] params parameters
+      # @return [BrickFTP::Types::Behavior] Behavior
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/behaviors.json', params.to_h.compact)
+
+        BrickFTP::Types::Behavior.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_bundle.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a bundle
+    #
+    # @see https://developers.brickftp.com/#create-a-bundle Create a bundle
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE   | DESCRIPTION
+    # --------- | ------ | -----------
+    # paths     | array  | List of the paths associated with the bundle.
+    # password  | string | Optional password to password-protect the bundle. This property is write-only. It cannot be retrieved via the API.
+    #
+    class CreateBundle
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateBundleParams',
+        :paths,
+        :password,
+        keyword_init: true
+      )
+
+      # Creates a new group on the current site.
+      #
+      # @param [BrickFTP::RESTfulAPI::CreateBundle::Params] params parameters
+      # @return [BrickFTP::Types::Bundle] Bundle
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/bundles.json', params.to_h.compact)
+
+        BrickFTP::Types::Bundle.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_folder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a folder
+    #
+    # @see https://developers.brickftp.com/#create-a-folder Create a folder
+    #
+    class CreateFolder
+      include Command
+
+      # Creates a folder.
+      #
+      # @param [String] path
+      # @return [BrickFTP::Types::Folder] Folders
+      #
+      def call(path)
+        client.post("/api/rest/v1/folders/#{ERB::Util.url_encode(path)}")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_group.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a group
+    #
+    # @see https://developers.brickftp.com/#create-a-group Create a group
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE                     | DESCRIPTION
+    # --------- | ------------------------ | -----------
+    # name      | string                   | Name of the group. This is how the group will be displayed on the site. Maximum of 50 characters.
+    # notes     | text                     | You may use this property to store any additional information you require. There are no restrictions on its formatting.
+    # user_ids  | comma-separated integers | IDs of the users that are in this group.
+    #
+    class CreateGroup
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateGroupParams',
+        :name,
+        :notes,
+        :user_ids,
+        keyword_init: true
+      )
+
+      # Creates a new group on the current site.
+      #
+      # @param [BrickFTP::RESTfulAPI::CreateGroup::Params] params parameters for creating a Group
+      # @return [BrickFTP::Types::Group] created Group
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/groups.json', params.to_h.compact)
+
+        BrickFTP::Types::Group.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_notification.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a notification
+    #
+    # @see https://developers.brickftp.com/#create-a-notification Create a notification
+    #
+    # ### Params
+    #
+    # PARAMETER     | TYPE    | DESCRIPTION
+    # ------------- | ------- | -----------
+    # path          | string  | Folder path for notifications. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    # user_id       | integer | Unique identifier for the user being notified. Each user is given an ID automatically upon creation. You can look up user IDs by using the User resource of this REST API.
+    # username      | string  | Username for the user given by user_id. If this value is set during creation and user_id is not set, the user_id is looked up from the username and set. Maximum of 50 characters.
+    # send_interval | string  | The send interval for notifications. Can be one of the following: five_minutes (default), fifteen_minutes, hourly, daily.
+    #
+    class CreateNotification
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateNotificationParams',
+        :path,
+        :user_id,
+        :username,
+        :send_interval,
+        keyword_init: true
+      )
+
+      # Creates a new notification on the current site.
+      #
+      # @param [BrickFTP::RESTfulAPI::CreateNotification::Params] params parameters
+      # @return [BrickFTP::Types::Notification] Notification
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/notifications.json', params.to_h.compact)
+
+        BrickFTP::Types::Notification.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_permission.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a permission
+    #
+    # @see https://developers.brickftp.com/#create-a-permission Create a permission
+    #
+    # ### Params
+    #
+    # PARAMETER  | TYPE    | DESCRIPTION
+    # ---------- | ------- | -----------
+    # user_id    | integer | Unique identifier for the user being granted a permission. Each user is given an ID automatically upon creation. The user_id and group_id fields cannot both be set.
+    # username   | string  | Username for the user, if user_id is set. If this value is set during creation and user_id is not set, the user_id is looked up from the username and set. Maximum of 50 characters.
+    # group_id   | integer | Unique identifier for the group being granted a permission. Each group is given an ID automatically upon creation. The user_id and group_id fields cannot both be set.
+    # path       | string  | Folder path for the permission to apply to. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    # permission | enum    | Value must be set to full, readonly, writeonly, previewonly, or history, depending on the type of access to be granted by the Permission.
+    # recursive  | boolean | If set to false, the permission will be non-recursive, and will not apply to subfolders of the folder specified by the path property. Default is true.
+    #
+    class CreatePermission
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreatePermissionParams',
+        :user_id,
+        :username,
+        :group_id,
+        :path,
+        :permission,
+        :recursive,
+        keyword_init: true
+      )
+
+      # Creates a new permission record.
+      #
+      # @param [BrickFTP::RESTfulAPI::CreatePermission::Params] params parameters
+      # @return [BrickFTP::Types::Permission] Permissions
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/permissions.json', params.to_h.compact)
+
+        BrickFTP::Types::Permission.new(res.symbolize_keys)
+      end
+    end
+  end
+end