Communitygithub.com

Integración CI de AppFolio

Configura pipelines de CI/CD para integraciones con AppFolio de gestión de propiedades.

¿Qué es Integración CI de AppFolio?

Esta habilidad configura un pipeline de CI/CD en GitHub Actions para validar integraciones con la API de AppFolio de gestión de propiedades sin consumir cuota de API en solicitudes de pull. Utiliza una estrategia de dos niveles: pruebas unitarias con mocks del cliente REST de AppFolio para verificar la lógica de búsqueda de inquilinos, creación de órdenes de trabajo y listado de propiedades, y pruebas de integración en el entorno sandbox de AppFolio solo en fusiones a la rama main. Las credenciales Basic Auth se almacenan como secretos de GitHub para evitar exposiciones. El pipeline incluye control de presupuesto de solicitudes, manejo de errores para credenciales expiradas, límites de tasa y datos de sandbox restablecidos, y proporciona una decisión de lanzamiento bloqueada en caso de fallos. Soporta GitHub Actions con Node.js, y los ejemplos de código cubren tanto pruebas unitarias con mocks (Vitest) como pruebas de integración reales contra el sandbox, además de un helper para rastrear el consumo de API.

Compatible con✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/jeremylongshore/tons-of-skills-marketplace/tree/HEAD/plugins/saas-packs/appfolio-pack/skills/appfolio-ci-integration

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

¿Qué hace Integración CI de AppFolio?

Descripción general

Configura pipelines de CI que validan integraciones con la API de AppFolio para gestión de propiedades utilizando una estrategia de dos niveles. Las pruebas unitarias simulan el cliente REST de AppFolio para verificar la lógica de búsqueda de inquilinos, creación de órdenes de trabajo y listado de propiedades sin consumir cuota de API. Las pruebas de integración se ejecutan contra el entorno sandbox de AppFolio solo en fusiones a la rama main, utilizando credenciales Basic Auth almacenadas como secretos de GitHub. Esto mantiene la retroalimentación de las PR rápida y gratuita mientras detecta cambios en el contrato de la API antes de los despliegues a producción.

Prerrequisitos

  • Un repositorio con Actions habilitado, una instalación de dependencias bloqueada y pruebas unitarias que utilicen únicamente fixtures sintéticos de inquilinos, propiedades y órdenes de trabajo.
  • Una credencial de sandbox de AppFolio administrada por separado y un registro fixture preaprovisionado y no productivo que el propietario de la integración esté autorizado a leer.
  • Propietario de CI definido, un presupuesto de solicitudes fijo y una ruta de incidentes para rotación de credenciales, interrupción del proveedor o restablecimiento de datos del sandbox.

Instrucciones

  1. Mantén las verificaciones de solicitudes de pull solo con mocks; no expongas las credenciales de AppFolio a código no confiable ni a solicitudes de pull bifurcadas.
  2. Bloquea el trabajo de sandbox en vivo solo para pushes a main protegida después de que lint, tipo y pruebas unitarias pasen, e inyecta credenciales únicamente a través de secretos del repositorio.
  3. Limita la ejecución de integración a un fixture conocido de solo lectura, un trabajador y el presupuesto de solicitudes indicado; registra solo evidencia de estado y recuento enmascarados.
  4. Trata la autenticación fallida, los límites de tasa o los fixtures faltantes como una condición de lanzamiento bloqueada en lugar de crear datos de sandbox compartidos desde CI.

Flujo de trabajo de GitHub Actions

# .github/workflows/appfolio-tests.yml
name: Pruebas de API de AppFolio
on: [push, pull_request]

jobs:
  unit-tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: { node-version: '20' }
      - run: npm ci
      - run: npm run lint && npm run typecheck
      - run: npm test -- --testPathPattern=unit  # No se necesitan credenciales de API

  integration-tests:
    runs-on: ubuntu-latest
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    needs: unit-tests
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: { node-version: '20' }
      - run: npm ci
      - run: npm test -- --testPathPattern=integration
        env:
          APPFOLIO_CLIENT_ID: ${{ secrets.APPFOLIO_CLIENT_ID }}
          APPFOLIO_CLIENT_SECRET: ${{ secrets.APPFOLIO_CLIENT_SECRET }}
          APPFOLIO_BASE_URL: ${{ secrets.APPFOLIO_SANDBOX_URL }}

