diff --git a/AUTHORS b/AUTHORS new file mode 100644 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +The Freepost community . Specifically, the following people: + +fr33domlover diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/ChangeLog b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,6 @@ +If you have a local clone of the repository, you can see a detailed list of +changes using: + + $ git log + +There is also a web interface in NotABug which can display commit history. diff --git a/INSTALL b/INSTALL new file mode 100644 --- /dev/null +++ b/INSTALL @@ -0,0 +1,13 @@ +Install from Hackage: + + $ cabal install funbot-client + +Install from unpacked release tarball or source repo: + + $ cd funbot-client + $ cabal install + +Just play with it without installing: + + $ cabal build + $ cabal repl diff --git a/NEWS b/NEWS new file mode 100644 --- /dev/null +++ b/NEWS @@ -0,0 +1,23 @@ +This file lists the user-visible interesting changes between releases. For a +full list of changes to the source, see the ChangeLog. + + + +funbot-client 0.1.0.0 -- 2015-09-19 +=================================== + +General, build and documentation changes: + +* (This is the first release, so everything is new) + +New APIs, features and enhancements: + +* (This is the first release, so everything is a new feature) + +Bug fixes: + +* (This is just the first release, many bugs haven't been discovered yet) + +Dependency changes: + +* (This is the first release) diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# funbot-client + +This is a Haskell library for reporting events to a running instance of +[FunBot][funbot], so that the bot can announce the event to IRC. For example, +if you are writing a paste server, you can add support for IRC announcments of +new pastes by reporting the paste to a running bot. + +[funbot]: https://notabug.org/fr33domlover/funbot.git + +See the .cabal file for more info and link to project website and version +control. + +The official download location is the Git repository: + + + +Occasionally, releases may be made to Hackage, the Haskell package repository. +See . + +This software is free software, and is committed to software freedom. It is +released to the public domain using the CC0 Public Domain Dedication. For the +boring "legal" details see the file `COPYING`. + +See the file `INSTALL` for hints on installation. The file `ChangeLog` explains +how to see the history log of the changes done in the code. `NEWS` provides a +friendly overview of the changes for each release. + +## Bug and Patches + +See [here](https://notabug.org/fr33domlover/funbot#reporting-bugs-and-suggesting-features). diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/funbot-client.cabal b/funbot-client.cabal new file mode 100644 --- /dev/null +++ b/funbot-client.cabal @@ -0,0 +1,39 @@ +name: funbot-client +version: 0.1.0.0 +synopsis: Report events to FunBot over a JSON/HTTP API. +description: + This is a library for reporting events to a running instance of + , so that the bot can + announce the event to IRC. For example, if you are writing a paste server, + you can add support for IRC announcments of new pastes by reporting the paste + to a running bot. +homepage: https://notabug.org/fr33domlover/funbot-client/ +bug-reports: https://notabug.org/fr33domlover/funbot-client/issues/ +license: PublicDomain +license-file: COPYING +author: fr33domlover +maintainer: fr33domlover@riseup.net +copyright: ♡ Copying is an act of love. Please copy, reuse and share. +category: Network, Web +build-type: Simple +extra-source-files: AUTHORS ChangeLog COPYING INSTALL NEWS README.md +cabal-version: >=1.10 + +source-repository head + type: git + location: https://notabug.org/fr33domlover/funbot-client.git + +library + exposed-modules: FunBot.Client + -- other-modules: + -- other-extensions: + build-depends: aeson + , aeson-pretty >=0.7 + , base >=4.7 && <5 + , bytestring + , funbot-ext-events + , HTTP >=4000.2 + , network-uri + hs-source-dirs: src + default-language: Haskell2010 + ghc-options: -Wall diff --git a/src/FunBot/Client.hs b/src/FunBot/Client.hs new file mode 100644 --- /dev/null +++ b/src/FunBot/Client.hs @@ -0,0 +1,101 @@ +{- This file is part of funbot-client. + - + - Written in 2015 by fr33domlover . + - + - ♡ Copying is an act of love. Please copy, reuse and share. + - + - The author(s) have dedicated all copyright and related and neighboring + - rights to this software to the public domain worldwide. This software is + - distributed without any warranty. + - + - You should have received a copy of the CC0 Public Domain Dedication along + - with this software. If not, see + - . + -} + +-- | Using this module, you can send external events (such as git commits) to a +-- running FunBot instance over HTTP. +-- +-- Constructing events requires using types from the @funbot-ext-events@ +-- package. But you should not use the @ExtEvent@ constructors from there, +-- because if they change, it will break your code. Instead, use the functions +-- provided below. This way new events can be added without breaking old code. +module FunBot.Client + ( Bot () + , ExtEvent () + , mkBot + , sendExtEvent + , mkPushEvent + , mkTagEvent + , mkMergeRequestEvent + , mkNewsEvent + , mkPasteEvent + ) +where + +import Data.Aeson (encode) +import Data.Aeson.Encode.Pretty (encodePretty) +import FunBot.ExtEvents +import Network.HTTP +import Network.Stream (ConnError) +import Network.URI (URI) + +import qualified Data.ByteString.Lazy as B + +-- | Reference to running FunBot instance to which you can send events. +newtype Bot = Bot + { botMkRequest :: ExtEvent -> Request B.ByteString + } + +-- | Create a reference to a FunBot instance. +-- +-- You can parse the URL at runtime using 'Network.URI.parseURI' or at compile +-- time using 'Network.URI.Static.staticURI' (or the @uri@ quasi quoter in the +-- same package). +mkBot :: URI -- ^ URL at which the bot listens to client events. + -> Bool -- ^ Whether JSON data should be sent in pretty form, i.e. + -- indented. This may be useful for debugging, but otherwise you + -- should probably pass 'False' here. + -> Bot +mkBot uri pretty = + let f event = + let body = if pretty then encodePretty event else encode event + in Request + { rqURI = uri + , rqBody = body + , rqHeaders = + [ Header HdrContentType "application/json" + , Header HdrContentLength (show $ B.length body) + ] + , rqMethod = POST + } + in Bot f + +-- | Send an event to a bot over HTTP. If successfully sent, return 'Nothing'. +-- If an error occurs, return 'Just' the error details. +sendExtEvent :: Bot -> ExtEvent -> IO (Maybe ConnError) +sendExtEvent bot event = do + result <- simpleHTTP $ botMkRequest bot event + case result of + Left err -> return $ Just err + Right _ -> return Nothing + +-- | Construct a git push event. +mkPushEvent :: Push -> ExtEvent +mkPushEvent = GitPushEvent + +-- | Construct a git tag event. +mkTagEvent :: Tag -> ExtEvent +mkTagEvent = GitTagEvent + +-- | Construct a merge request event. +mkMergeRequestEvent :: MergeRequest -> ExtEvent +mkMergeRequestEvent = MergeRequestEvent + +-- | Construct a news item event. +mkNewsEvent :: NewsItem -> ExtEvent +mkNewsEvent = NewsEvent + +-- | Construct a paste event. +mkPasteEvent :: Paste -> ExtEvent +mkPasteEvent = PasteEvent