brick_ftp 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b3bf69a33bce75c836d9f0a892647127e9a52d8
-  data.tar.gz: ac40a241fa853a76d0b156de3d7a5946c00f037d
+  metadata.gz: 3865f1640bda9de3a80c620e958bf9de23901ca0
+  data.tar.gz: 12ebd6763744542fd4657910bb5e4cffd2635ada
 SHA512:
-  metadata.gz: 39d59472f0eee719336531c6f79dad2605d426690452f01875036020c45f990e919674351b807f3794f817c023efa498c888aadac7ddd70f6357c214dcbfd209
-  data.tar.gz: 3512bd4ce61bdcfe14cfca362bbd437f02be765b07aeae1db6e7fff0d7096c0077f90838780ccb13e31f37483739071f948172e566847f936bcd59a944edf73c
+  metadata.gz: 912c304822601600468a880b45d572f8ea744c912d589576448004a3bdee956fa83366892581a6f4116405d69ebef98f5eaf22e6c2f711cf0c42f07662587ff9
+  data.tar.gz: 4fdc3e3a5471577f2462b072242d15bb74a1bbde3b5dd45ee12e3bc9f8a1f3fbcc3b9927ad8dd1b0508486b953bedb46afd3db93a92484d08244e5bc56cb27d3

data/lib/brick_ftp.rb

@@ -4,6 +4,8 @@ require 'brick_ftp/configuration'
 require 'brick_ftp/http_client'
 require 'brick_ftp/client'
 require 'brick_ftp/api'
+require 'brick_ftp/api_component'
+require 'brick_ftp/api_definition'
 require 'brick_ftp/api/base'
 require 'brick_ftp/api/authentication'
 require 'brick_ftp/api/authentication/session'
@@ -22,12 +24,13 @@ require 'brick_ftp/api/bundle'
 require 'brick_ftp/api/bundle_content'
 require 'brick_ftp/api/bundle_download'
 require 'brick_ftp/api/behavior'
-require 'brick_ftp/api/behavior_folder'
+require 'brick_ftp/api/folder_behavior'
 require 'brick_ftp/api/folder'
 require 'brick_ftp/api/file'
-require 'brick_ftp/api/file_move'
-require 'brick_ftp/api/file_copy'
-require 'brick_ftp/api/file_upload'
+require 'brick_ftp/api/file_operation'
+require 'brick_ftp/api/file_operation/move'
+require 'brick_ftp/api/file_operation/copy'
+require 'brick_ftp/api/file_operation/upload'
 
 module BrickFTP
   # Return configuration.

data/lib/brick_ftp/api.rb

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

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

@@ -2,10 +2,12 @@ module BrickFTP
   module API
     module Authentication
       class Session < BrickFTP::API::Base
-        define_api :create, '/api/rest/v1/sessions.json'
-        define_api :delete, '/api/rest/v1/sessions.json'
-        define_writable_attributes :username, :password
-        define_readonly_attributes :id
+        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 }

data/lib/brick_ftp/api/base.rb

@@ -3,107 +3,63 @@ require 'cgi'
 module BrickFTP
   module API
     class Base
-      class NoSuchAPIError < StandardError; end
-
-      class UndefinedAttributesError < StandardError
-        def initialize(undefined_attributes = [])
-          super "No such attributes: #{undefined_attributes.join(', ')}"
-        end
-      end
-
       def self.inherited(subclass)
-        subclass.instance_eval do
-          @api = {}
-          @writable_attributes = []
-          @readonly_attributes = []
-        end
-      end
-
-      class << self
-        attr_reader :api, :writable_attributes, :readonly_attributes
+        subclass.include APIDefinition
       end
 
