phpcfdi/sat-pys-scraper

Herramienta para obtener y generar un listado de las clasificaciones del cat谩logo de productos y servicios del SAT

Maintainers

Details

github.com/phpcfdi/sat-pys-scraper

Homepage

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 1

Open Issues: 0

v4.0.0 2024-10-17 17:18 UTC

Requires

Requires (Dev)

MIT 9ef45964361bb035523ac08f6ee733f8b099f8a8

satcfdicatalogosserviciosproductos

This package is auto-updated.

Last update: 2024-10-17 17:21:08 UTC

README

Source Code PHP Version Latest Version Software License Build Status Reliability Maintainability Code Coverage Violations Total Downloads

Herramienta para obtener y generar un listado de las clasificaciones del cat谩logo de productos y servicios del SAT

馃嚭馃嚫 The documentation of this project is in Spanish, as this is the natural language for the intended audience.

Es posible que, lo 煤nico que buscas es el Listado de clasificaciones de productos y servicios del SAT, si es ese el caso, es mejor consumir el recurso phpcfdi/resources-pys, en donde el listado es actualizado autom谩ticamente.

Acerca de phpcfdi/sat-pys-scraper

El SAT en el sitio de internet http://pys.sat.gob.mx/PyS/catPyS.aspx tiene publicada una clasificaci贸n de productos y servicios. Esta clasificaci贸n no pertenece oficialmente a los cat谩logos y no se encuentra publicada en ning煤n lugar.

Esta herramienta hace el scrap del sitio mencionado para obtener los 4 niveles de clasificaci贸n: Tipo, Segmento, Familia y Clase. Igualmente, la estructura se puede exportar como XML o como JSON.

Instalaci贸n usando composer

A diferencia de otras librer铆as o componentes, este proyecto es una herramienta, por lo que probablemente nunca tengas que instalar el proyecto como una dependencia. Sin embargo, se puede hacer para que realices la parte de obtener las clasificaciones del sitio del SAT, pero t煤 mismo te encargues de procesar la estructura y usarla para tus propios prop贸sitos, como por ejemplo, almacenar en una base de datos.

composer require phpcfdi/sat-pys-scraper

Instalaci贸n usando Docker

Este proyecto provee un archivo Dockerfile para construir una imagen con todas sus dependencias. Se puede usar esta imagen para correr de forma local, para m谩s informaci贸n consulte el archivo README.Docker.md.

# clonado del proyecto
git clone https://github.com/phpcfdi/sat-pys-scraper.git

# construcci贸n de la imagen de Docker
docker build -t sat-pys-scraper sat-pys-scraper/

# ejecuci贸n de la herramienta
docker run -it --rm sat-pys-scraper --help

Ayuda de sat-pys-scraper (script)

sat-pys-scraper - Crea un archivo con la clasificaci贸n de productos y servicios del SAT.

Sintaxis:
    sat-pys-scraper help|-h|--help
    sat-pys-scraper [--quiet|-q] [--json|-j JSON_FILE] [--xml|-x XML_FILE]

Argumentos:
    --xml|-x XML_FILE
        Establece el nombre de archivo, o "-" para la salida est谩ndar, donde se env铆an
        los datos generados en formato XML.
    --json|-j JSON_FILE
        Establece el nombre de archivo, o "-" para la salida est谩ndar, donde se env铆an
        los datos generados en formato JSON.
    --sort|-s SORT
        Establece el orden de elementos, default: key, se puede usar "key" o "name".
    --quiet|-q
        Modo de operaci贸n silencioso.

Notas:
    Debe especificar al menos un argumento "--xml" o "--json", o ambos.
    No se puede especificar "-" como salida de "--xml" y "--json" al mismo tiempo.

Acerca de:
    Este script pertenece al proyecto https://github.com/phpcfdi/sat-pys-scraper
    y mantiene la autor铆a y licencia de todo el proyecto.

Uso de la herramienta

Si usar el c贸digo de la herramienta, entonces es importante entender que la tarea trata de dos pasos:

  1. Obtener del sitio del SAT el listado de tipos, segmentos, familias y clases.
  2. Exportar el listado a un formato espec铆fico.

Para generar el listado de tipos, segmentos, familias y clases se usa el objeto Generator, que a su vez usa un objeto Scraper para realizar la descarga de informaci贸n, que a su vez utiliza un objeto Client de GuzzleHttp.

En el siguiente ejemplo se muestra c贸mo generar la estructura e iterar sobre sus elementos.

  • Al ejecutar Generator::generate() se devuelve un objeto de tipo Types.
  • Se recorre la estructura con foreach.
  • Se puede exportar usando XmlExporter::export().
<?php
use GuzzleHttp\Client;
use PhpCfdi\SatPysScraper\Generator;
use PhpCfdi\SatPysScraper\Scraper;
use PhpCfdi\SatPysScraper\XmlExporter;

$scraper = new Scraper(new Client());
$generator = new Generator($scraper);
$types = $generator->generate();
$types->sortByKey();

foreach ($types as $type) {
    printf("Tipo: %s - %s\n", $type->key, $type->name);
    foreach ($type as $segment) {
        printf("  Segmento: %s - %s\n", $segment->key, $segment->name);
        foreach ($segment as $family) {
            printf("    Familia: %s - %s\n", $family->key, $family->name);
            foreach ($family as $class) {
                printf("      Clase: %s - %s\n", $class->key, $class->name);
            }
        }
    }
}

$exporter = new XmlExporter();
$exporter->export('output.xml', $types);

Tipos de datos

Un objeto Types es una colecci贸n iterable de objetos de tipo Type. Un objeto Type contiene las propiedades key y name, y adem谩s es una colecci贸n iterable de objetos de tipo Segment. Un objeto Segment contiene las propiedades key y name, y adem谩s es una colecci贸n iterable de objetos de tipo Family. Un objeto Family contiene las propiedades key y name, y adem谩s es una colecci贸n iterable de objetos de tipo Classification. Un objeto Classification solamente contiene las propiedades key y name.

Todos los objetos de datos implementan JsonSerializable, por lo que puedes usar esta caracter铆stica para exportar a formato JSON.

Excepciones

La clase Scraper y -por consecuencia- tambi茅n la clase Generator generan excepciones. En el caso de una excepci贸n de tipo HTTP se tira una excepci贸n HttpException. En el caso de una excepci贸n HTTP y tenga un c贸digo de error del servicio remoto se tira una excepci贸n HttpServerException.

La jerarqu铆a de excepciones es:

- PysException (interface)
    - HttpException (class)
        - HttpServerException (class)

Soporte

Puedes obtener soporte abriendo un ticket en Github.

Adicionalmente, esta librer铆a pertenece a la comunidad PhpCfdi, as铆 que puedes usar los canales oficiales de comunicaci贸n para obtener ayuda de la comunidad.

Compatibilidad

Esta librer铆a se mantendr谩 compatible con al menos la versi贸n con soporte activo de PHP m谩s reciente.

Tambi茅n utilizamos Versionado Sem谩ntico 2.0.0 por lo que puedes usar esta librer铆a sin temor a romper tu aplicaci贸n.

Contribuciones

Las contribuciones con bienvenidas. Por favor lee CONTRIBUTING para m谩s detalles y recuerda revisar el archivo de tareas pendientes TODO y el archivo CHANGELOG.

Copyright and License

The phpcfdi/sat-pys-scraper tool is copyright 漏 PhpCfdi and licensed for use under the MIT License (MIT). Please see LICENSE for more information.