diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a42e5de --- /dev/null +++ b/.gitignore @@ -0,0 +1,103 @@ +*.iml +.gradle +/local.properties +/.idea/* +.DS_Store +/build +/captures +.externalNativeBuild + +# CMake +cmake-build-debug/ +cmake-build-release/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests +### Android template +# Built application files +*.apk +*.ap_ + +# Files for the ART/Dalvik VM +*.dex + +# Java class files +*.class + +# Generated files +bin/ +gen/ + +# Gradle files +build/ + +# Proguard folder generated by Eclipse +proguard/ + +# Log Files +*.log + +# Android Studio Navigation editor temp files +.navigation/ + +# Android Studio captures folder +captures/ + +# Keystore files +# Uncomment the following line if you do not want to check your keystore files in. +#*.jks + +# External native build folder generated in Android Studio 2.2 and later + +# Google Services (e.g. APIs or Firebase) +google-services.json + +# Freeline +freeline.py +freeline/ +freeline_project_description.json + +# fastlane +fastlane/report.xml +fastlane/Preview.html +fastlane/screenshots +fastlane/test_output +fastlane/readme.md + +#VSCODE +.project +.settings/ + +!.idea/scopes/ +!.idea/copyright/ +!.idea/codeStyles/ +!.idea/saveactions_settings.xml +!/.idea/encodings.xml +!/.idea/kotlinc.xml +!/.idea/externalDependencies.xml +*.exec +!/gradle/ diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml new file mode 100644 index 0000000..0bad645 --- /dev/null +++ b/.idea/codeStyles/Project.xml @@ -0,0 +1,222 @@ + + + + \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 0000000..79ee123 --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/General.xml b/.idea/copyright/General.xml new file mode 100644 index 0000000..25cfea7 --- /dev/null +++ b/.idea/copyright/General.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml new file mode 100644 index 0000000..15f080a --- /dev/null +++ b/.idea/copyright/profiles_settings.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/encodings.xml b/.idea/encodings.xml new file mode 100644 index 0000000..ada92a5 --- /dev/null +++ b/.idea/encodings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml new file mode 100644 index 0000000..0dd4b35 --- /dev/null +++ b/.idea/kotlinc.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/saveactions_settings.xml b/.idea/saveactions_settings.xml new file mode 100644 index 0000000..7ffff9e --- /dev/null +++ b/.idea/saveactions_settings.xml @@ -0,0 +1,22 @@ + + + + + + \ No newline at end of file diff --git a/.idea/scopes/Copyright.xml b/.idea/scopes/Copyright.xml new file mode 100644 index 0000000..88ddeb5 --- /dev/null +++ b/.idea/scopes/Copyright.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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 new file mode 100644 index 0000000..ecef672 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Home assignment - [Peakon](https://peakon.com/) + +Logo + +# Notes +- Code is separated into multiple modules + - Core + - Search + - App(Demo) +- To Build + - `./gradlew clean assembleDebug` +- To Test + - `./gradlew clean testDebugUnitTest connectedDebugAndroidTest --full-stacktrace` +- To Test with code coverage + - `./gradlew testDebugUnitTest connectedDebugAndroidTest -PenableCodeCoverage=true --full-stacktrace` + +## Required +- [x] Code Quality +- [x] SOLID Principles +- [x] Coding Standards +- [x] Testability +- [x] Unit Tests +- [ ] ~~Git Flow~~ + +## TODO +- [ ] Remove small hack, to get data on first query +- [ ] Move Source of Truth to Persistance + +## Addons +- [x] UI Tests +- [x] Gradle Setup +- [x] Dependency Injection +- [ ] ~~Git Rebase~~ +- [ ] ~~Git Squash~~ +- [x] Git Verified Commits +- [x] Git Release Tags +- [ ] T.D.D +- [x] Architecture Components +- [x] Documentation +- [x] Inline Comments +- [x] Modular +- [x] Scalable +- [x] Mock API Calls +- [x] Code Coverage +- [ ] Sonarqube/CodeClimate + +# Clean Up +- [x] Parcelables +- [ ] Remove unused libraries diff --git a/app/.gitignore b/app/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/app/build.gradle b/app/build.gradle new file mode 100644 index 0000000..9aaf4b8 --- /dev/null +++ b/app/build.gradle @@ -0,0 +1,63 @@ +apply plugin: 'com.android.application' +apply from: "$rootProject.rootDir/scripts/root.gradle" + +apply plugin: 'androidx.navigation.safeargs.kotlin' + +android.defaultConfig.applicationId deps.buildConfig.applicationId + +dependencies { + implementation project(':search') + + // AndroidX + implementation deps.jetpack.appcompat + implementation deps.jetpack.constraintlayout + implementation deps.jetpack.ktx + implementation deps.jetpack.material + implementation deps.jetpack.navigationFragment + implementation deps.jetpack.navigationUi + implementation deps.jetpack.viewmodel + + // Image Renderer + implementation deps.app.glide + + // Dependency Injection + implementation deps.app.koinViewmodel + + // Annotation Processors + kapt deps.kapt.lifecycle + kapt deps.kapt.glide + + implementation deps.androidTest.espressoIdling +} + +/* + * Android Test Dependencies + */ +dependencies { + androidTestImplementation deps.androidTest.runner + androidTestImplementation deps.androidTest.rules + androidTestImplementation deps.androidTest.jUnitExt + androidTestImplementation deps.androidTest.coreTest + + // Espresso + androidTestImplementation deps.androidTest.espresso + androidTestImplementation deps.androidTest.espressoContrib + + androidTestImplementation deps.androidTest.mockwebserver + + // Debug Only + debugImplementation deps.androidTest.fragmentTesting + + // Koin DI + androidTestImplementation deps.app.koin + androidTestImplementation deps.app.koinScope + androidTestImplementation deps.test.koinTest +} + +/* + * Debug Dependencies + */ +dependencies { + debugImplementation deps.debug.chuck + debugImplementation deps.debug.stetho +} diff --git a/app/proguard-rules.pro b/app/proguard-rules.pro new file mode 100644 index 0000000..f1b4245 --- /dev/null +++ b/app/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeDetailFragmentErrorTest.kt b/app/src/androidTest/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeDetailFragmentErrorTest.kt new file mode 100644 index 0000000..ce60dee --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeDetailFragmentErrorTest.kt @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.all.ui + +import androidx.fragment.app.testing.launchFragmentInContainer +import androidx.recyclerview.widget.RecyclerView +import androidx.test.espresso.Espresso.onView +import androidx.test.espresso.action.ViewActions.closeSoftKeyboard +import androidx.test.espresso.action.ViewActions.typeText +import androidx.test.espresso.contrib.RecyclerViewActions +import androidx.test.espresso.matcher.ViewMatchers.withId +import com.venomvendor.peakon.R +import com.venomvendor.peakon.employee.db.EmployeeDatabase +import com.venomvendor.peakon.helper.BaseTest +import com.venomvendor.peakon.helper.RecyclerViewItemCountAssertion.withItemCount +import okhttp3.mockwebserver.MockResponse +import okhttp3.mockwebserver.MockWebServer +import org.junit.After +import org.junit.Before +import org.junit.Test +import org.koin.core.get +import org.koin.core.inject +import java.io.IOException + +class EmployeeDetailFragmentErrorTest : BaseTest() { + private val db by inject() + + @Before + override fun setUp() { + super.setUp() + + val response = with(this).read("error.json") + val server = get() + server.enqueue( + MockResponse() + .setResponseCode(200) + .setBody(response) + ) + + db.teamDao().deleteAll() + + /* Launches Fragment directly */ + launchFragmentInContainer(null, R.style.AppTheme) + } + + @After + @Throws(IOException::class) + fun closeDb() { + db.close() + } + + @Test + fun getNoResultsButError() { + val query = "U" + + // Start Typing + onView(withId(R.id.search)).perform( + typeText(query), + closeSoftKeyboard() + ) + + onView(withId(R.id.team_list)) + .perform(RecyclerViewActions.scrollToPosition(Int.MAX_VALUE - 1)) + + onView(withId(R.id.team_list)) + .check(withItemCount(0)) + } +} diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeDetailFragmentTest.kt b/app/src/androidTest/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeDetailFragmentTest.kt new file mode 100644 index 0000000..6ca748d --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeDetailFragmentTest.kt @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.all.ui + +import androidx.fragment.app.testing.launchFragmentInContainer +import androidx.recyclerview.widget.RecyclerView +import androidx.test.espresso.Espresso.onView +import androidx.test.espresso.action.ViewActions.closeSoftKeyboard +import androidx.test.espresso.action.ViewActions.replaceText +import androidx.test.espresso.action.ViewActions.typeText +import androidx.test.espresso.contrib.RecyclerViewActions +import androidx.test.espresso.matcher.ViewMatchers.withId +import com.venomvendor.peakon.R +import com.venomvendor.peakon.helper.BaseTest +import com.venomvendor.peakon.helper.RecyclerViewItemCountAssertion.withItemCount +import okhttp3.mockwebserver.MockResponse +import okhttp3.mockwebserver.MockWebServer +import org.junit.Before +import org.junit.Test +import org.koin.core.get + +class EmployeeDetailFragmentTest : BaseTest() { + + @Before + override fun setUp() { + super.setUp() + + val response = with(this).read("response.json") + val server = get() + server.enqueue( + MockResponse() + .setResponseCode(200) + .setBody(response) + ) + + /* Launches Fragment directly */ + launchFragmentInContainer(null, R.style.AppTheme) + } + + @Test + fun getDataSuccessfullyWithResults() { + val query = "U" + + // Start Typing + onView(withId(R.id.search)).perform( + typeText(query), + closeSoftKeyboard() + ) + + onView(withId(R.id.team_list)) + .perform(RecyclerViewActions.scrollToPosition(Int.MAX_VALUE - 1)) + + onView(withId(R.id.team_list)) + .check(withItemCount(4)) + } + + @Test + fun getDataSuccessfullyWithZeroResults() { + val query = "UB" + + // Start Typing + onView(withId(R.id.search)).perform( + typeText(query), + closeSoftKeyboard() + ) + + onView(withId(R.id.team_list)) + .perform(RecyclerViewActions.scrollToPosition(Int.MAX_VALUE - 1)) + + onView(withId(R.id.team_list)) + .check(withItemCount(0)) + } + + @Test + fun getDataSuccessfullyWithNoResults() { + var query = "A" + + // Start Typing + onView(withId(R.id.search)).perform( + typeText(query), + closeSoftKeyboard() + ) + + query = "" + + // Start Typing + onView(withId(R.id.search)).perform( + replaceText(query), + closeSoftKeyboard() + ) + + onView(withId(R.id.team_list)) + .perform(RecyclerViewActions.scrollToPosition(Int.MAX_VALUE - 1)) + + onView(withId(R.id.team_list)) + .check(withItemCount(0)) + } +} diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/BaseTest.kt b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/BaseTest.kt new file mode 100644 index 0000000..7920c81 --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/BaseTest.kt @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.helper + +import androidx.annotation.CallSuper +import androidx.test.espresso.IdlingRegistry +import androidx.test.ext.junit.runners.AndroidJUnit4 +import com.venomvendor.peakon.app.util.EspressoIdlingResource +import org.junit.After +import org.junit.Before +import org.junit.runner.RunWith +import org.koin.core.KoinComponent + +@RunWith(AndroidJUnit4::class) +abstract class BaseTest : KoinComponent { + + @Before + @CallSuper + open fun setUp() { + IdlingRegistry.getInstance().register(EspressoIdlingResource.idlingResource) + } + + @After + @CallSuper + open fun autoClose() { + IdlingRegistry.getInstance().unregister(EspressoIdlingResource.idlingResource) + } + + companion object { + fun with(instance: Any): TestHelper { + return TestHelper(instance) + } + } +} + +class TestHelper(private val testInstance: Any) { + /** + * Add files under `/src/test/resources` + * Add files under `/src/androidTest/resources` + * + * @param filePath location of file to be read, relative path. + * @return Contents in file. + */ + fun read(filePath: String): String { + return testInstance.javaClass.getResource("/$filePath")!!.readText() + } +} + diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/CustomTestApplication.kt b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/CustomTestApplication.kt new file mode 100644 index 0000000..1c4cdb8 --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/CustomTestApplication.kt @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.helper + +import com.venomvendor.peakon.app.core.CustomApplication +import com.venomvendor.peakon.app.util.EspressoIdlingResource +import com.venomvendor.peakon.helper.di.appTestModule +import org.koin.core.context.loadKoinModules + +class CustomTestApplication : CustomApplication() { + + override fun onCreate() { + super.onCreate() + + EspressoIdlingResource.setDefaultIdlingResource() + + loadKoinModules(appTestModule) + } +} diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/CustomTestRunner.kt b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/CustomTestRunner.kt new file mode 100644 index 0000000..87b4cda --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/CustomTestRunner.kt @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +@file:Suppress("unused") + +package com.venomvendor.peakon.helper + +import android.app.Application +import android.content.Context +import androidx.test.runner.AndroidJUnitRunner + +class CustomTestRunner : AndroidJUnitRunner() { + @Throws( + ClassNotFoundException::class, + IllegalAccessException::class, + InstantiationException::class + ) + override fun newApplication(cl: ClassLoader, className: String, context: Context): Application { + return super.newApplication(cl, CustomTestApplication::class.java.name, context) + } +} diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/RecyclerViewItemCountAssertion.java b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/RecyclerViewItemCountAssertion.java new file mode 100644 index 0000000..c716aab --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/RecyclerViewItemCountAssertion.java @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.helper; + +import android.view.View; + +import org.hamcrest.Matcher; + +import androidx.recyclerview.widget.RecyclerView; +import androidx.test.espresso.NoMatchingViewException; +import androidx.test.espresso.ViewAssertion; +import androidx.test.espresso.matcher.ViewMatchers; + +import static org.hamcrest.Matchers.is; + +/** + * Credits to https://stackoverflow.com/a/43207009/1008278 + */ +public class RecyclerViewItemCountAssertion implements ViewAssertion { + + private final Matcher matcher; + + private RecyclerViewItemCountAssertion(Matcher matcher) { + this.matcher = matcher; + } + + public static RecyclerViewItemCountAssertion withItemCount(int expectedCount) { + return withItemCount(is(expectedCount)); + } + + public static RecyclerViewItemCountAssertion withItemCount(Matcher matcher) { + return new RecyclerViewItemCountAssertion(matcher); + } + + @Override + public void check(View view, NoMatchingViewException noViewFoundException) { + if (noViewFoundException != null) { + throw noViewFoundException; + } + + RecyclerView recyclerView = (RecyclerView) view; + RecyclerView.Adapter adapter = recyclerView.getAdapter(); + ViewMatchers.assertThat(adapter.getItemCount(), matcher); + } +} diff --git a/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/di/AppTestModule.kt b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/di/AppTestModule.kt new file mode 100644 index 0000000..c745fab --- /dev/null +++ b/app/src/androidTest/kotlin/com/venomvendor/peakon/helper/di/AppTestModule.kt @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.helper.di + +import com.venomvendor.peakon.core.helper.CoreConstant.Companion.QUALIFIER_BASE_URL +import okhttp3.mockwebserver.MockWebServer +import org.koin.core.qualifier.named +import org.koin.dsl.module + +val appTestModule = module(override = true) { + + single { + val server = MockWebServer() + server.start() + val url = server.url("/").toString() + println("Server is running at $url") + server + } + + /** + * Provides Instance of networking client's base url + */ + single(named(QUALIFIER_BASE_URL), createdAtStart = false, override = true) { + val server = get() + server.url("/").toString() + } +} diff --git a/app/src/androidTest/resources/error.json b/app/src/androidTest/resources/error.json new file mode 100644 index 0000000..066673e --- /dev/null +++ b/app/src/androidTest/resources/error.json @@ -0,0 +1,5 @@ +{ + "error": "error", + "message": "Error Message", + "statusCode": 401 +} diff --git a/app/src/androidTest/resources/response.json b/app/src/androidTest/resources/response.json new file mode 100644 index 0000000..55e5983 --- /dev/null +++ b/app/src/androidTest/resources/response.json @@ -0,0 +1,730 @@ +{ + "data": [ + { + "type": "employees", + "id": "323", + "links": { + "self": "http://localhost:3000/v1/employees/323" + }, + "attributes": { + "identifier": null, + "firstName": "Harriet", + "lastName": "McKinney", + "name": "Harriet McKinney", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 3767, + "Business Unit": "Sales", + "Commute Time": 34, + "Age": "1984-02-08", + "Department": "Customer Care", + "Gender": "Female", + "Job Level": "Manager", + "Local Office": "Kuala Lumpur", + "% of target": 88, + "Region": "APAC", + "Salary": 76000, + "Tenure": "2014-05-31" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "324" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "201" + } + } + } + }, + { + "type": "employees", + "id": "139", + "links": { + "self": "http://localhost:3000/v1/employees/139" + }, + "attributes": { + "identifier": null, + "firstName": "Harriet", + "lastName": "Banks", + "name": "Harriet Banks", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 215835, + "Business Unit": "People & Operations", + "Commute Time": 18, + "Age": "1984-04-19", + "Department": "Learning and Development", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "New York", + "% of target": 12, + "Region": "AMER", + "Salary": 332000, + "Tenure": "2009-06-30" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "140" + } + }, + "phones": { + "data": [] + } + } + }, + { + "type": "employees", + "id": "142", + "links": { + "self": "http://localhost:3000/v1/employees/142" + }, + "attributes": { + "identifier": null, + "firstName": "Mathilda", + "lastName": "Summers", + "name": "Mathilda Summers", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 95050, + "Business Unit": "Marketing", + "Commute Time": 131, + "Age": "1976-12-19", + "Department": "Media", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "London", + "% of target": 166, + "Region": "EMEA", + "Salary": 248000, + "Tenure": "2000-05-15" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "143" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "140", + "links": { + "self": "http://localhost:3000/v1/employees/140" + }, + "attributes": { + "identifier": null, + "firstName": "Eugene", + "lastName": "Wong", + "name": "Eugene Wong", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 157643, + "Business Unit": "Technology", + "Commute Time": 16, + "Age": "1980-03-21", + "Department": "Engineering", + "Gender": "Male", + "Job Level": "Executive", + "Local Office": "New York", + "% of target": 180, + "Region": "AMER", + "Salary": 483000, + "Tenure": "2011-01-31" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "141" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "340", + "links": { + "self": "http://localhost:3000/v1/employees/340" + }, + "attributes": { + "identifier": null, + "firstName": "New", + "lastName": "Manager", + "name": "New Manager", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2018-02-23T09:09:44.447Z", + "external": false + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "341" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "145", + "links": { + "self": "http://localhost:3000/v1/employees/145" + }, + "attributes": { + "identifier": null, + "firstName": "Marguerite", + "lastName": "Ryan", + "name": "Marguerite Ryan", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 81656, + "Business Unit": "Sales", + "Commute Time": 111, + "Age": "1991-09-14", + "Department": "Sales Development", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "Berlin", + "% of target": 121, + "Region": "EMEA", + "Salary": 341000, + "Tenure": "2015-01-29" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "146" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "171", + "links": { + "self": "http://localhost:3000/v1/employees/171" + }, + "attributes": { + "identifier": null, + "firstName": "Donald", + "lastName": "Butler", + "name": "Donald Butler", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 277768, + "Business Unit": "IT", + "Commute Time": 38, + "Age": "1990-02-23", + "Department": "Security", + "Gender": "Male", + "Job Level": "Executive", + "Local Office": "Berlin", + "% of target": 8, + "Region": "EMEA", + "Salary": 238000, + "Tenure": "2013-04-12" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "172" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "151", + "links": { + "self": "http://localhost:3000/v1/employees/151" + }, + "attributes": { + "identifier": null, + "firstName": "Jim", + "lastName": "Carlson", + "name": "Jim Carlson", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 85637, + "Business Unit": "Finance", + "Commute Time": 111, + "Age": "1968-06-06", + "Department": "Accounting", + "Gender": "Male", + "Job Level": "Executive", + "Local Office": "Beijing", + "% of target": 95, + "Region": "APAC", + "Salary": 163000, + "Tenure": "2013-04-29" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "152" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "141", + "links": { + "self": "http://localhost:3000/v1/employees/141" + }, + "attributes": { + "identifier": null, + "firstName": "Alta", + "lastName": "Maxwell", + "name": "Alta Maxwell", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 137145, + "Business Unit": "People & Operations", + "Commute Time": 67, + "Age": "1988-07-04", + "Department": "Recruitment", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "Tokyo", + "% of target": 21, + "Region": "APAC", + "Salary": 441000, + "Tenure": "2016-04-17" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "142" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + } + ], + "included": [ + { + "type": "accounts", + "id": "140", + "links": { + "self": "http://localhost:3000/v1/accounts/140" + }, + "attributes": { + "email": "harriet.banks@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": "en-GB", + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "141", + "links": { + "self": "http://localhost:3000/v1/accounts/141" + }, + "attributes": { + "email": "eugene.wong@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "142", + "links": { + "self": "http://localhost:3000/v1/accounts/142" + }, + "attributes": { + "email": "alta.maxwell@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": "en-GB", + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "143", + "links": { + "self": "http://localhost:3000/v1/accounts/143" + }, + "attributes": { + "email": "mathilda.summers@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "146", + "links": { + "self": "http://localhost:3000/v1/accounts/146" + }, + "attributes": { + "email": "marguerite.ryan@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "152", + "links": { + "self": "http://localhost:3000/v1/accounts/152" + }, + "attributes": { + "email": "jim.carlson@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "172", + "links": { + "self": "http://localhost:3000/v1/accounts/172" + }, + "attributes": { + "email": "donald.butler@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "324", + "links": { + "self": "http://localhost:3000/v1/accounts/324" + }, + "attributes": { + "email": "harriet.mckinney@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "341", + "links": { + "self": "http://localhost:3000/v1/accounts/341" + }, + "attributes": { + "email": "manager@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": "en-US", + "timezoneEffective": null + } + }, + { + "type": "employees", + "id": "139", + "links": { + "self": "http://localhost:3000/v1/employees/139" + }, + "attributes": { + "identifier": null, + "firstName": "Harriet", + "lastName": "Banks", + "name": "Harriet Banks", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 215835, + "Business Unit": "People & Operations", + "Commute Time": 18, + "Age": "1984-04-19", + "Department": "Learning and Development", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "New York", + "% of target": 12, + "Region": "AMER", + "Salary": 332000, + "Tenure": "2009-06-30" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "140" + } + }, + "phones": { + "data": [] + } + } + }, + { + "type": "employees", + "id": "201", + "links": { + "self": "http://localhost:3000/v1/employees/201" + }, + "attributes": { + "identifier": null, + "firstName": "Derrick", + "lastName": "Cummings", + "name": "Derrick Cummings", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 9214, + "Business Unit": "Sales", + "Commute Time": 6, + "Age": "1992-07-08", + "Department": "Customer Care", + "Gender": "Male", + "Job Level": "Senior Manager", + "Local Office": "Seoul", + "% of target": 31, + "Region": "APAC", + "Salary": 142000, + "Tenure": "2013-11-07" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "202" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "194" + } + } + } + } + ], + "meta": { + "page": { + "total": 9 + } + }, + "links": { + "self": "http://localhost:3000/v1/employees/contexts/company_5?per_page=25&q=harriet&sort=score&order=desc&include=account%2Cphones%2CLast%20Year%20Bonus%2CBusiness%20Unit%2CCommute%20Time%2CManager&simple=false", + "first": "http://localhost:3000/v1/employees/contexts/company_5?per_page=25&q=harriet&sort=score&order=desc&include=account%2Cphones%2CLast%20Year%20Bonus%2CBusiness%20Unit%2CCommute%20Time%2CManager&simple=false", + "last": "http://localhost:3000/v1/employees/contexts/company_5?per_page=25&page=1&q=harriet&sort=score&order=desc&include=account%2Cphones%2CLast%20Year%20Bonus%2CBusiness%20Unit%2CCommute%20Time%2CManager&simple=false" + } +} diff --git a/app/src/debug/AndroidManifest.xml b/app/src/debug/AndroidManifest.xml new file mode 100644 index 0000000..ed4fd0b --- /dev/null +++ b/app/src/debug/AndroidManifest.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/app/src/debug/kotlin/com/venomvendor/peakon/app/core/DebugCustomApplication.kt b/app/src/debug/kotlin/com/venomvendor/peakon/app/core/DebugCustomApplication.kt new file mode 100644 index 0000000..eb2f9d0 --- /dev/null +++ b/app/src/debug/kotlin/com/venomvendor/peakon/app/core/DebugCustomApplication.kt @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +@file:Suppress("unused") + +package com.venomvendor.peakon.app.core + +import android.annotation.SuppressLint +import com.facebook.stetho.Stetho +import com.venomvendor.peakon.core.di.coreDebugModule +import com.venomvendor.peakon.debug.di.networkTrackerModule +import org.koin.core.context.loadKoinModules + +/** + * Application class for core functionality. + */ +@SuppressLint("Registered") +class DebugCustomApplication : CustomApplication() { + + override fun onCreate() { + super.onCreate() + + Stetho.initializeWithDefaults(this) + + loadKoinModules( + listOf( + networkTrackerModule, coreDebugModule + ) + ) + } +} diff --git a/app/src/debug/kotlin/com/venomvendor/peakon/debug/di/Modules.kt b/app/src/debug/kotlin/com/venomvendor/peakon/debug/di/Modules.kt new file mode 100644 index 0000000..c0b277f --- /dev/null +++ b/app/src/debug/kotlin/com/venomvendor/peakon/debug/di/Modules.kt @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.debug.di + +import com.readystatesoftware.chuck.ChuckInterceptor +import okhttp3.Interceptor +import org.koin.android.ext.koin.androidContext +import org.koin.dsl.module + +/** + * Debug module that tracks all API calls. + */ +val networkTrackerModule = module { + + /** + * Provides Chuck Interceptor which attaches with [okhttp3] interceptors. + */ + single { + ChuckInterceptor(androidContext()) + } +} diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..a835fd8 --- /dev/null +++ b/app/src/main/AndroidManifest.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/MainActivity.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/MainActivity.kt new file mode 100644 index 0000000..6f4b89f --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/MainActivity.kt @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app + +import androidx.annotation.LayoutRes +import androidx.navigation.fragment.NavHostFragment +import com.venomvendor.peakon.R +import com.venomvendor.peakon.app.common.BaseActivity + +class MainActivity : BaseActivity() { + @LayoutRes + // Return current layout + override val layout = R.layout.activity_main + + override fun initViews() { + // Get Navigation Graph + val host = NavHostFragment.create(R.navigation.nav_graph) + + supportFragmentManager + .beginTransaction() + .replace(R.id.frame, host) + .setPrimaryNavigationFragment(host) + .commit() + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/all/adapter/EmployeeListAdapter.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/all/adapter/EmployeeListAdapter.kt new file mode 100644 index 0000000..e11ed4a --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/all/adapter/EmployeeListAdapter.kt @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.all.adapter + +import android.content.Context +import android.view.LayoutInflater +import android.view.View +import android.view.ViewGroup +import android.widget.ImageView +import android.widget.TextView +import androidx.recyclerview.widget.ListAdapter +import androidx.recyclerview.widget.RecyclerView +import com.bumptech.glide.request.RequestOptions +import com.venomvendor.peakon.R +import com.venomvendor.peakon.app.common.factory.OnItemClickListener +import com.venomvendor.peakon.app.core.GlideApp +import com.venomvendor.peakon.app.util.DiffUtilHelper +import com.venomvendor.peakon.employee.model.Employee + +/** + * Recycler Adapter for displaying list of results. + */ +internal class EmployeeListAdapter(context: Context) : + ListAdapter(DiffUtilHelper.EMPLOYEE_DIFF) { + + private val glide by lazy { GlideApp.with(context) } + + // Event listener + private var mItemClickListener: OnItemClickListener? = null + + override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): EmployeeViewHolder { + val view = LayoutInflater.from(parent.context) + // Update item view + .inflate(R.layout.team_item, parent, false) + + return EmployeeViewHolder(view) + } + + override fun onBindViewHolder(holder: EmployeeViewHolder, position: Int) { + // Get item + val employee = getItem(position) + + // Update views + holder.employeeName.text = employee.attributes.name + + holder.teamType.text = employee.attributes.jobLevel + holder.teamId.text = employee.attributes.gender + + // Load image + glide.load("https://api.adorable.io/avatars/${employee.id}") + .centerCrop() + // place holder until image loads + .placeholder(R.drawable.circle_bg) + .apply(RequestOptions.circleCropTransform()) + .into(holder.media) + } + + fun setOnItemClickLister(listener: OnItemClickListener?) { + mItemClickListener = listener + } + + /** + * View Holder pattern, used by recycler view. + */ + internal inner class EmployeeViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView), + View.OnClickListener { + + internal val employeeName = itemView.findViewById(R.id.team_name) + internal val teamType = itemView.findViewById(R.id.team_type) + internal val teamId = itemView.findViewById(R.id.team_id) + internal val media = itemView.findViewById(R.id.media) + + init { + // Add event listener + itemView.setOnClickListener(this) + } + + override fun onClick(view: View) { + val selectedPos = adapterPosition + if (selectedPos == RecyclerView.NO_POSITION) { + return + } + + // Pass on to root level event listener + mItemClickListener?.onClick(getItem(selectedPos), view, selectedPos) + } + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeListFragment.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeListFragment.kt new file mode 100644 index 0000000..fc5315f --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/all/ui/EmployeeListFragment.kt @@ -0,0 +1,150 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.all.ui + +import android.os.Bundle +import android.view.View +import androidx.annotation.LayoutRes +import androidx.core.widget.doOnTextChanged +import androidx.navigation.Navigation +import androidx.recyclerview.widget.LinearLayoutManager +import com.venomvendor.peakon.R +import com.venomvendor.peakon.app.all.adapter.EmployeeListAdapter +import com.venomvendor.peakon.app.common.BaseFragment +import com.venomvendor.peakon.app.common.factory.OnItemClickListener +import com.venomvendor.peakon.app.util.EspressoIdlingResource +import com.venomvendor.peakon.employee.model.Employee +import com.venomvendor.peakon.employee.viewmodel.EmployeeViewModel +import io.reactivex.android.schedulers.AndroidSchedulers +import io.reactivex.disposables.CompositeDisposable +import kotlinx.android.synthetic.main.employee_list_fragment.* +import org.koin.androidx.viewmodel.ext.android.viewModel + +/** + * Main View for listing Teams. + */ +class EmployeeListFragment : BaseFragment(), OnItemClickListener { + + private val mEmployeeViewModel: EmployeeViewModel by viewModel() + + private val disposable = CompositeDisposable() + + /* Adapter holding data. */ + private lateinit var mEmployeeAdapter: EmployeeListAdapter + + @get:LayoutRes + override val layout = R.layout.employee_list_fragment + + override fun onActivityCreated(savedInstanceState: Bundle?) { + super.onActivityCreated(savedInstanceState) + + // Initialize Listeners + initListener() + } + + override fun initViews(view: View) { + // For performance + team_list.setHasFixedSize(true) + // Set layout type + + updateLayoutManager() + + // Create Adapter + mEmployeeAdapter = EmployeeListAdapter(context!!) + // Set adapter + team_list.adapter = mEmployeeAdapter + } + + private fun updateLayoutManager() { + team_list.layoutManager = LinearLayoutManager(context) + } + + /** + * Initialize event listeners + */ + private fun initListener() { + search.doOnTextChanged { text, _, _, _ -> + text?.let { + getAllEmployees(it.toString()) + } + } + + mEmployeeAdapter.setOnItemClickLister(this) + } + + private fun getAllEmployees(search: String) { + if (disposable.size() > 0) { + disposable.clear() + if (progress_bar.visibility == View.VISIBLE) { + EspressoIdlingResource.decrement() + } + } + + if (search.isBlank()) { + mEmployeeAdapter.submitList(null) + return + } + + EspressoIdlingResource.increment() + progress_bar.visibility = View.VISIBLE + + disposable.add( + mEmployeeViewModel.getTeams(search) + .observeOn(AndroidSchedulers.mainThread()) + .doOnEvent { _, _ -> + resetProgress() + } + .subscribe({ teams -> + handleData(search, teams) + }, { ex -> + handleError(ex) + }) + ) + } + + /** + * Handler for data received + * + * @param response data + */ + private fun handleData(search: String, response: List) { + if (response.isEmpty()) { + showToast("No results for $search") + } + // Update data. + mEmployeeAdapter.submitList(response) + } + + /** + * TODO: Handle errors + */ + private fun handleError(error: Throwable) { + // Show error toast + showToast(error.message!!) + } + + private fun resetProgress() { + // Update indicators + progress_bar.visibility = View.GONE + refresh.isRefreshing = false + + EspressoIdlingResource.decrement() + } + + override fun onClick(item: Employee, view: View, position: Int) { + val action = + EmployeeListFragmentDirections.actionEmployeeListFragmentToEmployeeDetailFragment() + // Get Navigation controller + Navigation.findNavController(view) + // Navigate to next view with predefined action & data. + .navigate(action) + } + + override fun onDestroy() { + super.onDestroy() + disposable.dispose() + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/common/BaseActivity.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/common/BaseActivity.kt new file mode 100644 index 0000000..1c7cd1b --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/common/BaseActivity.kt @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.common + +import android.os.Bundle + +import androidx.annotation.CheckResult +import androidx.annotation.LayoutRes +import androidx.appcompat.app.AppCompatActivity + +/** + * Root activity responsible for common operation across the app. + */ +abstract class BaseActivity : AppCompatActivity() { + + /** + * Get the Layout for the user. + * + * @return layout to append + */ + @get:CheckResult + @get:LayoutRes + protected abstract val layout: Int + + /** + * Views are ready to be initialized. + */ + protected abstract fun initViews() + + /** + * {@inheritDoc} + */ + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(layout) + + // Init Views + initViews() + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/common/BaseFragment.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/common/BaseFragment.kt new file mode 100644 index 0000000..3399c38 --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/common/BaseFragment.kt @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.common + +import android.content.Context +import android.os.Bundle +import android.view.LayoutInflater +import android.view.View +import android.view.ViewGroup +import android.widget.Toast +import androidx.annotation.CheckResult +import androidx.annotation.LayoutRes +import androidx.fragment.app.Fragment +import java.util.Objects + +/** + * Root fragment/view to handles common functionality across app. + */ +abstract class BaseFragment : Fragment() { + + /** + * Get the Layout for the user. + * + * @return layout to append + */ + @get:CheckResult + @get:LayoutRes + protected abstract val layout: Int + + /** + * Views are ready to be initialized. + * + * @param view current view + */ + protected abstract fun initViews(view: View) + + override fun onAttach(context: Context) { + super.onAttach(context) + // Retain state over orientation. + retainInstance = true + } + + override fun onCreateView( + inflater: LayoutInflater, container: ViewGroup?, + savedInstanceState: Bundle? + ): View? { + // Create View. + return inflater.inflate(layout, container, false) + } + + override fun onViewCreated(view: View, savedInstanceState: Bundle?) { + super.onViewCreated(view, savedInstanceState) + + // Init Views + initViews(Objects.requireNonNull(getView(), "View is not loaded yet")) + } + + fun showToast(message: String) { + Toast.makeText(this.context, message, Toast.LENGTH_SHORT).show() + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/common/factory/OnItemClickListener.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/common/factory/OnItemClickListener.kt new file mode 100644 index 0000000..a2b2c43 --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/common/factory/OnItemClickListener.kt @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.common.factory + +import android.view.View + +/** + * Handle item click + * + * @param Type of data + */ +interface OnItemClickListener { + + /** + * Callback when item is clicked + */ + fun onClick(item: T, view: View, position: Int) +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/core/CustomApplication.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/core/CustomApplication.kt new file mode 100644 index 0000000..5d90707 --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/core/CustomApplication.kt @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.core + +import android.app.Application +import com.venomvendor.peakon.core.di.coreModule +import com.venomvendor.peakon.employee.di.employeeModule +import org.koin.android.ext.koin.androidContext +import org.koin.core.context.startKoin + +/** + * Application class for core functionality. + */ +open class CustomApplication : Application() { + + override fun onCreate() { + super.onCreate() + // start Koin + startKoin { + // Declare used Android context + androidContext(this@CustomApplication) + // Declare modules + modules( + listOf( + coreModule, employeeModule + ) + ) + } + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/core/CustomGlideApp.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/core/CustomGlideApp.kt new file mode 100644 index 0000000..ef83ad6 --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/core/CustomGlideApp.kt @@ -0,0 +1,12 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.core + +import com.bumptech.glide.annotation.GlideModule +import com.bumptech.glide.module.AppGlideModule + +@GlideModule +class CustomGlideApp : AppGlideModule() diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/util/DiffUtilHelper.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/util/DiffUtilHelper.kt new file mode 100644 index 0000000..b6dea26 --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/util/DiffUtilHelper.kt @@ -0,0 +1,39 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.util + +import androidx.recyclerview.widget.DiffUtil +import com.venomvendor.peakon.employee.model.Employee + +/** + * Helper Utility for Recycler View's Data. + */ +class DiffUtilHelper private constructor() { + + init { + throw UnsupportedOperationException("Instance should not be created") + } + + companion object { + + val EMPLOYEE_DIFF: DiffUtil.ItemCallback = + object : DiffUtil.ItemCallback() { + override fun areItemsTheSame( + oldItem: Employee, + newItem: Employee + ): Boolean { + return oldItem.id == newItem.id + } + + override fun areContentsTheSame( + oldItem: Employee, + newItem: Employee + ): Boolean { + return oldItem == newItem + } + } + } +} diff --git a/app/src/main/kotlin/com/venomvendor/peakon/app/util/EspressoIdlingResource.kt b/app/src/main/kotlin/com/venomvendor/peakon/app/util/EspressoIdlingResource.kt new file mode 100644 index 0000000..f1f23a2 --- /dev/null +++ b/app/src/main/kotlin/com/venomvendor/peakon/app/util/EspressoIdlingResource.kt @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.app.util + +import androidx.annotation.VisibleForTesting +import androidx.test.espresso.IdlingResource +import androidx.test.espresso.idling.CountingIdlingResource +import com.venomvendor.peakon.BuildConfig +import java.util.Objects + +/** + * Global Espresso idling resource + */ +class EspressoIdlingResource private constructor() { + + init { + throw UnsupportedOperationException("Instance should not be created") + } + + companion object { + + private const val RES_NAME = "EspressoIdlingResource" + + private var sIdlingResource: CountingIdlingResource? = null + + /** + * Start waiting for data + */ + fun increment() { + if (BuildConfig.DEBUG) { + println("INCREMENTING " + sIdlingResource?.dumpStateToLogs()) + sIdlingResource?.increment() + } + } + + /** + * Data is received + */ + fun decrement() { + if (BuildConfig.DEBUG) { + println("DECREMENTING " + sIdlingResource?.dumpStateToLogs()) + sIdlingResource?.decrement() + } + } + + val idlingResource: IdlingResource + @VisibleForTesting(otherwise = VisibleForTesting.NONE) + get() = Objects.requireNonNull( + sIdlingResource, + "Missing Idling Resource" + ) + + /** + * Set Custom idling resource + */ + @VisibleForTesting(otherwise = VisibleForTesting.NONE) + fun setIdlingResource(idlingResource: CountingIdlingResource) { + if (BuildConfig.DEBUG) { + sIdlingResource = Objects.requireNonNull(idlingResource) + } + } + + /** + * Set default idling resource. + */ + @VisibleForTesting(otherwise = VisibleForTesting.NONE) + fun setDefaultIdlingResource() { + setIdlingResource(CountingIdlingResource(RES_NAME, true)) + } + } +} diff --git a/app/src/main/res/anim/slide_in_left.xml b/app/src/main/res/anim/slide_in_left.xml new file mode 100644 index 0000000..0b1b9b6 --- /dev/null +++ b/app/src/main/res/anim/slide_in_left.xml @@ -0,0 +1,11 @@ + + + + + diff --git a/app/src/main/res/anim/slide_in_right.xml b/app/src/main/res/anim/slide_in_right.xml new file mode 100644 index 0000000..465c50c --- /dev/null +++ b/app/src/main/res/anim/slide_in_right.xml @@ -0,0 +1,11 @@ + + + + + diff --git a/app/src/main/res/anim/slide_out_left.xml b/app/src/main/res/anim/slide_out_left.xml new file mode 100644 index 0000000..5afd8a3 --- /dev/null +++ b/app/src/main/res/anim/slide_out_left.xml @@ -0,0 +1,11 @@ + + + + + diff --git a/app/src/main/res/anim/slide_out_right.xml b/app/src/main/res/anim/slide_out_right.xml new file mode 100644 index 0000000..a4b3ff5 --- /dev/null +++ b/app/src/main/res/anim/slide_out_right.xml @@ -0,0 +1,11 @@ + + + + + diff --git a/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 index 0000000..1f6bb29 --- /dev/null +++ b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + diff --git a/app/src/main/res/drawable/circle_bg.xml b/app/src/main/res/drawable/circle_bg.xml new file mode 100644 index 0000000..bd9fc0e --- /dev/null +++ b/app/src/main/res/drawable/circle_bg.xml @@ -0,0 +1,4 @@ + + + diff --git a/app/src/main/res/drawable/ic_launcher_background.xml b/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000..0d025f9 --- /dev/null +++ b/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/src/main/res/layout/activity_main.xml b/app/src/main/res/layout/activity_main.xml new file mode 100644 index 0000000..eb83d8e --- /dev/null +++ b/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,13 @@ + + + + + + diff --git a/app/src/main/res/layout/employee_list_fragment.xml b/app/src/main/res/layout/employee_list_fragment.xml new file mode 100644 index 0000000..c9d13cc --- /dev/null +++ b/app/src/main/res/layout/employee_list_fragment.xml @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + diff --git a/app/src/main/res/layout/team_item.xml b/app/src/main/res/layout/team_item.xml new file mode 100644 index 0000000..49fa5a5 --- /dev/null +++ b/app/src/main/res/layout/team_item.xml @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + diff --git a/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 0000000..6b78462 --- /dev/null +++ b/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 0000000..6b78462 --- /dev/null +++ b/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/app/src/main/res/mipmap-hdpi/ic_launcher.png b/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000..898f3ed Binary files /dev/null and b/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-hdpi/ic_launcher_round.png b/app/src/main/res/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 0000000..dffca36 Binary files /dev/null and b/app/src/main/res/mipmap-hdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-mdpi/ic_launcher.png b/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000..64ba76f Binary files /dev/null and b/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-mdpi/ic_launcher_round.png b/app/src/main/res/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 0000000..dae5e08 Binary files /dev/null and b/app/src/main/res/mipmap-mdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000..e5ed465 Binary files /dev/null and b/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png b/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 0000000..14ed0af Binary files /dev/null and b/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000..b0907ca Binary files /dev/null and b/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png b/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 0000000..d8ae031 Binary files /dev/null and b/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000..2c18de9 Binary files /dev/null and b/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png b/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 0000000..beed3cd Binary files /dev/null and b/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/navigation/nav_graph.xml b/app/src/main/res/navigation/nav_graph.xml new file mode 100644 index 0000000..dd11ee3 --- /dev/null +++ b/app/src/main/res/navigation/nav_graph.xml @@ -0,0 +1,19 @@ + + + + + + + diff --git a/app/src/main/res/values/colors.xml b/app/src/main/res/values/colors.xml new file mode 100644 index 0000000..69b2233 --- /dev/null +++ b/app/src/main/res/values/colors.xml @@ -0,0 +1,6 @@ + + + #008577 + #00574B + #D81B60 + diff --git a/app/src/main/res/values/dimens.xml b/app/src/main/res/values/dimens.xml new file mode 100644 index 0000000..47bddbe --- /dev/null +++ b/app/src/main/res/values/dimens.xml @@ -0,0 +1,7 @@ + + + 4dp + 8dp + 16dp + 80dp + diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml new file mode 100644 index 0000000..84310a8 --- /dev/null +++ b/app/src/main/res/values/strings.xml @@ -0,0 +1,5 @@ + + Peakon + Search + Fetching… + diff --git a/app/src/main/res/values/styles.xml b/app/src/main/res/values/styles.xml new file mode 100644 index 0000000..5885930 --- /dev/null +++ b/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..3bb2e45 --- /dev/null +++ b/build.gradle @@ -0,0 +1,34 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. + +buildscript { + apply from: "$rootDir/scripts/dependency.gradle" + + addRepos(repositories) + + dependencies { + // Android + classpath deps.buildPlugin.android + + // Kotlin + classpath deps.buildPlugin.kotlin + + // Formatter + classpath deps.buildPlugin.spotless + + // Navigation Args + classpath deps.buildPlugin.navigationSafeArgs + } + repositories { + google() + } +} + +allprojects { + addRepos(repositories) +} + +subprojects { + addRepos(buildscript.repositories) +} + +apply from: "$rootDir/scripts/formatter.gradle" diff --git a/dist/demo.apk b/dist/demo.apk new file mode 100644 index 0000000..4748657 Binary files /dev/null and b/dist/demo.apk differ diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..894fd0e --- /dev/null +++ b/gradle.properties @@ -0,0 +1,28 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx2048m +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app's APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true +# Automatically convert third-party libraries to use AndroidX +android.enableJetifier=true +# Kotlin code style for this project: "official" or "obsolete": +kotlin.code.style=official +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +org.gradle.parallel=true +# When set to true the Gradle daemon is used to run the build. For local developer builds this is our favorite property. +# The developer environment is optimized for speed and feedback so we nearly always run Gradle jobs with the daemon. +org.gradle.daemon=true +org.gradle.caching=true diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..5c2d1cf Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..7c4388a --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..83f2acf --- /dev/null +++ b/gradlew @@ -0,0 +1,188 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9618d8d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,100 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/graphics/logo.jpg b/graphics/logo.jpg new file mode 100644 index 0000000..61087dc Binary files /dev/null and b/graphics/logo.jpg differ diff --git a/scripts/common-deps.gradle b/scripts/common-deps.gradle new file mode 100644 index 0000000..6ff5189 --- /dev/null +++ b/scripts/common-deps.gradle @@ -0,0 +1,49 @@ +/** + * API dependencies + */ +dependencies { + // Kotlin + implementation deps.app.kotlin + implementation deps.app.kotlinReflect + + // Rx + implementation deps.app.rxAndroid + implementation deps.app.rxJava + + // AndroidX + implementation deps.jetpack.annotation + + // Dependency Injection + implementation deps.app.koin + implementation deps.app.koinScope + + // Json Parser + implementation deps.app.gson +} + +/* + * Test Dependencies + */ +dependencies { + // Unit + testImplementation deps.test.jUnit4 + + // Mockito + testImplementation deps.test.mockito + + // Model Validator + testImplementation deps.test.openpojo + + // Koin DI + testImplementation deps.test.koinTest +} + +dependencies { + def room_version = "2.2.0-rc01" + + implementation "androidx.room:room-runtime:$room_version" + implementation "androidx.room:room-ktx:$room_version" + implementation "androidx.room:room-rxjava2:$room_version" + + kapt "androidx.room:room-compiler:$room_version" +} diff --git a/scripts/dependency.gradle b/scripts/dependency.gradle new file mode 100644 index 0000000..cb339b1 --- /dev/null +++ b/scripts/dependency.gradle @@ -0,0 +1,200 @@ +def version = [ + buildTools : '3.5.0', + jacoco : '0.8.4', + kotlin : '1.3.50', + ktLint : '0.34.2', + spotless : '3.24.2', + + /* CONFIG */ + appBuildTools : '29.0.2', + minSdk : 21, + compileSdk : 29, + targetSdk : 29, + + versionCode : 1, + + MAJOR : 1, + MINOR : 0, + PATCH : 0, + SUFFIX : '', + + // Place holder + versionName : 'x.y.z', + + /* APP */ + annotation : '1.1.0', + appcompat : '1.1.0', + chuck : '1.1.0', + constraintlayout : '1.1.3', + glide : '4.9.0', + gson : '2.8.5', + koin : '2.0.1', + koinScope : '2.0.1', + koinViewmodel : '2.0.1', + ktx : '1.1.0', + lifecycle : '2.1.0', + material : '1.0.0', + navigation : '2.0.0', + nullDefense : '2.0.0', + okHttp : '4.2.0', + retrofit : '2.6.1', + rxAndroid : '2.1.1', + rxJava : '2.2.12', + stetho : '1.5.1', + + /* UNIT TEST */ + jUnit4 : '4.12', + mockito : '2.27.0', + openpojo : '0.8.12', + + /* ANDROID TEST */ + androidTestRunner: '1.1.1', + androidTestRules : '1.1.1', + coreTest : '1.1.0', + jUnitExt : '1.1.0', + espresso : '3.1.1', + fragmentTesting : '1.1.0', +] + +// Semantic versioning +version.versionName = "${version.MAJOR}.${version.MINOR}.${version.PATCH}${version.SUFFIX}" + +/** + * Build + */ +def build = [ + config: [ + buildTools : version.appBuildTools, + minSdk : version.minSdk, + compileSdk : version.compileSdk, + targetSdk : version.targetSdk, + versionCode : version.versionCode, + versionName : version.versionName, + + applicationId : 'com.venomvendor.peakon', + testInstrumentationRunner: 'com.venomvendor.peakon.helper.CustomTestRunner', + ], + + plugin: [ + android : "com.android.tools.build:gradle:${version.buildTools}", + kotlin : "org.jetbrains.kotlin:kotlin-gradle-plugin:${version.kotlin}", + navigationSafeArgs: "androidx.navigation:navigation-safe-args-gradle-plugin:${version.navigation}", + spotless : "com.diffplug.spotless:spotless-plugin-gradle:${version.spotless}", + ] +] + +/** + * App Dependencies + */ +def app = [ + /* + * Annotation Processor + */ + kapt : [ + // Image Renderer + glide : "com.github.bumptech.glide:compiler:${version.glide}", + + // Lifecycle Components + lifecycle: "androidx.lifecycle:lifecycle-compiler:${version.lifecycle}", + ], + + /* + * Main Dependencies + */ + main : [ + // Kotlin + kotlin : "org.jetbrains.kotlin:kotlin-stdlib-jdk8:${version.kotlin}", + kotlinReflect: "org.jetbrains.kotlin:kotlin-reflect:${version.kotlin}", + + // Reactive + rxAndroid : "io.reactivex.rxjava2:rxandroid:${version.rxAndroid}", + rxJava : "io.reactivex.rxjava2:rxjava:${version.rxJava}", + + // Dependency Injection + koin : "org.koin:koin-android:${version.koin}", + koinScope : "org.koin:koin-androidx-scope:${version.koinScope}", + koinViewmodel: "org.koin:koin-androidx-viewmodel:${version.koinViewmodel}", + + // Image Renderer + glide : "com.github.bumptech.glide:glide:${version.glide}", + + // Json Parser + gson : "com.google.code.gson:gson:${version.gson}", + nullDefense : "com.venomvendor:gson-nulldefense:${version.nullDefense}", + + // Network Client + retrofit : "com.squareup.retrofit2:retrofit:${version.retrofit}", + retrofitGson : "com.squareup.retrofit2:converter-gson:${version.retrofit}", + retrofitRx : "com.squareup.retrofit2:adapter-rxjava2:${version.retrofit}", + + // Http Client + okHttp : "com.squareup.okhttp3:okhttp:${version.okHttp}", + ], + + /* + * Jetpack + */ + jetpack: [ + annotation : "androidx.annotation:annotation:${version.annotation}", + appcompat : "androidx.appcompat:appcompat:${version.appcompat}", + constraintlayout : "androidx.constraintlayout:constraintlayout:${version.constraintlayout}", + ktx : "androidx.core:core-ktx:${version.ktx}", + material : "com.google.android.material:material:${version.material}", + navigationFragment: "androidx.navigation:navigation-fragment-ktx:${version.navigation}", + navigationUi : "androidx.navigation:navigation-ui-ktx:${version.navigation}", + viewmodel : "androidx.lifecycle:lifecycle-viewmodel-ktx:${version.lifecycle}", + ], + + /* + * Debug + */ + debug : [ + chuck : "com.readystatesoftware.chuck:library:${version.chuck}", + okHttpLog: "com.squareup.okhttp3:logging-interceptor:${version.okHttp}", + stetho : "com.facebook.stetho:stetho:${version.stetho}", + ], +] + +def test = [ + /* jUnit Test */ + junit : [ + jUnit4 : "junit:junit:${version.jUnit4}", + mockito : "org.mockito:mockito-core:${version.mockito}", + openpojo: "com.openpojo:openpojo:${version.openpojo}", + koinTest: "org.koin:koin-test:${version.koin}", + ], + + /* Android Test */ + android: [ + coreTest : "androidx.test:core:${version.coreTest}", + espresso : "androidx.test.espresso:espresso-core:${version.espresso}", + espressoContrib: "androidx.test.espresso:espresso-contrib:${version.espresso}", + espressoIdling : "androidx.test.espresso:espresso-idling-resource:${version.espresso}", + fragmentTesting: "androidx.fragment:fragment-testing:${version.fragmentTesting}", + jUnitExt : "androidx.test.ext:junit:${version.jUnitExt}", + runner : "androidx.test:runner:${version.androidTestRunner}", + rules : "androidx.test:rules:${version.androidTestRules}", + mockwebserver : "com.squareup.okhttp3:mockwebserver:${version.okHttp}", + ] +] + +def static addRepos(def handler) { + handler.google() + handler.jcenter() +} + +ext.deps = [ + version : version, + buildPlugin: build.plugin, + buildConfig: build.config, + + app : app.main, + debug : app.debug, + jetpack : app.jetpack, + kapt : app.kapt, + + test : test.junit, + androidTest: test.android, +] + +ext.addRepos = this.&addRepos diff --git a/scripts/formatter.gradle b/scripts/formatter.gradle new file mode 100644 index 0000000..f4c1221 --- /dev/null +++ b/scripts/formatter.gradle @@ -0,0 +1,45 @@ +/* + * Code Formatter, formatter for Java, Kotlin, Json, Gradle and others + * Available tasks `spotlessCheck`, `spotlessApply` + */ +apply plugin: 'com.diffplug.gradle.spotless' + +spotless { + format 'misc', { + target '**/*.gradle', '**/*.md', '**/.gitignore' + + indentWithSpaces() + trimTrailingWhitespace() + endWithNewline() + } + + format 'json', { + target '**/*.json' + indentWithSpaces(2) + trimTrailingWhitespace() + endWithNewline() + } + + kotlin { + target '**/*.kt' + ktlint(deps.version.ktLint) + trimTrailingWhitespace() + endWithNewline() + } + + java { + target '**/*.java' + removeUnusedImports() + indentWithSpaces() + trimTrailingWhitespace() + endWithNewline() + } +} + +afterEvaluate { + tasks.find { + it.name.contains('compile') + }.each { + it.dependsOn spotlessCheck + } +} diff --git a/scripts/jacoco.gradle b/scripts/jacoco.gradle new file mode 100644 index 0000000..1c04245 --- /dev/null +++ b/scripts/jacoco.gradle @@ -0,0 +1,9 @@ +apply plugin: 'jacoco' + +jacoco { + toolVersion = deps.version.jacoco +} + +tasks.withType(Test) { + jacoco.includeNoLocationClasses = true +} diff --git a/scripts/root.gradle b/scripts/root.gradle new file mode 100644 index 0000000..1f0368f --- /dev/null +++ b/scripts/root.gradle @@ -0,0 +1,94 @@ +apply plugin: 'kotlin-android' +apply plugin: 'kotlin-android-extensions' +apply plugin: 'kotlin-kapt' + +android { + compileSdkVersion deps.buildConfig.compileSdk + buildToolsVersion deps.buildConfig.buildTools + + androidExtensions { + experimental = true + } + defaultConfig { + minSdkVersion deps.buildConfig.minSdk + targetSdkVersion deps.buildConfig.targetSdk + versionCode deps.buildConfig.versionCode + versionName deps.buildConfig.versionName + + testInstrumentationRunner deps.buildConfig.testInstrumentationRunner + } + buildTypes { + release { + minifyEnabled true + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + + debug { + testCoverageEnabled Boolean.valueOf(project.findProperty('enableCodeCoverage')) + } + } + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + lintOptions { + abortOnError false + } + testOptions { + animationsDisabled = true + unitTests { + all { + testLogging { + exceptionFormat = 'full' + events 'passed', 'skipped', 'failed', 'standardOut', 'standardError' + } + } + returnDefaultValues = true + includeAndroidResources = true + } + } + sourceSets { + main { + java { + srcDir 'src/main/kotlin' + } + } + debug { + java { + srcDir 'src/debug/kotlin' + } + } + test { + java { + srcDir 'src/test/kotlin' + } + resources.srcDirs += ['src/test/resources'] + } + androidTest { + java { + srcDir 'src/androidTest/kotlin' + } + resources.srcDirs += ['src/androidTest/resources'] + } + } + packagingOptions { + exclude 'META-INF/LICENSE' + exclude 'META-INF/LICENSE.md' + exclude 'META-INF/LICENSE.txt' + exclude 'META-INF/NOTICE' + exclude 'META-INF/NOTICE.md' + exclude 'META-INF/NOTICE.txt' + exclude 'META-INF/LICENSE-notice.md' + exclude 'META-INF/rxjava.properties' + exclude 'META-INF/MANIFEST.MF' + exclude '**/rxjava.properties' + exclude '.readme' + return true + } + useLibrary 'android.test.runner' + useLibrary 'android.test.base' + useLibrary 'android.test.mock' +} + +apply from: "$rootProject.rootDir/scripts/common-deps.gradle" +apply from: "$rootProject.rootDir/scripts/jacoco.gradle" diff --git a/sdk-core/.gitignore b/sdk-core/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/sdk-core/.gitignore @@ -0,0 +1 @@ +/build diff --git a/sdk-core/build.gradle b/sdk-core/build.gradle new file mode 100644 index 0000000..a0b7a12 --- /dev/null +++ b/sdk-core/build.gradle @@ -0,0 +1,34 @@ +apply plugin: 'com.android.library' + +apply from: "$rootProject.rootDir/scripts/root.gradle" + +/** + * Module Dependencies + */ +dependencies { + // Json Parser + implementation deps.app.nullDefense + + // Networking + implementation deps.app.okHttp + implementation deps.app.retrofit + implementation deps.app.retrofitGson + implementation deps.app.retrofitRx + + debugImplementation deps.debug.okHttpLog +} + +/** + * Module Dependencies + */ +dependencies { + // Json Parser + testImplementation deps.app.gson + testImplementation deps.app.nullDefense + + // Networking + testImplementation deps.app.okHttp + testImplementation deps.app.retrofit + testImplementation deps.app.retrofitGson + testImplementation deps.app.retrofitRx +} diff --git a/sdk-core/proguard-rules.pro b/sdk-core/proguard-rules.pro new file mode 100644 index 0000000..f1b4245 --- /dev/null +++ b/sdk-core/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/sdk-core/src/debug/kotlin/com/venomvendor/peakon/core/di/CoreDebugModule.kt b/sdk-core/src/debug/kotlin/com/venomvendor/peakon/core/di/CoreDebugModule.kt new file mode 100644 index 0000000..f13206f --- /dev/null +++ b/sdk-core/src/debug/kotlin/com/venomvendor/peakon/core/di/CoreDebugModule.kt @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.di + +import okhttp3.Interceptor +import okhttp3.OkHttpClient +import okhttp3.logging.HttpLoggingInterceptor +import org.koin.dsl.module + +/** + * Provides all dependencies in current core module. + */ +val coreDebugModule = module(override = true) { + factory { + val interceptor = HttpLoggingInterceptor() + interceptor.level = HttpLoggingInterceptor.Level.HEADERS + interceptor + } + + /** + * Provides Single Okhttp3 Client for http layer + */ + single(override = true) { + OkHttpClient().newBuilder() + .addInterceptor(get() as Interceptor) + .addInterceptor(get() as HttpLoggingInterceptor) + .build() + } +} diff --git a/sdk-core/src/main/AndroidManifest.xml b/sdk-core/src/main/AndroidManifest.xml new file mode 100644 index 0000000..08512d2 --- /dev/null +++ b/sdk-core/src/main/AndroidManifest.xml @@ -0,0 +1,5 @@ + + + + diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/annotation/Mandatory.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/annotation/Mandatory.kt new file mode 100644 index 0000000..c420662 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/annotation/Mandatory.kt @@ -0,0 +1,10 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.annotation + +@Retention(AnnotationRetention.RUNTIME) +@Target(AnnotationTarget.FIELD, AnnotationTarget.CLASS, AnnotationTarget.FILE) +annotation class Mandatory diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/data/RepositoryManager.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/data/RepositoryManager.kt new file mode 100644 index 0000000..560ee40 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/data/RepositoryManager.kt @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.data + +import androidx.annotation.CheckResult +import com.venomvendor.peakon.core.data.factory.Repository +import io.reactivex.Single +import io.reactivex.schedulers.Schedulers + +/** + * Handles core functionality, it is the single source of truth. + * Gets data from storage, server, saves, handles responses gracefully. + */ +class RepositoryManager(private val repository: Repository) { + + companion object { + fun create(repository: Repository) = RepositoryManager( + repository + ) + } + + /** + * Executes request to get data. + * First data is retrieved from storage, upon failure, the request is sent to server + * to get data, it also adds functionality to get data from both storage & server. + * This acts as offline first approach. + * + * @param Type of data from server + * @return LiveData in which data is updated when received. + */ + @CheckResult + fun execute(): Single { + val source = Single.defer { + val fromCache = repository.cachedData() + + fromCache?.let { + return@defer Single.just(it) + } + + // Executes request and retrieves data from server. + repository.request() + } + + return attachIoThread(source) + } + + /** + * Attaches io thread to current Observable + * + * @param source Observable to attach + * @param Type of data from server + * @return Updated Observable + */ + @CheckResult + private fun attachIoThread(source: Single): Single { + return source.subscribeOn(Schedulers.io()) + } +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/data/factory/Repository.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/data/factory/Repository.kt new file mode 100644 index 0000000..dc15763 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/data/factory/Repository.kt @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.data.factory + +import androidx.annotation.CheckResult +import androidx.annotation.WorkerThread +import io.reactivex.Single + +/** + * Repository to be handled by [com.venomvendor.peakon.core.data.RepositoryManager] + * + * @param Data type received from server + */ +interface Repository { + + /** + * Get Cached data from storage + * + * @return Cached data or `null` + */ + @CheckResult + fun cachedData(): T? + + /** + * Request to be executed if data is not available. + * + * @return Request or `null` if no request to be made to server. + */ + @CheckResult + fun request(): Single + + /** + * Save a copy of data to cache + * + * @param data data to be saved. + */ + @WorkerThread + @Throws(Exception::class) + fun saveData(data: T) +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/di/CoreModule.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/di/CoreModule.kt new file mode 100644 index 0000000..d8e317c --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/di/CoreModule.kt @@ -0,0 +1,124 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.di + +import com.google.gson.GsonBuilder +import com.google.gson.TypeAdapterFactory +import com.venomvendor.gson.NullDefenseTypeAdapterFactory +import com.venomvendor.peakon.core.annotation.Mandatory +import com.venomvendor.peakon.core.data.RepositoryManager +import com.venomvendor.peakon.core.data.factory.Repository +import com.venomvendor.peakon.core.helper.CoreConstant.Companion.QUALIFIER_BASE_URL +import com.venomvendor.peakon.core.helper.CoreConstant.Companion.QUALIFIER_ROOM +import com.venomvendor.peakon.core.helper.CoreConstant.Companion.QUALIFIER_SHARED_PREF +import com.venomvendor.peakon.core.network.NetworkManager +import com.venomvendor.peakon.core.storage.RoomManager +import com.venomvendor.peakon.core.storage.SharedPreferencesManager +import okhttp3.OkHttpClient +import org.koin.core.qualifier.named +import org.koin.dsl.module +import retrofit2.CallAdapter +import retrofit2.Converter +import retrofit2.Retrofit +import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory +import retrofit2.converter.gson.GsonConverterFactory + +private const val BASE_URL = "https://gist.githubusercontent.com" + +/** + * Provides all dependencies in current core module. + */ +val coreModule = module { + + /** + * Provides [Gson] to generate objects from Json. + */ + single { + val gsonBuilder = GsonBuilder() + + get>().forEach { + gsonBuilder.registerTypeAdapterFactory(it) + } + + gsonBuilder.create() + } + + /** + * Provides [Gson] to generate objects from Json. + */ + factory { + GsonConverterFactory.create(get()) as Converter.Factory + } + + /** + * Provides [TypeAdapterFactory] to attach with [Gson], this removes invalid object from response. + */ + factory> { + listOf(NullDefenseTypeAdapterFactory(Mandatory::class.java)) + } + + /** + * Provides [RxJava2CallAdapterFactory] to create network response to Reactive streams. + */ + factory { + RxJava2CallAdapterFactory.create() as CallAdapter.Factory + } + + /** + * Provides Single Okhttp3 Client for http layer + */ + single { + OkHttpClient().newBuilder() + .build() + } + + /** + * Provides Instance of networking client's base url + */ + single(named(QUALIFIER_BASE_URL)) { + BASE_URL + } + + /** + * Provides Instance of networking client. + */ + single { + Retrofit.Builder() + .baseUrl(get(named(QUALIFIER_BASE_URL))) + .addConverterFactory(get()) + .addCallAdapterFactory(get()) + .client(get()) + .build() + } + + /** + * Creates Repository Manager for the given repository + */ + factory { (repository: Repository<*>) -> + RepositoryManager(repository) + } + + /** + * Provider Network Manager + */ + factory { + NetworkManager() + } + + /** + * Provides Shared Preferences + */ + factory(named(QUALIFIER_SHARED_PREF)) { + SharedPreferencesManager() + } + + /** + * Provides Room/SQLite + */ + single(named(QUALIFIER_ROOM)) { + RoomManager() + } +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/helper/CoreConstant.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/helper/CoreConstant.kt new file mode 100644 index 0000000..f4dfa94 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/helper/CoreConstant.kt @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.helper + +/** + * Core Module's constants + */ +class CoreConstant { + companion object { + const val QUALIFIER_BASE_URL = "QUALIFIER_BASE_URL" + const val QUALIFIER_SHARED_PREF = "QUALIFIER_SHARED_PREF" + const val QUALIFIER_ROOM = "QUALIFIER_ROOM" + } +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/network/NetworkManager.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/network/NetworkManager.kt new file mode 100644 index 0000000..3fc72b8 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/network/NetworkManager.kt @@ -0,0 +1,21 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.network + +import retrofit2.Retrofit + +/** + * Handles Network Operation + */ +class NetworkManager { + + /** + * Creates Webservice client for the given provider. + */ + inline fun getWebService(retrofit: Retrofit): T { + return retrofit.create(T::class.java) + } +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/network/model/Status.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/network/model/Status.kt new file mode 100644 index 0000000..7fb3a27 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/network/model/Status.kt @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.network.model + +import androidx.room.Ignore +import com.google.gson.annotations.SerializedName + +open class Status( + @Ignore + @SerializedName("error") + val error: String? = null, + + @Ignore + @SerializedName("message") + val message: String? = null, + + @Ignore + @SerializedName("statusCode") + val statusCode: Int? = null +) { + val isSuccess: Boolean + get() = error == null +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/RoomManager.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/RoomManager.kt new file mode 100644 index 0000000..ed2b3e2 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/RoomManager.kt @@ -0,0 +1,29 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.storage + +import com.venomvendor.peakon.core.storage.factory.Storage + +/** + * Yet to be implemented by storage provider + */ +class RoomManager : Storage { + override fun save(data: E) { + TODO("not implemented") + } + + override fun update(data: E) { + TODO("not implemented") + } + + override fun delete(data: E) { + TODO("not implemented") + } + + override fun retrieve(clz: Class): List? { + return null + } +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/SharedPreferencesManager.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/SharedPreferencesManager.kt new file mode 100644 index 0000000..869817a --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/SharedPreferencesManager.kt @@ -0,0 +1,29 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.storage + +import com.venomvendor.peakon.core.storage.factory.Storage + +/** + * Yet to be implemented by storage provider + */ +class SharedPreferencesManager : Storage { + override fun save(data: E) { + // TODO("not implemented") + } + + override fun update(data: E) { + TODO("not implemented") + } + + override fun delete(data: E) { + TODO("not implemented") + } + + override fun retrieve(clz: Class): List? { + return null + } +} diff --git a/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/factory/Storage.kt b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/factory/Storage.kt new file mode 100644 index 0000000..ea8be56 --- /dev/null +++ b/sdk-core/src/main/kotlin/com/venomvendor/peakon/core/storage/factory/Storage.kt @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.storage.factory + +/** + * Template for storage operation + */ +interface Storage { + + /** + * Save data + */ + fun save(data: E) + + /** + * Update data + */ + fun update(data: E) + + /** + * Delete data + */ + fun delete(data: E) + + /** + * Retrieve data from storage + */ + fun retrieve(clz: Class): List? +} diff --git a/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/data/RepositoryManagerTest.kt b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/data/RepositoryManagerTest.kt new file mode 100644 index 0000000..8fda0a3 --- /dev/null +++ b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/data/RepositoryManagerTest.kt @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.data + +import com.venomvendor.peakon.core.data.factory.Repository +import com.venomvendor.peakon.core.di.coreModule +import com.venomvendor.peakon.core.helper.BaseTest +import com.venomvendor.peakon.core.helper.model.TestData +import io.reactivex.Single +import org.junit.Test +import org.koin.core.context.startKoin +import org.koin.core.parameter.parametersOf +import org.koin.test.inject +import org.mockito.Mockito +import org.mockito.Mockito.`when` as mockitoWhen + +/** + * Test Repository manager with mock implementation + */ +class RepositoryManagerTest : BaseTest() { + private val mockRepository = Mockito.mock(Repository::class.java) + + private val fakeRepoManager: RepositoryManager by inject { + parametersOf(mockRepository) + } + + override fun before() { + super.before() + startKoin { + modules(coreModule) + } + } + + @Test + fun `test RepositoryManager to get data from Cache (+ve)`() { + val testData = "Test" + mockitoWhen(mockRepository.cachedData()) + .thenReturn( + TestData(1, testData) + ) + fakeRepoManager.execute() + .test() + .assertSubscribed() + .assertValue { + it.name == testData + } + } + + @Test + fun `test RepositoryManager to get data from Request (+ve)`() { + val testDataReq = "Test" + mockitoWhen(mockRepository.cachedData()) + .thenReturn( + null + ) + + mockitoWhen(mockRepository.request()) + .thenReturn( + Single.just(TestData(1, testDataReq)) + ) + fakeRepoManager.execute() + .test() + .assertSubscribed() + .assertValue { + it.name == testDataReq + } + } + + @Test + fun `test RepositoryManager, ensure data from Request (+ve)`() { + val testData = "Test" + mockitoWhen(mockRepository.request()) + .thenReturn( + Single.just(TestData(1, testData)) + ) + fakeRepoManager.execute() + .test() + .assertSubscribed() + .assertValue { + it.name == testData + } + } +} diff --git a/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/di/CoreModuleTest.kt b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/di/CoreModuleTest.kt new file mode 100644 index 0000000..020fe69 --- /dev/null +++ b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/di/CoreModuleTest.kt @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.di + +import com.google.gson.Gson +import com.venomvendor.peakon.core.helper.BaseTest +import com.venomvendor.peakon.core.helper.di.BASE_URL +import com.venomvendor.peakon.core.helper.di.testModule +import com.venomvendor.peakon.core.helper.model.TestData +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Test +import org.koin.core.context.startKoin +import org.koin.test.inject +import retrofit2.Retrofit + +class CoreModuleTest : BaseTest() { + + override fun before() { + super.before() + startKoin { + modules(listOf(coreModule, testModule)) + } + } + + @Test + fun testBaseUrl() { + val retrofit by inject() + assertEquals(BASE_URL, retrofit.baseUrl().toString()) + } + + @Test + fun `testGsonTypeAdapter with result(+ve)`() { + val gson by inject() + + val testData: TestData = + gson.fromJson("{\"id\":1,\"name\":\"test\"}", TestData::class.java) + assertEquals("test", testData.name) + } + + @Test + fun `testGsonTypeAdapter with Missing Required Data(-ve)`() { + val gson by inject() + val testData: TestData? = + gson.fromJson("{\"id\":1,\"name\":null}", TestData::class.java) + assertNull(testData) + } +} diff --git a/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/BaseTest.kt b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/BaseTest.kt new file mode 100644 index 0000000..0780052 --- /dev/null +++ b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/BaseTest.kt @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.helper + +import androidx.annotation.CallSuper +import io.reactivex.plugins.RxJavaPlugins +import io.reactivex.schedulers.Schedulers +import org.junit.After +import org.junit.Before +import org.koin.core.context.stopKoin +import org.koin.test.KoinTest + +abstract class BaseTest : KoinTest { + + @Before + @CallSuper + open fun before() { + RxJavaPlugins.setIoSchedulerHandler { + Schedulers.trampoline() + } + } + + @After + @CallSuper + open fun autoClose() { + stopKoin() + RxJavaPlugins.reset() + } + + companion object { + fun with(instance: Any): TestHelper { + return TestHelper(instance) + } + } +} + +class TestHelper(private val testInstance: Any) { + /** + * Add files under `/src/test/resources` + * Add files under `/src/androidTest/resources` + * + * @param filePath location of file to be read, relative path. + * @return Contents in file. + */ + fun read(filePath: String): String { + return testInstance.javaClass.getResource("/$filePath")!!.readText() + } +} diff --git a/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/di/CoreTestModule.kt b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/di/CoreTestModule.kt new file mode 100644 index 0000000..682c0c6 --- /dev/null +++ b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/di/CoreTestModule.kt @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.helper.di + +import com.venomvendor.peakon.core.helper.CoreConstant.Companion.QUALIFIER_BASE_URL +import org.koin.core.qualifier.named +import org.koin.dsl.module + +const val BASE_URL = "http://localhost:8080/" + +val testModule = module(override = true) { + + /** + * Provides Instance of networking client's base url + */ + single(named(QUALIFIER_BASE_URL), createdAtStart = false, override = true) { + BASE_URL + } +} diff --git a/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/model/TestData.kt b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/model/TestData.kt new file mode 100644 index 0000000..a1c7f18 --- /dev/null +++ b/sdk-core/src/test/kotlin/com/venomvendor/peakon/core/helper/model/TestData.kt @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.core.helper.model + +import com.google.gson.annotations.SerializedName +import com.venomvendor.peakon.core.annotation.Mandatory + +data class TestData( + @SerializedName("id") val id: Int, + + @Mandatory + @SerializedName("name") val name: String +) diff --git a/sdk-search/.gitignore b/sdk-search/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/sdk-search/.gitignore @@ -0,0 +1 @@ +/build diff --git a/sdk-search/build.gradle b/sdk-search/build.gradle new file mode 100644 index 0000000..e73456b --- /dev/null +++ b/sdk-search/build.gradle @@ -0,0 +1,33 @@ +apply plugin: 'com.android.library' + +apply from: "$rootProject.rootDir/scripts/root.gradle" + +/** + * API dependencies + */ +dependencies { + api project(':core') + + // Dependency Injection + implementation deps.app.koin + implementation deps.app.koinScope + implementation deps.app.koinViewmodel + + implementation deps.jetpack.viewmodel +} + +/** + * Module Dependencies + */ +dependencies { + // Networking + implementation deps.app.retrofit +} + +/** + * Module Dependencies + */ +dependencies { + // Networking + testImplementation deps.app.retrofit +} diff --git a/sdk-search/proguard-rules.pro b/sdk-search/proguard-rules.pro new file mode 100644 index 0000000..f1b4245 --- /dev/null +++ b/sdk-search/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/sdk-search/src/main/AndroidManifest.xml b/sdk-search/src/main/AndroidManifest.xml new file mode 100644 index 0000000..c46caef --- /dev/null +++ b/sdk-search/src/main/AndroidManifest.xml @@ -0,0 +1 @@ + diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/dao/EmployeeDao.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/dao/EmployeeDao.kt new file mode 100644 index 0000000..9db6cf0 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/dao/EmployeeDao.kt @@ -0,0 +1,39 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.dao + +import androidx.room.Dao +import androidx.room.Delete +import androidx.room.Insert +import androidx.room.OnConflictStrategy +import androidx.room.Query +import com.venomvendor.peakon.employee.model.Employee +import io.reactivex.Completable + +@Dao +interface EmployeeDao { + @Query("SELECT * FROM employee") + fun getAll(): List + + @Query("SELECT COUNT(*) FROM employee") + fun getCount(): Int + + // @Query("SELECT * FROM employee WHERE name LIKE '%' || :query || '%' ORDER BY firstName ASC") + @Query("SELECT * FROM employee WHERE firstName LIKE '%' || :query || '%' OR lastName LIKE '%' || :query || '%' ORDER BY firstName ASC") + fun getAll(query: String): List + + @Insert(onConflict = OnConflictStrategy.REPLACE) + fun insertAll(vararg employees: Employee): Completable + + @Insert(onConflict = OnConflictStrategy.REPLACE) + fun insert(employees: List): Completable + + @Delete + fun delete(employee: Employee): Completable + + @Query("DELETE FROM employee") + fun deleteAll() +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/db/AttributeConverter.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/db/AttributeConverter.kt new file mode 100644 index 0000000..e8c6927 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/db/AttributeConverter.kt @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.db + +import androidx.room.TypeConverter +import com.google.gson.Gson +import com.venomvendor.peakon.employee.model.Attributes + +class AttributeConverter { + + @TypeConverter + fun fromString(value: String): Attributes { + return Gson().fromJson(value, Attributes::class.java) + } + + @TypeConverter + fun fromList(list: Attributes): String { + return Gson().toJson(list) + } +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/db/EmployeeDatabase.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/db/EmployeeDatabase.kt new file mode 100644 index 0000000..db8a9c7 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/db/EmployeeDatabase.kt @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.db + +import android.content.Context +import androidx.room.Database +import androidx.room.Room +import androidx.room.RoomDatabase +import com.venomvendor.peakon.employee.dao.EmployeeDao +import com.venomvendor.peakon.employee.model.Employee + +/** + * The Room database that contains the Users table + */ +@Database(entities = [Employee::class], version = 1) +abstract class EmployeeDatabase : RoomDatabase() { + + abstract fun teamDao(): EmployeeDao + + companion object { + + @Volatile + private var INSTANCE: EmployeeDatabase? = null + + fun getInstance(context: Context): EmployeeDatabase = + INSTANCE ?: synchronized(this) { + INSTANCE ?: buildDatabase(context).also { INSTANCE = it } + } + + private fun buildDatabase(context: Context) = + Room.databaseBuilder( + context.applicationContext, + EmployeeDatabase::class.java, "team.db" + ) + .fallbackToDestructiveMigration() + .build() + } +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/di/TeamModule.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/di/TeamModule.kt new file mode 100644 index 0000000..cc1d0c1 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/di/TeamModule.kt @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.di + +import com.venomvendor.peakon.core.network.NetworkManager +import com.venomvendor.peakon.core.storage.SharedPreferencesManager +import com.venomvendor.peakon.core.storage.factory.Storage +import com.venomvendor.peakon.employee.db.EmployeeDatabase +import com.venomvendor.peakon.employee.factory.EmployeeService +import com.venomvendor.peakon.employee.repository.EmployeeRepository +import com.venomvendor.peakon.employee.viewmodel.EmployeeViewModel +import org.koin.dsl.module + +val employeeModule = module { + + factory { + EmployeeViewModel(get()) + } + + factory { + EmployeeRepository(get(), get()) + } + + factory { + SharedPreferencesManager() as Storage + } + + factory { + get().getWebService(get()) + } + + single { + EmployeeDatabase.getInstance(get()) + } +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/factory/EmployeeService.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/factory/EmployeeService.kt new file mode 100644 index 0000000..40aad88 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/factory/EmployeeService.kt @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.factory + +import com.venomvendor.peakon.employee.model.EmployeeWrapper +import io.reactivex.Single +import retrofit2.http.GET + +/** + * Webservice to make employee API calls + */ +interface EmployeeService { + + /** + * Get all Teams + * TODO: Change response object type & + * use custom [GSON] adapter to handle error object, response array in single Type + * + * @return SingleObservable to subscribe the result. + */ + @GET("/daviferreira/41238222ac31fe36348544ee1d4a9a5e/raw/5dc996407f6c9a6630bfcec56eee22d4bc54b518/employees.json") + fun getEmployee(): Single +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/Attributes.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/Attributes.kt new file mode 100644 index 0000000..185bd9e --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/Attributes.kt @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.model + +import android.os.Parcelable +import androidx.room.ColumnInfo +import androidx.room.Entity +import androidx.room.PrimaryKey +import com.google.gson.annotations.SerializedName +import com.venomvendor.peakon.core.annotation.Mandatory +import kotlinx.android.parcel.Parcelize + +@Parcelize +@Entity +data class Attributes( + @PrimaryKey(autoGenerate = true) + @ColumnInfo(name = "id") + var id: Long, + + @field:Mandatory + @field:SerializedName("firstName") + var firstName: String, + + @field:Mandatory + @field:SerializedName("lastName") + var lastName: String, + + @field:Mandatory + @field:SerializedName("name") + var name: String, + + @field:SerializedName("Job Level") + var jobLevel: String? = null, + + @field:SerializedName("Gender") + var gender: String? = null, + + @field:SerializedName("employmentStart") + var employmentStart: String? = null +) : Parcelable diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/Employee.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/Employee.kt new file mode 100644 index 0000000..bf374a5 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/Employee.kt @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.model + +import android.os.Parcelable +import androidx.room.ColumnInfo +import androidx.room.Embedded +import androidx.room.Entity +import androidx.room.PrimaryKey +import androidx.room.TypeConverters +import com.google.gson.annotations.SerializedName +import com.venomvendor.peakon.core.annotation.Mandatory +import com.venomvendor.peakon.employee.db.AttributeConverter +import kotlinx.android.parcel.Parcelize + +@Parcelize +@Entity +data class Employee( + @Embedded + @field:TypeConverters(AttributeConverter::class) + @field:SerializedName("attributes") + val attributes: Attributes, + + @ColumnInfo(name = "eid") + @field:Mandatory + @field:SerializedName("id") + @PrimaryKey + val id: String +) : Parcelable diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/EmployeeWrapper.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/EmployeeWrapper.kt new file mode 100644 index 0000000..e15d29a --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/model/EmployeeWrapper.kt @@ -0,0 +1,16 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.model + +import android.os.Parcelable +import com.google.gson.annotations.SerializedName +import kotlinx.android.parcel.Parcelize + +@Parcelize +data class EmployeeWrapper( + @field:SerializedName("data") + val employees: List +) : Parcelable diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/repository/AllEmployeeRepository.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/repository/AllEmployeeRepository.kt new file mode 100644 index 0000000..1cc4442 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/repository/AllEmployeeRepository.kt @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.repository + +import android.annotation.SuppressLint +import com.venomvendor.peakon.core.data.factory.Repository +import com.venomvendor.peakon.employee.dao.EmployeeDao +import com.venomvendor.peakon.employee.factory.EmployeeService +import com.venomvendor.peakon.employee.model.Employee +import io.reactivex.Single +import org.koin.core.KoinComponent + +class AllEmployeeRepository( + private val storage: EmployeeDao, + private val apiService: EmployeeService +) : Repository>, KoinComponent { + + lateinit var search: String + + override fun cachedData(): List? { + return cachedData(true) + } + + @SuppressLint("CheckResult") + private fun cachedData(retry: Boolean): List? { + storage.getAll(search) + .run { + if (isEmpty() && storage.getCount() == 0) { + /****** THIS IS A HACK :: START + * RIGHT WAY IS TO HAVE SINGLE SOURCE OF TRUTH + * such as Database & subscribe to changes ******/ + if (retry && request().blockingGet() != null) { + return cachedData(false) + } + /****** THIS IS A HACK :: END ******/ + return null + } + return this + } + } + + override fun request(): Single> { + return apiService.getEmployee() + .map { + it.employees + } + .doOnSuccess { + if (it.isEmpty()) { + // TODO: Wrap in nice exception + throw RuntimeException("Unknown Error Occurred") + } + } + .doOnSuccess { + saveData(it) + } + } + + @Throws(Exception::class) + override fun saveData(data: List) { + // Do In parallel + storage.insert(data) +// Uncomment below, once Hacky way is fixed. +// .subscribeOn(Schedulers.io()) + .subscribe() + } +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/repository/EmployeeRepository.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/repository/EmployeeRepository.kt new file mode 100644 index 0000000..9d10344 --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/repository/EmployeeRepository.kt @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.repository + +import androidx.annotation.CheckResult +import com.venomvendor.peakon.core.data.RepositoryManager +import com.venomvendor.peakon.employee.db.EmployeeDatabase +import com.venomvendor.peakon.employee.factory.EmployeeService +import com.venomvendor.peakon.employee.model.Employee +import io.reactivex.Single +import org.koin.core.KoinComponent + +class EmployeeRepository( + apiService: EmployeeService, + storage: EmployeeDatabase +) : KoinComponent { + private var repo = AllEmployeeRepository(storage.teamDao(), apiService) + private val mEmployee: RepositoryManager> by lazy { + // Create request object + RepositoryManager.create(repo) + } + + @CheckResult + fun getTeams(query: String): Single> { + repo.apply { + this.search = query + } + // Execute repository + return mEmployee.execute() + } +} diff --git a/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/viewmodel/EmployeeViewModel.kt b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/viewmodel/EmployeeViewModel.kt new file mode 100644 index 0000000..c6ca1ea --- /dev/null +++ b/sdk-search/src/main/kotlin/com/venomvendor/peakon/employee/viewmodel/EmployeeViewModel.kt @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.viewmodel + +import androidx.annotation.CheckResult +import androidx.lifecycle.ViewModel +import com.venomvendor.peakon.employee.model.Employee +import com.venomvendor.peakon.employee.repository.EmployeeRepository +import io.reactivex.Single +import org.koin.core.KoinComponent + +class EmployeeViewModel( + private val employeeRepo: EmployeeRepository +) : ViewModel(), KoinComponent { + /** + * THIS API WRAPS **DATA** + * ****************************************** + * Inside [Single]. Error is propagated as is. + * ****************************************** + * Get list of EmployeeDetail + * + * @return List of [Employee] wrapped inside response. + */ + @CheckResult + fun getTeams(search: String): Single> { + return employeeRepo.getTeams(search) + } +} diff --git a/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/EmployeeDetailPojoTest.kt b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/EmployeeDetailPojoTest.kt new file mode 100644 index 0000000..351381c --- /dev/null +++ b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/EmployeeDetailPojoTest.kt @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee + +import com.openpojo.reflection.impl.PojoClassFactory +import com.openpojo.validation.ValidatorBuilder +import com.openpojo.validation.rule.impl.GetterMustExistRule +import com.openpojo.validation.rule.impl.NoNestedClassRule +import com.openpojo.validation.rule.impl.SetterMustExistRule +import com.openpojo.validation.test.impl.DefaultValuesNullTester +import com.openpojo.validation.test.impl.GetterTester +import com.openpojo.validation.test.impl.SetterTester +import com.venomvendor.peakon.employee.model.Employee +import org.junit.Test + +/** + * @see [Testing documentation](http://d.android.com/tools/testing) + */ +class EmployeeDetailPojoTest { + + @Test + fun searchTeamPojoTest() { + val validator = ValidatorBuilder.create() + .with(GetterMustExistRule()) + .with(SetterMustExistRule()) + .with(SetterTester()) + .with(GetterTester()) + .with(DefaultValuesNullTester()) + .with(NoNestedClassRule()) + // Build assertion criteria + .build() + + // Add all classes + val clzez = setOf( + Employee::class.java + ) + + for (clazz in clzez) { + // This is where the assertion happens + validator.validate(PojoClassFactory.getPojoClass(clazz)) + } + } +} diff --git a/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/dao/FakeDao.kt b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/dao/FakeDao.kt new file mode 100644 index 0000000..b422c90 --- /dev/null +++ b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/dao/FakeDao.kt @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.dao + +import androidx.room.DatabaseConfiguration +import androidx.room.InvalidationTracker +import androidx.sqlite.db.SupportSQLiteOpenHelper +import com.venomvendor.peakon.employee.db.EmployeeDatabase +import org.mockito.Mockito + +class FakeDao(private val employeeDao: EmployeeDao?) : + EmployeeDatabase() { + override fun teamDao(): EmployeeDao { + return employeeDao!! + } + + override fun createOpenHelper(config: DatabaseConfiguration?): SupportSQLiteOpenHelper { + return Mockito.mock(SupportSQLiteOpenHelper::class.java) + } + + override fun createInvalidationTracker(): InvalidationTracker { + return Mockito.mock(InvalidationTracker::class.java) + } + + override fun clearAllTables() { +// TODO("not implemented") //To change body of created functions use File | Settings | File Templates. + } +} diff --git a/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/helper/BaseTest.kt b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/helper/BaseTest.kt new file mode 100644 index 0000000..ae859ee --- /dev/null +++ b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/helper/BaseTest.kt @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.helper + +import androidx.annotation.CallSuper +import io.reactivex.plugins.RxJavaPlugins +import io.reactivex.schedulers.Schedulers +import org.junit.After +import org.junit.Before +import org.koin.core.context.stopKoin +import org.koin.test.KoinTest + +abstract class BaseTest : KoinTest { + + @Before + @CallSuper + open fun before() { + RxJavaPlugins.setIoSchedulerHandler { + Schedulers.trampoline() + } + } + + @After + @CallSuper + open fun autoClose() { + stopKoin() + RxJavaPlugins.reset() + } + + companion object { + fun with(instance: Any): TestHelper { + return TestHelper(instance) + } + } +} + +class TestHelper(private val testInstance: Any) { + /** + * Add files under `/src/test/resources` + * Add files under `/src/androidTest/resources` + * + * @param filePath location of file to be read, relative path. + * @return Contents in file. + */ + fun read(filePath: String): String { + return testInstance.javaClass.getResource("/$filePath")!!.readText() + } +} diff --git a/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/repository/EmployeeDetailRepositoryTest.kt b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/repository/EmployeeDetailRepositoryTest.kt new file mode 100644 index 0000000..6dd46b6 --- /dev/null +++ b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/repository/EmployeeDetailRepositoryTest.kt @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.repository + +import com.google.gson.Gson +import com.venomvendor.peakon.core.di.coreModule +import com.venomvendor.peakon.employee.dao.EmployeeDao +import com.venomvendor.peakon.employee.dao.FakeDao +import com.venomvendor.peakon.employee.db.EmployeeDatabase +import com.venomvendor.peakon.employee.di.employeeModule +import com.venomvendor.peakon.employee.factory.EmployeeService +import com.venomvendor.peakon.employee.helper.BaseTest +import com.venomvendor.peakon.employee.model.EmployeeWrapper +import io.reactivex.Completable +import io.reactivex.Single +import org.junit.Test +import org.koin.core.context.startKoin +import org.koin.test.get +import org.mockito.Mockito +import org.mockito.Mockito.doReturn +import org.mockito.Mockito.`when` as mockitoWhen + +class EmployeeDetailRepositoryTest : BaseTest() { + + override fun before() { + super.before() + startKoin { + modules(listOf(coreModule, employeeModule)) + } + } + + @Test + fun `teamTeams With Results`() { + val response: String = with(this).read("response.json") + val teamObj = get().fromJson( + response, + EmployeeWrapper::class.java + ) + + val employee: EmployeeService = Mockito.mock(EmployeeService::class.java) + val teamDao = Mockito.mock(EmployeeDao::class.java) + + val fakeDao: EmployeeDatabase = FakeDao(teamDao) + val teamRepository = EmployeeRepository(employee, fakeDao) + + mockitoWhen(teamDao.getAll()) + .thenReturn(listOf()) + + doReturn(Completable.complete()) + .`when`(teamDao).insert(teamObj.employees) + + mockitoWhen(employee.getEmployee()) + .thenReturn(Single.just(teamObj)) + + teamRepository.getTeams("ABC") + .test() + .assertSubscribed() + .assertComplete() + .assertNoErrors() + .assertValue { + it.count() == teamObj.employees.count() + } + } +} diff --git a/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/viewmodel/EmployeeDetailViewModelTest.kt b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/viewmodel/EmployeeDetailViewModelTest.kt new file mode 100644 index 0000000..a8b4d73 --- /dev/null +++ b/sdk-search/src/test/kotlin/com/venomvendor/peakon/employee/viewmodel/EmployeeDetailViewModelTest.kt @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2019 VenomVendor. All rights reserved. + * Created by VenomVendor on 09-Oct-2019. + */ + +package com.venomvendor.peakon.employee.viewmodel + +import com.google.gson.Gson +import com.venomvendor.peakon.core.di.coreModule +import com.venomvendor.peakon.employee.di.employeeModule +import com.venomvendor.peakon.employee.helper.BaseTest +import com.venomvendor.peakon.employee.model.EmployeeWrapper +import com.venomvendor.peakon.employee.repository.EmployeeRepository +import io.reactivex.Single +import org.junit.Test +import org.koin.core.context.startKoin +import org.koin.test.get +import org.mockito.Mockito +import org.mockito.Mockito.anyString +import org.mockito.Mockito.`when` as mockitoWhen + +class EmployeeDetailViewModelTest : BaseTest() { + + override fun before() { + super.before() + startKoin { + modules(listOf(coreModule, employeeModule)) + } + } + + @Test + fun `getTeams With Results`() { + val response: String = with(this).read("response.json") + val teamObj = get().fromJson( + response, + EmployeeWrapper::class.java + ) + + val mockRepository = Mockito.mock(EmployeeRepository::class.java) + + mockitoWhen(mockRepository.getTeams(anyString())) + .thenReturn( + Single.just(teamObj.employees) + ) + + val randomUserViewModel = EmployeeViewModel(mockRepository) + + randomUserViewModel.getTeams("ABC") + .test() + .assertSubscribed() + .assertComplete() + .assertNoErrors() + .assertValueCount(1) + .assertValue { + it.count() == teamObj.employees.count() + } + } + + @Test + fun `getTeams With Error`() { + val mockRepository = Mockito.mock(EmployeeRepository::class.java) + + mockitoWhen(mockRepository.getTeams(anyString())) + .thenReturn( + Single.error(Exception("Test")) + ) + + val randomUserViewModel = EmployeeViewModel(mockRepository) + + randomUserViewModel.getTeams("ERR") + .test() + .assertSubscribed() + .assertError { + it.message == "Test" + } + } +} diff --git a/sdk-search/src/test/resources/error.json b/sdk-search/src/test/resources/error.json new file mode 100644 index 0000000..066673e --- /dev/null +++ b/sdk-search/src/test/resources/error.json @@ -0,0 +1,5 @@ +{ + "error": "error", + "message": "Error Message", + "statusCode": 401 +} diff --git a/sdk-search/src/test/resources/response.json b/sdk-search/src/test/resources/response.json new file mode 100644 index 0000000..55e5983 --- /dev/null +++ b/sdk-search/src/test/resources/response.json @@ -0,0 +1,730 @@ +{ + "data": [ + { + "type": "employees", + "id": "323", + "links": { + "self": "http://localhost:3000/v1/employees/323" + }, + "attributes": { + "identifier": null, + "firstName": "Harriet", + "lastName": "McKinney", + "name": "Harriet McKinney", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 3767, + "Business Unit": "Sales", + "Commute Time": 34, + "Age": "1984-02-08", + "Department": "Customer Care", + "Gender": "Female", + "Job Level": "Manager", + "Local Office": "Kuala Lumpur", + "% of target": 88, + "Region": "APAC", + "Salary": 76000, + "Tenure": "2014-05-31" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "324" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "201" + } + } + } + }, + { + "type": "employees", + "id": "139", + "links": { + "self": "http://localhost:3000/v1/employees/139" + }, + "attributes": { + "identifier": null, + "firstName": "Harriet", + "lastName": "Banks", + "name": "Harriet Banks", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 215835, + "Business Unit": "People & Operations", + "Commute Time": 18, + "Age": "1984-04-19", + "Department": "Learning and Development", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "New York", + "% of target": 12, + "Region": "AMER", + "Salary": 332000, + "Tenure": "2009-06-30" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "140" + } + }, + "phones": { + "data": [] + } + } + }, + { + "type": "employees", + "id": "142", + "links": { + "self": "http://localhost:3000/v1/employees/142" + }, + "attributes": { + "identifier": null, + "firstName": "Mathilda", + "lastName": "Summers", + "name": "Mathilda Summers", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 95050, + "Business Unit": "Marketing", + "Commute Time": 131, + "Age": "1976-12-19", + "Department": "Media", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "London", + "% of target": 166, + "Region": "EMEA", + "Salary": 248000, + "Tenure": "2000-05-15" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "143" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "140", + "links": { + "self": "http://localhost:3000/v1/employees/140" + }, + "attributes": { + "identifier": null, + "firstName": "Eugene", + "lastName": "Wong", + "name": "Eugene Wong", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 157643, + "Business Unit": "Technology", + "Commute Time": 16, + "Age": "1980-03-21", + "Department": "Engineering", + "Gender": "Male", + "Job Level": "Executive", + "Local Office": "New York", + "% of target": 180, + "Region": "AMER", + "Salary": 483000, + "Tenure": "2011-01-31" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "141" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "340", + "links": { + "self": "http://localhost:3000/v1/employees/340" + }, + "attributes": { + "identifier": null, + "firstName": "New", + "lastName": "Manager", + "name": "New Manager", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2018-02-23T09:09:44.447Z", + "external": false + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "341" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "145", + "links": { + "self": "http://localhost:3000/v1/employees/145" + }, + "attributes": { + "identifier": null, + "firstName": "Marguerite", + "lastName": "Ryan", + "name": "Marguerite Ryan", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 81656, + "Business Unit": "Sales", + "Commute Time": 111, + "Age": "1991-09-14", + "Department": "Sales Development", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "Berlin", + "% of target": 121, + "Region": "EMEA", + "Salary": 341000, + "Tenure": "2015-01-29" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "146" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "171", + "links": { + "self": "http://localhost:3000/v1/employees/171" + }, + "attributes": { + "identifier": null, + "firstName": "Donald", + "lastName": "Butler", + "name": "Donald Butler", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 277768, + "Business Unit": "IT", + "Commute Time": 38, + "Age": "1990-02-23", + "Department": "Security", + "Gender": "Male", + "Job Level": "Executive", + "Local Office": "Berlin", + "% of target": 8, + "Region": "EMEA", + "Salary": 238000, + "Tenure": "2013-04-12" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "172" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "151", + "links": { + "self": "http://localhost:3000/v1/employees/151" + }, + "attributes": { + "identifier": null, + "firstName": "Jim", + "lastName": "Carlson", + "name": "Jim Carlson", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 85637, + "Business Unit": "Finance", + "Commute Time": 111, + "Age": "1968-06-06", + "Department": "Accounting", + "Gender": "Male", + "Job Level": "Executive", + "Local Office": "Beijing", + "% of target": 95, + "Region": "APAC", + "Salary": 163000, + "Tenure": "2013-04-29" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "152" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + }, + { + "type": "employees", + "id": "141", + "links": { + "self": "http://localhost:3000/v1/employees/141" + }, + "attributes": { + "identifier": null, + "firstName": "Alta", + "lastName": "Maxwell", + "name": "Alta Maxwell", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 137145, + "Business Unit": "People & Operations", + "Commute Time": 67, + "Age": "1988-07-04", + "Department": "Recruitment", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "Tokyo", + "% of target": 21, + "Region": "APAC", + "Salary": 441000, + "Tenure": "2016-04-17" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "142" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "139" + } + } + } + } + ], + "included": [ + { + "type": "accounts", + "id": "140", + "links": { + "self": "http://localhost:3000/v1/accounts/140" + }, + "attributes": { + "email": "harriet.banks@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": "en-GB", + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "141", + "links": { + "self": "http://localhost:3000/v1/accounts/141" + }, + "attributes": { + "email": "eugene.wong@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "142", + "links": { + "self": "http://localhost:3000/v1/accounts/142" + }, + "attributes": { + "email": "alta.maxwell@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": "en-GB", + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "143", + "links": { + "self": "http://localhost:3000/v1/accounts/143" + }, + "attributes": { + "email": "mathilda.summers@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "146", + "links": { + "self": "http://localhost:3000/v1/accounts/146" + }, + "attributes": { + "email": "marguerite.ryan@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "152", + "links": { + "self": "http://localhost:3000/v1/accounts/152" + }, + "attributes": { + "email": "jim.carlson@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "172", + "links": { + "self": "http://localhost:3000/v1/accounts/172" + }, + "attributes": { + "email": "donald.butler@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "324", + "links": { + "self": "http://localhost:3000/v1/accounts/324" + }, + "attributes": { + "email": "harriet.mckinney@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": null, + "timezoneEffective": null + } + }, + { + "type": "accounts", + "id": "341", + "links": { + "self": "http://localhost:3000/v1/accounts/341" + }, + "attributes": { + "email": "manager@kinetar.com", + "locale": null, + "timezone": null, + "bouncedAt": null, + "bounceReason": null, + "localeEffective": "en-US", + "timezoneEffective": null + } + }, + { + "type": "employees", + "id": "139", + "links": { + "self": "http://localhost:3000/v1/employees/139" + }, + "attributes": { + "identifier": null, + "firstName": "Harriet", + "lastName": "Banks", + "name": "Harriet Banks", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 215835, + "Business Unit": "People & Operations", + "Commute Time": 18, + "Age": "1984-04-19", + "Department": "Learning and Development", + "Gender": "Female", + "Job Level": "Executive", + "Local Office": "New York", + "% of target": 12, + "Region": "AMER", + "Salary": 332000, + "Tenure": "2009-06-30" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "140" + } + }, + "phones": { + "data": [] + } + } + }, + { + "type": "employees", + "id": "201", + "links": { + "self": "http://localhost:3000/v1/employees/201" + }, + "attributes": { + "identifier": null, + "firstName": "Derrick", + "lastName": "Cummings", + "name": "Derrick Cummings", + "features": [ + "engagement" + ], + "avatar": null, + "employmentStart": "2016-01-31T00:00:00.000Z", + "external": false, + "Last Year Bonus": 9214, + "Business Unit": "Sales", + "Commute Time": 6, + "Age": "1992-07-08", + "Department": "Customer Care", + "Gender": "Male", + "Job Level": "Senior Manager", + "Local Office": "Seoul", + "% of target": 31, + "Region": "APAC", + "Salary": 142000, + "Tenure": "2013-11-07" + }, + "relationships": { + "company": { + "data": { + "type": "companies", + "id": "5" + } + }, + "account": { + "data": { + "type": "accounts", + "id": "202" + } + }, + "phones": { + "data": [] + }, + "Manager": { + "data": { + "type": "employees", + "id": "194" + } + } + } + } + ], + "meta": { + "page": { + "total": 9 + } + }, + "links": { + "self": "http://localhost:3000/v1/employees/contexts/company_5?per_page=25&q=harriet&sort=score&order=desc&include=account%2Cphones%2CLast%20Year%20Bonus%2CBusiness%20Unit%2CCommute%20Time%2CManager&simple=false", + "first": "http://localhost:3000/v1/employees/contexts/company_5?per_page=25&q=harriet&sort=score&order=desc&include=account%2Cphones%2CLast%20Year%20Bonus%2CBusiness%20Unit%2CCommute%20Time%2CManager&simple=false", + "last": "http://localhost:3000/v1/employees/contexts/company_5?per_page=25&page=1&q=harriet&sort=score&order=desc&include=account%2Cphones%2CLast%20Year%20Bonus%2CBusiness%20Unit%2CCommute%20Time%2CManager&simple=false" + } +} diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..c613e81 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,10 @@ +rootProject.name = 'Peakon' + +include ':demo' +project(':demo').projectDir = new File(settingsDir, 'app') + +include ':core' +project(':core').projectDir = new File(settingsDir, 'sdk-core') + +include ':search' +project(':search').projectDir = new File(settingsDir, 'sdk-search')