-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A thin wrapper for the Hyperpublic API
--   
--   A thin wrapper for the Hyperpublic API, which uses
--   <tt>http-enumerator</tt> to fetch results and <tt>aeson</tt> to return
--   them as JSON.
@package hyperpublic
@version 0.1.0


-- | A thin wrapper for the Hyperpublic API, which uses
--   <tt>http-enumerator</tt> to fetch results and <tt>aeson</tt> to return
--   them as JSON. Full documentation for the Hyperpublic API can be found
--   at <a>http://developer.hyperpublic.com/</a>.
--   
--   The exposed functions of these modules follow a simple pattern: each
--   takes an <a>HpAuth</a> record as well as either a <a>ByteString</a>
--   (for <tt>show</tt> methods on the API) or a
--   <tt>Network.HTTP.Types.SimpleQuery</tt> (for <tt>find</tt> or
--   <tt>create</tt> methods on the API).
--   
--   Some basic usage examples follow. (This code is included in the
--   distribution as <tt>Examples.hs</tt>. Call <tt>cabal-install</tt> with
--   <tt>-f example</tt> and it will build an executable called
--   <tt>hyperpublic-example</tt>.) Usage questions may be posted on the
--   Hyperpublic API Developers mailing list at
--   <a>http://groups.google.com/group/hyperpublic-api-developers</a>.
--   
--   <pre>
--   {-# LANGUAGE OverloadedStrings #-}
--   
--   module Main where
--   
--   import Data.Aeson
--   import Data.ByteString.Char8 ()
--   import qualified Data.Map as M
--   import Data.Maybe
--   import Data.Text
--   import qualified Data.Vector as V
--   
--   import Web.Hyperpublic
--   import qualified Web.Hyperpublic.Places as Places
--   import qualified Web.Hyperpublic.Offers as Offers
--   
--   
--   -- Sequence the two examples.
--   main :: IO ()
--   main = placeNamesNearHq &gt;&gt; offerDescr
--   
--   
--   -- Find places near Hyperpublic HQ and print the name of each.
--   placeNamesNearHq :: IO ()
--   placeNamesNearHq =
--       let json = Places.find auth [( "address"
--                                    , "416 W 13th St, New York, NY 10014" )]
--       in json &gt;&gt;= putStrLn . show . getNames
--     where
--       getNames (Array arr) = mapMaybe getName $ V.toList arr
--       getName (Object obj) = getTextField obj "display_name"
--   
--   -- Find the offer with id 4e90567c297a200001008db9 and print its description.
--   offerDescr :: IO ()
--   offerDescr =
--       let json = Offers.show auth "4e90567c297a200001008db9"
--       in json &gt;&gt;= putStrLn . show . getDescr
--     where
--       getDescr (Object obj) = maybe "" id $ getTextField obj "description"
--   
--   
--   -- Create an authorization record. Get your own credentials at
--   -- http://www.hyperpublic.com/registerapi
--   auth :: HpAuth
--   auth = HpAuth { clientId = "8UufhI6bCKQXKMBn7AUWO67Yq6C8RkfD0BGouTke"
--                 , clientSecret = "zdoROY5XRN0clIWsEJyKzHedSK4irYee8jpnOXaP" }
--   
--   -- Extract a text field from an 'Data.Aeson.Object'.
--   getTextField :: Object -&gt; Text -&gt; Maybe Text
--   getTextField obj txt = M.lookup txt obj &gt;&gt;= resultToMaybe . fromJSON
--     where
--       resultToMaybe (Success a) = Just a
--       resultToMaybe (Error _) = Nothing
--   </pre>
module Web.Hyperpublic

-- | A record for passing around API authorization credentials.
data HpAuth
HpAuth :: ByteString -> ByteString -> HpAuth
clientId :: HpAuth -> ByteString
clientSecret :: HpAuth -> ByteString
instance Show HpAuth


-- | Wrappers for calling the methods of the Hyperpublic Places+ endpoint.
module Web.Hyperpublic.Places

-- | Call the show method of the Places+ endpoint. API documentation at
--   <a>http://developer.hyperpublic.com/places/show-a-place/</a>
show :: HpAuth -> ByteString -> IO Value

-- | Call the find method of the Places+ endpoint. API documentation at
--   <a>http://developer.hyperpublic.com/offers/find-offers/</a>
find :: HpAuth -> SimpleQuery -> IO Value

-- | Call the create method of the Places+ endpoint. API documentation at
--   <a>http://developer.hyperpublic.com/places/create-a-place/</a>
create :: HpAuth -> SimpleQuery -> IO Value


-- | Wrappers for calling the methods of the Hyperpublic Geo Deals and
--   Events endpoint.
module Web.Hyperpublic.Offers

-- | Call the show method of the Geo Deals and Events endpoint. API
--   documentation at
--   <a>http://developer.hyperpublic.com/offers/show-an-offer/</a>
show :: HpAuth -> ByteString -> IO Value

-- | Call the find method of the Geo Deals and Events endpoint. API
--   documentation at
--   <a>http://developer.hyperpublic.com/offers/find-offers/</a>
find :: HpAuth -> SimpleQuery -> IO Value


-- | Wrappers for calling the methods of the Hyperpublic Categories
--   endpoint.
module Web.Hyperpublic.Categories

-- | Call the show method of the Categories endpoint. API documentation at
--   <a>http://developer.hyperpublic.com/categories/show-category/</a>
show :: HpAuth -> ByteString -> IO Value

-- | Call the find method of the Categories endpoint, which simply lists
--   the full category hierarchy. (The endpoint does not currently support
--   more specific queries.) API documentation at
--   <a>http://developer.hyperpublic.com/categories/all-categories/</a>
find :: HpAuth -> IO Value