Merge pull request #5 from RedisBloom/examples

[add] adds example for NewClientFromPool

Author: filipecosta90

client.go

@@ -2,9 +2,9 @@ package redis_bloom_go
 
 import (
 	"errors"
-	"strings"
-	"strconv"
 	"github.com/gomodule/redigo/redis"
+	"strconv"
+	"strings"
 )
 
 // TODO: refactor this hard limit and revise client locking
@@ -35,7 +35,6 @@ func NewClient(addr, name string, authPass *string) *Client {
 	return ret
 }
 
-
 // NewClientFromPool creates a new Client with the given pool and client name
 func NewClientFromPool(pool *redis.Pool, name string) *Client {
 	ret := &Client{
@@ -53,11 +52,10 @@ func NewClientFromPool(pool *redis.Pool, name string) *Client {
 func (client *Client) Reserve(key string, error_rate float64, capacity uint64) (err error) {
 	conn := client.Pool.Get()
 	defer conn.Close()
-	_, err = conn.Do("BF.RESERVE", key,  strconv.FormatFloat(error_rate, 'g', 16, 64), capacity)
+	_, err = conn.Do("BF.RESERVE", key, strconv.FormatFloat(error_rate, 'g', 16, 64), capacity)
 	return err
 }
 
-
 // Add - Add (or create and add) a new value to the filter
 // args:
 // key - the name of the filter 
@@ -88,7 +86,7 @@ func (client *Client) Info(key string) (info map[string]int64, err error) {
 	if err != nil {
 		return nil, err
 	}
-	
+
 	values, err := redis.Values(result, nil)
 	if err != nil {
 		return nil, err
@@ -98,7 +96,7 @@ func (client *Client) Info(key string) (info map[string]int64, err error) {
 	}
 	info = map[string]int64{}
 	for i := 0; i < len(values); i += 2 {
-		key, err = redis.String(values[i], nil)	
+		key, err = redis.String(values[i], nil)
 		if err != nil {
 			return nil, err
 		}
@@ -107,5 +105,5 @@ func (client *Client) Info(key string) (info map[string]int64, err error) {
 			return nil, err
 		}
 	}
-	return info, nil				
+	return info, nil
 }

client_test.go

@@ -1,14 +1,13 @@
 package redis_bloom_go
 
 import (
+	"github.com/gomodule/redigo/redis"
+	"github.com/stretchr/testify/assert"
 	"os"
 	"testing"
 	"time"
-	"github.com/gomodule/redigo/redis"
-	"github.com/stretchr/testify/assert"
 )
 
-
 func getTestConnectionDetails() (string, string) {
 	value, exists := os.LookupEnv("REDISBLOOM_TEST_HOST")
 	host := "localhost:6379"
@@ -32,7 +31,6 @@ func createClient() *Client {
 	return NewClient(host, "test_client", ptr)
 }
 
-
 func TestNewClientFromPool(t *testing.T) {
 	host, password := getTestConnectionDetails()
 	pool := &redis.Pool{Dial: func() (redis.Conn, error) {
@@ -65,33 +63,33 @@ func TestReserve(t *testing.T) {
 	key := "test_RESERVE"
 	err := client.Reserve(key, 0.1, 1000)
 	assert.Nil(t, err)
-	
+
 	info, err := client.Info(key)
 	assert.Nil(t, err)
 	assert.Equal(t, info, map[string]int64{
-			"Capacity": 1000,
-			"Expansion rate": 2,
-            "Number of filters": 1,
-            "Number of items inserted": 0,
-            "Size": 932,
+		"Capacity":                 1000,
+		"Expansion rate":           2,
+		"Number of filters":        1,
+		"Number of items inserted": 0,
+		"Size":                     932,
 	})
-	
+
 	err = client.Reserve(key, 0.1, 1000)
 	assert.NotNil(t, err)
 }
 
 func TestAdd(t *testing.T) {
 	client.FlushAll()
 	key := "test_ADD"
-	value := "test_ADD_value";
+	value := "test_ADD_value"
 	exists, err := client.Add(key, value)
 	assert.Nil(t, err)
 	assert.True(t, exists)
-	
+
 	info, err := client.Info(key)
 	assert.Nil(t, err)
 	assert.NotNil(t, info)
-	
+
 	exists, err = client.Add(key, value)
 	assert.Nil(t, err)
 	assert.False(t, exists)
@@ -100,11 +98,11 @@ func TestAdd(t *testing.T) {
 func TestExists(t *testing.T) {
 	client.FlushAll()
 	client.Add("test_ADD", "test_EXISTS")
-	
+
 	exists, err := client.Exists("test_ADD", "test_EXISTS")
 	assert.Nil(t, err)
 	assert.True(t, exists)
-	
+
 	exists, err = client.Exists("test_ADD", "test_EXISTS1")
 	assert.Nil(t, err)
 	assert.False(t, exists)

example_client_test.go

@@ -3,6 +3,8 @@ package redis_bloom_go_test
 import (
 	"fmt"
 	redisbloom "github.com/RedisBloom/redisbloom-go"
+	"github.com/gomodule/redigo/redis"
+	"log"
 )
 
 // exemplifies the NewClient function
@@ -21,6 +23,30 @@ func ExampleNewClient() {
 		fmt.Println("Error:", err)
 	}
 	fmt.Println("myItem exists in mytest: ", exists)
-	// myItem exists in mytest:  true
+	// Output: myItem exists in mytest:  true
+
+}
+
+// exemplifies the NewClientFromPool function
+func ExampleNewClientFromPool() {
+	host := "localhost:6379"
+	password := ""
+	pool := &redis.Pool{Dial: func() (redis.Conn, error) {
+		return redis.Dial("tcp", host, redis.DialPassword(password))
+	}}
+	client := redisbloom.NewClientFromPool(pool, "bloom-client-1")
+
+	// BF.ADD mytest item
+	_, err := client.Add("mytest", "myItem")
+	if err != nil {
+		log.Fatalf("Error: %v", err)
+	}
+
+	exists, err := client.Exists("mytest", "myItem")
+	if err != nil {
+		log.Fatalf("Error: %v", err)
+	}
+	fmt.Println("myItem exists in mytest: ", exists)
+	// Output: myItem exists in mytest:  true
 
 }

pool.go

@@ -17,6 +17,7 @@ type ConnPool interface {
 type SingleHostPool struct {
 	*redis.Pool
 }
+
 //
 //func (s SingleHostPool) Close() {
 //	s.Pool.Close()
@@ -39,7 +40,6 @@ type MultiHostPool struct {
 	authPass *string
 }
 
-
 func (p *MultiHostPool) Close() (err error) {
 	p.Lock()
 	defer p.Unlock()
@@ -57,7 +57,6 @@ func (p *MultiHostPool) Close() (err error) {
 	return
 }
 
-
 func NewMultiHostPool(hosts []string, authPass *string) *MultiHostPool {
 	return &MultiHostPool{
 		pools:    make(map[string]*redis.Pool, len(hosts)),