brick_ftp 0.8.4 → 1.0.0.beta

data/lib/brick_ftp/core_ext.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module CoreExt
+    autoload :Struct, 'brick_ftp/core_ext/struct'
+    autoload :Hash, 'brick_ftp/core_ext/hash'
+  end
+end

data/lib/brick_ftp/core_ext/hash.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module CoreExt
+    module Hash
+      autoload :Compact, 'brick_ftp/core_ext/hash/compact'
+
+      refine ::Hash do
+        include(BrickFTP::CoreExt::Hash::Compact) unless ::Hash.instance_methods(false).include?(:compact)
+      end
+    end
+  end
+end

data/lib/brick_ftp/core_ext/hash/compact.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module CoreExt
+    module Hash
+      module Compact
+        def compact
+          select { |_, value| !value.nil? }
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/core_ext/struct.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module CoreExt
+    module Struct
+      autoload :New, 'brick_ftp/core_ext/struct/new'
+
+      refine ::Struct do
+        ::Struct.singleton_class.prepend(BrickFTP::CoreExt::Struct::New) if RUBY_VERSION < '2.5.0'
+      end
+    end
+  end
+end

data/lib/brick_ftp/core_ext/struct/new.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module CoreExt
+    module Struct
+      module New
+        def new(*args, keyword_init: false, &block)
+          super(*args) do
+            define_method(:initialize) { |**kwargs| super(*members.map { |k| kwargs[k] }) } if keyword_init
+            class_eval(&block) if block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    autoload :Client, 'brick_ftp/restful_api/client'
+    autoload :Command, 'brick_ftp/restful_api/command'
+    autoload :GetSiteUsage, 'brick_ftp/restful_api/get_site_usage'
+    # ref. https://developers.brickftp.com/#users
+    autoload :ListUsers, 'brick_ftp/restful_api/list_users'
+    autoload :CountUsers, 'brick_ftp/restful_api/count_users'
+    autoload :SearchUser, 'brick_ftp/restful_api/search_user'
+    autoload :GetUser, 'brick_ftp/restful_api/get_user'
+    autoload :CreateUser, 'brick_ftp/restful_api/create_user'
+    autoload :UpdateUser, 'brick_ftp/restful_api/update_user'
+    autoload :DeleteUser, 'brick_ftp/restful_api/delete_user'
+    autoload :UnlockUser, 'brick_ftp/restful_api/unlock_user'
+    # ref. https://developers.brickftp.com/#user-api-keys
+    autoload :ListAPIKeys, 'brick_ftp/restful_api/list_api_keys'
+    autoload :GetAPIKey, 'brick_ftp/restful_api/get_api_key'
+    autoload :CreateAPIKey, 'brick_ftp/restful_api/create_api_key'
+    autoload :DeleteAPIKey, 'brick_ftp/restful_api/delete_api_key'
+    # ref. https://developers.brickftp.com/#user-public-keys
+    autoload :ListPublicKeys, 'brick_ftp/restful_api/list_public_keys'
+    autoload :GetPublicKey, 'brick_ftp/restful_api/get_public_key'
+    autoload :CreatePublicKey, 'brick_ftp/restful_api/create_public_key'
+    autoload :DeletePublicKey, 'brick_ftp/restful_api/delete_public_key'
+    # ref. https://developers.brickftp.com/#groups
+    autoload :ListGroups, 'brick_ftp/restful_api/list_groups'
+    autoload :GetGroup, 'brick_ftp/restful_api/get_group'
+    autoload :CreateGroup, 'brick_ftp/restful_api/create_group'
+    autoload :UpdateGroup, 'brick_ftp/restful_api/update_group'
+    autoload :DeleteGroup, 'brick_ftp/restful_api/delete_group'
+    autoload :CreateUserInGroup, 'brick_ftp/restful_api/create_user_in_group'
+    autoload :AddGroupMember, 'brick_ftp/restful_api/add_group_member'
+    autoload :UpdateGroupMember, 'brick_ftp/restful_api/update_group_member'
+    autoload :RemoveGroupMember, 'brick_ftp/restful_api/remove_group_member'
+    # ref. https://developers.brickftp.com/#permissions
+    autoload :ListPermissions, 'brick_ftp/restful_api/list_permissions'
+    autoload :CreatePermission, 'brick_ftp/restful_api/create_permission'
+    autoload :DeletePermission, 'brick_ftp/restful_api/delete_permission'
+    # ref. https://developers.brickftp.com/#notifications
+    autoload :ListNotifications, 'brick_ftp/restful_api/list_notifications'
+    autoload :CreateNotification, 'brick_ftp/restful_api/create_notification'
+    autoload :DeleteNotification, 'brick_ftp/restful_api/delete_notification'
+    # ref. https://developers.brickftp.com/#history
+    autoload :RetrieveHistory, 'brick_ftp/restful_api/retrieve_history'
+    autoload :RetrieveSiteHistory, 'brick_ftp/restful_api/retrieve_site_history'
+    autoload :RetrieveLoginHistory, 'brick_ftp/restful_api/retrieve_login_history'
+    autoload :RetrieveUserHistory, 'brick_ftp/restful_api/retrieve_user_history'
+    autoload :RetrieveFolderHistory, 'brick_ftp/restful_api/retrieve_folder_history'
+    autoload :RetrieveFileHistory, 'brick_ftp/restful_api/retrieve_file_history'
+    # ref. https://developers.brickftp.com/#bundles
+    autoload :ListBundles, 'brick_ftp/restful_api/list_bundles'
+    autoload :GetBundle, 'brick_ftp/restful_api/get_bundle'
+    autoload :CreateBundle, 'brick_ftp/restful_api/create_bundle'
+    autoload :DeleteBundle, 'brick_ftp/restful_api/delete_bundle'
+    autoload :ListBundleContents, 'brick_ftp/restful_api/list_bundle_contents'
+    autoload :GetFileInBundle, 'brick_ftp/restful_api/get_file_in_bundle'
+    autoload :GetBundleZip, 'brick_ftp/restful_api/get_bundle_zip'
+    # ref. https://developers.brickftp.com/#behaviors
+    autoload :ListBehaviors, 'brick_ftp/restful_api/list_behaviors'
+    autoload :ListFolderBehaviors, 'brick_ftp/restful_api/list_folder_behaviors'
+    autoload :GetBehavior, 'brick_ftp/restful_api/get_behavior'
+    autoload :CreateBehavior, 'brick_ftp/restful_api/create_behavior'
+    autoload :UpdateBehavior, 'brick_ftp/restful_api/update_behavior'
+    autoload :DeleteBehavior, 'brick_ftp/restful_api/delete_behavior'
+    # ref. https://developers.brickftp.com/#file-and-folder-operations
+    autoload :ListFolders, 'brick_ftp/restful_api/list_folders'
+    autoload :CreateFolder, 'brick_ftp/restful_api/create_folder'
+    autoload :CountFolderContents, 'brick_ftp/restful_api/count_folder_contents'
+    autoload :GetFolderSize, 'brick_ftp/restful_api/get_folder_size'
+    autoload :DownloadFile, 'brick_ftp/restful_api/download_file'
+    autoload :MoveFolder, 'brick_ftp/restful_api/move_folder'
+    autoload :CopyFolder, 'brick_ftp/restful_api/copy_folder'
+    autoload :DeleteFolder, 'brick_ftp/restful_api/delete_folder'
+    # ref. https://developers.brickftp.com/#file-uploading
+    autoload :StartUpload, 'brick_ftp/restful_api/start_upload'
+    autoload :ContinueUpload, 'brick_ftp/restful_api/continue_upload'
+    autoload :CompleteUpload, 'brick_ftp/restful_api/complete_upload'
+    autoload :UploadFile, 'brick_ftp/restful_api/upload_file'
+  end
+end

