brick_ftp 0.8.4 → 1.0.0.beta

data/lib/brick_ftp/restful_api/upload_file.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module BrickFTP
+  module RESTfulAPI
+    # Overview of uploading
+    #
+    # @see https://developers.brickftp.com/#overview-of-uploading Overview of uploading
+    #
+    # ### Uploading files using the REST API is done in 3 stages:
+    #
+    # 1. {https://developers.brickftp.com/#starting-a-new-upload Start a new upload} by sending a request to REST API to indicate intent to upload a file.
+    # 2. {https://developers.brickftp.com/#uploading-the-file-or-file-parts Upload the file} to the URL(s) provided by the REST API, possibly in parts via multiple uploads.
+    # 3. {https://developers.brickftp.com/#completing-an-upload Complete the upload} by notifying the REST API that the file upload has completed.
+    #
+    class UploadFile
+      include Command
+
+      CHUNK_SIZE_RANGE = 5_242_880..5_368_709_120
+
+      # At this point, you are to send a PUT request to the returned upload_uri with the file data,
+      # along with the headers and parameters provided to you from BrickFTP.
+      #
+      # The upload_uri link is signed by BrickFTP and must be used within 15 minutes.
+      # You will receive an HTTP 200 response with no body upon successful upload.
+      #
+      # Should you wish to upload the file in multiple parts (required if the file size exceeds 5 GB)
+      # you will need to request an additional upload URL for the next part.
+      #
+      # @param [String] path Full path of the file or folder. Maximum of 550 characters.
+      # @param [IO] data
+      # @param [Integer, nil] chunk_size the chunk sizes are required to be between 5 MB and 5 GB
+      # @return [BrickFTP::Types::File] File object
+      #
+      def call(path, data, chunk_size: nil)
+        chunk_size = adjust_chunk_size(data, chunk_size)
+        validate_range_of_chunk_size!(chunk_size)
+
+        upload = StartUpload.new(client).call(path)
+        chunk_io = BrickFTP::Utils::ChunkIO.new(data, chunk_size: chunk_size)
+
+        rest = data.size
+        chunk_io.each do |chunk|
+          rest -= client.upload_file(upload.http_method, upload.upload_uri, chunk)
+          break if !chunk_size || rest <= 0
+
+          upload = ContinueUpload.new(client).call(path, ref: upload.ref, part: upload.part_number + 1)
+        end
+        CompleteUpload.new(client).call(path, ref: upload.ref)
+      end
+
+      private
+
+      # To single uploading if chunk_size less than equals data size.
+      def adjust_chunk_size(data, chunk_size)
+        chunk_size && chunk_size >= data.size ? nil : chunk_size
+      end
+
+      def validate_range_of_chunk_size!(chunk_size)
+        raise ArgumentError, 'chunk_size must be between 5MB and 5GB' if chunk_size && !CHUNK_SIZE_RANGE.cover?(chunk_size)
+      end
+    end
+  end
+end

data/lib/brick_ftp/types.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    autoload :User, 'brick_ftp/types/user'
+    autoload :UserAPIKey, 'brick_ftp/types/user_api_key'
+    autoload :UserPublicKey, 'brick_ftp/types/user_public_key'
+    autoload :Group, 'brick_ftp/types/group'
+    autoload :GroupMembership, 'brick_ftp/types/group_membership'
+    autoload :Permission, 'brick_ftp/types/permission'
+    autoload :Notification, 'brick_ftp/types/notification'
+    autoload :History, 'brick_ftp/types/history'
+    autoload :Bundle, 'brick_ftp/types/bundle'
+    autoload :BundleContent, 'brick_ftp/types/bundle_content'
+    autoload :FileInBundle, 'brick_ftp/types/file_in_bundle'
+    autoload :BundleZip, 'brick_ftp/types/bundle_zip'
+    autoload :Behavior, 'brick_ftp/types/behavior'
+    autoload :File, 'brick_ftp/types/file'
+    autoload :FolderContentsCount, 'brick_ftp/types/folder_contents_count'
+    autoload :Upload, 'brick_ftp/types/upload'
+    autoload :SiteUsage, 'brick_ftp/types/site_usage'
+  end
+end

