Mainflux.mainflux/cli/groups.go

// Copyright (c) Mainflux
// SPDX-License-Identifier: Apache-2.0

package cli

import (
	"encoding/json"

	mfclients "github.com/mainflux/mainflux/pkg/clients"
	mfxsdk "github.com/mainflux/mainflux/pkg/sdk/go"
	"github.com/spf13/cobra"
)

var cmdGroups = []cobra.Command{
	{
		Use:   "create <JSON_group> <user_auth_token>",
		Short: "Create group",
		Long: "Creates new group\n" +
			"Usage:\n" +
			"\tmainflux-cli groups create '{\"name\":\"new group\", \"description\":\"new group description\", \"metadata\":{\"key\": \"value\"}}' $USERTOKEN\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 2 {
				logUsage(cmd.Use)
				return
			}
			var group mfxsdk.Group
			if err := json.Unmarshal([]byte(args[0]), &group); err != nil {
				logError(err)
				return
			}
			group.Status = mfclients.EnabledStatus.String()
			group, err := sdk.CreateGroup(group, args[1])
			if err != nil {
				logError(err)
				return
			}
			logJSON(group)
		},
	},
	{
		Use:   "update <JSON_group> <user_auth_token>",
		Short: "Update group",
		Long: "Updates group\n" +
			"Usage:\n" +
			"\tmainflux-cli groups update '{\"id\":\"<group_id>\", \"name\":\"new group\", \"description\":\"new group description\", \"metadata\":{\"key\": \"value\"}}' $USERTOKEN\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 2 {
				logUsage(cmd.Use)
				return
			}

			var group mfxsdk.Group
			if err := json.Unmarshal([]byte(args[0]), &group); err != nil {
				logError(err)
				return
			}

			group, err := sdk.UpdateGroup(group, args[1])
			if err != nil {
				logError(err)
				return
			}

			logJSON(group)
		},
	},
	{
		Use:   "get [all | children <group_id> | parents <group_id> | members <group_id> | <group_id>] <user_auth_token>",
		Short: "Get group",
		Long: "Get all users groups, group children or group by id.\n" +
			"Usage:\n" +
			"\tmainflux-cli groups get all $USERTOKEN - lists all groups\n" +
			"\tmainflux-cli groups get children <group_id> $USERTOKEN - lists all children groups of <group_id>\n" +
			"\tmainflux-cli groups get parents <group_id> $USERTOKEN - lists all parent groups of <group_id>\n" +
			"\tmainflux-cli groups get <group_id> $USERTOKEN - shows group with provided group ID\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) < 2 {
				logUsage(cmd.Use)
				return
			}
			if args[0] == all {
				if len(args) > 2 {
					logUsage(cmd.Use)
					return
				}
				pm := mfxsdk.PageMetadata{
					Offset: Offset,
					Limit:  Limit,
				}
				l, err := sdk.Groups(pm, args[1])
				if err != nil {
					logError(err)
					return
				}
				logJSON(l)
				return
			}
			if args[0] == "children" {
				if len(args) > 3 {
					logUsage(cmd.Use)
					return
				}
				pm := mfxsdk.PageMetadata{
					Offset: Offset,
					Limit:  Limit,
				}
				l, err := sdk.Children(args[1], pm, args[2])
				if err != nil {
					logError(err)
					return
				}
				logJSON(l)
				return
			}
			if args[0] == "parents" {
				if len(args) > 3 {
					logUsage(cmd.Use)
					return
				}
				pm := mfxsdk.PageMetadata{
					Offset: Offset,
					Limit:  Limit,
				}
				l, err := sdk.Parents(args[1], pm, args[2])
				if err != nil {
					logError(err)
					return
				}
				logJSON(l)
				return
			}
			if len(args) > 2 {
				logUsage(cmd.Use)
				return
			}
			t, err := sdk.Group(args[0], args[1])
			if err != nil {
				logError(err)
				return
			}
			logJSON(t)
		},
	},
	{
		Use:   "assign user <relation> <user_ids> <group_id> <user_auth_token>",
		Short: "Assign user",
		Long: "Assign user to a group\n" +
			"Usage:\n" +
			"\tmainflux-cli groups assign user <relation> '[\"<user_id_1>\", \"<user_id_2>\"]' <group_id> $USERTOKEN\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 5 {
				logUsage(cmd.Use)
				return
			}
			var userIDs []string
			if err := json.Unmarshal([]byte(args[1]), &userIDs); err != nil {
				logError(err)
				return
			}
			if err := sdk.AddUserToGroup(args[2], mfxsdk.UsersRelationRequest{Relation: args[0], UserIDs: userIDs}, args[3]); err != nil {
				logError(err)
				return
			}
			logOK()
		},
	},
	{
		Use:   "unassign user <relation> <user_ids> <group_id> <user_auth_token>",
		Short: "Unassign user",
		Long: "Unassign user from a group\n" +
			"Usage:\n" +
			"\tmainflux-cli groups unassign user <relation> '[\"<user_id_1>\", \"<user_id_2>\"]' <group_id> $USERTOKEN\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 5 {
				logUsage(cmd.Use)
				return
			}
			var userIDs []string
			if err := json.Unmarshal([]byte(args[1]), &userIDs); err != nil {
				logError(err)
				return
			}
			if err := sdk.RemoveUserFromGroup(args[2], mfxsdk.UsersRelationRequest{Relation: args[0], UserIDs: userIDs}, args[3]); err != nil {
				logError(err)
				return
			}
			logOK()
		},
	},

	{
		Use:   "users <group_id> <user_auth_token>",
		Short: "List users",
		Long: "List users in a group\n" +
			"Usage:\n" +
			"\tmainflux-cli groups users <group_id> $USERTOKEN",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 2 {
				logUsage(cmd.Use)
				return
			}
			pm := mfxsdk.PageMetadata{
				Offset: Offset,
				Limit:  Limit,
				Status: Status,
			}
			users, err := sdk.ListGroupUsers(args[0], pm, args[1])
			if err != nil {
				logError(err)
				return
			}
			logJSON(users)
		},
	},
	{
		Use:   "channels <group_id> <user_auth_token>",
		Short: "List channels",
		Long: "List channels in a group\n" +
			"Usage:\n" +
			"\tmainflux-cli groups channels <group_id> $USERTOKEN",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 2 {
				logUsage(cmd.Use)
				return
			}
			pm := mfxsdk.PageMetadata{
				Offset: Offset,
				Limit:  Limit,
				Status: Status,
			}
			channels, err := sdk.ListGroupChannels(args[0], pm, args[1])
			if err != nil {
				logError(err)
				return
			}
			logJSON(channels)
		},
	},
	{
		Use:   "enable <group_id> <user_auth_token>",
		Short: "Change group status to enabled",
		Long: "Change group status to enabled\n" +
			"Usage:\n" +
			"\tmainflux-cli groups enable <group_id> $USERTOKEN\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 2 {
				logUsage(cmd.Use)
				return
			}

			group, err := sdk.EnableGroup(args[0], args[1])
			if err != nil {
				logError(err)
				return
			}

			logJSON(group)
		},
	},
	{
		Use:   "disable <group_id> <user_auth_token>",
		Short: "Change group status to disabled",
		Long: "Change group status to disabled\n" +
			"Usage:\n" +
			"\tmainflux-cli groups disable <group_id> $USERTOKEN\n",
		Run: func(cmd *cobra.Command, args []string) {
			if len(args) != 2 {
				logUsage(cmd.Use)
				return
			}

			group, err := sdk.DisableGroup(args[0], args[1])
			if err != nil {
				logError(err)
				return
			}

			logJSON(group)
		},
	},
}

// NewGroupsCmd returns users command.
func NewGroupsCmd() *cobra.Command {
	cmd := cobra.Command{
		Use:   "groups [create | get | update | delete | assign | unassign | users | channels ]",
		Short: "Groups management",
		Long:  `Groups management: create, update, delete group and assign and unassign member to groups"`,
	}

	for i := range cmdGroups {
		cmd.AddCommand(&cmdGroups[i])
	}

	return &cmd
}