-      def self.attributes
-        writable_attributes + readonly_attributes
-      end
-
-      def self.define_api(method, path)
-        @api[method] = path
-      end
-
-      def self.define_writable_attributes(*attributes)
-        @writable_attributes = attributes
-        attr_reader *@writable_attributes.map { |x| x.to_s.tr('-', '_') }
-      end
-
-      def self.define_readonly_attributes(*attributes)
-        @readonly_attributes = attributes
-        attr_reader *@readonly_attributes.map { |x| x.to_s.tr('-', '_') }
-      end
-
-      def self.api_path_for(method, params = {})
-        raise NoSuchAPIError, "#{method} #{self.name}" unless @api.key?(method)
-        @api[method] % Hash[params.map { |k, v| [k, CGI.escape(v.to_s)] }]
-      end
-
-      QUERY_PARAMS = %i(page per_page start_at recursive).freeze
-
-      def self.all(path_params = {})
-        path_params.symbolize_keys!
-        query_params = QUERY_PARAMS.each_with_object({}) do |name, res|
-          res.update(name => path_params.delete(name)) if path_params.key?(name)
-        end
-
-        path = api_path_for(:index, path_params)
-        unless query_params.empty?
-          query = query_params.each_with_object([]) do |(k, v), res|
-            res << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
-          end.join('&')
-          path = "#{path}?#{query}"
-        end
+      def self.all(params = {})
+        params.symbolize_keys!
 
-        BrickFTP::HTTPClient.new.get(path).map { |x| new(x.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 = {}
-        api[:show].scan(/%\{([^}]+)\}/) { |m| params[m.first.to_sym] = id }
-        data = BrickFTP::HTTPClient.new.get(api_path_for(:show, params))
+        data = BrickFTP::HTTPClient.new.send(
+          endpoints[:show][:http_method],
+          api_path_for(:show, id)
+        )
         data.empty? ? nil : new(data.symbolize_keys)
       end
 
-      def self.create(params = {}, path_params = {})
+      def self.create(params = {})
         params.symbolize_keys!
-        undefined_attributes = params.keys - writable_attributes
-        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
 
-        data = BrickFTP::HTTPClient.new.post(api_path_for(:create, path_params), params: params)
+        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
 
       def initialize(params = {})
-        undefined_attributes = params.keys - self.class.attributes
-        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
-
         params.each { |k, v| instance_variable_set(:"@#{k}", v) }
       end
 
       def update(params = {})
         params.symbolize_keys!
-        undefined_attributes = params.keys - self.class.writable_attributes
-        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
 
-        data = BrickFTP::HTTPClient.new.put(self.class.api_path_for(:update, id: id), params: params)
+        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| instance_variable_set(:"@#{k}", v) }
 
         self
       end
 
       def destroy
-        params = {}
-        self.class.api[:delete].scan(/%\{([^}]+)\}/) { |m| params[m.first.to_sym] = send(m.first.to_sym) }
-        BrickFTP::HTTPClient.new.delete(self.class.api_path_for(:delete, params))
+        BrickFTP::HTTPClient.new.send(
+          self.class.endpoints[:delete][:http_method],
+          self.class.api_path_for(:delete, self),
+        )
         true
       end
     end

data/lib/brick_ftp/api/behavior.rb

@@ -1,13 +1,19 @@
 module BrickFTP
   module API
     class Behavior < Base
-      define_api :index,  '/api/rest/v1/behaviors.json'
-      define_api :show,   '/api/rest/v1/behaviors/%{id}.json'
-      define_api :create, '/api/rest/v1/behaviors.json'
-      define_api :update, '/api/rest/v1/behaviors/%{id}.json'
-      define_api :delete, '/api/rest/v1/behaviors/%{id}.json'
-      define_writable_attributes :path, :behavior, :value
-      define_readonly_attributes :id, :path, :behavior, :value
+      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,12 +1,17 @@
 module BrickFTP
   module API
     class Bundle < Base
-      define_api :index,  '/api/rest/v1/bundles.json'
-      define_api :show,   '/api/rest/v1/bundles/%{id}.json'
-      define_api :create, '/api/rest/v1/bundles.json'
-      define_api :delete, '/api/rest/v1/bundles/%{id}.json'
-      define_writable_attributes :paths
-      define_readonly_attributes :id, :code, :url, :user_id, :created_at
+      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,20 +1,18 @@
 module BrickFTP
   module API
     class BundleContent < Base
-      define_api :index, '/api/rest/v1/bundles/folders%{path}'
-      define_writable_attributes :code, :host
-      define_readonly_attributes :id, :path, :type, :size, :crc32, :md5
+      endpoint :post, :index, ->(params) {
+        params.key?(:path) ? '/api/rest/v1/bundles/folders/%{path}' : '/api/rest/v1/bundles/folders'
+      }
 
