From 83a25504d7f2f9d5856365bc6470f272146ff831 Mon Sep 17 00:00:00 2001 From: David Mosbach Date: Mon, 18 Dec 2023 05:51:51 +0100 Subject: [PATCH] init --- .gitignore | 2 ++ CHANGELOG.md | 11 ++++++ LICENSE | 30 ++++++++++++++++ README.md | 1 + Setup.hs | 2 ++ app/Main.hs | 8 +++++ oauth2-mock-server.cabal | 77 ++++++++++++++++++++++++++++++++++++++++ package.yaml | 64 +++++++++++++++++++++++++++++++++ src/Server.hs | 40 +++++++++++++++++++++ src/User.hs | 20 +++++++++++ stack.yaml | 67 ++++++++++++++++++++++++++++++++++ stack.yaml.lock | 13 +++++++ test/Spec.hs | 2 ++ 13 files changed, 337 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 Setup.hs create mode 100644 app/Main.hs create mode 100644 oauth2-mock-server.cabal create mode 100644 package.yaml create mode 100644 src/Server.hs create mode 100644 src/User.hs create mode 100644 stack.yaml create mode 100644 stack.yaml.lock create mode 100644 test/Spec.hs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c368d45 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.stack-work/ +*~ \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..09c09e6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog for `oauth2-mock-server` + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to the +[Haskell Package Versioning Policy](https://pvp.haskell.org/). + +## Unreleased + +## 0.1.0.0 - YYYY-MM-DD diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c5b6c16 --- /dev/null +++ b/LICENSE @@ -0,0 +1,30 @@ +Copyright Author name here (c) 2023 + +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 Author name here 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e9d1f06 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# oauth2-mock-server diff --git a/Setup.hs b/Setup.hs new file mode 100644 index 0000000..9a994af --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 index 0000000..ef8bfe5 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,8 @@ +module Main (main) where + +import Server + +import Network.Wai.Handler.Warp + +main :: IO () +main = putStrLn "Try: http://localhost:8080/query?userID=1" >> run 8080 insecureOAuthMock diff --git a/oauth2-mock-server.cabal b/oauth2-mock-server.cabal new file mode 100644 index 0000000..1324f22 --- /dev/null +++ b/oauth2-mock-server.cabal @@ -0,0 +1,77 @@ +cabal-version: 2.2 + +-- This file has been generated from package.yaml by hpack version 0.35.2. +-- +-- see: https://github.com/sol/hpack + +name: oauth2-mock-server +version: 0.1.0.0 +description: Please see the README +author: David Mosbach +maintainer: david.mosbach@uniworx.de +copyright: 2023 David Mosbach +license: BSD-3-Clause +license-file: LICENSE +build-type: Simple +extra-source-files: + README.md + CHANGELOG.md + +library + exposed-modules: + Server + User + other-modules: + Paths_oauth2_mock_server + autogen-modules: + Paths_oauth2_mock_server + hs-source-dirs: + src + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints + build-depends: + aeson + , base >=4.7 && <5 + , servant + , servant-server + , text + , warp + default-language: Haskell2010 + +executable oauth2-mock-server-exe + main-is: Main.hs + other-modules: + Paths_oauth2_mock_server + autogen-modules: + Paths_oauth2_mock_server + hs-source-dirs: + app + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + aeson + , base >=4.7 && <5 + , oauth2-mock-server + , servant + , servant-server + , text + , warp + default-language: Haskell2010 + +test-suite oauth2-mock-server-test + type: exitcode-stdio-1.0 + main-is: Spec.hs + other-modules: + Paths_oauth2_mock_server + autogen-modules: + Paths_oauth2_mock_server + hs-source-dirs: + test + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + aeson + , base >=4.7 && <5 + , oauth2-mock-server + , servant + , servant-server + , text + , warp + default-language: Haskell2010 diff --git a/package.yaml b/package.yaml new file mode 100644 index 0000000..96682cd --- /dev/null +++ b/package.yaml @@ -0,0 +1,64 @@ +name: oauth2-mock-server +version: 0.1.0.0 +# github: "githubuser/oauth2-mock-server" +license: BSD-3-Clause +author: "David Mosbach" +maintainer: "david.mosbach@uniworx.de" +copyright: "2023 David Mosbach" + +extra-source-files: +- README.md +- CHANGELOG.md + +# Metadata used when publishing your package +# synopsis: Short description of your package +# category: Web + +# To avoid duplicated efforts in documentation and dealing with the +# complications of embedding Haddock markup inside cabal files, it is +# common to point users to the README.md file. +description: Please see the README # on GitHub at + +dependencies: +- base >= 4.7 && < 5 +- servant +- servant-server +- warp +- aeson +- text + +ghc-options: +- -Wall +- -Wcompat +- -Widentities +- -Wincomplete-record-updates +- -Wincomplete-uni-patterns +- -Wmissing-export-lists +- -Wmissing-home-modules +- -Wpartial-fields +- -Wredundant-constraints + +library: + source-dirs: src + +executables: + oauth2-mock-server-exe: + main: Main.hs + source-dirs: app + ghc-options: + - -threaded + - -rtsopts + - -with-rtsopts=-N + dependencies: + - oauth2-mock-server + +tests: + oauth2-mock-server-test: + main: Spec.hs + source-dirs: test + ghc-options: + - -threaded + - -rtsopts + - -with-rtsopts=-N + dependencies: + - oauth2-mock-server diff --git a/src/Server.hs b/src/Server.hs new file mode 100644 index 0000000..fd516c7 --- /dev/null +++ b/src/Server.hs @@ -0,0 +1,40 @@ +{-# LANGUAGE DataKinds, TypeOperators, OverloadedStrings #-} + +module Server +( insecureOAuthMock +) where + +import User + +import Control.Monad.IO.Class + +import Data.Aeson +import Data.List +import Data.Maybe +import Data.Text hiding (find) + + +import Servant +import Servant.API + +testUsers :: [User] +testUsers = + [ User {name = "TestName", email = "foo@bar.com", uID = "1"}] + + +type Query = "query" :> QueryParam "userID" Text :> Get '[JSON] (Maybe User) +type Insert = "insert" :> Post '[JSON] User + +queryServer :: Server Query +queryServer = handleQuery + where + handleQuery :: Maybe Text -> Handler (Maybe User) + handleQuery Nothing = liftIO (putStrLn "no query param given") >> return Nothing + handleQuery (Just x) = liftIO (putStrLn $ "query param: " ++ show x) >> (return $ find (\u -> uID u == x) testUsers) + +queryAPI :: Proxy Query +queryAPI = Proxy + +insecureOAuthMock :: Application +insecureOAuthMock = queryAPI `serve` queryServer + \ No newline at end of file diff --git a/src/User.hs b/src/User.hs new file mode 100644 index 0000000..ed91672 --- /dev/null +++ b/src/User.hs @@ -0,0 +1,20 @@ +{-# LANGUAGE DeriveGeneric #-} + +module User +( + User (..) +) where + +import Data.Aeson +import Data.Text + +import GHC.Generics + + +data User = User + { name :: Text + , email :: Text + , uID :: Text + } deriving (Eq, Show, Generic) + +instance ToJSON User diff --git a/stack.yaml b/stack.yaml new file mode 100644 index 0000000..ec5fd64 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,67 @@ +# This file was automatically generated by 'stack init' +# +# Some commonly used options have been documented as comments in this file. +# For advanced use and comprehensive documentation of the format, please see: +# https://docs.haskellstack.org/en/stable/yaml_configuration/ + +# Resolver to choose a 'specific' stackage snapshot or a compiler version. +# A snapshot resolver dictates the compiler version and the set of packages +# to be used for project dependencies. For example: +# +# resolver: lts-3.5 +# resolver: nightly-2015-09-21 +# resolver: ghc-7.10.2 +# +# The location of a snapshot can be provided as a file or url. Stack assumes +# a snapshot provided as a file might change, whereas a url resource does not. +# +# resolver: ./custom-snapshot.yaml +# resolver: https://example.com/snapshots/2018-01-01.yaml +resolver: + url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/0.yaml + +# User packages to be built. +# Various formats can be used as shown in the example below. +# +# packages: +# - some-directory +# - https://example.com/foo/bar/baz-0.0.2.tar.gz +# subdirs: +# - auto-update +# - wai +packages: +- . +# Dependency packages to be pulled from upstream that are not in the resolver. +# These entries can reference officially published versions as well as +# forks / in-progress versions pinned to a git hash. For example: +# +# extra-deps: +# - acme-missiles-0.3 +# - git: https://github.com/commercialhaskell/stack.git +# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a +# +# extra-deps: [] + +# Override default flag values for local packages and extra-deps +# flags: {} + +# Extra package databases containing global packages +# extra-package-dbs: [] + +# Control whether we use the GHC we find on the path +system-ghc: true +# +# Require a specific version of Stack, using version ranges +# require-stack-version: -any # Default +# require-stack-version: ">=2.11" +# +# Override the architecture used by Stack, especially useful on Windows +# arch: i386 +arch: x86_64 +# +# Extra directories used by Stack for building +# extra-include-dirs: [/path/to/dir] +# extra-lib-dirs: [/path/to/dir] +# +# Allow a newer minor version of GHC than the snapshot specifies +# compiler-check: newer-minor diff --git a/stack.yaml.lock b/stack.yaml.lock new file mode 100644 index 0000000..a39a124 --- /dev/null +++ b/stack.yaml.lock @@ -0,0 +1,13 @@ +# This file was autogenerated by Stack. +# You should not edit this file by hand. +# For more information, please see the documentation at: +# https://docs.haskellstack.org/en/stable/lock_files + +packages: [] +snapshots: +- completed: + sha256: e176944bc843f740e05242fa7a66ca1f440c127e425254f7f1257f9b19add23f + size: 712153 + url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/0.yaml + original: + url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/0.yaml diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 index 0000000..cd4753f --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,2 @@ +main :: IO () +main = putStrLn "Test suite not yet implemented"