brick_ftp 0.8.4 → 1.0.0.beta

data/lib/brick_ftp/restful_api/create_public_key.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a public key
+    #
+    # @see https://developers.brickftp.com/#create-a-public-key Create a public key
+    #
+    # ### Params
+    #
+    # PARAMETER  | TYPE    | DESCRIPTION
+    # ---------- | ------- | -----------
+    # title      | string  | Title to identify the public key. For your reference. Maximum of 50 characters.
+    # public_key | string  | The public key itself. This property is write-only. It cannot be retrieved via the API.
+    #
+    class CreatePublicKey
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreatePublicKeyParams',
+        :title,
+        :public_key,
+        keyword_init: true
+      )
+
+      # Creates a new public 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::CreatePublicKey::Params] params parameters for creating an Public key
+      # @return [BrickFTP::Types::UserPublicKey] User's Public key
+      #
+      def call(id, params)
+        res = client.post("/api/rest/v1/users/#{id}/public_keys.json", params.to_h.compact)
+
+        BrickFTP::Types::UserPublicKey.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_user.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a user
+    #
+    # @see https://developers.brickftp.com/#create-a-user Create a user
+    #
+    # ### Params
+    #
+    # PARAMETER               | TYPE                     | DESCRIPTION
+    # ----------------------- | ------------------------ | -----------
+    # username                | string                   | Username for the user. This is how the user will be displayed on the site. Maximum of 50 characters.
+    # authentication_method   | enum                     | Authentication method for this user. Can be one of the following: password, ldap, or oauth_google. Default is password.
+    # password                | string                   | Password for the user. This property is write-only. It cannot be retrieved via the API.
+    # password_confirmation   | string                   | Confirms the new password provided in the password field. This field is optional but will be validated if provided.
+    # authenticate_until      | datetime                 | If set, the user will be blocked from logging in after this date.
+    # name                    | string                   | Real name of the user. For your reference. Maximum of 50 characters.
+    # email                   | string                   | E-Mail address of the user. 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.
+    # group_ids               | comma-separated integers | IDs of the Groups that this user is in.
+    # ftp_permission          | boolean                  | Allow user access via FTP/FTPS (port 21 or 990) interface. Default is true.
+    # sftp_permission         | boolean                  | Allow user access via SFTP (port 22) interface. Default is true.
+    # dav_permission          | boolean                  | Allow user access via WebDAV (port 443) interface. Default is true.
+    # restapi_permission      | boolean                  | Allow user access the REST API, via HTTP/HTTPS (port 80 or 443), and the desktop application. Default is true.
+    # attachments_permission  | boolean                  | Allow user to use Sharing tab in web interface to share files with anonymous users via a unique URL. Default is false.
+    # self_managed            | boolean                  | Allow user to change their password and user information via the web interface. Default is true.
+    # require_password_change | boolean                  | Require user to change their password at their next login. Note: requires restapi_permission to be true, as password changes can only occur via the web interface. Default is false.
+    # allowed_ips             | text                     | List allowed IPs, one per line. You may specify a range in CIDR format, such as 192.168.1.0/27. Leave blank to allow all IPs. If you are also restricting IP addresses on the Site tab, users matching in either place will be allowed to log in.
+    # user_root               | string                   | Folder to show as the root when this user logs in via the FTP interface. Make sure this folder exists, as it will not be automatically created. Does not apply to the web interface! This should not contain a leading slash, but must contain a trailing slash. Example: Users/jenny/. Limit of 250 characters.
+    # time_zone               | string                   | File modification times will be displayed in this time zone. Default is Eastern Time (US & Canada).
+    # language                | string                   | The language that BrickFTP will be displayed in, if the translation is available. Leave as default (null) to auto-detect or use the site setting.
+    # grant_permission        | enum                     | Value must be set to full, read, write, preview, read+write, or preview+write. The user will be granted that permission on their FTP root folder as defined by the user_root. This property is write-only. It cannot be retrieved via the User resource of the REST API, though may be obtained with the Permissions resource of the REST API.
+    # ssl_required            | enum                     | Whether or not SSL encryption is required on all connections for this user. Can be one of the following: use_system_setting, always_require, or never_require. Default is use_system_setting.
+    # site_admin              | boolean                  | If set to true, this user will be treated as a site-wide administrator. Default is false.
+    # receive_admin_alerts    | boolean                  | Enable this user to receive alerts sent to site administrators. This property will only be accepted/returned if site_admin is true. Default is false.
+    # subscribe_to_newsletter | boolean                  | Add this user to the BrickFTP newsletter and our mailing list for notices about product updates. This property will only be accepted/returned if site_admin is true. Default is false.
+    # can_create_new_users    | boolean                  | If true, this user will be able to create other users within groups where they have administrator privileges. Default is false.
+    # admin_group_ids         | comma-separated integers | IDs of the Groups that this user is an administrator of.
+    #
+    class CreateUser
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateUserParams',
+        :username,
+        :authentication_method,
+        :password,
+        :password_confirmation,
+        :authenticate_until,
+        :name,
+        :email,
+        :notes,
+        :group_ids,
+        :ftp_permission,
+        :sftp_permission,
+        :dav_permission,
+        :restapi_permission,
+        :attachments_permission,
+        :self_managed,
+        :require_password_change,
+        :allowed_ips,
+        :user_root,
+        :time_zone,
+        :language,
+        :grant_permission,
+        :ssl_required,
+        :site_admin,
+        :receive_admin_alerts,
+        :subscribe_to_newsletter,
+        :can_create_new_users,
+        :admin_group_ids,
+        keyword_init: true
+      )
+
+      # Creates a new user on the current site.
+      #
+      # @param [BrickFTP::RESTfulAPI::CreateUser::Params] params parameters for create a user
+      # @return [BrickFTP::Types::User] create User
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/users.json', params.to_h.compact)
+
+        BrickFTP::Types::User.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/create_user_in_group.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Create a user in a group
+    #
+    # @see https://developers.brickftp.com/#create-a-user-in-a-groupCreate a user in a group
+    #
+    # ### Params
+    #
+    # PARAMETER               | TYPE                     | DESCRIPTION
+    # ----------------------- | ------------------------ | -----------
+    # username                | string                   | Username for the user. This is how the user will be displayed on the site. Maximum of 50 characters.
+    # password                | string                   | Password for the user. This property is write-only. It cannot be retrieved via the API.
+    # authenticate_until      | datetime                 | If set, the user will be blocked from logging in after this date.
+    # name                    | string                   | Real name of the user. For your reference. Maximum of 50 characters.
+    # email                   | string                   | E-Mail address of the user. 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.
+    # group_ids               | comma-separated integers | IDs of the Groups that this user is in.
+    # require_password_change | boolean                  | Require user to change their password at their next login. Note: requires restapi_permission to be true, as password changes can only occur via the web interface. Default is false.
+    # user_root               | string                   | Folder to show as the root when this user logs in via the FTP interface. Make sure this folder exists, as it will not be automatically created. Does not apply to the web interface! This should not contain a leading slash, but must contain a trailing slash. Example: Users/jenny/. Limit of 250 characters.
+    # time_zone               | string                   | File modification times will be displayed in this time zone. Default is Eastern Time (US & Canada).
+    # language                | string                   | The language that BrickFTP will be displayed in, if the translation is available. Leave as default (null) to auto-detect or use the site setting.
+    #
+    class CreateUserInGroup
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CreateUserInGroupParams',
+        :username,
+        :password,
+        :authenticate_until,
+        :name,
+        :email,
+        :notes,
+        :group_ids,
+        :require_password_change,
+        :user_root,
+        :time_zone,
+        :language,
+        keyword_init: true
+      )
+
+      # Creates a new user within a specified group.
+      #
+      # @param [Integer] id Globally unique identifier of each group.
+      #   Each group is given an ID automatically upon creation.
+      # @param [BrickFTP::RESTfulAPI::CreateUserInGroup::Params] params parameters
+      # @return [BrickFTP::Types::User] created User
+      #
+      def call(id, params)
+        res = client.post("/api/rest/v1/groups/#{id}/users.json", user: params.to_h.compact)
+
+        BrickFTP::Types::User.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_api_key.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete an API key
+    #
+    # @see https://developers.brickftp.com/#delete-an-api-key Delete an API key
+    #
+    class DeleteAPIKey
+      include Command
+
+      # Deletes the specified API key.
+      #
+      # @param [Integer] id Globally unique identifier of each user API key.
+      #   Each user API key is given an ID automatically upon creation.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/api_keys/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_behavior.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a behavior
+    #
+    # @see https://developers.brickftp.com/#delete-a-behavior Delete a behavior
+    #
+    class DeleteBehavior
+      include Command
+
+      # Deletes a behavior.
+      #
+      # @param [Integer] id Globally unique identifier of each behavior.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/behaviors/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_bundle.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a bundle
+    #
+    # @see https://developers.brickftp.com/#delete-a-bundle Delete a bundle
+    #
+    class DeleteBundle
+      include Command
+
+      # Deletes the specified bundle.
+      #
+      # @param [Integer] id Globally unique identifier of each bundle.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/bundles/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_folder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a file or folder
+    #
+    # @see https://developers.brickftp.com/#delete-a-file-or-folder Delete a file or folder
+    #
+    class DeleteFolder
+      include Command
+
+      # Deletes a file or folder.
+      #
+      # Note that this operation works for both files and folders, but normally it will only work on empty folders.
+      # If you want to recursively delete a folder and all its contents, send the request with a `Depth` header
+      # with the value set to `infinity`.
+      #
+      # @param [String] path Full path of the file or folder. Maximum of 550 characters.
+      # @param [Boolean] recursive
+      #
+      def call(path, recursive: false)
+        headers = {}
+        headers = { 'Depth' => 'infinity' } if recursive
+
+        client.delete("/api/rest/v1/files/#{ERB::Util.url_encode(path)}", headers)
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_group.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a group
+    #
+    # @see https://developers.brickftp.com/#delete-a-group Delete a group
+    #
+    class DeleteGroup
+      include Command
+
+      # Deletes the specified group.
+      #
+      # @param [Integer] id Globally unique identifier of each group.
+      #   Each group is given an ID automatically upon creation.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/groups/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_notification.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a notification
+    #
+    # @see https://developers.brickftp.com/#delete-a-notification Delete a notification
+    #
+    class DeleteNotification
+      include Command
+
+      # Deletes the specified notification.
+      #
+      # @param [Integer] id Globally unique identifier of each notification.
+      #   Each notification is given an ID automatically upon creation.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/notifications/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_permission.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a permission
+    #
+    # @see https://developers.brickftp.com/#delete-a-permission Delete a permission
+    #
+    class DeletePermission
+      include Command
+
+      # Deletes the specified group.
+      #
+      # @param [Integer] id Globally unique identifier of each permission.
+      #   Each permission is given an ID automatically upon creation.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/permissions/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_public_key.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a public key
+    #
+    # @see https://developers.brickftp.com/#delete-a-public-key Delete a public key
+    #
+    class DeletePublicKey
+      include Command
+
+      # Deletes the specified public key.
+      #
+      # @param [Integer] id Globally unique identifier of each public key.
+      #   Each public key is given an ID automatically upon creation.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/public_keys/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/delete_user.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Delete a user
+    #
+    # @see https://developers.brickftp.com/#delete-a-user Delete a user
+    #
+    class DeleteUser
+      include Command
+
+      # Deletes the specified user.
+      #
+      # For additional security, this method requires reauthentication when updating a password unless an API key is used.
+      #
+      # @param [Integer] id Globally unique identifier of each user.
+      #   Each user is given an ID automatically upon creation.
+      #
+      def call(id)
+        client.delete("/api/rest/v1/users/#{id}.json")
+        true
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/download_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Download a file
+    #
+    # @see https://developers.brickftp.com/#download-a-file Download a file
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE     | DESCRIPTION
+    # --------- | -------- | -----------
+    # action    | string   | Optionally set to `stat` to have the `download_uri` field omitted in the response and no download action logged.
+    #
+    class DownloadFile
+      include Command
+
+      # Provides a download URL that will enable you to download a file.
+      #
+      # The download URL is a direct URL to Amazon S3 that has been signed by BrickFTP to provide temporary
+      # access to the file. The download links are valid for 3 minutes.
+      #
+      # By default this request assumes that the file will be downloaded, and therefore a download action is
+      # logged for the user that is logged into the REST API session. If downloading the file is not desired,
+      # but rather one is just looking at the information associated with the file such as the MD5 checksum or
+      # file size, then the action query parameter can be passed in on the URL with the value of stat.
+      # This causes the download_uri field to be omitted in the response and no download action to be logged.
+      #
+      # @param [String] path Full path of the file or folder. Maximum of 550 characters.
+      # @param [Boolean] stat Optionally set to stat to have the `download_uri` field
+      #   omitted in the response and no download action logged.
+      # @return [BrickFTP::Types::File] File
+      #
+      def call(path, stat: false)
+        endpoint = "/api/rest/v1/files/#{ERB::Util.url_encode(path)}"
+        endpoint = "#{endpoint}?action=stat" if stat
+        res = client.get(endpoint)
+        return nil if !res || res.empty?
+
+        BrickFTP::Types::File.new(res.symbolize_keys)
+      end
+    end
+  end
+end