adding pr template file

README.md

@@ -2,31 +2,69 @@
 
 This is a Go library for making bots with Smooch service.
 
+_**Note** : This a modified version version of [EddyTravels/smooch](https://github.com/EddyTravels/smooch) library with additional features. Please refer to the original repo for the original features._
+
+## Additional Feature
+
+- Token expiration & its checking.
+- Pre-create app user and link app user to specified channel functionality.
+- Send message in whatsapp HSM format.
+- Renew token functionality whenever token is expired.
+- Support smooch basic auth and JWT auth.
+- Redis support as a centralized storage to store JWT token for supporting autoscaling environment. Use redigo as redis library.
+
 ## Tips
 
 Smooch documentation: https://docs.smooch.io/rest/
 
 ## Installing
 
 ```
-$ go get -u github.com/EddyTravels/smooch
+$ go get -u github.com/kitabisa/smooch
 ```
 
 ## Example
 
+Using basic authentication :
+
+
+```
+import (
+	"os"
+
+	"github.com/kitabisa/smooch"
+)
+
+func main() {
+    smoochClient, err := smooch.New(smooch.Options{
+        Auth:         smooch.AuthBasic,
+        AppID:        os.Getenv("SMOOCH_APP_ID"),
+        KeyID:        os.Getenv("SMOOCH_KEY_ID"),
+        Secret:       os.Getenv("SMOOCH_SECRET"),
+    })
+
+    if err != nil {
+        panic(err)
+    }
+}
+```
+
+Using JWT authentication :
+
 ```
 import (
 	"os"
 
-	"github.com/EddyTravels/smooch"
+	"github.com/kitabisa/smooch"
 )
 
 func main() {
     smoochClient, err := smooch.New(smooch.Options{
+        Auth:         smooch.AuthJWT,
         AppID:        os.Getenv("SMOOCH_APP_ID"),
         KeyID:        os.Getenv("SMOOCH_KEY_ID"),
         Secret:       os.Getenv("SMOOCH_SECRET"),
-        VerifySecret: os.Getenv("SMOOCH_VERIFY_SECRET"),
+        RedisPool:    redisPool,
     })
 
     if err != nil {

error.go

@@ -6,6 +6,12 @@ import (
 	"net/http"
 )
 
+// ResponseData defines data for every response
+type ResponseData struct {
+	HTTPCode int
+	Flag     string
+}
+
 type SmoochError struct {
 	message string
 	code    int
@@ -19,11 +25,11 @@ func (e *SmoochError) Error() string {
 	return e.message
 }
 
-func checkSmoochError(r *http.Response) error {
+func checkSmoochError(r *http.Response) (*ResponseData, error) {
 	var errorPayload ErrorPayload
 	decodeErr := json.NewDecoder(r.Body).Decode(&errorPayload)
 	if decodeErr != nil {
-		return decodeErr
+		return nil, decodeErr
 	}
 
 	err := &SmoochError{
@@ -35,5 +41,9 @@ func checkSmoochError(r *http.Response) error {
 		code: r.StatusCode,
 	}
 
-	return err
+	respData := &ResponseData{
+		HTTPCode: r.StatusCode,
+		Flag:     errorPayload.Details.Code,
+	}
+	return respData, err
 }

error_test.go

@@ -27,7 +27,7 @@ func TestCheckSmoochError(t *testing.T) {
 		Body:       r,
 	}
 
-	err := checkSmoochError(response)
+	_, err := checkSmoochError(response)
 	assert.Error(t, err)
 	assert.EqualError(t, err, "StatusCode: 401 Code: unauthorized Message: Authorization is required")
 }

go.mod

@@ -1,6 +1,10 @@
-module github.com/EddyTravels/smooch
+module github.com/kitabisa/smooch
 
 require (
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
+	github.com/gomodule/redigo v2.0.0+incompatible
+	github.com/mitchellh/mapstructure v1.1.2 // indirect
 	github.com/stretchr/testify v1.3.0
 )
+
+go 1.13

go.sum

@@ -2,8 +2,14 @@ github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
+github.com/gomodule/redigo v2.0.0+incompatible h1:K/R+8tc58AaqLkqG2Ol3Qk+DR/TlNuhuh457pBFPtt0=
+github.com/gomodule/redigo v2.0.0+incompatible/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4=
+github.com/kitabisa/smooch v0.1.0 h1:dS+ouObVdoNFVZWMIqULMr/VbQoYhsBuSUdmp0VjbcM=
+github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
+github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

jwt.go

@@ -1,12 +1,18 @@
 package smooch
 
 import (
+	"time"
+
 	jwt "github.com/dgrijalva/jwt-go"
 )
 
+// JWTExpiration defines how many seconds jwt token is valid
+const JWTExpiration = 3600
+
 func GenerateJWT(scope string, keyID string, secret string) (string, error) {
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
 		"scope": scope,
+		"exp":   time.Now().Unix() + JWTExpiration,
 	})
 	token.Header = map[string]interface{}{
 		"alg": "HS256",
@@ -16,3 +22,38 @@ func GenerateJWT(scope string, keyID string, secret string) (string, error) {
 
 	return token.SignedString([]byte(secret))
 }
+
+// getJWTExpiration will get jwt expiration time
+func getJWTExpiration(jwtToken string, secret string) (int64, error) {
+	claims := jwt.MapClaims{}
+
+	_, err := jwt.ParseWithClaims(jwtToken, &claims, func(t *jwt.Token) (interface{}, error) {
+		return []byte(secret), nil
+	})
+	if err != nil {
+		return -1, err
+	}
+
+	expiredIn := claims["exp"].(int64) - time.Now().Unix()
+	return expiredIn, nil
+}
+
+// isJWTExpired will check whether Smooch JWT is expired or not.
+func isJWTExpired(jwtToken string, secret string) (bool, error) {
+	_, err := jwt.ParseWithClaims(jwtToken, jwt.MapClaims{}, func(t *jwt.Token) (interface{}, error) {
+		return []byte(secret), nil
+	})
+
+	if err == nil {
+		return false, nil
+	}
+
+	switch err.(type) {
+	case *jwt.ValidationError:
+		vErr := err.(*jwt.ValidationError)
+		if vErr.Errors == jwt.ValidationErrorExpired {
+			return true, nil
+		}
+	}
+	return false, err
+}

pull_request_template.md

@@ -0,0 +1,23 @@
+## What does this PR do?
+_Place what this pull request changes and anything affected. If your PR block or require another PR, also need to mention here_
+
+## Why are we doing this? Any context or related work?
+_You may put your JIRA card link here_
+
+## Where should a reviewer start?
+_optional -- if your changes affected so much files, it is encouraged to give helper for reviewer_
+
+## Screenshots
+_optional -- You may put the database, sequence or any diagram needed_
+
+## Manual testing steps?
+_Steps to do tests. including all possible that can hape_
+
+## Database changes
+_optional -- If there's database changes, put it here_
+
+## Config changes
+_optional -- If there's config changes, put it here_
+
+## Deployment instructions
+_optional -- Better to put it if there's some 'special case' for deployment_