-      def self.all(params, path_params = {})
-        params.symbolize_keys!
-        undefined_attributes = params.keys - writable_attributes
-        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
-
-        path_params[:path] = '' unless path_params.key?(:path)
-
-        data = BrickFTP::HTTPClient.new.post(api_path_for(:index, path_params), params: params)
-        data.map { |x| new(x.symbolize_keys) }
-      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 +1,18 @@
 module BrickFTP
   module API
     class BundleDownload < Base
-      define_api :index, '/api/rest/v1/bundles/files.json'
-      define_writable_attributes :code, :host, :paths
-      define_readonly_attributes :id, :path, :type, :size, :crc32, :md5, :download_uri
+      endpoint :post, :index, '/api/rest/v1/bundles/files.json'
 
-      def self.all(params, path_params = {})
-        params.symbolize_keys!
-        undefined_attributes = params.keys - writable_attributes
-        raise UndefinedAttributesError, undefined_attributes unless undefined_attributes.empty?
-
-        data = BrickFTP::HTTPClient.new.post(api_path_for(:index, path_params), params: params)
-        data.map { |x| new(x.symbolize_keys) }
-      end
+      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,9 +1,19 @@
 module BrickFTP
   module API
     class File < Base
-      define_api :show,   '/api/rest/v1/files/%{path}'
-      define_api :delete, '/api/rest/v1/files/%{path}'
-      define_readonly_attributes :id, :path, :type, :size, :mtime, :crc32, :md5, :download_uri, :provided_mtime, :permissions
+      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 :provided_mtime
+      attribute :permissions
     end
   end
 end

data/lib/brick_ftp/api/file_operation.rb

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

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,49 @@
+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
+
+        def self.create(path:, source:)
+          api_client = BrickFTP::HTTPClient.new
+          step1 = api_client.post(api_path_for(:create, path: path), params: { action: 'put' })
+
+          upload_uri = URI.parse(step1['upload_uri'])
+          upload_client = BrickFTP::HTTPClient.new(upload_uri.host)
+          upload_client.put(step1['upload_uri'], params: source)
+
+          step3 = api_client.post(api_path_for(:create, path: path), params: { action: 'end', ref: step1['ref'] })
+
+          new(step1.merge(step3).symbolize_keys)
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/api/folder.rb

@@ -1,13 +1,18 @@
 module BrickFTP
   module API
     class Folder < Base
-      define_api :index,  '/api/rest/v1/folders/%{path}'
-      define_api :create, '/api/rest/v1/folders/%{path}'
-      define_readonly_attributes :id, :path, :type, :size, :mtime, :crc32, :md5, :provided_mtime, :permissions
+      endpoint :get,  :index,  '/api/rest/v1/folders/%{path}', :page, :per_page, :search, :'sort_by[path]', :'sort_by[size]', :'sort_by[modified_at_datetime]'
+      endpoint :post, :create, '/api/rest/v1/folders/%{path}'
 
-      def self.create(path_params = {})
-        super({}, path_params)
-      end
+      attribute :id
+      attribute :path
+      attribute :type
+      attribute :size
+      attribute :mtime
+      attribute :crc32
+      attribute :md5
+      attribute :provided_mtime
+      attribute :permissions
     end
   end
 end

data/lib/brick_ftp/api/folder_behavior.rb

@@ -0,0 +1,12 @@
+module BrickFTP
+  module API
+    class FolderBehavior < Base
+      endpoint :get, :index, '/api/rest/v1/behaviors/folders/%{path}', :recursive
+
+      attribute :id
+      attribute :path
+      attribute :behavior
+      attribute :value
+    end
+  end
+end

data/lib/brick_ftp/api/group.rb

@@ -1,13 +1,16 @@
 module BrickFTP
   module API
     class Group < Base
-      define_api :index,  '/api/rest/v1/groups.json'
-      define_api :show,   '/api/rest/v1/groups/%{id}.json'
-      define_api :create, '/api/rest/v1/groups.json'
-      define_api :update, '/api/rest/v1/groups/%{id}.json'
-      define_api :delete, '/api/rest/v1/groups/%{id}.json'
-      define_writable_attributes :name, :notes, :user_ids
-      define_readonly_attributes :id
+      endpoint :get,    :index,  '/api/rest/v1/groups.json'
+      endpoint :get,    :show,   '/api/rest/v1/groups/%{id}.json'
+      endpoint :post,   :create, '/api/rest/v1/groups.json'
+      endpoint :put,    :update, '/api/rest/v1/groups/%{id}.json'
+      endpoint :delete, :delete, '/api/rest/v1/groups/%{id}.json'
+
+      attribute :id
+      attribute :name, writable: true
+      attribute :notes, writable: true
+      attribute :user_ids, writable: true
     end
   end
 end

