dynamodb_model 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 355ffd3eb3d0d42649b31239c6297464be46d260
-  data.tar.gz: e6ec2b09237a89b6e0c617d0e0f888c5578a52a5
+  metadata.gz: 695afa2fc15607d068003af7eab703194659ea0f
+  data.tar.gz: 4a0375284bf1565b781cd5fac752730e4fe7ddb4
 SHA512:
-  metadata.gz: 57b068c88fbf47de849a3980be63a98411f0103bc979c2457248b71e3d17b7d7bec0fc9a45a3f99d7a939ac5f811f0c5ee814907def64105bd678465af5e3721
-  data.tar.gz: c0c1ba569bbc4a1e411b3cc6821abd96a003a0fdba71dc56b6846f30275d3fd309ac8b6f524658b990045c1ec4745fd77880dbed2dc5a57665eecb847a4e0a45
+  metadata.gz: d26a55e6f07ae80457927212586ecd0fe1e3a5e7529e29c70db8b948d63c63bef07b75977dcdea0f52dbe3998bbd6eb1396758b58c84f0b3d3d152368a40fdbe
+  data.tar.gz: e10afd1105fce09364cdd41bfaa8bba11b43e489eaf63b082bd8c199726e87da56cc6e2fb29c12f969f2e7f4bf45e9d5215430f423505cde4cc97abf199eafd7

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.0.1]
+- Check dynamodb local is running when configured
+
 ## [1.0.0]
 - LSI support
 - automatically infer table_name

data/README.md

@@ -69,6 +69,26 @@ posts = Post.scan(options)
 posts # Array of Post items.  [Post.new, Post.new, ...]
 ```
 
+### Query
+
+```ruby
+posts = Post.query(
+  index_name: 'category-index',
+  expression_attribute_names: { "#category_name" => "category" },
+  expression_attribute_values: { ":category_value" => "Entertainment" },
+  key_condition_expression: "#category_name = :category_value",
+)
+posts # Array of Post items.  [Post.new, Post.new, ...]
+```
+
+### Where
+
+The where could be prettied up. Appreciate any pull requests.
+
+```ruby
+Post.where({category: "Drama"}, {index_name: "category-index"})
+```
+
 Examples are also in [item_spec.rb](spec/lib/dynamodb_model/item_spec.rb).
 
 ## Migration Support
@@ -115,7 +135,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tongueroo/dynamodb_model.
 
-TODO
+### TODO
 
-* implement Post.query
+* improve Post.where.  Something like `Post.index_name("user_id").where(category_name: "Entertainment")` would be nice.
 * implement `post.update` with `db.update_item` in a Ruby-ish way

data/lib/dynamodb_model/db_config.rb

@@ -24,11 +24,40 @@ module DynamodbModel::DbConfig
 
       config = db_config
       endpoint = ENV['DYNAMODB_ENDPOINT'] || config['endpoint']
-      Aws.config.update(endpoint: endpoint) if endpoint
+      check_dynamodb_local!(endpoint)
 
+      Aws.config.update(endpoint: endpoint) if endpoint
       @@db ||= Aws::DynamoDB::Client.new
     end
 
+    # When endoint has been configured to point at dynamodb local: localhost:8000
+    # check if port 8000 is listening and timeout quickly. Or else it takes a
+    # for DynamoDB local to time out, about 10 seconds...
+    # This wastes less of the users time.
+    def check_dynamodb_local!(endpoint)
+      return unless endpoint && endpoint.include?("8000")
+
+      open = port_open?("127.0.0.1", 8000, 0.2)
+      unless open
+        raise "You have configured your app to use DynamoDB local, but it is not running.  Please start DynamoDB local. Example: brew cask install dynamodb-local && dynamodb-local"
+      end
+    end
+
+    # Thanks: https://gist.github.com/ashrithr/5305786
+    def port_open?(ip, port, seconds=1)
+      # => checks if a port is open or not
+      Timeout::timeout(seconds) do
+        begin
+          TCPSocket.new(ip, port).close
+          true
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
+          false
+        end
+      end
+    rescue Timeout::Error
+      false
+    end
+
     # useful for specs
     def db=(db)
       @@db = db

data/lib/dynamodb_model/item.rb

@@ -156,7 +156,7 @@ module DynamodbModel
     # translates to
     #
     #   resp = db.query(
-    #     table_name: "proj-dev-post",
+    #     table_name: "demo-dev-post",
     #     index_name: 'category-index',
     #     expression_attribute_names: { "#category_name" => "category" },
     #     expression_attribute_values: { ":category_value" => category },

data/lib/dynamodb_model/migration/dsl.rb

@@ -159,7 +159,7 @@ class DynamodbModel::Migration
       end
     end
 
-    # >> resp = Post.db.describe_table(table_name: "proj-dev-posts")
+    # >> resp = Post.db.describe_table(table_name: "demo-dev-posts")
     # >> resp.table.attribute_definitions.map(&:to_h)
     # => [{:attribute_name=>"id", :attribute_type=>"S"}]
     def gsi_attribute_definitions

data/lib/dynamodb_model/migration/generator.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/string"
 
 class DynamodbModel::Migration
-  # jets generate migration posts --partition-key id:string
+  # jets dynamodb generate posts --partition-key id:string
   class Generator
     include DynamodbModel::DbConfig
 

data/lib/dynamodb_model/version.rb

@@ -1,3 +1,3 @@
 module DynamodbModel
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_model
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tung Nguyen