data/lib/brick_ftp/restful_api/add_group_member.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    # Add a member
+    #
+    # @see https://developers.brickftp.com/#add-a-member Add a member
+    #
+    # ### Params
+    #
+    # PARAMETER | TYPE    | DESCRIPTION
+    # --------- | ------- | -----------
+    # admin     | boolean | Indicates whether the user is an administrator of the group.
+    #
+    class AddGroupMember
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'AddGroupMemberParams',
+        :admin,
+        keyword_init: true
+      )
+
+      # Adds a user to a group.
+      #
+      # - By default, the member will not be an admin.
+      # - If the user is already a member of the group, their attributes will be updated to match the request.
+      #
+      # @param [Integer] group_id ID of the group the membership is associated with.
+      # @param [Integer] user_id ID of the user the membership is associated with.
+      # @param [BrickFTP::RESTfulAPI::AddGroupMember::Params] params parameters
+      # @return [BrickFTP::Types::GroupMembership] group membership
+      # @raise [BrickFTP::RESTfulAPI::Error] exception
+      #
+      def call(group_id, user_id, params)
+        res = client.put("/api/rest/v1/groups/#{group_id}/memberships/#{user_id}.json", membership: params.to_h.compact)
+
+        BrickFTP::Types::GroupMembership.new(res.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/client.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    class Client
+      using BrickFTP::CoreExt::Struct
+
+      OPEN_TIMEOUT = 60
+      READ_TIMEOUT = 60
+      USER_AGENT = 'BrickFTP Client/1.0 (https://github.com/koshigoe/brick_ftp)'
+
+      # ref. https://developers.brickftp.com/#errors
+      ErrorResponse = Struct.new(
+        'RESTfulAPIErrorResponse',
+        :error,
+        :'http-code',
+        :errors,
+        keyword_init: true
+      )
+
+      class Error < StandardError
+        attr_reader :error
+
+        # @param [BrickFTP::Adapters::RESTfulAPI::ErrorResponse] error
+        def initialize(error)
+          super error.error
+
+          @error = error
+        end
+      end
+
+      # Initialize REST API client.
+      #
+      # @param [String] subdomain
+      # @param [String] api_key
+      #
+      def initialize(subdomain, api_key)
+        @http = Net::HTTP.new("#{subdomain}.brickftp.com", 443)
+        @http.use_ssl = true
+        @http.open_timeout = OPEN_TIMEOUT
+        @http.read_timeout = READ_TIMEOUT
+        @request_headers = {
+          'User-Agent' => USER_AGENT,
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        }
+        @api_key = api_key
+      end
+
+      # Send HTTP request via GET method.
+      #
+      # @param [String] path the request path including query string.
+      # @param [Hash, nil] headers additional request headers
+      # @return [Hash] JSON parsed object.
+      #
+      def get(path, headers = nil)
+        req = Net::HTTP::Get.new(path, (headers || {}).merge(@request_headers))
+        req.basic_auth(@api_key, 'x')
+        res = @http.start { |session| session.request(req) }
+
+        handle_response(res)
+      end
+
+      # Send HTTP request via POST method.
+      #
+      # @param [String] path the request path including query string.
+      # @param [Hash, nil] data the request body
+      # @param [Hash, nil] headers additional request headers
+      # @return [Hash] JSON parsed object.
+      #
+      def post(path, data = nil, headers = nil)
+        req = Net::HTTP::Post.new(path, (headers || {}).merge(@request_headers))
+        req.basic_auth(@api_key, 'x')
+        req.body = data.to_json unless data.nil?
+        res = @http.start { |session| session.request(req) }
+
+        handle_response(res)
+      end
+
+      # Send HTTP request via PUT method.
+      #
+      # @param [String] path the request path including query string.
+      # @param [Hash, nil] data the request body
+      # @param [Hash, nil] headers additional request headers
+      # @return [Hash] JSON parsed object.
+      #
+      def put(path, data = nil, headers = nil)
+        req = Net::HTTP::Put.new(path, (headers || {}).merge(@request_headers))
+        req.basic_auth(@api_key, 'x')
+        req.body = data.to_json unless data.nil?
+        res = @http.start { |session| session.request(req) }
+
+        handle_response(res)
+      end
+
+      # Send HTTP request via PATCH method.
+      #
+      # @param [String] path the request path including query string.
+      # @param [Hash, nil] data the request body
+      # @param [Hash, nil] headers additional request headers
+      # @return [Hash] JSON parsed object.
+      #
+      def patch(path, data = nil, headers = nil)
+        req = Net::HTTP::Patch.new(path, (headers || {}).merge(@request_headers))
+        req.basic_auth(@api_key, 'x')
+        req.body = data.to_json unless data.nil?
+        res = @http.start { |session| session.request(req) }
+
+        handle_response(res)
+      end
+
+      # Send HTTP request via DELETE method.
+      #
+      # @param [String] path the request path including query string.
+      # @param [Hash, nil] headers additional request headers
+      # @return [Hash] JSON parsed object.
+      #
+      def delete(path, headers = nil)
+        req = Net::HTTP::Delete.new(path, (headers || {}).merge(@request_headers))
+        req.basic_auth(@api_key, 'x')
+        res = @http.start { |session| session.request(req) }
+
+        handle_response(res)
+      end
+
+      # Upload file.
+      #
+      # @param [String] http_method Value is `PUT` or `POST`, and is the HTTP method used when uploading the file.
+      # @param [String] upload_url The URL where the file is uploaded to.
+      # @param [IO] io uploading data
+      # @return [Integer] content length
+      #
+      def upload_file(http_method, upload_url, io)
+        raise ArgumentError, "Unsupported HTTP method `#{http_method}`" unless %w[POST PUT].include?(http_method)
+
+        uri = URI.parse(upload_url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        req = Net::HTTP.const_get(http_method.capitalize).new(uri.request_uri)
+        req.body_stream = io
+        req['Content-Length'] = io.size
+        res = http.start { |session| session.request(req) }
+
+        return io.size if res.is_a?(Net::HTTPSuccess)
+        raise Error, parse_error_response(res)
+      end
+
+      private
+
+      def handle_response(response)
+        case response
+        when Net::HTTPSuccess
+          parse_success_response(response)
+        else
+          error = parse_error_response(response)
+          raise Error, error
+        end
+      end
+
+      def parse_success_response(response)
+        JSON.parse(response.body)
+      end
+
+      def parse_error_response(response)
+        parsed = begin
+                   JSON.parse(response.body)
+                 rescue StandardError
+                   {}
+                 end
+        parsed = {} unless parsed.is_a?(Hash)
+
+        ErrorResponse.new(parsed.symbolize_keys).tap do |e|
+          e['http-code'] ||= response.code
+          e['error'] ||= response.body
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BrickFTP
+  module RESTfulAPI
+    module Command
+      def self.included(klass)
+        klass.class_eval do
+          attr_reader :client
+        end
+      end
+
+      # Initialize command.
+      #
+      # @param [BrickFTP::RESTfulAPI::Client] client RESTful API client.
+      #
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/brick_ftp/restful_api/complete_upload.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BrickFTP
+  module RESTfulAPI
+    # Completing an upload
+    #
+    # @see https://developers.brickftp.com/#completing-an-upload Completing an upload
+    #
+    # ### 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.
+    #
+    class CompleteUpload
+      include Command
+      using BrickFTP::CoreExt::Struct
+      using BrickFTP::CoreExt::Hash
+
+      Params = Struct.new(
+        'CompleteUploadParams',
+        :ref,
+        keyword_init: true
+      )
+
+      # After uploading the file to the file storage environment,
+      # the REST API needs to be notified that the upload was completed.
+      #
+      # This is done by sending another POST request to `/files/PATH_AND_FILENAME.EXT` with
+      # parameter `action` set to end and parameter `ref` set to the reference ID returned at the start of the upload.
+      #
+      # @param [String] path Full path of the file or folder. Maximum of 550 characters.
+      # @param [BrickFTP::RESTfulAPI::CompleteUpload::Params] params parameters
+      # @return [BrickFTP::Types::File] File object
+      # @raise [BrickFTP::RESTfulAPI::Error] exception
+      #
+      def call(path, params)
+        res = client.post("/api/rest/v1/files/#{ERB::Util.url_encode(path)}", params.to_h.compact.merge(action: 'end'))
+
+        BrickFTP::Types::File.new(res.symbolize_keys)
+      end
+    end
+  end
+end