dynomite 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65cbe54a9b7faa1698f39915100793cb5c004725f16d2bd3cb5b73c55b87a92f
+  data.tar.gz: 0ceb719e4386c73ef6fd4ea108d7114d09e1da1bfab35d8695203422b998ea56
+SHA512:
+  metadata.gz: 2c36491debda7b2697e0f44442925420d29de096e5d28c73ae234cbb7f1dd939d491b965305fd7627f1700c6182752db8c7dff032e2502dfe8425a34b4291af5
+  data.tar.gz: 88991c61e3cd38d5b08eeb3c4e951ddb7b5a7bb3b26bae0bfac90140d3f370a7147a39af2c1b80c6f086921bd5e0c424a5e2e4f3a6d4551c48f52acfd207d3c2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+
+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.5]
+- fix jets dynamodb:migrate tip
+
+## [1.0.4]
+- Add and use log method instead of puts to write to stderr by default
+
+## [1.0.3]
+- rename APP_ROOT to JETS_ROOT
+
+## [1.0.2]
+- to_json for json rendering
+
+## [1.0.1]
+- Check dynamodb local is running when configured
+
+## [1.0.0]
+- LSI support
+- automatically infer table_name
+- automatically infer create_table and update_table migrations types
+
+## [0.3.0]
+- DSL methods now available: create_table, update_table
+- Also can add GSI indexes within update_table with: i.gsi

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dynomite.gemspec
+gemspec

data/README.md

@@ -0,0 +1,141 @@
+# Dynomite
+
+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:
+
+## Examples
+
+First define a class:
+
+```ruby
+class Post < Dynomite::Item
+  # partition_key "id" # optional, defaults to id
+end
+```
+
+### Create
+
+```ruby
+post = Post.new
+post = post.replace(title: "test title")
+post.attrs # {"id" => "generated-id", title" => "my 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.
+
+```ruby
+post = Post.new(id: "myid", title: "my title")
+post.replace
+post.attrs # {"id" => "myid", title" => "my title"}
+```
+
+Note that the replace method replaces the entire item, so you need to merge the attributes if you want to keep the other attributes.  Know this is weird, but this is how DynamoDB works.
+
+### Find
+
+```ruby
+post = Post.find("myid")
+post.attrs = post.attrs.deep_merge("desc": "my desc") # keeps title field
+post.replace
+post.attrs # {"id" => "myid", title" => "my title", desc: "my desc"}
+```
+
+The convenience `attrs` method performs a deep_merge:
+
+```ruby
+post = Post.find("myid")
+post.attrs("desc": "my desc 2") # <= does a deep_merge
+post.replace
+post.attrs # {"id" => "myid", title" => "my title", desc: "my desc 2"}
+```
+
+Note, a race condition edge case can exist when several concurrent replace
+calls are happening.  This is why the interface is called replace to
+emphasis that possibility.
+
+### Delete
+
+```ruby
+resp = Post.delete("myid")  # dynamodb client resp
+# or
+post = Post.find("myid")
+resp = post.delete  # dynamodb client resp
+```
+
+### Scan
+
+```ruby
+options = {}
+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/dynomite/item_spec.rb).
+
+## Migration Support
+
+Dynomite supports ActiveRecord-like migrations.  Here's a short example:
+
+```ruby
+class CreateCommentsMigration < Dynomite::Migration
+  def up
+    create_table :comments do |t|
+      t.partition_key "post_id:string" # required
+      t.sort_key  "created_at:string" # optional
+      t.provisioned_throughput(5) # sets both read and write, defaults to 5 when not set
+    end
+  end
+end
+```
+
+More examples are in the [docs/migrations](docs/migrations) folder.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynomite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynomite
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tongueroo/dynomite.
+
+### TODO
+
+* 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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dynomite"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/migrations/long-example.rb

