feat: add postman-cli plugin

plugins/postman/api_key.go

@@ -0,0 +1,87 @@
+package postman
+
+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://learning.postman.com/docs/developer/postman-api/intro-api/#generating-a-postman-api-key"),
+		ManagementURL: sdk.URL("https://web.postman.co/settings/me/api-keys"),
+		Fields: []schema.CredentialField{
+			{
+				Name:                fieldname.APIKey,
+				MarkdownDescription: "API Key used to authenticate to postman.",
+				Secret:              true,
+				Composition: &schema.ValueComposition{
+					Length: 64,
+					Charset: schema.Charset{
+						Uppercase: true,
+						Lowercase: true,
+						Digits:    true,
+					},
+				},
+			},
+		},
+		DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
+		Importer: importer.TryAll(
+			importer.TryEnvVarPair(defaultEnvVarMapping),
+			TryPostmanConfigFile(),
+		)}
+}
+
+var defaultEnvVarMapping = map[string]sdk.FieldName{
+	"POSTMAN_API_KEY": fieldname.APIKey,
+}
+
+func TryPostmanConfigFile() sdk.Importer {
+	return importer.TryFile("~/.postman/postmanrc", 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
+		}
+
+		var defaultProfile *PostmanProfile
+
+		for _, profile := range config.Login.Profiles {
+			if profile.Alias == "default" {
+				defaultProfile = &profile
+				break
+			}
+		}
+
+		if defaultProfile == nil || defaultProfile.PostmanAPIKey == "" {
+			return
+		}
+
+		out.AddCandidate(sdk.ImportCandidate{
+			Fields: map[sdk.FieldName]string{
+				fieldname.APIKey: defaultProfile.PostmanAPIKey,
+			},
+		})
+	})
+}
+
+type PostmanProfile struct {
+	Alias         string `json:"alias"`
+	PostmanAPIKey string `json:"postmanApiKey"`
+	Username      string `json:"username"`
+}
+
+type Config struct {
+	Login struct {
+		Profiles []PostmanProfile `json:"_profiles"`
+	} `json:"login"`
+	Updates struct {
+		UpdateCheckedTimestamp int64 `json:"updateCheckedTimestamp"`
+	} `json:"updates"`
+}

plugins/postman/api_key_test.go

@@ -0,0 +1,53 @@
+package postman
+
+import (
+	"testing"
+
+	"github.com/1Password/shell-plugins/sdk"
+	"github.com/1Password/shell-plugins/sdk/plugintest"
+	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
+)
+
+func TestAPIKeyProvisioner(t *testing.T) {
+	plugintest.TestProvisioner(t, APIKey().DefaultProvisioner, map[string]plugintest.ProvisionCase{
+		"default": {
+			ItemFields: map[sdk.FieldName]string{
+				fieldname.APIKey: "jNMdtxuUHqiSMNmwYu3OXyhOgYKse6H82uhghe0Zw3K92ZEfXhL8wvLzX",
+			},
+			ExpectedOutput: sdk.ProvisionOutput{
+				Environment: map[string]string{
+					"POSTMAN_API_KEY": "jNMdtxuUHqiSMNmwYu3OXyhOgYKse6H82uhghe0Zw3K92ZEfXhL8wvLzX",
+				},
+			},
+		},
+	})
+}
+
+func TestAPIKeyImporter(t *testing.T) {
+	plugintest.TestImporter(t, APIKey().Importer, map[string]plugintest.ImportCase{
+		"environment": {
+			Environment: map[string]string{
+				"POSTMAN_API_KEY": "jNMdtxuUHqiSMNmwYu3OXyhOgYKse6H82uhghe0Zw3K92ZEfXhL8wvLzX",
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.APIKey: "jNMdtxuUHqiSMNmwYu3OXyhOgYKse6H82uhghe0Zw3K92ZEfXhL8wvLzX",
+					},
+				},
+			},
+		},
+		"config file": {
+			Files: map[string]string{
+				"~/.postman/postmanrc": plugintest.LoadFixture(t, "postmanrc"),
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.APIKey: "jNMdtxuUHqiSMNmwYu3OXyhOgYKse6H82uhghe0Zw3K92ZEfXhL8wvLzX",
+					},
+				},
+			},
+		},
+	})
+}

plugins/postman/plugin.go

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

plugins/postman/postman.go

@@ -0,0 +1,27 @@
+package postman
+
+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"
+)
+
+func postmanCLI() schema.Executable {
+	return schema.Executable{
+		Name:    "postman",
+		Runs:    []string{"postman"},
+		DocsURL: sdk.URL("https://learning.postman.com/docs/postman-cli/postman-cli-overview/"),
+		NeedsAuth: needsauth.IfAll(
+			needsauth.NotForHelpOrVersion(),
+			needsauth.NotWithoutArgs(),
+			needsauth.NotWhenContainsArgs("login"),
+			needsauth.NotWhenContainsArgs("-with-api-key"),
+		),
+		Uses: []schema.CredentialUsage{
+			{
+				Name: credname.APIKey,
+			},
+		},
+	}
+}

plugins/postman/test-fixtures/postmanrc

@@ -0,0 +1,14 @@
+{
+  "login": {
+    "_profiles": [
+      {
+        "alias": "default",
+        "postmanApiKey": "jNMdtxuUHqiSMNmwYu3OXyhOgYKse6H82uhghe0Zw3K92ZEfXhL8wvLzX",
+        "username": "example@example.com"
+      }
+    ]
+  },
+  "updates": {
+    "updateCheckedTimestamp": 1623456789
+  }
+}