v1.0.6 Expose Clients as Interfaces + Add Mocks (#42)

* Expose clients as interfaces
* Add client mocks that properly handle iterators and wrapped
long-running operations.
* Client initialization option is added to allow for insecure transport

Author: John-peterson-coinbase

clients/options.go

@@ -17,6 +17,7 @@ type WaaSClientConfig struct {
 	APIKey        *auth.APIKey
 	HTTPClient    *http.Client
 	ClientOptions []option.ClientOption
+	Insecure      bool
 }
 
 // WaaSClientOption is a function that applies changes to a clientConfig.
@@ -36,6 +37,14 @@ func WithAPIKey(apiKey *auth.APIKey) WaaSClientOption {
 	}
 }
 
+// WithInsecure returns an option to set the insecure flag.
+// If insecure is set to true, the client will not use transport authentication.
+func WithInsecure(insecure bool) WaaSClientOption {
+	return func(c *WaaSClientConfig) {
+		c.Insecure = insecure
+	}
+}
+
 // WithHTTPClient returns an option to set the HTTP Client.
 func WithHTTPClient(httpClient *http.Client) WaaSClientOption {
 	return func(c *WaaSClientConfig) {
@@ -114,7 +123,7 @@ func GetHTTPClient(serviceName string, config *WaaSClientConfig) (*http.Client,
 		httpClient = &http.Client{}
 	}
 
-	if config.APIKey != nil {
+	if config.Insecure == false {
 		if httpClient.Transport == nil {
 			httpClient.Transport = http.DefaultTransport
 		}

clients/v1/blockchain.go

@@ -19,16 +19,16 @@ const (
 	blockchainServiceEndpoint = "https://api.developer.coinbase.com/waas/blockchain"
 )
 
-// BlockchainServiceClient is the client to use to access WaaS BlockchainService APIs.
-type BlockchainServiceClient struct {
+// blockchainServiceClient is the client to use to access WaaS BlockchainService APIs.
+type blockchainServiceClient struct {
 	client *innerClient.BlockchainClient
 }
 
 // NewBlockchainServiceClient returns a BlockchainServiceClient based on the given inputs.
 func NewBlockchainServiceClient(
 	ctx context.Context,
 	waasOpts ...clients.WaaSClientOption,
-) (*BlockchainServiceClient, error) {
+) (BlockchainServiceClient, error) {
 	config, err := clients.GetConfig(blockchainServiceName, blockchainServiceEndpoint, waasOpts...)
 	if err != nil {
 		return nil, err
@@ -44,27 +44,27 @@ func NewBlockchainServiceClient(
 		return nil, err
 	}
 
-	return &BlockchainServiceClient{
+	return &blockchainServiceClient{
 		client: innerClient,
 	}, nil
 }
 
 // Close closes the connection to the API service. The user should invoke this when
 // the client is no longer required.
-func (p *BlockchainServiceClient) Close() error {
-	return p.client.Close()
+func (b *blockchainServiceClient) Close() error {
+	return b.client.Close()
 }
 
 // Connection returns a connection to the API service.
 //
 // Deprecated: Connections are now pooled so this method does not always
 // return the same resource.
-func (p *BlockchainServiceClient) Connection() *grpc.ClientConn {
-	return p.client.Connection()
+func (b *blockchainServiceClient) Connection() *grpc.ClientConn {
+	return b.client.Connection()
 }
 
 // GetNetwork gets a Network.
-func (b *BlockchainServiceClient) GetNetwork(
+func (b *blockchainServiceClient) GetNetwork(
 	ctx context.Context,
 	req *blockchainpb.GetNetworkRequest,
 	opts ...gax.CallOption) (*blockchainpb.Network, error) {
@@ -118,15 +118,15 @@ func (n *networkIteratorImpl) Response() *blockchainpb.ListNetworksResponse {
 }
 
 // ListNetworks lists the Networks supported by WaaS APIs.
-func (b *BlockchainServiceClient) ListNetworks(
+func (b *blockchainServiceClient) ListNetworks(
 	ctx context.Context,
 	req *blockchainpb.ListNetworksRequest,
 	opts ...gax.CallOption) NetworkIterator {
 	return &networkIteratorImpl{iter: b.client.ListNetworks(ctx, req, opts...)}
 }
 
 // GetAsset retrieves an Asset by resource name.
-func (b *BlockchainServiceClient) GetAsset(
+func (b *blockchainServiceClient) GetAsset(
 	ctx context.Context,
 	req *blockchainpb.GetAssetRequest,
 	opts ...gax.CallOption) (*blockchainpb.Asset, error) {
@@ -155,40 +155,40 @@ type assetIteratorImpl struct {
 }
 
 // PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
-func (n *assetIteratorImpl) PageInfo() *iterator.PageInfo {
-	return n.iter.PageInfo()
+func (a *assetIteratorImpl) PageInfo() *iterator.PageInfo {
+	return a.iter.PageInfo()
 }
 
 // Next returns the next result. Its second return value is iterator.Done if there are no more
 // results. Once Next returns Done, all subsequent calls will return Done.
-func (n *assetIteratorImpl) Next() (*blockchainpb.Asset, error) {
-	asset, err := n.iter.Next()
+func (a *assetIteratorImpl) Next() (*blockchainpb.Asset, error) {
+	asset, err := a.iter.Next()
 
 	return asset, clients.UnwrapError(err)
 }
 
 // Response is the raw response for the current page.
 // Calling Next() or InternalFetch() updates this value.
-func (n *assetIteratorImpl) Response() *blockchainpb.ListAssetsResponse {
-	if n.iter.Response == nil {
+func (a *assetIteratorImpl) Response() *blockchainpb.ListAssetsResponse {
+	if a.iter.Response == nil {
 		return nil
 	}
 
-	response := n.iter.Response.(*blockchainpb.ListAssetsResponse)
+	response := a.iter.Response.(*blockchainpb.ListAssetsResponse)
 
 	return response
 }
 
 // ListAssets lists the Assets supported by WaaS APIs.
-func (b *BlockchainServiceClient) ListAssets(
+func (b *blockchainServiceClient) ListAssets(
 	ctx context.Context,
 	req *blockchainpb.ListAssetsRequest,
 	opts ...gax.CallOption) AssetIterator {
 	return &assetIteratorImpl{b.client.ListAssets(ctx, req, opts...)}
 }
 
 // BatchGetAssets returns the list of Assets indicated by the given request.
-func (b *BlockchainServiceClient) BatchGetAssets(
+func (b *blockchainServiceClient) BatchGetAssets(
 	ctx context.Context,
 	req *blockchainpb.BatchGetAssetsRequest,
 	opts ...gax.CallOption) (*blockchainpb.BatchGetAssetsResponse, error) {