scotty-resource (empty) → 0.1.0.0

raw patch · 4 files changed

+493/−0 lines, 4 filesdep +basedep +containersdep +http-typessetup-changed

Dependencies added: base, containers, http-types, scotty, text, transformers, wai

Files

• LICENSE +202/−0
• Setup.hs +2/−0
• scotty-resource.cabal +41/−0
• src/Web/Scotty/Resource/Trans.hs +248/−0

@@ -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.

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

@@ -0,0 +1,41 @@+-- Initial scotty-resource.cabal generated by cabal init.  For further +-- documentation, see http://haskell.org/cabal/users-guide/++name:                scotty-resource+version:             0.1.0.0+synopsis:            A Better way of modeling web resources.+description:         +                     Allows users of the Scotty web framework to model+                     resources more like the HTTP standard models them.+homepage:            https://github.com/taphu/scotty-resource+license:             Apache-2.0+license-file:        LICENSE+author:              Rick Owens+maintainer:          rick@owenssoftware.com+copyright:           2016 - Rick Owens+category:            Web+build-type:          Simple+-- extra-source-files:  +cabal-version:       >=1.10++library+  exposed-modules:     +    Web.Scotty.Resource.Trans+  -- other-modules:       +  other-extensions:    +    OverloadedStrings+  build-depends:+    base         >= 4.7      && < 4.8,+    containers   >= 0.1.0.0  && < 0.6,+    http-types   >= 0.8.2    && < 0.10,+    scotty       >= 0.11.0   && < 0.12,+    text         >= 0.11.3.1 && < 1.3,+    transformers >= 0.3.0.0  && < 0.5,+    wai          >= 3.0.0    && < 3.3+  hs-source-dirs: src+  default-language: Haskell2010++source-repository head+  type:     git+  location: git://github.com/taphu/scotty-resource.git+

