0870b3b · typeable/servant

git.iko.soy/typeable/servant

on master help sign in

Remove FromFormUrlEncoded and ToFormUrlEncoded.

0870b3bJulian K. Arni10 years ago

servant-client/servant-client.cabal+1

compare with master

unifiedsplit

@@ -78,6 +78,7 @@ test-suite spec

78 , bytestring

79 , deepseq

80 , hspec == 2.*

81+ , http-api-data

81 , http-client

82 , http-client

82 , http-media

83 , http-media

83 , http-types

84 , http-types

servant-client/test/Servant/ClientSpec.hs+8−18

@@ -30,7 +30,7 @@ module Servant.ClientSpec where

30import Control.Applicative ((<$>))

31#endif

32import Control.Arrow (left)

33−import Control.Concurrent (forkIO, killThread, ThreadId)

33+import Control.Concurrent (ThreadId, forkIO, killThread)

34import Control.Exception (bracket)

35import Control.Monad.Trans.Except (throwE )

36import Data.Aeson

@@ -39,19 +39,20 @@ import Data.Char (chr, isPrint)

39import Data.Foldable (forM_)

40import Data.Monoid hiding (getLast)

41import Data.Proxy

42−import qualified Data.Text as T

43import GHC.Generics (Generic)

42import GHC.Generics (Generic)

44import qualified Network.HTTP.Client as C

43import qualified Network.HTTP.Client as C

45import Network.HTTP.Media

44import Network.HTTP.Media

46import qualified Network.HTTP.Types as HTTP

45import qualified Network.HTTP.Types as HTTP

47import Network.Socket

46import Network.Socket

48−import Network.Wai (Request, requestHeaders, responseLBS)

47+import Network.Wai (Request, requestHeaders,

48+ responseLBS)

49import Network.Wai.Handler.Warp

50import System.IO.Unsafe (unsafePerformIO)

51import Test.Hspec

52import Test.Hspec.QuickCheck

53import Test.HUnit

54import Test.QuickCheck

55+import Web.FormUrlEncoded (FromForm, ToForm)

56import Servant.API

57import Servant.API

57import Servant.API.Internal.Test.ComprehensiveAPI

58import Servant.API.Internal.Test.ComprehensiveAPI