data/lib/brick_ftp/api/history/file.rb

@@ -2,19 +2,20 @@ module BrickFTP
   module API
     module History
       class File < BrickFTP::API::Base
-        define_api :index, '/api/rest/v1/history/files/%{path}'
-        define_readonly_attributes :id,
-                                   :when,
-                                   :user_id,
-                                   :username,
-                                   :action,
-                                   :failure_type,
-                                   :path,
-                                   :source,
-                                   :destination,
-                                   :targets,
-                                   :ip,
-                                   :interface
+        endpoint :get, :index, '/api/rest/v1/history/files/%{path}', :page, :per_page, :start_at
+
+        attribute :id
+        attribute :when
+        attribute :user_id
+        attribute :username
+        attribute :action
+        attribute :failure_type
+        attribute :path
+        attribute :source
+        attribute :destination
+        attribute :targets
+        attribute :ip
+        attribute :interface
       end
     end
   end

data/lib/brick_ftp/api/history/folder.rb

@@ -2,19 +2,20 @@ module BrickFTP
   module API
     module History
       class Folder < BrickFTP::API::Base
-        define_api :index, '/api/rest/v1/history/folders/%{path}'
-        define_readonly_attributes :id,
-                                   :when,
-                                   :user_id,
-                                   :username,
-                                   :action,
-                                   :failure_type,
-                                   :path,
-                                   :source,
-                                   :destination,
-                                   :targets,
-                                   :ip,
-                                   :interface
+        endpoint :get, :index, '/api/rest/v1/history/folders/%{path}', :page, :per_page, :start_at
+
+        attribute :id
+        attribute :when
+        attribute :user_id
+        attribute :username
+        attribute :action
+        attribute :failure_type
+        attribute :path
+        attribute :source
+        attribute :destination
+        attribute :targets
+        attribute :ip
+        attribute :interface
       end
     end
   end

data/lib/brick_ftp/api/history/login.rb

@@ -2,19 +2,20 @@ module BrickFTP
   module API
     module History
       class Login < BrickFTP::API::Base
-        define_api :index, '/api/rest/v1/history/login.json'
-        define_readonly_attributes :id,
-                                   :when,
-                                   :user_id,
-                                   :username,
-                                   :action,
-                                   :failure_type,
-                                   :path,
-                                   :source,
-                                   :destination,
-                                   :targets,
-                                   :ip,
-                                   :interface
+        endpoint :get, :index, '/api/rest/v1/history/login.json', :page, :per_page, :start_at
+
+        attribute :id
+        attribute :when
+        attribute :user_id
+        attribute :username
+        attribute :action
+        attribute :failure_type
+        attribute :path
+        attribute :source
+        attribute :destination
+        attribute :targets
+        attribute :ip
+        attribute :interface
       end
     end
   end

data/lib/brick_ftp/api/history/site.rb

@@ -2,19 +2,20 @@ module BrickFTP
   module API
     module History
       class Site < BrickFTP::API::Base
-        define_api :index, '/api/rest/v1/history.json'
-        define_readonly_attributes :id,
-                                   :when,
-                                   :user_id,
-                                   :username,
-                                   :action,
-                                   :failure_type,
-                                   :path,
-                                   :source,
-                                   :destination,
-                                   :targets,
-                                   :ip,
-                                   :interface
+        endpoint :get, :index, '/api/rest/v1/history.json', :page, :per_page, :start_at
+
+        attribute :id
+        attribute :when
+        attribute :user_id
+        attribute :username
+        attribute :action
+        attribute :failure_type
+        attribute :path
+        attribute :source
+        attribute :destination
+        attribute :targets
+        attribute :ip
+        attribute :interface
       end
     end
   end

data/lib/brick_ftp/api/history/user.rb