Pruebas unitarias con mocks

// tests/unit/work-order-service.test.ts
import { describe, it, expect, vi } from 'vitest';
import { createWorkOrder } from '../../src/services/work-order-service';
import * as appfolioClient from '../../src/lib/appfolio-client';

vi.mock('../../src/lib/appfolio-client');

describe('WorkOrderService', () => {
  it('crea una orden de trabajo de mantenimiento para una propiedad', async () => {
    vi.mocked(appfolioClient.post).mockResolvedValue({
      id: 'wo-4821',
      property_id: 'prop-100',
      category: 'Plumbing',
      status: 'Open',
    });

    const result = await createWorkOrder('prop-100', 'Plumbing', 'Leaking faucet unit 3B');
    expect(result.status).toBe('Open');
    expect(appfolioClient.post).toHaveBeenCalledWith('/work_orders', {
      property_id: 'prop-100',
      category: 'Plumbing',
      description: 'Leaking faucet unit 3B',
    });
  });
});

Pruebas de integración

// tests/integration/tenant-lookup.test.ts
import { describe, it, expect } from 'vitest';
import { AppFolioClient } from '../../src/lib/appfolio-client';

const canRun = process.env.APPFOLIO_CLIENT_ID && process.env.APPFOLIO_CLIENT_SECRET;

describe.skipIf(!canRun)('Búsqueda de inquilino de AppFolio (sandbox en vivo)', () => {
  const client = new AppFolioClient({
    clientId: process.env.APPFOLIO_CLIENT_ID!,
    clientSecret: process.env.APPFOLIO_CLIENT_SECRET!,
    baseUrl: process.env.APPFOLIO_BASE_URL!,
  });

  it('lista inquilinos para una propiedad conocida', async () => {
    const tenants = await client.get('/tenants', { property_id: 'prop-100' });
    expect(Array.isArray(tenants)).toBe(true);
    expect(tenants[0]).toHaveProperty('lease_status');
  });
});

Gestión de costos de CI

// tests/helpers/api-budget.ts
let callCount = 0;
const MAX_CALLS_PER_RUN = 25; // El sandbox de AppFolio tiene un límite de 100 req/min

export function trackApiCall(): void {
  callCount++;
  if (callCount > MAX_CALLS_PER_RUN) {
    throw new Error(
      `Presupuesto de API de CI excedido: ${callCount}/${MAX_CALLS_PER_RUN} llamadas. ` +
      'Reduce el alcance de las pruebas de integración o divídelo entre trabajos.'
    );
  }
}

export function getCallCount(): number { return callCount; }

Manejo de errores

Problema de CICausaSolución
401 No autorizado en trabajo de integraciónCredenciales de sandbox expiradas o rotadasRegenera APPFOLIO_CLIENT_ID y APPFOLIO_CLIENT_SECRET en los Secretos de GitHub
429 Demasiadas solicitudesLímite de tasa del sandbox (100 req/min) alcanzado por pruebas paralelasEjecuta pruebas de integración con --maxWorkers=1
Lista de inquilinos vacíaDatos del sandbox restablecidos periódicamente por AppFolioDetén el trabajo y restaura el fixture preaprovisionado fuera de CI
Fallo de tipo en respuesta de APIEsquema de AppFolio actualizado sin previo avisoRegenera tipos desde la especificación OpenAPI, actualiza interfaces
Trabajo de integración omitidoRegla de protección de rama no coincide con refs/heads/mainVerifica que la condición if del flujo de trabajo coincida con el nombre de tu rama por defecto

Salida

  • Resultados de solicitudes de pull de verificaciones mock-only de lint, tipo y pruebas unitarias
  • Un recibo de sandbox de rama protegida con el estado del proveedor enmascarado, identidad del fixture, recuento de solicitudes y resultado de la prueba de integración
  • Una decisión de lanzamiento acotada que se bloquea en caso de credenciales no disponibles, errores del proveedor, desviación del fixture o agotamiento del presupuesto de solicitudes

Ejemplos

Para un cambio en el mapeo de órdenes de trabajo, agrega una respuesta sintética simulada y verifica el nuevo campo en el conjunto de pruebas de la PR. Después de la fusión, el flujo de trabajo protegido de main lee una orden de trabajo sandbox preaprovisionada y confirma la forma normalizada sin crear inquilinos, propiedades ni órdenes de trabajo. Si el fixture no está disponible, la credencial falla o se excede el presupuesto de solicitudes, marca el lanzamiento como bloqueado y haz que el propietario del sandbox restaure el fixture o la credencial antes de reejecutar el carril en vivo.

