Merge pull request #9 for v0.7 Release

Author: jeevatkm

.travis.yml

@@ -11,11 +11,15 @@ branches:
 
 go:
   - 1.8
-  - 1.8.x
+  - 1.9
   - tip
 
 go_import_path: aahframework.org/essentials.v0
 
+install:
+  - git config --global http.https://aahframework.org.followRedirects true
+  - go get -t -v ./...
+
 script:
   - bash <(curl -s https://aahframework.org/go-test)
 

README.md

@@ -1,19 +1,21 @@
 # essentials - aah framework
 [![Build Status](https://travis-ci.org/go-aah/essentials.svg?branch=master)](https://travis-ci.org/go-aah/essentials) [![codecov](https://codecov.io/gh/go-aah/essentials/branch/master/graph/badge.svg)](https://codecov.io/gh/go-aah/essentials/branch/master) [![Go Report Card](https://goreportcard.com/badge/aahframework.org/essentials.v0)](https://goreportcard.com/report/aahframework.org/essentials.v0)
-[![Version](https://img.shields.io/badge/version-0.6-blue.svg)](https://github.com/go-aah/essentials/releases/latest) [![GoDoc](https://godoc.org/aahframework.org/essentials.v0?status.svg)](https://godoc.org/aahframework.org/essentials.v0)  [![License](https://img.shields.io/github/license/go-aah/essentials.svg)](LICENSE)
+[![Version](https://img.shields.io/badge/version-0.7-blue.svg)](https://github.com/go-aah/essentials/releases/latest) [![GoDoc](https://godoc.org/aahframework.org/essentials.v0?status.svg)](https://godoc.org/aahframework.org/essentials.v0)  [![License](https://img.shields.io/github/license/go-aah/essentials.svg)](LICENSE)
 
-***v0.6 [released](https://github.com/go-aah/essentials/releases/latest) and tagged on Jul 22, 2017***
+***v0.7 [released](https://github.com/go-aah/essentials/releases/latest) and tagged on Sep 29, 2017***
 
 `essentials` contains simple & useful utils methods for Go. aah framework utilizes essentials (aka `ess`) library across. Essentials library complements with handy methods, refer godoc to know more about methods:
-* filepath
-* GUID (Globally Unique Identifier)
-* random string, random byte generation at fixed length
-* go
-* io
-* os
-* reflect
-* string
-* archive (zip)
+
+  * filepath
+  * GUID (Globally Unique Identifier - Mongo Object ID algorithm)
+  * random string, random byte generation at fixed length
+  * go
+  * io
+  * os
+  * reflect
+  * string
+  * encode
+  * archive (zip)
 
 *`essentials` developed for aah framework. However, it's an independent library, can be used separately with any `Go` language project. Feel free to use it.*
 

encode.go

@@ -0,0 +1,36 @@
+// Copyright (c) Jeevanandam M. (https://github.com/jeevatkm)
+// go-aah/essentials source code and usage is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package ess
+
+import (
+	"encoding/base64"
+	"errors"
+)
+
+// ErrBase64Decode returned when given string unable to do base64 decode.
+var ErrBase64Decode = errors.New("encoding/base64: decode error")
+
+//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
+// Encode/Decode Base64 methods
+//___________________________________
+
+// EncodeToBase64 method encodes given bytes into base64 bytes.
+// Reference: https://github.com/golang/go/blob/master/src/encoding/base64/base64.go#L169
+func EncodeToBase64(v []byte) []byte {
+	encoded := make([]byte, base64.URLEncoding.EncodedLen(len(v)))
+	base64.URLEncoding.Encode(encoded, v)
+	return encoded
+}
+
+// DecodeBase64 method decodes given base64 into bytes.
+// Reference: https://github.com/golang/go/blob/master/src/encoding/base64/base64.go#L384
+func DecodeBase64(v []byte) ([]byte, error) {
+	decoded := make([]byte, base64.URLEncoding.DecodedLen(len(v)))
+	b, err := base64.URLEncoding.Decode(decoded, v)
+	if err != nil {
+		return nil, ErrBase64Decode
+	}
+	return decoded[:b], nil
+}

encode_test.go

@@ -0,0 +1,26 @@
+// Copyright (c) Jeevanandam M. (https://github.com/jeevatkm)
+// go-aah/essentials source code and usage is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package ess
+
+import (
+	"testing"
+
+	"aahframework.org/test.v0/assert"
+)
+
+func TestEncodeBase64(t *testing.T) {
+	value := "this is gonna be encoded in base64"
+
+	valueBytes := EncodeToBase64([]byte(value))
+	assert.NotNil(t, valueBytes)
+
+	decoded, err := DecodeBase64(valueBytes)
+	assert.Nil(t, err)
+	assert.NotNil(t, decoded)
+
+	_, err = DecodeBase64([]byte("dGhpcyBpcyBnb25uYSBiZSBlbmGVkIGluIGJhc2U2NA=="))
+	assert.NotNil(t, err)
+	assert.Equal(t, ErrBase64Decode, err)
+}

random_key.go

@@ -25,41 +25,41 @@ var (
 	mr       *sync.Mutex
 )
 
-//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
-// Random String methods
-//___________________________________
+//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
+// Random String methods (Secure and Math)
+//_________________________________________
 
-// RandomString method generates the random string for given length using
+// SecureRandomString method generates the random string for given length using
 // `crypto/rand`.
-func RandomString(length int) string {
-	return hex.EncodeToString(GenerateRandomKey(length / 2))
+func SecureRandomString(length int) string {
+	return hex.EncodeToString(GenerateSecureRandomKey(length / 2))
 }
 
-// RandomStringbm method generates the random string for given length using
+// RandomString method generates the random string for given length using
 // `math/rand.Source` and byte mask.
-func RandomStringbm(length int) string {
-	return string(GenerateRandomKeybm(length))
+func RandomString(length int) string {
+	return string(GenerateRandomKey(length))
 }
 
-//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
-// Random key methods
-//___________________________________
+//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
+// Random Key Methods (Secure and Math)
+//_______________________________________
 
-// GenerateRandomKey method generates the random bytes for given length using
+// GenerateSecureRandomKey method generates the random bytes for given length using
 // `crypto/rand`.
-func GenerateRandomKey(length int) []byte {
+func GenerateSecureRandomKey(length int) []byte {
 	k := make([]byte, length)
 	if _, err := io.ReadFull(rand.Reader, k); err != nil {
 		// fallback to math based random key generater
-		return GenerateRandomKeybm(length)
+		return GenerateRandomKey(length)
 	}
 	return k
 }
 
-// GenerateRandomKeybm method generates the random bytes for given length using
+// GenerateRandomKey method generates the random bytes for given length using
 // `math/rand.Source` and byte mask.
 // StackOverflow Ref - http://stackoverflow.com/a/31832326
-func GenerateRandomKeybm(length int) []byte {
+func GenerateRandomKey(length int) []byte {
 	b := make([]byte, length)
 	// A randSrc() generates 63 random bits, enough for letterIdxMax characters!
 	for i, cache, remain := length-1, randSrc(), letterIdxMax; i >= 0; {

random_key_test.go

@@ -11,33 +11,33 @@ import (
 )
 
 func TestEssRandomKey(t *testing.T) {
-	key1 := GenerateRandomKey(32)
+	key1 := GenerateSecureRandomKey(32)
 	assert.NotNil(t, key1)
 	assert.True(t, len(key1) == 32)
 
-	key2 := GenerateRandomKeybm(64)
+	key2 := GenerateRandomKey(64)
 	assert.NotNil(t, key2)
 	assert.True(t, len(key2) == 64)
 }
 
 func TestEssRandomString(t *testing.T) {
-	str1 := RandomString(32)
+	str1 := SecureRandomString(32)
 	assert.True(t, len(str1) == 32)
 	assert.NotNil(t, str1)
 
-	str2 := RandomStringbm(32)
+	str2 := RandomString(32)
 	assert.True(t, len(str2) == 32)
 	assert.NotNil(t, str2)
 }
 
 func BenchmarkGenerateRandomKey(b *testing.B) {
 	for i := 0; i < b.N; i++ {
-		GenerateRandomKey(16)
+		GenerateSecureRandomKey(16)
 	}
 }
 
-func BenchmarkGenerateRandomKeybm(b *testing.B) {
+func BenchmarkGenerateMathRandomKey(b *testing.B) {
 	for i := 0; i < b.N; i++ {
-		GenerateRandomKeybm(32)
+		GenerateRandomKey(32)
 	}
 }

essentials.go renamed to version.go

@@ -7,4 +7,4 @@
 package ess
 
 // Version no. of essentials library
-var Version = "0.6"
+var Version = "0.7"