@@ -2,19 +2,20 @@ module BrickFTP
   module API
     module History
       class User < BrickFTP::API::Base
-        define_api :index, '/api/rest/v1/history/users/%{user_id}.json'
-        define_readonly_attributes :id,
-                                   :when,
-                                   :user_id,
-                                   :username,
-                                   :action,
-                                   :failure_type,
-                                   :path,
-                                   :source,
-                                   :destination,
-                                   :targets,
-                                   :ip,
-                                   :interface
+        endpoint :get, :index, '/api/rest/v1/history/users/%{user_id}.json', :page, :per_page, :start_at
+
+        attribute :id
+        attribute :when
+        attribute :user_id
+        attribute :username
+        attribute :action
+        attribute :failure_type
+        attribute :path
+        attribute :source
+        attribute :destination
+        attribute :targets
+        attribute :ip
+        attribute :interface
       end
     end
   end

data/lib/brick_ftp/api/notification.rb

@@ -1,11 +1,14 @@
 module BrickFTP
   module API
     class Notification < Base
-      define_api :index,  '/api/rest/v1/notifications.json'
-      define_api :create, '/api/rest/v1/notifications.json'
-      define_api :delete, '/api/rest/v1/notifications/%{id}.json'
-      define_writable_attributes :path, :user_id, :username
-      define_readonly_attributes :id
+      endpoint :get,    :index,  '/api/rest/v1/notifications.json'
+      endpoint :post,   :create, '/api/rest/v1/notifications.json'
+      endpoint :delete, :delete, '/api/rest/v1/notifications/%{id}.json'
+
+      attribute :id
+      attribute :path, writable: true
+      attribute :user_id, writable: true
+      attribute :username, writable: true
     end
   end
 end

data/lib/brick_ftp/api/permission.rb

@@ -1,11 +1,17 @@
 module BrickFTP
   module API
     class Permission < Base
-      define_api :index,  '/api/rest/v1/permissions.json'
-      define_api :create, '/api/rest/v1/permissions.json'
-      define_api :delete, '/api/rest/v1/permissions/%{id}.json'
-      define_writable_attributes :path, :permission, :user_id, :username, :group_id
-      define_readonly_attributes :id, :recursive
+      endpoint :get,    :index,  '/api/rest/v1/permissions.json'
+      endpoint :post,   :create, '/api/rest/v1/permissions.json'
+      endpoint :delete, :delete, '/api/rest/v1/permissions/%{id}.json'
+
+      attribute :id
+      attribute :recursive
+      attribute :path, writable: true
+      attribute :permission, writable: true
+      attribute :user_id, writable: true
+      attribute :username, writable: true
+      attribute :group_id, writable: true
     end
   end
 end

data/lib/brick_ftp/api/public_key.rb

@@ -1,11 +1,15 @@
 module BrickFTP
   module API
     class PublicKey < Base
-      define_api :index,  '/api/rest/v1/users/%{user_id}/public_keys.json'
-      define_api :create, '/api/rest/v1/users/%{user_id}/public_keys.json'
-      define_api :delete, '/api/rest/v1/public_keys/%{id}.json'
-      define_writable_attributes :title, :public_key
-      define_readonly_attributes :id, :fingerprint, :created_at
+      endpoint :get,    :index,  '/api/rest/v1/users/%{user_id}/public_keys.json'
+      endpoint :post,   :create, '/api/rest/v1/users/%{user_id}/public_keys.json'
+      endpoint :delete, :delete, '/api/rest/v1/public_keys/%{id}.json'
+
+      attribute :id
+      attribute :fingerprint
+      attribute :created_at
+      attribute :title, writable: true
+      attribute :public_key, writable: true
     end
   end
 end

data/lib/brick_ftp/api/user.rb

@@ -1,35 +1,36 @@
 module BrickFTP
   module API
     class User < Base