Recursos

Próximos pasos

Consulta appfolio-deploy-integration.

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

jeremylongshore/tons-of-skills-marketplace

Use when asked to structure a landing page for positioning, plan a conversion-optimized page layout, or design a launch page. Examples: "landing page for product launch", "conversion-optimized layout for SaaS

jeremylongshore/tons-of-skills-marketplace

Use when asked to design growth-optimized landing pages, activation funnel layouts, or experiment-friendly page structures. Examples: "growth-optimized landing", "activation funnel layout", "A/B testable page

jeremylongshore/tons-of-skills-marketplace

Use when asked to structure a landing page, design page layout for conversion, or plan landing page information architecture. Examples: "landing page structure for SaaS", "conversion-optimized layout

jeremylongshore/tons-of-skills-marketplace

Generate polished demo videos from a single prompt. Use when the user asks to create a demo video, product walkthrough, feature showcase, or animated presentation. Trigger with "make a demo video", "create a product video", "demo walkthrough", or "feature showcase video".

jeremylongshore/tons-of-skills-marketplace

Track cryptocurrency portfolio with real-time valuations, allocation analysis, and P&L tracking. Use when checking portfolio value, viewing holdings breakdown, analyzing allocations, or exporting portfolio data. Trigger with phrases like "show my portfolio", "check crypto holdings", "portfolio allocation", "track my crypto", or "export portfolio".

jeremylongshore/tons-of-skills-marketplace

Runs the full release workflow for the current project. Commits any uncommitted changes, pushes to remote, creates and merges a PR if on a feature branch, determines the next semver version from conventional commits, creates an annotated git tag and GitHub release with generated notes, cleans up merged branches, and returns to a clean main. Use when the user says promote, ship, release, commit and push, tag and release, or get back to main.

jeremylongshore/tons-of-skills-marketplace

Agent skill at plugins/productivity/content-multiplier/skills/channel-formats/SKILL.md

jeremylongshore/tons-of-skills-marketplace

Operate an evidence-backed editorial queue, balance topic and format coverage, schedule approved drafts, and reconcile backlog state with the publishing system. Use when choosing or scheduling the next blog work. Trigger with "show the editorial calendar" or "pick the next topic".

jeremylongshore/tons-of-skills-marketplace

Diagnose and fix common AppFolio API integration errors. Trigger: "appfolio error".

jeremylongshore/tons-of-skills-marketplace

Build property management dashboard with AppFolio API data. Trigger: "appfolio property dashboard".

jeremylongshore/tons-of-skills-marketplace

Automate tenant management and lease operations with AppFolio. Trigger: "appfolio tenant management".

jeremylongshore/tons-of-skills-marketplace

Collect AppFolio API debug evidence for support tickets. Trigger: "appfolio debug".

jeremylongshore/tons-of-skills-marketplace

Deploy AppFolio integration service to cloud infrastructure. Trigger: "deploy appfolio".

jeremylongshore/tons-of-skills-marketplace

Query AppFolio properties, units, and tenants via REST API. Trigger: "appfolio hello world".

jeremylongshore/tons-of-skills-marketplace

Configure AppFolio Stack API authentication with OAuth 2.0. Use when setting up property management API access, registering as an AppFolio Stack partner, or configuring client credentials for API calls. Trigger: "install appfolio", "setup appfolio", "appfolio auth", "appfolio API key".

jeremylongshore/tons-of-skills-marketplace

Set up local development for AppFolio property management API integration. Trigger: "appfolio local dev".

jeremylongshore/tons-of-skills-marketplace

Production readiness checklist for AppFolio integrations. Trigger: "appfolio production checklist".

jeremylongshore/tons-of-skills-marketplace

Handle AppFolio API rate limits with throttling and backoff. Trigger: "appfolio rate limit".

jeremylongshore/tons-of-skills-marketplace

Reference architecture for AppFolio property management integration. Trigger: "appfolio architecture".

jeremylongshore/tons-of-skills-marketplace

Apply production-ready patterns for AppFolio REST API integration. Trigger: "appfolio patterns".

Skills relacionados