bump aws.signature version

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: aws.iam
 Type: Package
 Title: AWS IAM Client Package
-Version: 0.1.5
-Date: 2016-12-20
+Version: 0.1.6
+Date: 2017-06-30
 Author: Thomas J. Leeper
 Maintainer: Thomas J. Leeper <[email protected]>
 Description: A simple client package for the Amazon Web Services (AWS) Identity
@@ -13,7 +13,7 @@ Imports:
     httr,
     xml2,
     jsonlite,
-    aws.signature (>= 0.2.6)
+    aws.signature (>= 0.3.4)
 URL: https://github.com/cloudyr/aws.iam
 BugReports: https://github.com/cloudyr/aws.iam/issues
-RoxygenNote: 5.0.1
+RoxygenNote: 6.0.1

NEWS.md

@@ -1,3 +1,7 @@
+# CHANGES TO aws.iam 0.1.5
+
+* Bump **aws.signature** dependency to 0.3.4.
+
 # CHANGES TO aws.iam 0.1.4
 
 * Documentation fixes. (#5)

R/http.R

@@ -5,10 +5,10 @@
 #' @param version A character string specifying an API version. Default is \dQuote{2010-05-08}.
 #' @param verb A character string specifying an HTTP verb. Either \dQuote{GET} or \dQuote{POST}.
 #' @param body A character string specifying a request body (if \code{verb = "POST"}).
-#' @param region A character string specifying an AWS region. The default is drawn from environment variable \env{AWS_DEFAULT_REGION}.
-#' @param key A character string specifying an AWS Access Key. The default is drawn from environment variable \env{AWS_ACCESS_KEY_ID}.
-#' @param secret A character string specifying an AWS Secret Key. The default is drawn from environment variable \env{AWS_SECRET_ACCESS_KEY}.
-#' @param session_token Optionally, a character string specifying an AWS temporary Session Token to use in signing a request. The default is drawn from environment variable \env{AWS_SESSION_TOKEN}.
+#' @param region A character string specifying an AWS region. See \code{\link[aws.signature]{locate_credentials}}.
+#' @param key A character string specifying an AWS Access Key. See \code{\link[aws.signature]{locate_credentials}}.
+#' @param secret A character string specifying an AWS Secret Key. See \code{\link[aws.signature]{locate_credentials}}.
+#' @param session_token Optionally, a character string specifying an AWS temporary Session Token to use in signing a request. See \code{\link[aws.signature]{locate_credentials}}.
 #' @param \dots Additional arguments passed to \code{\link[httr]{GET}} or \code{\link[httr]{POST}}
 #' @import httr
 #' @importFrom aws.signature signature_v4_auth
@@ -19,10 +19,10 @@ iamHTTP <- function(query,
                     verb = "GET", 
                     body = "", 
                     version = "2010-05-08",
-                    region = Sys.getenv("AWS_DEFAULT_REGION"), 
-                    key = Sys.getenv("AWS_ACCESS_KEY_ID"), 
-                    secret = Sys.getenv("AWS_SECRET_ACCESS_KEY"), 
-                    session_token = Sys.getenv("AWS_SESSION_TOKEN"),
+                    region = Sys.getenv("AWS_DEFAULT_REGION", "us-east-1"), 
+                    key = NULL, 
+                    secret = NULL, 
+                    session_token = NULL,
                     ...) {
     if (!"Version" %in% names(query)) {
         query[["Version"]] <- version
@@ -80,10 +80,10 @@ iamHTTP <- function(query,
 #' @export
 stsHTTP <- function(query, 
                     version = "2011-06-15",
-                    region = Sys.getenv("AWS_DEFAULT_REGION"), 
-                    key = Sys.getenv("AWS_ACCESS_KEY_ID"), 
-                    secret = Sys.getenv("AWS_SECRET_ACCESS_KEY"), 
-                    session_token = Sys.getenv("AWS_SESSION_TOKEN"),
+                    region = Sys.getenv("AWS_DEFAULT_REGION", "us-east-1"), 
+                    key = NULL, 
+                    secret = NULL, 
+                    session_token = NULL,
                     ...) {
     if (!"Version" %in% names(query)) {
         query[["Version"]] <- version
@@ -112,7 +112,7 @@ stsHTTP <- function(query,
     H <- do.call(add_headers, headers)
 
     r <- GET(paste0("https://sts.amazonaws.com"), H, query = query, ...)
-    if (http_status(r)$category == "Client error") {
+    if (http_error(r)) {
         x <- try(as_list(read_xml(content(r, "text", encoding = "UTF-8"))), silent = TRUE)
         if (inherits(x, "try-error")) {
             x <- try(fromJSON(content(r, "text", encoding = "UTF-8"))$Error, silent = TRUE)

README.Rmd

@@ -2,20 +2,24 @@
 
 **aws.iam** is a simple client package for the Amazon Web Services (AWS) [Identity and Access Management (IAM)](http://aws.amazon.com/iam/) and [Simple Token Service (STS)](http://docs.aws.amazon.com/STS/latest/APIReference) API, which can be used to manage access credentials for AWS services.
 
-To use the package, you will need an AWS account and enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. 
-
-By default, all **cloudyr** packages look for the access key ID and secret access key in environment variables. You can also use this to specify a default region or a temporary "session token". For example:
-
-```R
-Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
-           "AWS_SECRET_ACCESS_KEY" = "mysecretkey",
-           "AWS_DEFAULT_REGION" = "us-east-1",
-           "AWS_SESSION_TOKEN" = "mytoken")
-```
-
-These can alternatively be set on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`).
-
-If you work with multiple AWS accounts, another option that is consistent with other Amazon SDKs is to create [a centralized `~/.aws/credentials` file](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs), containing credentials for multiple accounts. You can then use credentials from this file on-the-fly by simply doing:
+To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials.
+
+By default, all **cloudyr** packages for AWS services allow the use of credentials specified in a number of ways, beginning with:
+
+ 1. User-supplied values passed directly to functions.
+ 2. Environment variables, which can alternatively be set on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R:
+
+    ```R
+    Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
+               "AWS_SECRET_ACCESS_KEY" = "mysecretkey",
+               "AWS_DEFAULT_REGION" = "us-east-1",
+               "AWS_SESSION_TOKEN" = "mytoken")
+    ```
+ 3. If R is running an EC2 instance, the role profile credentials provided by [**aws.ec2metadata**](https://cran.r-project.org/package=aws.ec2metadata).
+ 4. Profiles saved in a `/.aws/credentials` "dot file" in the current working directory. The `"default" profile is assumed if none is specified.
+ 5. [A centralized `~/.aws/credentials` file](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs), containing credentials for multiple accounts. The `"default" profile is assumed if none is specified.
+
+Profiles stored locally or in a centralized location (e.g., `~/.aws/credentials`) can also be invoked via:
 
 ```R
 # use your 'default' account credentials

README.md

@@ -0,0 +1,65 @@
+# AWS IAM Client Package
+
+**aws.iam** is a simple client package for the Amazon Web Services (AWS) [Identity and Access Management (IAM)](http://aws.amazon.com/iam/) and [Simple Token Service (STS)](http://docs.aws.amazon.com/STS/latest/APIReference) API, which can be used to manage access credentials for AWS services.
+
+To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials.
+
+By default, all **cloudyr** packages for AWS services allow the use of credentials specified in a number of ways, beginning with:
+
+ 1. User-supplied values passed directly to functions.
+ 2. Environment variables, which can alternatively be set on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R:
+
+    ```R
+    Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
+               "AWS_SECRET_ACCESS_KEY" = "mysecretkey",
+               "AWS_DEFAULT_REGION" = "us-east-1",
+               "AWS_SESSION_TOKEN" = "mytoken")
+    ```
+ 3. If R is running an EC2 instance, the role profile credentials provided by [**aws.ec2metadata**](https://cran.r-project.org/package=aws.ec2metadata).
+ 4. Profiles saved in a `/.aws/credentials` "dot file" in the current working directory. The `"default" profile is assumed if none is specified.
+ 5. [A centralized `~/.aws/credentials` file](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs), containing credentials for multiple accounts. The `"default" profile is assumed if none is specified.
+
+Profiles stored locally or in a centralized location (e.g., `~/.aws/credentials`) can also be invoked via:
+
+```R
+# use your 'default' account credentials
+aws.signature::use_credentials()
+
+# use an alternative credentials profile
+aws.signature::use_credentials(profile = "bob")
+```
+
+Temporary session tokens are stored in environment variable `AWS_SESSION_TOKEN` (and will be stored there by the `use_credentials()` function). The [aws.iam package](https://github.com/cloudyr/aws.iam/) provides an R interface to IAM roles and the generation of temporary session tokens via the security token service (STS).
+
+
+## Code Examples
+
+Coming soon...
+
+## Installation
+
+[![CRAN](https://www.r-pkg.org/badges/version/aws.iam)](https://cran.r-project.org/package=aws.iam)
+![Downloads](https://cranlogs.r-pkg.org/badges/aws.iam)
+[![Build Status](https://travis-ci.org/cloudyr/aws.iam.png?branch=master)](https://travis-ci.org/cloudyr/aws.iam)
+[![codecov.io](https://codecov.io/github/cloudyr/aws.iam/coverage.svg?branch=master)](https://codecov.io/github/cloudyr/aws.iam?branch=master)
+
+This package is not yet on CRAN. To install the latest development version you can install from the cloudyr drat repository:
+
+```R
+# latest stable version
+install.packages("aws.iam", repos = c(cloudyr = "http://cloudyr.github.io/drat", getOption("repos")))
+```
+
+Or, to pull a potentially unstable version directly from GitHub:
+
+```R
+if (!require("ghit")) {
+    install.packages("ghit")
+}
+ghit::install_github("cloudyr/aws.iam")
+```
+
+To install the latest version from CRAN, simply use `install.packages("aws.iam")`.
+
+---
+[![cloudyr project logo](http://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr)