ocean-dynamo 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 960ad13518dfbc9b4b70fb24dbfd044b13fef403e6606a6fbf08be3599580153
-  data.tar.gz: 022cd3afd3941e38cb541a8ecb32efeea9aee835e2a5296b0058ac91c6340b10
+  metadata.gz: 75ca78788e4c6fede73f78af4d7c8730e9f868198cd95f8905094f9e0032e45d
+  data.tar.gz: 798dc05815ecb753dcbe7062ecff1906108cde3ea498a25c53c0c4cea6588985
 SHA512:
-  metadata.gz: a1271f9f5d677c77e6c1af17077c43ecf645c1d11bf96b543397d7c1983b614c181e15f09b403964c47e5216c073eadfe51c584e3fb908206c107e54560cdded
-  data.tar.gz: 60464826fa2896ec5b60fae1fa3b54fc37b0f6f2585f4606dc6503693810b1cbcc22ba53532b2bdf37f46ea2e0285353595e513198aa5cf02341a49cf86915fb
+  metadata.gz: 99a4b8a30c990f58440f15245c90e3fd66aff7484d197a40dc48af85972bd2066858e8b4720a3273a35ee779300234e79d9ca79d21517c41f855441dc7ca2b71
+  data.tar.gz: 1e8df34da4547b6d00108a844b73c195ba25334866cc2f3f44016de9216ced945e67e59e20097590b19e96a2ec7fa5e439b217dd82ccb591d6c0bd414c387910

data/{README.rdoc → README.md}

@@ -318,28 +318,39 @@ To get the highest +:expires_at+ record:
 
 
 == Installation
-
- gem install ocean-dynamo
-
-Then, locate the gem's directory and copy
-
- spec/dummy/config/initializers/aws.rb
-
-to your project's
-
- config/initializers/aws.rb
-
-Also copy
-
- spec/dummy/config/aws.yml.example
-
-to both the following locations in your project:
-
- config/aws.yml.example
- config/aws.yml
-
-Enter your AWS credentials in the latter file.
-
+```
+gem install ocean-dynamo
+```
+
+Ocean-dynamo relies on Aws.config to fetch configuration data. In Ocean, we use
+an init file similar to this one:
+```
+cfg = if ENV['AWS_ACCESS_KEY_ID'].present? && ENV['AWS_SECRET_ACCESS_KEY'].present?
+  {
+    region: ENV['AWS_REGION'],
+    credentials: Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'],
+                                      ENV['AWS_SECRET_ACCESS_KEY'])
+  }
+elsif ENV['AWS_DYNAMODB_ENDPOINT'].present?
+  {
+    region: "eu-west-1",    # Doesn't matter in this context
+    credentials: Aws::Credentials.new('not', 'used'),
+    endpoint: ENV['AWS_DYNAMODB_ENDPOINT']
+  }
+else
+  {
+    region: ENV['AWS_REGION'],
+    credentials: Aws::InstanceProfileCredentials.new
+  }
+end
+Aws.config.update(cfg)
+```
+As you can see, this relies on ENV variables to choose from three different
+setups:
+#. If you're using discrete AWS credentials, set AWS_REGION, AWS_ACCESS_KEY_ID,
+   and AWS_SECRET_ACCESS_KEY.
+#. If you're using localstack, provide AWS_DYNAMODB_ENDPOINT (http://localhost:4569).
+#. If you're using EC2 or ECS instance profile credentials, set only AWS_REGION.
 
 == Running the specs
 

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Peter Bengtson
@@ -172,7 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - config/routes.rb
 - lib/ocean-dynamo.rb