brick_ftp 0.8.4 → 1.0.0.beta

data/lib/brick_ftp/api.rb

@@ -1,9 +0,0 @@
-module BrickFTP
-  module API
-    class Error < StandardError
-    end
-
-    class NoSuchAPI < Error
-    end
-  end
-end

data/lib/brick_ftp/api/authentication.rb

@@ -1,28 +0,0 @@
-require 'cgi'
-
-module BrickFTP
-  module API
-    module Authentication
-      COOKIE_NAME = 'BrickAPI'.freeze
-
-      # Generate authentication cookie.
-      # @param session [BrickFTP::API::Authentication::Session] authentication session object.
-      # @return [CGI::Cookie] authentication cookie.
-      def self.cookie(session)
-        CGI::Cookie.new(COOKIE_NAME, session.id)
-      end
-
-      # Alias for `BrickFTP::API::Authentication::Session.create`.
-      # @param username [String] username of BrickFTP's user.
-      # @param password [String] password of BrickFTP's user.
-      def self.login(username, password)
-        Session.create(username: username, password: password)
-      end
-
-      # Alias for `BrickFTP::API::Authentication::Session#destroy`.
-      def self.logout
-        BrickFTP.config.session.destroy
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/authentication/session.rb

@@ -1,25 +0,0 @@
-module BrickFTP
-  module API
-    module Authentication
-      class Session < BrickFTP::API::Base
-        endpoint :post,   :create, '/api/rest/v1/sessions.json'
-        endpoint :delete, :delete, '/api/rest/v1/sessions.json'
-
-        attribute :id
-        attribute :username, writable: true
-        attribute :password, writable: true
-
-        def self.create(params = {})
-          super.tap { |x| BrickFTP.config.session = x }
-        end
-
-        def destroy
-          super.tap do
-            delete_property(:id)
-            BrickFTP.config.session = nil
-          end
-        end
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/base.rb

@@ -1,119 +0,0 @@
-require 'cgi'
-
-module BrickFTP
-  module API
-    class Base
-      def self.inherited(subclass)
-        subclass.include APIDefinition
-      end
-
-      def self.all(params = {})
-        params.symbolize_keys!
-
-        data = BrickFTP::HTTPClient.new.send(
-          endpoints[:index][:http_method],
-          api_path_for(:index, params),
-          params: api_component_for(:index).except_path_and_query(params)
-        )
-        data.map { |x| new(x.symbolize_keys) }
-      end
-
-      def self.find(id, params: {})
-        data = BrickFTP::HTTPClient.new.send(
-          endpoints[:show][:http_method],
-          api_path_for(:show, id),
-          params: params
-        )
-        data.empty? ? nil : new(data.symbolize_keys)
-      end
-
-      def self.create(params = {})
-        params.symbolize_keys!
-
-        data = BrickFTP::HTTPClient.new.send(
-          endpoints[:create][:http_method],
-          api_path_for(:create, params),
-          params: api_component_for(:create).except_path_and_query(params)
-        )
-        data = {} if data.is_a?(Array)
-        new(data.symbolize_keys)
-      end
-
-      # @return [Hash{String => Object}] Key Value pairs of API properties
-      attr_reader :properties
-
-      def initialize(params = {})
-        initialize_properties
-        params.each { |k, v| write_property(k, v) }
-      end
-
-      def update(params = {})
-        params.symbolize_keys!
-
-        data = BrickFTP::HTTPClient.new.send(
-          self.class.endpoints[:update][:http_method],
-          self.class.api_path_for(:update, self),
-          params: self.class.api_component_for(:update).except_path_and_query(params)
-        )
-        data.each { |k, v| write_property(k, v) }
-
-        self
-      end
-
-      def destroy(recursive: false)
-        headers = {}
-        headers['Depth'] = 'infinity' if recursive
-
-        BrickFTP::HTTPClient.new.send(
-          self.class.endpoints[:delete][:http_method],
-          self.class.api_path_for(:delete, self),
-          headers: headers
-        )
-        true
-      end
-
-      def as_json(*_args)
-        properties.dup
-      end
-
-      def to_json(*args)
-        as_json.to_json(*args)
-      end
-
-      def write_property(key, value)
-        properties[key.to_s] = value
-      end
-
-      def read_property(key)
-        properties[key.to_s]
-      end
-
-      def delete_property(key)
-        properties.delete(key.to_s)
-      end
-
-      private
-
-      def initialize_properties
-        @properties = {}
-        self.class.attributes.each { |key| write_property(key, nil) }
-      end
-
-      def respond_to_missing?(method_name, _include_private)
-        self.class.attributes.include?(method_name.to_sym)
-      end
-
-      def method_missing(method_name, *args)
-        super unless self.class.attributes.include?(method_name.to_sym)
-
-        read_property(method_name)
-      end
-
-      def display
-        # attribute on history objects
-        # explicitly defined because display is a method on Object
-        read_property(:display)
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/behavior.rb

