ExAws.Dynamo

Service module for https://github.com/ex-aws/ex_aws

Installation

The package can be installed by adding :ex_aws_dynamo to your list of dependencies in mix.exs along with your preferred JSON codec and HTTP client:

def deps do
  [
    {:ex_aws_dynamo, "~> 4.0"},
    {:jason, "~> 1.0"},
    {:hackney, "~> 1.9"}
  ]
end

ExAws uses Jason as its default JSON codec - if you intend to use a different codec, see ex_aws for more information about setting a custom :json_codec.

Documentation for ExAwsDynamo can be found at https://hexdocs.pm/ex_aws_dynamo.

Requirements

DynamoDB Local

If you are running this module against a local development instance of DynamoDB, you'll want to make sure that you have installed the latest version, 1.15.0 (released 2021-02-08). You can find links to download the latest version here.

Configuration

ExAws

In order to use ExAws.Dynamo against a production instance of DynamoDB, your app will need to provide the following configuration for :ex_aws:

Example configuration:

config :ex_aws,
  access_key_id: [{:system, "AWS_ACCESS_KEY_ID"}, :instance_role],
  secret_access_key: [{:system, "AWS_SECRET_ACCESS_KEY"}, :instance_role]

:access_key_id :: string

The ID portion of a set of AWS credentials.

:secret_access_key :: string

The secret portion of a set of AWS credentials.

Please see the ExAws README for additional reference.

Testing

Integration tests (optional)

The tests in test/lib/dynamo/integration_test.exs will attempt to run against a local instance of DynamoDB - in order to run these tests, you will need both a running local instance of DynamoDB as well as a config/ddb_local_test.exs file (.gitignored) formatted like so:

config/ddb_local_test.exs

use Mix.Config

config :ex_aws,
  debug_requests: false, # set to true to monitor the DDB requests
  access_key_id: "abcd",
  secret_access_key: "1234",
  region: "us-east-1"

config :ex_aws, :dynamodb,
  scheme: "http://",
  host: "localhost",
  port: SET_YOUR_PORT,
  region: "us-east-1"

(or see config/ddb_local_test.exs.example)

Before running tests, be aware that test/lib/dynamo/integration_test.exs will create and delete tables with the names "TestUsers", "Test.User", "TestSeveralUsers", "TestFoo", "test_books", "TestUsersWithRange", "TestTransactions", "TestTransactions2" - test operations may affect your current tables if they share any of those names. You may consider maintaining a separate instance of DynamoDB local (or at least a separate instance of its shared-local-instance.db file) for testing.

If DynamoDB is not running locally or the config file has not been provided, the integration tests will be skipped.

Copyright and License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tashirosota/ex_aws_dynamo