dynamodb-local 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6113c2211f8b53f0592fa506f780d07d44254f34
-  data.tar.gz: df94baa04ad7da8956ac5672e6e4f91c0ab60655
+  metadata.gz: 7bff24b8c59c966c221f913f467497a4e305a816
+  data.tar.gz: ae4a5ef496462b3f42cb312cbc332794b6228014
 SHA512:
-  metadata.gz: 4d82d0311bf979ae54b99401586fb1feac80e4c72383fb848f756366c328b58fbff99bb1ba4c25ec6cf335adf9d11bcf57d1bfee6e1ff2545aba544d06050a04
-  data.tar.gz: 25a4715d2ffef364609464a83d93cb3245958dda61de44ed1d361c37cb302ff0b4da2290d2e80169252595a3d34deb3482371fcb58431c9e9f8290d06b92de3b
+  metadata.gz: a9321396fd1b8f805dd19bac76ab9485c0fcb89ffed4010544064a317428529efaf9c8c5635c832fcb6463237f60ec2d01a3cb3f875e3a27c63c17413f97bfc1
+  data.tar.gz: 660bf0016915af379f8dcd7b0ce75f706e2404d5883492e11af6b81136e710e836232d802405a75fe66dbc52f7d9fe0edf48f20572aa37d25abd4f820d2a76bc

data/README.md

@@ -2,8 +2,7 @@
 
 This is a simple helper gem that automaticall installs the [DynamoDB local tool](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLocal.html) and provides a simple ruby wrapper binar that allows you start and stop the local DynamoDB server from the command line.
 
-*IMPORTANT:* DynamoDB Local supports the Java Runtime Engine (JRE)
-version 6.x or newer; it will not run on older JRE versions.
+*IMPORTANT:* You must have the Java Runtime Engine (JRI) version 6.x or newer installed for the local serverto work; it will not run on older JRE versions.
 
 ## Installation
 
@@ -33,6 +32,45 @@ the underlying server. Those are:
  -port <port-no.>   Specify a port number. Default is 8000
 </pre>
 
+## Integration with the AWS Ruby SDK v1
+
+The v1 Ruby SDK ships with two versioned client classes, '2011-12-05'
+and '2012-08-10'. DynamoDB local only works with the 2012 API version.
+So you must specify the 2012 verion when creating a DynamoDB client.
+
+```ruby
+# either of the following versions will create an appropriate client
+# that will work with DynamoDB local
+ddb = AWS::DynamoDB::Client.new(api_verison: '2012-08-10')
+ddb = AWS::DynamoDB::Client::V20120810.new
+
+# this defaults to older API version for backwards compatability
+# and will not work with DyanmoDB local
+ddb = AWS::DynamoDB::Client.new
+```
+
+If you're using the [v2 SDK](https://github.com/aws/aws-sdk-core-ruby), the 2012 API is the default version.
+
+Additionally, you must turn SSL off when you using DynamoDB local.
+
+```ruby
+# Full working configuration using AWS Ruby SDK v1
+ddb = AWS::DynamoDB::Client.new(api_verison: '2012-08-10',
+                                endpoint: 'localhost',
+                                port: '8000',
+                                use_ssl: false)
+```
+
+Alternatively, you can configure these as global defaults:
+
+```ruby
+AWS.config(use_ssl: false,
+           dynamo_db: { api_verison: '2012-08-10',
+                        endpoint: 'localhost',
+                        port: '8000' })
+ddb = AWS::DynamoDB::Client.new
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/dynamodb-local/fork )

data/lib/dynamodb/local/version.rb

@@ -1,5 +1,5 @@
 module Dynamodb
   module Local
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-local
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Josh Huckabee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler