jpsclient 2.4.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5d9e62e89905a9d9f823e61ecc544ae6d621fd41d487f85a56b745850fcfbc0
-  data.tar.gz: 217da60adbfda9012c883bdb55b2e75ab88fca6c3f98e45951ed498e98649e62
+  metadata.gz: 4c96b5ac6d4cc1926b3ed272182eb162381f858180369c2c1c0a119937ce1dc4
+  data.tar.gz: 1ff46ef1dbc14c78ebc34eafa722402299d51f5685f4b949256c533690c4883e
 SHA512:
-  metadata.gz: e648f436a6b0e9b96fd6c147867e65fd4bee8efb6a57bb4ab508a260fb65a47981c6a111479413072cad41a82620073b381fda713aad992986d4fa4139160efb
-  data.tar.gz: 577fbb50f84370446b01afd9adfa5ac11e4cde0253ce94c0194accecc5c639fa1e3aecfcd0996127bb3525d337608c742d67bc80b5644be6e693667bc5e0cf78
+  metadata.gz: b042d80d7475b6d3477ba406a52343899e8557270db0de0845304a4d9c8a88326be30fa2eb61d345401b0746cda2413e19e088806facfceeca7535437f120401
+  data.tar.gz: e0ad15a3b46d560381c4b51330dc599eabb2a46b00fa1de50428f0c30458fdedc09bcd2d3d403bf9a26eff14a31e9c56d0480f8b510acadb0f504931ef073d72

data/lib/jpsclient/api/bug.rb

@@ -81,6 +81,32 @@ module JPSClient
 
         return request_with_auth(:get, path, params: params)
       end
+
+      # 下发 bug 列表筛选字段
+      #
+      # @param params [Hash] 请求参数（FieldsOptionsDto: sourceId, sourceType）
+      # @return [Hash] API响应
+      def get_filter_options(params: {})
+        config = @request_config && @request_config["bug_filter_options"]
+        raise JPSClient::ExceptionError, "Missing config for bug_filter_options" unless config && config["url"]
+
+        path = config["url"]
+
+        return request_with_auth(:get, path, params: params)
+      end
+
+      # 个人 bug 统计
+      #
+      # @param params [Hash] 请求参数（ProjectBugStatisticDto: larkUserIds 等）
+      # @return [Hash] API响应
+      def get_statistics(params: {})
+        config = @request_config && @request_config["bug_statistics"]
+        raise JPSClient::ExceptionError, "Missing config for bug_statistics" unless config && config["url"]
+
+        path = config["url"]
+
+        return request_with_auth(:get, path, params: params)
+      end
     end
   end
 end

data/lib/jpsclient/api/category.rb

@@ -1,15 +1,13 @@
 module JPSClient
   module API
     # Category 相关 API
-    # 处理通用分类管理相关接口
+    # 通用分类管理接口 (/api/category，分类 controller)
     module Category
 
-      # 获取分类列表
+      # 分类列表
       #
-      # @param params [Hash] 查询参数
-      #   - type: 分类类型（可选）
-      #   - parent_id: 父分类ID（可选）
-      # @return [Hash] API响应
+      # @param params [Hash] CategoryListDto: type（分类类型）, platforms（平台，可多个）
+      # @return [Hash] API响应，data: { list: [Category], count }
       def get_category_list(params: {})
         config = @request_config && @request_config["category_list"]
         raise JPSClient::ExceptionError, "Missing config for category_list" unless config && config["url"]
@@ -19,12 +17,10 @@ module JPSClient
         return request_with_auth(:get, path, params: params)
       end
 
-      # 获取分类树形结构
+      # 分类树
       #
-      # @param params [Hash] 查询参数
-      #   - type: 分类类型（可选）
-      #   - max_level: 最大层级深度（可选）
-      # @return [Hash] API响应，包含树形结构数据
+      # @param params [Hash] CategoryListDto: type（分类类型）, platforms（平台，可多个）
+      # @return [Hash] API响应，data: [CategoryTreeVo]
       def get_category_tree(params: {})
         config = @request_config && @request_config["category_tree"]
         raise JPSClient::ExceptionError, "Missing config for category_tree" unless config && config["url"]
@@ -36,29 +32,12 @@ module JPSClient
 
       # 创建分类
       #
-      # @param params [Hash] 分类信息参数
-      #   - name: 分类名称（必需）
-      #   - type: 分类类型（必需）
-      #   - parent_id: 父分类ID（可选，根分类不需要）
-      #   - icon: 分类图标（可选）
-      #   - description: 分类描述（可选）
-      #   - sort_order: 排序值（可选，默认1）
-      # @return [Hash] API响应
+      # @param params [Hash] CategoryCreateDto: type*, name*, parentId, priority, description, medias, platform
+      # @return [Hash] API响应，data: Category
       def create_category(params: {})
         config = @request_config && @request_config["category_create"]
         raise JPSClient::ExceptionError, "Missing config for category_create" unless config && config["url"]
 
