app_store_dev_api 0.1.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c0944be414e92c74620d040bbc9a341bc62be6f71cacd1839a4e669430c17d1
-  data.tar.gz: 5052d1a348ae9bb62b5d7aeeafaa75d708e82e53beeef7e02d0af03309144473
+  metadata.gz: a4b465858ed4f19c0c756e6cd8015c60f3c6d1b1abfc942511358b1812e67c00
+  data.tar.gz: 2c1db48f308133776a4b54bb39c7fbd5c21efdfb5396a65d38154cb9a2de4b6c
 SHA512:
-  metadata.gz: f03d1422226cc10a52ecfd9e05e4b17896bccf2cfaf13c67ea3798899c04c7a7787d5cd7bb4eb7e720b050f0b96becbafa1e27a545462b9c30a30124f32f2bac
-  data.tar.gz: 04e2b88489f202cdb9b2a74c7564a19a2119191a1528b79104b0b41c93912d861e2fd31fdd01176f8727abdce6ca3d2581e6949e67a49bcff07075a2b41a38db
+  metadata.gz: 549b8f18858dea46ffecee88a2c0fe69cd59ace82a6d5e41fba3289c0c2cbdcd5ab848f36339589220d1024c3595f0fc444f8f1e4a95224ee09d3f726eba89e1
+  data.tar.gz: cd2d09150518ca605fc2a2db990627f1e10fa9b3e8a61c5e1174c515727cb4c6bf5e0794565269ff2fdf76a0a35a18beb0429ae7be9a366bf08732f8dbb9754c

data/.claude/settings.local.json

@@ -0,0 +1,40 @@
+{
+  "permissions": {
+    "allow": [
+      "mcp__playwright__browser_navigate",
+      "mcp__playwright__browser_evaluate",
+      "Bash(mkdir:*)",
+      "mcp__markdownify__webpage-to-markdown",
+      "mcp__playwright__browser_wait_for",
+      "mcp__playwright__browser_click",
+      "mcp__playwright__browser_navigate_back",
+      "mcp__playwright__browser_snapshot",
+      "mcp__playwright__browser_close",
+      "mcp__playwright__browser_type",
+      "mcp__playwright__browser_press_key",
+      "Bash(git checkout:*)",
+      "Bash(bundle exec rspec:*)",
+      "Bash(bundle:*)",
+      "Bash(ruby:*)",
+      "Bash(gem install:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "WebSearch",
+      "Bash(cat:*)",
+      "Bash(python3:*)",
+      "Bash(chmod:*)",
+      "Bash(find:*)",
+      "Bash(bash:*)",
+      "Bash(gem list:*)",
+      "Bash(rake help:*)",
+      "Bash(rake validate:*)",
+      "Bash(rake install_local:*)",
+      "Bash(timeout 180 bundle install:*)"
+    ],
+    "deny": [],
+    "ask": [],
+    "additionalDirectories": [
+      "/Users/wade/MyDocument/ScriptCode/pindo"
+    ]
+  }
+}

data/CHANGELOG.md

@@ -1,5 +1,62 @@
+# Changelog
+
+所有对本项目的显著更改都将记录在此文件中。
+
+格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)，
+并且本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
+
 ## [Unreleased]
 
-## [0.1.0] - 2023-04-23
+### Fixed
+- 修复所有 Request 类与 Apple App Store Connect API v4.2 规范的不一致问题
+- 修复 68 个接口的属性和关系命名规范（从下划线命名改为驼峰命名）
+- 修复 `Attributes` 类中布尔值验证bug（false值被误判为缺失）
+- 修复 `Relationships` 类中布尔值验证bug（false值被误判为缺失）
+
+### Changed
+- API 规范一致性从 72.2% 提升到 100%
+- 规范化所有属性和关系命名为驼峰命名（camelCase）
+- 更新所有 Request 类以匹配 OpenAPI v4.2 规范
+
+### Added
+- 新增 160+ 个 Request 类文件（覆盖 API v4.2 新增功能）
+- 新增 `Relationships` 对象类
+- 新增验证工具 `scripts/validate_requests.rb`
+- 新增自动修复工具 `scripts/fix_requests.rb`
+- 新增 Request Body 功能测试
+
+### Technical Details
+
+**修复的主要问题类别：**
+1. **属性命名规范化**（~150处）
+   - `available_in_new_territories` → `availableInNewTerritories`
+   - `contact_email` → `contactEmail`
+   - `whats_new` → `whatsNew`
+
+2. **新增缺失属性**（~80处）
+   - AccessibilityDeclaration: 新增 9个无障碍功能属性
+   - Webhook: 新增 `eventTypes`, `secret`
+   - AgeRatingDeclaration: 新增 12个分级相关属性
+
+3. **移除过时属性**（~70处）
+   - AppEvent: 移除 `eventState`
+   - AppEncryptionDeclaration: 移除 7个过时属性
+
+4. **关系命名规范化**（~20处）
+   - `app_store_version` → `appStoreVersion`
+   - `app_clip_default_experience` → `appClipDefaultExperience`
+
+**影响的文件：**
+- 68 个已存在的 Request 类（修复）
+- 160+ 个新增的 Request 类
+- 2 个核心对象类（Attributes, Relationships）
+- 1 个测试文件
+- 2 个新增工具脚本
+
+**测试结果：**
+- ✅ 所有 Request Body 测试通过 (6/6)
+- ✅ API 一致性验证通过 (241/241)
+
+## [历史版本]
 
-- Initial release
+（以前的版本历史可以在 git log 中查看）

data/CLAUDE.md

