#720 Initial commit for listing Plans and Plan Accounts

github/apps_marketplace.go

@@ -0,0 +1,109 @@
+// Copyright 2013 The go-github AUTHORS. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package github
+
+import (
+	"context"
+	"fmt"
+)
+
+// MarketplaceService handles communication with the marketplace related
+// methods of the GitHub API.
+//
+// GitHub API docs: https://developer.github.com/v3/apps/marketplace/
+type MarketplaceService service
+
+// MarketplacePlan represents a GitHub Apps Marketplace Listing Plan.
+type MarketplacePlan struct {
+	URL                 *string   `json:"url"`
+	AccountsURL         *string   `json:"accounts_url"`
+	ID                  *int      `json:"id"`
+	Name                *string   `json:"name"`
+	Description         *string   `json:"description"`
+	MonthlyPriceInCents *int      `json:"monthly_price_in_cents"`
+	YearlyPriceInCents  *int      `json:"yearly_price_in_cents"`
+	PriceModel          *string   `json:"price_model"`
+	UnitName            *string   `json:"unit_name"`
+	Bullets             *[]string `json:"bullets"`
+}
+
+// MarketplacePurchase represents a GitHub Apps Marketplace Purchase.
+type MarketplacePurchase struct {
+	BillingCycle    *string          `json:"billing_cycle"`
+	NextBillingDate *string          `json:"next_billing_date"`
+	UnitCount       *int             `json:"unit_count"`
+	Plan            *MarketplacePlan `json:"plan"`
+}
+
+// MarketplacePlanAccount represents a GitHub Account (user or organization) on a specific plan
+type MarketplacePlanAccount struct {
+	URL                      *string              `json:"url"`
+	AccountType              *string              `json:"type"`
+	ID                       *int                 `json:"id"`
+	Login                    *string              `json:"login"`
+	Email                    *string              `json:"email"`
+	OrganizationBillingEmail *string              `json:"organization_billing_email"`
+	MarketplacePurchase      *MarketplacePurchase `json:"marketplace_purchase"`
+}
+
+// ListPlans lists all plans for your Marketplace listing
+//
+// GitHub API docs: https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing
+func (s *MarketplaceService) ListPlans(ctx context.Context, stubbed bool, opt *ListOptions) ([]*MarketplacePlan, *Response, error) {
+	u, err := addOptions(fmt.Sprintf("%v/plans", marketplaceURI(stubbed)), opt)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: remove custom Accept header when this API fully launches.
+	req.Header.Set("Accept", mediaTypeMarketplacePreview)
+
+	var i []*MarketplacePlan
+	resp, err := s.client.Do(ctx, req, &i)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return i, resp, nil
+}
+
+// ListPlanAccounts lists all GitHub accounts (user or organization) on a specific plan
+//
+// GitHub API docs: https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan
+func (s *MarketplaceService) ListPlanAccounts(ctx context.Context, planID int, stubbed bool, opt *ListOptions) ([]*MarketplacePlanAccount, *Response, error) {
+	u, err := addOptions(fmt.Sprintf("%v/plans/%v/accounts", marketplaceURI(stubbed), planID), opt)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: remove custom Accept header when this API fully launches.
+	req.Header.Set("Accept", mediaTypeMarketplacePreview)
+
+	var i []*MarketplacePlanAccount
+	resp, err := s.client.Do(ctx, req, &i)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return i, resp, nil
+}
+
+func marketplaceURI(stubbed bool) string {
+	if stubbed {
+		return "apps/marketplace_listing/stubbed"
+	}
+	return "apps/marketplace_listing"
+}

github/apps_marketplace_test.go

@@ -0,0 +1,84 @@
+// Copyright 2013 The go-github AUTHORS. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package github
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"reflect"
+	"testing"
+)
+
+func TestMarketplaceService_ListPlans(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/apps/marketplace_listing/plans", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testHeader(t, r, "Accept", mediaTypeMarketplacePreview)
+		testFormValues(t, r, values{
+			"page":     "1",
+			"per_page": "2",
+		})
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	opt := &ListOptions{Page: 1, PerPage: 2}
+	plans, _, err := client.Marketplace.ListPlans(context.Background(), false, opt)
+	if err != nil {
+		t.Errorf("Marketplace.ListPlans returned error: %v", err)
+	}
+
+	want := []*MarketplacePlan{{ID: Int(1)}}
+	if !reflect.DeepEqual(plans, want) {
+		t.Errorf("Marketplace.ListPlans returned %+v, want %+v", plans, want)
+	}
+}
+
+func TestMarketplaceService_ListPlansStubbed(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/apps/marketplace_listing/stubbed/plans", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testHeader(t, r, "Accept", mediaTypeMarketplacePreview)
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	opt := &ListOptions{Page: 1, PerPage: 2}
+	plans, _, err := client.Marketplace.ListPlans(context.Background(), true, opt)
+	if err != nil {
+		t.Errorf("Marketplace.ListPlans returned error: %v", err)
+	}
+
+	want := []*MarketplacePlan{{ID: Int(1)}}
+	if !reflect.DeepEqual(plans, want) {
+		t.Errorf("Marketplace.ListPlans returned %+v, want %+v", plans, want)
+	}
+}
+
+func TestMarketplaceService_ListPlanAccounts(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/apps/marketplace_listing/plans/1/accounts", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testHeader(t, r, "Accept", mediaTypeMarketplacePreview)
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	opt := &ListOptions{Page: 1, PerPage: 2}
+	accounts, _, err := client.Marketplace.ListPlanAccounts(context.Background(), 1, false, opt)
+	if err != nil {
+		t.Errorf("Marketplace.ListPlanAccounts returned error: %v", err)
+	}
+
+	want := []*MarketplacePlanAccount{{ID: Int(1)}}
+	if !reflect.DeepEqual(accounts, want) {
+		t.Errorf("Marketplace.ListPlanAccounts returned %+v, want %+v", accounts, want)
+	}
+}

github/github.go

@@ -102,6 +102,9 @@ const (
 
 	// https://developer.github.com/changes/2017-07-26-team-review-request-thor-preview/
 	mediaTypeTeamReviewPreview = "application/vnd.github.thor-preview+json"
+
+	// https://developer.github.com/v3/apps/marketplace/
+	mediaTypeMarketplacePreview = "application/vnd.github.valkyrie-preview+json"
 )
 
 // A Client manages communication with the GitHub API.
@@ -143,6 +146,7 @@ type Client struct {
 	Licenses       *LicensesService
 	Migrations     *MigrationService
 	Reactions      *ReactionsService
+	Marketplace    *MarketplaceService
 }
 
 type service struct {
@@ -224,6 +228,7 @@ func NewClient(httpClient *http.Client) *Client {
 	c.Gitignores = (*GitignoresService)(&c.common)
 	c.Issues = (*IssuesService)(&c.common)
 	c.Licenses = (*LicensesService)(&c.common)
+	c.Marketplace = (*MarketplaceService)(&c.common)
 	c.Migrations = (*MigrationService)(&c.common)
 	c.Organizations = (*OrganizationsService)(&c.common)
 	c.Projects = (*ProjectsService)(&c.common)