@@ -1,19 +0,0 @@
-module BrickFTP
-  module API
-    class Behavior < Base
-      endpoint :get,    :index,  '/api/rest/v1/behaviors.json'
-      endpoint :get,    :show,   '/api/rest/v1/behaviors/%{id}.json'
-      endpoint :post,   :create, '/api/rest/v1/behaviors.json'
-      endpoint :put,    :update, '/api/rest/v1/behaviors/%{id}.json'
-      endpoint :delete, :delete, '/api/rest/v1/behaviors/%{id}.json'
-
-      attribute :id
-      attribute :path
-      attribute :behavior
-      attribute :value
-      attribute :path, writable: true
-      attribute :behavior, writable: true
-      attribute :value, writable: true
-    end
-  end
-end

data/lib/brick_ftp/api/bundle.rb

@@ -1,17 +0,0 @@
-module BrickFTP
-  module API
-    class Bundle < Base
-      endpoint :get,    :index,  '/api/rest/v1/bundles.json'
-      endpoint :get,    :show,   '/api/rest/v1/bundles/%{id}.json'
-      endpoint :post,   :create, '/api/rest/v1/bundles.json'
-      endpoint :delete, :delete, '/api/rest/v1/bundles/%{id}.json'
-
-      attribute :id
-      attribute :code
-      attribute :url
-      attribute :user_id
-      attribute :created_at
-      attribute :paths, writable: true
-    end
-  end
-end

data/lib/brick_ftp/api/bundle_content.rb

@@ -1,18 +0,0 @@
-module BrickFTP
-  module API
-    class BundleContent < Base
-      endpoint :post, :index, ->(params) do
-        params.key?(:path) ? '/api/rest/v1/bundles/folders/%{path}' : '/api/rest/v1/bundles/folders'
-      end
-
-      attribute :id
-      attribute :path
-      attribute :type
-      attribute :size
-      attribute :crc32
-      attribute :md5
-      attribute :code, writable: true
-      attribute :host, writable: true
-    end
-  end
-end

data/lib/brick_ftp/api/bundle_download.rb

@@ -1,18 +0,0 @@
-module BrickFTP
-  module API
-    class BundleDownload < Base
-      endpoint :post, :index, '/api/rest/v1/bundles/files.json'
-
-      attribute :id
-      attribute :path
-      attribute :type
-      attribute :size
-      attribute :crc32
-      attribute :md5
-      attribute :download_uri
-      attribute :code, writable: true
-      attribute :host, writable: true
-      attribute :paths, writable: true
-    end
-  end
-end

data/lib/brick_ftp/api/file.rb

@@ -1,20 +0,0 @@
-module BrickFTP
-  module API
-    class File < Base
-      endpoint :get,    :show,   '/api/rest/v1/files/%{path}'
-      endpoint :delete, :delete, '/api/rest/v1/files/%{path}'
-
-      attribute :id
-      attribute :path
-      attribute :type
-      attribute :size
-      attribute :mtime
-      attribute :crc32
-      attribute :md5
-      attribute :download_uri
-      attribute :display_name
-      attribute :provided_mtime
-      attribute :permissions
-    end
-  end
-end

data/lib/brick_ftp/api/file_operation.rb

@@ -1,6 +0,0 @@
-module BrickFTP
-  module API
-    module FileOperation
-    end
-  end
-end

data/lib/brick_ftp/api/file_operation/copy.rb

@@ -1,10 +0,0 @@
-module BrickFTP
-  module API
-    module FileOperation
-      class Copy < BrickFTP::API::Base
-        endpoint :post, :create, '/api/rest/v1/files/%{path}'
-        attribute :'copy-destination', writable: true
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/file_operation/move.rb

@@ -1,10 +0,0 @@
-module BrickFTP
-  module API
-    module FileOperation
-      class Move < BrickFTP::API::Base
-        endpoint :post, :create, '/api/rest/v1/files/%{path}'
-        attribute :'move-destination', writable: true
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/file_operation/upload.rb

