Some cleanups

Author: phadej

CHANGELOG.md

@@ -1,3 +1,12 @@
+## Changes for 0.19.1
+
+- Add ratelimit endpoint
+  [#315](https://github.com/phadej/github/pull/315/)
+- Add some deployment endoints
+  [#330](https://github.com/phadej/github/pull/330/)
+- Add webhook installation events
+  [#329](https://github.com/phadej/github/pull/330/)
+
 ## Changes for 0.19
 
 - Fix issue event type enumeration

CONTRIBUTING.md

@@ -1,26 +1,30 @@
 Contributing
-------------
+============
 
-When adding a new public function
-=================================
+When adding a new endpoint
+--------------------------
 
-* Write a test (or sample) in the appropriate place in the samples/ directory.
-* Implement the function.
-* Submit a pull request.
+```haskell
+-- | The title, as in the GitHub API docs.
+-- <url to the docs>
+endpointR :: Request k EndpointResult
+endpointR = query ["endpoint"] []
+```
 
-When modifying an existing data structure
-=========================================
+For example:
 
-* Find all samples that use the data structure and make sure they run.
-* Modify the data structure.
-* Modify the samples as appropriate.
-* Make sure all relevant samples still run.
-* Submit a pull request.
+```haskell
+-- | Get your current rate limit status.
+-- <https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status>
+rateLimitR :: Request k RateLimit
+rateLimitR = query ["rate_limit"] []
+```
 
-Submitting a pull request
-=========================
+Also re-export endpoints from the top `GitHub` module. *Note:* only `R` variants, not `IO`.
 
-* If your code is radically different from existing functionality, give
-some explanation for how it fits in this library.
-* Create a topic branch on your fork.
-* Rebase and squash your commits.
+Miscellaneous
+-------------
+
+* **Don't** edit `CHANGELOG.md`, it will only conflict.
+* **Don't** edit package version.
+* The codebase is not uniform in style, don't make it worse.

src/GitHub.hs

@@ -359,8 +359,7 @@ module GitHub (
 
     -- ** Rate Limit
     -- | See <https://developer.github.com/v3/rate_limit/>
-    rateLimit,
-    rateLimit',
+    rateLimitR,
 
     -- * Data definitions
     module GitHub.Data,

src/GitHub/Data/RateLimit.hs

@@ -1,5 +1,3 @@
-{-# LANGUAGE RecordWildCards #-}
-
 -----------------------------------------------------------------------------
 -- |
 -- License     :  BSD-3-Clause
@@ -10,31 +8,36 @@ module GitHub.Data.RateLimit where
 import GitHub.Internal.Prelude
 import Prelude ()
 
+data Limits = Limits
+    { limitsMax       :: !Int
+    , limitsRemaining :: !Int
+    , limitsReset     :: !Int -- TODO: change to proper type
+    }
+  deriving (Show, Data, Typeable, Eq, Ord, Generic)
+
+instance NFData Limits where rnf = genericRnf
+instance Binary Limits
+
+instance FromJSON Limits where
+    parseJSON = withObject "Limits" $ \obj -> Limits
+        <$> obj .: "limit"
+        <*> obj .: "remaining"
+        <*> obj .: "reset"
 
 data RateLimit = RateLimit
-    { coreLimit       :: !Int
-    , coreRemaining   :: !Int
-    , coreReset       :: !Int
-    , searchLimit     :: !Int
-    , searchRemaining :: !Int
-    , searchReset     :: !Int
+    { rateLimitCore    :: Limits
+    , rateLimitSearch  :: Limits
+    , rateLimitGraphQL :: Limits
     }
   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{..}
+    parseJSON = withObject "RateLimit" $ \obj -> do
+        resources <- obj .: "resources"
+        RateLimit
+            <$> resources .: "core"
+            <*> resources .: "search"
+            <*> resources .: "graphql"

src/GitHub/Endpoints/RateLimit.hs

@@ -5,9 +5,10 @@
 --
 -- The Github RateLimit API, as described at
 -- <http://developer.github.com/v3/rate_limit/>.
-module GitHub.Endpoints.RateLimit(
-    rateLimit',
+module GitHub.Endpoints.RateLimit (
+    rateLimitR,
     rateLimit,
+    rateLimit',
     module GitHub.Data,
     ) where
 
@@ -16,19 +17,17 @@ 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
 
+-- | Get your current rate limit status.
+-- <https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status>
 rateLimitR :: Request k RateLimit
 rateLimitR = query ["rate_limit"] []