-      define_api :index,  '/api/rest/v1/users.json'
-      define_api :show,   '/api/rest/v1/users/%{id}.json'
-      define_api :create, '/api/rest/v1/users.json'
-      define_api :update, '/api/rest/v1/users/%{id}.json'
-      define_api :delete, '/api/rest/v1/users/%{id}.json'
-      define_writable_attributes :username,
-                                 :password,
-                                 :name,
-                                 :email,
-                                 :notes,
-                                 :group_ids,
-                                 :ftp_permission,
-                                 :web_permission,
-                                 :sftp_permission,
-                                 :dav_permission,
-                                 :restapi_permission,
-                                 :attachments_permission,
-                                 :self_managed,
-                                 :require_password_change,
-                                 :allowed_ips,
-                                 :user_root,
-                                 :grant_permission,
-                                 :ssl_required,
-                                 :authentication_method
-      define_readonly_attributes :id,
-                                 :last_login_at,
-                                 :time_zone,
-                                 :language,
-                                 :site_admin
+      endpoint :get,    :index,  '/api/rest/v1/users.json'
+      endpoint :get,    :show,   '/api/rest/v1/users/%{id}.json'
+      endpoint :post,   :create, '/api/rest/v1/users.json'
+      endpoint :put,    :update, '/api/rest/v1/users/%{id}.json'
+      endpoint :delete, :delete, '/api/rest/v1/users/%{id}.json'
+
+      attribute :id
+      attribute :last_login_at
+      attribute :time_zone
+      attribute :language
+      attribute :site_admin
+      attribute :username, writable: true
+      attribute :password, writable: true
+      attribute :name, writable: true
+      attribute :email, writable: true
+      attribute :notes, writable: true
+      attribute :group_ids, writable: true
+      attribute :ftp_permission, writable: true
+      attribute :web_permission, writable: true
+      attribute :sftp_permission, writable: true
+      attribute :dav_permission, writable: true
+      attribute :restapi_permission, writable: true
+      attribute :attachments_permission, writable: true
+      attribute :self_managed, writable: true
+      attribute :require_password_change, writable: true
+      attribute :allowed_ips, writable: true
+      attribute :user_root, writable: true
+      attribute :grant_permission, writable: true
+      attribute :ssl_required, writable: true
+      attribute :authentication_method, writable: true
     end
   end
 end

data/lib/brick_ftp/api_component.rb

@@ -0,0 +1,79 @@
+module BrickFTP
+  class APIComponent
+    attr_reader :path_template, :query_keys
+
+    def initialize(path_template, query_keys = [])
+      @path_template = path_template.respond_to?(:call) ? path_template : ->(_) { path_template }
+      @query_keys = query_keys.map(&:to_sym)
+    end
+
+    def path(params)
+      params = normalize_params(params)
+
+      path_params = build_path_params_from(params)
+      escaped_path_params = path_params.each_with_object({}) do |(k, v), res|
+        res[k] = CGI.escape(v.to_s)
+      end
+
+      path = path_template.call(params) % escaped_path_params
+      query = build_query_string_from(params)
+      query.empty? ? path : "#{path}?#{query}"
+    end
+
+    def build_path_params_from(params = {})
+      params = normalize_params(params)
+
+      path_variables(params).each_with_object({}) do |key, res|
+        res[key] = params[key]
+      end
+    end
+
+    def build_query_params_from(params = {})
+      params = normalize_params(params)
+
+      query_keys.each_with_object({}) do |name, res|
+        next unless params.key?(name)
+        res[name] = params[name]
+      end
+    end
+
+    def build_query_string_from(params = {})
+      params = normalize_params(params)
+
+      pairs = build_query_params_from(params).each_with_object([]) do |(k, v), res|
+        res << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+      end
+      pairs.join('&')
+    end
+
+    def except_path_and_query(params = {})
+      params = normalize_params(params)
+
+      exceptions = path_variables(params) + query_keys
+      params.reject { |k, _| exceptions.include?(k) }
+    end
+
+    private
+
+    def path_variables(params = {})
+      @path_variables ||= path_template.call(params).scan(/%\{([^}]+)\}/).map { |m| m.first.to_sym }
+    end
+
+    def normalize_params(params = {})
+      case params
+      when Hash
+        params.symbolize_keys
+      when BrickFTP::API::Base
+        keys = path_variables(params) + query_keys
+        keys.each_with_object({}) do |key, res|
+          res[key] = params.send(key)
+        end
+      else
+        keys = path_variables(params) + query_keys
+        keys.each_with_object({}) do |key, res|
+          res[key] = params
+        end
+      end
+    end
+  end
+end

data/lib/brick_ftp/api_definition.rb

