dynamodb_model 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f4086919c79934456c55927f2c127cb983f3f16
-  data.tar.gz: 00da845314f039d065ff7c122c7a7f7d85d33e08
+  metadata.gz: afe935d182837391daa3ca740b280d338f6bc458
+  data.tar.gz: 536563d9d5e036a46dfdcc3a1a9f47f6df24eff9
 SHA512:
-  metadata.gz: c47587fa7275602096f3626175abfaf96e8f1c2e538c20558bcee5dc15c69218d92c3dc04c916afad8871a369e0fb1c2a8b84c866e80def1ec316fbffe870be4
-  data.tar.gz: 4b9f9f3754e5d8ec6fd8b6492c40d877fa9d3d4c4b2a310f4addbf677046725c30534a81fc9c78fc57b4c4282db310f77280f483a067eb946c8ba205ecd40d88
+  metadata.gz: 6a7281afdba6068ec75af043d66c3490be35ed8beb39af7c0d60e13196bed14003a9c9142db616ca575e848fe7391467dcb70ba68a656ab5f74b5c28c205a118
+  data.tar.gz: c56348d9fda4a5ac732251e48f8924b50970488db1cfdb0a6090eb301a6084ec94bdce07f4f8e60168a4c538f7e335801cd05928f3fe693afe8afe5da0f78617

data/README.md

@@ -55,8 +55,10 @@ emphasis that possibility.
 ### Delete
 
 ```ruby
-resp = Post.delete("myid")
-resp # dynamodb client resp
+resp = Post.delete("myid")  # dynamodb client resp
+# or
+post = Post.find("myid")
+resp = post.delete  # dynamodb client resp
 ```
 
 ### Scan

data/dynamodb_model.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
+  spec.add_dependency "aws-sdk-dynamodb"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dynamodb_model.rb

@@ -6,4 +6,7 @@ module DynamodbModel
   autoload :Dsl, "dynamodb_model/dsl"
   autoload :DbConfig, "dynamodb_model/db_config"
   autoload :Item, "dynamodb_model/item"
+  autoload :Util, "dynamodb_model/util"
+
+  extend Util
 end

data/lib/dynamodb_model/db_config.rb

@@ -1,3 +1,8 @@
+require "aws-sdk-dynamodb"
+require 'fileutils'
+require 'erb'
+require 'yaml'
+
 module DynamodbModel::DbConfig
   def self.included(base)
     base.extend(ClassMethods)

data/lib/dynamodb_model/item.rb

@@ -74,6 +74,10 @@ module DynamodbModel
       self.class.find(id)
     end
 
+    def delete
+      self.class.delete(@attrs[:id]) if @attrs[:id]
+    end
+
     def table_name
       self.class.table_name
     end

data/lib/dynamodb_model/migration.rb

@@ -1,17 +1,16 @@
 module DynamodbModel
   class Migration
     autoload :Dsl, "dynamodb_model/migration/dsl"
+    autoload :Generator, "dynamodb_model/migration/generator"
 
-    class << self
-      def up
-        puts "Running up migration for #{self.class.name}"
-      end
+    def up
+      puts "Should defined an up method for your migration: #{self.class.name}"
+    end
 
-      def create_table(table_name)
-        dsl = Dsl.new(table_name)
-        yield(dsl)
-        dsl.execute
-      end
+    def create_table(table_name)
+      dsl = Dsl.new(table_name)
+      yield(dsl)
+      dsl.execute
     end
   end
 end

data/lib/dynamodb_model/migration/dsl.rb

@@ -91,9 +91,10 @@ class DynamodbModel::Migration
       end
     end
 
