wip

- Closes #28

backend/ChangeLog.md

@@ -0,0 +1,5 @@
+# Revision history for backend
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

backend/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2018, Mats Rauhala
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Mats Rauhala nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

backend/Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

backend/backend.cabal

@@ -1,4 +1,7 @@
-name:                ebook-manager
+-- Initial backend.cabal generated by cabal init.  For further
+-- documentation, see http://haskell.org/cabal/users-guide/
+
+name:                backend
 version:             0.1.0.0
 -- synopsis:
 -- description:
@@ -12,30 +15,29 @@ build-type:          Simple
 extra-source-files:  ChangeLog.md
 cabal-version:       >=1.10
 
-executable ebook-manager
+executable backend
   main-is:             Main.hs
   other-modules:       Devel.Main
-                     , API
-                     , API.Books
-                     , API.Catalogue
-                     , API.Channels
-                     , API.Users
-                     , Configuration
-                     , Data.Versioned
                      , Database
                      , Database.Book
                      , Database.Channel
-                     , Database.Tag
                      , Database.Schema
+                     , Database.Tag
                      , Database.User
                      , Datastore
                      , Servant.XML
                      , Server
+                     , Server.API
+                     , Server.API.Books
+                     , Server.API.Catalogue
+                     , Server.API.Channels
+                     , Server.API.Users
                      , Server.Auth
                      , Types
                      , View
   -- other-extensions:
   build-depends:       base >=4.10 && <4.11
+                     , common
                      , aeson
                      , asn1-data
                      , asn1-types
@@ -77,8 +79,8 @@ executable ebook-manager
                      , xml-conduit
                      , xml-hamlet
   hs-source-dirs:      src
+  default-language:    Haskell2010
   default-extensions:  DeriveGeneric
                      , NoImplicitPrelude
                      , OverloadedStrings
                      , RecordWildCards
-  default-language:    Haskell2010

backend/src/Database/Schema.hs

