add tests to properly test interfaces and fix constant naming conventions

Author: WillatShopKeep

auth.go

@@ -12,12 +12,12 @@ import (
 )
 
 const (
-	ACCESS_ENV_KEY = "AWS_ACCESS_KEY"
-	SECRET_ENV_KEY = "AWS_SECRET_KEY"
+	AccessEnvKey = "AWS_ACCESS_KEY"
+	SecretEnvKey = "AWS_SECRET_KEY"
 
-	AWS_METADATA_SERVER = "169.254.169.254"
-	AWS_IAM_CREDS_PATH  = "/latest/meta-data/iam/security-credentials"
-	AWS_IAM_CREDS_URL   = "http://" + AWS_METADATA_SERVER + AWS_IAM_CREDS_PATH
+	AWSMetadataServer = "169.254.169.254"
+	AWSIAMCredsPath   = "/latest/meta-data/iam/security-credentials"
+	AWSIAMCredsURL    = "http://" + AWSMetadataServer + "/" + AWSIAMCredsPath
 )
 
 // Auth interface for authentication credentials and information
@@ -31,7 +31,7 @@ type Auth interface {
 	Sign(*Service, time.Time) []byte
 }
 
-type auth struct {
+type AuthCredentials struct {
 	// accessKey, secretKey are the standard AWS auth credentials
 	accessKey, secretKey, token string
 
@@ -41,22 +41,22 @@ type auth struct {
 	expiry time.Time
 }
 
-func NewAuth(accessKey, secretKey string) Auth {
-	return &auth{
+func NewAuth(accessKey, secretKey string) *AuthCredentials {
+	return &AuthCredentials{
 		accessKey: accessKey,
 		secretKey: secretKey,
 	}
 }
 
 // NewAuthFromEnv retrieves auth credentials from environment vars
-func NewAuthFromEnv() (Auth, error) {
-	accessKey := os.Getenv(ACCESS_ENV_KEY)
-	secretKey := os.Getenv(SECRET_ENV_KEY)
+func NewAuthFromEnv() (*AuthCredentials, error) {
+	accessKey := os.Getenv(AccessEnvKey)
+	secretKey := os.Getenv(SecretEnvKey)
 	if accessKey == "" {
-		return nil, fmt.Errorf("Unable to retrieve access key from %s env variable", ACCESS_ENV_KEY)
+		return nil, fmt.Errorf("Unable to retrieve access key from %s env variable", AccessEnvKey)
 	}
 	if secretKey == "" {
-		return nil, fmt.Errorf("Unable to retrieve secret key from %s env variable", SECRET_ENV_KEY)
+		return nil, fmt.Errorf("Unable to retrieve secret key from %s env variable", SecretEnvKey)
 	}
 
 	return NewAuth(accessKey, secretKey), nil
@@ -68,41 +68,41 @@ func NewAuthFromEnv() (Auth, error) {
 //
 // TODO: specify custom network (connect, read) timeouts, else this will block
 // for the default timeout durations.
-func NewAuthFromMetadata() (Auth, error) {
-	auth := &auth{}
+func NewAuthFromMetadata() (*AuthCredentials, error) {
+	auth := &AuthCredentials{}
 	if err := auth.Renew(); err != nil {
 		return nil, err
 	}
 	return auth, nil
 }
 
 // HasExpiration returns true if the expiration time is non-zero and false otherwise
-func (a *auth) HasExpiration() bool {
+func (a *AuthCredentials) HasExpiration() bool {
 	return !a.expiry.IsZero()
 }
 
 // GetExpiration retrieves the current expiration time
-func (a *auth) GetExpiration() time.Time {
+func (a *AuthCredentials) GetExpiration() time.Time {
 	return a.expiry
 }
 
 // GetToken returns the token
-func (a *auth) GetToken() string {
+func (a *AuthCredentials) GetToken() string {
 	return a.token
 }
 
 // GetSecretKey returns the secret key
-func (a *auth) GetSecretKey() string {
+func (a *AuthCredentials) GetSecretKey() string {
 	return a.secretKey
 }
 
 // GetAccessKey returns the access key
-func (a *auth) GetAccessKey() string {
+func (a *AuthCredentials) GetAccessKey() string {
 	return a.accessKey
 }
 
 // Renew retrieves a new token and mutates it on an instance of the Auth struct
-func (a *auth) Renew() error {
+func (a *AuthCredentials) Renew() error {
 	role, err := retrieveIAMRole()
 	if err != nil {
 		return err
@@ -127,7 +127,7 @@ func (a *auth) Renew() error {
 // Sign API request by
 // http://docs.amazonwebservices.com/general/latest/gr/signature-version-4.html
 
-func (a *auth) Sign(s *Service, t time.Time) []byte {
+func (a *AuthCredentials) Sign(s *Service, t time.Time) []byte {
 	h := ghmac([]byte("AWS4"+a.GetSecretKey()), []byte(t.Format(iSO8601BasicFormatShort)))
 	h = ghmac(h, []byte(s.Region))
 	h = ghmac(h, []byte(s.Name))
@@ -138,7 +138,7 @@ func (a *auth) Sign(s *Service, t time.Time) []byte {
 func retrieveAWSCredentials(role string) (map[string]string, error) {
 	var bodybytes []byte
 	// Retrieve the json for this role
-	resp, err := http.Get(AWS_IAM_CREDS_URL + "/" + role)
+	resp, err := http.Get(fmt.Sprintf("%s/%s", AWSIAMCredsURL, role))
 	if err != nil || resp.StatusCode != http.StatusOK {
 		return nil, err
 	}
@@ -161,7 +161,7 @@ func retrieveAWSCredentials(role string) (map[string]string, error) {
 func retrieveIAMRole() (string, error) {
 	var bodybytes []byte
 
-	resp, err := http.Get(AWS_IAM_CREDS_URL)
+	resp, err := http.Get(AWSIAMCredsURL)
 	if err != nil || resp.StatusCode != http.StatusOK {
 		return "", err
 	}

auth_test.go

@@ -5,6 +5,13 @@ import (
 	"testing"
 )
 
+func TestAuthInterfaceIsImplemented(t *testing.T) {
+	var auth Auth = &AuthCredentials{}
+	if auth == nil {
+		t.Error("Invalid nil auth credentials value")
+	}
+}
+
 func TestGetSecretKey(t *testing.T) {
 	auth := NewAuth("BAD_ACCESS_KEY", "BAD_SECRET_KEY")
 
@@ -22,8 +29,8 @@ func TestGetAccessKey(t *testing.T) {
 }
 
 func TestNewAuthFromEnv(t *testing.T) {
-	os.Setenv(ACCESS_ENV_KEY, "asdf")
-	os.Setenv(SECRET_ENV_KEY, "asdf")
+	os.Setenv(AccessEnvKey, "asdf")
+	os.Setenv(SecretEnvKey, "asdf")
 
 	auth, _ := NewAuthFromEnv()
 
@@ -35,6 +42,6 @@ func TestNewAuthFromEnv(t *testing.T) {
 		t.Error("Expected SecretKey to be inferred as \"asdf\"")
 	}
 
-	os.Setenv(ACCESS_ENV_KEY, "") // Use Unsetenv with go1.4
-	os.Setenv(SECRET_ENV_KEY, "") // Use Unsetenv with go1.4
+	os.Setenv(AccessEnvKey, "") // Use Unsetenv with go1.4
+	os.Setenv(SecretEnvKey, "") // Use Unsetenv with go1.4
 }

client.go

@@ -5,7 +5,7 @@ import (
 	"time"
 )
 
-const AWS_SECURITY_TOKEN_HEADER = "X-Amz-Security-Token"
+const AWSSecurityTokenHeader = "X-Amz-Security-Token"
 
 // Client is like http.Client, but signs all requests using Auth.
 type Client struct {
@@ -42,7 +42,7 @@ func (c *Client) Do(req *http.Request) (*http.Response, error) {
 	}
 
 	if c.auth.GetToken() != "" {
-		req.Header.Add(AWS_SECURITY_TOKEN_HEADER, c.auth.GetToken())
+		req.Header.Add(AWSSecurityTokenHeader, c.auth.GetToken())
 	}
 
 	return c.client.Do(req)

examples/example.go

@@ -5,7 +5,8 @@ import (
 	"os"
 	"time"
 
-	kinesis "github.com/sendgridlabs/go-kinesis"
+	// kinesis "github.com/sendgridlabs/go-kinesis"
+	kinesis "github.com/wchan2/go-kinesis"
 )
 
 func getRecords(ksis kinesis.KinesisClient, streamName, ShardId string) {

kinesis-cli/kinesis-cli.go

@@ -22,7 +22,8 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/sendgridlabs/go-kinesis"
+	// "github.com/sendgridlabs/go-kinesis"
+	"github.com/wchan2/go-kinesis"
 )
 
 const HELP = `Usage: ./kinesis-cli <command> [<arg>, ...]
@@ -117,14 +118,14 @@ func main() {
 	if len(os.Args) < 2 {
 		die(true, "Error: no command specified.")
 	}
-	if os.Getenv(kinesis.ACCESS_ENV_KEY) == "" ||
-		os.Getenv(kinesis.SECRET_ENV_KEY) == "" {
+	if os.Getenv(kinesis.AccessEnvKey) == "" ||
+		os.Getenv(kinesis.SecretEnvKey) == "" {
 		fmt.Printf("WARNING: %s and/or %s environment variables not set. Will "+
 			"attempt to fetch credentials from metadata server.\n",
-			kinesis.ACCESS_ENV_KEY, kinesis.SECRET_ENV_KEY)
+			kinesis.AccessEnvKey, kinesis.SecretEnvKey)
 	}
-	if os.Getenv(kinesis.REGION_ENV_NAME) == "" {
-		fmt.Printf("WARNING: %s not set.\n", kinesis.REGION_ENV_NAME)
+	if os.Getenv(kinesis.RegionEnvName) == "" {
+		fmt.Printf("WARNING: %s not set.\n", kinesis.RegionEnvName)
 	}
 	switch os.Args[1] {
 	case "create":

kinesis.go

@@ -12,8 +12,8 @@ import (
 )
 
 const (
-	ACTION_KEY      = "Action"
-	REGION_ENV_NAME = "AWS_REGION_NAME"
+	ActionKey     = "Action"
+	RegionEnvName = "AWS_REGION_NAME"
 
 	// Regions
 	USEast1      = "us-east-1"
@@ -29,11 +29,11 @@ const (
 
 // NewRegionFromEnv creates a region from the an expected environment variable
 func NewRegionFromEnv() string {
-	return os.Getenv(REGION_ENV_NAME)
+	return os.Getenv(RegionEnvName)
 }
 
 // Structure for kinesis client
-type kinesis struct {
+type Kinesis struct {
 	client   *Client
 	endpoint string
 	region   string
@@ -56,31 +56,31 @@ type KinesisClient interface {
 
 // New returns an initialized AWS Kinesis client using the canonical live “production” endpoint
 // for AWS Kinesis, i.e. https://kinesis.{region}.amazonaws.com
-func New(auth Auth, region string) KinesisClient {
+func New(auth Auth, region string) *Kinesis {
 	endpoint := fmt.Sprintf(kinesisURL, region)
 	return NewWithEndpoint(auth, region, endpoint)
 }
 
 // NewWithClient returns an initialized AWS Kinesis client using the canonical live “production” endpoint
 // for AWS Kinesis, i.e. https://kinesis.{region}.amazonaws.com but with the ability to create a custom client
 // with specific configurations like a timeout
-func NewWithClient(auth Auth, region string, client *Client) KinesisClient {
+func NewWithClient(region string, client *Client) *Kinesis {
 	endpoint := fmt.Sprintf(kinesisURL, region)
-	return &kinesis{client: client, version: "20131202", region: region, endpoint: endpoint}
+	return &Kinesis{client: client, version: "20131202", region: region, endpoint: endpoint}
 }
 
 // NewWithEndpoint returns an initialized AWS Kinesis client using the specified endpoint.
 // This is generally useful for testing, so a local Kinesis server can be used.
-func NewWithEndpoint(auth Auth, region string, endpoint string) KinesisClient {
+func NewWithEndpoint(auth Auth, region string, endpoint string) *Kinesis {
 	// TODO: remove trailing slash on endpoint if there is one? does it matter?
 	// TODO: validate endpoint somehow?
-	return &kinesis{client: NewClient(auth), version: "20131202", region: region, endpoint: endpoint}
+	return &Kinesis{client: NewClient(auth), version: "20131202", region: region, endpoint: endpoint}
 }
 
 // Create params object for request
 func makeParams(action string) map[string]string {
 	params := make(map[string]string)
-	params[ACTION_KEY] = action
+	params[ActionKey] = action
 	return params
 }
 
@@ -152,7 +152,7 @@ func buildError(r *http.Response) error {
 }
 
 // Query by AWS API
-func (kinesis *kinesis) query(params map[string]string, data interface{}, resp interface{}) error {
+func (kinesis *Kinesis) query(params map[string]string, data interface{}, resp interface{}) error {
 	jsonData, err := json.Marshal(data)
 	if err != nil {
 		return err
@@ -171,7 +171,7 @@ func (kinesis *kinesis) query(params map[string]string, data interface{}, resp i
 
 	// headers
 	request.Header.Set("Content-Type", "application/x-amz-json-1.1")
-	request.Header.Set("X-Amz-Target", fmt.Sprintf("Kinesis_%s.%s", kinesis.version, params[ACTION_KEY]))
+	request.Header.Set("X-Amz-Target", fmt.Sprintf("Kinesis_%s.%s", kinesis.version, params[ActionKey]))
 	request.Header.Set("User-Agent", "Golang Kinesis")
 
 	// response
@@ -195,7 +195,7 @@ func (kinesis *kinesis) query(params map[string]string, data interface{}, resp i
 // CreateStream adds a new Amazon Kinesis stream to your AWS account
 // StreamName is a name of stream, ShardCount is number of shards
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html
-func (kinesis *kinesis) CreateStream(StreamName string, ShardCount int) error {
+func (kinesis *Kinesis) CreateStream(StreamName string, ShardCount int) error {
 	params := makeParams("CreateStream")
 	requestParams := struct {
 		StreamName string
@@ -214,7 +214,7 @@ func (kinesis *kinesis) CreateStream(StreamName string, ShardCount int) error {
 // DeleteStream deletes a stream and all of its shards and data from your AWS account
 // StreamName is a name of stream
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html
-func (kinesis *kinesis) DeleteStream(StreamName string) error {
+func (kinesis *Kinesis) DeleteStream(StreamName string) error {
 	params := makeParams("DeleteStream")
 	requestParams := struct {
 		StreamName string
@@ -230,7 +230,7 @@ func (kinesis *kinesis) DeleteStream(StreamName string) error {
 
 // MergeShards merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_MergeShards.html
-func (kinesis *kinesis) MergeShards(args *RequestArgs) error {
+func (kinesis *Kinesis) MergeShards(args *RequestArgs) error {
 	params := makeParams("MergeShards")
 	err := kinesis.query(params, args.params, nil)
 	if err != nil {
@@ -241,7 +241,7 @@ func (kinesis *kinesis) MergeShards(args *RequestArgs) error {
 
 // SplitShard splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_SplitShard.html
-func (kinesis *kinesis) SplitShard(args *RequestArgs) error {
+func (kinesis *Kinesis) SplitShard(args *RequestArgs) error {
 	params := makeParams("SplitShard")
 	err := kinesis.query(params, args.params, nil)
 	if err != nil {
@@ -258,7 +258,7 @@ type ListStreamsResp struct {
 
 // ListStreams returns an array of the names of all the streams that are associated with the AWS account making the ListStreams request
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html
-func (kinesis *kinesis) ListStreams(args *RequestArgs) (resp *ListStreamsResp, err error) {
+func (kinesis *Kinesis) ListStreams(args *RequestArgs) (resp *ListStreamsResp, err error) {
 	params := makeParams("ListStreams")
 	resp = &ListStreamsResp{}
 	err = kinesis.query(params, args.params, resp)
@@ -300,7 +300,7 @@ type DescribeStreamResp struct {
 // the shard spans, and the IDs of any earlier shards that played in a role in a MergeShards or
 // SplitShard operation that created the shard
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html
-func (kinesis *kinesis) DescribeStream(args *RequestArgs) (resp *DescribeStreamResp, err error) {
+func (kinesis *Kinesis) DescribeStream(args *RequestArgs) (resp *DescribeStreamResp, err error) {
 	params := makeParams("DescribeStream")
 	resp = &DescribeStreamResp{}
 	err = kinesis.query(params, args.params, resp)
@@ -317,7 +317,7 @@ type GetShardIteratorResp struct {
 
 // GetShardIterator returns a shard iterator
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html
-func (kinesis *kinesis) GetShardIterator(args *RequestArgs) (resp *GetShardIteratorResp, err error) {
+func (kinesis *Kinesis) GetShardIterator(args *RequestArgs) (resp *GetShardIteratorResp, err error) {
 	params := makeParams("GetShardIterator")
 	resp = &GetShardIteratorResp{}
 	err = kinesis.query(params, args.params, resp)
@@ -346,7 +346,7 @@ type GetRecordsResp struct {
 
 // GetRecords returns one or more data records from a shard
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html
-func (kinesis *kinesis) GetRecords(args *RequestArgs) (resp *GetRecordsResp, err error) {
+func (kinesis *Kinesis) GetRecords(args *RequestArgs) (resp *GetRecordsResp, err error) {
 	params := makeParams("GetRecords")
 	resp = &GetRecordsResp{}
 	err = kinesis.query(params, args.params, resp)
@@ -365,7 +365,7 @@ type PutRecordResp struct {
 // PutRecord puts a data record into an Amazon Kinesis stream from a producer.
 // args must contain a single record added with AddRecord.
 // More info: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html
-func (kinesis *kinesis) PutRecord(args *RequestArgs) (resp *PutRecordResp, err error) {
+func (kinesis *Kinesis) PutRecord(args *RequestArgs) (resp *PutRecordResp, err error) {
 	params := makeParams("PutRecord")
 
 	if _, ok := args.params["Data"]; !ok && len(args.Records) == 0 {
@@ -391,7 +391,7 @@ func (kinesis *kinesis) PutRecord(args *RequestArgs) (resp *PutRecordResp, err e
 
 // PutRecords puts multiple data records into an Amazon Kinesis stream from a producer
 // more info http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html
-func (kinesis *kinesis) PutRecords(args *RequestArgs) (resp *PutRecordsResp, err error) {
+func (kinesis *Kinesis) PutRecords(args *RequestArgs) (resp *PutRecordsResp, err error) {
 	params := makeParams("PutRecords")
 	resp = &PutRecordsResp{}
 	args.Add("Records", args.Records)