data/lib/brick_ftp/types/behavior.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # ## The behavior object
+    #
+    # @see https://developers.brickftp.com/#the-behavior-object The behavior object
+    #
+    # ATTRIBUTE  | TYPE     | DESCRIPTION
+    # ---------- | -------- | -----------
+    # id         | integer  | Globally unique identifier of each behavior.
+    # 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.
+    #
+    Behavior = Struct.new(
+      'Behavior',
+      :id,
+      :path,
+      :behavior,
+      :value,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/bundle.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # The bundle object
+    #
+    # @see https://developers.brickftp.com/#the-bundle-object The bundle object
+    #
+    # ATTRIBUTE  | TYPE     | DESCRIPTION
+    # ---------- | -------- | -----------
+    # id         | integer  | Globally unique identifier of each bundle.
+    # code       | string   | Unique code string identifier for the bundle.
+    # url        | string   | Public sharing URL for the bundle.
+    # user_id    | integer  | ID of the user that created the bundle.
+    # created_at | datetime | Creation date of the bundle.
+    # 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.
+    #
+    Bundle = Struct.new(
+      'Bundle',
+      :id,
+      :code,
+      :url,
+      :user_id,
+      :created_at,
+      :paths,
+      :expires_at,
+      :username,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/bundle_content.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # An element of bundle contents
+    #
+    # @see https://developers.brickftp.com/#list-bundle-contents List bundle contents
+    #
+    # ATTRIBUTE | TYPE    | DESCRIPTION
+    # --------- | ------- | -----------
+    # path      | string  | undocumented
+    # type      | string  | undocumented
+    # size      | integer | undocumented
+    #
+    BundleContent = Struct.new(
+      'BundleContent',
+      :path,
+      :type,
+      :size,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/bundle_zip.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # @see https://developers.brickftp.com/#download-entire-bundle-as-zip Download entire bundle as ZIP
+    #
+    # ATTRIBUTE    | TYPE     | DESCRIPTION
+    # ------------ | -------- | -----------
+    # download_uri | string   | undocumented
+    #
+    BundleZip = Struct.new(
+      'BundleZip',
+      :download_uri,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/file.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # The file/folder object
+    #
+    # @see https://developers.brickftp.com/#the-file-folder-object The file/folder object
+    #
+    # ATTRIBUTE          | TYPE     | DESCRIPTION
+    # ------------------ | -------- | -----------
+    # id                 | integer  | Globally unique identifier of each file.
+    # path               | string   | Full path of the file or folder. Maximum of 550 characters.
+    # display_name       | string   | Name of the file or folder without path.
+    # type               | enum     | Either `file` or `directory` (meaning folder).
+    # size               | integer  | Size of the file in bytes. Will be 0 for a folder.
+    # mtime              | datetime | Date of the file/folder's last modification.
+    # provided_mtime     | datetime | Client-provided date of the file/folder's last modification.
+    # crc32              | string   | CRC32 for the file, if available.
+    # md5                | string   | MD5 hash for the file, if available.
+    # region             | string   | The geographic region that a file is stored in.
+    # permissions        | string   | Your permissions on the file/folder. Will be one of the following:<br>`p` (list/preview only), `r` (read-only), `w` (write-only), `rw` (read/write), `rwd` (read/write/delete).
+    # download_uri       | string   | URL to download the file, if requested.
+    # subfolders_locked? | integer  | A value of `1` indicates that the Lock-subfolders setting is enabled on a folder.
+    #
+    File = Struct.new(
+      'File',
+      :id,
+      :path,
+      :display_name,
+      :type,
+      :size,
+      :mtime,
+      :provided_mtime,
+      :crc32,
+      :md5,
+      :region,
+      :permissions,
+      :download_uri,
+      :subfolders_locked?,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/file_in_bundle.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # @see https://developers.brickftp.com/#download-one-file-in-a-bundle Download one file in a bundle
+    #
+    # ATTRIBUTE    | TYPE     | DESCRIPTION
+    # ------------ | -------- | -----------
+    # path         | string   | undocumented
+    # type         | string   | undocumented
+    # size         | integer  | undocumented
+    # download_uri | string   | undocumented
+    #
+    FileInBundle = Struct.new(
+      'FileInBundle',
+      :path,
+      :type,
+      :size,
+      :download_uri,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/folder_contents_count.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # @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
+    #
+    # ATTRIBUTE  | TYPE    | DESCRIPTION
+    # ---------- | ------- | -----------
+    # total      | integer | undocumented
+    # files      | integer | undocumented
+    # folders    | integer | undocumented
+    #
+    FolderContentsCount = Struct.new(
+      'FolderContentsCount',
+      :total,
+      :files,
+      :folders,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/group.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # The group object
+    #
+    # @see https://developers.brickftp.com/#the-group-object The group object
+    #
+    # ATTRIBUTE | TYPE                     | DESCRIPTION
+    # --------- | ------------------------ | -----------
+    # id        | integer                  | Globally unique identifier of each group. Each group is given an ID automatically upon creation.
+    # 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.
+    # usernames | string                   | Usernames of the users that are in this group.
+    # admin_ids | comma-separated integers | IDs of the users that are in this group and are administrators of this group.
+    #
+    Group = Struct.new(
+      'Group',
+      :id,
+      :name,
+      :notes,
+      :user_ids,
+      :usernames,
+      :admin_ids,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/group_membership.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # membership object
+    #
+    # @see https://developers.brickftp.com/#add-a-member membership object
+    #
+    # ATTRIBUTE | TYPE    | DESCRIPTION
+    # --------- | ------- | -----------
+    # id        | integer | Globally unique identifier for the membership.
+    # group_id  | integer | ID of the group the membership is associated with.
+    # user_id   | integer | ID of the user the membership is associated with.
+    # admin     | boolean | Indicates whether the user is an administrator of the group.
+    #
+    GroupMembership = Struct.new(
+      'GroupMembership',
+      :id,
+      :group_id,
+      :user_id,
+      :admin,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/history.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # The notification object
+    #
+    # @see https://developers.brickftp.com/#the-notification-object The notification object
+    #
+    # ATTRIBUTE     | TYPE     | DESCRIPTION
+    # ------------- | -------- | -----------
+    # id            | integer  | Globally unique identifier of each history entry.
+    # when          | datetime | Date of the history entry.
+    # user_id       | integer  | ID of the user associated with the history entry.
+    # username      | string   | Username of the user associated with the history entry.
+    # action        | string   | Type of action that occurred. Will be one of the following: <br>`create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_destroy`, `group_create`, `group_destroy`, `permission_create`, `permission_destroy`.
+    # failure_type  | string   | Type of failure that occurred, if any.
+    # path          | string   | Path of the file or folder associated with the history entry.
+    # source        | string   | Source path associated with the history entry.
+    # destination   | string   | Destination path associated with the history entry.
+    # targets       | object   | Object containing the target object(s) for `user_create`, `user_destroy`, `group_create`, `group_destroy`, `permission_create`, and `permission_destroy` actions. <br>A `user` target will include an `id` and `username`. A `group` target will include an `id` and `name`. A `permission` target will include an `id`, `permission`, and a `recursive` parameter.
+    # ip            | string   | IP address associated with the history entry.
+    # interface     | string   | Interface associated with the history entry. Will be one of the following: web, ftp, robot, jsapi, restapi, sftp, dav.
+    #
+    History = Struct.new(
+      'History',
+      :id,
+      :when,
+      :user_id,
+      :username,
+      :action,
+      :failure_type,
+      :path,
+      :source,
+      :destination,
+      :targets,
+      :ip,
+      :interface,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/notification.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # The notification object
+    #
+    # @see https://developers.brickftp.com/#the-notification-object The notification object
+    #
+    # ATTRIBUTE     | TYPE    | DESCRIPTION
+    # ------------- | ------- | -----------
+    # id            | integer | Globally unique identifier of each notification. Each notification is given an ID automatically upon creation.
+    # 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.
+    # unsubscribed  | boolean | If true, the user has unsubscribed from receiving this notification. This property is read-only.
+    #
+    Notification = Struct.new(
+      'Notification',
+      :id,
+      :path,
+      :user_id,
+      :username,
+      :send_interval,
+      :unsubscribed,
+      keyword_init: true
+    )
+  end
+end

data/lib/brick_ftp/types/permission.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module Types
+    using BrickFTP::CoreExt::Struct
+
+    # The permission object
+    #
+    # @see https://developers.brickftp.com/#the-permission-object The permission object
+    #
+    # ATTRIBUTE  | TYPE    | DESCRIPTION
+    # ---------- | ------- | -----------
+    # id         | integer | Globally unique identifier of each permission. Each permission is given an ID automatically upon creation.
+    # 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.
+    # group_name | string  | Name of the group, if group_id is set. This property is read-only.
+    # 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.
+    #
+    Permission = Struct.new(
+      'Permission',
+      :id,
+      :user_id,
+      :username,
+      :group_id,
+      :group_name,
+      :path,
+      :permission,
+      :recursive,
+      keyword_init: true
+    )
+  end
+end