Add ReadMe plugin

plugins/readme/api_key.go

@@ -0,0 +1,86 @@
+package readme
+
+import (
+	"context"
+
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/importer"
+	"github.com/1Password/shell-plugins/sdk/provision"
+	"github.com/1Password/shell-plugins/sdk/schema"
+	"github.com/1Password/shell-plugins/sdk/schema/credname"
+	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
+)
+
+func APIKey() schema.CredentialType {
+	return schema.CredentialType{
+		Name:    credname.APIKey,
+		DocsURL: sdk.URL("https://docs.readme.com/main/reference/intro/authentication"),
+		Fields: []schema.CredentialField{
+			{
+				Name:                fieldname.Username,
+				MarkdownDescription: "ReadMe user to log in as.",
+				Secret:              false,
+				Optional:            true,
+			},
+			{
+				Name:                fieldname.APIKey,
+				MarkdownDescription: "API Key used to authenticate to ReadMe.",
+				Secret:              true,
+				Composition: &schema.ValueComposition{
+					Prefix: "rdme_",
+					Charset: schema.Charset{
+						Lowercase: true,
+						Digits:    true,
+					},
+				},
+			},
+			{
+				Name:                fieldname.Website,
+				MarkdownDescription: "The ReadMe project URL.",
+				Secret:              false,
+				Optional:            true,
+			},
+		},
+		DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
+		Importer: importer.TryAll(
+			importer.TryEnvVarPair(defaultEnvVarMapping),
+			TryReadMeConfigFile(),
+		)}
+}
+
+var defaultEnvVarMapping = map[string]sdk.FieldName{
+	"RDME_API_KEY": fieldname.APIKey,
+	"RDME_EMAIL":   fieldname.Username,
+	"RDME_PROJECT": fieldname.Website,
+}
+
+func TryReadMeConfigFile() sdk.Importer {
+	return importer.TryFile("~/.config/configstore/rdme-production.json", func(ctx context.Context, contents importer.FileContents, in sdk.ImportInput, out *sdk.ImportAttempt) {
+		var config Config
+		if err := contents.ToJSON(&config); err != nil {
+			out.AddError(err)
+			return
+		}
+
+		if config.APIKey == "" {
+			return
+		}
+
+		var website string = "https://dash.readme.com/go/" + config.Subdomain
+
+		out.AddCandidate(sdk.ImportCandidate{
+			NameHint: config.Subdomain,
+			Fields: map[sdk.FieldName]string{
+				fieldname.Username: config.Email,
+				fieldname.APIKey:   config.APIKey,
+				fieldname.Website:  website,
+			},
+		})
+	})
+}
+
+type Config struct {
+	APIKey    string `json:"apiKey"`
+	Email     string `json:"email"`
+	Subdomain string `json:"project"`
+}

plugins/readme/api_key_test.go

@@ -0,0 +1,64 @@
+package readme
+
+import (
+	"testing"
+
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/plugintest"
+	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
+)
+
+func TestAPIKeyImporter(t *testing.T) {
+	plugintest.TestImporter(t, APIKey().Importer, map[string]plugintest.ImportCase{
+		"environment": {
+			Environment: map[string]string{
+				"RDME_API_KEY": "rdme_9o50rxz28p0msun40apgyzvkdji2vhxyd7b8emioclkrx57ucpb5x2d31yu39taexample",
+				"RDME_EMAIL":   "owlbert@readme.io",
+				"RDME_PROJECT": "test-subdomain",
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.Username: "owlbert@readme.io",
+						fieldname.APIKey:   "rdme_9o50rxz28p0msun40apgyzvkdji2vhxyd7b8emioclkrx57ucpb5x2d31yu39taexample",
+						fieldname.Website:  "test-subdomain",
+					},
+				},
+			},
+		},
+		"ReadMe config file": {
+			Files: map[string]string{
+				"~/.config/configstore/rdme-production.json": plugintest.LoadFixture(t, "readme.json"),
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.Username: "owlbert@readme.io",
+						fieldname.APIKey:   "rdme_9o50rxz28p0msun40apgyzvkdji2vhxyd7b8emioclkrx57ucpb5x2d31yu39taexample",
+						fieldname.Website:  "https://dash.readme.com/go/test-subdomain",
+					},
+					NameHint: "test-subdomain",
+				},
+			},
+		},
+	})
+}
+
+func TestSecretKeyProvisioner(t *testing.T) {
+	plugintest.TestProvisioner(t, APIKey().DefaultProvisioner, map[string]plugintest.ProvisionCase{
+		"default": {
+			ItemFields: map[sdk.FieldName]string{
+				fieldname.Username: "owlbert@readme.io",
+				fieldname.APIKey:   "rdme_9o50rxz28p0msun40apgyzvkdji2vhxyd7b8emioclkrx57ucpb5x2d31yu39taexample",
+				fieldname.Website:  "https://dash.readme.com/go/test-subdomain",
+			},
+			ExpectedOutput: sdk.ProvisionOutput{
+				Environment: map[string]string{
+					"RDME_EMAIL":   "owlbert@readme.io",
+					"RDME_API_KEY": "rdme_9o50rxz28p0msun40apgyzvkdji2vhxyd7b8emioclkrx57ucpb5x2d31yu39taexample",
+					"RDME_PROJECT": "https://dash.readme.com/go/test-subdomain",
+				},
+			},
+		},
+	})
+}

plugins/readme/plugin.go

@@ -0,0 +1,22 @@
+package readme
+
+import (
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/schema"
+)
+
+func New() schema.Plugin {
+	return schema.Plugin{
+		Name: "readme",
+		Platform: schema.PlatformInfo{
+			Name:     "ReadMe",
+			Homepage: sdk.URL("https://readme.com"),
+		},
+		Credentials: []schema.CredentialType{
+			APIKey(),
+		},
+		Executables: []schema.Executable{
+			ReadMeCLI(),
+		},
+	}
+}

plugins/readme/rdme.go

@@ -0,0 +1,44 @@
+package readme
+
+import (
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/needsauth"
+	"github.com/1Password/shell-plugins/sdk/schema"
+	"github.com/1Password/shell-plugins/sdk/schema/credname"
+)
+
+var commands = [][]string{
+	{"openapi"},
+
+	{"docs"},
+	{"docs:prune"},
+	{"guides"},
+	{"guides:prune"},
+
+	{"changelogs"},
+	{"custompages"},
+
+	{"versions"},
+	{"versions:create"},
+	{"versions:delete"},
+	{"versions:update"},
+
+	{"categories"},
+	{"categories:create"},
+
+	{"whoami"},
+}
+
+func ReadMeCLI() schema.Executable {
+	return schema.Executable{
+		Name:      "ReadMe CLI",
+		Runs:      []string{"rdme"},
+		DocsURL:   sdk.URL("https://docs.readme.com/main/docs/rdme"),
+		NeedsAuth: needsauth.ForCommands(commands...),
+		Uses: []schema.CredentialUsage{
+			{
+				Name: credname.APIKey,
+			},
+		},
+	}
+}

plugins/readme/test-fixtures/readme.json

@@ -0,0 +1,5 @@
+{
+  "apiKey": "rdme_9o50rxz28p0msun40apgyzvkdji2vhxyd7b8emioclkrx57ucpb5x2d31yu39taexample",
+  "email": "owlbert@readme.io",
+  "project": "test-subdomain"
+}