+    # http://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/dynamo-example-create-table.html
     def execute
       params = {
-        table_name: @table_ame,
+        table_name: @table_name,
         key_schema: @key_schema,
         attribute_definitions: @attribute_definitions,
         provisioned_throughput: @provisioned_throughput
@@ -101,11 +102,9 @@ class DynamodbModel::Migration
       begin
         result = db.create_table(params)
 
-        puts 'DynamoDB Table: proj-posts Status: ' +
-              result.table_description.table_status;
+        puts "DynamoDB Table: #{@table_name} Status: #{result.table_description.table_status}"
       rescue Aws::DynamoDB::Errors::ServiceError => error
-        puts 'Unable to create table:'
-        puts error.message
+        puts "Unable to create table: #{error.message}"
       end
     end
   end

data/lib/dynamodb_model/migration/generator.rb

@@ -0,0 +1,45 @@
+require "active_support/core_ext/string"
+
+class DynamodbModel::Migration
+  # jets generate migration posts --partition-key id:string
+  class Generator
+    include DynamodbModel::DbConfig
+
+    attr_reader :table_name
+    def initialize(table_name, options)
+      @table_name = table_name.pluralize
+      @options = options
+    end
+
+    def generate
+      puts "Generating migration" unless @options[:quiet]
+      return if @options[:noop]
+      create_migration
+    end
+
+    def create_migration
+      migration_path = "#{DynamodbModel.root}db/migrate/#{migration_file_name}.rb"
+      dir = File.dirname(migration_path)
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
+      IO.write(migration_path, migration_code)
+    end
+
+    def migration_code
+      # @table_name already set
+      @migration_class_name = migration_file_name.classify
+      @partition_key = @options[:partition_key]
+      @sort_key = @options[:sort_key]
+      @provisioned_throughput = @options[:provisioned_throughput] || 5
+      template = IO.read(File.expand_path("../template.rb", __FILE__))
+      result = ERB.new(template, nil, "-").result(binding)
+    end
+
+    def migration_file_name
+      "#{@table_name}_migration"
+    end
+
+    def timestamp
+      "timestamp"
+    end
+  end
+end

data/lib/dynamodb_model/migration/template.rb

@@ -0,0 +1,59 @@
+# Note: table name created will be namespaced based on
+# DynamodbModel::Migration.table_namespace.  This can be set in
+# config/dynamodb.yml
+#
+# development:
+#   table_namespace: "mynamespace"
+#
+# This results in:
+#   create_table "posts" => table name: "mynamespace-posts"
+#
+# When you're in a in Jets project you can set the namespace based on
+# Jets.config.table_namespace, which is based on the project name and
+# a short version of the environment.  Example:
+#
+# `config/dynamodb.yml`:
+# development:
+#   table_namespace: <%%= Jets.config.table_namespace %>
+#
+# If your project_name is proj and environment is production:
+#   create_table "posts" => table name: "proj-prod-posts"
+#
+# If your project_name is proj and environment is staging:
+#   create_table "posts" => table name: "proj-stag-posts"
+#
+# If your project_name is proj and environment is development:
+#   create_table "posts" => table name: "proj-dev-posts"
+#
+# If the table_namespace is set to a blank string or nil, then a namespace
+# will not be prepended at all.
+class <%= @migration_class_name %> < DynamodbModel::Migration
+  def up
+    create_table :<%= @table_name %> do |t|
+      t.partition_key "<%= @partition_key %>" # required
+<% if @sort_key # so extra spaces are not added when generated -%>
+      t.sort_key  "<%= @sort_key %>" # optional
+<% end -%>
+      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
+      # key schema directly also
+      # t.key_schema([
+      #     {attribute_name: "id", :key_type=>"HASH"},
+      #     {attribute_name: "created_at", :key_type=>"RANGE"}
+      #   ])
+      # t.attribute_definitions([
+      #   {attribute_name: "id", attribute_type: "N"},
+      #   {attribute_name: "created_at", attribute_type: "S"}
+      # ])
+
+      # other ways to set provisioned_throughput
+      # t.provisioned_throughput(:read, 10)
+      # t.provisioned_throughput(:write, 10)
+      # t.provisioned_throughput(
+      #   read_capacity_units: 5,
+      #   write_capacity_units: 5
+      # )
+    end
+  end
+end

data/lib/dynamodb_model/util.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+module DynamodbModel::Util
+  # Ensures trailing slash
+  # Useful for appending a './' in front of a path or leaving it alone.
+  # Returns: '/path/with/trailing/slash/' or './'
+  @@root = nil
+  def root
+    return @@root if @@root
+    @@root = ENV['PROJECT_ROOT'].to_s
+    @@root = '.' if @@root == ''
+    @@root = "#{@@root}/" unless @@root.ends_with?('/')
+    @@root
+  end
+end

data/lib/dynamodb_model/version.rb

@@ -1,3 +1,3 @@
 module DynamodbModel
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  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
@@ -86,6 +100,9 @@ files:
 - lib/dynamodb_model/item.rb
 - lib/dynamodb_model/migration.rb
 - lib/dynamodb_model/migration/dsl.rb
+- lib/dynamodb_model/migration/generator.rb
+- lib/dynamodb_model/migration/template.rb
+- lib/dynamodb_model/util.rb
 - lib/dynamodb_model/version.rb
 homepage: https://github.com/tongueroo/dynamodb_model
 licenses: []