@@ -0,0 +1,66 @@
+module BrickFTP
+  module APIDefinition
+    def self.included(klass)
+      klass.class_eval do
+        @endpoints = {}
+        @writable_attributes = []
+        @readonly_attributes = []
+
+        class << self
+          attr_reader :endpoints, :writable_attributes, :readonly_attributes
+        end
+      end
+
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Define API endpoint.
+      # @param http_method [:Symbol] any one of :get, :post, :put, :delete
+      # @param name [Symbol] any one of :index, :show, :create, :update, :destroy
+      # @param path_template [Stryng] template of endpoint path.
+      # @param query_keys [Array] array of query_string's parameter name.
+      def endpoint(http_method, name, path_template, *query_keys)
+        endpoints[name] = {
+          http_method: http_method,
+          path_template: path_template,
+          query_keys: query_keys,
+        }
+      end
+
+      # Define attribute.
+      # @param name [Symbol] name of attribute.
+      # @param writable [Boolean]
+      def attribute(name, writable: false)
+        if writable
+          writable_attributes << name.to_sym
+        else
+          readonly_attributes << name.to_sym
+        end
+        attr_reader name.to_s.tr('-', '_')
+      end
+
+      # Return all attributes.
+      # @return [Array]
+      def attributes
+        writable_attributes + readonly_attributes
+      end
+
+      # Build path for API endpoint.
+      # @param name [Symbol]
+      # @param params [Hash] mixed path parameters and query parameters.
+      # @return [String]
+      def api_path_for(name, params = {})
+        api_component_for(name).path(params)
+      end
+
+      # Build BrickFTP::APIComponent.
+      # @param name [Symbol]
+      # @return [BrickFTP::APIComponent]
+      def api_component_for(name)
+        raise BrickFTP::API::NoSuchAPI, "#{name} #{self.name}" unless endpoints.key?(name)
+        BrickFTP::APIComponent.new(endpoints[name][:path_template], endpoints[name][:query_keys])
+      end
+    end
+  end
+end

data/lib/brick_ftp/client.rb

@@ -281,9 +281,9 @@ module BrickFTP
 
     # shows the behaviors that apply to the given path.
     # @see https://brickftp.com/ja/docs/rest-api/behaviors/
-    # @return [Array] array of BrickFTP::API::BehaviorFolder
+    # @return [Array] array of BrickFTP::API::FolderBehavior
     def list_folder_behaviors(path:)
-      BrickFTP::API::BehaviorFolder.all(path: path)
+      BrickFTP::API::FolderBehavior.all(path: path)
     end
 
     # Lists the contents of the folder provided in the URL.
@@ -326,7 +326,7 @@ module BrickFTP
     # @param move_destination [String]
     # @return [BrickFTP::API::FileMove]
     def move_file(path:, move_destination:)
-      BrickFTP::API::FileMove.create(path: path, move_destination: move_destination)
+      BrickFTP::API::FileOperation::Move.create(path: path, move_destination: move_destination)
     end
 
     # Copy a file or folder to the destination provided in the copy_destination parameter.
@@ -335,7 +335,7 @@ module BrickFTP
     # @param copy_destination [String]
     # @return [BrickFTP::API::FileCopy]
     def copy_file(path:, copy_destination:)
-      BrickFTP::API::FileCopy.create(path: path, copy_destination: copy_destination)
+      BrickFTP::API::FileOperation::Copy.create(path: path, copy_destination: copy_destination)
     end
 
     # Delete a file.
@@ -352,7 +352,7 @@ module BrickFTP
     # @param source [String] path for source file.
     # @return [BrickFTP::API::FileUpload]
     def upload_file(path:, source:)
-      BrickFTP::API::FileUpload.create(path: path, source: source)
+      BrickFTP::API::FileOperation::Upload.create(path: path, source: source)
     end
   end
 end

data/lib/brick_ftp/http_client.rb

@@ -30,8 +30,8 @@ module BrickFTP
       @conn.use_ssl = true
     end
 
-    def get(path)
-      case res = request(:get, path)
+    def get(path, params: {})
+      case res = request(:get, path, params: params)
       when Net::HTTPSuccess
         res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
       else
@@ -60,8 +60,8 @@ module BrickFTP
       end
     end
 
