diff --git a/.gitignore b/.gitignore
index 40ce77674d89b6c217903b7b43adb30d4d3e9052..979717eb93b624b88c6749fccd981b0ccb7b2e8d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -19,3 +19,4 @@ build/*
.gulp-cache
config.json
+docs/
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b3949c4f704e19351c9126df4c326bdfaa229998..04cdb1f9f46441a3617636eea51bf6403f1e2ab9 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,13 +1,27 @@
stages:
- test
+services:
+ - mongo:latest
+
+variables:
+ MONGO_URI: 'mongodb://mongo/app_name'
+ NODE_ENV: 'test'
+
before_script:
- - npm install --global gulp gulp-cli babel babel-cli babel-core babel-register mocha
+ - npm install --global gulp gulp-cli babel babel-cli babel-core babel-register mocha gulp-mocha gulp-eslint
- npm install
run_tests:
stage: test
script:
+ - ping -W1 -c1 mongo
+ - mv config.json.example config.json
+ - sed -i -e 's/false/true/g' config.json
+ - gulp build
- gulp test
tags:
- node
+ cache:
+ paths:
+ - node_modules/
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000000000000000000000000000000000000..7733f133f247a71bbb99a09dacd3a92b4963d6a4
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,11 @@
+# Contributor code of conduct
+
+As contributors and maintainers of the SimCAQ project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting merge requests, providing feedback in comments, and any other activities.
+
+Communication through any of SimCAQ's channels (GitLab, Mattermos, mailing lists, etc.) must be constructive and never resort to personal attacks, trolling, public or private harrassment, insults, or other unprofessional conduct.
+
+We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the SimCAQ project to do the same.
+
+If any member of the community violates this code of conduct, the maintainers of the SimCAQ project may take action, removing issues, comments, and MRs or blocking accounts as deemed appropriate.
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please contact us.
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000000000000000000000000000000000..8e649c4e017254a3cdc008cbcc2597a4da3fe740
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+# Contributing to SimCAQ API
+
+## Before you get started
+
+### Code of Conduct
+
+By participating of this project you are expected to hold the [Code of Conduct](https://gitlab.c3sl.ufpr.br/simcaq/simcaq-node/blob/development/CODE_OF_CONDUCT.md).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+Bugs are reported and tracked at [simcaq/SCRUM](https://gitlab.c3sl.ufpr.br/simcaq/SCRUM/board) repository. As you determinate which repository your bug is related to, create an issue and label it with the appropriate tags.
+
+## Branch structure
+
+* **master**: protected branch and contains the stable version
+* **development**: default branch
+* **issue/??**: issue branch - a branch created to solve a issue
+* **feature_????**: feature branch - a branch created to add a feature
+
+## Styleguide
+
+### Commit messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally
+* When only changing documentation, include [ci skip] in the commit description
+* Consider starting the commit message with an applicable emoji:
+ * :art: `:art:` when improving the format/structure of the code
+ * :racehorse: `:racehorse:` when improving performance
+ * :memo: `:memo:` when writing docs
+ * :bug: `:bug:` when fixing a bug
+ * :fire: `:fire:` when removing code or files
+ * :green_heart: `:green_heart:` when fixing the CI build
+ * :white_check_mark: `:white_check_mark:` when adding tests
+ * :lock: `:lock:` when dealing with security
+ * :arrow_up: `:arrow_up:` when upgrading dependencies
+ * :arrow_down: `:arrow_down:` when downgrading dependencies
+
+### JavaScript Styleguide
+
+All JavaScript follows the [AirBnB styleguide](https://github.com/airbnb/javascript) with the following modifications:
+* 4 spaces of identation
+* No unused vars
+* Allow param reassign
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..c90ba0a59af41c07b49e0d9ee866cd8dbecd2ba1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ simcaq-node
+ Copyright (C) 2016 simcaq
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ simcaq-node Copyright (C) 2016 simcaq
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/README.md b/README.md
index 12530fa13c5edcffdd2b9e68892950e68b9ef71a..74ecd6234f14689c66dc397dbf7af2845ca1e76a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
# SIMCAQ
+[](https://gitlab.c3sl.ufpr.br/simcaq/simcaq-node/commits/development)
+[](https://gitlab.c3sl.ufpr.br/simcaq/simcaq-node/commits/development)
# Dependencies
@@ -16,9 +18,9 @@ Previous versions of Node.js do not support ECMAScript6, it is recommended to us
> nvm use v4.5.0
-4) Install babel and gulp globally
+4) Install the global dependencies
-> npm install -g gulp gulp-cli babel babel-cli babel-core babel-register mocha
+> npm install --global gulp gulp-cli babel babel-cli babel-core babel-register mocha gulp-mocha gulp-eslint istanbul
5) Install project dependencies
diff --git a/config.json b/config.json
deleted file mode 100644
index 69683fe56496ea5a7c7297e817dd8967f452a88b..0000000000000000000000000000000000000000
--- a/config.json
+++ /dev/null
@@ -1,21 +0,0 @@
-{
- "port": 3000,
- "debug" : true,
- "monetdb": {
- "host": "simcaqdb1",
- "port": 50000,
- "dbname": "simcaq_dev",
- "user": "monetdb",
- "password":"monetdb",
- "nrConnections": "16"
- },
- "mongodb" : {
- "uri": "mongodb://localhost/users",
- "secret": "simcaqC3SL"
- },
- "default": {
- "api": {
- "version" : "v1"
- }
- }
-}
diff --git a/config.json.example b/config.json.example
index b2a7f79a8bcacf0195c52604f47f57b203847e04..136ee928b34e9554c008f7125400286e6ff2ec33 100644
--- a/config.json.example
+++ b/config.json.example
@@ -1,5 +1,6 @@
{
"port": 3000,
+ "ip": "127.0.0.1",
"debug" : false,
"monetdb": {
"host": "simcaqdb1",
@@ -10,8 +11,7 @@
"nrConnections": "16"
},
"mongodb" : {
- "uri": "mongodb://localhost/users",
- "secret": "simcaqC3SL"
+ "uri": "mongodb://localhost/users"
},
"default": {
"api": {
diff --git a/gulpfile.babel.js b/gulpfile.babel.js
index cecae587a2e22e11052da3dc01371310086a74bd..b2758b0a6abe55329d30fb9658e0547e5fcb150d 100644
--- a/gulpfile.babel.js
+++ b/gulpfile.babel.js
@@ -1,3 +1,7 @@
+require('babel-core/register');
+
+const fs = require('fs');
+
const gulp = require('gulp');
const babel = require('gulp-babel');
@@ -6,67 +10,103 @@ const eslint = require('gulp-eslint');
const mocha = require('gulp-mocha');
+const istanbul = require('gulp-istanbul');
+
const nodemon = require('gulp-nodemon');
const Cache = require('gulp-file-cache');
+const docco = require('gulp-docco');
+
+const mkdirp = require('mkdirp');
+
const cache = new Cache();
-/**
- * Compile source files
- */
-function compile() {
+function createLogDir() {
+ const logDirPath = 'build/logs';
+ mkdirp(logDirPath, (err) => {
+ if(err) console.error(err);
+ });
+}
+
+gulp.task('lint', () => {
// run ESLint
gulp.src('src/**/*.js')
- .pipe(eslint())
- .pipe(eslint.format());
+ .pipe(eslint())
+ .pipe(eslint.format());
+})
+
+/**
+* Compile source files
+*/
+gulp.task('compile', ['lint'], () => {
// compile source to ES5
gulp.src('src/**/*.js')
- .pipe(cache.filter()) // cache source files
- .pipe(babel()) // compile only modified files
- .pipe(cache.cache()) // cache compiled files
- .pipe(gulp.dest('build')); // move compiled files to build directory
+ .pipe(cache.filter()) // cache source files
+ .pipe(babel()) // compile only modified files
+ // .pipe(cache.cache()) // cache compiled files
+ .pipe(gulp.dest('build')); // move compiled files to build directory
// copy configuration file to build directory
gulp.src('config.json')
- .pipe(gulp.dest('build'));
+ .pipe(gulp.dest('build'));
-}
+ createLogDir();
+});
+
+gulp.task('build', ['compile']);
+
+gulp.task('docco', () => {
+ gulp.src('./src/**/*.js')
+ .pipe(docco())
+ .pipe(gulp.dest('./docs'));
+});
+
+gulp.task('doc', ['docco']);
-gulp.task('build', compile);
+gulp.task('pre-test', () => {
+ return gulp.src(['build/**/*.js', '!build/{test,test/**}'])
+ .pipe(istanbul())
+ .pipe(istanbul.hookRequire());
+});
-gulp.task('test', () => {
- gulp.src('test/test.js', {read: false})
+gulp.task('test', ['pre-test'], () => {
+ process.chdir('build');
+ gulp.src('test/test.js', {read: false})
.pipe(mocha())
- .once('error', () => {
- process.exit(1);
+ .pipe(istanbul.writeReports())
+ .pipe(istanbul.enforceThresholds({
+ thresholds: {
+ global: 80
+ }
+ }))
+ .on('error', () => {
+ process.exit(1);
})
- .once('end', () => {
- process.exit();
+ .on('end', () => {
+ process.exit();
});
});
-gulp.task('watch', [], () => {
+gulp.task('watch', ['compile'], () => {
console.log('Watching source directory for changes');
- compile();
gulp.watch('src/**/*.js').on('change', () => {
console.log('Recompiling source');
- compile();
- console.log('Source recompilation done')
+ gulp.start('compile');
+ console.log('Source recompilation done');
});
});
gulp.task('run', () => {
- process.chdir('build');
- nodemon({
- script: 'server.js',
- tasks: ['watch'],
- ignore: ["test/test.js", "gulpfile.babel.js"],
- ext: 'js html json',
- env: { 'NODE_ENV': 'development' }
- });
+ process.chdir('build');
+ nodemon({
+ script: 'server.js',
+ tasks: ['watch'],
+ ignore: ["test/test.js", "gulpfile.babel.js"],
+ ext: 'js html json',
+ env: { 'NODE_ENV': 'development' }
+ });
});
gulp.task('default', ['run']);
-
diff --git a/jsdoc.json b/jsdoc.json
new file mode 100644
index 0000000000000000000000000000000000000000..3456657c211f6e49246172a9bdb15db65721c3a7
--- /dev/null
+++ b/jsdoc.json
@@ -0,0 +1,19 @@
+{
+ "tags": {
+ "allowUnknownTags": true
+ },
+ "plugins": [
+ "plugins/markdown"
+ ],
+ "opts": {
+ "template": "./node_modules/docdash/",
+ "encoding": "utf8",
+ "destination": "docs/",
+ "recurse": true,
+ "verbose": true
+ },
+ "templates": {
+ "cleverLinks": false,
+ "monospaceLinks": false
+ }
+}
diff --git a/package.json b/package.json
index 1b217491194fac07e1d3d4640e93d8d0676e6f33..acc29cd2e3d6ff9a605fde13cfaa6774243b6307 100644
--- a/package.json
+++ b/package.json
@@ -10,7 +10,6 @@
},
"dependencies": {
"apicache": "0.0.14",
- "bcrypt": "^0.8.7",
"body-parser": "^1.13.1",
"chai": "^3.5.0",
"chai-http": "^3.0.0",
@@ -24,14 +23,11 @@
"faker": "^2.1.5",
"forever": "^0.15.2",
"js2xmlparser": "^1.0.0",
- "jwt-simple": "^0.5.0",
"method-override": "^2.3.3",
"mocha": "^2.5.3",
"monetdb-pool": "0.0.8",
"mongoose": "^4.6.0",
"nconf": "^0.6.x",
- "passport": "^0.3.2",
- "passport-jwt": "^2.1.0",
"squel": "^5.4.2",
"winston": "^2.2.0"
},
@@ -43,6 +39,8 @@
"babel-register": "^6.14.0",
"babelify": "^7.3.0",
"browserify": "^13.1.0",
+ "chai-xml": "^0.3.1",
+ "docdash": "^0.4.0",
"eslint": "^3.3.1",
"eslint-config-airbnb": "^10.0.1",
"eslint-plugin-import": "^1.13.0",
@@ -51,12 +49,18 @@
"gulp": "^3.9.1",
"gulp-babel": "^6.1.2",
"gulp-cli": "^1.2.2",
+ "gulp-docco": "0.0.4",
"gulp-eslint": "^3.0.1",
"gulp-file-cache": "0.0.1",
+ "gulp-function": "^1.3.6",
+ "gulp-istanbul": "^1.1.1",
+ "gulp-jsdoc3": "^0.3.0",
"gulp-mocha": "^3.0.1",
"gulp-nodemon": "^2.1.0",
"gulp-plumber": "^1.1.0",
"gulp-rename": "^1.2.2",
- "gulp-uglify": "^2.0.0"
+ "gulp-uglify": "^2.0.0",
+ "jsdoc": "^3.4.1",
+ "mkdirp": "^0.5.1"
}
}
diff --git a/src/libs/app.js b/src/libs/app.js
index f03e2282a34a74e3fde8c1183515df4670b35d4b..f43abfb9732b4793d161c51efaf9b7dc857a674c 100644
--- a/src/libs/app.js
+++ b/src/libs/app.js
@@ -4,40 +4,48 @@ const bodyParser = require('body-parser');
const methodOverride = require('method-override');
const cors = require('cors');
const compression = require('compression');
+const squel = require('squel');
-const log = require('./log')(module);
+const libs = `${process.cwd()}/libs`;
-const config = require('./config');
+const log = require(`${libs}/log`)(module);
+
+const config = require(`${libs}/config`);
const cache = require('apicache').options({ debug: config.get('debug') }).middleware;
const app = express();
-const api = require('./routes/api');
-
-
-const passport = require('passport');
+const api = require(`${libs}/routes/api`);
-app.use(passport.initialize());
+const mongoose = require(`${libs}/db/mongoose`);
-require('./middlewares/passport')(passport); // pass passport for configuration
+const db = mongoose();
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());
+// Enable Cross-Origin Resource Sharing (CORS)
app.use(cors());
app.use(methodOverride());
+// Enable cache for 1 day
app.use(cache('1 day'));
+// Enable maximum compression
app.use(compression(9));
-app.use(api);
+// Middleware tha adds the squel object to req
+app.use((req, res, next) => {
+ req.sql = squel.select();
+ next();
+});
+app.use('/api/v1', api);
-// catch 404 and forward to error handler
+// Catch 404 and forward to error handler
app.use((req, res, next) => {
res.status(404);
log.debug('%s %d %s', req.method, res.statusCode, req.url);
res.json({ error: 'Not found' }).end();
});
-// error handlers
+// Error handlers
app.use((err, req, res, next) => {
res.status(err.status || 500);
log.error('%s %d %s', req.method, res.statusCode, err.message);
diff --git a/src/libs/config.js b/src/libs/config.js
index ef5a26cddbb3946b89ac690e8cf52d28884463aa..5aea5a9ca50efd0dac2253dd23690229431236dc 100644
--- a/src/libs/config.js
+++ b/src/libs/config.js
@@ -1,5 +1,6 @@
const nconf = require('nconf');
+// Exports the config.json as an object with get functions
nconf.argv()
.env()
.file({ file: `${process.cwd()}/config.json` });
diff --git a/src/libs/db/monet.js b/src/libs/db/monet.js
index 1cf874cc9ca5a2ada3e20bdd077c34fbcfbe8226..dd7e620adcf5b6a1dbe29358697fa71a3970ea03 100644
--- a/src/libs/db/monet.js
+++ b/src/libs/db/monet.js
@@ -4,10 +4,12 @@ const libs = `${process.cwd()}/libs`;
const config = require(`${libs}/config`);
+// Connection options
const poolOptions = {
nrConnections: config.get('monetdb:nrConnections'),
};
+// Configuration options
const options = {
host: config.get('monetdb:host'),
port: config.get('monetdb:port'),
@@ -16,6 +18,7 @@ const options = {
password: config.get('monetdb:password'),
};
+// Connection singleton
const conn = new MonetDBPool(poolOptions, options);
conn.connect();
diff --git a/src/libs/db/mongoose.js b/src/libs/db/mongoose.js
index 896438a84da346d4840a8dd86722cadebf050a21..30b4d4930c203537335c46b14bfb5e2958ace6bb 100644
--- a/src/libs/db/mongoose.js
+++ b/src/libs/db/mongoose.js
@@ -6,14 +6,13 @@ const log = require(`${libs}/log`)(module);
const mongoose = require('mongoose');
-mongoose.Promise = global.Promise;
-
module.exports = () => {
- const mongoUri = config.get('mongodb:uri');
+ const mongoUri = process.env.MONGO_URI || config.get('mongodb:uri');
log.debug(`Connecting to MongDB on URI ${mongoUri}`);
+ // Connection singleton
const db = mongoose.connect(mongoUri);
- mongoose.connection.once('open', () => { log.info('MongoDB connected'); });
+ mongoose.connection.once('open', () => { log.info("MongoDB connected"); });
return db;
};
diff --git a/src/libs/db/query_exec.js b/src/libs/db/query_exec.js
index bd921d1d02deec90101260046707b7929434a10a..71ae6d9824ac304eb5fd4e4d0e122b16d8d159a2 100644
--- a/src/libs/db/query_exec.js
+++ b/src/libs/db/query_exec.js
@@ -1,40 +1,41 @@
+
const libs = `${process.cwd()}/libs`;
const log = require(`${libs}/log`)(module);
const conn = require(`${libs}/db/monet`);
-/**
- * Promise that executes an SQL query with optional parameters
- *
- * Examples:
- * Query with no parameters:
- * execSqlQuery('SELECT * FROM people');
- * Query with one parameter:
- * execSqlQuery('SELECT name, age FROM people WHERE id = ?', [1]);
- * Query with more than one parameter:
- * execSqlQuery('SELECT name, age FROM people WHERE city = ? AND age > ?', ['São Paulo', 35]);
- *
- * @param {string} sqlQuery - SQL query to be executed by the Promise
- * @param {array} sqlQueryParams - SQL query parameters
- */
+ // Promise that executes an SQL query with optional parameters
+ // ```
+ // Examples:
+ // Query with no parameters:
+ // execSqlQuery('SELECT * FROM people');
+ // Query with one parameter:
+ // execSqlQuery('SELECT name, age FROM people WHERE id = ?', [1]);
+ // Query with more than one parameter:
+ // execSqlQuery('SELECT name, age FROM people WHERE city = ? AND age > ?', ['São Paulo', 35]);
+ // ```
function execSqlQuery(sqlQuery, sqlQueryParams = []) {
log.debug(`Executing SQL query '${sqlQuery}' with params '${sqlQueryParams}'`);
return new Promise((resolve, reject) => {
+ // Prepare statement
conn.prepare(sqlQuery, true).then(
(dbQuery) => {
+ // Execute query
dbQuery.exec(sqlQueryParams).then(
+ // Success
(dbResult) => {
log.debug(`Query result: ${dbResult.data}`);
log.debug(dbResult.data);
resolve(dbResult.data);
},
+ // Error
(dbError) => {
log.error(`SQL query execution error: ${dbError.message}`);
reject(new Error(dbError.message));
}
);
- // release resources allocated for prepared statement
+ // Release resources allocated for prepared statement
conn.release();
}
);
diff --git a/src/libs/log.js b/src/libs/log.js
index ecf6df026314105b02628ef0ac2736a23950374a..fbe7b1394464e06611cbcd91d69e33c022846923 100644
--- a/src/libs/log.js
+++ b/src/libs/log.js
@@ -1,4 +1,5 @@
-const config = require('./config');
+const libs = `${process.cwd()}/libs`;
+const config = require(`${libs}/config`);
const winston = require('winston');
@@ -10,21 +11,34 @@ function getFilePath(module) {
}
function logger(module) {
+ const logPath = `${process.cwd()}/logs`;
+ const maxLogFiles = 5;
+ const maxLogSize = 5242880;
const log = new winston.Logger({
transports: [
new winston.transports.File({
name: 'info-log',
level: 'info',
- filename: `${process.cwd()}/logs/all.log`,
+ filename: `${logPath}/simcaq-info.log`,
handleException: true,
json: false,
- maxSize: 5242880, // 5MB
- maxFiles: 2,
+ maxSize: maxLogSize, // 5MB
+ maxFiles: maxLogFiles,
+ colorize: false,
+ }),
+ new winston.transports.File({
+ name: 'error-log',
+ level: 'error',
+ filename: `${logPath}/simcaq-error.log`,
+ handleException: true,
+ json: false,
+ maxSize: maxLogSize, // 5MB
+ maxFiles: maxLogFiles,
colorize: false,
}),
new winston.transports.Console({
name: 'debug-log',
- level: 'debug',
+ level: (process.env.NODE_ENV === 'development') ? 'debug' : 'error',
label: getFilePath(module),
handleException: true,
json: false,
diff --git a/src/libs/middlewares/dimensions.js b/src/libs/middlewares/dimensions.js
deleted file mode 100644
index 618a510e028742dbbf4a8e9ca04d19d936d9e39e..0000000000000000000000000000000000000000
--- a/src/libs/middlewares/dimensions.js
+++ /dev/null
@@ -1,58 +0,0 @@
-/**
-* Dimensions middleware
-*
-* EXAMPLE:
-* Use it with no parameters to get all the dimensions specified
-* app.get('/', dimensions(), function(req, res, next){})
-*
-* Use it with an array of accepted values
-* app.get('/', dimensions(['year', 'location']), function(req, res, next){})
-*
-* Use it globally
-* app.use(dimensions())
-*/
-
-/**
- * This function returns the intersection of two arrays
- * @param {array} a [description]
- * @param {array} b [description]
- * @return {array} [description]
- */
-function intersect(a, b) {
- let t;
- if (b.length > a.length) {
- t = b; b = a; a = t;
- }
- return a.filter((e) => b.indexOf(e) !== -1);
-}
-
-function dimensions(dims) {
- return (req, res, next) => {
- req.dims = {};
- if (req.query.dims) {
- const params = req.query.dims.split(',');
- const dimObj = {};
- for (const param of params) {
- const kv = param.split(':');
- dimObj[kv[0]] = (typeof kv[1] === 'undefined') ? null : kv[1];
- }
- // for(let i=0; i<params.length; ++i) {
- // let kv = params[i].split(':');
- // dimObj[kv[0]] = (typeof kv[1] === 'undefined') ? null : kv[1];
- // }
-
- // If the dims array exists and is not empty
- if (typeof dims !== 'undefined' && dims.length > 0) {
- const intersection = intersect(dims, Object.keys(dimObj));
- for (let i = 0; i < intersection.length; ++i) {
- req.dims[intersection[i]] = dimObj[intersection[i]];
- }
- } else {
- req.dims = dimObj;
- }
- }
- next();
- };
-}
-
-module.exports = dimensions;
diff --git a/src/libs/middlewares/parseParams.js b/src/libs/middlewares/parseParams.js
new file mode 100644
index 0000000000000000000000000000000000000000..c74b6b491bc445b22cd480c85d9f232494a139de
--- /dev/null
+++ b/src/libs/middlewares/parseParams.js
@@ -0,0 +1,66 @@
+/**
+* ParseParams middleware
+*
+* EXAMPLE:
+* Use it with no parameters to get all the params specified
+* app.get('/', parseParams('dims'), function(req, res, next){})
+*
+* Use it with an array of accepted values
+* app.get('/', parseParams('filter', ['year', 'location']), function(req, res, next){})
+*
+* Use it globally
+* app.use(parseParams('dims'))
+*/
+
+const libs = `${process.cwd()}/libs`;
+
+const log = require(`${libs}/log`)(module);
+
+ // This function returns the intersection of two arrays
+function intersect(a, b) {
+ let t;
+ if (b.length > a.length) {
+ t = b; b = a; a = t;
+ }
+ return a.filter((e) => b.indexOf(e) !== -1);
+}
+
+function parseParams(queryParam, arr) {
+ return (req, res, next) => {
+ req[queryParam] = {};
+ if (req.query[queryParam]) {
+ const params = req.query[queryParam].split(',');
+ // Temporary object to hold the params and it's values
+ const obj = {};
+ for (const param of params) {
+ // Get the key and the value - state:41 is key 'state' whith value 41
+ const kv = param.split(':');
+ // Check if there is a value. If there isn't, assign null
+ obj[kv[0]] = (typeof kv[1] === 'undefined') ? null : kv[1];
+ }
+
+ // If the array exists and is not empty we intersect
+ if (typeof arr !== 'undefined' && arr.length > 0) {
+ // Intersect the keys of the obj with the array arr.
+ // The intersection array is assigned with the keys
+ const intersection = intersect(arr, Object.keys(obj));
+ // This is a bit tricky...
+ // For each key in the intersection array we get it's value in the obj
+ // and assign it to the custom attribute in the req obj.
+ // For example: instersection => ["state"] so
+ // obj[intersection[i]] (with i=0) is obj["state"], that is 41
+ // and req[queryParam]["state"] = 41
+ for (let i = 0; i < intersection.length; ++i) {
+ req[queryParam][intersection[i]] = obj[intersection[i]];
+ }
+ req[queryParam].size = intersection.length;
+ } else {
+ req[queryParam] = obj;
+ req[queryParam].size = Object.keys(obj).length;
+ }
+ }
+ next();
+ };
+}
+
+module.exports = parseParams;
diff --git a/src/libs/middlewares/query.js b/src/libs/middlewares/query.js
index 74a0c505cf02285dde3a35c0d0fc6365b8b4ce86..a4f20e3ba5bdd31cf7dab85a44121b8e8e456fc0 100644
--- a/src/libs/middlewares/query.js
+++ b/src/libs/middlewares/query.js
@@ -2,15 +2,11 @@ const libs = `${process.cwd()}/libs`;
const log = require(`${libs}/log`)(module);
const execQuery = require(`${libs}/db/query_exec`);
-/**
- * Middleware that executes a query defined by a squel object in req.sql
- * @param {Object} req [description]
- * @param {Object} res [description]
- * @param {Function} next [description]
- */
+ // Middleware that executes a query defined by a squel object in req.sql
function query(req, res, next) {
- log.debug(req.sql);
- execQuery(req.sql.text, req.sql.values).then((result) => {
+ let sql = req.sql.toParam();
+ log.debug(sql);
+ execQuery(sql.text, sql.values).then((result) => {
log.debug(result);
req.result = result;
next();
diff --git a/src/libs/middlewares/response.js b/src/libs/middlewares/response.js
index 83580825109c37c7da18e08d8c9c28b3e51487ea..580c16f5bd7470d20c622565954234f873f56b54 100644
--- a/src/libs/middlewares/response.js
+++ b/src/libs/middlewares/response.js
@@ -1,15 +1,15 @@
const libs = `${process.cwd()}/libs`;
const log = require(`${libs}/log`)(module);
const xml = require('js2xmlparser');
+const csv = require('csv-express');
-/**
- * Custom generic middleware used to send api responses
- * @param {string} value text to be used in the xml response
- */
+ // Custom generic middleware used respond requests.
+ // The function reads the req.query.format param and respond in json, xml or csv
function response(value) {
return (req, res, next) => {
log.debug(req.query.format);
if (req.query.format === 'csv') {
+ res.attachment(`${value}.csv`);
res.csv(req.result);
} else if (req.query.format === 'xml') {
res.send(xml('result', JSON.stringify({ [value]: req.result })));
diff --git a/src/libs/routes/api.js b/src/libs/routes/api.js
index a1805696172afccb4ca747a31b8db42e3bcc5962..3faaa926c7055bc9849d4457e183e8ea6fd48cf8 100644
--- a/src/libs/routes/api.js
+++ b/src/libs/routes/api.js
@@ -12,18 +12,15 @@ const city = require('./city');
const school = require('./school');
-const user = require('./user');
-
api.get('/', (req, res) => {
res.json({ msg: 'SimCAQ API is running' });
});
// mount API routes
-api.use('/api/v1/enrollment', enrollment);
-api.use('/api/v1/state', state);
-api.use('/api/v1/region', region);
-api.use('/api/v1/city', city);
-api.use('/api/v1/school', school);
-api.use('/api/v1/user', user);
+api.use('/enrollment', enrollment);
+api.use('/state', state);
+api.use('/region', region);
+api.use('/city', city);
+api.use('/school', school);
module.exports = api;
diff --git a/src/libs/routes/city.js b/src/libs/routes/city.js
index 030aa3cecda6c538a45d12543aa6d9449e685937..733da6f341cc37a7b6b792b8f5383076eae75067 100644
--- a/src/libs/routes/city.js
+++ b/src/libs/routes/city.js
@@ -1,6 +1,6 @@
const express = require('express');
-const cityApp = express();
+const cityApp = express.Router();
const libs = `${process.cwd()}/libs`;
@@ -10,26 +10,30 @@ const query = require(`${libs}/middlewares/query`);
const response = require(`${libs}/middlewares/response`);
+// Return all cities
cityApp.get('/', (req, res, next) => {
- req.sql = squel.select().from('municipios').toParam();
+ req.sql.from('municipios');
next();
}, query, response('city'));
+// Return a specific city by it's id
cityApp.get('/:id', (req, res, next) => {
- req.sql = squel.select().from('municipios').where('pk_municipio_id = ?',
- parseInt(req.params.id, 10)).toParam();
+ req.sql.from('municipios')
+ .where('pk_municipio_id = ?', parseInt(req.params.id, 10));
next();
}, query, response('city'));
+// Return a specific city by it's IBGE code
cityApp.get('/ibge/:id', (req, res, next) => {
- req.sql = squel.select().from('municipios').where('codigo_ibge = ?',
- req.params.id).toParam();
+ req.sql.from('municipios')
+ .where('codigo_ibge = ?', req.params.id);
next();
}, query, response('city'));
+// Return all the cities from a specific state
cityApp.get('/state/:id', (req, res, next) => {
- req.sql = squel.select().from('municipios').where('fk_estado_id = ?',
- parseInt(req.params.id, 10)).toParam();
+ req.sql.from('municipios')
+ .where('fk_estado_id = ?', parseInt(req.params.id, 10));
next();
}, query, response('city'));
diff --git a/src/libs/routes/enrollment.js b/src/libs/routes/enrollment.js
index 26d1cd6fcea5ed231bf16664dc15026499736fac..9fe6e903bdbe9bc10b89181866a920792b832533 100644
--- a/src/libs/routes/enrollment.js
+++ b/src/libs/routes/enrollment.js
@@ -1,6 +1,6 @@
const express = require('express');
-const enrollmentApp = express();
+const enrollmentApp = express.Router();
const libs = `${process.cwd()}/libs`;
@@ -12,219 +12,203 @@ const query = require(`${libs}/middlewares/query`);
const response = require(`${libs}/middlewares/response`);
-// **Temporary** solution to add where clauses that are common to all requests
-function filter(req, q) {
- if (typeof req.min_year !== 'undefined') {
- if (typeof req.max_year === 'undefined') q.where('ano_censo=?', req.min_year);
- else q.where('ano_censo>=?', req.min_year);
- }
-
- if (typeof req.max_year !== 'undefined') {
- if (typeof req.min_year === 'undefined') q.where('ano_censo=?', req.max_year);
- else q.where('ano_censo<=?', req.max_year);
- }
-
- if (typeof req.adm_dependency_id !== 'undefined') {
- q.where('fk_dependencia_adm_id=?', req.adm_dependency_id);
- }
+const parseParams = require(`${libs}/middlewares/parseParams`);
- if (typeof req.location_id !== 'undefined') {
- q.where('id_localizacao=?', req.location_id);
- }
+// **Temporary** solution to add where clauses that are common to all requests
- if (typeof req.education_level_id !== 'undefined') {
- q.where('fk_etapa_ensino_id=?', req.education_level_id);
- }
-}
-/**
- * Complete range of the enrollments dataset
- *
- * Returns a tuple of start and ending years of the complete enrollments dataset.
- */
+// Complete range of the enrollments dataset.
+// Returns a tuple of start and ending years of the complete enrollments dataset.
enrollmentApp.get('/year_range', (req, res, next) => {
req.sql = squel.select()
.from('turmas')
.field('MIN(turmas.ano_censo)', 'start_year')
- .field('MAX(turmas.ano_censo)', 'end_year')
- .toParam();
+ .field('MAX(turmas.ano_censo)', 'end_year');
next();
}, query, response('range'));
-/**
- * Returns all educational levels avaible
- *
- */
+// Returns all educational levels avaible
enrollmentApp.get('/education_level', (req, res, next) => {
req.sql = squel.select()
.from('etapa_ensino')
.field('pk_etapa_ensino_id', 'id')
- .field('desc_etapa', 'name')
- .toParam();
+ .field('desc_etapa', 'name');
next();
}, query, response('education_level'));
-enrollmentApp.get('/data', (req, res, next) => {
- req.sql = squel.select().from('turmas').toParam();
+// Returns all adm dependencies
+enrollmentApp.get('/adm_dependency', (req, res, next) => {
+ req.sql = squel.select()
+ .from('dependencia_adms')
+ .field('pk_dependencia_adm_id', 'id')
+ .field('nome', 'name');
+
next();
-}, query, response('data'));
+}, query, response('adm_dependency'));
-enrollmentApp.use('/', (req, res, next) => {
- const params = req.query;
- req.paramCnt = 0;
+// Parse the filters and dimensions parameter in the query
+enrollmentApp.use('/', parseParams('filter', [
+ 'min_year',
+ 'max_year',
+ 'adm_dependency_id',
+ 'location_id',
+ 'education_level_id',
+ 'region',
+ 'state',
+ 'city',
+ 'school'
+]), parseParams('dims', [
+ 'adm_dependency_id',
+ 'location_id',
+ 'education_level_id',
+ 'region',
+ 'state',
+ 'city',
+ 'school'
+]), (req, res, next) => {
+ log.debug(req.filter);
+ log.debug(req.dims);
- if (typeof params.id !== 'undefined') {
- req.id = parseInt(params.id, 10);
- req.paramCnt += 1;
+ // Do the joins
+ if(typeof req.filter.adm_dependency_id !== 'undefined'
+ || typeof req.dims.adm_dependency_id !== 'undefined') {
+ req.sql.join('dependencia_adms', null, 'fk_dependencia_adm_id=dependencia_adms.pk_dependencia_adm_id');
}
- if (typeof params.location_id !== 'undefined') {
- req.location_id = parseInt(params.location_id, 10);
- req.paramCnt += 1;
+ if(typeof req.filter.education_level_id !== 'undefined'
+ || typeof req.dims.education_level_id !== 'undefined') {
+ req.sql.join('etapa_ensino', null, 'fk_etapa_ensino_id=etapa_ensino.pk_etapa_ensino_id');
}
- if (typeof params.adm_dependency_id !== 'undefined') {
- req.adm_dependency_id = parseInt(params.adm_dependency_id, 10);
- req.paramCnt += 1;
+ if(typeof req.filter.region !== 'undefined'
+ || typeof req.dims.region !== 'undefined') {
+ req.sql.join('municipios', null, 'fk_municipio_id=municipios.pk_municipio_id')
+ .join('estados', null, 'municipios.fk_estado_id=estados.pk_estado_id')
+ .join('regioes', null, 'estados.fk_regiao_id=regioes.pk_regiao_id');
}
- if (typeof params.min_year !== 'undefined') {
- req.min_year = parseInt(params.min_year, 10);
- req.paramCnt += 1;
+ if((typeof req.filter.state !== 'undefined'
+ || typeof req.dims.state !== 'undefined')
+ && (typeof req.filter.region === 'undefined'
+ && typeof req.dims.region === 'undefined')) {
+ req.sql.join('municipios', null, 'fk_municipio_id=municipios.pk_municipio_id')
+ .join('estados', null, 'municipios.fk_estado_id=estados.pk_estado_id');
}
- if (typeof params.max_year !== 'undefined') {
- req.max_year = parseInt(params.max_year, 10);
- req.paramCnt += 1;
+ if((typeof req.filter.city !== 'undefined'
+ || typeof req.dims.city !== 'undefined')
+ && (typeof req.filter.state === 'undefined'
+ && typeof req.dims.state === 'undefined')
+ && (typeof req.filter.region === 'undefined'
+ && typeof req.dims.region === 'undefined')) {
+ req.sql.join('municipios', null, 'fk_municipio_id=municipios.pk_municipio_id');
}
- if (typeof params.education_level_id !== 'undefined') {
- req.education_level_id = parseInt(params.education_level_id, 10);
- req.paramCnt += 1;
+ if(typeof req.dims.school !== 'undefined') {
+ req.sql.join('escolas', null, 'fk_escola_id=escolas.pk_escola_id');
}
- next();
-});
+ // Dimensions (add fields)
-enrollmentApp.use('/', (req, res, next) => {
- const params = req.query;
- if (typeof params.aggregate !== 'undefined' && params.aggregate === 'region') {
- log.debug('Using enrollments query for regions');
- const q = squel.select().from('mat_regioes')
- .field('name')
- .field('SUM(total)', 'total')
- .field('ano_censo', 'year');
+ if(typeof req.dims.education_level_id !== 'undefined') {
+ req.sql.field('desc_etapa', 'education_level')
+ .group('desc_etapa')
+ .order('desc_etapa');
+ }
- filter(req, q);
+ if(typeof req.dims.region !== 'undefined') {
+ req.sql.field('regioes.nome', 'region_name')
+ .group('regioes.nome')
+ .order('regioes.nome');
+ }
- if (typeof req.id !== 'undefined') {
- q.where('pk_regiao_id=?', req.id);
- }
- req.sql = q.group('name').group('ano_censo').order('ano_censo').toParam();
+ if(typeof req.dims.state !== 'undefined') {
+ req.sql.field('estados.nome', 'state_name')
+ .group('estados.nome')
+ .order('estados.nome');
}
- next();
-});
-enrollmentApp.use('/', (req, res, next) => {
- const params = req.query;
- if (typeof params.aggregate !== 'undefined' && params.aggregate === 'state') {
- log.debug('Using enrollments query for states');
- const q = squel.select().from('mat_estados')
- .field('name')
- .field('SUM(total)', 'total')
- .field('ano_censo', 'year');
+ if(typeof req.dims.city !== 'undefined') {
+ req.sql.field('municipios.nome', 'city_name')
+ .group('municipios.nome')
+ .order('municipios.nome');
+ }
- filter(req, q);
+ if(typeof req.dims.school !== 'undefined') {
+ req.sql.field('escolas.nome_entidade', 'school_name')
+ .group('escolas.nome_entidade')
+ .order('escolas.nome_entidade');
+ }
- if (typeof req.id !== 'undefined') {
- q.where('pk_estado_id=?', req.id);
- }
- req.sql = q.group('name').group('ano_censo').order('ano_censo').toParam();
+ if(typeof req.dims.adm_dependency_id !== 'undefined') {
+ req.sql.field('dependencia_adms.nome', 'adm_dependency_name')
+ .group('dependencia_adms.nome')
+ .order('dependencia_adms.nome');
}
- next();
-});
-enrollmentApp.use('/', (req, res, next) => {
- const params = req.query;
- if (typeof params.aggregate !== 'undefined' && params.aggregate === 'city') {
- log.debug('Using enrollments query for cities');
- const q = squel.select().from('mat_municipios')
- .field('name')
- .field('SUM(total)', 'total')
- .field('ano_censo', 'year');
+ if(typeof req.dims.location_id !== 'undefined') {
+ req.sql.field('turmas.id_localizacao', 'location')
+ .group('turmas.id_localizacao')
+ .order('turmas.id_localizacao');
+ }
+
+ if(typeof req.dims.region === 'undefined'
+ && typeof req.dims.state === 'undefined'
+ && typeof req.dims.city === 'undefined'
+ && typeof req.dims.school === 'undefined') {
+ req.sql.field("'Brasil'", 'name');
+ }
- filter(req, q);
+ // Filter (add where)
- if (typeof req.id !== 'undefined') {
- q.where('pk_municipio_id=?', req.id);
- }
- req.sql = q.group('name').group('ano_censo').order('ano_censo').toParam();
+ if (typeof req.filter.min_year !== 'undefined') {
+ req.sql.where('turmas.ano_censo>=?', parseInt(req.filter.min_year, 10));
+ }
+
+ if (typeof req.filter.max_year !== 'undefined') {
+ req.sql.where('turmas.ano_censo<=?', parseInt(req.filter.max_year, 10));
}
- next();
-});
-enrollmentApp.use('/', (req, res, next) => {
- const params = req.query;
- if (typeof params.aggregate !== 'undefined' && params.aggregate === 'school') {
- log.debug('Using enrollments query for schools');
- const q = squel.select().from('mat_escolas')
- .field('name')
- .field('SUM(total)', 'total')
- .field('ano_censo', 'year');
+ if (typeof req.filter.adm_dependency_id !== 'undefined') {
+ req.sql.where('pk_dependencia_adm_id=?', parseInt(req.filter.adm_dependency_id, 10));
+ }
- filter(req, q);
+ if (typeof req.filter.location_id !== 'undefined') {
+ req.sql.where('turmas.id_localizacao=?', parseInt(req.filter.location_id, 10));
+ }
- if (typeof req.id !== 'undefined') {
- q.where('pk_escola_id=?', req.id);
- }
- req.sql = q.group('name').group('ano_censo').order('ano_censo').toParam();
+ if (typeof req.filter.education_level_id !== 'undefined') {
+ req.sql.where('pk_etapa_ensino_id=?', parseInt(req.filter.education_level_id, 10));
}
- next();
-});
-enrollmentApp.use('/', (req, res, next) => {
- const params = req.query;
- if (typeof params.aggregate === 'undefined') {
- log.debug('Using enrollments query for the whole country');
- const q = squel.select().from('turmas').field("'Brasil'", 'name')
- .field('COALESCE(SUM(num_matriculas),0)', 'total')
- .field('ano_censo', 'year');
+ if (typeof req.filter.region !== 'undefined') {
+ req.sql.where('pk_regiao_id=?', parseInt(req.filter.region, 10));
+ }
- filter(req, q);
+ if (typeof req.filter.state !== 'undefined') {
+ req.sql.where('pk_estado_id=?', parseInt(req.filter.state, 10));
+ }
+
+ if (typeof req.filter.city !== 'undefined') {
+ req.sql.where('turmas.fk_municipio_id=?', parseInt(req.filter.city, 10));
+ }
- req.sql = q.group('ano_censo').order('ano_censo').toParam();
+ if (typeof req.filter.school !== 'undefined') {
+ req.sql.where('turmas.fk_escola_id=?', parseInt(req.filter.school, 10));
}
+ log.debug(req.sql.toParam());
next();
});
enrollmentApp.get('/', (req, res, next) => {
- log.debug(`Request parameters: ${req}`);
+ req.sql.field('COALESCE(SUM(num_matriculas), 0)', 'total')
+ .field('turmas.ano_censo', 'year')
+ .from('turmas')
+ .group('turmas.ano_censo')
+ .order('turmas.ano_censo');
next();
-}, query, response('enrollments'));
-
-// enrollmentApp.get('/', (req, res, next) => {
-// log.debug(`Request parameters: ${req}`);
-// if (typeof req.sqlQuery === 'undefined') {
-// // Should only happen if there is a bug in the chaining of the
-// // '/enrollments' route, since when no +aggregate+ parameter is given,
-// // it defaults to use the query for the whole country.
-// log.error('BUG -- No SQL query was found to be executed!');
-// next('Internal error, request could not be satisfied at this moment. Please, '
-// + 'try again later');
-// } else {
-// log.debug('SQL query: ${ req.sqlQuery }?');
-// log.debug(req.sqlQuery);
-// dbQuery(req.sqlQuery).then((result) => {
-// req.result = result;
-// return response(req, res);
-// }, (error) => {
-// log.error(`[${req.originalUrl}] SQL query error: ${error}`);
-// next('Internal error, request could not be satisfied at this moment. Please, '
-// + 'try again later');
-// });
-// }
-// });
+}, query, response('test'));
module.exports = enrollmentApp;
diff --git a/src/libs/routes/region.js b/src/libs/routes/region.js
index 754cd6164725bebf8c5d6cfb387b3f0656eb615b..773ad347959049dd2137d96abb255a3bc809a2d4 100644
--- a/src/libs/routes/region.js
+++ b/src/libs/routes/region.js
@@ -1,6 +1,6 @@
const express = require('express');
-const regionApp = express();
+const regionApp = express.Router();
const libs = `${process.cwd()}/libs`;
@@ -10,14 +10,16 @@ const query = require(`${libs}/middlewares/query`);
const response = require(`${libs}/middlewares/response`);
+// Get all regions
regionApp.get('/', (req, res, next) => {
- req.sql = squel.select().from('regioes').toParam();
+ req.sql.from('regioes');
next();
}, query, response('region'));
+// Get a region by it's id
regionApp.get('/:id', (req, res, next) => {
- req.sql = squel.select().from('regioes').where('pk_regiao_id = ?',
- parseInt(req.params.id, 10)).toParam();
+ req.sql.from('regioes')
+ .where('pk_regiao_id = ?', parseInt(req.params.id, 10));
next();
}, query, response('region'));
diff --git a/src/libs/routes/school.js b/src/libs/routes/school.js
index bf3ee4fb1ec97ad326f68f4d536d27776ad64531..6c92430b425d3b9fde8c682216c8f6a10f07b75f 100644
--- a/src/libs/routes/school.js
+++ b/src/libs/routes/school.js
@@ -1,6 +1,6 @@
const express = require('express');
-const schoolApp = express();
+const schoolApp = express.Router();
const libs = `${process.cwd()}/libs`;
@@ -22,40 +22,38 @@ const response = require(`${libs}/middlewares/response`);
// .field('nome_entidade', 'name')
// .field('ano_censo', 'year')
// .field('fk_cod_estado')
-// .field('fk_cod_municipio')
-// .toParam();
+// .field('fk_cod_municipio');
// next();
// }, query, response('school'));
+// Get a school by it's id
schoolApp.get('/:id', (req, res, next) => {
- req.sql = squel.select().from('escolas').where('pk_escola_id = ?',
- parseInt(req.params.id, 10)).toParam();
+ req.sql.from('escolas')
+ .where('pk_escola_id = ?', parseInt(req.params.id, 10));
next();
}, query, response('school'));
+// Get all schools from a state
schoolApp.get('/state/:id', (req, res, next) => {
- req.sql = squel.select().from('escolas')
+ req.sql.from('escolas')
.field('pk_escola_id')
- .field('nome_entidade', 'name')
- .field('ano_censo', 'year')
+ .field('nome_entidade')
+ .field('ano_censo')
.field('fk_cod_estado')
.field('fk_cod_municipio')
- .where('fk_cod_estado = ?',
- parseInt(req.params.id, 10))
- .toParam();
+ .where('fk_cod_estado = ?', parseInt(req.params.id, 10));
next();
}, query, response('school'));
+// Get all schools from a city
schoolApp.get('/city/:id', (req, res, next) => {
- req.sql = squel.select().from('escolas')
+ req.sql.from('escolas')
.field('pk_escola_id')
- .field('nome_entidade', 'name')
- .field('ano_censo', 'year')
+ .field('nome_entidade')
+ .field('ano_censo')
.field('fk_cod_estado')
.field('fk_cod_municipio')
- .where('fk_cod_municipio = ?',
- parseInt(req.params.id, 10))
- .toParam();
+ .where('fk_cod_municipio = ?', parseInt(req.params.id, 10));
next();
}, query, response('school'));
diff --git a/src/libs/routes/state.js b/src/libs/routes/state.js
index 637149f1a9b9db0fb90a7ccdfaffb4381c406152..75e1c0b7835901804ea78e459b1fe0050ec03631 100644
--- a/src/libs/routes/state.js
+++ b/src/libs/routes/state.js
@@ -1,6 +1,6 @@
const express = require('express');
-const stateApp = express();
+const stateApp = express.Router();
const libs = `${process.cwd()}/libs`;
@@ -10,20 +10,23 @@ const query = require(`${libs}/middlewares/query`);
const response = require(`${libs}/middlewares/response`);
+// Get all states
stateApp.get('/', (req, res, next) => {
- req.sql = squel.select().from('estados').toParam();
+ req.sql.from('estados');
next();
}, query, response('state'));
+// Get a state
stateApp.get('/:id', (req, res, next) => {
- req.sql = squel.select().from('estados').where('pk_estado_id = ?',
- parseInt(req.params.id, 10)).toParam();
+ req.sql.from('estados')
+ .where('pk_estado_id = ?', parseInt(req.params.id, 10));
next();
}, query, response('state'));
+// Get all states from a region
stateApp.get('/region/:id', (req, res, next) => {
- req.sql = squel.select().from('estados').where('fk_regiao_id = ?',
- parseInt(req.params.id, 10)).toParam();
+ req.sql.from('estados')
+ .where('fk_regiao_id = ?', parseInt(req.params.id, 10));
next();
}, query, response('state'));
diff --git a/src/server.js b/src/server.js
index b77fb6cfd5409e003afb4da268478e9b524d3ac8..0eef8dfa5fb4764522f0b1c0be02da239603d347 100644
--- a/src/server.js
+++ b/src/server.js
@@ -8,15 +8,16 @@ const log = require(`${libs}/log`)(module);
const app = require(`${libs}/app`);
-const mongoose = require('./libs/db/mongoose');
-
-const db = mongoose();
-
process.env.NODE_ENV = process.env.NODE_ENV || 'development';
-app.set('port', config.get('port') || 3000);
+app.set('port', process.env.PORT || config.get('port') || 3000);
+
+// Set default ip: first environment variable IOP, then configuration and last '127.0.0.1'
+app.set('ip', process.env.IP || config.get('ip') || '127.0.0.1');
const server = app.listen(app.get('port'), () => {
- debug(`Express server listening on port ${server.address().port}`);
- log.info(`Express server listening on port ${config.get('port')}`);
+ log.info(`Express server listening on port ${server.address().port}`);
});
+
+// For testing
+module.exports = server;
diff --git a/src/test/test.js b/src/test/test.js
index dde277d0dec15186290a5a0aa992dd60d8e5c7a4..066b7b77c9651dbde50b97cd6ab730c78053d27b 100644
--- a/src/test/test.js
+++ b/src/test/test.js
@@ -1,9 +1,15 @@
+process.env.NODE_ENV = 'test';
+
const chai = require('chai');
const dirtyChai = require('dirty-chai');
chai.use(dirtyChai);
+const chaiXml = require('chai-xml');
+
+chai.use(chaiXml);
+
const chaiHttp = require('chai-http');
const assert = chai.assert;
@@ -12,14 +18,129 @@ const expect = chai.expect;
const should = chai.should(); // actually call the function
-const server = require('../libs/app');
+const libs = `${process.cwd()}/libs`;
+
+const server = require(`${libs}/app`);
chai.use(chaiHttp);
+describe('API is running', () => {
+ it('should respond it\'s running', (done) => {
+ chai.request(server)
+ .get('/api/v1')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('msg');
+ done();
+ })
+ });
+});
+
describe('request enrollments', () => {
+ it('should list the year range', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment/year_range')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('start_year');
+ res.body.result[0].should.have.property('end_year');
+ done();
+ });
+ });
+
+ it('should list the education level', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment/education_level')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('id');
+ res.body.result[0].should.have.property('name');
+ done();
+ });
+ });
+
+ it('should list the administrative dependencies', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment/adm_dependency ')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('id');
+ res.body.result[0].should.have.property('name');
+ done();
+ });
+ });
+
it('should list enrollments', (done) => {
chai.request(server)
- .get('/v1/enrollment')
+ .get('/api/v1/enrollment')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('name');
+ res.body.result[0].should.have.property('total');
+ done();
+ });
+ });
+
+ it('should list enrollments with valid filters', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment?filter=min_year:2010,state:41')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('name');
+ res.body.result[0].should.have.property('total');
+ done();
+ });
+ });
+
+ it('should list enrollments with invalid filters', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment?filter=foo:2010,bar:41')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('name');
+ res.body.result[0].should.have.property('total');
+ done();
+ });
+ });
+
+ it('should list enrollments with valid dimensions', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment?dims=region,state,adm_dependency_id,location_id&filter=min_year:2014,region:4')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('region_name');
+ res.body.result[0].should.have.property('state_name');
+ res.body.result[0].should.have.property('adm_dependency_name');
+ res.body.result[0].should.have.property('total');
+ done();
+ });
+ });
+
+ it('should list enrollments with invalid dimensions', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment?dims=foo,bar')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -30,12 +151,32 @@ describe('request enrollments', () => {
done();
});
});
+
+ it('should list enrollments with valid dimensions and filters', (done) => {
+ chai.request(server)
+ .get('/api/v1/enrollment?dims=region,state,education_level_id,school&filter=min_year:2013,max_year:2014,city:3287')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('region_name');
+ res.body.result[0].should.have.property('state_name');
+ res.body.result[0].should.have.property('school_name');
+ res.body.result[0].should.have.property('education_level');
+ res.body.result[0].should.have.property('total');
+ res.body.result[0].should.have.property('year');
+ done();
+ });
+ });
+
+
});
describe('request regions', () => {
it('should list all regions', (done) => {
chai.request(server)
- .get('/v1/region')
+ .get('/api/v1/region')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -49,7 +190,7 @@ describe('request regions', () => {
it('should list region by id', (done) => {
chai.request(server)
- .get('/v1/region/1')
+ .get('/api/v1/region/1')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -66,7 +207,7 @@ describe('request regions', () => {
describe('request states', () => {
it('should list all states', (done) => {
chai.request(server)
- .get('/v1/state')
+ .get('/api/v1/state')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -81,7 +222,7 @@ describe('request states', () => {
it('should list a state by id', (done) => {
chai.request(server)
- .get('/v1/state/11')
+ .get('/api/v1/state/11')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -97,7 +238,7 @@ describe('request states', () => {
it('should list states by region id', (done) => {
chai.request(server)
- .get('/v1/state/region/1')
+ .get('/api/v1/state/region/1')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -114,7 +255,7 @@ describe('request states', () => {
describe('request cities', () => {
it('should list all cities', (done) => {
chai.request(server)
- .get('/v1/city')
+ .get('/api/v1/city')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -130,7 +271,7 @@ describe('request cities', () => {
it('should list a city by id', (done) => {
chai.request(server)
- .get('/v1/city/1')
+ .get('/api/v1/city/1')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -146,7 +287,23 @@ describe('request cities', () => {
it('should list a city by codigo_ibge', (done) => {
chai.request(server)
- .get('/v1/city/ibge/1200013')
+ .get('/api/v1/city/ibge/1200013')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('pk_municipio_id');
+ res.body.result[0].should.have.property('fk_estado_id');
+ res.body.result[0].should.have.property('nome');
+ res.body.result[0].should.have.property('codigo_ibge');
+ done();
+ });
+ });
+
+ it('should list all cities from a state', (done) => {
+ chai.request(server)
+ .get('/api/v1/city/state/41')
.end((err, res) => {
res.should.have.status(200);
res.should.be.json;
@@ -157,6 +314,85 @@ describe('request cities', () => {
res.body.result[0].should.have.property('nome');
res.body.result[0].should.have.property('codigo_ibge');
done();
+ })
+ })
+});
+
+describe('request schools', () => {
+ it('should list a school by id', (done) => {
+ chai.request(server)
+ .get('/api/v1/school/185588')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('pk_escola_id');
+ res.body.result[0].should.have.property('ano_censo');
+ res.body.result[0].should.have.property('cod_entidade');
+ res.body.result[0].should.have.property('nome_entidade');
+ done();
+ });
+ });
+
+ it('should list all schools from a state', (done) => {
+ chai.request(server)
+ .get('/api/v1/school/state/41')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('pk_escola_id');
+ res.body.result[0].should.have.property('ano_censo');
+ res.body.result[0].should.have.property('nome_entidade');
+ done();
+ });
+ });
+
+ it('should list all schools from a city', (done) => {
+ chai.request(server)
+ .get('/api/v1/school/city/3287')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ res.body.should.have.property('result');
+ res.body.result.should.be.a('array');
+ res.body.result[0].should.have.property('pk_escola_id');
+ res.body.result[0].should.have.property('ano_censo');
+ res.body.result[0].should.have.property('nome_entidade');
+ done();
+ })
+ })
+});
+
+describe('test response', () => {
+ it('should list all regions in json', (done) => {
+ chai.request(server)
+ .get('/api/v1/region')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.json;
+ done();
+ });
+ });
+
+ it('should list all regions in xml', (done) => {
+ chai.request(server)
+ .get('/api/v1/region?format=xml')
+ .end((err, res) => {
+ res.should.have.status(200);
+ res.should.be.xml;
+ done();
+ });
+ });
+
+ it('should list all regions in csv', (done) => {
+ chai.request(server)
+ .get('/api/v1/region?format=csv')
+ .end((err, res) => {
+ res.should.have.status(200);
+ done();
});
});
});