Skip to content

Commit b1407d4

Browse files
SantiagoFiolSantiagoFiol
committed
Primer commit. Se creó el API Client y sus servicios. Se crearon los tests. Se creó la documentación. Se añadió licencias y Readme.
0 parents  commit b1407d4

60 files changed

Lines changed: 9837 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/ci.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master # Ejecuta pruebas al hacer push en la rama 'master'
7+
env:
8+
env_var: ${{ vars.ENV_CONTEXT_VAR }}
9+
10+
jobs:
11+
test:
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
php-version: ['8.3'] # Puedes cambiar las versiones según necesites
17+
18+
steps:
19+
- name: Check out repository code
20+
uses: actions/checkout@v3
21+
22+
- name: Setup PHP ${{ matrix.php-version }}
23+
uses: shivammathur/setup-php@v2
24+
with:
25+
php-version: ${{ matrix.php-version }} # Configura la versión de PHP desde la matriz
26+
extensions: curl, mbstring, intl, xdebug
27+
tools: composer
28+
29+
- name: Install Composer dependencies
30+
run: composer install --no-progress --no-suggest
31+
32+
- name: Run PHP tests readonly
33+
env:
34+
CONTAFI_API_TOKEN: ${{ secrets.CONTAFI_API_TOKEN }}
35+
CONTAFI_CONTRIBUYENTE_RUT: ${{ vars.CONTAFI_CONTRIBUYENTE_RUT }}
36+
run: |
37+
composer tests-readonly
38+
39+
- name: Upload PHPUnit result report
40+
if: failure()
41+
uses: actions/upload-artifact@v4
42+
with:
43+
name: tests-testdox-php_${{ matrix.php-version }}.txt
44+
path: var/tests-testdox.txt
45+
46+
- name: Upload Coverage Report
47+
uses: actions/upload-artifact@v4
48+
with:
49+
name: tests-coverage-php_${{ matrix.php-version }}.txt
50+
path: var/tests-coverage.txt
51+
52+
- name: Display PHP version
53+
run: php -v

‎.github/workflows/docs.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
docs:
11+
name: Docs
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Check out repository
16+
uses: actions/checkout@v4
17+
18+
- name: Set up PHP
19+
uses: shivammathur/setup-php@v2
20+
with:
21+
php-version: '8.3'
22+
23+
- name: Download phpDocumentor
24+
run: |
25+
mkdir -p tools
26+
wget https://phpdoc.org/phpDocumentor.phar -O tools/phpdocumentor
27+
28+
- name: Generate Documentation
29+
run: php tools/phpdocumentor run --config=phpdoc.xml
30+
31+
- name: Create CNAME file
32+
run: echo "api-client-php.docs.contafi.cl" > build/docs/CNAME
33+
34+
- name: Deploy to GitHub Pages
35+
if: success()
36+
uses: peaceiris/actions-gh-pages@v4
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ./build/docs
40+
publish_branch: gh-pages

‎.gitignore‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
vendor/
2+
test.env
3+
.phpunit.result.cache
4+
Dockerfile
5+
6+
var/
7+
tools/
8+
build/
9+
tests/archivos/bhe_emitidas_pdf/*
10+
tests/archivos/bte_emitidas_pdf/*
11+
tests/archivos/bte_emitidas_html/*
12+
13+
prueba-ejemplo.php
14+
phpstan-baseline.neon

‎.scrutinizer.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
checks:
2+
php: true
3+
4+
build:
5+
nodes:
6+
analysis:
7+
tests:
8+
override:
9+
- php-scrutinizer-run
10+
- command: composer tests-readonly
11+
coverage:
12+
file: var/tests-coverage.xml
13+
format: clover
14+
environment:
15+
php:
16+
version: 8.3.13
17+
pecl_extensions:
18+
- xdebug
19+
dependencies:
20+
before:
21+
- composer install --no-progress --prefer-dist
22+
23+
tools:
24+
php_code_sniffer:
25+
enabled: true
26+
config:
27+
standard: PSR12
28+
29+
filter:
30+
paths:
31+
- src/*
32+
excluded_paths:
33+
- resources/*
34+
- tests/*
35+
- tools/*
36+
- var/*
37+
- vendor/*

‎COPYING‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
ContaFi: Cliente de API en PHP
2+
================================
3+
4+
[![CI Workflow](https://github.com/contafi/contafi-api-client-php/actions/workflows/ci.yml/badge.svg?branch=master&event=push)](https://github.com/contafi/contafi-api-client-php/actions/workflows/ci.yml?query=branch%3Amaster)
5+
[![Scrutinizer](https://scrutinizer-ci.com/g/contafi/contafi-api-client-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/contafi/contafi-api-client-php/)
6+
[![Coverage](https://scrutinizer-ci.com/g/contafi/contafi-api-client-php/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/contafi/contafi-api-client-php/)
7+
[![Licencia](https://poser.pugx.org/contafi/contafi-api-client/license)](https://packagist.org/packages/contafi/contafi-api-client)
8+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcontafi%2Fcontafi-api-client-php.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcontafi%2Fcontafi-api-client-php?ref=badge_shield&issueType=license)
9+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcontafi%2Fcontafi-api-client-php.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcontafi%2Fcontafi-api-client-php?ref=badge_shield&issueType=security)
10+
[![Descargas Totales](https://poser.pugx.org/contafi/contafi-api-client/downloads)](https://packagist.org/packages/contafi/contafi-api-client)
11+
[![Descargas Mensuales](https://poser.pugx.org/contafi/contafi-api-client/d/monthly)](https://packagist.org/packages/contafi/contafi-api-client)
12+
13+
Cliente para realizar la integración con los servicios web de [ContaFi](https://www.contafi.cl) desde PHP.
14+
15+
Revisa la [documentación](https://api-client-php.docs.contafi.cl/guide/index.html) de la biblioteca para más información, sus características y detalles de su uso.
16+
17+
Licencia
18+
--------
19+
20+
Este programa es software libre: usted puede redistribuirlo y/o modificarlo
21+
bajo los términos de la GNU Lesser General Public License (LGPL) publicada
22+
por la Fundación para el Software Libre, ya sea la versión 3 de la Licencia,
23+
o (a su elección) cualquier versión posterior de la misma.
24+
25+
Este programa se distribuye con la esperanza de que sea útil, pero SIN
26+
GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
27+
PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la GNU Lesser General
28+
Public License (LGPL) para obtener una información más detallada.
29+
30+
Debería haber recibido una copia de la GNU Lesser General Public License
31+
(LGPL) junto a este programa. En caso contrario, consulte
32+
[GNU Lesser General Public License](http://www.gnu.org/licenses/lgpl.html).
33+
34+
Enlaces
35+
-------
36+
37+
- [Sitio web ContaFi](https://www.contafi.cl).
38+
- [Código fuente en GitHub](https://github.com/contafi/contafi-api-client-php).
39+
- [Paquete en Packagist](https://packagist.org/packages/contafi/contafi-api-client).

0 commit comments

Comments
 (0)