Merge pull request #8 from leozz37/develop

Develop

Author: leozz37

.github/workflows/go.yml

@@ -16,7 +16,7 @@ jobs:
         run: go mod download
 
       - name: Test
-        run: go test -v -covermode=count -coverprofile=coverage.out
+        run: go test -v -covermode=count -coverprofile=coverage.out ./hare
 
       - name: Upload coverage
         run: bash <(curl -s https://codecov.io/bash)

.gitignore

@@ -4,6 +4,7 @@
 *.dll
 *.so
 *.dylib
+*hare-cli
 
 # Test binary, built with `go test -c`
 *.test

Makefile

@@ -0,0 +1,19 @@
+APP_NAME=hare-cli
+
+build:
+	@go build -o ./$(APP_NAME) cmd/cli/cli.go 
+
+install:
+	@go build -o $(GOPATH)/bin/hare cmd/cli/cli.go 
+
+uninstall:
+	@rm $(GOPATH)/bin/hare
+
+deps:
+	@go mod download
+
+test:
+	@go test ./...
+
+test-coverage:
+	@go test -v -covermode=count -coverprofile=coverage.out ./...

README.md

@@ -13,7 +13,7 @@
 [![Release](https://img.shields.io/github/v/release/leozz37/hare)](https://github.com/leozz37/hare/releases)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Hare is a user-friendly lib for sockets in Golang. You can send and listen to TCP connections with a few lines of code.
+Hare is a user-friendly lib for sockets in Golang and a CLI tool for interaction with sockets. You can send and listen to TCP connections with a few lines of code or commands.
 
 ## Contents
 
@@ -27,6 +27,26 @@ Hare is a user-friendly lib for sockets in Golang. You can send and listen to TC
 
 ## 🖥️ Installation
 
+Installation guid for the CLI Tool and the Golang Library.
+
+### 💻 CLI Tool
+
+To install the CLI tool, you can install it through [Homebrew](https://brew.sh/):
+
+```shell
+$ brew tap leozz37/hare
+
+$ brew install hare
+```
+
+Or you can install manually with the `Makefile` script:
+
+```shell
+$ make install
+```
+
+### 🐇 Golang Lib
+
 First, you need [Go](https://golang.org/) installed (version 1.12+ is required), then you can install Hare:
 
 ```shell
@@ -39,15 +59,46 @@ Import it in your code:
 import "github.com/leozz37/hare"
 ```
 
-(Optional) install [jaguar](https://github.com/leozz37/jaguar) for testing the sockets:
+## 🍕 Quickstart
+
+Quick start for the CLI Tool and the Golang Library.
+
+### 💻 CLI Tool
+
+To use the CLI tool, these are the flags:
+
+```
+  -d string
+        Data to be sended
+  -h string
+        Host address to bo operated (default "localhost")
+  -l    Listen to a given address
+  -p string
+        Port address to bo operated         [REQUIRED]
+  -s    Send message to a given address
+```
+
+You can run the `--help`  flag:
+
+```shell
+$ hare --help
+```
+
+To `Listen` to port `3000` for example, run:
 
 ```shell
-$ brew tap leozz37/jaguar
+$ hare -l -p 3000
+```
+
+To `Send` a payload with the message `Hello World` to port `3000` for example, run:
 
-$ brew install jaguar
+```shell
+$ hare -s -p 3000 -d 'Hello World'
 ```
 
-## 🍕 Quickstart
+![cli-example](resources/images/cli-example.png)
+
+### 🐇 Golang Lib
 
 [Sample code](./examples/send.go) for sending payloads:
 

cmd/cli/cli.go

@@ -0,0 +1,64 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+
+	"github.com/fatih/color"
+	"github.com/leozz37/hare/hare"
+)
+
+func main() {
+	sendPtr := flag.Bool("s", false, "Send message to a given address")
+	listenPtr := flag.Bool("l", false, "Listen to a given address")
+	portPtr := flag.String("p", "", "Port address to bo operated")
+	hostPtr := flag.String("h", "localhost", "Host address to bo operated")
+	dataPtr := flag.String("d", "", "Data to be sended")
+
+	flag.Parse()
+	if *sendPtr && *listenPtr {
+		flag.PrintDefaults()
+		fmt.Errorf("You can only listen OR send to a port")
+	}
+	if *portPtr == "" {
+		flag.PrintDefaults()
+		fmt.Errorf("Flag PORT is required.")
+	}
+
+	if *listenPtr {
+		err := listenPort(*portPtr, *hostPtr)
+		if err != nil {
+			fmt.Errorf("Could listen to address")
+		}
+	}
+	if *sendPtr {
+		err := sendMessage(*portPtr, *hostPtr, *dataPtr)
+		if err != nil {
+			fmt.Errorf("Could send to address")
+		}
+	}
+}
+
+func listenPort(port, host string) error {
+	red := color.New(color.FgRed).SprintFunc()
+	fmt.Printf("Listening to port: %s\n", red(port))
+
+	r, err := hare.Listen(port)
+	if err != nil {
+		panic(err)
+	}
+
+	for {
+		if r.HasNewMessages() {
+			fmt.Println(r.GetMessage())
+		}
+	}
+}
+
+func sendMessage(port, host, data string) error {
+	err := hare.Send(port, data)
+	if err != nil {
+		panic(err)
+	}
+	return nil
+}

go.mod

@@ -1,3 +1,5 @@
 module github.com/leozz37/hare
 
 go 1.15
+
+require github.com/fatih/color v1.12.0 // indirect

go.sum

@@ -0,0 +1,9 @@
+github.com/fatih/color v1.12.0 h1:mRhaKNwANqRgUBGKmnI5ZxEk7QXmjQeCcuYFMX2bfcc=
+github.com/fatih/color v1.12.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
+github.com/mattn/go-colorable v0.1.8 h1:c1ghPdyEDarC70ftn0y+A/Ee++9zz8ljHG1b13eJ0s8=
+github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae h1:/WDfKMnPU+m5M4xB+6x4kaepxRw6jWvR5iDRdvjHgy8=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=