diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - 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. - - - Copyright (C) - - 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 . - -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: - - Copyright (C) - 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 -. - - 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 -. diff --git a/README.md b/README.md index 4a55ec2..5b3d22c 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ PHP SDK for interacting with the Smart Send API. +Check our [Swagger documentation](https://app.swaggerhub.com/apis/smartsendio/webshop/) for more details. + ## Install Via Composer @@ -26,8 +28,8 @@ require __DIR__.'/../vendor/autoload.php'; And finally create an instance of the SDK: ```php -$client = new Smartsendio\Api\Adapters\GuzzleClientAdapter(new \GuzzleHttp\Client()); // Any client implementing ClientInterface -$api = new Smartsendio\Api\ApiFactory($client); +$client = new Smartsendio\Api\Adapters\GuzzleClientAdapter(new \GuzzleHttp\Client()); +$api = new Smartsendio\Api\ApiFactory($client); // Any client that implements ClientInterface can be used $api->apiToken('API_TOKEN_HERE')->website('WEBSITE'); // Set the authentication parameters ``` @@ -35,32 +37,40 @@ $api->apiToken('API_TOKEN_HERE')->website('WEBSITE'); // Set the authentication Demo mode can be used for testing and is activated like so: ```php -$api->demo(); // Not the api is in demo mode. +$api->demo(); // Api is now in demo mode. ``` ### Fetching agents -Agents are fetched using the `agent` API. +Agents are fetched using the `agents` API. ```php // Example: All agents for a given carrier in a zipcode -$response = $api->agents() +$response = $api->agents() // AgentApiInterface ->carrier('postnord') ->country('DK') ->zipcode('2100') - ->get(); // ApiResponseInterface + ->get(); // PaginatedAgentApiResponseInterface // Example: The closest agents for a given carrier based on a given address -$response = $api->agents() +$response = $api->agents() // AgentApiInterface ->carrier('postnord') ->country('DK') ->zipcode('2100') ->street('Nordre Frihavnsgade 1') - ->closest(); // ApiResponseInterface + ->closest(); // PaginatedAgentApiResponseInterface + +// Example: Get a single agent using the carries own unique agent number +$response = $api->agents() // AgentApiInterface + ->carrier('postnord') + ->country('DK') + ->lookup('1234567'); // AgentApiResponseInterface ``` ### Shipments +Booking of shipments (creating shipping labels) are done by firstly creating the complex `Shipment` object and passing that to the `shipments` API: + ```php -$item = new \Smartsendio\Api\Data\Item([ +$item = \Smartsendio\Api\Data\Item::make([ 'internal_id' => '000000123', 'internal_reference' => 'PRODUCT-1231456', 'sku' => '012345678', @@ -78,7 +88,7 @@ $item = new \Smartsendio\Api\Data\Item([ 'total_tax_amount' => 20.3, ]); -$parcel = new \Smartsendio\Api\Data\Parcel([ +$parcel = \Smartsendio\Api\Data\Parcel::make([ 'internal_id' => '00100025556', 'internal_reference' => 'ABC12345678', 'weight' => 9.3, @@ -109,16 +119,21 @@ $shipment->setReceiver([ 'email' => 'email@example.com', ])->addParcel($parcel); -$api->book($shipment); // ApiResponseInterface +$response = $api->booking() // BookingApiInterface + ->shipment($shipment); // BookingApiResponseInterface ``` ### Dealing with errors This is how to deal with API errors: ```php -$api->shipments()->book($shipment); // ApiResponseInterface -$api->isSuccessful(); // false -$api->getError(); // ApiErrorInterface +$response = $api->booking()->shipment($shipment); // ApiResponseInterface +$response->isSuccessful(); // false +$error = $response->getError(); // ApiErrorInterface +$error->getId(); // Unique id of the error +$error->getCode(); // Error code describing the type of error +$error->getMessage(); // Description of the error +$error->getErrors(); // Return each individual error ``` ## Change log diff --git a/src/AbstractApiResponse.php b/src/AbstractApiResponse.php new file mode 100644 index 0000000..ec26b78 --- /dev/null +++ b/src/AbstractApiResponse.php @@ -0,0 +1,63 @@ +api_response = $api_response; + } + + public function getDecodedData(): array + { + return $this->api_response->getDecodedData(); + } + + public function isSuccessful(): bool + { + return $this->api_response->isSuccessful(); + } + + public function getResponse(): Psr7ResponseInterface + { + return $this->api_response->getResponse(); + } + + public function hasData(): bool + { + return $this->api_response->hasData(); + } + + public function hasLinks(): bool + { + return $this->api_response->hasData(); + } + + public function getLinks(): array + { + return $this->api_response->getLinks(); + } + + public function hasMeta(): bool + { + return $this->api_response->hasMeta(); + } + + public function getMeta(): array + { + return $this->api_response->getMeta(); + } + + public function getError(): ApiErrorInterface + { + return $this->api_response->getError(); + } +} diff --git a/src/AgentApi.php b/src/AgentApi.php index 9963d0b..3c6b076 100644 --- a/src/AgentApi.php +++ b/src/AgentApi.php @@ -4,6 +4,7 @@ use InvalidArgumentException; use Smartsendio\Api\Contracts\AgentApiInterface; +use Smartsendio\Api\Contracts\AgentApiResponseInterface; use Smartsendio\Api\Contracts\ClientInterface; use Smartsendio\Api\Contracts\ApiResponseInterface; use Smartsendio\Api\Traits\PaginatableTrait; @@ -58,7 +59,7 @@ public function street(string $street): AgentApiInterface return $this; } - public function lookup(string $agentNo): ApiResponseInterface + public function lookup(string $agentNo): AgentApiResponseInterface { $this->checkRequiredAuthenticationParameters(); @@ -76,24 +77,28 @@ public function lookup(string $agentNo): ApiResponseInterface 'agentno' => $agentNo, ]; - return $this->client->get( + $apiResponse = $this->client->get( $this->getBaseUri($this->api_endpoint_base).$this->getPathString($pathParameters), [ 'api_token' => $this->token, ] ); + + return new AgentApiResponse($apiResponse); } - public function find(string $id): ApiResponseInterface + public function find(string $id): AgentApiResponseInterface { $this->checkRequiredAuthenticationParameters(); - return $this->client->get( + $apiResponse = $this->client->get( $this->getBaseUri($this->api_endpoint_base).$id.'/', [ 'api_token' => $this->token, ] ); + + return new AgentApiResponse($apiResponse); } public function get(): ApiResponseInterface @@ -115,12 +120,14 @@ public function get(): ApiResponseInterface 'street' => $this->street, ]); - return $this->client->get( + $apiResponse = $this->client->get( $this->getBaseUri($this->api_endpoint_base).$this->getPathString($pathParameters), [ 'api_token' => $this->token, ] ); + + return new PaginatedAgentApiResponse($apiResponse); } public function closest(): ApiResponseInterface @@ -142,12 +149,14 @@ public function closest(): ApiResponseInterface 'street' => $this->street, ]); - return $this->client->get( + $apiResponse = $this->client->get( $this->getBaseUri($this->api_endpoint_base).'closest/'.$this->getPathString($pathParameters), [ 'api_token' => $this->token, ] ); + + return new PaginatedAgentApiResponse($apiResponse); } /** @throws InvalidArgumentException */ diff --git a/src/AgentApiResponse.php b/src/AgentApiResponse.php new file mode 100644 index 0000000..c7a2209 --- /dev/null +++ b/src/AgentApiResponse.php @@ -0,0 +1,21 @@ +data)) { + $this->data = new AgentResponse($this->api_response->getDecodedData()); + } + + return $this->data; + } +} diff --git a/src/ApiError.php b/src/ApiError.php index ef47cf4..ba9a25d 100644 --- a/src/ApiError.php +++ b/src/ApiError.php @@ -2,12 +2,13 @@ namespace Smartsendio\Api; +use Smartsendio\Api\Contracts\ApiErrorInterface; use Smartsendio\Api\Contracts\ApiErrorLinksInterface; -use Smartsendio\Api\Traits\ArrayConstructableTrait; +use Smartsendio\Api\Traits\ArrayMakableTrait; -class ApiError implements Contracts\ApiErrorInterface +class ApiError implements ApiErrorInterface { - use ArrayConstructableTrait; + use ArrayMakableTrait; /** @ApiErrorLinksInterface */ public $links; @@ -44,9 +45,6 @@ public function getMessage(): string return $this->message; } - /** - * @inheritDoc - */ public function getErrors(): array { return $this->errors; @@ -54,7 +52,7 @@ public function getErrors(): array private function setLinks(array $links): void { - $this->links = new ApiErrorLinks($links); + $this->links = ApiErrorLinks::make($links); } private function setCode(string $code): void @@ -62,11 +60,16 @@ private function setCode(string $code): void $this->code = $code; } - private function setId(string $message): void + private function setMessage(string $message): void { $this->message = $message; } + private function setId(string $id): void + { + $this->id = $id; + } + private function setErrors(array $errors): void { $this->errors = $errors; diff --git a/src/ApiErrorLinks.php b/src/ApiErrorLinks.php index 4c2a6d9..70c9057 100644 --- a/src/ApiErrorLinks.php +++ b/src/ApiErrorLinks.php @@ -2,11 +2,11 @@ namespace Smartsendio\Api; -use Smartsendio\Api\Traits\ArrayConstructableTrait; +use Smartsendio\Api\Traits\ArrayMakableTrait; class ApiErrorLinks implements Contracts\ApiErrorLinksInterface { - use ArrayConstructableTrait; + use ArrayMakableTrait; /** @string */ public $about; diff --git a/src/ApiFactory.php b/src/ApiFactory.php index bf046d2..92b3631 100644 --- a/src/ApiFactory.php +++ b/src/ApiFactory.php @@ -4,8 +4,8 @@ use Smartsendio\Api\Contracts\AgentApiInterface; use Smartsendio\Api\Contracts\ApiFactoryInterface; +use Smartsendio\Api\Contracts\BookingApiInterface; use Smartsendio\Api\Contracts\ClientInterface; -use Smartsendio\Api\Contracts\ShipmentsApiInterface; use Smartsendio\Api\Traits\ApiAuthenticationTrait; class ApiFactory implements ApiFactoryInterface @@ -35,9 +35,9 @@ public function agents(array $parameters = []): AgentApiInterface return $api; } - public function shipments(array $parameters = []): ShipmentsApiInterface + public function bookings(array $parameters = []): BookingApiInterface { - $api = new ShipmentApi($this->client); + $api = new BookingApi($this->client); if ($this->token) { $api->token($this->token); diff --git a/src/ApiResponse.php b/src/ApiResponse.php index d5714bf..ccadcdd 100644 --- a/src/ApiResponse.php +++ b/src/ApiResponse.php @@ -2,9 +2,9 @@ namespace Smartsendio\Api; +use OutOfBoundsException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface; -use RuntimeException; use Smartsendio\Api\Contracts\ApiErrorInterface; use Smartsendio\Api\Contracts\ApiResponseInterface; @@ -37,9 +37,73 @@ public function hasData(): bool return false; } + if (empty($responseArray['data'])) { + return false; + } + return true; } + public function hasLinks(): bool + { + $responseArray = $this->getDecodedResponse(); + + if (!isset($responseArray['links'])) { + return false; + } + + if (empty($responseArray['links'])) { + return false; + } + + return true; + } + + public function getLinks(): array + { + $responseArray = $this->getDecodedResponse(); + + if (! isset($responseArray['links'])) { + throw new OutOfBoundsException('Unexpected response, missing links'); + } + + if (empty($responseArray['links'])) { + throw new OutOfBoundsException('Unexpected response, no links'); + } + + return $responseArray['links']; + } + + public function hasMeta(): bool + { + $responseArray = $this->getDecodedResponse(); + + if (!isset($responseArray['meta'])) { + return false; + } + + if (empty($responseArray['meta'])) { + return false; + } + + return true; + } + + public function getMeta(): array + { + $responseArray = $this->getDecodedResponse(); + + if (! isset($responseArray['meta'])) { + throw new OutOfBoundsException('Unexpected response, missing meta'); + } + + if (empty($responseArray['meta'])) { + throw new OutOfBoundsException('Unexpected response, no meta'); + } + + return $responseArray['meta']; + } + public function getError(): ApiErrorInterface { $responseArray = $this->getDecodedResponse(); @@ -47,12 +111,12 @@ public function getError(): ApiErrorInterface return new ApiError($responseArray); } - public function getData(): array + public function getDecodedData(): array { $responseArray = $this->getDecodedResponse(); if (! isset($responseArray['data'])) { - throw new RuntimeException('Unexpected response, missing data'); + throw new OutOfBoundsException('Unexpected response, missing data'); } return $responseArray['data']; diff --git a/src/ShipmentApi.php b/src/BookingApi.php similarity index 68% rename from src/ShipmentApi.php rename to src/BookingApi.php index 1da5912..ebf7fe5 100644 --- a/src/ShipmentApi.php +++ b/src/BookingApi.php @@ -3,18 +3,22 @@ namespace Smartsendio\Api; use InvalidArgumentException; +use Smartsendio\Api\Contracts\BookingApiInterface; +use Smartsendio\Api\Contracts\BookingApiResponseInterface; use Smartsendio\Api\Contracts\ClientInterface; -use Smartsendio\Api\Contracts\ApiResponseInterface; use Smartsendio\Api\Data\Shipment; +use Smartsendio\Api\Traits\PaginatableTrait; -class ShipmentApi extends AbstractApi implements Contracts\ShipmentsApiInterface +class BookingApi extends AbstractApi implements BookingApiInterface { + use PaginatableTrait; + /** @var ClientInterface */ protected $client; protected $api_version = '1'; - protected $api_endpoint_base = 'shipments'; + protected $api_endpoint_base = 'labels'; public function __construct(ClientInterface $client) { @@ -26,17 +30,19 @@ public function getVersion(): string return $this->api_version; } - public function book(Shipment $shipment): ApiResponseInterface + public function shipment(Shipment $shipment): BookingApiResponseInterface { $this->checkBasicRequiredParameters(); - return $this->client->post( + $apiResponse = $this->client->post( $this->getBaseUri($this->api_endpoint_base), [ 'api_token' => $this->token, ], $shipment->toArray() ); + + return new BookingApiResponse($apiResponse); } /** @throws InvalidArgumentException */ diff --git a/src/BookingApiResponse.php b/src/BookingApiResponse.php new file mode 100644 index 0000000..99f9589 --- /dev/null +++ b/src/BookingApiResponse.php @@ -0,0 +1,21 @@ +data)) { + $this->data = BookingResponse::make($this->api_response->getDecodedData()); + } + + return $this->data; + } +} diff --git a/src/Contracts/AgentApiInterface.php b/src/Contracts/AgentApiInterface.php index 1a25d59..edf32fb 100644 --- a/src/Contracts/AgentApiInterface.php +++ b/src/Contracts/AgentApiInterface.php @@ -12,9 +12,9 @@ public function postalcode(string $postalcode): AgentApiInterface; public function street(string $street): AgentApiInterface; - public function lookup(string $agentNo): ApiResponseInterface; + public function lookup(string $agentNo): AgentApiResponseInterface; - public function find(string $id): ApiResponseInterface; + public function find(string $id): AgentApiResponseInterface; public function get(): ApiResponseInterface; diff --git a/src/Contracts/AgentApiResponseInterface.php b/src/Contracts/AgentApiResponseInterface.php new file mode 100644 index 0000000..ecb2664 --- /dev/null +++ b/src/Contracts/AgentApiResponseInterface.php @@ -0,0 +1,10 @@ +id = $id; + } + + public function setType(string $type): void + { + $this->type = $type; + } + + public function setAgentNo(string $agent_no): void + { + $this->agent_no = $agent_no; + } + + public function setCarrier(string $carrier): void + { + $this->carrier = $carrier; + } + + public function setDistance(float $distance): void + { + $this->distance = $distance; + } + + public function setCompany(string $company): void + { + $this->company = $company; + } + + public function setNameLine1(string $name_line1): void + { + $this->name_line1 = $name_line1; + } + + public function setNameLine2(string $name_line2): void + { + $this->name_line2 = $name_line2; + } + + public function setAddressLine1(string $address_line1): void + { + $this->address_line1 = $address_line1; + } + + public function setAddressLine2(string $address_line2): void + { + $this->address_line2 = $address_line2; + } + + public function setPostalCode(string $postal_code): void + { + $this->postal_code = $postal_code; + } + + public function setCity(string $city): void + { + $this->city = $city; + } + + public function setCountry(string $country): void + { + $this->country = $country; + } +} diff --git a/src/Data/Responses/Booking/Parcel.php b/src/Data/Responses/Booking/Parcel.php new file mode 100644 index 0000000..8a6c07a --- /dev/null +++ b/src/Data/Responses/Booking/Parcel.php @@ -0,0 +1,68 @@ +parcel_id = $parcel_id; + } + + public function setParcelInternalId(string $parcel_internal_id): void + { + $this->parcel_internal_id = $parcel_internal_id; + } + + public function setParcelInternalReference(string $parcel_internal_reference): void + { + $this->parcel_internal_reference = $parcel_internal_reference; + } + + public function setCarrierCode(string $carrier_code): void + { + $this->carrier_code = $carrier_code; + } + + public function setCarrierName(string $carrier_name): void + { + $this->carrier_name = $carrier_name; + } + + public function setTrackingCode(string $tracking_code): void + { + $this->tracking_code = $tracking_code; + } + + public function setTrackingLink(string $tracking_link): void + { + $this->tracking_link = $tracking_link; + } +} diff --git a/src/Data/Responses/Booking/Pdf.php b/src/Data/Responses/Booking/Pdf.php new file mode 100644 index 0000000..0ca0465 --- /dev/null +++ b/src/Data/Responses/Booking/Pdf.php @@ -0,0 +1,28 @@ +link = $link; + } + + public function setBase64Encoded(string $base_64_encoded): void + { + $this->base_64_encoded = $base_64_encoded; + } +} diff --git a/src/Data/Responses/BookingResponse.php b/src/Data/Responses/BookingResponse.php new file mode 100644 index 0000000..a79cdb4 --- /dev/null +++ b/src/Data/Responses/BookingResponse.php @@ -0,0 +1,86 @@ +type = $type; + } + + public function setShipmentId(string $shipment_id): void + { + $this->shipment_id = $shipment_id; + } + + public function setShipmentInternalId(string $shipment_internal_id): void + { + $this->shipment_internal_id = $shipment_internal_id; + } + + public function setShipmentInternalReference(string $shipment_internal_reference): void + { + $this->shipment_internal_reference = $shipment_internal_reference; + } + + public function setCarrierCode(string $carrier_code): void + { + $this->carrier_code = $carrier_code; + } + + public function setCarrierName(string $carrier_name): void + { + $this->carrier_name = $carrier_name; + } + + public function setPdf(array $pdf): void + { + $this->pdf = Pdf::make($pdf); + } + + public function setParcels(array $parcels): void + { + $this->parcels = []; + + foreach ($parcels as $parcel) { + $this->parcels[] = Parcel::make($parcel); + } + } +} diff --git a/src/Data/Sender.php b/src/Data/Sender.php index 3e41657..d5bfd0c 100644 --- a/src/Data/Sender.php +++ b/src/Data/Sender.php @@ -4,12 +4,12 @@ use Smartsendio\Api\Contracts\ArrayableInterface; use Smartsendio\Api\Traits\ArrayableTrait; -use Smartsendio\Api\Traits\ArrayConstructableTrait; +use Smartsendio\Api\Traits\ArrayMakableTrait; class Sender implements ArrayableInterface { use ArrayableTrait; - use ArrayConstructableTrait; + use ArrayMakableTrait; /** @string */ public $internal_id; diff --git a/src/Data/Services.php b/src/Data/Services.php index d839533..447d884 100644 --- a/src/Data/Services.php +++ b/src/Data/Services.php @@ -4,12 +4,12 @@ use Smartsendio\Api\Contracts\ArrayableInterface; use Smartsendio\Api\Traits\ArrayableTrait; -use Smartsendio\Api\Traits\ArrayConstructableTrait; +use Smartsendio\Api\Traits\ArrayMakableTrait; class Services implements ArrayableInterface { use ArrayableTrait; - use ArrayConstructableTrait; + use ArrayMakableTrait; /** * Email address used for carrier email notification. diff --git a/src/Data/Shipment.php b/src/Data/Shipment.php index 2bbb083..b141199 100644 --- a/src/Data/Shipment.php +++ b/src/Data/Shipment.php @@ -4,12 +4,12 @@ use Smartsendio\Api\Contracts\ArrayableInterface; use Smartsendio\Api\Traits\ArrayableTrait; -use Smartsendio\Api\Traits\ArrayConstructableTrait; +use Smartsendio\Api\Traits\ArrayMakableTrait; class Shipment implements ArrayableInterface { use ArrayableTrait; - use ArrayConstructableTrait; + use ArrayMakableTrait; /** @string */ public $internal_id; diff --git a/src/PaginatedAgentApiResponse.php b/src/PaginatedAgentApiResponse.php new file mode 100644 index 0000000..4b56467 --- /dev/null +++ b/src/PaginatedAgentApiResponse.php @@ -0,0 +1,30 @@ +data)) { + $this->data = []; + foreach ($this->api_response->getDecodedData() as $agent) { + $this->data[] = AgentResponse::make($agent); + } + } + + return $this->data; + } +} diff --git a/src/Traits/ArrayConstructableTrait.php b/src/Traits/ArrayMakableTrait.php similarity index 65% rename from src/Traits/ArrayConstructableTrait.php rename to src/Traits/ArrayMakableTrait.php index 4887a9c..05f0f45 100644 --- a/src/Traits/ArrayConstructableTrait.php +++ b/src/Traits/ArrayMakableTrait.php @@ -2,10 +2,12 @@ namespace Smartsendio\Api\Traits; -trait ArrayConstructableTrait +trait ArrayMakableTrait { - public function __construct(array $parameters = []) + public static function make(array $parameters = []) { + $instance = new static(); + foreach ($parameters as $key => $value) { if (is_null($value)) { // We are not setting any null values. @@ -14,9 +16,11 @@ public function __construct(array $parameters = []) } $method = 'set'.str_replace('_', '', ucwords($key, '_')); // 'about' => 'setAbout' - if (method_exists(__CLASS__, $method)) { - $this->{$method}($value); + if (method_exists($instance, $method)) { + $instance->{$method}($value); } } + + return $instance; } } diff --git a/src/Traits/PaginatableTrait.php b/src/Traits/PaginatableTrait.php index 41e5529..6ec19de 100644 --- a/src/Traits/PaginatableTrait.php +++ b/src/Traits/PaginatableTrait.php @@ -8,7 +8,7 @@ trait PaginatableTrait { public $page; - public function page(int $page): PaginatableInterface + public function page(int $page): self { $this->page = $page; return $this; diff --git a/tests/Unit/AgentsApiTest.php b/tests/Unit/AgentsApiTest.php index 4177daf..2ab9322 100644 --- a/tests/Unit/AgentsApiTest.php +++ b/tests/Unit/AgentsApiTest.php @@ -5,8 +5,10 @@ use InvalidArgumentException; use PHPUnit\Framework\TestCase; use Smartsendio\Api\AgentApi; +use Smartsendio\Api\Contracts\AgentApiResponseInterface; use Smartsendio\Api\Contracts\ClientInterface; use Smartsendio\Api\Contracts\ApiResponseInterface; +use Smartsendio\Api\PaginatedAgentApiResponse; class AgentsApiTest extends TestCase { @@ -25,16 +27,23 @@ public function setUp(): void /** @test */ public function testFindAgentById() { + $apiResponse = \Mockery::mock(ApiResponseInterface::class); + $apiResponse->shouldReceive('getDecodedData')->andReturn([]); + $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/123/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/agents/123/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn($apiResponse); $response = (new AgentApi($this->client)) ->website('example.com') ->token('TEST-1234') ->find('123'); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(AgentApiResponseInterface::class, $response); } /** @test */ @@ -98,9 +107,16 @@ private function tokenIsRequiresWhenFindingAgentById() /** @test */ public function testCanLookupAgentByAgentNumber() { + $apiResponse = \Mockery::mock(ApiResponseInterface::class); + $apiResponse->shouldReceive('getDecodedData')->andReturn([]); + $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/agentno/123/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/agentno/123/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn($apiResponse); $response = (new AgentApi($this->client)) ->website('example.com') @@ -109,7 +125,7 @@ public function testCanLookupAgentByAgentNumber() ->country('DK') ->lookup('123'); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(AgentApiResponseInterface::class, $response); } /** @test */ @@ -344,8 +360,12 @@ private function countryIsRequiredWhenListingAgents() public function testCanListAgentsForCarrierInCountry() { $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn(\Mockery::mock(ApiResponseInterface::class)); $response = (new AgentApi($this->client)) ->website('example.com') @@ -354,15 +374,19 @@ public function testCanListAgentsForCarrierInCountry() ->country('DK') ->get(); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(PaginatedAgentApiResponse::class, $response); } /** @test */ public function testCanListAgentsForCarrierInCountryPostalcode() { $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/postalcode/2100/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/postalcode/2100/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn(\Mockery::mock(ApiResponseInterface::class)); $response = (new AgentApi($this->client)) ->website('example.com') @@ -372,15 +396,18 @@ public function testCanListAgentsForCarrierInCountryPostalcode() ->postalcode('2100') ->get(); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(PaginatedAgentApiResponse::class, $response); } /** @test */ public function testCanListAgentsForCarrierInCountryPostalcodeStreet() { $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/postalcode/2100/street/some street/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with('https://app.smartsend.io/api/v1/website/example.com/agents/carrier/TESTDK/country/DK/postalcode/2100/street/some street/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn(\Mockery::mock(ApiResponseInterface::class)); $response = (new AgentApi($this->client)) ->website('example.com') @@ -391,7 +418,7 @@ public function testCanListAgentsForCarrierInCountryPostalcodeStreet() ->street('some street') ->get(); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(PaginatedAgentApiResponse::class, $response); } //====================================================================== @@ -514,8 +541,12 @@ private function countryIsRequiredWhenSearchingForClosestAgents() public function testCanFindClosestAgentsForCarrierInCountryPostalcode() { $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/closest/carrier/TESTDK/country/DK/postalcode/2100/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/agents/closest/carrier/TESTDK/country/DK/postalcode/2100/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn(\Mockery::mock(ApiResponseInterface::class)); $response = (new AgentApi($this->client)) ->website('example.com') @@ -525,15 +556,19 @@ public function testCanFindClosestAgentsForCarrierInCountryPostalcode() ->postalcode('2100') ->closest(); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(PaginatedAgentApiResponse::class, $response); } /** @test */ public function testCanFindClosestAgentsForCarrierInCountryPostalcodeStreet() { $this->client->shouldReceive('get') - ->with('https://app.smartsend.io/api/v1/website/example.com/agents/closest/carrier/TESTDK/country/DK/postalcode/2100/street/some street/', ['api_token' => 'TEST-1234']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/agents/closest/carrier/TESTDK/country/DK/postalcode/2100/street/some street/', + [ + 'api_token' => 'TEST-1234', + ] + )->andReturn(\Mockery::mock(ApiResponseInterface::class)); $response = (new AgentApi($this->client)) ->website('example.com') @@ -544,6 +579,6 @@ public function testCanFindClosestAgentsForCarrierInCountryPostalcodeStreet() ->street('some street') ->closest(); - $this->assertInstanceOf(ApiResponseInterface::class, $response); + $this->assertInstanceOf(PaginatedAgentApiResponse::class, $response); } } diff --git a/tests/Unit/ApiErrorTest.php b/tests/Unit/ApiErrorTest.php new file mode 100644 index 0000000..689f853 --- /dev/null +++ b/tests/Unit/ApiErrorTest.php @@ -0,0 +1,70 @@ +apiError = ApiError::make([ + 'links' => [ + 'about' => 'https://smartsend.io/errors/ValidationException', + ], + 'id' => 'UUID-123456-ABCDE-558ABC', + 'code' => 'ValidationException', + 'message' => 'The given data was invalid.', + 'errors' => [ + 'field_name' => [ + 'String describing the error for the given field', + ], + ], + ]); + } + + public function testGetLinks() + { + $this->assertInstanceOf(ApiErrorLinksInterface::class, $this->apiError->getLinks()); + $this->assertEquals( + 'https://smartsend.io/errors/ValidationException', + $this->apiError->getLinks()->getAbout() + ); + } + + public function testGetId() + { + $this->assertEquals('UUID-123456-ABCDE-558ABC', $this->apiError->getId()); + } + + public function testGetCode() + { + $this->assertEquals('ValidationException', $this->apiError->getCode()); + } + + public function testGetMessage() + { + $this->assertEquals('The given data was invalid.', $this->apiError->getMessage()); + } + + public function testGetErrors() + { + $errors = $this->apiError->getErrors(); + + $this->assertIsArray($errors); + + $this->assertCount(1, $errors); + + $this->assertArrayHasKey('field_name', $errors); + + $this->assertIsArray($errors['field_name']); + + $this->assertCount(1, $errors['field_name']); + + $this->assertEquals('String describing the error for the given field', $errors['field_name'][0]); + } +} diff --git a/tests/Unit/ApiFactoryTest.php b/tests/Unit/ApiFactoryTest.php index d72e657..54cc382 100644 --- a/tests/Unit/ApiFactoryTest.php +++ b/tests/Unit/ApiFactoryTest.php @@ -5,8 +5,8 @@ use PHPUnit\Framework\TestCase; use Smartsendio\Api\ApiFactory; use Smartsendio\Api\Contracts\AgentApiInterface; +use Smartsendio\Api\Contracts\BookingApiInterface; use Smartsendio\Api\Contracts\ClientInterface; -use Smartsendio\Api\Contracts\ShipmentsApiInterface; class ApiFactoryTest extends TestCase { @@ -24,8 +24,8 @@ public function testCanResolveAgentsApi() } /** @test */ - public function testCanResolveShipmentsApi() + public function testCanResolveBookingApi() { - $this->assertInstanceOf(ShipmentsApiInterface::class, $this->factory->shipments()); + $this->assertInstanceOf(BookingApiInterface::class, $this->factory->bookings()); } } diff --git a/tests/Unit/ApiResponseTest.php b/tests/Unit/ApiResponseTest.php index 8be5d78..90381f0 100644 --- a/tests/Unit/ApiResponseTest.php +++ b/tests/Unit/ApiResponseTest.php @@ -90,36 +90,278 @@ public function testHasDataReturnsFalseWhenNoDataReturned(): void } /** @test */ - public function testGetThrowsExceptionForMissingData(): void + public function testHasDataReturnsFalseWhenEmptyDataReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['data' => null])); + $response = new ApiResponse($psrResponse); + + $this->assertFalse($response->hasData()); + } + + /** @test */ + public function testGetDecodedDataThrowsExceptionWhenNoData(): void { $psrResponse = new Response(200, [], json_encode(['not-data-field' => 'value'])); $response = new ApiResponse($psrResponse); if (method_exists($this, 'expectException')) { - $this->expectException(\RuntimeException::class); + $this->expectException(\OutOfBoundsException::class); + + $response->getDecodedData(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getDecodedData(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + + /** @test */ + public function testGetDecodedDataThrowsExceptionWhenEmptyData(): void + { + $psrResponse = new Response(200, [], json_encode(['data' => null])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); - $response->getData(); // This should throw an exception + $response->getDecodedData(); // This should throw an exception } else { // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 try { - $response->getData(); // This should throw an exception + $response->getDecodedData(); // This should throw an exception } catch (\Exception $exception) { - $this->assertInstanceOf(\RuntimeException::class, $exception); + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); } } } /** @test */ - public function testReturnsDataFromResponse(): void + public function testGetDecodedDataFromResponse(): void { $psrResponse = new Response(200, [], json_encode(['data' => ['field1' => 'valueA', 'field2' => 'valueB']])); $response = new ApiResponse($psrResponse); - $data = $response->getData(); + $data = $response->getDecodedData(); $this->assertEquals(['field1' => 'valueA', 'field2' => 'valueB'], $data); } + //====================================================================== + // Links + //====================================================================== + + /** @test */ + public function testHasLinkReturnsTrueWhenLinksReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['links' => ['link1' => 'value']])); + $response = new ApiResponse($psrResponse); + + $this->assertTrue($response->hasLinks()); + } + + /** @test */ + public function testHasLinksReturnsFalseWhenNoLinksReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['not-links-field' => 'value'])); + $response = new ApiResponse($psrResponse); + + $this->assertFalse($response->hasLinks()); + } + + /** @test */ + public function testHasLinksReturnsFalseWhenEmptyLinksReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['links' => null])); + $response = new ApiResponse($psrResponse); + + $this->assertFalse($response->hasLinks()); + } + + /** @test */ + public function testHasLinksReturnsFalseWhenEmptyLinksArrayReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['links' => []])); + $response = new ApiResponse($psrResponse); + + $this->assertFalse($response->hasLinks()); + } + + /** @test */ + public function testGetLinksThrowsExceptionWhenNoLinks(): void + { + $psrResponse = new Response(200, [], json_encode(['not-links-field' => 'value'])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); + + $response->getLinks(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getLinks(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + + /** @test */ + public function testGetLinksThrowsExceptionWhenEmptyLinks(): void + { + $psrResponse = new Response(200, [], json_encode(['links' => null])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); + + $response->getLinks(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getLinks(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + + /** @test */ + public function testGetLinksThrowsExceptionWhenEmptyLinksArray(): void + { + $psrResponse = new Response(200, [], json_encode(['links' => []])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); + + $response->getLinks(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getLinks(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + + /** @test */ + public function testGetLinksFromResponse(): void + { + $psrResponse = new Response(200, [], json_encode(['links' => ['link1' => 'valueA', 'link2' => 'valueB']])); + $response = new ApiResponse($psrResponse); + + $data = $response->getLinks(); + + $this->assertEquals(['link1' => 'valueA', 'link2' => 'valueB'], $data); + } + + //====================================================================== + // Meta + //====================================================================== + + /** @test */ + public function testHasMetaReturnsTrueWhenMetaReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['meta' => ['field' => 'value']])); + $response = new ApiResponse($psrResponse); + + $this->assertTrue($response->hasMeta()); + } + + /** @test */ + public function testHasMetaReturnsFalseWhenNoMetaReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['not-meta-field' => 'value'])); + $response = new ApiResponse($psrResponse); + + $this->assertFalse($response->hasMeta()); + } + + /** @test */ + public function testHasMetaReturnsFalseWhenEmptyMetaArrayReturned(): void + { + $psrResponse = new Response(200, [], json_encode(['meta' => []])); + $response = new ApiResponse($psrResponse); + + $this->assertFalse($response->hasMeta()); + } + + /** @test */ + public function testGetMetaFromResponse(): void + { + $psrResponse = new Response(200, [], json_encode(['meta' => ['field1' => 'valueA', 'field2' => 'valueB']])); + $response = new ApiResponse($psrResponse); + + $meta = $response->getMeta(); + + $this->assertEquals(['field1' => 'valueA', 'field2' => 'valueB'], $meta); + } + + /** @test */ + public function testGetMetaThrowsExceptionWhenNoMeta(): void + { + $psrResponse = new Response(200, [], json_encode(['not-meta-field' => 'value'])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); + + $response->getMeta(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getMeta(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + + /** @test */ + public function testGetMetaThrowsExceptionWhenEmptyMeta(): void + { + $psrResponse = new Response(200, [], json_encode(['meta' => null])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); + + $response->getMeta(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getMeta(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + + /** @test */ + public function testGetMetaThrowsExceptionWhenEmptyMetaArray(): void + { + $psrResponse = new Response(200, [], json_encode(['meta' => []])); + $response = new ApiResponse($psrResponse); + + if (method_exists($this, 'expectException')) { + $this->expectException(\OutOfBoundsException::class); + + $response->getMeta(); // This should throw an exception + } else { + // The methods above was introduced in PHPUnit 8.4 which require PHP 7.2 + try { + $response->getMeta(); // This should throw an exception + } catch (\Exception $exception) { + $this->assertInstanceOf(\OutOfBoundsException::class, $exception); + } + } + } + //====================================================================== // Errors //====================================================================== diff --git a/tests/Unit/BookingApiTest.php b/tests/Unit/BookingApiTest.php new file mode 100644 index 0000000..9a7c13f --- /dev/null +++ b/tests/Unit/BookingApiTest.php @@ -0,0 +1,37 @@ +shouldReceive("toArray")->andReturn(['test']); + + $client = \Mockery::mock(ClientInterface::class); + $client->shouldReceive("post") + ->with( + 'https://app.smartsend.io/api/v1/website/example.com/labels/', + [ + 'api_token' => 'TEST-1234', + ], + [ + 'test', + ] + )->andReturn(\Mockery::mock(ApiResponseInterface::class)); + + $api = new BookingApi($client); + $api->website('example.com'); + $api->token('TEST-1234'); + $this->assertInstanceOf(BookingApiResponseInterface::class, $api->shipment($shipment)); + } +} diff --git a/tests/Unit/Data/Responses/AbstractBookingResponseTest.php b/tests/Unit/Data/Responses/AbstractBookingResponseTest.php new file mode 100644 index 0000000..57bcbf8 --- /dev/null +++ b/tests/Unit/Data/Responses/AbstractBookingResponseTest.php @@ -0,0 +1,39 @@ +bookingResponse = BookingResponse::make([ + 'type' => 'label', + 'shipment_id' => '17765987', + 'shipment_internal_id' => 'S123456', + 'shipment_internal_reference' => 'ORDER123456S', + 'carrier_code' => 'postnord', + 'carrier_name' => 'PostNord', + 'pdf' => [ + 'link' => 'https://example.com/labels/DK123456789.pdf', + 'base_64_encoded' => 'b3dlam9pZQ==' + ], + 'parcels' => [ + [ + 'parcel_id' => '177923', + 'parcel_internal_id' => 'P123456', + 'parcel_internal_reference' => 'ORDER123456P', + 'carrier_code' => 'postnord', + 'carrier_name' => 'PostNord', + 'tracking_code' => 'DK123456789', + 'tracking_link' => 'https://example.com/tracking/DK123456789' + ], + ], + ]); + } +} diff --git a/tests/Unit/Data/Responses/AgentResponseTest.php b/tests/Unit/Data/Responses/AgentResponseTest.php new file mode 100644 index 0000000..3a5eb25 --- /dev/null +++ b/tests/Unit/Data/Responses/AgentResponseTest.php @@ -0,0 +1,117 @@ +agentResponse = AgentResponse::make([ + 'id' => 1, + 'type' => 'agent', + 'agent_no' => 'pTOt5PaOYD', + 'carrier' => 'bring', + 'distance' => 1.23, + 'company' => 'Herzog-Lowe', + 'name_line1' => 'Name', + 'name_line2' => 'Jones', + 'address_line1' => '998 Ledner Key', + 'address_line2' => 'Falls', + 'postal_code' => '29580-6498', + 'city' => 'Brakusfort', + 'country' => 'dk', + 'coordinates' => [ + 'latitude' => 19.817213, + 'longitude' => 135.326348 + ], + 'opening_hours' => [ + [ + 'day' => 'tuesday', + 'opens' => '08:30:00', + 'closes' => '17:15:00' + ], + ], + ]); + } + + public function testId() + { + $this->assertEquals('1', $this->agentResponse->id); + } + + public function testType() + { + $this->assertEquals('agent', $this->agentResponse->type); + } + + public function testAgentNo() + { + $this->assertEquals('pTOt5PaOYD', $this->agentResponse->agent_no); + } + + public function testCarrier() + { + $this->assertEquals('bring', $this->agentResponse->carrier); + } + + public function testDistance() + { + $this->assertEquals(1.23, $this->agentResponse->distance); + } + + public function testCompany() + { + $this->assertEquals('Herzog-Lowe', $this->agentResponse->company); + } + + public function testNameLine1() + { + $this->assertEquals('Name', $this->agentResponse->name_line1); + } + + public function testNameLine2() + { + $this->assertEquals('Jones', $this->agentResponse->name_line2); + } + + public function testAddressLine1() + { + $this->assertEquals('998 Ledner Key', $this->agentResponse->address_line1); + } + + public function testAddressLine2() + { + $this->assertEquals('Falls', $this->agentResponse->address_line2); + } + + public function testPostalCode() + { + $this->assertEquals('29580-6498', $this->agentResponse->postal_code); + } + + public function testCity() + { + $this->assertEquals('Brakusfort', $this->agentResponse->city); + } + + public function testCountry() + { + $this->assertEquals('dk', $this->agentResponse->country); + } + + public function testCoordinates() + { + $this->assertTrue(true); // Not yet implemented + } + + public function testOpeningHours() + { + $this->assertTrue(true); // Not yet implemented + } +} diff --git a/tests/Unit/Data/Responses/Booking/ParcelTest.php b/tests/Unit/Data/Responses/Booking/ParcelTest.php new file mode 100644 index 0000000..3a3a734 --- /dev/null +++ b/tests/Unit/Data/Responses/Booking/ParcelTest.php @@ -0,0 +1,43 @@ +assertEquals('177923', $this->bookingResponse->parcels[0]->parcel_id); + } + + public function testParcelInternalId() + { + $this->assertEquals('P123456', $this->bookingResponse->parcels[0]->parcel_internal_id); + } + + public function testParcelInternalReference() + { + $this->assertEquals('ORDER123456P', $this->bookingResponse->parcels[0]->parcel_internal_reference); + } + + public function testCarrierCode() + { + $this->assertEquals('postnord', $this->bookingResponse->parcels[0]->carrier_code); + } + + public function testCarrierName() + { + $this->assertEquals('PostNord', $this->bookingResponse->parcels[0]->carrier_name); + } + + public function testTrackingCode() + { + $this->assertEquals('DK123456789', $this->bookingResponse->parcels[0]->tracking_code); + } + + public function testTrackingLink() + { + $this->assertEquals('https://example.com/tracking/DK123456789', $this->bookingResponse->parcels[0]->tracking_link); + } +} diff --git a/tests/Unit/Data/Responses/Booking/PdfTest.php b/tests/Unit/Data/Responses/Booking/PdfTest.php new file mode 100644 index 0000000..de3e6d5 --- /dev/null +++ b/tests/Unit/Data/Responses/Booking/PdfTest.php @@ -0,0 +1,18 @@ +assertEquals('https://example.com/labels/DK123456789.pdf', $this->bookingResponse->pdf->link); + } + + public function testBase64Encoded() + { + $this->assertEquals('b3dlam9pZQ==', $this->bookingResponse->pdf->base_64_encoded); + } +} diff --git a/tests/Unit/Data/Responses/BookingResponseTest.php b/tests/Unit/Data/Responses/BookingResponseTest.php new file mode 100644 index 0000000..2bcb72b --- /dev/null +++ b/tests/Unit/Data/Responses/BookingResponseTest.php @@ -0,0 +1,51 @@ +assertEquals('label', $this->bookingResponse->type); + } + + public function testShipmentId() + { + $this->assertEquals('17765987', $this->bookingResponse->shipment_id); + } + + public function testShipmentInternalId() + { + $this->assertEquals('S123456', $this->bookingResponse->shipment_internal_id); + } + + public function testShipmentInternalReference() + { + $this->assertEquals('ORDER123456S', $this->bookingResponse->shipment_internal_reference); + } + + public function testCarrierCode() + { + $this->assertEquals('postnord', $this->bookingResponse->carrier_code); + } + + public function testCarrierName() + { + $this->assertEquals('PostNord', $this->bookingResponse->carrier_name); + } + + public function testPdf() + { + $this->assertInstanceOf(Pdf::class, $this->bookingResponse->pdf); + } + + public function testParcels() + { + $this->assertIsArray($this->bookingResponse->parcels); + $this->assertCount(1, $this->bookingResponse->parcels); + $this->assertContainsOnlyInstancesOf(Parcel::class, $this->bookingResponse->parcels); + } +} diff --git a/tests/Unit/ShipmentsApiTest.php b/tests/Unit/ShipmentsApiTest.php deleted file mode 100644 index 89758e8..0000000 --- a/tests/Unit/ShipmentsApiTest.php +++ /dev/null @@ -1,29 +0,0 @@ -shouldReceive("toArray")->andReturn(['test']); - - $client = \Mockery::mock(ClientInterface::class); - $client->shouldReceive("post") - ->with('https://app.smartsend.io/api/v1/website/example.com/shipments/', ['api_token' => 'TEST-1234'], ['test']) - ->andReturn(\Mockery::mock(ApiResponseInterface::class)); - - $api = new ShipmentApi($client); - $api->website('example.com'); - $api->token('TEST-1234'); - $this->assertInstanceOf(ApiResponseInterface::class, $api->book($shipment)); - } -}