@@ -18,9 +18,6 @@ newtype PlainPassword = PlainPassword Text deriving (Show, ToJSON, FromJSON, ToH
 newtype HashedPassword = HashedPassword {unHashed :: ByteString}
 data NoPassword = NoPassword
 
-newtype Email = Email { unEmail :: Text } deriving (Show, ToJSON, FromJSON, ToHttpApiData, FromHttpApiData)
-
-newtype Username = Username { unUsername :: Text } deriving (Show, ToJSON, FromJSON, ToHttpApiData, FromHttpApiData)
 
 instance SqlType HashedPassword where
   mkLit = LCustom . LBlob . unHashed

backend/src/Devel/Main.hs

@@ -37,7 +37,7 @@ update = do
 
 develMain :: IO ()
 develMain = do
-  conf <- input auto "./config/devel.dhall"
+  conf <- input auto "../config/devel.dhall"
   withApp conf $ \app -> do
     void $ runReaderT (runDB migrate) app
     defaultMain app

backend/src/Server.hs

@@ -12,7 +12,7 @@
 {-# Language TypeApplications #-}
 module Server where
 
-import qualified API as API
+import qualified Server.API as API
 import Server.Auth (authCheck)
 import Servant
 import Types

backend/src/Server/API.hs

@@ -9,7 +9,7 @@
 {-# Language RecordWildCards #-}
 {-# Language DeriveGeneric #-}
 {-# Language FlexibleInstances #-}
-module API (API, handler) where
+module Server.API (API, handler) where
 
 
 import Servant
@@ -18,10 +18,10 @@ import Types
 
 import View
 
-import qualified API.Users as Users
+import qualified Server.API.Users as Users
-import qualified API.Channels as Channels
+import qualified Server.API.Channels as Channels
-import qualified API.Books as Books
+import qualified Server.API.Books as Books
-import qualified API.Catalogue as Catalogue
+import qualified Server.API.Catalogue as Catalogue
 
 data Index = Index
 

backend/src/Server/API/Books.hs

@@ -13,7 +13,7 @@
 {-# Language TypeApplications #-}
 {-# Language DataKinds #-}
 {-# Language NamedFieldPuns #-}
-module API.Books where
+module Server.API.Books where
 
 import Servant hiding (contentType)
 import Types

backend/src/Server/API/Catalogue.hs

@@ -14,7 +14,7 @@
 {-# Language TemplateHaskell #-}
 {-# Language MultiParamTypeClasses #-}
 {-# Language ScopedTypeVariables #-}
-module API.Catalogue (VersionedAPI, handler) where
+module Server.API.Catalogue (VersionedAPI, handler) where
 
 import Types
 import Servant hiding (contentType)
@@ -26,7 +26,7 @@ import Servant.XML
 import qualified Database.Channel as Channel
 import Database.Book (Book(..))
 import Database
-import qualified API.Books
+import qualified Server.API.Books as API.Books
 
 -- This is my first try on going to versioned apis, things might change
 -- I think my rule of thumb is that you can add new things as you want, but

backend/src/Server/API/Channels.hs

@@ -13,7 +13,7 @@
 {-# Language DataKinds #-}
 {-# Language DuplicateRecordFields #-}
 {-# Language NamedFieldPuns #-}
-module API.Channels (API, handler, JsonChannel(..)) where
+module Server.API.Channels (API, handler, JsonChannel(..)) where
 
 import Servant
 import Types

backend/src/Server/API/Users.hs

@@ -5,7 +5,7 @@
 {-# Language TypeOperators #-}
 {-# Language DuplicateRecordFields #-}
 {-# Language TypeApplications #-}
-module API.Users  where
+module Server.API.Users  where
 
 import Servant
 import ClassyPrelude

backend/src/Server/Auth.hs

@@ -24,21 +24,8 @@ import Control.Lens (view)
 import Data.Generics.Product
 import Servant (err401)
 import Control.Monad.Logger
+import Auth (SafeUser(..))
 
--- generic-lens can convert similar types to this
--- I'm trying out servant-auth-server which uses a jwt style login. IIRC anyone
--- can open the jwt token and view what's inside, you just can't modify it.
---
--- Is it a problem that a human readable username and email are visible?
-data SafeUser = SafeUser { email :: Email
-                         , username :: Username
-                         , role :: Role }
-              deriving (Show, Generic)
-
-instance ToJSON SafeUser where
-instance FromJSON SafeUser where
-instance ToJWT SafeUser where
-instance FromJWT SafeUser where
 
 type instance BasicAuthCfg = BasicAuthData -> IO (AuthResult SafeUser)
 

common/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2018, Mats Rauhala
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Mats Rauhala nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

common/common.cabal

@@ -0,0 +1,48 @@
+name:                common
+version:             0.1.0.0
+-- synopsis:
+-- description:
+license:             BSD3
+license-file:        LICENSE
+author:              Mats Rauhala
+maintainer:          mats.rauhala@iki.fi
+-- copyright:
+category:            Web
+build-type:          Simple
+extra-source-files:  ChangeLog.md
+cabal-version:       >=1.10
+
+library
+  exposed-modules:     Configuration
+                     , Data.Versioned
+                     , API
+                     , API.Books
+                     , API.Catalogue
+                     , API.Channels
+                     , API.Users
+                     , Auth
+  -- other-extensions:
+  build-depends:       base >=4.10 && <4.11
+                     , aeson
+                     , classy-prelude
+                     , dhall
+                     , foreign-store
+                     , generic-lens
+                     , lens
+                     , mtl
+                     , servant
+                     , servant-auth
+                     , servant-auth-server
+                     , servant-docs
+                     , servant-lucid
+                     , servant-multipart
+                     , text
+                     , transformers
+  hs-source-dirs:      src
+  default-extensions:  DeriveGeneric
+                     , NoImplicitPrelude
+                     , OverloadedStrings
+                     , RecordWildCards
+                     , TypeOperators
+                     , DataKinds
+  default-language:    Haskell2010

common/src/API.hs

@@ -0,0 +1 @@
+module API where

common/src/API/Books.hs

@@ -0,0 +1 @@
+module API.Books where

common/src/API/Catalogue.hs

@@ -0,0 +1 @@
+module API.Catalogue where

common/src/API/Channels.hs

@@ -0,0 +1,27 @@
+{-# Language DuplicateRecordFields #-}
+module API.Channels (API) where
+
+import Auth
+import ClassyPrelude
+import Data.Aeson
+import Servant.API
+import Servant.Auth as SA
+
+data JsonChannel = JsonChannel { channel :: Text
+                               , visibility :: Visibility }
+                 deriving (Show, Generic)
+data UpdateChannel = UpdateChannel { identifier :: ChannelID
+                                   , channel :: Text
+                                   , visibility :: Visibility }
+                 deriving (Show, Generic)
+
+instance ToJSON JsonChannel
+instance FromJSON JsonChannel
+instance ToJSON UpdateChannel
+instance FromJSON UpdateChannel
+
+type API = Auth '[SA.BasicAuth, SA.Cookie, SA.JWT] SafeUser :> BaseAPI
+
+type BaseAPI = "channels" :> ReqBody '[JSON] JsonChannel :> Post '[JSON] UpdateChannel
+          :<|> "channels" :> Capture "channel_id" ChannelID :> ReqBody '[JSON] UpdateChannel :> Put '[JSON] UpdateChannel
+          :<|> "channels" :> Get '[JSON] [JsonChannel]

common/src/API/Users.hs

@@ -0,0 +1 @@
+module API.Users where

common/src/Auth.hs

@@ -0,0 +1,26 @@
+{-# Language GeneralizedNewtypeDeriving #-}
+module Auth where
+
+import ClassyPrelude
+import Data.Aeson
+import Servant.Auth.Server (ToJWT, FromJWT)
+import Servant.API
+
+-- generic-lens can convert similar types to this
+-- I'm trying out servant-auth-server which uses a jwt style login. IIRC anyone
+-- can open the jwt token and view what's inside, you just can't modify it.
+--
+-- Is it a problem that a human readable username and email are visible?
+newtype Email = Email { unEmail :: Text } deriving (Show, ToJSON, FromJSON, ToHttpApiData, FromHttpApiData)
+
+newtype Username = Username { unUsername :: Text } deriving (Show, ToJSON, FromJSON, ToHttpApiData, FromHttpApiData)
+
+data SafeUser = SafeUser { email :: Email
+                         , username :: Username
+                         }
+              deriving (Show, Generic)
+
+instance ToJSON SafeUser where
+instance FromJSON SafeUser where
+instance ToJWT SafeUser where
+instance FromJWT SafeUser where

default.nix

@@ -1,10 +1,12 @@
-{ mkDerivation, base, stdenv }:
+{ nixpkgs, haskellPackages }:
-mkDerivation {
+
-  pname = "ebook-manager";
+(import ./project.nix nixpkgs) {
-  version = "0.1.0.0";
+  packages = {
-  src = ./.;
+    common = ./common;
-  isLibrary = false;
+    backend = ./backend;
-  isExecutable = true;
+  };
-  executableHaskellDepends = [ base ];
+  tools = with haskellPackages; [
-  license = stdenv.lib.licenses.bsd3;
+    ghcid
+    hasktags
+  ];
 }

project.nix

@@ -0,0 +1,38 @@
+nixpkgs:
+
+let
+
+  inherit (nixpkgs.lib) mapAttrs mapAttrsToList escapeShellArg optionalString concatStringsSep concatMapStringsSep;
+
+in
+
+{ packages
+, overrides ? _ : _ : {}
+, tools ? []
+}:
+
+let
+
+  overrides' = nixpkgs.lib.foldr nixpkgs.lib.composeExtensions (_: _: {}) [
+    (self: super: mapAttrs (name: path: self.callCabal2nix name path {}) packages)
+  ];
+  haskellPackages = nixpkgs.haskellPackages.override { overrides = overrides'; };
+  packages' = mapAttrs (name: _: haskellPackages."${name}") packages;
+  mkShell = name: pkg:
+  let
+    n =  "${name}-shell";
+    deps = haskellPackages.ghcWithPackages (pkgs: pkg.buildInputs);
+  in
+  {
+    name = "${n}";
+    value = nixpkgs.buildEnv {
+      name = "${n}";
+      paths = tools ++ [deps];
+      buildInputs = tools ++ [deps];
+    };
+  };
+  shells = nixpkgs.lib.listToAttrs (mapAttrsToList mkShell packages');
+
+in
+
+packages' // shells

release.nix

@@ -0,0 +1,15 @@
+{ nixpkgs ? import <nixpkgs> {} }:
+
+let
+
+  pinnedVersion = nixpkgs.lib.importJSON ./nixpkgs-version.json;
+  pinnedPkgs = import (nixpkgs.fetchFromGitHub {
+    owner = "NixOS";
+    repo = "nixpkgs";
+    inherit (pinnedVersion) rev sha256;
+  }) {};
+  inherit (pinnedPkgs) pkgs;
+
+  in
+
+import ./default.nix { nixpkgs = pinnedPkgs; haskellPackages = pinnedPkgs.haskellPackages; }