From 7ba215a5b7ad2eb6c38f3e465baea2c1508b51e1 Mon Sep 17 00:00:00 2001 From: Maniraja Date: Sat, 1 Jul 2023 01:35:39 -0400 Subject: [PATCH] Add support for Kaggle CLI --- plugins/kaggle/api_token.go | 51 ++++++++++++++++++++++++++++++++ plugins/kaggle/api_token_test.go | 26 ++++++++++++++++ plugins/kaggle/kaggle.go | 25 ++++++++++++++++ plugins/kaggle/plugin.go | 22 ++++++++++++++ 4 files changed, 124 insertions(+) create mode 100644 plugins/kaggle/api_token.go create mode 100644 plugins/kaggle/api_token_test.go create mode 100644 plugins/kaggle/kaggle.go create mode 100644 plugins/kaggle/plugin.go diff --git a/plugins/kaggle/api_token.go b/plugins/kaggle/api_token.go new file mode 100644 index 000000000..5b047a6e9 --- /dev/null +++ b/plugins/kaggle/api_token.go @@ -0,0 +1,51 @@ +package kaggle + +import ( + "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 APIToken() schema.CredentialType { + return schema.CredentialType{ + Name: credname.APIToken, + DocsURL: sdk.URL("https://www.kaggle.com/docs/api"), + ManagementURL: sdk.URL("https://www.kaggle.com/settings/account"), + Fields: []schema.CredentialField{ + { + Name: fieldname.Token, + MarkdownDescription: "API Token used to authenticate to Kaggle.", + Secret: true, + Composition: &schema.ValueComposition{ + Length: 32, + Charset: schema.Charset{ + Lowercase: true, + Digits: true, + }, + }, + }, + { + Name: fieldname.Username, + MarkdownDescription: "Username to authenticate to Kaggle.", + Secret: true, + Composition: &schema.ValueComposition{ + Charset: schema.Charset{ + Lowercase: true, + Digits: true, + }, + }, + }, + }, + DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping), + Importer: importer.TryAll( + importer.TryEnvVarPair(defaultEnvVarMapping), + )} +} + +var defaultEnvVarMapping = map[string]sdk.FieldName{ + "KAGGLE_TOKEN": fieldname.Token, + "KAGGLE_USERNAME": fieldname.Username, +} diff --git a/plugins/kaggle/api_token_test.go b/plugins/kaggle/api_token_test.go new file mode 100644 index 000000000..39f7d2861 --- /dev/null +++ b/plugins/kaggle/api_token_test.go @@ -0,0 +1,26 @@ +package kaggle + +import ( + "testing" + + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/plugintest" + "github.com/1Password/shell-plugins/sdk/schema/fieldname" +) + +func TestAPITokenProvisioner(t *testing.T) { + plugintest.TestProvisioner(t, APIToken().DefaultProvisioner, map[string]plugintest.ProvisionCase{ + "default": { + ItemFields: map[sdk.FieldName]string{ + fieldname.Token: "z2pifkruzgbb17plmz2gux21fexample", + fieldname.Username: "username", + }, + ExpectedOutput: sdk.ProvisionOutput{ + Environment: map[string]string{ + "KAGGLE_TOKEN": "z2pifkruzgbb17plmz2gux21fexample", + "KAGGLE_USERNAME": "username", + }, + }, + }, + }) +} diff --git a/plugins/kaggle/kaggle.go b/plugins/kaggle/kaggle.go new file mode 100644 index 000000000..78d0dd2a2 --- /dev/null +++ b/plugins/kaggle/kaggle.go @@ -0,0 +1,25 @@ +package kaggle + +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 KaggleCLI() schema.Executable { + return schema.Executable{ + Name: "Kaggle CLI", + Runs: []string{"kaggle"}, + DocsURL: sdk.URL("https://github.com/Kaggle/kaggle-api"), + NeedsAuth: needsauth.IfAll( + needsauth.NotForHelpOrVersion(), + needsauth.NotWithoutArgs(), + ), + Uses: []schema.CredentialUsage{ + { + Name: credname.APIToken, + }, + }, + } +} diff --git a/plugins/kaggle/plugin.go b/plugins/kaggle/plugin.go new file mode 100644 index 000000000..2a6b256cd --- /dev/null +++ b/plugins/kaggle/plugin.go @@ -0,0 +1,22 @@ +package kaggle + +import ( + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/schema" +) + +func New() schema.Plugin { + return schema.Plugin{ + Name: "kaggle", + Platform: schema.PlatformInfo{ + Name: "Kaggle", + Homepage: sdk.URL("https://kaggle.com"), + }, + Credentials: []schema.CredentialType{ + APIToken(), + }, + Executables: []schema.Executable{ + KaggleCLI(), + }, + } +}