Minimalist ODM for commonly used operations with dynamodb.

This is not a complete ODM for DynamoDB! Check https://gitter.im/aws/aws-sdk-ruby or http://ruby.awsblog.com/ for that instead, rumour has it one might be appearing soon.

This work is heavily influenced in layout by the awesome mongoid gem, which I have used for years. Since I shouldn't be writing a full ODM I have borrowed as much as needed, especially to implement ActiveSupport::Concern way of module dependency resolution. I also shied away from reinventing perfectly valid methods if they were in Mongoid. So, if code looks familiar to you, it probably is.

So, thanks goes to Durran Jordan @ mongoid/mongoid.

Beyond that, TinyDyno is a , no frills abstraction to work with DynamoDB on EC2 within ruby apps.

If you're new to DynamoDB, it is highly recommended to read the following:

GettingStartedDynamoDB

GuidelinesForTables

Supported Operations

create_table

Indexes in dynamo are created at table creation time.

either Model.create_table

rake tiny_dyno:create_tables

delete_table

Model.delete_table

put_item

http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method Invoked upon create/create!

supported keys;

• table_name
• item

update_item

http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method Invoked upon save on existing objects.

supported_keys;

• table_name
• key
• attribute_updates

delete_item

• hash_key

Installation

Add this line to your application's Gemfile:

gem 'tiny_dyno'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tiny_dyno

Usage

It is highly recommended to work through the specs and also the fabricators and models in the spec folder to see example implementations.

require 'securerandom'
require 'tiny_dyno'


class Account
  include TinyDyno::Document

  hash_key :id, type: String

  field :email, type: String, range_key: true
  field :label, type: String

  validates_presence_of :id, :email, :label

  def initialize(attrs = nil)
    super
    set_id if id.nil?
  end

  def set_id
    self.id ||= SecureRandom.uuid
  end

end

Person.create_table / Person.create_table!

require 'fabrication'

Fabricator(:person) do
  id { Faker::Number.number(10) }
  first_name { Faker::Name.first_name }
  last_name { Faker::Name.last_name }
  age { Faker::Number.number(2) }
end

person = Fabricate(:person)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rspec to run the tests. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RataWorks/tiny_dyno.

Please ensure documentation updates, test cases etc. are included for any pull requests

For feature requests of currently unsupported DynamodB operations, please provide a raw, working usage example as example specification.