Leanpub.Wreq

The Leanpub monad

newtype Leanpub a

There are two ways to run a Leanpub action:

1. Create a Context and then apply the newtyped Context -> IO a function directly.
2. Create a Config and then apply the runLeanpub function. This approach is likely more convenient, because it can do some things automatically like creating the Session and reading your API key from a file.

Constructors

Leanpub (Context -> IO a)

Instances

Monad Leanpub

Defined in Leanpub.Wreq

Methods

(>>=) :: Leanpub a -> (a -> Leanpub b) -> Leanpub b

(>>) :: Leanpub a -> Leanpub b -> Leanpub b

return :: a -> Leanpub a

Functor Leanpub

Defined in Leanpub.Wreq

Methods

fmap :: (a -> b) -> Leanpub a -> Leanpub b

(<$) :: a -> Leanpub b -> Leanpub a

MonadFail Leanpub

Defined in Leanpub.Wreq

Methods

fail :: String -> Leanpub a

Applicative Leanpub

Defined in Leanpub.Wreq

Methods

pure :: a -> Leanpub a

(<*>) :: Leanpub (a -> b) -> Leanpub a -> Leanpub b

liftA2 :: (a -> b -> c) -> Leanpub a -> Leanpub b -> Leanpub c

(*>) :: Leanpub a -> Leanpub b -> Leanpub b

(<*) :: Leanpub a -> Leanpub b -> Leanpub a

MonadIO Leanpub

Defined in Leanpub.Wreq

Methods

liftIO :: IO a -> Leanpub a

data Context

Constructors

Context

Fields

• contextSession :: Session
• contextKeyMaybe :: Maybe ApiSecretKey
• contextRandom :: GenIO

Configuration

runLeanpub :: Config -> Leanpub a -> IO a

data Config

Construct a Config by using <> to combine any of the following:

• Either configKey or configKeyFile (not both)
• Optionally, configSession

Then use the config as the first argument to the runLeanpub function.

Instances

Semigroup Config

Defined in Leanpub.Wreq

Methods

(<>) :: Config -> Config -> Config

sconcat :: NonEmpty Config -> Config

stimes :: Integral b => b -> Config -> Config

Monoid Config

Defined in Leanpub.Wreq

Methods

mempty :: Config

mappend :: Config -> Config -> Config

mconcat :: [Config] -> Config

configSession :: Session -> Config

configKey :: ApiSecretKey -> Config

configKeyFile :: FilePath -> Config

Leanpub actions

getBookSummary :: BookSlug -> Leanpub Value

getBookSalesSummary :: BookSlug -> Leanpub Value

createFreeBookCoupon

Arguments

:: BookSlug

What book does the coupon give away?

-> CouponCode

The secret that the user needs to have to redeem the coupon

-> CouponMaxUses

How many times can each coupon be used?

-> Maybe CouponNote

An optional note to remind you what the coupon is for, why it was issued, etc.

-> Leanpub Value

createManyFreeBookCoupons

Arguments

:: (CouponCode -> IO ())

Action to perform after creating each coupon, e.g. perhaps print for use in a REPL.

-> Natural

How many coupons?

-> BookSlug

What book does the coupon give away?

-> CouponMaxUses

How many times can each coupon be used?

-> Maybe CouponNote

An optional note to remind you what the coupon is for, why it was issued, etc.

-> Leanpub ()

Wreq

wreqGet :: Path -> Extension -> [QueryParam] -> Leanpub WreqResponse

wreqPost :: Path -> Extension -> [FormParam] -> Leanpub WreqResponse

wreqGetAeson :: Path -> [QueryParam] -> Leanpub Value

wreqPostAeson :: Path -> [FormParam] -> Leanpub Value

wreqPostAeson_ :: Path -> [FormParam] -> Leanpub ()

type WreqResponse = Response ByteString

type Path = [Text]

type Extension = Text

type QueryParam = (Text, Text)

data FormParam where

A key/value pair for an application/x-www-form-urlencoded POST request body.

Constructors

(:=) :: forall v. FormValue v => ByteString -> v -> FormParam infixr 3

Instances

Show FormParam

Defined in Network.Wreq.Internal.Types

Methods

showsPrec :: Int -> FormParam -> ShowS

show :: FormParam -> String

showList :: [FormParam] -> ShowS

data Session

A session that spans multiple requests. This is responsible for cookie management and TCP connection reuse.

Instances

Show Session

Defined in Network.Wreq.Internal.Types

Methods

showsPrec :: Int -> Session -> ShowS

show :: Session -> String

showList :: [Session] -> ShowS

newAPISession :: IO Session

Create a session.

This uses the default session manager settings, but does not manage cookies. It is intended for use with REST-like HTTP-based APIs, which typically do not use cookies.

Since: wreq-0.5.2.0