brick_ftp 0.8.4 → 1.0.0.beta

data/lib/brick_ftp/restful_api/get_api_key.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Show an API key
+    #
+    # @see https://developers.brickftp.com/#show-an-api-key Show an API key
+    #
+    class GetAPIKey
+      include Command
+
+      # Returns a single API key.
+      #
+      # @param [Integer] id Globally unique identifier of each user API key.
+      #   Each user API key is given an ID automatically upon creation.
+      # @return [BrickFTP::Types::UserAPIKey] User's API key
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/api_keys/#{id}.json")
+
+        BrickFTP::Types::UserAPIKey.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_behavior.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Show a behavior
+    #
+    # @see https://developers.brickftp.com/#show-a-behavior Show a behavior
+    #
+    class GetBehavior
+      include Command
+
+      # Returns a single behavior.
+      #
+      # @param [Integer] id Globally unique identifier of each behavior.
+      # @return [BrickFTP::Types::Behavior, nil] found Behavior or nil
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/behaviors/#{id}.json")
+        return nil if !res || res.empty?
+
+        BrickFTP::Types::Behavior.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_bundle.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Show a bundle
+    #
+    # @see https://developers.brickftp.com/#show-a-bundle Show a bundle
+    #
+    class GetBundle
+      include Command
+
+      # Returns a single bundle.
+      #
+      # @param [Integer] id Globally unique identifier of each bundle.
+      # @return [BrickFTP::Types::Bundle] Bundle
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/bundles/#{id}.json")
+        return nil if !res || res.empty?
+
+        BrickFTP::Types::Bundle.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_bundle_zip.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Download entire bundle as ZIP
+    #
+    # @see https://developers.brickftp.com/#download-entire-bundle-as-zip Download entire bundle as ZIP
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE   | DESCRIPTION
+    # --------- | ------ | -----------
+    # code,     | string | Unique code string identifier for the bundle.
+    # password  | string | Optional password to password-protect the bundle. This property is write-only. It cannot be retrieved via the API.
+    #
+    class GetBundleZip
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'GetBundleZipParams',
+        :code,
+        :password,
+        keyword_init: true
+      )
+
+      # Provides a download URL that will enable you to download all the files in a bundle as a single ZIP.
+      #
+      # The download URLs can be downloaded using an HTTP GET to the same hostname providing the download_uri
+      # as the URL path. This will be routed by our frontend proxies to our ZIP server that will stream the ZIP.
+      # The ZIP download link is valid for 3 minutes.
+      #
+      # The password parameter is required only for bundles that are password-protected.
+      # If a bundle is password-protected and the password is missing or incorrect, an error message will
+      # specify that the correct password is required.
+      #
+      # @param [BrickFTP::RESTfulAPI::GetFileInBundle::Params] params parameters
+      # @return [BrickFTP::Types::BundleZip] BundleZip
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/bundles/zip.json', params.to_h.compact)
+
+        BrickFTP::Types::BundleZip.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_file_in_bundle.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Download one file in a bundle
+    #
+    # @see https://developers.brickftp.com/#download-one-file-in-a-bundle Download one file in a bundle
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE   | DESCRIPTION
+    # --------- | ------ | -----------
+    # code      | string | Unique code string identifier for the bundle.
+    # path      | string |
+    # password  | string | Optional password to password-protect the bundle. This property is write-only. It cannot be retrieved via the API.
+    #
+    class GetFileInBundle
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'GetFileInBundleParams',
+        :code,
+        :path,
+        :password,
+        keyword_init: true
+      )
+
+      # Provides a download URL to download a single file in the bundle.
+      #
+      # 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. For details on the attributes in the response body from this
+      # endpoint, please see The file object.
+      #
+      # The password parameter is required only for bundles that are password-protected. If a bundle is password-protected
+      # and the password is missing or incorrect, an error message will specify that the correct password is required.
+      #
+      # @param [BrickFTP::RESTfulAPI::GetFileInBundle::Params] params parameters
+      # @return [BrickFTP::Types::FileInBundle] FileInBundle
+      #
+      def call(params)
+        res = client.post('/api/rest/v1/bundles/download.json', params.to_h.compact)
+
+        BrickFTP::Types::FileInBundle.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_folder_size.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Get folder size
+    #
+    # @see https://developers.brickftp.com/#get-folder-size Get folder size
+    #
+    class GetFolderSize
+      include Command
+
+      # Returns the size (in bytes) of the specified folder, recursively.
+      #
+      # @param [String] path
+      # @return [Integer]
+      #
+      def call(path)
+        res = client.get("/api/rest/v1/folders/#{ERB::Util.url_encode(path)}?action=size")
+        res['data']['size']
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_group.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Show a group
+    #
+    # @see https://developers.brickftp.com/#show-a-group Show a group
+    #
+    class GetGroup
+      include Command
+
+      # Returns a single group.
+      #
+      # @param [Integer] id Globally unique identifier of each group.
+      #   Each group is given an ID automatically upon creation.
+      # @return [BrickFTP::Types::Group, nil] found Group or nil
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/groups/#{id}.json")
+        return nil if !res || res.empty?
+
+        BrickFTP::Types::Group.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_public_key.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Show a public key
+    #
+    # @see https://developers.brickftp.com/#show-a-public-key Show a public key
+    #
+    class GetPublicKey
+      include Command
+
+      # Returns a single public key.
+      #
+      # @param [Integer] id Globally unique identifier of each public key.
+      #   Each public key is given an ID automatically upon creation.
+      # @return [BrickFTP::Types::UserPublicKey] User's Public key
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/public_keys/#{id}.json")
+
+        BrickFTP::Types::UserPublicKey.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_site_usage.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    class GetSiteUsage
+      include Command
+
+      # Returns site usage
+      #
+      # @return [BrickFTP::Types::SiteUsage] site usage
+      #
+      def call
+        res = client.get('/api/rest/v1/site/usage.json')
+
+        BrickFTP::Types::SiteUsage.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/get_user.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Show a user
+    #
+    # @see https://developers.brickftp.com/#show-a-user Show a user
+    #
+    class GetUser
+      include Command
+
+      # Returns a single user.
+      #
+      # @param [Integer] id Globally unique identifier of each user.
+      #   Each user is given an ID automatically upon creation.
+      # @return [BrickFTP::Types::User, nil] found User or nil
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/users/#{id}.json")
+        return nil if !res || res.empty?
+
+        BrickFTP::Types::User.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/list_api_keys.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # List API keys
+    #
+    # @see https://developers.brickftp.com/#list-api-keys List API keys
+    #
+    class ListAPIKeys
+      include Command
+
+      # Returns a list of all API keys 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.
+      # @return [Array<BrickFTP::Types::UserAPIKey>] User's API keys
+      #
+      def call(id)
+        res = client.get("/api/rest/v1/users/#{id}/api_keys.json")
+
+        res.map { |i| BrickFTP::Types::UserAPIKey.new(i.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/list_behaviors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # List all behaviors
+    #
+    # @see https://developers.brickftp.com/#list-all-behaviors List all behaviors
+    #
+    class ListBehaviors
+      include Command
+
+      # Returns a list of all behaviors on the current site.
+      #
+      # @return [Array<BrickFTP::Types::Behavior>] Behaviors
+      #
+      def call
+        res = client.get('/api/rest/v1/behaviors.json')
+
+        res.map { |i| BrickFTP::Types::Behavior.new(i.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/list_bundle_contents.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # List bundle contents
+    #
+    # @see https://developers.brickftp.com/#list-bundle-contents List bundle contents
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE   | DESCRIPTION
+    # --------- | ------ | -----------
+    # code      | string | Unique code string identifier for the bundle.
+    # password  | string | Optional password to password-protect the bundle. This property is write-only. It cannot be retrieved via the API.
+    #
+    class ListBundleContents
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'ListBundleContentsParams',
+        :code,
+        :password,
+        keyword_init: true
+      )
+
+      # This unauthenticated (public) endpoint lists the contents of a bundle.
+      #
+      # When no path is specified, the contents of the root of the bundle will be listed. The contents of a subfolder
+      # can be listed by providing its path in the URL after /contents, for example: /bundles/contents/cloud/images.
+      # Alternatively, you can provide path as a parameter in the request body instead of in the URL.
+      #
+      # This endpoint only reveals the public part of the file paths (i.e. relative to the root of the bundle).
+      # To view the full path of included files, use the authenticated Show Bundle endpoint above.
+      #
+      # The password parameter is required only for bundles that are password-protected. If a bundle is password-protected
+      # and the password is missing or incorrect, an error message will specify that the correct password is required.
+      #
+      # @param [String, nil] path
+      # @param [BrickFTP::RESTfulAPI::ListBundleContents::Params] params parameters
+      # @return [Array<BrickFTP::Types::BundleContent>] BundleContent
+      #
+      def call(params, path: nil)
+        endpoint = if path
+                     "/api/rest/v1/bundles/contents/#{ERB::Util.url_encode(path)}"
+                   else
+                     '/api/rest/v1/bundles/contents.json'
+                   end
+        res = client.post(endpoint, params.to_h.compact)
+
+        res.map { |i| BrickFTP::Types::BundleContent.new(i.symbolize_keys) }
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/list_bundles.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # List all bundles
+    #
+    # @see https://developers.brickftp.com/#list-all-bundles List all bundles
+    #
+    class ListBundles
+      include Command
+
+      # Returns a list of all bundles on the current site.
+      #
+      # @return [Array<BrickFTP::Types::Bundle>] Bundle
+      #
+      def call
+        res = client.get('/api/rest/v1/bundles.json')
+
+        res.map { |i| BrickFTP::Types::Bundle.new(i.symbolize_keys) }
+      end
+    end
+  end
+end