Sandbox::https://github.com/fizruk/http-api-data/pull/32

fizruk · 2016-08-30T12:52:09Z

Closes #23. Supersedes #31 and #25.

Some further questions:

do we want FormOptions to mimic aeson's Options?
do we want ToFormKey/FromFormKey instances for Maybe a, Either a b, First a, Last a like we have for ToHttpApiData and FromHttpApiData?
do we want specialised instances for Map Text Text, HashMap Text Text and [(Text, Text)]?
do we want to bikeshed functions names (helpers in particular)?

This commit moves ToFormUrlEncoded and FromFormUrlEncoded from servant to http-api-data. The classes are renamed ToForm and FromForm, and gain generic instances.

`decodeForm (encodeForm x)` does not equal `x` when we have a form like `Form [("", "")]`. The result `Form` after encoding and decoding is just `Form []`. This commit adds in a newtype wrapper `NoEmptyKeyForm` with an `Arbitrary` instance that removes all empty-string keys.

This commit replaces all uses of the `cs` function with functions like `pack`, `unpack`, `decodeUtf8`, etc.

…arseQueryParam.

…rectly to / from a datatype.

jkarni · 2016-08-30T13:25:32Z

+
+-- | Typeclass for types that can be parsed from keys of a 'Form'. This is the reverse of 'ToFormKey'.
+class FromFormKey k where
+  -- | Parse a key of a 'Form'.


Looking at the W3 docs, it seems keys (control names, in the lingo) should be case-insensitive.

https://www.w3.org/TR/html401/interact/forms.html#control-name
https://www.w3.org/TR/html401/interact/forms.html#h-17.3

So maybe this needs to be CI Text?

Interesting, we might want to use CI Text for helpers in Web.HttpApiData too.

@jkarni can't find anywhere that "control names" should be case insensitive.

I was looking at name in 17.3, but that's not right. id says it's case sensitive. So I think it's right as it stands.

jkarni · 2016-08-30T13:32:58Z

+encodeForm :: Form -> BSL.ByteString
+encodeForm xs = BSL.intercalate "&" $ map (BSL.fromStrict . encodePair) $ toList xs
+  where
+    escape = Text.encodeUtf8 . Text.pack . escapeURIString isUnreserved . Text.unpack


This is obviously inefficient. I'm in favor of making changes incrementally, and so leaving the fixing of it for another PR, but for reference [uri-bytestrings](%28https://hackage.haskell.org/package/uri-bytestring-0.2.2.0/docs/URI-ByteString.html%29 could) urlEncode could be a good option.

Aha, I was looking for something like it!
urlEncodeQuery looks ideal for encoding.

fizruk · 2016-08-30T13:45:53Z

@jkarni ah, I still want to remove support for them for now. If there's demand we'll get back to this problem later.

cdepillabout · 2016-08-31T00:14:55Z

@fizruk: This looks good to me.

One thing I'd like to see is an example using FormOptions. One thing that always bugs me is when I look at lens or aeson documentation is that there is not enough explanation for using their generic deriving options.

For example, take a datatype like this:

data Person = Person
  { personName :: Text
  , personAge :: Int
  }

I imagine it's common to want to urlencode this to be name=foo&age=30, not personName=foo&personAge=30.

An example of how to use defaultOptions to accomplish this would be really nice.

Of course, I can always send a PR for this additional documentation after this PR (#32) has been merged.

fizruk · 2016-08-31T01:00:53Z

@cdepillabout added an example in e613d05.

Any final wishes before I release? :)

jkarni · 2016-08-31T01:02:12Z

I wish you a good flight?

fizruk · 2016-08-31T01:28:22Z

@jkarni yeah, thanks :)

I am merging this now, I think we've covered most things here.

jkarni and others added 26 commits August 24, 2016 22:23

Move FormUrlEncoded from servant.

1b468b0

This commit moves ToFormUrlEncoded and FromFormUrlEncoded from servant to http-api-data. The classes are renamed ToForm and FromForm, and gain generic instances.

Fix PR so it works on ghc-7.8.

ac72f9e

Remove dependency on string-conversions package.

acc2cd4

This commit replaces all uses of the `cs` function with functions like `pack`, `unpack`, `decodeUtf8`, etc.

Replace uses for toUrlPiece and parseUrlPiece with toQueryParam and p…

97f200f

…arseQueryParam.

Change uses of String to Text.

dd1baa5

Add comments and doctests to the FormUrlEncoded module.

8ab1a1f

Add two convenience functions for encoding / decoding a ByteString di…

6487f48

…rectly to / from a datatype.

Rephrase documentation and amend some examples for FormUrlEncoded

fb08da7

Use a custom Show instanse for Form (like Map has)

6ab8a56

Rename encode/decodeWith*From to encode/decodeAsForm

236c59a

Ignore stack haddock's output to src/