-    def delete(path)
-      case res = request(:delete, path)
+    def delete(path, params: {})
+      case res = request(:delete, path, params: params)
       when Net::HTTPSuccess
         true
       else

data/lib/brick_ftp/version.rb

@@ -1,3 +1,3 @@
 module BrickFTP
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick_ftp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - koshigoe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,15 +117,16 @@ files:
 - lib/brick_ftp/api/authentication/session.rb
 - lib/brick_ftp/api/base.rb
 - lib/brick_ftp/api/behavior.rb
-- lib/brick_ftp/api/behavior_folder.rb
 - lib/brick_ftp/api/bundle.rb
 - lib/brick_ftp/api/bundle_content.rb
 - lib/brick_ftp/api/bundle_download.rb
 - lib/brick_ftp/api/file.rb
-- lib/brick_ftp/api/file_copy.rb
-- lib/brick_ftp/api/file_move.rb
-- lib/brick_ftp/api/file_upload.rb
+- lib/brick_ftp/api/file_operation.rb
+- lib/brick_ftp/api/file_operation/copy.rb
+- lib/brick_ftp/api/file_operation/move.rb
+- lib/brick_ftp/api/file_operation/upload.rb
 - lib/brick_ftp/api/folder.rb
+- lib/brick_ftp/api/folder_behavior.rb
 - lib/brick_ftp/api/group.rb
 - lib/brick_ftp/api/history.rb
 - lib/brick_ftp/api/history/file.rb
@@ -137,6 +138,8 @@ files:
 - lib/brick_ftp/api/permission.rb
 - lib/brick_ftp/api/public_key.rb
 - lib/brick_ftp/api/user.rb
+- lib/brick_ftp/api_component.rb
+- lib/brick_ftp/api_definition.rb
 - lib/brick_ftp/client.rb
 - lib/brick_ftp/configuration.rb
 - lib/brick_ftp/http_client.rb

data/lib/brick_ftp/api/behavior_folder.rb

@@ -1,8 +0,0 @@
-module BrickFTP
-  module API
-    class BehaviorFolder < Base
-      define_api :index, '/api/rest/v1/behaviors/folders/%{path}'
-      define_readonly_attributes :id, :path, :behavior, :value
-    end
-  end
-end

data/lib/brick_ftp/api/file_copy.rb

@@ -1,8 +0,0 @@
-module BrickFTP
-  module API
-    class FileCopy < Base
-      define_api :create, '/api/rest/v1/files/%{path}'
-      define_writable_attributes :'copy-destination'
-    end
-  end
-end

data/lib/brick_ftp/api/file_move.rb

@@ -1,8 +0,0 @@
-module BrickFTP
-  module API
-    class FileMove < Base
-      define_api :create, '/api/rest/v1/files/%{path}'
-      define_writable_attributes :'move-destination'
-    end
-  end
-end

data/lib/brick_ftp/api/file_upload.rb

@@ -1,43 +0,0 @@
-module BrickFTP
-  module API
-    class FileUpload < Base
-      define_api :create, '/api/rest/v1/files/%{path}'
-      define_writable_attributes :action, :ref, :part, :restart
-      define_readonly_attributes :id,
-                                 :ref,
-                                 :http_method,
-                                 :upload_uri,
-                                 :partsize,
-                                 :part_number,
-                                 :available_parts,
-                                 :headers,
-                                 :parameters,
-                                 :send,
-                                 :path,
-                                 :action,
-                                 :ask_about_overwrites,
-                                 :type,
-                                 :size,
-                                 :mtime,
-                                 :crc32,
-                                 :md5,
-                                 :expires,
-                                 :next_partsize,
-                                 :provided_mtime,
-                                 :permissions
-
-      def self.create(path: , source:)
-        api_client = BrickFTP::HTTPClient.new
-        step1 = api_client.post(api_path_for(:create, path: path), params: { action: 'put' })
-
-        upload_uri = URI.parse(step1['upload_uri'])
-        upload_client = BrickFTP::HTTPClient.new(upload_uri.host)
-        upload_client.put(step1['upload_uri'], params: source)
-
-        step3 = api_client.post(api_path_for(:create, path: path), params: { action: 'end', ref: step1['ref'] })
-
-        new(step1.merge(step3).symbolize_keys)
-      end
-    end
-  end
-end