dynomite 1.2.4 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55dd0f93e12c5b18e5ae2d1997be0089e60024d4656e15720732b8d8da743d97
-  data.tar.gz: d8bf1232ace35602f896691af0e1036a31744adff2dec35b4eea7930c3c65ec6
+  metadata.gz: 8a0639976cc739134d6670945d099f3584b39f88f058e056678591a42c09be84
+  data.tar.gz: 6ad8c28d9147a175cf940ec756d808b66a948c27be74239ab95dc3b589dd9d74
 SHA512:
-  metadata.gz: b16044c3d220c9e9a55634faf04a8d9c79a593377be323fca6a20ca9e7bbe8fa6e5e7c60c4f6bdebede938c420ed319272e62f75926c5937cb878714ba5ab2ea
-  data.tar.gz: c43283a308192ab948e78b278db6f465d162d291fb06ce56e6fccfbbdfa1225cf3cc98ca9c463a01a85aa83ab4b4f4ca5fffc786fce70410e3da68e32a803e88
+  metadata.gz: 3f7f4e2dcb3163c4cc60065c3d0f74b835bd4763f6295ae00d8f92576f2c57afcc969a5b4bf0c727d9b8a45ab17e52ae573319a819cf3f7c0974cf29a91b19ac
+  data.tar.gz: c37b011a90f943e6e04fbdfa248dee7b8bcf1dae762ae5175c976e02325e462118715d8340f5d42022e62a40ab1b77aa80af532544e255eed2c2fec89ecd6aa8

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+vendor/bundle

data/CHANGELOG.md

@@ -3,8 +3,20 @@
 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/).
+
+## [1.2.5]
+- use correct color method
+
 ## [1.2.4]
-- #16 add rainbow gem dependency for colorize method
+- #16 add rainbow gem dependency for color method
 - #17 fix table names for models with namespaces
 
 ## [1.2.3]

data/README.md

@@ -1,9 +1,17 @@
 # Dynomite
 
