versioning-servant (empty) → 0.1.0.0
raw patch · 7 files changed
+473/−0 lines, 7 filesdep +aesondep +attoparsecdep +basesetup-changed
Dependencies added: aeson, attoparsec, base, bytestring, hspec, hspec-wai, http-media, servant, servant-server, versioning, versioning-servant, wai, wai-extra
Files
- ChangeLog.md +5/−0
- LICENSE +202/−0
- Setup.hs +2/−0
- src/Versioning/Servant.hs +91/−0
- tests/Main.hs +26/−0
- tests/Tests/Versioning/Servant/Fixtures.hs +100/−0
- versioning-servant.cabal +47/−0
+ ChangeLog.md view
@@ -0,0 +1,5 @@+# Revision history++## 0.1.0.0++- First version
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ src/Versioning/Servant.hs view
@@ -0,0 +1,91 @@+{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE KindSignatures #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications #-}+{-# LANGUAGE UndecidableInstances #-}+module Versioning.Servant+ ( VersionedJSON+ , VersionedJSONFrom+ )+where++import Data.Aeson (FromJSON, ToJSON, encode,+ parseJSON)+import Data.Aeson.Parser (value)+import Data.Aeson.Types (parseEither)+import Data.Attoparsec.ByteString.Char8 (endOfInput, parseOnly,+ skipSpace, (<?>))+import qualified Data.ByteString.Lazy as LazyBS+import Data.Kind (Type)+import qualified Data.List.NonEmpty as NonEmpty+import Data.Typeable (Typeable)+import qualified Network.HTTP.Media as Media+import Servant.API (Accept (..), MimeRender (..),+ MimeUnrender (..))++import Versioning.Base+import Versioning.Internal.Decoding+import Versioning.JSON++-- | Drop-in replacement for the 'JSON' data-type+-- for seamless integration with servant.+type VersionedJSON = VersionedJSONFrom V0++-- | Like 'VersionedJSON', with an additional type-parameter+-- indicating the oldest version you want to be able to decode+data VersionedJSONFrom (v :: V) deriving Typeable++instance Accept (VersionedJSONFrom from) where+ contentTypes _ =+ "application" Media.// "json" Media./: ("charset", "utf-8") NonEmpty.:|+ [ "application" Media.// "json" ]++-- We add a redundant 'JsonDecodableTo' constraint to minimize the risk+-- of using the 'VersionedJSON' type in the wrong place+instance {-# OVERLAPPABLE #-} (JsonDecodableToFrom from v a, ToJSON (a v))+ => MimeRender (VersionedJSONFrom from) (a v) where+ mimeRender _ = encode++instance JsonDecodableToFrom from v a => MimeUnrender (VersionedJSONFrom from) (a v) where+ mimeUnrender _ = fromJsonAnyVersionLenientFrom @from++-- | Like 'fromJsonAnyVersionEither', but it uses 'eitherDecodeLenient' for decoding+fromJsonAnyVersionLenientFrom+ :: forall from v a+ . JsonDecodableToFrom from v a+ => LazyBS.ByteString+ -> Either String (a v)+fromJsonAnyVersionLenientFrom = decodeAnyVersionFrom @from jsonDecodeLenient++-- | Lenient JSON decoder+jsonDecodeLenient+ :: Decoder FromJSON LazyBS.ByteString (Either String) (a :: V -> Type)+jsonDecodeLenient = Decoder eitherDecodeLenient++-- Copied and pasted from Servant.API.ContentTypes:++-- | Like 'Data.Aeson.eitherDecode' but allows all JSON values instead of just+-- objects and arrays.+--+-- Will handle trailing whitespace, but not trailing junk. ie.+--+-- >>> eitherDecodeLenient "1 " :: Either String Int+-- Right 1+--+-- >>> eitherDecodeLenient "1 junk" :: Either String Int+-- Left "trailing junk after valid JSON: endOfInput"+eitherDecodeLenient :: FromJSON a => LazyBS.ByteString -> Either String a+eitherDecodeLenient input = parseOnly parser (LazyBS.toStrict input)+ >>= parseEither parseJSON+ where+ parser =+ skipSpace+ *> value+ <* skipSpace+ <* (endOfInput <?> "trailing junk after valid JSON")
+ tests/Main.hs view
@@ -0,0 +1,26 @@+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE TypeApplications #-}+module Main where++import Data.Aeson+import Data.Maybe (fromJust)+import Network.Wai.Test (SResponse (simpleBody))+import Test.Hspec+import Test.Hspec.Wai++import Tests.Versioning.Servant.Fixtures+import Versioning.Base++main :: IO ()+main = hspec $ with (pure app) $ do+ let headers = [("Content-Type", "application/json")]+ decodeV2 = fromJust . decode @(Foo V2)++ describe "VersionedJSON" $ do+ it "given the latest version returns latest version" $ do+ res <- request "POST" "foo" headers fooJsonV2+ liftIO $ decodeV2 (simpleBody res) `shouldBe` decodeV2 fooJsonV2++ it "given a previous version returns latest version" $ do+ res <- request "POST" "foo" headers fooJsonV0+ liftIO $ decodeV2 (simpleBody res) `shouldBe` decodeV2 fooJsonV2
+ tests/Tests/Versioning/Servant/Fixtures.hs view
@@ -0,0 +1,100 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE KindSignatures #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE StandaloneDeriving #-}+{-# LANGUAGE TypeApplications #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE TypeOperators #-}+{-# LANGUAGE TypeSynonymInstances #-}+{-# LANGUAGE UndecidableInstances #-}+module Tests.Versioning.Servant.Fixtures where++import Data.Aeson+import qualified Data.ByteString.Lazy as LazyBS+import GHC.Generics (Generic)+import Network.Wai (Application)+import Servant++import Versioning.Base+import Versioning.JSON+import Versioning.Servant (VersionedJSON)+import Versioning.Upgrade++type Api = "foo" :> ReqBody '[VersionedJSON] (Foo V2) :> Post '[JSON] (Foo V2)++server :: Server Api+server = pure++app :: Application+app = serve (Proxy :: Proxy Api) server++data Foo v = Foo+ { always :: Int -- this field exists in all versions+ , sinceV1 :: Since V1 v Bool -- this field has been introduced in V1+ , sinceV2 :: Since V2 v String -- this field has been introduced in V2+ , untilV1 :: Until V1 v Double -- this field has been removed in V2+ } deriving (Generic)++deriving instance Eq (Foo V0)++deriving instance Eq (Foo V1)++deriving instance Eq (Foo V2)++instance FromJSON (Foo V0)++instance FromJSON (Foo V1)++instance FromJSON (Foo V2)++deriving instance Show (Foo V0)++deriving instance Show (Foo V1)++deriving instance Show (Foo V2)++instance ToJSON (Foo V2)++-- How to upcast from V1 to V2+instance Adapt V0 V1 Foo where+ adapt foo = foo { sinceV1 = True+ , sinceV2 = na+ , untilV1 = untilV1 foo+ }++-- How to upcast from V2 to V3+instance Adapt V1 V2 Foo where+ adapt foo = foo { sinceV1 = sinceV1 foo+ , sinceV2 = "hello"+ , untilV1 = na+ }++type instance Applied Show a = String++-- | A 'Foo' at version V0+foo0 :: Foo V0+foo0 = Foo+ { always = 1+ , sinceV1 = na+ , sinceV2 = na+ , untilV1 = 3.14+ }++-- | A 'Foo' at version V2+foo2 :: Foo V2+foo2 = Foo+ { always = 1+ , sinceV1 = True+ , sinceV2 = "hello"+ , untilV1 = Nothing+ }++fooJsonV0 :: LazyBS.ByteString+fooJsonV0 = "{\"always\":1, \"untilV1\": 3.14}"++fooJsonV2 :: LazyBS.ByteString+fooJsonV2 = "{\"always\":1, \"sinceV1\": true, \"sinceV2\": \"hello\"}"
+ versioning-servant.cabal view
@@ -0,0 +1,47 @@+name: versioning-servant+version: 0.1.0.0+synopsis: Servant combinators for the versioning library.+description: This package provides Servant combinators to be used with+ the 'versioning' library.+homepage: https://github.com/lortabac/versioning+license: Apache-2.0+license-file: LICENSE+author: Lorenzo Tabacchini+maintainer: lortabac@gmx.com+copyright: (c) 2018 Lorenzo Tabacchini+category: Data+build-type: Simple+extra-source-files: ChangeLog.md+cabal-version: >=1.10++library+ exposed-modules: Versioning.Servant+ build-depends: base >=4.10 && <4.12+ , aeson >=1.0 && <1.5+ , attoparsec+ , bytestring >=0.10 && <0.11+ , http-media+ , servant+ , versioning >=0.2+ hs-source-dirs: src+ default-language: Haskell2010+ ghc-options: -Wall++test-suite tests+ type: exitcode-stdio-1.0+ main-is: Main.hs+ other-modules: Tests.Versioning.Servant.Fixtures+ build-depends: base >=4.10 && <4.12+ , aeson >=1.0 && <1.5+ , bytestring >=0.10 && <0.11+ , hspec >=2.0 && <2.6+ , hspec-wai >=0.9+ , servant+ , servant-server+ , versioning+ , versioning-servant+ , wai+ , wai-extra+ hs-source-dirs: tests+ default-language: Haskell2010+ ghc-options: -Wall