7c3d63b

Move Form-related stuff to Web.FormUrlEncoded

4233ec9

Simplify To/FromForm instances for lists

9b7a61d

Remove utf8-string dependency

6e97168

Refactor decodeForm

f2a7554

Remove mtl dependency, simplify GToForm and GFromForm

28713e6

Add test case for empty form data

765249b

Refactor qualified names

d04cfba

Allow duplicate keys in Form

5322053

Add FormKey classes

3d6065a

Generalize ToForm/FromForm instances

a9976c2

Add ToForm/FormForm instances for IntMap and HashMap

6cd7a03

Add helpers for FromForm instances

70060ee

Change Form's internal representation to HashMap

0456604

Export Generic-based toForm and fromForm

550df9a

jkarni reviewed Aug 30, 2016
View reviewed changes

fizruk force-pushed the cdepillabout-add-form-url-encoded branch from 7e55dd8 to 5ae2f86 Compare August 30, 2016 13:27

jkarni reviewed Aug 30, 2016
View reviewed changes

fizruk added 3 commits August 30, 2016 16:46

Rename encode/decode to urlEncode/urlDecode

02fadd3

Use uri-bytestring for a more efficient url-encoding and decoding

ea020ae

Remove Generic support for sum types

5a448b3

fizruk force-pushed the cdepillabout-add-form-url-encoded branch 2 times, most recently from 2fa39c1 to ec3b440 Compare August 30, 2016 21:05

Fix GHC 7.8 builds

e9c728b

fizruk force-pushed the cdepillabout-add-form-url-encoded branch from ec3b440 to e9c728b Compare August 30, 2016 21:12

fizruk added 6 commits August 31, 2016 00:41

Add instances for Natural (close #33)

d944721

Rename lookupKey -> lookupAll, improve docs a bit

fa05cca

Add notes that Generic-based implementation only works for records

3158b55

Add nice type error for when ToForm/FromForm is derived for sum type

bea3afe

Add basic FormOptions

7a7b274

Fix unticked promoted constructors warning

57c0a23

cdepillabout mentioned this pull request Aug 31, 2016

From/ToFormUrlEncoded #31

Closed

jkarni mentioned this pull request Aug 31, 2016

From/ToFormUrlEncoded (Do not merge) #25

Closed

Treat Maybes and lists specially when deriving Generic instances

4bc8d3e

Fix GHC 7 builds

9cb90d5

fizruk force-pushed the cdepillabout-add-form-url-encoded branch from 570353a to 9cb90d5 Compare August 31, 2016 00:27

fizruk added 3 commits August 31, 2016 03:45

Re-export FormOptions

2df7799

Add an example for non-default FormOptions

e613d05

Enable ConstraintKinds and fix typo for GHC 7.8

de9fe0f

fizruk force-pushed the cdepillabout-add-form-url-encoded branch from acae0c8 to de9fe0f Compare August 31, 2016 00:54

Add more docs explaining special roles of Maybe and lists

f59b5c9

fizruk merged commit 56c53a4 into master Aug 31, 2016

fizruk deleted the cdepillabout-add-form-url-encoded branch August 31, 2016 01:33

Navigation Menu

Repository navigation

Forms - #32

Forms#32
fizruk merged 43 commits into
masterfrom
cdepillabout-add-form-url-encoded

fizruk commented Aug 30, 2016

Uh oh!

jkarni Aug 30, 2016

Uh oh!

fizruk Aug 30, 2016

Uh oh!

fizruk Aug 30, 2016

Uh oh!

jkarni Aug 30, 2016

Uh oh!

jkarni Aug 30, 2016

Uh oh!

fizruk Aug 30, 2016

Uh oh!

fizruk commented Aug 30, 2016

Uh oh!

cdepillabout commented Aug 31, 2016

Uh oh!

fizruk commented Aug 31, 2016

Uh oh!

jkarni commented Aug 31, 2016

Uh oh!

fizruk commented Aug 31, 2016

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

fizruk commented Aug 30, 2016

Uh oh!

jkarni Aug 30, 2016

Choose a reason for hiding this comment

Uh oh!

fizruk Aug 30, 2016

Choose a reason for hiding this comment

Uh oh!

fizruk Aug 30, 2016

Choose a reason for hiding this comment

Uh oh!

jkarni Aug 30, 2016

Choose a reason for hiding this comment

Uh oh!

jkarni Aug 30, 2016

Choose a reason for hiding this comment

Uh oh!

fizruk Aug 30, 2016

Choose a reason for hiding this comment

Uh oh!

fizruk commented Aug 30, 2016

Uh oh!

cdepillabout commented Aug 31, 2016

Uh oh!

fizruk commented Aug 31, 2016

Uh oh!

jkarni commented Aug 31, 2016

Uh oh!

fizruk commented Aug 31, 2016

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants