Tidy up

Author: garyb

src/Network/HTTP/Affjax.purs

@@ -1,7 +1,7 @@
 module Network.HTTP.Affjax
   ( Affjax
   , AffjaxRequest, defaultRequest
-  , AffjaxResponseT
+  , AffjaxResponse
   , URL
   , affjax
   , get
@@ -13,7 +13,6 @@ module Network.HTTP.Affjax
   , RetryPolicy(..)
   , defaultRetryPolicy
   , retry
-  , module Exports
   ) where
 
 import Prelude
@@ -42,21 +41,20 @@ import Effect.Exception (Error, error)
 import Effect.Ref as Ref
 import Foreign (F, Foreign, ForeignError(..), fail, unsafeReadTagged, unsafeToForeign)
 import Math as Math
-import Network.HTTP.Affjax.Request (RequestContent(..), defaultMediaType)
-import Network.HTTP.Affjax.Request (RequestContent(..)) as Exports
-import Network.HTTP.Affjax.Response (AffjaxResponse(..), responseTypeToMediaType, responseTypeToString)
+import Network.HTTP.Affjax.Request as Request
+import Network.HTTP.Affjax.Response as Response
 import Network.HTTP.RequestHeader (RequestHeader(..), requestHeaderName, requestHeaderValue)
 import Network.HTTP.ResponseHeader (ResponseHeader, responseHeader)
 import Network.HTTP.StatusCode (StatusCode(..))
 
 -- | The result type for Affjax requests.
-type Affjax a = Aff (AffjaxResponseT a)
+type Affjax a = Aff (AffjaxResponse a)
 
 type AffjaxRequest =
   { method :: Either Method CustomMethod
   , url :: URL
   , headers :: Array RequestHeader
-  , content :: Maybe RequestContent
+  , content :: Maybe Request.Request
   , username :: Maybe String
   , password :: Maybe String
   , withCredentials :: Boolean
@@ -74,7 +72,7 @@ defaultRequest =
   }
 
 -- | The type of records that will be received as an Affjax response.
