github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/thing/extract.go (about)

     1  // This file is part of arduino-cloud-cli.
     2  //
     3  // Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/)
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published
     7  // by the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <https://www.gnu.org/licenses/>.
    17  
    18  package thing
    19  
    20  import (
    21  	"context"
    22  	"fmt"
    23  
    24  	"github.com/arduino/arduino-cloud-cli/config"
    25  	"github.com/arduino/arduino-cloud-cli/internal/iot"
    26  	"github.com/arduino/arduino-cloud-cli/internal/template"
    27  )
    28  
    29  // ExtractParams contains the parameters needed to
    30  // extract a template thing from Arduino IoT Cloud.
    31  type ExtractParams struct {
    32  	ID string
    33  }
    34  
    35  // Extract command is used to extract a thing template
    36  // from a thing on Arduino IoT Cloud.
    37  func Extract(ctx context.Context, params *ExtractParams, cred *config.Credentials) (map[string]interface{}, error) {
    38  	iotClient, err := iot.NewClient(cred)
    39  	if err != nil {
    40  		return nil, err
    41  	}
    42  
    43  	thing, err := iotClient.ThingShow(ctx, params.ID)
    44  	if err != nil {
    45  		err = fmt.Errorf("%s: %w", "cannot extract thing: ", err)
    46  		return nil, err
    47  	}
    48  
    49  	return template.FromThing(thing), nil
    50  }