Merge pull request #2 from hookdeck/feat/unauthenticated-user

feat: logout command & creating guest access when calling listen

Author: alexbouchardd

README.md

@@ -1,7 +1,5 @@
 # Hookdeck CLI
 
-> Hookdeck CLI is in public beta. A **free** account is required, and we will allow for unauthenticated use cases in the short future!
-
 Using the Hookdeck CLI, you can forward your webhooks to your local webserver. We offer unlimited **free** and **permanent** webhook URLs. You webhook history is preserved between session and can be viewed, replayed or used for testing by you and your teammates.
 
 Hookdeck CLI is compatible with most of Hookdeck features such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your webhook integration code locally.
@@ -14,7 +12,6 @@ For a complete reference, see the [CLI reference](https://hookdeck.com/cli)
 
 ![demo](docs/cli-demo.gif)
 
-
 ## Installation
 
 Hookdeck CLI is available for macOS, Windows, and Linux for distros like Ubuntu, Debian, RedHat and CentOS.
@@ -36,7 +33,7 @@ scoop bucket add hookdeck https://github.com/hookdeck/scoop-hookdeck-cli.git
 scoop install hookdeck
 ```
 
-### Linux Or Without package managers 
+### Linux Or Without package managers
 
 To install the Hookdeck CLI on Linux without a package manager:
 
@@ -74,6 +71,8 @@ Login with your Hookdeck account.
 hookdeck login
 ```
 
+> Login is optional, if you do not login a temporary guest account will be created for you when you run other commands.
+
 ### Listen
 
 Start a session to forward your webhooks to a local HTTP server.
@@ -82,7 +81,7 @@ Start a session to forward your webhooks to a local HTTP server.
 hookdeck listen <port> <source-alias?> <connection-query?>
 ```
 
-Hookdeck works by routing webhooks receive for a given `source` (ie: Shopify, Github, etc.) to its defined `destination` by connecting them with a `connection`  to a `destination`. The CLI allows you to receive webhooks for any given connection and forward them to your localhost at the specified port.
+Hookdeck works by routing webhooks receive for a given `source` (ie: Shopify, Github, etc.) to its defined `destination` by connecting them with a `connection` to a `destination`. The CLI allows you to receive webhooks for any given connection and forward them to your localhost at the specified port.
 
 Each `source` is assigned a Webhook URL, which you can use to receive webhooks. When starting with a fresh account, the CLI will prompt you to create your first source. Each CLI process can listen to one source at a time.
 
@@ -91,20 +90,21 @@ Contrarily to ngrok, **Hookdeck does not allow to append a path to your Webhook
 > The `port` param is mandatory, webhooks will be forwarded to http://localhost:$PORT/$DESTINATION_PATH
 
 #### Listen to all your connections for a given source
+
 The second param, `source-alias` is used to select a specific source to listen on. By default, the CLI will start listening on all eligible connections for that source.
 
 ```sh-session
 $ hookdeck listen 3000 shopify
 
-╭ Shopify ───────────────────────────────────────────────────────────────╮
-│                                                                        │
-│  🔌 Webhook URL: http://localhost:5000/e/src_dgRnekOhKKZe7KqyXK88Uajr  │
-│                                                                        │
-╰────────────────────────────────────────────────────────────────────────╯
+👉  Inspect and replay webhooks: https://dashboard.hookdeck.com/cli/events
+
+Shopify Source
+🔌 Webhook URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
+
+Connections
 Inventory Service forwarding to /webhooks/shopify/inventory
 Orders Service forwarding to /webhooks/shopify/orders
 
-👉  Inspect and replay webhooks: https://dashboard.hookdeck.io/events/cli
 
 ⣾ Getting ready...
 
@@ -117,23 +117,22 @@ The 3rd param, `connection-query` can be used to filter the list of connections
 ```sh-session
 $ hookdeck listen 3000 shopify orders
 
-╭ Shopify ───────────────────────────────────────────────────────────────╮
-│                                                                        │
-│  🔌 Webhook URL: http://localhost:5000/e/src_dgRnekOhKKZe7KqyXK88Uajr  │
-│                                                                        │
-╰────────────────────────────────────────────────────────────────────────╯
+👉  Inspect and replay webhooks: https://dashboard.hookdeck.com/cli/events
+
+Shopify Source
+🔌 Webhook URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
+
+Connections
 Inventory Service forwarding to /webhooks/shopify/inventory
 
-👉  Inspect and replay webhooks: https://dashboard.hookdeck.io/events/cli
 
 ⣾ Getting ready...
 
 ```
 
 #### Viewing and interacting with your webhooks
 
-Webhooks logs for your CLI can be found at https://dashboard.hookdeck.io/events/cli. Events can be replayed or saved at any time.
-
+Webhooks logs for your CLI can be found at https://dashboard.hookdeck.com/cli/events. Events can be replayed or saved at any time.
 
 ### Version
 
@@ -152,6 +151,7 @@ hookdeck completion
 ```
 
 ## License
+
 Copyright (c) Hookdeck. All rights reserved.
 
 Licensed under the [Apache License 2.0 license](blob/master/LICENSE).

pkg/cmd/logout.go

@@ -0,0 +1,35 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/hookdeck/hookdeck-cli/pkg/logout"
+	"github.com/hookdeck/hookdeck-cli/pkg/validators"
+)
+
+type logoutCmd struct {
+	cmd *cobra.Command
+	all bool
+}
+
+func newLogoutCmd() *logoutCmd {
+	lc := &logoutCmd{}
+
+	lc.cmd = &cobra.Command{
+		Use:   "logout",
+		Args:  validators.NoArgs,
+		Short: "Logout of your Hookdeck account",
+		Long:  `Logout of your Hookdeck account to setup the CLI`,
+		RunE:  lc.runLogoutCmd,
+	}
+	lc.cmd.Flags().BoolVarP(&lc.all, "all", "a", false, "Clear credentials for all projects you are currently logged into.")
+
+	return lc
+}
+
+func (lc *logoutCmd) runLogoutCmd(cmd *cobra.Command, args []string) error {
+	if lc.all {
+		return logout.All(&Config)
+	}
+	return logout.Logout(&Config)
+}

pkg/cmd/root.go

@@ -103,6 +103,7 @@ func init() {
 	rootCmd.Flags().BoolP("version", "v", false, "Get the version of the Hookdeck CLI")
 
 	rootCmd.AddCommand(newLoginCmd().cmd)
+	rootCmd.AddCommand(newLogoutCmd().cmd)
 	rootCmd.AddCommand(newListenCmd().cmd)
 	rootCmd.AddCommand(newCompletionCmd().cmd)
 }

pkg/hookdeck/guest.go

@@ -0,0 +1,37 @@
+package hookdeck
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+type GuestUser struct {
+	Id         string `json:"id"`
+	APIKey     string `json:"key"`
+	Url        string `json:"link"`
+	BrowserURL string `json:"browser_url"`
+	PollURL    string `json:"poll_url"`
+}
+
+type CreateGuestUserInput struct {
+	DeviceName string `json:"device_name"`
+}
+
+func (c *Client) CreateGuestUser(input CreateGuestUserInput) (GuestUser, error) {
+	input_bytes, err := json.Marshal(input)
+	if err != nil {
+		return GuestUser{}, err
+	}
+	res, err := c.Post(context.Background(), "/cli/guest", input_bytes, nil)
+	if err != nil {
+		return GuestUser{}, err
+	}
+	if res.StatusCode != http.StatusOK {
+		return GuestUser{}, fmt.Errorf("Unexpected http status code: %d %s", res.StatusCode)
+	}
+	guest_user := GuestUser{}
+	postprocessJsonResponse(res, &guest_user)
+	return guest_user, nil
+}

pkg/listen/listen.go

@@ -21,10 +21,12 @@ import (
 	"net/url"
 	"regexp"
 
-	box "github.com/Delta456/box-cli-maker/v2"
+	"github.com/hookdeck/hookdeck-cli/pkg/ansi"
 	"github.com/hookdeck/hookdeck-cli/pkg/config"
 	"github.com/hookdeck/hookdeck-cli/pkg/hookdeck"
+	"github.com/hookdeck/hookdeck-cli/pkg/login"
 	"github.com/hookdeck/hookdeck-cli/pkg/proxy"
+	"github.com/hookdeck/hookdeck-cli/pkg/validators"
 	log "github.com/sirupsen/logrus"
 )
 
@@ -35,10 +37,26 @@ type Flags struct {
 
 // listenCmd represents the listen command
 func Listen(port string, source_alias string, connection_query string, flags Flags, config *config.Config) error {
+	var key string
+	var err error
+	var guest_url string
 
-	key, err := config.Profile.GetAPIKey()
+	key, err = config.Profile.GetAPIKey()
 	if err != nil {
-		return err
+		errString := err.Error()
+		if errString == validators.ErrAPIKeyNotConfigured.Error() || errString == validators.ErrDeviceNameNotConfigured.Error() {
+			guest_url, _ = login.GuestLogin(config)
+			if guest_url == "" {
+				return err
+			}
+
+			key, err = config.Profile.GetAPIKey()
+			if err != nil {
+				return err
+			}
+		} else {
+			return err
+		}
 	}
 
 	parsedBaseURL, err := url.Parse(config.APIBaseURL)
@@ -61,24 +79,31 @@ func Listen(port string, source_alias string, connection_query string, flags Fla
 		return err
 	}
 
-	// Print sources, connections and URLs
 	fmt.Println()
-	Box := box.New(box.Config{Px: 2, Py: 1, ContentAlign: "Left", Type: "Round", Color: "White", TitlePos: "Top"})
-	Box.Print(source.Label, "🔌 Webhook URL: "+source.Url)
+	fmt.Println(ansi.Bold("Dashboard"))
+	if guest_url != "" {
+		fmt.Println("👤 Login URL: " + guest_url)
+		fmt.Println("Sign up in the dashboard to make your webhook URL permanent.")
+		fmt.Println()
+	}
+	fmt.Println("👉 Inspect and replay webhooks: https://dashboard.hookdeck.com/cli/events")
+	fmt.Println()
 
-	//var connection_ids []string
+	fmt.Println(ansi.Bold(source.Label + " Source"))
+	fmt.Println("🔌 Webhook URL: " + source.Url)
+	fmt.Println()
+
+	fmt.Println(ansi.Bold("Connections"))
 	for _, connection := range connections {
 		fmt.Println(connection.Label + " forwarding to " + connection.Destination.CliPath)
-		//connection_ids = append(connection_ids, connection.Id)
 	}
+	fmt.Println()
 
 	deviceName, err := config.Profile.GetDeviceName()
 	if err != nil {
 		return err
 	}
 
-	fmt.Println("\n👉  Inspect and replay webhooks: https://dashboard.hookdeck.io/events/cli\n")
-
 	p := proxy.New(&proxy.Config{
 		DeviceName: deviceName,
 		Key:        key,

pkg/login/client_login.go

@@ -84,6 +84,49 @@ func Login(config *config.Config, input io.Reader) error {
 	return nil
 }
 
+func GuestLogin(config *config.Config) (string, error) {
+	parsedBaseURL, err := url.Parse(config.APIBaseURL)
+	if err != nil {
+		return "", err
+	}
+
+	client := &hookdeck.Client{
+		BaseURL: parsedBaseURL,
+	}
+
+	fmt.Println("🚩 Not connected with any account. Creating a guest account...")
+
+	guest_user, err := client.CreateGuestUser(hookdeck.CreateGuestUserInput{
+		DeviceName: config.Profile.DeviceName,
+	})
+	if err != nil {
+		return "", err
+	}
+
+	// Call poll function
+	response, err := PollForKey(guest_user.PollURL, 0, 0)
+	if err != nil {
+		return "", err
+	}
+
+	validateErr := validators.APIKey(response.APIKey)
+	if validateErr != nil {
+		return "", validateErr
+	}
+
+	config.Profile.APIKey = response.APIKey
+	config.Profile.ClientID = response.ClientID
+	config.Profile.DisplayName = response.UserName
+	config.Profile.TeamName = response.TeamName
+
+	profileErr := config.Profile.CreateProfile()
+	if profileErr != nil {
+		return "", profileErr
+	}
+
+	return guest_user.Url, nil
+}
+
 func getLinks(baseURL string, deviceName string) (*Links, error) {
 	parsedBaseURL, err := url.Parse(baseURL)
 	if err != nil {

pkg/logout/logout.go

@@ -0,0 +1,48 @@
+package logout
+
+import (
+	"fmt"
+
+	"github.com/hookdeck/hookdeck-cli/pkg/config"
+)
+
+// Logout function is used to clear the credentials set for the current Profile
+func Logout(config *config.Config) error {
+	key, _ := config.Profile.GetAPIKey()
+
+	if key == "" {
+		fmt.Println("You are already logged out.")
+		return nil
+	}
+
+	fmt.Println("Logging out...")
+
+	profileName := config.Profile.ProfileName
+
+	err := config.RemoveProfile(profileName)
+	if err != nil {
+		return err
+	}
+
+	if profileName == "default" {
+		fmt.Println("Credentials have been cleared for the default project.")
+	} else {
+		fmt.Printf("Credentials have been cleared for %s.\n", profileName)
+	}
+
+	return nil
+}
+
+// All function is used to clear the credentials on all profiles
+func All(cfg *config.Config) error {
+	fmt.Println("Logging out...")
+
+	err := cfg.RemoveAllProfiles()
+	if err != nil {
+		return err
+	}
+
+	fmt.Println("Credentials have been cleared for all projects.")
+
+	return nil
+}

pkg/proxy/proxy.go

@@ -252,7 +252,7 @@ func (p *Proxy) processEndpointResponse(webhookEvent *websocket.Attempt, resp *h
 	localTime := time.Now().Format(timeLayout)
 
 	color := ansi.Color(os.Stdout)
-	outputStr := fmt.Sprintf("%s [%d] %s %s | https://dashboard.hookdeck.io/events/%s",
+	outputStr := fmt.Sprintf("%s [%d] %s %s | https://dashboard.hookdeck.com/events/%s",
 		color.Faint(localTime),
 		ansi.ColorizeStatus(resp.StatusCode),
 		resp.Request.Method,