aboutsummaryrefslogtreecommitdiff
path: root/client
diff options
context:
space:
mode:
Diffstat (limited to 'client')
-rw-r--r--client/LICENSE27
-rw-r--r--client/Setup.hs2
-rw-r--r--client/shell.nix20
-rw-r--r--client/src/Thermoprint/Client.hs74
-rw-r--r--client/thermoprint-client.cabal32
-rw-r--r--client/thermoprint-client.nix15
6 files changed, 170 insertions, 0 deletions
diff --git a/client/LICENSE b/client/LICENSE
new file mode 100644
index 0000000..4ad71e2
--- /dev/null
+++ b/client/LICENSE
@@ -0,0 +1,27 @@
1Statement of Purpose
2
3The 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").
4
5Certain 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.
6
7For 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.
8
91. 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:
10
11the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
12moral rights retained by the original author(s) and/or performer(s);
13publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
14rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
15rights protecting the extraction, dissemination, use and reuse of data in a Work;
16database 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
17other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
182. 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.
19
203. 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.
21
224. Limitations and Disclaimers.
23
24No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
25Affirmer 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.
26Affirmer 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.
27Affirmer 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. \ No newline at end of file
diff --git a/client/Setup.hs b/client/Setup.hs
new file mode 100644
index 0000000..9a994af
--- /dev/null
+++ b/client/Setup.hs
@@ -0,0 +1,2 @@
1import Distribution.Simple
2main = defaultMain
diff --git a/client/shell.nix b/client/shell.nix
new file mode 100644
index 0000000..1e9307e
--- /dev/null
+++ b/client/shell.nix
@@ -0,0 +1,20 @@
1{ pkgs ? (import <nixpkgs> {})
2, compilerName ? "ghc7102"
3}:
4
5let
6 packages = ps: with ps; [
7 cabal-install hlint cabal2nix
8 hspec QuickCheck quickcheck-instances
9 hspec-contrib temporary
10 ] ++ (builtins.attrValues (import ./default.nix { inherit pkgs; }));
11 ghc = pkgs.haskell.packages.${compilerName}.ghcWithPackages packages;
12in
13pkgs.stdenv.mkDerivation rec {
14 name = "thermoprint-env";
15 buildInputs = [ ghc ];
16 shellHook = ''
17 eval $(egrep ^export ${ghc}/bin/ghc)
18 export PROMPT_INFO="${name}"
19 '';
20}
diff --git a/client/src/Thermoprint/Client.hs b/client/src/Thermoprint/Client.hs
new file mode 100644
index 0000000..8299821
--- /dev/null
+++ b/client/src/Thermoprint/Client.hs
@@ -0,0 +1,74 @@
1{-# LANGUAGE DataKinds #-}
2{-# LANGUAGE TypeOperators #-}
3{-# LANGUAGE ViewPatterns #-}
4{-# LANGUAGE RecordWildCards #-}
5
6-- | A client library for 'Thermoprint.API'
7module Thermoprint.Client
8 ( Client(..)
9 , mkClient
10 -- = Reexports
11 , ServantError(..)
12 , module Servant.Common.BaseUrl
13 , module Control.Monad.Trans.Either
14 , module Servant.Server.Internal.Enter
15 ) where
16
17import Thermoprint.API
18import Data.Map (Map)
19import Data.Sequence (Seq)
20import Data.Time (UTCTime)
21
22import Servant.Client hiding (HasClient(..))
23import qualified Servant.Client as S
24import Servant.Common.BaseUrl
25import Servant.API
26import Servant.Server.Internal.Enter
27import Control.Monad.Trans.Either
28
29import Control.Category
30import Prelude hiding (id, (.))
31
32-- | All 'ThermoprintAPI'-functions as a record
33--
34-- Use like this:
35--
36-- > import Control.Category
37-- > import Prelude hiding (id, (.))
38-- >
39-- > main :: IO ()
40-- > main = do
41-- > Client{..} <- mkClient id $ Http "localhost" 3000
42-- >
43-- > print =<< runEitherT printers -- Display a list of printers with their status
44data Client m = Client
45 { printers :: EitherT ServantError m (Map PrinterId PrinterStatus)
46 -- ^ List all printers
47 , jobs :: Maybe PrinterId
48 -> Maybe JobId
49 -> Maybe JobId
50 -> Maybe UTCTime
51 -> Maybe UTCTime
52 -> EitherT ServantError m (Seq (JobId, UTCTime, JobStatus))
53 -- ^ @jobs p minId maxId minTime maxTime@ lists a selection of jobs
54 , print :: Maybe PrinterId -> Printout -> EitherT ServantError m JobId
55 -- ^ Send a 'Printout' to be queued
56 , jobContents :: JobId -> EitherT ServantError m Printout
57 , jobStatus :: JobId -> EitherT ServantError m JobStatus
58 , jobDelete :: JobId -> EitherT ServantError m ()
59 }
60
61withArg :: (a -> layoutA :<|> layoutB) -> (a -> layoutA) :<|> (a -> layoutB)
62withArg outer = (\(a :<|> _) -> a) . outer :<|> (\(_ :<|> b) -> b) . outer
63
64mkClient :: (IO :~> m) -- ^ A monad functor ('Nat') used to make the api functions work in any monad which can be constructed from 'IO'
65 -> BaseUrl
66 -> Client m
67-- ^ Generate a 'Client'
68mkClient n url = Client{..}
69 where
70 printers
71 :<|> (jobs :<|> print)
72 :<|> (withArg -> jobContents :<|> (withArg -> jobStatus :<|> jobDelete))
73 :<|> _
74 = enter (hoistNat n) $ client thermoprintAPI url
diff --git a/client/thermoprint-client.cabal b/client/thermoprint-client.cabal
new file mode 100644
index 0000000..39e2622
--- /dev/null
+++ b/client/thermoprint-client.cabal
@@ -0,0 +1,32 @@
1-- Initial thermoprint-server.cabal generated by cabal init. For further
2-- documentation, see http://haskell.org/cabal/users-guide/
3
4name: thermoprint-client
5version: 0.0.0
6synopsis: Client for thermoprint-spec
7-- description:
8homepage: http://dirty-haskell.org/tags/thermoprint.html
9license: PublicDomain
10license-file: LICENSE
11author: Gregor Kleen
12maintainer: aethoago@141.li
13-- copyright:
14category: Web
15build-type: Simple
16-- extra-source-files:
17cabal-version: >=1.10
18
19library
20 exposed-modules: Thermoprint.Client
21 -- other-modules:
22 -- other-extensions:
23 build-depends: base >=4.8 && <5
24 , thermoprint-spec ==3.0.*
25 , servant >=0.4.4 && <1
26 , servant-client >=0.4.4 && <1
27 , servant-server >=0.4.4 && <1
28 , containers >=0.5.6 && <1
29 , either >=4.4.1 && <5
30 , time >=1.5.0 && <2
31 hs-source-dirs: src
32 default-language: Haskell2010
diff --git a/client/thermoprint-client.nix b/client/thermoprint-client.nix
new file mode 100644
index 0000000..e424403
--- /dev/null
+++ b/client/thermoprint-client.nix
@@ -0,0 +1,15 @@
1{ mkDerivation, base, containers, either, servant, servant-client
2, servant-server, stdenv, thermoprint-spec
3}:
4mkDerivation {
5 pname = "thermoprint-client";
6 version = "0.0.0";
7 src = ./.;
8 libraryHaskellDepends = [
9 base containers either servant servant-client servant-server
10 thermoprint-spec
11 ];
12 homepage = "http://dirty-haskell.org/tags/thermoprint.html";
13 description = "Client for thermoprint-spec";
14 license = stdenv.lib.licenses.publicDomain;
15}