cuedo · kvanbere · Oct 3, 2021 · Oct 3, 2021
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 * The invitation and membership fields were made optional for `OrganizationEvent` (resolves #37)
 * The maintaining sponsor [onrock.online](https://onrock.online) has rebranded to [Cuedo Business Solutions](https://cuedo.com.au)
+* Support for marketplace purchase event (by Alistair Burrowes, resolves #46)
 
 # 0.15.0
 

diff --git a/fixtures/marketplace-purchase-event.json b/fixtures/marketplace-purchase-event.json
@@ -0,0 +1,80 @@
+{
+  "action": "changed",
+  "effective_date": "2017-10-25T00:00:00+00:00",
+  "sender": {
+    "login": "username",
+    "id": 3877742,
+    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+    "avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/username",
+    "html_url": "https://github.com/username",
+    "followers_url": "https://api.github.com/users/username/followers",
+    "following_url": "https://api.github.com/users/username/following{/other_user}",
+    "gists_url": "https://api.github.com/users/username/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/username/subscriptions",
+    "organizations_url": "https://api.github.com/users/username/orgs",
+    "repos_url": "https://api.github.com/users/username/repos",
+    "events_url": "https://api.github.com/users/username/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/username/received_events",
+    "type": "User",
+    "site_admin": true,
+    "email": "username@email.com"
+  },
+  "marketplace_purchase": {
+    "account": {
+      "type": "Organization",
+      "id": 18404719,
+      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+      "login": "username",
+      "organization_billing_email": "username@email.com"
+    },
+    "billing_cycle": "monthly",
+    "unit_count": 10,
+    "on_free_trial": false,
+    "free_trial_ends_on": null,
+    "next_billing_date": "2017-11-05T00:00:00+00:00",
+    "plan": {
+      "id": 435,
+      "name": "Basic Plan",
+      "description": "Basic Plan",
+      "monthly_price_in_cents": 1000,
+      "yearly_price_in_cents": 10000,
+      "price_model": "per-unit",
+      "has_free_trial": true,
+      "unit_name": "seat",
+      "bullets": [
+        "Is Basic",
+        "Because Basic "
+      ]
+    }
+  },
+  "previous_marketplace_purchase": {
+    "account": {
+      "type": "Organization",
+      "id": 18404719,
+      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+      "login": "username",
+      "organization_billing_email": "username@email.com"
+    },
+    "billing_cycle": "monthly",
+    "on_free_trial": false,
+    "free_trial_ends_on": null,
+    "unit_count": 1,
+    "plan": {
+      "id": 435,
+      "name": "Basic Plan",
+      "description": "Basic Plan",
+      "monthly_price_in_cents": 1000,
+      "yearly_price_in_cents": 10000,
+      "price_model": "per-unit",
+      "has_free_trial": true,
+      "unit_name": "seat",
+      "bullets": [
+        "Is Basic",
+        "Because Basic "
+      ]
+    }
+  }
+}
diff --git a/spec/DecodeEventsSpec.hs b/spec/DecodeEventsSpec.hs
@@ -53,6 +53,7 @@ spec = do
   it "can decode IssueCommentEvent"       $ fixtureShouldMatch "fixtures/issue-comment-event.json" issueCommentEventFixture
   it "can decode IssuesEvent"             $ fixtureShouldMatch "fixtures/issues-event.json" issuesEventFixture
   it "can decode LabelEvent"              $ fixtureShouldMatch "fixtures/label-event.json" labelEventFixture
+  it "can decode MarketplacePurchaseEvent" $ fixtureShouldMatch "fixtures/marketplace-purchase-event.json" marketplacePurchaseEventFixture
   it "can decode MemberEvent"             $ fixtureShouldMatch "fixtures/member-event.json" memberEventFixture
   it "can decode MembershipEvent"         $ fixtureShouldMatch "fixtures/membership-event.json" membershipEventFixture
   it "can decode MilestoneEvent"          $ fixtureShouldMatch "fixtures/milestone-event.json" milestoneEventFixture
@@ -2174,6 +2175,90 @@ labelEventFixture = LabelEvent
           }
     }
 
+marketplacePurchaseEventFixture :: MarketplacePurchaseEvent
+marketplacePurchaseEventFixture = MarketplacePurchaseEvent
+    { evMarketplacePurchaseAction = MarketplacePurchaseChangedAction
+    , evMarketplacePurchaseEffectiveDate = read "2017-10-25 00:00:00 UTC"
+    , evMarketplacePurchaseSender =
+        HookUser
+          { whUserLogin = "username"
+          , whUserId = 3877742
+          , whUserNodeId = "MDEyOk9yZ2FuaXphdGlvbjE="
+          , whUserAvatarUrl = URL "https://avatars2.githubusercontent.com/u/3877742?v=4"
+          , whUserGravatarId = URL ""
+          , whUserUrl = URL "https://api.github.com/users/username"
+          , whUserHtmlUrl = URL "https://github.com/username"
+          , whUserFollowersUrl = URL "https://api.github.com/users/username/followers"
+          , whUserFollowingUrl = URL "https://api.github.com/users/username/following{/other_user}"
+          , whUserGistsUrl = URL "https://api.github.com/users/username/gists{/gist_id}"
+          , whUserStarredUrl = URL "https://api.github.com/users/username/starred{/owner}{/repo}"
+          , whUserSubscriptionsUrl = URL "https://api.github.com/users/username/subscriptions"
+          , whUserOrganizationsUrl = URL "https://api.github.com/users/username/orgs"
+          , whUserReposUrl = URL "https://api.github.com/users/username/repos"
+          , whUserEventsUrl = URL "https://api.github.com/users/username/events{/privacy}"
+          , whUserReceivedEventsUrl = URL "https://api.github.com/users/username/received_events"
+          , whUserType = OwnerUser
+          , whUserIsAdminOfSite = True
+          }
+    , evMarketplacePurchaseNew =
+        HookMarketplacePurchase
+          { whMarketplacePurchaseAccount =
+              HookMarketplaceAccount
+                { whMarketplaceAccountType = OwnerOrganization
+                , whMarketplaceAccountId = 18404719
+                , whMarketplaceAccountNodeId = "MDEyOk9yZ2FuaXphdGlvbjE="
+                , whMarketplaceAccountLogin = "username"
+                , whMarketplaceAccountOrganizationBillingEmail = Just "username@email.com"
+              }
+          , whMarketplacePurchaseBillingCycle = Just HookMarketplaceBillingCycleMonthly
+          , whMarketplacePurchaseUnitCount = 10
+          , whMarketplacePurchaseOnFreeTrial = False
+          , whMarketplacePurchaseFreeTrialEndsOn = Nothing
+          , whMarketplacePurchaseNextBillingDate = Just (read "2017-11-05 00:00:00 UTC")
+          , whMarketplacePurchasePlan =
+              HookMarketplacePlan
+                { whMarketplacePlanId = 435
+                , whMarketplacePlanName = "Basic Plan"
+                , whMarketplacePlanDescription = "Basic Plan"
+                , whMarketplacePlanMonthlyPriceInCents = 1000
+                , whMarketplacePlanYearlyPriceInCents = 10000
+                , whMarketplacePlanPriceModel = HookMarketplacePlanPriceModelPerUnit
+                , whMarketplacePlanHasFreeTrial = True
+                , whMarketplacePlanUnitName = Just "seat"
+                , whMarketplacePlanBullet = V.fromList ["Is Basic","Because Basic "]
+                }
+          }
+    , evMarketplacePurchasePrevious =
+        Just (
+          HookMarketplacePurchase
+            { whMarketplacePurchaseAccount =
+                HookMarketplaceAccount
+                  { whMarketplaceAccountType = OwnerOrganization
+                  , whMarketplaceAccountId = 18404719
+                  , whMarketplaceAccountNodeId = "MDEyOk9yZ2FuaXphdGlvbjE="
+                  , whMarketplaceAccountLogin = "username"
+                  , whMarketplaceAccountOrganizationBillingEmail = Just "username@email.com"
+                  }
+              , whMarketplacePurchaseBillingCycle = Just HookMarketplaceBillingCycleMonthly
+              , whMarketplacePurchaseUnitCount = 1
+              , whMarketplacePurchaseOnFreeTrial = False
+              , whMarketplacePurchaseFreeTrialEndsOn = Nothing
+              , whMarketplacePurchaseNextBillingDate = Nothing
+              , whMarketplacePurchasePlan =
+                  HookMarketplacePlan
+                    { whMarketplacePlanId = 435
+                    , whMarketplacePlanName = "Basic Plan"
+                    , whMarketplacePlanDescription = "Basic Plan"
+                    , whMarketplacePlanMonthlyPriceInCents = 1000
+                    , whMarketplacePlanYearlyPriceInCents = 10000
+                    , whMarketplacePlanPriceModel = HookMarketplacePlanPriceModelPerUnit
+                    , whMarketplacePlanHasFreeTrial = True
+                    , whMarketplacePlanUnitName = Just "seat"
+                    , whMarketplacePlanBullet = V.fromList ["Is Basic","Because Basic "]
+                    }
+            })
+    }
+
 memberEventFixture :: MemberEvent
 memberEventFixture = MemberEvent
     { evMemberAction = MemberAddedAction

diff --git a/src/GitHub/Data/Webhooks/Events.hs b/src/GitHub/Data/Webhooks/Events.hs
@@ -51,6 +51,9 @@ module GitHub.Data.Webhooks.Events
     , LabelEvent(..)
     , LabelEventAction(..)
       --
+    , MarketplacePurchaseEvent(..)
+    , MarketplacePurchaseEventAction(..)
+      --
     , MemberEvent(..)
     , MemberEventAction(..)
       --
@@ -572,6 +575,48 @@ instance EventHasRepo LabelEvent where repoForEvent = evLabelEventRepo
 instance NFData LabelEvent where rnf = genericRnf
 
 
+data MarketplacePurchaseEventAction
+  -- | Decodes from "purchased"
+  = MarketplacePurchasePurchasedAction
+  -- | Decodes from "cancelled"
+  | MarketplacePurchaseCancelledAction
+  -- | Decodes from "pending_change"
+  | MarketplacePurchasePendingChangeAction
+  -- | Decodes from "pending_change_cancelled"
+  | MarketplacePurchasePendingChangeCancelledAction
+  -- | Decodes from "changed"
+  | MarketplacePurchaseChangedAction
+  -- | The result of decoding an unknown marketplace purchase event action type
+  | MarketplacePurchaseActionOther !Text
+  deriving (Eq, Ord, Show, Generic, Typeable, Data)
+
+instance NFData MarketplacePurchaseEventAction where rnf = genericRnf
+
+instance FromJSON MarketplacePurchaseEventAction where
+  parseJSON = withText "Marketplace purchase event action" $ \t ->
+    case t of
+        "purchased"                -> pure MarketplacePurchasePurchasedAction
+        "cancelled"                -> pure MarketplacePurchaseCancelledAction
+        "pending_change"           -> pure MarketplacePurchasePendingChangeAction
+        "pending_change_cancelled" -> pure MarketplacePurchasePendingChangeCancelledAction
+        "changed"                  -> pure MarketplacePurchaseChangedAction
+        _                          -> pure (MarketplacePurchaseActionOther t)
+
+-- | A GitHub Marketplace app receives information about changes to a user's plan from the Marketplace purchase event webhook. A Marketplace purchase event is triggered when a user purchases, cancels, or changes their payment plan.
+-- See <https://docs.github.com/en/developers/github-marketplace/using-the-github-marketplace-api-in-your-app/webhook-events-for-the-github-marketplace-api#github-marketplace-purchase-webhook-payload>.
+data MarketplacePurchaseEvent = MarketplacePurchaseEvent
+    { evMarketplacePurchaseAction        :: !MarketplacePurchaseEventAction
+    , evMarketplacePurchaseEffectiveDate :: !UTCTime
+    , evMarketplacePurchaseSender        :: !HookUser
+    , evMarketplacePurchaseNew           :: !HookMarketplacePurchase
+    , evMarketplacePurchasePrevious      :: !(Maybe HookMarketplacePurchase)
+    }
+    deriving (Eq, Show, Typeable, Data, Generic)
+
+instance EventHasSender MarketplacePurchaseEvent where senderOfEvent = evMarketplacePurchaseSender
+instance NFData MarketplacePurchaseEvent where rnf = genericRnf
+
+
 data MemberEventAction
   -- | Decodes from "added"
   = MemberAddedAction
@@ -1399,6 +1444,14 @@ instance FromJSON LabelEvent where
         <*> o .:? "organization"
         <*> o .: "sender"
 
+instance FromJSON MarketplacePurchaseEvent where
+    parseJSON = withObject "MarketplacePurchaseEvent" $ \o -> MarketplacePurchaseEvent
+        <$> o .: "action"
+        <*> o .: "effective_date"
+        <*> o .: "sender"
+        <*> o .: "marketplace_purchase"
+        <*> o .:? "previous_marketplace_purchase"
+
 instance FromJSON MemberEvent where
     parseJSON = withObject "MemberEvent" $ \o -> MemberEvent
         <$> o .: "action"