GeocoderOpenCage (empty) → 0.1.0.1
raw patch · 7 files changed
+1348/−0 lines, 7 filesdep +HTTPdep +aesondep +basesetup-changed
Dependencies added: HTTP, aeson, base, bytestring, text
Files
- GeocoderOpenCage.cabal +39/−0
- LICENSE +674/−0
- Setup.hs +2/−0
- src/Geocoder.hs +245/−0
- src/HTTPWrapper.hs +54/−0
- src/Main.hs +121/−0
- src/RevGeocoder.hs +213/−0
+ GeocoderOpenCage.cabal view
@@ -0,0 +1,39 @@+name: GeocoderOpenCage+version: 0.1.0.1+cabal-version: >= 1.4+build-type: Simple+author: Juergen Hahn+maintainer: hahn@geoinfo.tuwien.ac.at+category: Web+data-files: + src/Geocoder.hs,+ src/OpenCageExamples.hs,+ src/RevGeocoder.hs+ GeocoderOpenCage.cabal,+ Setup.hs+license: GPL+license-file: LICENSE+stability: experimental+homepage: https://github.com/juergenhah/Haskell-Geocoder-OpenCage.git+description: uses the OpenCage REST API to geocode and reverse geocode+synopsis: Geocoder and Reverse Geocoding Service Wrapper++library + build-depends: + base >= 4 && <5,+ text >= 1.1.1.0 && <2,+ HTTP >=4000.2.8 && <4000.3,+ bytestring >=0.10.0 && <0.11,+ aeson >=0.9+ hs-source-dirs: src+ ghc-options: -Wall+ exposed-modules: + Geocoder,+ RevGeocoder,+ Main+ other-modules: + HTTPWrapper+ + extensions: + OverloadedStrings+
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<http://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ src/Geocoder.hs view
@@ -0,0 +1,245 @@+{-# LANGUAGE DeriveGeneric, OverloadedStrings #-}++{-|+Module : Geocoder+Description : Module to convert an address into coordinates.+Copyright : +License : GPL-3+Maintainer : hahn@geoinfo.tuwien.ac.at+Stability : experimental++Requests the <http://geocoder.opencagedata.com> geocoding service to get latitude and longitude values from an address. Uses Aeson to convert the response from JSON to Haskell types.+-}+module Geocoder (QueryParameters(..)+ ,defaultParams+ ,TokenToGeocode+ ,GeoCageDeveloperKey+ ,getAPIResponse+ ,getAPIResponseWith+ ,geocode+ ,geocodeWith+ ,geocodeGeoTokensList+ ,createGeocoderParams+ ,ResponseBody(..)+ ,Result(..)+ ,License(..)+ ,Rate(..)+ ,Status(..)+ ,Timestamp(..)+ ,Components(..)+ ,Location(..)+ ,Bounds (..)) where++import qualified Data.Text as T (Text,pack,unpack)+import GHC.Generics (Generic)+import Data.Aeson hiding (Result) ++import Data.ByteString.Char8 as Bs (ByteString) ++import HTTPWrapper++++-- * Request Type++-- | data type including all possible parameters OpenCage API offers+data QueryParameters = QueryParameters {+ para_q::T.Text, -- ^ Text to query+ para_key::T.Text, -- ^ OpenCage key+ para_language:: Maybe T.Text, -- ^ language for the result: IETF format language code + para_pretty::Maybe T.Text, -- ^ should the result be pretty printed ?+ para_bounds::Maybe T.Text, -- ^ rectangle hint: southwest corner, northeast corner+ para_country::Maybe T.Text, -- ^ country hint: ISO 3166-1 Alpha 3+ para_fields::Maybe T.Text -- ^ comma separated list+}deriving (Show)+++-- | minimal example of QueryParameters+-- can be used to create your own parameters+defaultParams :: QueryParameters+defaultParams = QueryParameters {+ para_q="",+ para_key="",+ para_language=Just "en",+ para_pretty=Nothing,+ para_bounds=Nothing,+ para_country=Nothing,+ para_fields=Nothing}++type TokenToGeocode = T.Text+type GeoCageDeveloperKey = T.Text++-- * Request functions++-- | Minimalistic version to geocode a token returning the whole Response+getAPIResponse :: TokenToGeocode -- ^ token to geocode+ -> GeoCageDeveloperKey -- ^ OpenCage key+ -> IO (Maybe ResponseBody) -- ^ if the geocoding was successful there is a ResultBody full of data returned+getAPIResponse tokenToGeocode developerKey = + getAPIResponseWith parameters+ where parameters = defaultParams {para_q= tokenToGeocode,para_key=developerKey}+++-- | main geocode function, called by all other functions, deals with errors +getAPIResponseWith :: QueryParameters -- ^ parameters included into the request+ -> IO (Maybe ResponseBody) -- ^ if the geocoding was successful there is a ResultBody full of data returned+getAPIResponseWith parameters =do+ reqSuccesfull <-requestGeocage parameters+ case reqSuccesfull of+ Left err -> do putStrLn "exception at OpenCage request, issue:"+ print err+ return Nothing+ Right response -> case eitherDecodeStrict response of+ Left exception -> do putStrLn+ "exception at ByteString to JSON conversion, issue:"+ print exception+ return Nothing+ Right resultBody -> return $ Just resultBody+ where requestGeocage :: QueryParameters -> IO (Either String ByteString)+ requestGeocage params = download geocageUrl para+ where geocageUrl = "http://api.opencagedata.com/geocode/v1/json?" + para = convertQParamstoOptionsList params+ +-- | converts QueryParameters to a list of tupels needed by the HTTPWrapper module +convertQParamstoOptionsList :: QueryParameters -- ^ data type including all request parameters + -> [(String,String)] -- ^ list of tupels containing all request parameters+convertQParamstoOptionsList (QueryParameters q key lang pre boun cou fields)= [] +++ [("q",T.unpack q),("key",T.unpack key)]+ ++ toParameter "language" lang + ++ toParameter "pretty" pre + ++ toParameter "bounds" boun+ ++ toParameter "country" cou+ ++ toParameter "fields" fields+ where toParameter :: String -> Maybe T.Text -> [(String,String)]+ toParameter param mValue = case mValue of+ Nothing -> []+ Just val -> [(param,T.unpack val)]+++-- | geocodes the token and returns a list of results+geocode :: TokenToGeocode -- ^ token to geocode, empty if an error occured+ -> GeoCageDeveloperKey -- ^ OpenCage key+ -> IO [Result] -- ^ list of results+geocode tokentoGeocode developerKey = geocodeWith params+ where params = defaultParams {para_q=tokentoGeocode,para_key=developerKey}+ ++-- | geocodes the token included into the QueryParameters respecting all values set in the QueryParameters +-- returns an empty list if an exception occured or the result was empty+geocodeWith :: QueryParameters -- ^ parameters included into the request+ -> IO [Result] -- ^ list of results, empty if an error occured+geocodeWith params = do + resp <- getAPIResponseWith params + case resp of+ Nothing -> return []+ Just r -> return $ results r++-- | geocodes a list of tokens and prints the results+geocodeGeoTokensList :: [TokenToGeocode] -- ^ list of tokens to geocode+ -> GeoCageDeveloperKey -- ^ OpenCage key+ -> IO() -- ^ prints the result+geocodeGeoTokensList geoTokens developerKey = do+ let geocodeparams = defaultParams {para_key=developerKey,+ para_language= Just$ T.pack "en",+ para_country = Just $ T.pack "DEU"}+ let params = createGeocoderParams geocodeparams geoTokens+ res <- mapM geocodeWith params+ print res++-- | packs tokens into QueryParameters and returns this as a list+-- if you want to specify your own parameters use this function+createGeocoderParams :: QueryParameters -- ^ parameters that should be used for all tokens in the list+ -> [TokenToGeocode] -- ^ list of tokens to geocode+ -> [QueryParameters] -- ^ list of parameters, for every token one QueryParameter entry is included+createGeocoderParams params geoTokens = zipWith (\p t -> p {para_q=t}) + (replicate (length geoTokens) params) + geoTokens++-- * data types for the geocoding result+ ++-- | data type respecting OpenCage response encoded as JSON +data ResponseBody = ResponseBody { + licenses :: [License], + rate :: Rate,+ results :: [Result],+ status :: Status,+ thanks :: T.Text,+ timestamp :: Timestamp,+ total_results :: Integer+} deriving (Show,Generic)+instance FromJSON ResponseBody+ +data License = License { + name :: T.Text, + url :: T.Text+} deriving (Show, Generic)+instance FromJSON License ++data Rate = Rate {+ limit :: Integer, + remaining::Integer, + reset::Double +} deriving (Show, Generic)+instance FromJSON Rate++data Result = Result { + bounds :: Bounds, + components:: Components, + confidence:: Integer, + formatted:: T.Text , + geometry:: Location+} deriving (Show,Generic)++instance FromJSON Result where+ parseJSON (Object v) = Result <$>+ v .: "bounds" <*>+ v .: "components"<*>+ v .: "confidence"<*>+ (v .:? "formatted" .!= "") <*> + v .: "geometry"+ parseJSON _ = undefined++data Status = Status { + code::Integer, + message::T.Text+} deriving (Show, Generic)+instance FromJSON Status++data Timestamp = Timestamp { + created_http::T.Text, + created_unix:: Integer+} deriving (Show,Generic)+instance FromJSON Timestamp++data Bounds = Bounds { + northeast:: Location, + southwest::Location+} deriving (Show, Generic)+instance FromJSON Bounds++data Location = Location { + lat::Double, + lng :: Double+} deriving (Show, Generic)+instance FromJSON Location++data Components = Components { + country :: T.Text, + country_code:: T.Text,+ county:: T.Text,+ state:: T.Text,+ city:: T.Text,+ road :: T.Text+} deriving (Show,Generic)++-- | not all components are included into the response, if so there is an empty string as default value+instance FromJSON Components where + parseJSON (Object v) = Components <$>+ (v .:? "country" .!= "") <*>+ (v .:? "country_code" .!= "") <*>+ (v .:? "county" .!= "") <*>+ (v .:? "state" .!= "") <*>+ (v .:? "city" .!= "") <*>+ (v .:? "road" .!= "")+ parseJSON _ = undefined
+ src/HTTPWrapper.hs view
@@ -0,0 +1,54 @@+{-|+Module : HTTPWrapper+Description : Requests a URL and returns the response body+Copyright : +License : GPL-3+Maintainer : hahn@geoinfo.tuwien.ac.at+Stability : experimental++This module handles HTTP requests using the simpleHTTP function. It deals with the most+exceptions.+-}+module HTTPWrapper (download) where+import Control.Exception as E (SomeException, try)+import Data.ByteString.Char8 as Bs (ByteString, pack)+import Network.HTTP as HTTP (getRequest, simpleHTTP)+import Network.HTTP.Base as Base+import Network.HTTP.Headers as Headers+import Network.Stream as Stream++-- | requests the url with the parameter List via GET, +-- returns an error message or the body as a ByteString+download :: String -- ^ URL to request+ -> [(String,String)] -- ^ parameter list attached to the request URL e.g: [("p1","test"),("p2","today")]+ -> IO (Either String ByteString) -- ^ Left includes the error with a message, Right the response body+download url requestParameter =do+ putStrLn requestURL+ downloadURL requestURL+ where requestURL = url ++ (Base.urlEncodeVars requestParameter)++-- | function requests the URL and returns with a Error and a Message or with the body as ByteString+-- can deal with redirects, see RealWorldHaskell for a description+downloadURL :: String -> IO (Either String ByteString) --+downloadURL url = do+ result <- E.try (HTTP.simpleHTTP (HTTP.getRequest url)) :: IO (Either E.SomeException (Stream.Result (Response String)))+ case result of+ Left x -> return $ Left ("Problem with simpleHTTP :"++show x)+ Right resp ->+ case resp of+ Left x ->+ case x of+ Stream.ErrorReset ->return $ Left "ErrorReset: "+ Stream.ErrorClosed ->return $ Left "ErrorClosed: "+ Stream.ErrorParse y -> return $ Left ("ErrorClosed: "++show y)+ Stream.ErrorMisc y -> return $ Left ("ErrorClosed: "++show y)+ Right r ->+ case rspCode r of+ (2,_,_) -> return $ Right (Bs.pack $ rspBody r)+ (3,_,_) ->+ case findHeader Headers.HdrLocation r of --redirect+ Nothing -> return $ Left (show r)+ Just redirecturl -> downloadURL redirecturl+ _ -> return $ Left ("unknown Problem occurred")++
+ src/Main.hs view
@@ -0,0 +1,121 @@+{-|+Module : Main+Description : Some examples howto use the Geocoder and RevGeocoder modules.+Copyright : +License : GPL-3+Maintainer : hahn@geoinfo.tuwien.ac.at+Stability : experimental++Examples to show how Geocoder and RevGeocoder works.+-}+module Main where++import qualified Geocoder as Geocoder+import qualified RevGeocoder as RevGeocoder++import qualified Data.Text as T (Text (), pack, unpack)++main :: IO()+main = do+ putStrLn "geocode NewYork:"+ geocodeNewYork+ putStrLn "geocode Vienna"+ geocodeVienna+ putStrLn "geocode Vienna"+ geocodeVienna+ putStrLn "geocode Austria show results in German"+ geocodeAustriaGermanResult+ putStrLn "reverse geocode a TU building"+ reverseGeocodeTUVienna + putStrLn "reverse geocode a TU building"+ testGeocodeAPI1++-- | function for your OpenCage key+myDeveloperkey :: T.Text+myDeveloperkey = T.pack "put your OpenCage key here"+-- * geocoding++-- | requests the OpenCage Geocoder to geocode the token: Now York and returns the whole result body+--+-- >>> geocodeNewYork+-- Just (ResponseBody {licenses = [License {name = "CC-BY-SA", url = "http://creativecommons.org/licenses/by-sa/3.0/"},License {name = "ODbL", url = "http://opendatacommons.org/licenses/odbl/summary/"}], rate = Rate {limit = 2500, remaining = 2463, reset = 1.4458176e9}, results = [Result {bounds = Bounds {northeast = Location {lat = 40.917577, lng = -73.7001714}, southwest = Location {lat = 40.477399, lng = -74.2590899}}, components = Components {country = "United States of America", country_code = "us", county = "", state = "New York", city = "New York City", road = ""}, confidence = 2, formatted = "New York City, United States of America", geometry = Location {lat = 40.7305991, lng = -73.9865812}},Result {bounds = Bounds {northeast = Location {lat = 45.0158611, lng = -71.7897328}, southwest = Location {lat = 40.477399, lng = -79.7623534}}, components = Components {country = "United States of America", country_code = "us", county = "", state = "New York", city = "", road = ""}, confidence = 1, formatted = "New York, United States of America", geometry = Location {lat = 43.1561681, lng = -75.8449946}},Result {bounds = Bounds {northeast = Location {lat = 41.4047714, lng = -73.340764}, southwest = Location {lat = 40.1247714, lng = -74.620764}}, components = Components {country = "United States of America", country_code = "us", county = "New York", state = "New York", city = "New York City", road = ""}, confidence = 1, formatted = "New York City, New York, United States of America", geometry = Location {lat = 40.7647714, lng = -73.980764}},Result {bounds = Bounds {northeast = Location {lat = 55.0452998, lng = -1.4669496}, southwest = Location {lat = 55.0052998, lng = -1.5069496}}, components = Components {country = "United Kingdom", country_code = "gb", county = "Tyne and Wear", state = "England", city = "", road = ""}, confidence = 7, formatted = "New York, Tyne and Wear, England, United Kingdom", geometry = Location {lat = 55.0252998, lng = -1.4869496}},Result {bounds = Bounds {northeast = Location {lat = 30.8585202, lng = -87.1808048}, southwest = Location {lat = 30.8185202, lng = -87.2208048}}, components = Components {country = "United States of America", country_code = "us", county = "Santa Rosa County", state = "Florida", city = "", road = ""}, confidence = 7, formatted = "New York, Santa Rosa County, Florida, United States of America", geometry = Location {lat = 30.8385202, lng = -87.2008048}},Result {bounds = Bounds {northeast = Location {lat = 39.7052874, lng = -93.9068836}, southwest = Location {lat = 39.6652874, lng = -93.9468836}}, components = Components {country = "United States of America", country_code = "us", county = "Caldwell County", state = "Missouri", city = "", road = ""}, confidence = 7, formatted = "New York, Caldwell County, Missouri, United States of America", geometry = Location {lat = 39.6852874, lng = -93.9268836}},Result {bounds = Bounds {northeast = Location {lat = 40.8716701, lng = -93.2399318}, southwest = Location {lat = 40.8316701, lng = -93.2799318}}, components = Components {country = "United States of America", country_code = "us", county = "Wayne County", state = "Iowa", city = "", road = ""}, confidence = 7, formatted = "New York, Wayne County, Iowa, United States of America", geometry = Location {lat = 40.8516701, lng = -93.2599318}},Result {bounds = Bounds {northeast = Location {lat = 37.0089428, lng = -88.9325629}, southwest = Location {lat = 36.9689428, lng = -88.9725629}}, components = Components {country = "United States of America", country_code = "us", county = "Ballard County", state = "Kentucky", city = "", road = ""}, confidence = 7, formatted = "New York, Ballard County, Kentucky, United States of America", geometry = Location {lat = 36.9889428, lng = -88.9525629}},Result {bounds = Bounds {northeast = Location {lat = 35.0786534, lng = -107.5072717}, southwest = Location {lat = 35.0386534, lng = -107.5472717}}, components = Components {country = "United States of America", country_code = "us", county = "Cibola County", state = "New Mexico", city = "", road = ""}, confidence = 7, formatted = "New York, Cibola County, New Mexico, United States of America", geometry = Location {lat = 35.0586534, lng = -107.5272717}},Result {bounds = Bounds {northeast = Location {lat = 32.1879321, lng = -95.6491277}, southwest = Location {lat = 32.1479321, lng = -95.6891277}}, components = Components {country = "United States of America", country_code = "us", county = "Henderson County", state = "Texas", city = "", road = ""}, confidence = 7, formatted = "New York, Henderson County, Texas, United States of America", geometry = Location {lat = 32.1679321, lng = -95.6691277}}], status = Status {code = 200, message = "OK"}, thanks = "For using an OpenCage Data API", timestamp = Timestamp {created_http = "Sun, 25 Oct 2015 11:23:04 GMT", created_unix = 1445772184}, total_results = 10})+geocodeNewYork :: IO (Maybe Geocoder.ResponseBody) -- ^ Nothing if the request was not successful, Just the ResultBody+geocodeNewYork = Geocoder.getAPIResponse (T.pack "New York") myDeveloperkey+++-- | requests the String Delhi and returns only the license part of the response+--+-- >>> checkLicensesforDelhi+-- which licenses are used:+-- [License {name = "CC-BY-SA", url = "http://creativecommons.org/licenses/by-sa/3.0/"},License {name = "ODbL", url = "http://opendatacommons.org/licenses/odbl/summary/"}]+checkLicensesforDelhi :: IO () -- ^ prints the results+checkLicensesforDelhi = do+ let params = Geocoder.defaultParams {Geocoder.para_q = T.pack "Delhi",Geocoder.para_key=myDeveloperkey}+ eitherResponse<-Geocoder.getAPIResponseWith params+ case eitherResponse of+ Nothing -> putStrLn "no result delivered from the geocoder"+ Just r -> do+ putStrLn "which licenses are used:"+ print (Geocoder.licenses r)++-- | requests an ordinary state (e.g: Delhi) and returns only the number of remaining requests OpenCage allows+--+-- >>> howManyRequestsLeft+-- 2062+howManyRequestsLeft :: IO Integer -- ^ number of remaining requests OpenCage allows for the actual period +howManyRequestsLeft = do+ let params = Geocoder.defaultParams {Geocoder.para_q = T.pack "Delhi",Geocoder.para_key=myDeveloperkey}+ eitherResponse<-Geocoder.getAPIResponseWith params+ case eitherResponse of+ Nothing -> return (-1)+ Just r -> return (Geocoder.remaining . Geocoder.rate $ r)++-- | geocodes Vienna and returns only the results of the responseBody+--+-- >>> geocodeVienna+-- [Result {bounds = Bounds {northeast = Location {lat = 48.3683537, lng = 16.5325042}, southwest = Location {lat = 48.0483537, lng = 16.2125042}}, components = Components {country = "Austria", country_code = "at", county = "", state = "Vienna", city = "Vienna", road = ""}, confidence = 3, formatted = "Vienna, Austria", geometry = Location {lat = 48.2083537, lng = 16.3725042}},Result {bounds = Bounds {northeast = Location {lat = 47.1759223, lng = 1.2131909}, southwest = Location {lat = 46.0482926, lng = -0.1049762}}, components = Components {country = "France", country_code = "fr", county = "Vienne", state = "Poitou-Charentes", city = "", road = ""}, confidence = 1, formatted = "Vienne, France", geometry = Location {lat = 46.61211655, lng = 0.465407009663971}},Result {bounds = Bounds {northeast = Location {lat = 48.2184891, lng = 16.3849175}, southwest = Location {lat = 48.1995278, lng = 16.3552089}}, components = Components {country = "Austria", country_code = "at", county = "", state = "Vienna", city = "Vienna", road = ""}, confidence = 7, formatted = "1010 Vienna, Austria", geometry = Location {lat = 48.2091332, lng = 16.3699915}},Result {bounds = Bounds {northeast = Location {lat = 38.921824, lng = -77.2412649}, southwest = Location {lat = 38.878494, lng = -77.2847629}}, components = Components {country = "United States of America", country_code = "us", county = "Fairfax County", state = "Virginia", city = "Vienna", road = ""}, confidence = 7, formatted = "Vienna, Fairfax County, Virginia, United States of America", geometry = Location {lat = 38.9013013, lng = -77.2651585}},Result {bounds = Bounds {northeast = Location {lat = 48.8309113, lng = 21.9877973}, southwest = Location {lat = 48.7909113, lng = 21.9477973}}, components = Components {country = "Slovakia", country_code = "sk", county = "", state = "Region of Ko\353ice", city = "", road = ""}, confidence = 7, formatted = "072 31 Vinn\233, Slovakia", geometry = Location {lat = 48.8109113, lng = 21.9677973}},Result {bounds = Bounds {northeast = Location {lat = 38.197853, lng = -91.9348889}, southwest = Location {lat = 38.175516, lng = -91.9629559}}, components = Components {country = "United States of America", country_code = "us", county = "Maries County", state = "Missouri", city = "Vienna", road = ""}, confidence = 7, formatted = "Vienna, Maries County, Missouri, United States of America", geometry = Location {lat = 38.1867085, lng = -91.947112}},Result {bounds = Bounds {northeast = Location {lat = 39.348538, lng = -81.5073038}, southwest = Location {lat = 39.296021, lng = -81.5564408}}, components = Components {country = "United States of America", country_code = "us", county = "Wood County", state = "West Virginia", city = "Vienna", road = ""}, confidence = 7, formatted = "Vienna, Wood County, West Virginia, United States of America", geometry = Location {lat = 39.3270191, lng = -81.5484578}},Result {bounds = Bounds {northeast = Location {lat = 37.4034172, lng = -121.9985449}, southwest = Location {lat = 37.4033172, lng = -121.9986449}}, components = Components {country = "United States of America", country_code = "us", county = "Santa Clara County", state = "California", city = "Sunnyvale", road = "West Tasman Drive"}, confidence = 10, formatted = "Vienna, West Tasman Drive, Sunnyvale, CA 94089, United States of America", geometry = Location {lat = 37.4033672, lng = -121.9985949}},Result {bounds = Bounds {northeast = Location {lat = 32.112459, lng = -83.7615469}, southwest = Location {lat = 32.066248, lng = -83.8138599}}, components = Components {country = "United States of America", country_code = "us", county = "Dooly County", state = "Georgia", city = "Vienna", road = ""}, confidence = 7, formatted = "Vienna, Dooly County, Georgia, United States of America", geometry = Location {lat = 32.0913402, lng = -83.7964675}}]+geocodeVienna :: IO [Geocoder.Result]+geocodeVienna = Geocoder.geocode (T.pack "Vienna") myDeveloperkey++-- | geocodes Vienna where the result should be converted into german+--+-- >>> geocodeAustriaGermanResult+-- Österreich+-- Dubai, Vereinigte Arabische Emirate+-- Austria, Recoleta, C1118AAT Buenos Aires, Argentinien+-- Austria, Recoleta, C1425BGR Buenos Aires, Argentinien+-- Austria, Recoleta, C1129ABO Buenos Aires, Argentinien+-- Austria, La Carolina, EC170515, Quito, Ecuador+-- Austria, Lima L05, Peru+-- Austria, Coquimbo, Chile+-- Austria, 12598 Peníscola / Peñíscola, Spanien+-- Austria, Real del Bosque, 91096 Xalapa, Veracruz de Ignacio de la Llave, Mexiko+geocodeAustriaGermanResult :: IO ()+geocodeAustriaGermanResult= do+ let params= Geocoder.defaultParams {Geocoder.para_q = T.pack "Austria"+ ,Geocoder.para_key=myDeveloperkey+ ,Geocoder.para_language= Just $ T.pack "de"}+ results <- Geocoder.geocodeWith params+ let strResults= map (T.unpack.Geocoder.formatted) results+ mapM_ putStrLn strResults++-- | geocodes a list of Strings and prints the result+testGeocodeAPI1 :: IO ()+testGeocodeAPI1 = do+ let tokens = map T.pack ["Berlin","München","Tokyo","invalid","San Francisco","White House"]+ Geocoder.geocodeGeoTokensList tokens myDeveloperkey++-- * reverse geocoding++-- | gets the address from the coordinates (Vienna University of Technology)+reverseGeocodeTUVienna :: IO ()+reverseGeocodeTUVienna = do+ results<-RevGeocoder.reverseGeocode 48.19637 16.36992 myDeveloperkey+ let formattedResult= map (T.unpack.RevGeocoder.formatted) results+ mapM_ putStrLn formattedResult++-- | a request using RevGeocoder.defaultParams+reverseGeocodeTest1 :: IO (Maybe RevGeocoder.ResponseBody)+reverseGeocodeTest1 = RevGeocoder.getReverseAPIResponseWith revGeocodeParams+ where revGeocodeParams = RevGeocoder.defaultParams {RevGeocoder.para_latitude=(-22.6792)::Double,+ RevGeocoder.para_longitude=(14.5272)::Double,RevGeocoder.para_key=myDeveloperkey}
+ src/RevGeocoder.hs view
@@ -0,0 +1,213 @@+{-# LANGUAGE DeriveGeneric, OverloadedStrings #-}++{-|+Module : RevGeocoder+Description : Module to convert latitude and longitude coordinated into an address.+Copyright : +License : GPL-3+Maintainer : hahn@geoinfo.tuwien.ac.at+Stability : experimental++Requests the <http://geocoder.opencagedata.com> reverse geocoding service to transfer latitude and longitude values into an address.+-}+module RevGeocoder (QueryParameters(..)+ ,defaultParams+ ,GeoCageDeveloperKey+ ,GeoCageLatitude+ ,GeoCageLongitude+ ,reverseGeocode+ ,reverseGeocodeWith+ ,getReverseAPIResponse+ ,getReverseAPIResponseWith+ ,ResponseBody(..)+ ,Result(..)+ ,License(..)+ ,Rate(..)+ ,Status(..)+ ,Timestamp(..)+ ,Components(..)+ ,Location(..)+ ,Annotations (..)) where+ +import HTTPWrapper+import qualified Data.Text as T (Text,unpack)+import GHC.Generics (Generic)+import Data.Aeson hiding (Result) +import Data.ByteString.Char8 as Bs (ByteString) +++-- * request++-- | data type including all possible parameters OpenCage API offers+data QueryParameters = QueryParameters {+ para_latitude::Double, -- ^ latitude value to reverse geocode+ para_longitude::Double, -- ^ longitude value to reverse geocode+ para_key::T.Text, -- ^ OpenCage key+ para_language:: Maybe T.Text, -- ^ language for the result: IETF format language code + para_pretty::Maybe T.Text, -- ^ should the result be pretty printed ?+ para_jsonp:: Maybe T.Text -- ^ should the result be included into a JSON function ?+}deriving (Show,Generic)++-- | minimal example of QueryParameters+-- can be used to create your own parameters+defaultParams :: QueryParameters+defaultParams = RevGeocoder.QueryParameters {+ para_latitude=0+ ,para_longitude=0+ ,para_key=""+ ,para_language=Just "en"+ ,para_pretty=Nothing+ ,para_jsonp=Nothing}+ +type GeoCageDeveloperKey = T.Text+type GeoCageLatitude = Double+type GeoCageLongitude = Double++-- | reverse geocode latitude and longitude, returns a list of Result values+reverseGeocode :: GeoCageLatitude -- ^ latitude value to reverse geocode+ -> GeoCageLongitude -- ^ longitude value to reverse geocode+ -> GeoCageDeveloperKey -- ^ OpenCage key+ -> IO [Result] -- ^ list of results, empty if an error occured+reverseGeocode latt long developerKey = reverseGeocodeWith params + where params = defaultParams {para_latitude=latt, para_longitude=long,para_key=developerKey}++-- | reverse geocode passing all parameters via the QueryParameters type+reverseGeocodeWith :: QueryParameters -- ^ parameters for the request+ -> IO [Result] -- ^ list of results, empty if an error occured+reverseGeocodeWith params = do+ r <- getReverseAPIResponseWith params+ case r of+ Nothing -> return []+ Just a -> return $ results a+ +-- | reverse geocode latitude and longitude, returns the whole Response+getReverseAPIResponse :: GeoCageLatitude -- ^ latitude value to reverse geocode+ -> GeoCageLongitude -- ^ longitude value to reverse geocode+ -> GeoCageDeveloperKey -- ^ OpenCage key+ -> IO (Maybe ResponseBody) -- ^ if successful Just a ResponseBody, otherwise Nothing+getReverseAPIResponse latt long developerKey = getReverseAPIResponseWith params + where params = defaultParams {para_latitude=latt, para_longitude=long,para_key=developerKey}++-- | reverse geocode passing all parameters via the QueryParameters type+getReverseAPIResponseWith :: QueryParameters -- ^ parameters for the request+ -> IO (Maybe ResponseBody) -- ^ if successful Just a ResponseBody, otherwise Nothing+getReverseAPIResponseWith parameters =do+ reqSuccesfull <-requestGeocage parameters+ case reqSuccesfull of+ Left err -> do putStrLn "exception at geoCage request, issue:"+ print err+ return Nothing+ Right response -> case eitherDecodeStrict response of+ Left exception -> do putStrLn+ "exception at ByteString to JSON conversion, issue:"+ print exception+ return Nothing+ Right resultBody -> return $ Just resultBody+ where requestGeocage :: QueryParameters -> IO (Either String ByteString)+ requestGeocage params = download geocageUrl para+ where geocageUrl = "http://api.opencagedata.com/geocode/v1/json?" + para = convertQParamstoOptionsList params+++-- | converts QueryParameters to a list of tupels needed by the HTTPWrapper module+convertQParamstoOptionsList :: QueryParameters -- ^ data type including all request parameters + -> [(String,String)] -- ^ list of tupels containing all request parameters+convertQParamstoOptionsList (QueryParameters para_lat para_long key lang pre jsonp )= [] +++ [("q", show para_lat++","++show para_long),("key",T.unpack key)]+ ++ toParameter "language" lang + ++ toParameter "pretty" pre + ++ toParameter "jsonp" jsonp+ where toParameter :: String -> Maybe T.Text -> [(String,String)]+ toParameter param mValue = case mValue of+ Nothing -> []+ Just val -> [(param,T.unpack val)]++-- * response data types+ +-- | data type respecting OpenCage response encoded as JSON +data ResponseBody = ResponseBody {licenses :: [License],+ rate :: Rate,+ results :: [Result],+ status :: Status,+ thanks :: T.Text,+ timestamp :: Timestamp,+ total_results :: Integer+} deriving (Show,Generic)+instance FromJSON ResponseBody++data License = License { + name :: T.Text, + url :: Url+} deriving (Show, Generic)+instance FromJSON License ++data Rate = Rate {+ limit :: Integer, + remaining::Integer, + reset::Double +} deriving (Show, Generic)+instance FromJSON Rate++data Result = Result { + annotations :: Annotations, + components:: Components, + confidence:: Integer, + formatted:: T.Text , + geometry:: Location+} deriving (Show,Generic)++instance FromJSON Result where+ parseJSON (Object v) = Result <$>+ v .: "annotations" <*>+ v .: "components"<*>+ v .: "confidence"<*>+ (v .:? "formatted" .!= "") <*> + v .: "geometry"+ parseJSON _ = undefined++data Status = Status { + code::Integer, + message::T.Text+} deriving (Show, Generic)+instance FromJSON Status++data Timestamp = Timestamp { + created_http::T.Text, + created_unix:: Integer+} deriving (Show,Generic)+instance FromJSON Timestamp++data Annotations = Annotations { + geohash::T.Text+} deriving (Show, Generic)+instance FromJSON Annotations++type Url = T.Text++data Location = Location { + lat::Double, + lng :: Double+} deriving (Show, Generic)+instance FromJSON Location++data Components = Components { + country :: T.Text, + country_code:: T.Text,+ county:: T.Text,+ state:: T.Text,+ city:: T.Text,+ road :: T.Text,+ clothes :: T.Text+} deriving (Show,Generic)++-- | not all components are included into the response, if so there is an empty string as default value.+instance FromJSON Components where + parseJSON (Object v) = Components <$>+ (v .:? "country" .!= "") <*>+ (v .:? "country_code" .!= "") <*>+ (v .:? "county" .!= "") <*>+ (v .:? "state" .!= "") <*>+ (v .:? "city" .!= "") <*>+ (v .:? "road" .!= "") <*>+ (v .:? "clothes" .!= "")+ parseJSON _ = undefined