dynomite 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f80bf11d2121217d52d8ceac89defcd4e738b3ff220847f7421b1337fbc104f
-  data.tar.gz: cd1a4fb8c66678458c8e08b3222064ea3153129f31d1a81ff7ee6d25f1ac3928
+  metadata.gz: 8a0639976cc739134d6670945d099f3584b39f88f058e056678591a42c09be84
+  data.tar.gz: 6ad8c28d9147a175cf940ec756d808b66a948c27be74239ab95dc3b589dd9d74
 SHA512:
-  metadata.gz: 890d2960cd53cec65a93b81b31fb61da535f123f4718d5e870eb2983813811352e2bbf93043007389ee85224590e2484ec0f2b0c5f377b384c5cf886923a87fd
-  data.tar.gz: 1e2ab49bfc684afe96927971d2a57544b9d4898bb1271b920b88969e267b79f5271c4bf71ed07f45b4b160c5f27ef7ff943250c62e42eb1ce1c1c81d720e78ab
+  metadata.gz: 3f7f4e2dcb3163c4cc60065c3d0f74b835bd4763f6295ae00d8f92576f2c57afcc969a5b4bf0c727d9b8a45ab17e52ae573319a819cf3f7c0974cf29a91b19ac
+  data.tar.gz: c37b011a90f943e6e04fbdfa248dee7b8bcf1dae762ae5175c976e02325e462118715d8340f5d42022e62a40ab1b77aa80af532544e255eed2c2fec89ecd6aa8

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.2.7] - 2022-06-12
+- [#23](https://github.com/tongueroo/dynomite/pull/23) #where method refactor to allow Model.index_name('index').where(...)
+- [#24](https://github.com/tongueroo/dynomite/pull/24) Add get_endpoint_ip to db_config.rb
+- [#26](https://github.com/tongueroo/dynomite/pull/26) change pay_per_use to pay_per_request
+- [#27](https://github.com/tongueroo/dynomite/pull/27) Fixed message that tells how to install dynamodb-local
+
 ## [1.2.6]
 - Implement the `PAY_PER_USE` billing mode for table creations and updates. See [DynamoDB On Demand](https://aws.amazon.com/blogs/aws/amazon-dynamodb-on-demand-no-capacity-planning-and-pay-per-request-pricing/).
 

data/README.md

@@ -2,7 +2,9 @@
 
 [![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
 
-NOTE: Am looking for maintainers to help with this gem. Send me an email!  Also [dynamoid](https://github.com/Dynamoid/dynamoid) seems like a good option that should be considered delegating to or straight using. Learning on delegation so we can have better default behavior for a DynamoDB model layer for Jets.
+NOTE: Am looking for maintainers to help with this gem. Send me an email!
+
+IMPORTANT: The next major version of Dynomite will be ActiveModel compatible. A POC is in the [edge](https://github.com/tongueroo/dynomite/tree/edge) branch. It's still very rough and experimental. Would not recommend using it yet, but wanted to note it.
 
 A simple wrapper library to make DynamoDB usage a little more friendly.  The modeling is ActiveRecord-ish but not exactly because DynamoDB is a different type of database.  Examples below explain it best:
 

data/docs/migrations/long-example.rb

@@ -57,7 +57,7 @@ class CreateCommentsMigration < Dynomite::Migration
       # )
 
       # set the billing mode to on-demand (NOTE: this overrides provisioned_throughput)
-      # t.billing_mode(:pay_per_use)
+      # t.billing_mode(:pay_per_request)
     end
   end
 end
@@ -66,7 +66,7 @@ class UpdateCommentsMigration < Dynomite::Migration
   def up
     update_table :comments do |t|
       # You can update from provisioned_throughput to on-demand pricing
-      # t.billing_mode(:pay_per_use)
+      # t.billing_mode(:pay_per_request)
 
       # t.global_secondary_index do
       # t.gsi(METHOD, INDEX_NAME) do

data/lib/dynomite/db_config.rb

@@ -42,10 +42,24 @@ module Dynomite::DbConfig
     # 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)
+      
+      host, port = endpoint.gsub("http://", "").split(":")
+      ip = get_endpoint_ip(host)
+      unless ip
+        raise "You have configured your app to use DynamoDB local, but it is not running on the host: #{host}."
+      end       
+      
+      open = port_open?(ip, 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"
+        raise "You have configured your app to use DynamoDB local, but it is not running.  Please start DynamoDB local. Example: brew install --cask dynamodb-local && dynamodb-local"
+      end
+    end
+    
+    def get_endpoint_ip(host)
+      begin
+        IPSocket.getaddress(host)
+      rescue SocketError
+        false # Can return anything you want here
       end
     end
 

data/lib/dynomite/item.rb

@@ -4,6 +4,7 @@ require "digest"
 require "yaml"
 
 require "dynomite/reserved_words"
+require "dynomite/query"
 
 # The modeling is ActiveRecord-ish but not exactly because DynamoDB is a
 # different type of database.
@@ -170,9 +171,17 @@ module Dynomite
       resp.items.map {|i| self.new(i) }
     end
 
+    # Creates a new chainable ActiveRecord Query-style instance with a certain index_name.
+    #
+    #   Post.index_name("category-index").where(category: "Drama")
+    #
+    def self.index_name(name)
+      _new_query.index_name(name)
+    end
+
     # Translates simple query searches:
     #
-    #   Post.where({category: "Drama"}, index_name: "category-index")
+    #   Post.index_name("category-index").where(category: "Drama")
     #
     # translates to
     #
@@ -183,34 +192,8 @@ module Dynomite
     #     expression_attribute_values: { ":category_value" => category },
     #     key_condition_expression: "#category_name = :category_value",
     #   )
-    #
-    # TODO: Implement nicer where syntax with index_name as a chained method.
-    #
-    #   Post.where({category: "Drama"}, {index_name: "category-index"})
-    #     VS
-    #   Post.where(category: "Drama").index_name("category-index")
-    def self.where(attributes, options={})
-      raise "attributes.size == 1 only supported for now" if attributes.size != 1
-
-      attr_name = attributes.keys.first
-      attr_value = attributes[attr_name]
-
-      # params = {
-      #   expression_attribute_names: { "#category_name" => "category" },
-      #   expression_attribute_values: { ":category_value" => "Entertainment" },
-      #   key_condition_expression: "#category_name = :category_value",
-      # }
-      name_key, value_key = "##{attr_name}_name", ":#{attr_name}_value"
-      params = {
-        expression_attribute_names: { name_key => attr_name },
-        expression_attribute_values: { value_key => attr_value },
-        key_condition_expression: "#{name_key} = #{value_key}",
-      }
-      # Allow direct access to override params passed to dynamodb query options.
-      # This is is how index_name is passed:
-      params = params.merge(options)
-
-      query(params)
+    def self.where(attributes)
+      _new_query.where(attributes)
     end
 
     def self.replace(attrs)
@@ -343,5 +326,9 @@ module Dynomite
         @attrs[name.to_s] = value
       end
     end
+
+    def self._new_query
+      Dynomite::Query.new(self, {})
+    end
   end
 end

data/lib/dynomite/query.rb

@@ -0,0 +1,48 @@
+module Dynomite
+  class Query
+    include Enumerable
+
+    def initialize(item, params)
+      @item = item
+      @params = params
+    end
+
+    def <<(item)
+      raise NotImplementedError
+    end
+
+    def inspect
+      "#<Dynomite::Query [#{first(2).map(&:inspect).join(', ')}, ...]>"
+    end
+
+    def each(&block)
+      run_query.each(&block)
+    end
+
+    def index_name(name)
+      self.class.new(@item, @params.merge(index_name: name))
+    end
+
+    def where(attributes)
+      raise "attributes.size == 1 only supported for now" if attributes.size != 1
+
+      attr_name = attributes.keys.first
+      attr_value = attributes[attr_name]
+
+      name_key, value_key = "##{attr_name}_name", ":#{attr_name}_value"
+      params = {
+        expression_attribute_names: { name_key => attr_name },
+        expression_attribute_values: { value_key => attr_value },
+        key_condition_expression: "#{name_key} = #{value_key}",
+      }
+
+      self.class.new(@item, @params.merge(params))
+    end
+
+    private
+
+    def run_query
+      @query ||= @item.query(@params)
+    end
+  end
+end

data/lib/dynomite/version.rb

@@ -1,3 +1,3 @@
 module Dynomite
-  VERSION = "1.2.6"
+  VERSION = "1.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynomite
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,6 +129,7 @@ files:
 - lib/dynomite/migration/generator.rb
 - lib/dynomite/migration/templates/create_table.rb
 - lib/dynomite/migration/templates/update_table.rb
+- lib/dynomite/query.rb
 - lib/dynomite/reserved_words.rb
 - lib/dynomite/version.rb
 homepage: https://github.com/tongueroo/dynomite
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.12
 signing_key: 
 specification_version: 4
 summary: ActiveRecord-ish Dynamodb Model