@@ -0,0 +1,123 @@
+# Note: table name created will be namespaced based on
+# Dynomite::Migration.table_namespace.  This can be set in
+# config/dynamodb.yml
+#
+# development:
+#   table_namespace: "mynamespace"
+#
+# This results in:
+#   create_table "posts"
+# Produces:
+#   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 demo and environment is production:
+#   create_table "posts" => table name: "demo-prod-posts"
+#
+# If your project_name is proj and environment is staging:
+#   create_table "posts" => table name: "demo-stag-posts"
+#
+# If your project_name is proj and environment is development:
+#   create_table "posts" => table name: "demo-dev-posts"
+#
+# If the table_namespace is set to a blank string or nil, then a namespace
+# will not be prepended at all.
+
+class CreateCommentsMigration < Dynomite::Migration
+  def up
+    create_table :comments do |t|
+      t.partition_key "post_id:string" # required
+      t.sort_key  "created_at:string" # optional
+      t.provisioned_throughput(5) # 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
+
+class UpdateCommentsMigration < Dynomite::Migration
+  def up
+    update_table :comments do |t|
+
+      # t.global_secondary_index do
+      # t.gsi(METHOD, INDEX_NAME) do
+
+      # You normally create an index like so:
+      #
+      #  t.gsi(:create) do |i|
+      #    i.partition_key = "post_id:string" # partition_key is required
+      #    i.sort_key = "updated_at:string" # sort_key is optional
+      #  end
+      #
+      # The index name will be inferred from the partition_key and sort_key when
+      # not explicitly set.  Examples:
+      #
+      #   index_name = "#{partition_key}-#{sort_key}-index"
+      #   index_name = "post_id-index" # no sort key
+      #   index_name = "post_id-updated_at-index" # has sort key
+      #
+      # The inference allows you to not have to worry about the index
+      # naming scheme. You can still set the index_name explicitly like so:
+      #
+      #  t.gsi(:create, "post_id-updated_at-index") do |i|
+      #    i.partition_key = "post_id:string" # partition_key is required
+      #    i.sort_key = "updated_at:string" # sort_key is optional
+      #  end
+      #
+      t.gsi(:create) do |i|
+        i.partition_key "post_id:string"
+        i.sort_key "updated_at:string" # optional
+
+        # translates to
+        # i.key_schema({...})
+        # also makes sure that the schema_keys are added to the attributes_definitions
+
+        # t.projected_attributes(:all) # default if not called
+        # t.projected_attributes(:keys_only) # other ways to call
+        # t.projected_attributes([:id, :body, :tags, :updated_at])
+        # translates to:
+        # Valid Values: ALL | KEYS_ONLY | INCLUDE
+        # t.projection(
+        #   projection_type: :all, # defaults to all
+        # )
+        # t.projection(
+        #   projection_type: :include, # defaults to all
+        #   non_key_attributes: [:id, :body, :tags, :updated_at], # defaults to all
+        # )
+
+        i.provisioned_throughput(10)
+      end
+
+      t.gsi(:update, "category-index") do |i|
+        i.provisioned_throughput(10)
+      end
+
+      t.gsi(:delete, "category-index")
+    end
+  end
+end
+

data/docs/migrations/short-example.rb

@@ -0,0 +1,36 @@
+class CreateCommentsMigration < Dynomite::Migration
+  def up
+    create_table :comments do |t|
+      t.partition_key "post_id:string" # required
+      t.sort_key  "created_at:string" # optional
+      t.provisioned_throughput(5) # sets both read and write, defaults to 5 when not set
+
+      t.lsi do |i|
+        i.partition_key "user_id:string"
+        i.sort_key "updated_at:string" # optional
+
+        i.provisioned_throughput(10)
+      end
+    end
+  end
+end
+
+class UpdateCommentsMigration < Dynomite::Migration
+  def up
+    update_table :comments do |t|
+      t.gsi(:create) do |i|
+        i.partition_key "post_id:string"
+        i.sort_key "updated_at:string" # optional
+
+        i.provisioned_throughput(10)
+      end
+
+      t.gsi(:update, "update-me-index") do |i|
+        i.provisioned_throughput(10)
+      end
+
+      t.gsi(:delete, "delete-me-index")
+    end
+  end
+end
+

data/dynomite.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dynomite/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynomite"
+  spec.version       = Dynomite::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = %q{ActiveRecord-ish Dynamodb Model}
+  spec.description   = %q{ActiveRecord-ish Dynamodb Model}
+  spec.homepage      = "https://github.com/tongueroo/dynomite"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "aws-sdk-dynamodb"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dynomite.rb

@@ -0,0 +1,23 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "dynomite/version"
+
+module Dynomite
+  ATTRIBUTE_TYPES = {
+    'string' => 'S',
+    'number' => 'N',
+    'binary' => 'B',
+    's' => 'S',
+    'n' => 'N',
+    'b' => 'B',
+  }
+
+  autoload :Migration, "dynomite/migration"
+  autoload :Dsl, "dynomite/dsl"
+  autoload :DbConfig, "dynomite/db_config"
+  autoload :Item, "dynomite/item"
+  autoload :Core, "dynomite/core"
+  autoload :Erb, "dynomite/erb"
+  autoload :Log, "dynomite/log"
+
+  extend Core
+end