Communitygithub.com

jeremylongshore/tons-of-skills-marketplace

Configure pipeline CI/CD para integrações com o sistema de gestão de propriedades AppFolio.

O que é tons-of-skills-marketplace?

Esta skill configura pipelines de CI/CD que validam integrações com a API de gestão de propriedades AppFolio usando uma estratégia de dois níveis. Testes de unidade simulam o cliente REST do AppFolio para verificar a lógica de consulta de inquilinos, criação de ordens de serviço e listagem de propriedades sem consumir cota de API. Testes de integração são executados contra o ambiente sandbox do AppFolio apenas em merges na branch principal, usando credenciais de autenticação básica armazenadas como segredos do GitHub. Essa abordagem mantém o feedback de PRs rápido e gratuito, enquanto captura desvios reais no contrato da API antes dos deploys em produção. A skill fornece workflows prontos do GitHub Actions, exemplos de código para testes de unidade e integração, gerenciamento de custos de API e tratamento de erros para problemas comuns como credenciais expiradas, limites de taxa e dados de sandbox redefinidos.

Funciona com✓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

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

Integração CI AppFolio

Visão Geral

Configure pipelines de CI que validam integrações com a API de gestão de propriedades AppFolio usando uma estratégia de dois níveis. Testes de unidade simulam o cliente REST do AppFolio para verificar a lógica de consulta de inquilinos, criação de ordens de serviço e listagem de propriedades sem consumir cota de API. Testes de integração são executados contra o ambiente sandbox do AppFolio apenas em merges na branch principal, usando credenciais de autenticação básica armazenadas como segredos do GitHub. Isso mantém o feedback de PRs rápido e gratuito enquanto captura desvios reais no contrato da API antes dos deploys em produção.

Pré-requisitos

  • Um repositório com Actions habilitadas, instalação de dependências travada e testes de unidade que usam apenas fixtures sintéticas de inquilinos, propriedades e ordens de serviço.
  • Uma credencial de sandbox AppFolio gerenciada separadamente e um registro de fixture não produtivo pré-provisionado que o proprietário da integração tenha permissão para ler.
  • Propriedade de CI definida, um orçamento de requisições fixo e um caminho de incidente para rotação de credenciais, indisponibilidade do provedor ou redefinição de dados do sandbox.

Instruções

  1. Mantenha as verificações de pull-request apenas com mocks; não exponha credenciais AppFolio a código não confiável ou pull requests bifurcados.
  2. Proteja o job do sandbox ao vivo para pushes protegidos na main após lint, type e testes de unidade passarem, e injete credenciais apenas através de segredos do repositório.
  3. Limite a execução da integração a uma fixture somente leitura conhecida, um worker e o orçamento de requisições declarado; registre apenas evidências de status e contagem editadas.
  4. Trate falhas de autenticação, limites de taxa ou fixtures ausentes como uma condição de bloqueio de lançamento, em vez de criar dados de sandbox compartilhados a partir do CI.

Workflow do GitHub Actions

# .github/workflows/appfolio-tests.yml
name: AppFolio API Tests
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  # Nenhuma credencial de API necessária

  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 }}

Testes de Unidade com Mock

// 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('cria uma ordem de serviço de manutenção para uma propriedade', 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',
    });
  });
});

Testes de Integração

// 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)('AppFolio Tenant Lookup (sandbox ao 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 uma propriedade conhecida', async () => {
    const tenants = await client.get('/tenants', { property_id: 'prop-100' });
    expect(Array.isArray(tenants)).toBe(true);
    expect(tenants[0]).toHaveProperty('lease_status');
  });
});

Gerenciamento de Custos de CI

// tests/helpers/api-budget.ts
let callCount = 0;
const MAX_CALLS_PER_RUN = 25; // Sandbox AppFolio tem limite de 100 req/min

export function trackApiCall(): void {
  callCount++;
  if (callCount > MAX_CALLS_PER_RUN) {
    throw new Error(
      `Orçamento de API de CI excedido: ${callCount}/${MAX_CALLS_PER_RUN} chamadas. ` +
      'Reduza o escopo do teste de integração ou divida entre jobs.'
    );
  }
}

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

Tratamento de Erros

Problema de CICausaSolução
401 Não Autorizado no job de integraçãoCredenciais de sandbox expiradas ou rotacionadasRegere APPFOLIO_CLIENT_ID e APPFOLIO_CLIENT_SECRET nos Segredos do GitHub
429 Muitas RequisiçõesLimite de taxa do sandbox (100 req/min) atingido por testes paralelosExecute testes de integração com --maxWorkers=1
Lista de inquilinos vaziaDados do sandbox redefinidos periodicamente pela AppFolioPare o job e restaure a fixture pré-provisionada fora do CI
Typecheck falha na resposta da APIEsquema da AppFolio atualizado sem avisoRegere tipos a partir da especificação OpenAPI, atualize interfaces
Job de integração puladoRegra de proteção de branch não corresponde a refs/heads/mainVerifique se a condição if do workflow corresponde ao nome da sua branch padrão

Saída

  • Resultados de pull-request a partir de verificações de lint, type e testes de unidade apenas com mock
  • Um comprovante de sandbox de branch protegida com o status do provedor editado, identidade da fixture, contagem de requisições e resultado do teste de integração
  • Uma decisão de lançamento limitada que bloqueia em caso de credenciais indisponíveis, erros do provedor, desvio de fixture ou esgotamento do orçamento de requisições

Exemplos

Para uma alteração no mapeamento de ordens de serviço, adicione uma resposta mock sintética e verifique o novo campo no conjunto de PRs. Após o merge, o workflow protegido da main lê uma ordem de serviço sandbox pré-provisionada e confirma a forma normalizada sem criar inquilinos, propriedades ou ordens de serviço. Se a fixture estiver indisponível, a credencial falhar ou o orçamento de requisições for excedido, marque o lançamento como bloqueado e peça ao proprietário do sandbox para restaurar a fixture ou credencial antes de reexecutar a pista ao vivo.

Recursos

Próximos Passos

Veja 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".

Habilidades Relacionadas