Add support for RateLimit API call

Author: santolucito

github.cabal

@@ -65,6 +65,7 @@ Library
     GADTs
     KindSignatures
     StandaloneDeriving
+    RecordWildCards 
   exposed-modules:
     GitHub
     GitHub.Internal.Prelude
@@ -87,6 +88,7 @@ Library
     GitHub.Data.Name
     GitHub.Data.Options
     GitHub.Data.PullRequests
+    GitHub.Data.RateLimit
     GitHub.Data.Releases
     GitHub.Data.Repos
     GitHub.Data.Request
@@ -117,6 +119,7 @@ Library
     GitHub.Endpoints.PullRequests
     GitHub.Endpoints.PullRequests.Reviews
     GitHub.Endpoints.PullRequests.Comments
+    GitHub.Endpoints.RateLimit
     GitHub.Endpoints.Repos
     GitHub.Endpoints.Repos.Collaborators
     GitHub.Endpoints.Repos.Comments

src/GitHub.hs

@@ -344,6 +344,11 @@ module GitHub (
     createStatusR,
     statusesForR,
     statusForR,
+    
+    -- ** Rate Limit
+    -- | See <https://developer.github.com/v3/rate_limit/>
+    rateLimit,
+    rateLimit',
 
     -- * Data definitions
     module GitHub.Data,
@@ -372,6 +377,7 @@ import GitHub.Endpoints.Organizations.Teams
 import GitHub.Endpoints.PullRequests
 import GitHub.Endpoints.PullRequests.Reviews
 import GitHub.Endpoints.PullRequests.Comments
+import GitHub.Endpoints.RateLimit
 import GitHub.Endpoints.Repos
 import GitHub.Endpoints.Repos.Collaborators
 import GitHub.Endpoints.Repos.Comments

src/GitHub/Data.hs

@@ -47,6 +47,7 @@ module GitHub.Data (
     module GitHub.Data.Milestone,
     module GitHub.Data.Options,
     module GitHub.Data.PullRequests,
+    module GitHub.Data.RateLimit,
     module GitHub.Data.Releases,
     module GitHub.Data.Repos,
     module GitHub.Data.Request,
@@ -79,6 +80,7 @@ import GitHub.Data.Milestone
 import GitHub.Data.Name
 import GitHub.Data.Options
 import GitHub.Data.PullRequests
+import GitHub.Data.RateLimit
 import GitHub.Data.Releases
 import GitHub.Data.Repos
 import GitHub.Data.Request

src/GitHub/Data/RateLimit.hs

@@ -0,0 +1,40 @@
+{-# LANGUAGE RecordWildCards #-}
+
+-----------------------------------------------------------------------------
+-- |
+-- License     :  BSD-3-Clause
+-- Maintainer  :  Oleg Grenrus <oleg.grenrus@iki.fi>
+--
+module GitHub.Data.RateLimit where
+
+import GitHub.Internal.Prelude
+import Prelude ()
+
+
+data RateLimit = RateLimit
+    { coreLimit       :: !Int
+    , coreRemaining   :: !Int
+    , coreReset       :: !Int
+    , searchLimit     :: !Int
+    , searchRemaining :: !Int
+    , searchReset     :: !Int
+    }
+  deriving (Show, Data, Typeable, Eq, Ord, Generic)
+
+instance NFData RateLimit where rnf = genericRnf
+instance Binary RateLimit
+
+instance FromJSON RateLimit where
+    parseJSON = withObject "RateLimit" $ \o -> do
+        resources <- o .: "resources"
+        core <- resources .: "core"
+        coreLimit <- core .: "limit"
+        coreRemaining <- core .: "remaining"
+        coreReset <- core .: "reset"
+
+        search <- resources .: "search"
+        searchLimit <- search .: "limit"
+        searchRemaining <- search .: "remaining"
+        searchReset <- search .: "reset"
+
+        return RateLimit{..}

src/GitHub/Endpoints/RateLimit.hs

@@ -0,0 +1,34 @@
+-----------------------------------------------------------------------------
+-- |
+-- License     :  BSD-3-Clause
+-- Maintainer  :  Oleg Grenrus <oleg.grenrus@iki.fi>
+--
+-- The Github RateLimit API, as described at
+-- <http://developer.github.com/v3/rate_limit/>.
+module GitHub.Endpoints.RateLimit(
+    rateLimit',
+    rateLimit,
+    module GitHub.Data,
+    ) where
+
+import GitHub.Data
+import GitHub.Internal.Prelude
+import GitHub.Request
+import Prelude ()
+
+import qualified Data.Text.Encoding as TE
+
+-- | Get your current rate limit status (Note: Accessing this endpoint does not count against your rate limit.)
+-- With authentication.
+rateLimit' :: Maybe Auth -> IO (Either Error RateLimit)
+rateLimit' auth = executeRequestMaybe auth rateLimitR
+
+-- | Get your current rate limit status (Note: Accessing this endpoint does not count against your rate limit.)
+-- Without authentication.
+--
+-- > searchRepos "q=a in%3Aname language%3Ahaskell created%3A>2013-10-01&per_page=100"
+rateLimit :: IO (Either Error RateLimit)
+rateLimit = rateLimit' Nothing
+
+rateLimitR :: Request k RateLimit
+rateLimitR = query ["rate_limit"] []