Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement organization membership endpoint #487

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/GitHub.hs
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ module GitHub (
membersOfWithR,
isMemberOfR,
orgInvitationsR,
orgMembershipR,
-- ** Outside Collaborators
-- | See <https://developer.github.com/v3/orgs/outside_collaborators/>
--
Expand Down
57 changes: 57 additions & 0 deletions src/GitHub/Data/Definitions.hs
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,63 @@ type QueryString = [(BS.ByteString, Maybe BS.ByteString)]
-- | Count of elements
type Count = Int



data MembershipRole
= MembershipRoleMember
| MembershipRoleAdmin
| MembershipRoleBillingManager
deriving
(Eq, Ord, Show, Enum, Bounded, Generic, Typeable, Data)

instance NFData MembershipRole where rnf = genericRnf
instance Binary MembershipRole

instance FromJSON MembershipRole where
parseJSON = withText "MembershipRole" $ \t -> case T.toLower t of
"member" -> pure MembershipRoleMember
"admin" -> pure MembershipRoleAdmin
"billing_manager" -> pure MembershipRoleBillingManager
_ -> fail $ "Unknown MembershipRole: " <> T.unpack t

data MembershipState
= MembershipPending
| MembershipActive
deriving (Show, Data, Typeable, Eq, Ord, Generic)

instance NFData MembershipState where rnf = genericRnf
instance Binary MembershipState

instance FromJSON MembershipState where
parseJSON = withText "MembershipState" $ \t -> case T.toLower t of
"active" -> pure MembershipActive
"pending" -> pure MembershipPending
_ -> fail $ "Unknown MembershipState: " <> T.unpack t


data Membership = Membership
{ membershipUrl :: !URL
, membershipState :: !MembershipState
, membershipRole :: !MembershipRole
, membershipOrganizationUrl :: !URL
, membershipOrganization :: !SimpleOrganization
, membershipUser :: !SimpleUser
}
deriving (Show, Data, Typeable, Eq, Ord, Generic)

instance NFData Membership where rnf = genericRnf
instance Binary Membership

instance FromJSON Membership where
parseJSON = withObject "Membership" $ \o -> Membership
<$> o .: "url"
<*> o .: "state"
<*> o .: "role"
<*> o .: "organization_url"
<*> o .: "organization"
<*> o .: "user"


-------------------------------------------------------------------------------
-- IssueNumber
-------------------------------------------------------------------------------
Expand Down
8 changes: 8 additions & 0 deletions src/GitHub/Endpoints/Organizations/Members.hs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module GitHub.Endpoints.Organizations.Members (
membersOfWithR,
isMemberOfR,
orgInvitationsR,
orgMembershipR,
module GitHub.Data,
) where

Expand Down Expand Up @@ -51,3 +52,10 @@ isMemberOfR user org =
-- See <https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations>
orgInvitationsR :: Name Organization -> FetchCount -> Request 'RA (Vector Invitation)
orgInvitationsR org = pagedQuery ["orgs", toPathPart org, "invitations"] []

-- | Get user membership information in an organization
--
-- See <https://docs.github.com/en/rest/orgs/members#get-organization-membership-for-a-user>
orgMembershipR :: Name User -> Name Organization -> Request 'RA Membership
orgMembershipR user org =
Query [ "orgs", toPathPart org, "memberships", toPathPart user ] []