dynomite 1.2.1 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f0dd2d67b74fad780ef023ce7d4dcf40b4ee1741ca57fa730d9c5d3a615a96
-  data.tar.gz: d5f0f59d7761708f8ddb00efdd9bc82d9803234ba6fa4b1dda3486aae9210f60
+  metadata.gz: 6f80bf11d2121217d52d8ceac89defcd4e738b3ff220847f7421b1337fbc104f
+  data.tar.gz: cd1a4fb8c66678458c8e08b3222064ea3153129f31d1a81ff7ee6d25f1ac3928
 SHA512:
-  metadata.gz: b32a45f367418c5d825bf294c1095949b963ea9abc86aafb3a3529c3097789cb723bc7f53940774c492b8512ddaf4e36746e3150520ca6cc796b7046db634a00
-  data.tar.gz: ed3daf9d3667901038c4aa66884e2883d8d7cd6ef675212818b715ba539c834e57bb0832ab02b4fc376ced1a86b68735499638f177e765231b635d2383d371f3
+  metadata.gz: 890d2960cd53cec65a93b81b31fb61da535f123f4718d5e870eb2983813811352e2bbf93043007389ee85224590e2484ec0f2b0c5f377b384c5cf886923a87fd
+  data.tar.gz: 1e2ab49bfc684afe96927971d2a57544b9d4898bb1271b920b88969e267b79f5271c4bf71ed07f45b4b160c5f27ef7ff943250c62e42eb1ce1c1c81d720e78ab

data/.gitignore

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

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 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.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 color method
+- #17 fix table names for models with namespaces
+
+## [1.2.3]
+- #11 fix comments in dsl.rb
+- #13 update find method to support composite key
+
+## [1.2.2]
+- update Jets.root usage
+
 ## [1.2.1]
 - #10 from gotchane/fix-readme-about-validation
 - #8 from patchkit-net/feature/replace-return-self

data/README.md

@@ -1,9 +1,15 @@
 # Dynomite
 
+[![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.
 
 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 +17,7 @@ First define a class:
 ```ruby
 class Post < Dynomite::Item
   # partition_key "id" # optional, defaults to id
-  
+
   column :id, :title, :desc
 end
 ```
@@ -21,7 +27,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 +118,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 +131,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_use)
     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_use)
 
       # t.global_secondary_index do
       # t.gsi(METHOD, INDEX_NAME) do
@@ -120,4 +125,3 @@ class UpdateCommentsMigration < Dynomite::Migration
     end
   end
 end
-

data/dynomite.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "aws-sdk-dynamodb"
+  spec.add_dependency "rainbow"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dynomite.rb

@@ -1,5 +1,6 @@
 $:.unshift(File.expand_path("../", __FILE__))
 require "dynomite/version"
+require "rainbow/ext/string"
 
 module Dynomite
   ATTRIBUTE_TYPES = {

data/lib/dynomite/db_config.rb

@@ -73,7 +73,7 @@ module Dynomite::DbConfig
       return @db_config if @db_config
 
       if defined?(Jets)
-        config_path = "#{Jets.root}config/dynamodb.yml"
+        config_path = "#{Jets.root}/config/dynamodb.yml"
         env = Jets.env
       else
         config_path = ENV['DYNOMITE_CONFIG'] || "./config/dynamodb.yml"

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

@@ -236,9 +236,17 @@ module Dynomite
     end
 
     def self.find(id)
+      params =
+        case id
+        when String
+          { partition_key => id }
+        when Hash
+          id
+        end
+
       resp = db.get_item(
         table_name: table_name,
-        key: {partition_key => id}
+        key: params
       )
       attributes = resp.item # unwraps the item's attributes
       self.new(attributes) if attributes
@@ -298,7 +306,7 @@ module Dynomite
     end
 
     def self.get_table_name
-      @table_name ||= self.name.pluralize.underscore
+      @table_name ||= self.name.pluralize.gsub('::','-').underscore.dasherize
       [table_namespace, @table_name].reject {|s| s.nil? || s.empty?}.join('-')
     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,9 +39,17 @@ 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
+    #   i.partition_key "category:string"
+    #   i.sort_key "created_at:string" # optional
     # end
     def gsi(action=:create, index_name=nil, &block)
       gsi_index = GlobalSecondaryIndex.new(action, index_name, &block)
@@ -42,8 +58,8 @@ class Dynomite::Migration
     alias_method :global_secondary_index, :gsi
 
     # t.lsi(:create) do |i|
-    #   i.partition_key = "category:string"
-    #   i.sort_key = "created_at:string" # optional
+    #   i.partition_key "category:string"
+    #   i.sort_key "created_at:string" # optional
     # end
     def lsi(action=:create, index_name=nil, &block)
       # dont need action create but have it to keep the lsi and gsi method consistent
@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynomite
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-20 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -135,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ActiveRecord-ish Dynamodb Model