@@ -0,0 +1,248 @@+{-# LANGUAGE OverloadedStrings #-}+{- |+  This module defines better resource routing for Scotty.++  Scotty is defined in terms of "routes", whereas HTTP is defined in+  terms of "resources".  This package adds a "resource" abstraction to+  the scotty ecosystem.++  (note: All examples probably require -XOverloadedStrings)++  Scotty comes out of the box with a way to model "routes". The problem+  is that "routes" is not the abstraction used by the HTTP standard and+  it can sometimes be tricky to write a perfectly correct HTTP service+  using the routes model (where "correct" is judged against rfc-2616).+  The most blatant, (and who knows, maybe the only) example of this problem+  is shown by the scotty code:++  > import Web.Scotty.Trans (get, scottyT, text)+  >+  > ...+  >+  > scottyT 8080 id $ do+  >   get "/hello" $ do+  >     text "world"++  If a client requests something like @DELETE /hello@, this scotty application+  will return @404 Not Found@, which conflicts with section 5.1.1 of rfc-2616.+  A better response would be @405 Method Not Allowed@, and it would include an+  automatically generated @Allow@ response header.++  This library gives users a way to model "resources" which is closer to the+  abstractions used in the HTTP standard.++  We can re-write the above example like this:++  > import Web.Scotty.Trans (scottyT, text)+  > import Web.Scotty.Resource.Trans (resource, get)+  >+  > ...+  >+  > scottyT 8080 id $ do+  >   resource "/hello" $ do+  >     get $ do+  >       text "world"++  Given a request:++  > DELETE /hello HTTP/1.1+  > Host: localhost:8080++  The resource-based scotty application will produce something like:++  > HTTP/1.1 405 Method Not Allowed+  > Allow: GET++  Each resource is described by a `WebResource` value, which happens to+  be a `Monad`. The only reason `WebResource` implements `Monad` to fit+  in with the do-notation coding style of `ScottyT`. This is an abuse of+  `Monad`, but, you know, whatever. The `Monoid` typeclass more correctly+  represents what a `WebResource` really is. The `Monad` and `Monoid`+  typeclasses are used to compose instances of `WebResource`.++  Here is another more complex example, with multiple resources.++  > import Data.Aeson (decode)+  > import Network.HTTP.Types (notFound404, badRequest400, noContent204)+  > import Web.Scotty.Resource.Trans (resource, get, post)+  > import Web.Scotty.Trans (scottyT, text, body, raw, status, param)+  >+  > import MyApplication (lookupPerson, storePerson)+  > +  > ...+  > +  > scottyT 8080 id $ do+  >+  >   -- an "echo" resource+  >   resource "/echo" $ do+  >     get $ do+  >       text "hello world"+  >     post $ do+  >       -- echo the request body back to the user+  >       raw =<< body+  >+  >   -- A resource that represents a kind of a RESTful database of people.+  >   -- This resource supports GET and PUT.+  >   resource "/people/:personId" $ do+  >     get $ do+  >       personId <- param "personId"+  >       maybePerson <- lookupPerson personId+  >       case maybePerson of+  >         Nothing ->+  >           status notFound404+  >         Just person ->+  >           json person+  >     put $ do+  >       personId <- param "personId"+  >       maybePerson <- decode <$> body+  >       case maybePerson of+  >         Nothing -> do+  >           status badRequest400+  >           text "Invalid person JSON"+  >         Just person ->+  >           storePerson personId person+  >           status noContent204+-}+module Web.Scotty.Resource.Trans (+  resource,+  WebResource,+  options,+  get,+  head,+  post,+  put,+  delete,+  patch,+  method+) where++import Prelude hiding (head)++import Control.Monad (liftM)+import Control.Monad.IO.Class (MonadIO)+import Data.List (intersperse)+import Data.Maybe (fromMaybe)+import Data.Monoid (mconcat, (<>), mempty, Monoid, mappend)+import Data.Set (fromList, toList)+import Data.Text.Encoding (decodeUtf8)+import Data.Text.Lazy (fromStrict)+import Network.HTTP.Types (Method, methodNotAllowed405)+import Network.Wai (requestMethod)+import Web.Scotty.Trans (ActionT, RoutePattern, ScottyT, matchAny,+  request, ScottyError, setHeader, status)++{- |+  Add a resource whose uri matches the route pattern.+-}+resource :: (MonadIO m, ScottyError e)+  => RoutePattern+  -> WebResource e m ()+  -> ScottyT e m ()+resource uri (W methods ()) = matchAny uri $+    getMethod `liftM` request >>= fromMaybe notAllowed+  where+    getMethod = (`lookup` methods) . requestMethod+    notAllowed = do+      setHeader "Allow" allowed+      status methodNotAllowed405++    {-+      Build a list of allowed methods.+    -}+    allowed =+      (+        fromStrict+        . decodeUtf8+        . mconcat+        . intersperse ", "+        . dedupe+        . fmap fst+      ) methods+++{- |+  An opaque representation of an http resource. Use `get`, `post`, etc. to+  create one of these. Use the `Monad` or `Monoid` instances to compose them.+-}+data WebResource e m a = W [(Method, ActionT e m ())] a+instance Monad (WebResource e m) where+  return = W []+  W methods a >>= f =+    let W newMethods b = f a+    in W (methods <> newMethods) b+instance Monoid (WebResource e m a) where+  mempty = W mempty undefined+  mappend (W a _) (W b _) = W (a <> b) undefined+++{- |+  Create a `WebResource` that handles OPTIONS requests using the given+  scotty action.+-}+options :: ActionT e m () -> WebResource e m ()+options action = W [("OPTIONS", action)] ()+++{- |+  Create a `WebResource` that handles GET requests using the given+  scotty action.+-}+get :: ActionT e m () -> WebResource e m ()+get action = W [("GET", action)] ()+++{- |+  Create a `WebResource` that handles HEAD requests using the given+  scotty action.+-}+head :: ActionT e m () -> WebResource e m ()+head action = W [("HEAD", action)] ()+++{- |+  Create a `WebResource` that handles POST requests using the given+  scotty action.+-}+post :: ActionT e m () -> WebResource e m ()+post action = W [("POST", action)] ()+++{- |+  Create a `WebResource` that handles PUT requests using the given+  scotty action.+-}+put :: ActionT e m () -> WebResource e m ()+put action = W [("PUT", action)] ()+++{- |+  Create a `WebResource` that handles DELETE requests using the given+  scotty action.+-}+delete :: ActionT e m () -> WebResource e m ()+delete action = W [("DELETE", action)] ()+++{- |+  Create a `WebResource` that handles PATCH requests using the given+  scotty action.+-}+patch :: ActionT e m () -> WebResource e m ()+patch action = W [("PATCH", action)] ()+++{- |+  Create a `WebResource` that handles the specific method using the given+  scotty action.+-}+method :: Method -> ActionT e m () -> WebResource e m ()+method m action = W [(m, action)] ()+++{- |+  A helper function that removes duplicates from a list.+-}+dedupe :: (Ord a, Eq a) => [a] -> [a]+dedupe = toList . fromList++