@@ -1,66 +0,0 @@
-module BrickFTP
-  module API
-    module FileOperation
-      class Upload < BrickFTP::API::Base
-        endpoint :post, :create, '/api/rest/v1/files/%{path}'
-
-        attribute :id
-        attribute :ref
-        attribute :http_method
-        attribute :upload_uri
-        attribute :partsize
-        attribute :part_number
-        attribute :available_parts
-        attribute :headers
-        attribute :parameters
-        attribute :send
-        attribute :path
-        attribute :action
-        attribute :ask_about_overwrites
-        attribute :type
-        attribute :size
-        attribute :mtime
-        attribute :crc32
-        attribute :md5
-        attribute :expires
-        attribute :next_partsize
-        attribute :provided_mtime
-        attribute :permission
-        attribute :action, writable: true
-        attribute :ref, writable: true
-        attribute :part, writable: true
-        attribute :restart, writable: true
-
-        # Upload file.
-        #
-        # @see https://brickftp.com/docs/rest-api/file-uploading/
-        # @param [String] path Remote file path.
-        # @param [IO] source Source `data` (not `path`) to upload.
-        # @param [Integer] chunk_size Size of chunk to multi-part upload.
-        # @return [BrickFTP::API::FileOperation::Upload] An instance of BrickFTP::API::FileOperation::Upload.
-        #
-        def self.create(path:, source:, chunk_size: nil)
-          api_client = BrickFTP::HTTPClient.new
-          chunk_io = BrickFTP::Utils::ChunkIO.new(source, chunk_size: chunk_size)
-
-          ref = nil
-          params_for_request_upload_url = { action: 'put' }
-          upload_info = {}
-          chunk_io.each.with_index(1) do |chunk, part|
-            params_for_request_upload_url.update(part: part, ref: ref) if part > 1
-            upload_info = api_client.post(api_path_for(:create, path: path), params: params_for_request_upload_url)
-            ref = upload_info['ref']
-
-            upload_uri = URI.parse(upload_info['upload_uri'])
-            upload_client = BrickFTP::HTTPClient.new(upload_uri.host)
-            upload_client.put(upload_info['upload_uri'], params: chunk)
-          end
-
-          uploaded_info = api_client.post(api_path_for(:create, path: path), params: { action: 'end', ref: ref })
-
-          new(upload_info.merge(uploaded_info).symbolize_keys)
-        end
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/file_operation/uploading_result.rb

@@ -1,22 +0,0 @@
-module BrickFTP
-  module API
-    module FileOperation
-      class UploadingResult < BrickFTP::API::Base
-        endpoint :post, :create, '/api/rest/v1/files/%{path}'
-
-        attribute :path
-        attribute :type
-        attribute :size
-        attribute :mtime
-        attribute :crc32
-        attribute :md5
-
-        def self.create(path:, ref:)
-          api_client = BrickFTP::HTTPClient.new
-          res = api_client.post(api_path_for(:create, path: path), params: { action: 'end', ref: ref })
-          new(res.symbolize_keys)
-        end
-      end
-    end
-  end
-end

data/lib/brick_ftp/api/file_operation/uploading_session.rb

@@ -1,95 +0,0 @@
-module BrickFTP
-  module API
-    module FileOperation
-      class UploadingSession < BrickFTP::API::Base
-        include Enumerable
-
-        endpoint :post, :create, '/api/rest/v1/files/%{path}'
-
-        attribute :ref
-        attribute :http_method
-        attribute :upload_uri
-        attribute :partsize
-        attribute :part_number
-        attribute :available_parts
-        attribute :headers
-        attribute :parameters
-        attribute :send
-        attribute :path
-        attribute :action
-        attribute :ask_about_overwrites
-        attribute :expires
-        attribute :next_partsize
-        attribute :provided_mtime
-        attribute :permission
-
-        # Get uploading URL.
-        #
-        # @see https://brickftp.com/docs/rest-api/file-uploading/
-        # @param [String] path Remote file path.
-        # @return [BrickFTP::API::FileOperation::UploadingSession] A session object of uploading file.
-        #
-        def self.create(path:)
-          api_client = BrickFTP::HTTPClient.new
-          res = api_client.post(api_path_for(:create, path: path), params: { action: 'put' })
-          new(res.symbolize_keys)
-        end
-
-        # Upload data.
-        #
-        # @param [String] upload_uri A uplading URL.
-        # @param [IO] data An IO object to upload.
-        #
-        def self.upload(upload_uri:, data:)
-          uri = URI.parse(upload_uri)
-          upload_client = BrickFTP::HTTPClient.new(uri.host)
-          upload_client.put(uri.to_s, params: data)
-        end
-
-        # Get uploading URL for multi part uploading.
-        #
-        # @param [Integer] part_number The part number.
-        # @return [BrickFTP::API::FileOperation::UploadingSession] A session object of uploading file.
-        #
-        def at(part_number)
-          params = { action: 'put', ref: ref, part: part_number }
-          api_client = BrickFTP::HTTPClient.new
-          res = api_client.post(self.class.api_path_for(:create, path: path), params: params)
-          self.class.new(res.symbolize_keys)
-        end
-
-        # Get each uploading URLs.
-        #
-        # @yield [session] Gives uploading session object to the block.
-        # @yieldparam [BrickFTP::API::FileOperation::UploadingSession] session A session object of uploading file.
-        #
-        def each
-          return enum_for(__method__) unless block_given?
-
-          yield self
-          (part_number + 1).upto(available_parts) do |n|
-            yield at(n)
-          end
-        end
-
-        # Complete uploading file.
-        #
-        # @return [BrickFTP::API::FileOperation::UploadingResult] A result of uploading file.
-        #
-        def commit
-          UploadingResult.create(path: path, ref: ref)
-        end
-
-        # Return single uploading session object.
-        #
-        # NOTE: The `#as_json` method will be overwritten by active_supprt.
-        #
-        # @return [Hash] a JSON serializable object
-        #
-        def as_json(*_args)
-          properties.dup
-        end
-      end
-    end
-  end
-end