Merge pull request haskell-github#399 from hercules-ci/ownertype-bot

phadej · web-flow · commit 7c0070bbd7da · 2019-09-30T00:01:54.000+03:00
OwnerType: add OwnerBot
diff --git a/fixtures/user-bot.json b/fixtures/user-bot.json
@@ -0,0 +1,32 @@
+{
+  "login": "mike-burns",
+  "id": 4550,
+  "avatar_url": "https://avatars.githubusercontent.com/u/4550?v=3",
+  "gravatar_id": "",
+  "url": "https://api.github.com/users/mike-burns",
+  "html_url": "https://github.com/mike-burns",
+  "followers_url": "https://api.github.com/users/mike-burns/followers",
+  "following_url": "https://api.github.com/users/mike-burns/following{/other_user}",
+  "gists_url": "https://api.github.com/users/mike-burns/gists{/gist_id}",
+  "starred_url": "https://api.github.com/users/mike-burns/starred{/owner}{/repo}",
+  "subscriptions_url": "https://api.github.com/users/mike-burns/subscriptions",
+  "organizations_url": "https://api.github.com/users/mike-burns/orgs",
+  "repos_url": "https://api.github.com/users/mike-burns/repos",
+  "events_url": "https://api.github.com/users/mike-burns/events{/privacy}",
+  "received_events_url": "https://api.github.com/users/mike-burns/received_events",
+  "type": "Bot",
+  "site_admin": false,
+  "name": "Mike Burns",
+  "company": "thoughtbot",
+  "blog": "http://mike-burns.com/",
+  "location": "Stockholm, Sweden",
+  "email": "mburns@thoughtbot.com",
+  "hireable": true,
+  "bio": null,
+  "public_repos": 35,
+  "public_gists": 32,
+  "followers": 171,
+  "following": 0,
+  "created_at": "2008-04-03T17:54:24Z",
+  "updated_at": "2015-10-02T16:53:25Z"
+}
diff --git a/github.cabal b/github.cabal
@@ -48,6 +48,7 @@ extra-source-files:
   fixtures/pull-request-review-requested.json
   fixtures/user-organizations.json
   fixtures/user.json
+  fixtures/user-bot.json
 
 source-repository head
   type:     git
diff --git a/spec/GitHub/UsersSpec.hs b/spec/GitHub/UsersSpec.hs
@@ -41,6 +41,10 @@ spec = do
       let userInfo = eitherDecodeStrict $(embedFile "fixtures/user.json")
       userLogin (fromRightS userInfo) `shouldBe` "mike-burns"
 
+    it "decodes user-bot json" $ do
+      let userInfo = eitherDecodeStrict $(embedFile "fixtures/user-bot.json")
+      userLogin (fromRightS userInfo) `shouldBe` "mike-burns"
+
     it "returns information about the user" $ withAuth $ \auth -> do
       userInfo <- userInfoFor' (Just auth) "mike-burns"
       userLogin (fromRightS userInfo) `shouldBe` "mike-burns"
diff --git a/src/GitHub/Data/Definitions.hs b/src/GitHub/Data/Definitions.hs
@@ -32,7 +32,7 @@ data Error
 instance E.Exception Error
 
 -- | Type of the repository owners.
-data OwnerType = OwnerUser | OwnerOrganization
+data OwnerType = OwnerUser | OwnerOrganization | OwnerBot
     deriving (Eq, Ord, Enum, Bounded, Show, Read, Generic, Typeable, Data)
 
 instance NFData OwnerType
@@ -77,7 +77,7 @@ data User = User
     { userId          :: !(Id User)
     , userLogin       :: !(Name User)
     , userName        :: !(Maybe Text)
-    , userType        :: !OwnerType  -- ^ Should always be 'OwnerUser'
+    , userType        :: !OwnerType  -- ^ Should always be 'OwnerUser' or 'OwnerBot'
     , userCreatedAt   :: !UTCTime
     , userPublicGists :: !Int
     , userAvatarUrl   :: !URL
@@ -137,6 +137,7 @@ instance FromJSON OwnerType where
     parseJSON = withText "OwnerType" $ \t -> case T.toLower t of
         "user"         -> pure $ OwnerUser
         "organization" -> pure $ OwnerOrganization
+        "bot"          -> pure $ OwnerBot
         _              -> fail $ "Unknown OwnerType: " <> T.unpack t
 
 instance FromJSON SimpleUser where
@@ -205,7 +206,7 @@ parseOrganization obj = Organization
     <*> obj .: "created_at"
 
 instance FromJSON User where
-    parseJSON = mfilter ((== OwnerUser) . userType) . withObject "User" parseUser
+    parseJSON = mfilter ((/= OwnerOrganization) . userType) . withObject "User" parseUser
 
 instance FromJSON Organization where
     parseJSON = withObject "Organization" parseOrganization
@@ -215,6 +216,7 @@ instance FromJSON Owner where
         t <- obj .: "type"
         case t of
             OwnerUser         -> Owner . Left <$> parseUser obj
+            OwnerBot          -> Owner . Left <$> parseUser obj
             OwnerOrganization -> Owner . Right <$> parseOrganization obj
 
 -- | Filter members returned in the list.