@@ -82,19 +83,8 @@ data Person = Person {

82instance ToJSON Person

83instance ToJSON Person

83instance FromJSON Person

84instance FromJSON Person

85−instance ToFormUrlEncoded Person where

86+instance ToForm Person where

86− toFormUrlEncoded Person{..} =

87− [("name", T.pack name), ("age", T.pack (show age))]

88−

89−lookupEither :: (Show a, Eq a) => a -> [(a,b)] -> Either String b

90−lookupEither x xs = do

91− maybe (Left $ "could not find key " <> show x) return $ lookup x xs

92−

93−instance FromFormUrlEncoded Person where

87+instance FromForm Person where

94− fromFormUrlEncoded xs = do

95− n <- lookupEither "name" xs

96− a <- lookupEither "age" xs

97− return $ Person (T.unpack n) (read $ T.unpack a)

99alice :: Person

89alice :: Person

100alice = Person "Alice" 42

90alice = Person "Alice" 42

@@ -131,9 +121,9 @@ getBody :: Person -> SCR.ClientM Person

131getQueryParam :: Maybe String -> SCR.ClientM Person

121getQueryParam :: Maybe String -> SCR.ClientM Person

132getQueryParams :: [String] -> SCR.ClientM [Person]

122getQueryParams :: [String] -> SCR.ClientM [Person]

133getQueryFlag :: Bool -> SCR.ClientM Bool

123getQueryFlag :: Bool -> SCR.ClientM Bool

134−getRawSuccess :: HTTP.Method

124+getRawSuccess :: HTTP.Method

135 -> SCR.ClientM (Int, BS.ByteString, MediaType, [HTTP.Header], C.Response BS.ByteString)

125 -> SCR.ClientM (Int, BS.ByteString, MediaType, [HTTP.Header], C.Response BS.ByteString)

136−getRawFailure :: HTTP.Method

126+getRawFailure :: HTTP.Method

137 -> SCR.ClientM (Int, BS.ByteString, MediaType, [HTTP.Header], C.Response BS.ByteString)

127 -> SCR.ClientM (Int, BS.ByteString, MediaType, [HTTP.Header], C.Response BS.ByteString)

138getMultiple :: String -> Maybe Int -> Bool -> [(String, [Rational])]

128getMultiple :: String -> Maybe Int -> Bool -> [(String, [Rational])]

139 -> SCR.ClientM (String, Maybe Int, Bool, [(String, [Rational])])

129 -> SCR.ClientM (String, Maybe Int, Bool, [(String, [Rational])])

servant/CHANGELOG.md+2−1

@@ -1,12 +1,13 @@

1next

2----

3* Added Eq, Show, Read, Generic and Ord instances to IsSecure

4+* BACKWARDS INCOMPATIBLE replace use of `ToFromByteString` with `To/FromHttpApiData` for `GetHeaders/BuildHeadersTo`

5+* BACKWARD INCOMPATIBLE: Moved `From/ToFormUrlEncoded` classes, which were renamed to `From/ToForm` to `http-api-data`

50.8.1

70.8.1

6----

8----

8* Add `CaptureAll` combinator. Captures all of the remaining segments in a URL.

10* Add `CaptureAll` combinator. Captures all of the remaining segments in a URL.

9−* BACKWARDS INCOMPATIBLE replace use of `ToFromByteString` with `To/FromHttpApiData` for `GetHeaders/BuildHeadersTo`

110.8

120.8

12---

13---

servant/src/Servant/API.hs+2−2

@@ -62,10 +62,10 @@ import Servant.API.Alternative ((:<|>) (..))

62import Servant.API.BasicAuth (BasicAuth,BasicAuthData(..))

63import Servant.API.Capture (Capture, CaptureAll)

64import Servant.API.ContentTypes (Accept (..), FormUrlEncoded,

65− FromFormUrlEncoded (..), JSON,

65+ JSON,

66 MimeRender (..), NoContent (NoContent),

67 MimeUnrender (..), OctetStream,

68− PlainText, ToFormUrlEncoded (..))

68+ PlainText)

69import Servant.API.Experimental.Auth (AuthProtect)

70import Servant.API.Header (Header (..))

71import Servant.API.HttpVersion (HttpVersion (..))

servant/src/Servant/API/ContentTypes.hs+11−56

@@ -66,15 +66,14 @@ module Servant.API.ContentTypes

66 , AllMime(..)

67 , AllMimeRender(..)

68 , AllMimeUnrender(..)

69− , FromFormUrlEncoded(..)

70− , ToFormUrlEncoded(..)

71 , eitherDecodeLenient

69 , eitherDecodeLenient

72 , canHandleAcceptH

70 , canHandleAcceptH

73 ) where

71 ) where

75import Control.Arrow (left)

73import Control.Arrow (left)

76import Control.Monad.Compat

74import Control.Monad.Compat

77−import Data.Aeson (FromJSON(..), ToJSON(..), encode)

75+import Data.Aeson (FromJSON (..), ToJSON (..),

76+ encode)

78import Data.Aeson.Parser (value)

77import Data.Aeson.Parser (value)

79import Data.Aeson.Types (parseEither)

78import Data.Aeson.Types (parseEither)