-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.
+[![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!
+
+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:
 
+## Jets Docs
+
+* [Database DynamoDB](https://rubyonjets.com/docs/database/dynamodb/)
+
 ## Examples
 
 First define a class:
@@ -11,7 +19,7 @@ First define a class:
 ```ruby
 class Post < Dynomite::Item
   # partition_key "id" # optional, defaults to id
-  
+
   column :id, :title, :desc
 end
 ```
@@ -21,7 +29,7 @@ end
 ```ruby
 post = Post.new
 post = post.replace(title: "test title")
-post.attrs # {"id" => "generated-id", title" => "my title"}
+post.attrs # {"id" => "generated-id", title" => "test title"}
 ```
 
 `post.attrs[:id]` now contain a generated unique partition_key id.  Usually the partition_key is 'id'. You can set your own unique id also by specifying id.
@@ -112,7 +120,7 @@ post.replace
 
 puts post.id # 1962DE7D852298C5CDC809C0FEF50D8262CEDF09
 puts post.name # "My First Post"
-``` 
+```
 
 Note that any column not defined using the `column` method can still be accessed using the `attrs`
 method.
@@ -125,15 +133,15 @@ Just add `include ActiveModel::Validations` at the top of your item class.
 ```ruby
 class Post < Dynomite::Item
   include ActiveModel::Validations
-  
+
   column :id, :name # needed
-  
+
   validates :id, presence: true
   validates :name, presence: true
 end
-``` 
+```
 
-**Be sure to define all validated columns using `column` method**.  
+**Be sure to define all validated columns using `column` method**.
 
 Validations are executed by default as soon as you call the `replace` method, returning `false` on
 failure. It also can be ran manually using the `valid?` method just like with ActiveRecord models.

data/docs/migrations/long-example.rb

@@ -55,6 +55,9 @@ class CreateCommentsMigration < Dynomite::Migration
       #   read_capacity_units: 5,
       #   write_capacity_units: 5
       # )
+
+      # set the billing mode to on-demand (NOTE: this overrides provisioned_throughput)
+      # t.billing_mode(:pay_per_request)
     end
   end
 end
@@ -62,6 +65,8 @@ end
 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_request)
 
       # t.global_secondary_index do
       # t.gsi(METHOD, INDEX_NAME) do
@@ -120,4 +125,3 @@ class UpdateCommentsMigration < Dynomite::Migration
     end
   end
 end
-

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/erb.rb

@@ -26,7 +26,7 @@ class Dynomite::Erb
         error_info ||= e.backtrace.grep(/\(erb\)/)[0]
         raise unless error_info # unable to find the (erb):xxx: error line
         line = error_info.split(':')[1].to_i
-        log "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '').colorize(:green)}"
+        log "Error evaluating ERB template on line #{line.to_s.color(:red)} of: #{path.sub(/^\.\//, '').color(:green)}"
 
         template_lines = template.split("\n")
         context = 5 # lines of context
@@ -35,7 +35,7 @@ class Dynomite::Erb
         template_lines[top..bottom].each_with_index do |line_content, index|
           line_number = top+index+1
           if line_number == line
-            printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
+            printf("%#{spacing}d %s\n".color(:red), line_number, line_content)
           else
             printf("%#{spacing}d %s\n", line_number, line_content)
           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/migration/dsl.rb

@@ -1,5 +1,12 @@
 class Dynomite::Migration
   class Dsl
+    ATTRIBUTES = %i[
+      key_schema
+      attribute_definitions
+      table_name
+      billing_mode
+    ].freeze
+
     autoload :Common, "dynomite/migration/common"
     autoload :BaseSecondaryIndex, "dynomite/migration/dsl/base_secondary_index"
     autoload :LocalSecondaryIndex, "dynomite/migration/dsl/local_secondary_index"
@@ -8,15 +15,16 @@ class Dynomite::Migration
     include Dynomite::DbConfig
     include Common
 
-    attr_accessor :key_schema, :attribute_definitions
-    attr_accessor :table_name
+    attr_accessor(*ATTRIBUTES)
+
     def initialize(method_name, table_name, &block)
       @method_name = method_name
       @table_name = table_name
       @block = block
 
-      # Dsl fills in atttributes in as methods are called within the block.
+      # Dsl fills in attributes in as methods are called within the block.
       # Attributes for both create_table and updated_table:
+      @billing_mode = 'PROVISIONED'
       @attribute_definitions = []
       @provisioned_throughput = {
         read_capacity_units: 5,
@@ -31,6 +39,14 @@ class Dynomite::Migration
       @lsi_indexes = []
     end
 
+    # t.billing_mode(:pay_per_request)
+    # t.billing_mode(:provisioned) # default value
+    def billing_mode(mode = nil)
+      return @billing_mode if mode.nil?
+
+      @billing_mode = mode.to_s.upcase
+    end
+
     # t.gsi(:create) do |i|
     #   i.partition_key "category:string"
     #   i.sort_key "created_at:string" # optional
@@ -81,9 +97,10 @@ class Dynomite::Migration
         table_name: namespaced_table_name,
         key_schema: @key_schema,
         attribute_definitions: @attribute_definitions,
-        provisioned_throughput: @provisioned_throughput
+        billing_mode: @billing_mode
       }
 
+      params[:provisioned_throughput] = @provisioned_throughput if @billing_mode == 'PROVISIONED'
       params[:local_secondary_indexes] = lsi_secondary_index_creates unless @lsi_indexes.empty?
       params[:global_secondary_indexes] = gsi_secondary_index_creates unless @gsi_indexes.empty?
       params
@@ -95,12 +112,15 @@ class Dynomite::Migration
       params = {
         table_name: namespaced_table_name,
         attribute_definitions: @attribute_definitions,
+        billing_mode: @billing_mode
         # update table take values only some values for the "parent" table
         # no key_schema, update_table does not handle key_schema for the "parent" table
       }
       # only set "parent" table provisioned_throughput if user actually invoked
       # it in the dsl
-      params[:provisioned_throughput] =  @provisioned_throughput if @provisioned_throughput_set_called
+      if @provisioned_throughput_set_called && @billing_mode == 'PROVISIONED'
+        params[:provisioned_throughput] = @provisioned_throughput
+      end
       params[:global_secondary_index_updates] = global_secondary_index_updates
       params
     end

data/lib/dynomite/migration/executor.rb

@@ -31,7 +31,7 @@ class Dynomite::Migration
 
         puts "DynamoDB Table: #{@table_name} Status: #{result.table_description.table_status}"
       rescue Aws::DynamoDB::Errors::ServiceError => error
-        puts "Unable to #{@method_name.to_s.gsub('_',' ')}: #{error.message}".colorize(:red)
+        puts "Unable to #{@method_name.to_s.gsub('_',' ')}: #{error.message}".color(:red)
       end
     end
   end

data/lib/dynomite/migration/generator.rb

@@ -31,7 +31,7 @@ class Dynomite::Migration
         table_name: table_name,
         partition_key: @options[:partition_key],
         sort_key: @options[:sort_key],
-        provisioned_throughput: @options[:provisioned_throughput] || 5,
+        provisioned_throughput: @options[:provisioned_throughput] || 5
       )
     end
 

data/lib/dynomite/migration/templates/create_table.rb

@@ -5,6 +5,7 @@ class <%= @migration_class_name %> < Dynomite::Migration
 <% if @sort_key # so extra spaces are not added when generated -%>
       t.sort_key  "<%= @sort_key %>" # optional
 <% end -%>
+      t.billing_mode(:PROVISIONED)
       t.provisioned_throughput(<%= @provisioned_throughput %>) # sets both read and write, defaults to 5 when not set
 
       # Instead of using partition_key and sort_key you can set the

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.4"
+  VERSION = "1.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynomite
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.7
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-13 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.0.6
+rubygems_version: 3.3.12
 signing_key: 
 specification_version: 4
 summary: ActiveRecord-ish Dynamodb Model