@@ -0,0 +1,256 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## 项目概述
+
+AppStoreDevApi 是一个 Ruby gem，提供与 Apple App Store Connect API 交互的客户端库。
+
+**官方 API 文档**: https://developer.apple.com/documentation/appstoreconnectapi
+**当前 API 版本支持**: v1, v2 (需要升级到 v4.0)
+
+## 系统架构详解
+
+### 整体架构设计
+
+```
+┌─────────────────────────────────────────┐
+│         lib/config/schema.json          │  ← 配置层：301个端点定义
+└────────────┬────────────────────────────┘
+             │ 读取
+┌────────────▼────────────────────────────┐
+│      lib/app_store_dev_api/schema.rb    │  ← 解析层：JSON→Ruby对象
+└────────────┬────────────────────────────┘
+             │ 注册
+┌────────────▼────────────────────────────┐
+│    lib/app_store_dev_api/base.rb        │  ← 核心层：动态方法调度
+│    - method_missing                      │
+│    - JWT 认证 (Authorization)            │
+│    - 端点注册 (Registry)                 │
+└────────────┬────────────────────────────┘
+             │ 调用
+┌────────────▼────────────────────────────┐
+│    lib/app_store_dev_api/requests/      │  ← 请求层：数据结构定义
+│    - v1/ (主要版本)                      │
+│    - v2/ (部分功能)                      │
+└─────────────────────────────────────────┘
+```
+
+### 核心特性：配置驱动的 API 管理
+
+#### 1. JSON 配置文件 (`lib/config/schema.json`)
+
+**当前规模**：
+- 文件大小：1,675 行
+- 端点数量：301 个
+- 支持版本：v1, v2
+
+**配置结构**：
+```json
+{
+  "web_service_endpoints": [
+    {
+      "alias": "create_bundle_id",           // Ruby 方法名
+      "http_method": "post",                 // HTTP 方法
+      "url": "https://api.appstoreconnect.apple.com/v1/bundleIds",
+      "http_body_type": "Requests::V1::BundleId::Create"  // 请求体类（可选）
+    }
+  ]
+}
+```
+
+#### 2. 动态方法生成机制
+
+**工作流程**：
+1. **启动时**：Schema 类读取 JSON 文件，创建 WebServiceEndpoint 对象
+2. **运行时**：Base 类通过 `method_missing` 拦截方法调用
+3. **执行时**：从 Registry 查找端点配置，构建并执行 HTTP 请求
+
+**关键优势**：
+- ✅ 无需手动编写 301 个方法
+- ✅ 统一的错误处理和响应解析
+- ✅ 易于批量更新和维护
+
+#### 3. 请求体管理 (`lib/app_store_dev_api/requests/`)
+
+**目录结构**：
+```
+requests/
+├── v1/                    # API v1 请求类（83个文件）
+│   ├── app/
+│   │   ├── create.rb
+│   │   └── update.rb
+│   ├── bundle_id/
+│   ├── certificate/
+│   └── ...
+└── v2/                    # API v2 请求类（新功能）
+    ├── sandbox_tester/
+    └── in_app_purchase/
+```
+
+**请求类设计模式**：
+```ruby
+module Requests::V1::BundleId
+  class Create < Request::Body
+    data do
+      type 'bundleIds'
+      attributes do
+        property :identifier, required: true
+        property :name, required: true
+        property :platform, required: true
+      end
+    end
+  end
+end
+```
+
+### 认证与安全
+
+#### JWT Token 生成 (`Client::Authorization`)
+- 使用 ES256 算法签名
+- Token 有效期：20 分钟
+- 自动刷新机制
+
+#### 请求头配置
+```ruby
+{
+  'Authorization' => "Bearer #{jwt_token}",
+  'Content-Type' => 'application/json'
+}
+```
+
+### 如何添加新的 API 接口
+
+#### 方式一：添加简单端点（仅 GET/DELETE）
+1. 编辑 `lib/config/schema.json`
+2. 添加端点配置：
+```json
+{
+  "alias": "get_app_info",
+  "http_method": "get",
+  "url": "https://api.appstoreconnect.apple.com/v1/apps/{id}"
+}
+```
+3. 无需其他操作，立即可用
+
+#### 方式二：添加复杂端点（需要请求体）
+1. 在 `schema.json` 中添加端点，指定 `http_body_type`
+2. 创建对应的 Request 类：
+```ruby
+# lib/app_store_dev_api/requests/v1/webhook/create.rb
+module Requests::V1::Webhook
+  class Create < Request::Body
+    data do
+      type 'webhooks'
+      attributes do
+        property :url, required: true
+        property :events, required: true
+      end
+    end
+  end
+end
+```
+
+### 当前问题与升级需求
+
+#### API 版本滞后
+- **当前支持**：主要是 API v1.x - v2.x
+- **最新版本**：Apple 已发布 API v4.0
+- **缺失功能**：
+  - Webhooks（事件通知）
+  - Accessibility Declarations（无障碍声明）
+  - Customer Review Summarizations（评论摘要）
+  - Background Assets（后台资源）
+  - TestFlight Feedback（Beta 反馈）
+
+#### 需要更新的端点数量
+- 新增端点：约 25-30 个
+- 更新端点：约 10-15 个
+- 废弃端点：约 5 个
+
+### API 文档映射
+
+生成的每个方法都包含对应的 Apple 官方文档链接，例如：
+- Bundle ID 注册: https://developer.apple.com/documentation/appstoreconnectapi/register_a_new_bundle_id
+- 其他 API: https://developer.apple.com/documentation/appstoreconnectapi
+
+## Key Architecture
+
+### Core Components
+
+1. **Client System** (`lib/app_store_dev_api/client.rb`, `lib/app_store_dev_api/base.rb`)
+   - `Base` class handles HTTP requests, JWT authorization, and response decoding
+   - `Client` class contains generated methods for each API endpoint
+   - Uses `Client::Authorization` for JWT token generation
+   - Uses `Client::Registry` for endpoint management
+
+2. **Request Objects** (`lib/app_store_dev_api/requests/`)
+   - Organized by API version (v1, v2)
+   - Each request type has its own class with data structure definitions
+   - Uses builder pattern for request creation
+
+3. **Schema System** (`lib/app_store_dev_api/schema.rb`)
+   - Defines API endpoints and their configurations
+   - Used for code generation and runtime request handling
+
+4. **Object Model** (`lib/app_store_dev_api/object/`)
+   - Provides base classes for API data objects
+   - Handles attributes, relationships, and data type definitions
+
+## Development Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Open interactive console with the gem loaded
+bin/console
+
+# Build the gem
+bundle exec rake build
+
+# Install gem locally
+bundle exec rake install
+
+# Release new version (creates git tag and pushes to RubyGems)
+bundle exec rake release
+
+# Run linter (RuboCop)
+bundle exec rubocop
+
+# Generate changelog
+bundle exec rake changelog
+
+# 重新生成 Client 类（添加新 API 后）
+ruby -r ./lib/app_store_dev_api/client/builder.rb -e "AppStoreDevApi::Client::Builder.new.write"
+```
+
+## Version Management
+
+- Version is defined in `lib/app_store_dev_api/version.rb`
+- To release: update VERSION constant, then run `bundle exec rake release`
+
+## Code Generation
+
+This project uses generated code (see "WARNING ABOUT GENERATED CODE" comments). The `Client` class and request classes are generated based on Apple's API documentation.
+
+## Dependencies
+
+- **zeitwerk**: Autoloading
+- **activesupport**: Ruby extensions
+- **jwt**: JWT token generation for Apple API authentication
+
+## API 参考资源
+
+- **官方文档主页**: https://developer.apple.com/documentation/appstoreconnectapi
+- **REST API 规范**: 遵循 JSON API 规范
+- **认证方式**: JWT Bearer Token
+- **基础 URL**: https://api.appstoreconnect.apple.com
+
+## Network Request Rules
+
+### Proxy Configuration
+- Claude-related requests: Use environment proxy settings
+- Non-Claude requests (e.g., Apple API calls): Direct connection without proxy
+  - Use `--noproxy "*"` for curl
+  - Use `proxies={'http': None, 'https': None}` for Python requests

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    app_store_dev_api (0.1.3)
-      activesupport (>= 6.0.0)
-      jwt (>= 1.4)
-      zeitwerk (>= 2.6.7)
+    app_store_dev_api (0.2.0)
+      activesupport (~> 7.0)
+      jwt (~> 2.0, >= 2.0.0)
+      zeitwerk (~> 2.6)
 
 GEM
   remote: https://rubygems.org/
@@ -16,7 +16,7 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
+    ast (2.4.3)
     async (2.5.0)
       console (~> 1.10)
       io-event (~> 1.1)
@@ -36,6 +36,7 @@ GEM
       async
     async-pool (0.4.0)
       async (>= 1.25)
+    base64 (0.1.2)
     cgi (0.3.6)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
@@ -85,8 +86,9 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     io-event (1.1.7)
-    json (2.6.3)
+    json (2.14.1)
     jwt (2.7.0)
+    language_server-protocol (3.17.0.5)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -101,9 +103,11 @@ GEM
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
-    parallel (1.23.0)
-    parser (3.2.2.1)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.5.1)
     protocol-hpack (1.4.2)
     protocol-http (0.24.1)
     protocol-http1 (0.15.0)
@@ -115,12 +119,13 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.8.0)
+    regexp_parser (2.11.3)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -135,18 +140,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.47.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
@@ -162,12 +170,12 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     thor (1.2.1)
-    timecop (0.9.6)
+    timecop (0.9.10)
     timers (4.3.5)
     traces (0.9.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.6.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -175,11 +183,12 @@ GEM
     zeitwerk (2.6.7)
 
 PLATFORMS
+  arm64-darwin-24
   x86_64-darwin-22
 
 DEPENDENCIES
   app_store_dev_api!
-  bundler
+  bundler (~> 2.4, >= 2.4.0)
   erb (~> 4.0.2)
   factory_bot (~> 6.2.1)
   github_changelog_generator (= 1.16.4)
@@ -187,11 +196,11 @@ DEPENDENCIES
   pry (~> 0.14.1)
   rake (~> 13.0)
   rspec (~> 3.12.0)
-  rubocop (~> 1.50.1)
-  rubyzip
+  rubocop (~> 1.56.4)
+  rubyzip (~> 2.3)
   semantic (~> 1.6.1)
   simplecov (~> 0.22.0)
-  timecop (~> 0.9.5)
+  timecop (~> 0.9.8)
   webmock (~> 3.18.1)
 
 BUNDLED WITH