SheetZoukas::Lambda

Deploy to AWS Lambda to expose Google Sheets as JSON via HTTPS. AWS Lambda wrapper for sheet_zoukas.

sheet_zoukas converts Google Sheets to JSON. sheet_zoukas-lambda serves sheet_zoukas via AWS Lambda.

Reference implementation TBD.

Notes

It appears that Lambda functions cannot control HTTP status codes in the response. If the function throws an error AWS returns a 502. So I've opted to return error information for known errors, but the HTTP status code will be 200. This implementation has chosen the latter options to provide callers with more information on error conditions at the cost of a true RESTful implementation. Known errors are:

• Google authentication issues
• Missing required parameters
• Google rejects parameters as invalid

Precendence is given for parameters in request bodies over query string parameters.

Precedence is given for passed-in parameters over default environment variables.

Usage

Deploy to AWS Lambda to expose Google Sheets as JSON.

Use with a request body (URL differs for each Lambda)

$ curl -v 'https://a1aaa1aaaaaaaaaaaaaa1zzzzz1zzzzz.lambda-url.us-east-1.on.aws' \
  -H 'content-type: application/json' \
  -d '{ "sheet_id": "<GOOGLE_SHEET_ID>", "tab_name": "<TAB_NAME>" }'

Use with query string parameters

$ curl -v 'https://a1aaa1aaaaaaaaaaaaaa1zzzzz1zzzzz.lambda-url.us-east-1.on.aws?sheet_id=<GOOGLE_SHEET_ID>&tab_name=<TAB_NAME>'

Default values

To use default values in AWS set one or more of the following

• DEFAULT_SHEET_ID
• DEFAULT_TAB_NAME
• DEFAULT_RANGE

Use with environment variables in AWS Lambda as default values.

$ curl -v 'https://a1aaa1aaaaaaaaaaaaaa1zzzzz1zzzzz.lambda-url.us-east-1.on.aws/defaults'

You can use defaults and still pass in values to override the environment variables. For example, with SHEET_ID and TAB_NAME set as an environment variable in Lambda the following will use the SHEET_ID but override the TAB_NAME:

$ curl -v 'https://a1aaa1aaaaaaaaaaaaaa1zzzzz1zzzzz.lambda-url.us-east-1.on.aws/defaults' \
  -H 'content-type: application/json' \
  -d '{ "tab_name": "<TAB_NAME>" }'

$ curl -v 'https://a1aaa1aaaaaaaaaaaaaa1zzzzz1zzzzz.lambda-url.us-east-1.on.aws/defaults?tab_name=<TAB_NAME>'

Development

$ bundle install
$ rake spec

Deploy to AWS

Create AWS role

Create Lambda in AWS

• Runtime Settings -> Edit
• Set Handler to lib/sheet_zoukas/lambda.SheetZoukas::Lambda.lambda_handler

Create environment variables in AWS

Google auth variables are required; default sheet values and log level are not.

• Configuration -> Environment Variables -> Edit -> Add environment variables
• Set vars required by sheet_zoukas uses environment variables to authenticate a Google service account. See the sheet_zoukas README for more info. The logs/console will tell you which environment variables aren't set.

Logging

Unless ZOUKAS_LOG_LEVEL environment variable is set only ERROR-level logging will occur.

Package code

For CI/CD use

$ rake package:package

For local development you'll want bundler reset to include test and development

$ rake package:package_dev

Deploy code

Upload the zip file to the Lambda.

Test code

Modify spec/fixtures/lambda_tests to have valid values and execute the tests in the Lambda console. fixtures/lambda_tests/includes sample JSON you can use in the Lambda console after replacing slug values.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eebbesen/sheet_zoukas-lambda.

License

The gem is available as open source under the terms of the MIT License.