80import Data.Attoparsec.ByteString.Char8 (endOfInput, parseOnly,

79import Data.Attoparsec.ByteString.Char8 (endOfInput, parseOnly,

@@ -82,10 +81,8 @@ import Data.Attoparsec.ByteString.Char8 (endOfInput, parseOnly,

82import qualified Data.ByteString as BS

81import qualified Data.ByteString as BS

83import Data.ByteString.Lazy (ByteString, fromStrict,

82import Data.ByteString.Lazy (ByteString, fromStrict,

84 toStrict)

83 toStrict)

85−import qualified Data.ByteString.Lazy as B

86import qualified Data.ByteString.Lazy.Char8 as BC

84import qualified Data.ByteString.Lazy.Char8 as BC

87import Data.Maybe (isJust)

85import Data.Maybe (isJust)

88−import Data.Monoid.Compat

89import Data.String.Conversions (cs)

86import Data.String.Conversions (cs)

90import qualified Data.Text as TextS

87import qualified Data.Text as TextS

91import qualified Data.Text.Encoding as TextS

88import qualified Data.Text.Encoding as TextS

@@ -94,8 +91,9 @@ import qualified Data.Text.Lazy.Encoding as TextL

94import Data.Typeable

91import Data.Typeable

95import GHC.Generics (Generic)

92import GHC.Generics (Generic)

96import qualified Network.HTTP.Media as M

93import qualified Network.HTTP.Media as M

97−import Network.URI (escapeURIString,

94+import Web.FormUrlEncoded (FromForm, ToForm,

98− isUnreserved, unEscapeString)

95+ urlEncodeAsForm,

96+ urlDecodeAsForm)

99import Prelude ()

97import Prelude ()

100import Prelude.Compat

98import Prelude.Compat

101

@@ -290,12 +288,12 @@ instance OVERLAPPABLE_

290 ToJSON a => MimeRender JSON a where

288 ToJSON a => MimeRender JSON a where

291 mimeRender _ = encode

289 mimeRender _ = encode

292

290

293−-- | @encodeFormUrlEncoded . toFormUrlEncoded@

291+-- | @urlEncodeAsForm"

294-- Note that the @mimeUnrender p (mimeRender p x) == Right x@ law only

292-- Note that the @mimeUnrender p (mimeRender p x) == Right x@ law only

295-- holds if every element of x is non-null (i.e., not @("", "")@)

293-- holds if every element of x is non-null (i.e., not @("", "")@)

296instance OVERLAPPABLE_

294instance OVERLAPPABLE_

297− ToFormUrlEncoded a => MimeRender FormUrlEncoded a where

295+ ToForm a => MimeRender FormUrlEncoded a where

298− mimeRender _ = encodeFormUrlEncoded . toFormUrlEncoded

296+ mimeRender _ = urlEncodeAsForm

299

297

300-- | `TextL.encodeUtf8`

298-- | `TextL.encodeUtf8`

301instance MimeRender PlainText TextL.Text where

299instance MimeRender PlainText TextL.Text where

@@ -348,11 +346,11 @@ eitherDecodeLenient input =

348instance FromJSON a => MimeUnrender JSON a where

346instance FromJSON a => MimeUnrender JSON a where

349 mimeUnrender _ = eitherDecodeLenient

347 mimeUnrender _ = eitherDecodeLenient

350

348

351−-- | @decodeFormUrlEncoded >=> fromFormUrlEncoded@

349+-- | @urlDecodeAsForm@

352-- Note that the @mimeUnrender p (mimeRender p x) == Right x@ law only

350-- Note that the @mimeUnrender p (mimeRender p x) == Right x@ law only

353-- holds if every element of x is non-null (i.e., not @("", "")@)

351-- holds if every element of x is non-null (i.e., not @("", "")@)

354−instance FromFormUrlEncoded a => MimeUnrender FormUrlEncoded a where

352+instance FromForm a => MimeUnrender FormUrlEncoded a where

355− mimeUnrender _ = decodeFormUrlEncoded >=> fromFormUrlEncoded

353+ mimeUnrender _ = left TextS.unpack . urlDecodeAsForm

356

354

357-- | @left show . TextL.decodeUtf8'@

355-- | @left show . TextL.decodeUtf8'@

358instance MimeUnrender PlainText TextL.Text where

356instance MimeUnrender PlainText TextL.Text where

@@ -375,49 +373,6 @@ instance MimeUnrender OctetStream BS.ByteString where

375 mimeUnrender _ = Right . toStrict

373 mimeUnrender _ = Right . toStrict

376

374

377

375

378−--------------------------------------------------------------------------

379−-- * FormUrlEncoded

380−

381−-- | A type that can be converted to @application/x-www-form-urlencoded@

382−class ToFormUrlEncoded a where

383− toFormUrlEncoded :: a -> [(TextS.Text, TextS.Text)]

384−

385−instance ToFormUrlEncoded [(TextS.Text, TextS.Text)] where

386− toFormUrlEncoded = id

387−

388−-- | A type that can be converted from @application/x-www-form-urlencoded@,

389−-- with the possibility of failure.

390−class FromFormUrlEncoded a where

391− fromFormUrlEncoded :: [(TextS.Text, TextS.Text)] -> Either String a

392−

393−instance FromFormUrlEncoded [(TextS.Text, TextS.Text)] where

394− fromFormUrlEncoded = return

395−

396−encodeFormUrlEncoded :: [(TextS.Text, TextS.Text)] -> ByteString

397−encodeFormUrlEncoded xs =

398− let escape :: TextS.Text -> ByteString

399− escape = cs . escapeURIString isUnreserved . cs

400− encodePair :: (TextS.Text, TextS.Text) -> ByteString

401− encodePair (k, "") = escape k

402− encodePair (k, v) = escape k <> "=" <> escape v

403− in B.intercalate "&" $ map encodePair xs

404−

405−decodeFormUrlEncoded :: ByteString -> Either String [(TextS.Text, TextS.Text)]

406−decodeFormUrlEncoded "" = return []

407−decodeFormUrlEncoded q = do

408− let xs :: [TextS.Text]

409− xs = TextS.splitOn "&" . cs $ q

410− parsePair :: TextS.Text -> Either String (TextS.Text, TextS.Text)

411− parsePair p =

412− case TextS.splitOn "=" p of

413− [k,v] -> return ( unescape k

414− , unescape v

415− )

416− [k] -> return ( unescape k, "" )

417− _ -> Left $ "not a valid pair: " <> cs p

418− unescape :: TextS.Text -> TextS.Text

419− unescape = cs . unEscapeString . cs . TextS.intercalate "%20" . TextS.splitOn "+"

420− mapM parsePair xs

421

376

422-- $setup

377-- $setup

423-- >>> import Servant.API

378-- >>> import Servant.API

servant/test/Servant/API/ContentTypesSpec.hs−17

@@ -11,7 +11,6 @@ module Servant.API.ContentTypesSpec where

11import Prelude ()

12import Prelude.Compat

14−import Control.Arrow

15import Data.Aeson

14import Data.Aeson

16import Data.ByteString.Char8 (ByteString, append, pack)

15import Data.ByteString.Char8 (ByteString, append, pack)

17import qualified Data.ByteString.Lazy as BSL

16import qualified Data.ByteString.Lazy as BSL

@@ -25,7 +24,6 @@ import Data.String.Conversions (cs)

25import qualified Data.Text as TextS

24import qualified Data.Text as TextS

26import qualified Data.Text.Lazy as TextL

25import qualified Data.Text.Lazy as TextL

27import GHC.Generics

26import GHC.Generics

28−import Network.URL (exportParams, importParams)

29import Test.Hspec

27import Test.Hspec

30import Test.QuickCheck

28import Test.QuickCheck

31import "quickcheck-instances" Test.QuickCheck.Instances ()

29import "quickcheck-instances" Test.QuickCheck.Instances ()

@@ -68,21 +66,6 @@ spec = describe "Servant.API.ContentTypes" $ do

68 it "has mimeUnrender reverse mimeRender for valid top-level json " $ do

66 it "has mimeUnrender reverse mimeRender for valid top-level json " $ do

69 property $ \x -> mimeUnrender p (mimeRender p x) == Right (x::SomeData)

67 property $ \x -> mimeUnrender p (mimeRender p x) == Right (x::SomeData)

71− describe "The FormUrlEncoded Content-Type type" $ do

72− let p = Proxy :: Proxy FormUrlEncoded

73−

74− it "has mimeUnrender reverse mimeRender" $ do

75− property $ \x -> mempty `notElem` x

76− ==> mimeUnrender p (mimeRender p x) == Right (x::[(TextS.Text,TextS.Text)])

77−

78− it "has mimeUnrender reverse exportParams (Network.URL)" $ do

79− property $ \x -> mempty `notElem` x

80− ==> (mimeUnrender p . cs . exportParams . map (cs *** cs) $ x) == Right (x::[(TextS.Text,TextS.Text)])

81−

82− it "has importParams (Network.URL) reverse mimeRender" $ do

83− property $ \x -> mempty `notElem` x

84− ==> (fmap (map (cs *** cs)) . importParams . cs . mimeRender p $ x) == Just (x::[(TextS.Text,TextS.Text)])

85−

86 describe "The PlainText Content-Type type" $ do

69 describe "The PlainText Content-Type type" $ do

87 let p = Proxy :: Proxy PlainText

70 let p = Proxy :: Proxy PlainText