-type AffjaxResponseT a =
+type AffjaxResponse a =
   { status :: StatusCode
   , headers :: Array ResponseHeader
   , response :: a
@@ -84,70 +82,70 @@ type AffjaxResponseT a =
 type URL = String
 
 -- | Makes a `GET` request to the specified URL.
-get :: forall a. AffjaxResponse a -> URL -> Affjax a
+get :: forall a. Response.Response a -> URL -> Affjax a
 get rt u = affjax rt $ defaultRequest { url = u }
 
 -- | Makes a `POST` request to the specified URL, sending data.
-post :: forall a. AffjaxResponse a -> URL -> RequestContent -> Affjax a
+post :: forall a. Response.Response a -> URL -> Request.Request -> Affjax a
 post rt u c = affjax rt $ defaultRequest { method = Left POST, url = u, content = Just c }
 
 -- | Makes a `POST` request to the specified URL with the option to send data.
-post' :: forall a. AffjaxResponse a -> URL -> Maybe RequestContent -> Affjax a
+post' :: forall a. Response.Response a -> URL -> Maybe Request.Request -> Affjax a
 post' rt u c = affjax rt $ defaultRequest { method = Left POST, url = u, content = c }
 
 -- | Makes a `POST` request to the specified URL, sending data and ignoring the
 -- | response.
-post_ :: URL -> RequestContent -> Affjax Unit
-post_ = post (IgnoredResponse identity)
+post_ :: URL -> Request.Request -> Affjax Unit
+post_ = post Response.ignore
 
 -- | Makes a `POST` request to the specified URL with the option to send data,
 -- | and ignores the response.
-post_' :: URL -> Maybe RequestContent -> Affjax Unit
-post_' = post' (IgnoredResponse identity)
+post_' :: URL -> Maybe Request.Request -> Affjax Unit
+post_' = post' Response.ignore
 
 -- | Makes a `PUT` request to the specified URL, sending data.
-put :: forall a. AffjaxResponse a -> URL -> RequestContent -> Affjax a
+put :: forall a. Response.Response a -> URL -> Request.Request -> Affjax a
 put rt u c = affjax rt $ defaultRequest { method = Left PUT, url = u, content = Just c }
 
 -- | Makes a `PUT` request to the specified URL with the option to send data.
-put' :: forall a. AffjaxResponse a -> URL -> Maybe RequestContent -> Affjax a
+put' :: forall a. Response.Response a -> URL -> Maybe Request.Request -> Affjax a
 put' rt u c = affjax rt $ defaultRequest { method = Left PUT, url = u, content = c }
 
 -- | Makes a `PUT` request to the specified URL, sending data and ignoring the
 -- | response.
-put_ :: URL -> RequestContent -> Affjax Unit
-put_ = put  (IgnoredResponse identity)
+put_ :: URL -> Request.Request -> Affjax Unit
+put_ = put  Response.ignore
 
 -- | Makes a `PUT` request to the specified URL with the option to send data,
 -- | and ignores the response.
-put_' :: URL -> Maybe RequestContent -> Affjax Unit
-put_' = put'  (IgnoredResponse identity)
+put_' :: URL -> Maybe Request.Request -> Affjax Unit
+put_' = put'  Response.ignore
 
 -- | Makes a `DELETE` request to the specified URL.
-delete :: forall a. AffjaxResponse a -> URL -> Affjax a
+delete :: forall a. Response.Response a -> URL -> Affjax a
 delete rt u = affjax rt $ defaultRequest { method = Left DELETE, url = u }
 
 -- | Makes a `DELETE` request to the specified URL and ignores the response.
 delete_ :: URL -> Affjax Unit
-delete_ = delete (IgnoredResponse identity)
+delete_ = delete Response.ignore
 
 -- | Makes a `PATCH` request to the specified URL, sending data.
-patch :: forall a. AffjaxResponse a -> URL -> RequestContent -> Affjax a
+patch :: forall a. Response.Response a -> URL -> Request.Request -> Affjax a
 patch rt u c = affjax rt $ defaultRequest { method = Left PATCH, url = u, content = Just c }
 
 -- | Makes a `PATCH` request to the specified URL with the option to send data.
-patch' :: forall a. AffjaxResponse a -> URL -> Maybe RequestContent -> Affjax a
+patch' :: forall a. Response.Response a -> URL -> Maybe Request.Request -> Affjax a
 patch' rt u c = affjax rt $ defaultRequest { method = Left PATCH, url = u, content = c }
 
 -- | Makes a `PATCH` request to the specified URL, sending data and ignoring the
 -- | response.
-patch_ :: URL -> RequestContent -> Affjax Unit
-patch_ = patch (IgnoredResponse identity)
+patch_ :: URL -> Request.Request -> Affjax Unit
+patch_ = patch Response.ignore
 
 -- | Makes a `PATCH` request to the specified URL with the option to send data,
 -- | and ignores the response.
-patch_' :: URL -> Maybe RequestContent -> Affjax Unit
-patch_' = patch' (IgnoredResponse identity)
+patch_' :: URL -> Maybe Request.Request -> Affjax Unit
+patch_' = patch' Response.ignore
 
 -- | A sequence of retry delays, in milliseconds.
 type RetryDelayCurve = Int -> Milliseconds
@@ -189,8 +187,8 @@ retry policy run req = do
         Just resp -> pure resp
   where
     retryState
-      :: Either Error (AffjaxResponseT a)
-      -> RetryState Error (AffjaxResponseT a)
+      :: Either Error (AffjaxResponse a)
+      -> RetryState Error (AffjaxResponse a)
     retryState (Left exn) = Left $ Left exn
     retryState (Right resp) =
       case resp.status of
@@ -211,7 +209,7 @@ retry policy run req = do
         Right resp -> pure resp
 
 -- | Makes an `Affjax` request.
-affjax :: forall a. AffjaxResponse a -> AffjaxRequest -> Affjax a
+affjax :: forall a. Response.Response a -> AffjaxRequest -> Affjax a
 affjax rt req = do
   res <- AC.fromEffectFnAff $ runFn2 _ajax responseHeader req'
   case runExcept (fromResponse' res.response) of
@@ -225,26 +223,26 @@ affjax rt req = do
     , url: req.url
     , headers: (\h -> { field: requestHeaderName h, value: requestHeaderValue h }) <$> headers req.content
     , content: toNullable (extractContent <$> req.content)
-    , responseType: responseTypeToString rt
+    , responseType: Response.toResponseType rt
     , username: toNullable req.username
     , password: toNullable req.password
     , withCredentials: req.withCredentials
     }
 
-  extractContent :: RequestContent -> Foreign
+  extractContent :: Request.Request -> Foreign
   extractContent = case _ of
-    ArrayView f → f unsafeToForeign
-    BlobRequest x → unsafeToForeign x
-    DocumentRequest x → unsafeToForeign x
-    StringRequest x → unsafeToForeign x
-    FormDataRequest x → unsafeToForeign x
-    FormURLEncodedRequest x → unsafeToForeign (FormURLEncoded.encode x)
-    JsonRequest x → unsafeToForeign (J.stringify x)
-
-  headers :: Maybe RequestContent -> Array RequestHeader
+    Request.ArrayView f → f unsafeToForeign
+    Request.Blob x → unsafeToForeign x
+    Request.Document x → unsafeToForeign x
+    Request.String x → unsafeToForeign x
+    Request.FormData x → unsafeToForeign x
+    Request.FormURLEncoded x → unsafeToForeign (FormURLEncoded.encode x)
+    Request.Json x → unsafeToForeign (J.stringify x)
+
+  headers :: Maybe Request.Request -> Array RequestHeader
   headers reqContent =
-    addHeader (ContentType <$> (defaultMediaType =<< reqContent)) $
-      addHeader (Accept <$> responseTypeToMediaType rt)
+    addHeader (ContentType <$> (Request.toMediaType =<< reqContent)) $
+      addHeader (Accept <$> Response.toMediaType rt)
         req.headers
 
   addHeader :: Maybe RequestHeader -> Array RequestHeader -> Array RequestHeader
@@ -256,13 +254,13 @@ affjax rt req = do
   parseJSON = either (fail <<< ForeignError) pure <<< jsonParser
 
   fromResponse' :: Foreign -> F a
-  fromResponse' rc = case rt of
-    ArrayBufferResponse coe -> unsafeReadTagged "ArrayBuffer" rc
-    BlobResponse coe -> unsafeReadTagged "Blob" rc
-    DocumentResponse coe -> unsafeReadTagged "Document" rc
-    JSONResponse coe -> coe $ parseJSON =<< unsafeReadTagged "String" rc
-    StringResponse coe -> unsafeReadTagged "String" rc
-    IgnoredResponse coe -> coe $ pure unit
+  fromResponse' = case rt of
+    Response.ArrayBuffer _ -> unsafeReadTagged "ArrayBuffer"
+    Response.Blob _ -> unsafeReadTagged "Blob"
+    Response.Document _ -> unsafeReadTagged "Document"
+    Response.Json coe -> coe <<< parseJSON <=< unsafeReadTagged "String"
+    Response.String _ -> unsafeReadTagged "String"
+    Response.Ignore coe -> const $ coe (pure unit)
 
 type AjaxRequest a =
   { method :: String
@@ -280,4 +278,4 @@ foreign import _ajax
    . Fn2
       (String -> String -> ResponseHeader)
       (AjaxRequest a)
-      (AC.EffectFnAff (AffjaxResponseT Foreign))
+      (AC.EffectFnAff (AffjaxResponse Foreign))

src/Network/HTTP/Affjax/Request.purs

@@ -10,20 +10,38 @@ import Web.DOM.Document (Document)
 import Web.File.Blob (Blob)
 import Web.XHR.FormData (FormData)
 
-data RequestContent
+data Request
   = ArrayView (forall r. (forall a. A.ArrayView a -> r) -> r)
-  | BlobRequest Blob
-  | DocumentRequest Document
-  | StringRequest String
-  | FormDataRequest FormData
-  | FormURLEncodedRequest FormURLEncoded
-  | JsonRequest Json
-
-arrayView :: forall a. A.ArrayView a -> RequestContent
+  | Blob Blob
+  | Document Document
+  | String String
+  | FormData FormData
+  | FormURLEncoded FormURLEncoded
+  | Json Json
+
+arrayView :: forall a. A.ArrayView a -> Request
 arrayView av = ArrayView \f -> f av
 
-defaultMediaType :: RequestContent -> Maybe MediaType
-defaultMediaType = case _ of
-  FormURLEncodedRequest _ -> Just applicationFormURLEncoded
-  JsonRequest _ -> Just applicationJSON
+blob :: Blob -> Request
+blob = Blob
+
+document :: Document -> Request
+document = Document
+
+string :: String -> Request
+string = String
+
+formData :: FormData -> Request
+formData = FormData
+
+formURLEncoded :: FormURLEncoded -> Request
+formURLEncoded = FormURLEncoded
+
+json :: Json -> Request
+json = Json
+
+toMediaType :: Request -> Maybe MediaType
+toMediaType = case _ of
+  FormURLEncoded _ -> Just applicationFormURLEncoded
+  Json _ -> Just applicationJSON
   _ -> Nothing

src/Network/HTTP/Affjax/Response.purs

@@ -10,44 +10,44 @@ import Data.MediaType.Common (applicationJSON)
 import Web.DOM.Document (Document)
 import Web.File.Blob (Blob)
 
-data AffjaxResponse a
-  = ArrayBufferResponse (forall f. f ArrayBuffer -> f a)
-  | BlobResponse (forall f. f Blob -> f a)
-  | DocumentResponse (forall f. f Document -> f a)
-  | JSONResponse (forall f. f Json -> f a)
-  | StringResponse (forall f. f String -> f a)
-  | IgnoredResponse (forall f. f Unit -> f a)
+data Response a
+  = ArrayBuffer (forall f. f ArrayBuffer -> f a)
+  | Blob (forall f. f Blob -> f a)
+  | Document (forall f. f Document -> f a)
+  | Json (forall f. f Json -> f a)
+  | String (forall f. f String -> f a)
+  | Ignore (forall f. f Unit -> f a)
 
-arrayBuffer :: AffjaxResponse ArrayBuffer
-arrayBuffer = ArrayBufferResponse identity
+arrayBuffer :: Response ArrayBuffer
+arrayBuffer = ArrayBuffer identity
 
-blob :: AffjaxResponse Blob
-blob = BlobResponse identity
+blob :: Response Blob
+blob = Blob identity
 
-document :: AffjaxResponse Document
-document = DocumentResponse identity
+document :: Response Document
+document = Document identity
 
-json :: AffjaxResponse Json
-json = JSONResponse identity
+json :: Response Json
+json = Json identity
 
-string :: AffjaxResponse String
-string = StringResponse identity
+string :: Response String
+string = String identity
 
-ignored :: AffjaxResponse Unit
-ignored = IgnoredResponse identity
+ignore :: Response Unit
+ignore = Ignore identity
 
-responseTypeToString :: forall a. AffjaxResponse a -> String
-responseTypeToString =
+toResponseType :: forall a. Response a -> String
+toResponseType =
   case _ of
-    ArrayBufferResponse _ -> "arraybuffer"
-    BlobResponse _ -> "blob"
-    DocumentResponse _ -> "document"
-    JSONResponse _ -> "text" -- IE doesn't support "json" responseType
-    StringResponse _ -> "text"
-    IgnoredResponse _ -> "text"
-
-responseTypeToMediaType :: forall a. AffjaxResponse a -> Maybe MediaType
-responseTypeToMediaType =
+    ArrayBuffer _ -> "arraybuffer"
+    Blob _ -> "blob"
+    Document _ -> "document"
+    Json _ -> "text" -- IE doesn't support "json" responseType
+    String _ -> "text"
+    Ignore _ -> ""
+
+toMediaType :: forall a. Response a -> Maybe MediaType
+toMediaType =
   case _ of
-    JSONResponse _ -> Just applicationJSON
+    Json _ -> Just applicationJSON
     _ -> Nothing