-        # 参数验证
-        required_fields = [:name, :type]
-        missing_fields = required_fields.select { |field| params[field].nil? || params[field].to_s.empty? }
-
-        if missing_fields.any?
-          raise JPSClient::ExceptionError, "Missing required fields: #{missing_fields.join(', ')}"
-        end
-
-        # 设置默认值
-        params[:sort_order] ||= 1
-
         path = config["url"]
 
         return request_with_auth(:post, path, body: params)
@@ -66,21 +45,12 @@ module JPSClient
 
       # 更新分类
       #
-      # @param params [Hash] 更新参数
-      #   - id: 分类ID（必需）
-      #   - name: 分类名称
-      #   - icon: 分类图标
-      #   - description: 分类描述
-      #   - sort_order: 排序值
-      #   - status: 分类状态（1:启用, 0:停用）
-      # @return [Hash] API响应
+      # @param params [Hash] CategoryUpdateDto: id*, parentId, priority, name, weight, medias, description
+      # @return [Hash] API响应，data: Category
       def update_category(params: {})
         config = @request_config && @request_config["category_update"]
         raise JPSClient::ExceptionError, "Missing config for category_update" unless config && config["url"]
 
-        # ID 是必需的
-        raise JPSClient::ExceptionError, "Missing required field: id" unless params[:id]
-
         path = config["url"]
 
         return request_with_auth(:post, path, body: params)
@@ -88,190 +58,30 @@ module JPSClient
 
       # 删除分类
       #
-      # @param id [String, Integer] 分类ID（必需）
+      # @param params [Hash] BaseIdDtoInteger: id*
       # @return [Hash] API响应
-      def delete_category(id:)
+      def delete_category(params: {})
         config = @request_config && @request_config["category_delete"]
         raise JPSClient::ExceptionError, "Missing config for category_delete" unless config && config["url"]
 
         path = config["url"]
 
-        # POST请求，ID作为body参数
-        params = { id: id }
-
         return request_with_auth(:post, path, body: params)
       end
 
       # 分类排序
       #
-      # @param items [Array<Hash>] 排序项数组
-      #   每个项包含：
-      #   - id: 分类ID
-      #   - sort_order: 新的排序值
+      # @param params [Array] CategorySortDto 数组，每项: id*, weight*, parentId（前端以裸数组体提交）
       # @return [Hash] API响应
-      def sort_categories(items: [])
+      def sort_categories(params: [])
         config = @request_config && @request_config["category_sort"]
         raise JPSClient::ExceptionError, "Missing config for category_sort" unless config && config["url"]
 
-        if items.empty?
-          raise JPSClient::ExceptionError, "Items array cannot be empty"
-        end
-
-        # 验证每个项都有必需的字段
-        items.each_with_index do |item, index|
-          unless item[:id] || item["id"]
-            raise JPSClient::ExceptionError, "Item at index #{index} missing 'id'"
-          end
-          unless item[:sort_order] || item["sort_order"]
-            raise JPSClient::ExceptionError, "Item at index #{index} missing 'sort_order'"
-          end
-        end
-
         path = config["url"]
-        params = { items: items }
 
         return request_with_auth(:post, path, body: params)
       end
 
-      # 按类型获取分类列表（便捷方法）
-      #
-      # @param type [String] 分类类型
-      #   - application: 应用分类
-      #   - resource: 资源分类
-      #   - asset: 素材分类
-      #   - requirement: 需求分类
-      #   - sketch: 画板分类
-      #   - tool: 工具分类
-      #   - survey: 调研分类
-      #   - publisher: 发行商分类
-      #   - experience: 体验分类
-      # @param parent_id [String, Integer, nil] 父分类ID
-      # @return [Hash] API响应
-      def get_categories_by_type(type:, parent_id: nil)
-        params = { type: type }
-        params[:parent_id] = parent_id if parent_id
-        get_category_list(params: params)
-      end
-
-      # 获取某分类的所有子分类
-      #
-      # @param parent_id [String, Integer] 父分类ID
-      # @return [Hash] API响应
-      def get_subcategories(parent_id:)
-        get_category_list(params: { parent_id: parent_id })
-      end
-
-      # 获取根分类列表
-      #
-      # @param type [String, nil] 分类类型（可选）
-      # @return [Hash] API响应
-      def get_root_categories(type: nil)
-        params = { parent_id: 0 }  # parent_id 为 0 或 null 表示根分类
-        params[:type] = type if type
-        get_category_list(params: params)
-      end
-
-      # 批量创建分类
-      # 注意：此方法会逐个调用 API，返回结果数组
-      #
-      # @param categories [Array<Hash>] 分类数组
-      # @return [Array<Hash>] 每个请求的响应结果
-      def batch_create_categories(categories: [])
-        return [] if categories.empty?
-
-        results = []
-        categories.each do |category_params|
-          result = create_category(params: category_params)
-          results << result
-        end
-
-        results
-      end
-
-      # 移动分类到新的父分类
-      #
-      # @param category_id [String, Integer] 要移动的分类ID
-      # @param new_parent_id [String, Integer, nil] 新的父分类ID（nil表示移到根级）
-      # @return [Hash] API响应
-      def move_category(category_id:, new_parent_id: nil)
-        params = {
-          id: category_id,
-          parent_id: new_parent_id || 0
-        }
-        update_category(params: params)
-      end
-
-      # 启用分类
-      #
-      # @param category_id [String, Integer] 分类ID
-      # @return [Hash] API响应
-      def enable_category(category_id:)
-        update_category(params: { id: category_id, status: 1 })
-      end
-
-      # 停用分类
-      #
-      # @param category_id [String, Integer] 分类ID
-      # @return [Hash] API响应
-      def disable_category(category_id:)
-        update_category(params: { id: category_id, status: 0 })
-      end
-
-      # 构建分类路径
-      # 根据分类ID获取从根到该分类的完整路径
-      #
-      # @param category_id [String, Integer] 分类ID
-      # @return [Array<Hash>] 分类路径数组，从根到目标分类
-      def get_category_path(category_id:)
-        response = get_category_list
-
-        # 如果请求失败，返回空数组
-        return [] unless response && response['data']
-
-        categories = response['data']['list'] || response['data'][:list] || []
-        path = []
-
-        current_id = category_id.to_s
-        while current_id
-          category = categories.find { |c|
-            (c['id'] || c[:id]).to_s == current_id
-          }
-          break unless category
-
-          path.unshift(category)
-          current_id = (category['parent_id'] || category[:parent_id])&.to_s
-          break if current_id == "0" || current_id.nil?
-        end
-
-        path
-      end
-
-      # 获取分类统计信息
-      # 统计某个分类下的直接子分类数量
-      #
-      # @param category_id [String, Integer] 分类ID
-      # @return [Hash] 包含统计数据的哈希
-      def get_category_statistics(category_id:)
-        response = get_subcategories(parent_id: category_id)
-
-        # 如果请求失败，返回空统计
-        unless response && response['data']
-          return {
-            category_id: category_id,
-            direct_children_count: 0,
-            children: []
-          }
-        end
-
-        child_list = response['data']['list'] || response['data'][:list] || []
-
-        {
-          category_id: category_id,
-          direct_children_count: child_list.size,
-          children: child_list
-        }
-      end
-
     end
   end
-end
+end

data/lib/jpsclient/api/lark_task.rb

@@ -81,6 +81,77 @@ module JPSClient
 
         return request_with_auth(:get, path, params: params)
       end
+
+      # 获取有飞书任务的 app 列表
+      #
+      # @param params [Hash] 请求参数（LarkTaskAppsDto: keyword, larkUserId）
+      # @return [Hash] API响应
+      def get_apps(params: {})
+        config = @request_config && @request_config["lark_task_apps"]
+        raise JPSClient::ExceptionError, "Missing config for lark_task_apps" unless config && config["url"]
+
+        path = config["url"]
+
+        return request_with_auth(:get, path, params: params)
+      end
+
+      # 查询当前用户完成的任务和 Bug
+      #
+      # spec 标注 startTime / endTime 均为 required（int64 毫秒时间戳）。
+      #
+      # @return [Hash] API响应
+      def get_completed_items(start_time: nil, end_time: nil, params: {})
+        config = @request_config && @request_config["lark_task_completed_items"]
+        raise JPSClient::ExceptionError, "Missing config for lark_task_completed_items" unless config && config["url"]
+
+        path = config["url"]
+
+        # TODO(human): 决定如何把 start_time/end_time 与 params 合并成最终的 query
+        # 候选策略见对话中的 Learn by Doing 说明，最终需要返回一个能直接交给
+        # request_with_auth(:get, path, params: ...) 的 Hash。
+        query = nil
+
+        return request_with_auth(:get, path, params: query)
+      end
+
+      # 任务字段列表
+      #
+      # @param params [Hash] 请求参数（spec 未声明字段，预留以保持调用风格统一）
+      # @return [Hash] API响应
+      def get_fields(params: {})
+        config = @request_config && @request_config["lark_task_fields"]
+        raise JPSClient::ExceptionError, "Missing config for lark_task_fields" unless config && config["url"]
+
+        path = config["url"]
+
+        return request_with_auth(:get, path, params: params)
+      end
+
+      # 下发 task 列表筛选字段
+      #
+      # @param params [Hash] 请求参数（FieldsOptionsDto: sourceId, sourceType）
+      # @return [Hash] API响应
+      def get_filter_options(params: {})
+        config = @request_config && @request_config["lark_task_filter_options"]
+        raise JPSClient::ExceptionError, "Missing config for lark_task_filter_options" unless config && config["url"]
+
+        path = config["url"]
+
+        return request_with_auth(:get, path, params: params)
+      end
+
+      # 个人任务统计
+      #
+      # @param params [Hash] 请求参数（ProjectTaskStatisticDto: larkUserIds 等）
+      # @return [Hash] API响应
+      def get_statistics(params: {})
+        config = @request_config && @request_config["lark_task_statistics"]
+        raise JPSClient::ExceptionError, "Missing config for lark_task_statistics" unless config && config["url"]
+
+        path = config["url"]
+
+        return request_with_auth(:get, path, params: params)
+      end
     end
   end
 end