dynamo_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fcfdfe0d51cd70bcc1a5e49cd096ac4c6fb526d
+  data.tar.gz: 40330495883f655abadef5dcd7f8ab2afd4767b0
+SHA512:
+  metadata.gz: 8cf18933b73c5370cb2e66aa7567a28c1e451266f4cc705cdbaa113de2434fa20f869fa48a6c0fce11f0111ed97559d6330c6451ff64b576af5d3f12c527d827
+  data.tar.gz: 54d0023132022e3179759039d122a71619e69669adeeffe7ae176a620c9501efdf7c43a5ee4e425ae8f2b7f1a046674a24537679791d35b827420414d0e48e90

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dynamo_record.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nguyen Vu Nguyen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# DynamoRecord
+
+A simple DynamoDB ORM wrapper on top of aws-sdk v2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynamo_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamo_record
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dynamo_record/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/dynamo_record.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dynamo_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynamo_record"
+  spec.version       = DynamoRecord::VERSION
+  spec.authors       = ["Nguyen Vu Nguyen"]
+  spec.email         = ["nvunguyen@gmail.com"]
+  spec.summary       = %q{A simple DynamoDB ORM wrapper on top of aws-sdk v2}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.1.0"
+  spec.add_dependency "aws-sdk", "~> 2.0.17.pre"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.20.4"
+end

data/lib/dynamo_record/collection.rb

@@ -0,0 +1,31 @@
+module DynamoRecord
+  class Collection < Array
+
+    def initialize(pager = nil, klass = nil)
+      if pager && klass
+        @pager = pager
+        @klass = klass
+        replace @pager.items.map { |item| klass.send(:from_database, item) }
+      end
+    end
+
+    def next_page?
+      @pager ? @pager.next_page? : false
+    end
+
+    def last_page?
+      @pager ? @pager.last_page? : true
+    end
+
+    def next_page
+      return self.class.new(@pager.next_page, @klass) if @pager.next_page?
+      self.class.new
+    end
+
+    def each_page(&block)
+      @pager.each do |page|
+        yield self.class.new(page, @klass)
+      end
+    end
+  end
+end

data/lib/dynamo_record/config.rb

@@ -0,0 +1,15 @@
+module DynamoRecord
+  module Config
+    extend self
+
+    attr_accessor :access_key_id, :secret_access_key, :region, :namespace, :read_capacity_units, :write_capacity_units
+
+    def set_defaults
+      self.region = 'us-east-1'
+      self.read_capacity_units = 20
+      self.write_capacity_units = 20
+      self.namespace = nil
+    end
+    set_defaults
+  end
+end

data/lib/dynamo_record/document.rb

@@ -0,0 +1,32 @@
+module DynamoRecord
+  module Document
+    extend ActiveSupport::Concern
+    include DynamoRecord::Fields
+    include DynamoRecord::Persistence
+    include DynamoRecord::Finders
+    include DynamoRecord::Query
+
+    included do
+      class_attribute :base_class
+      self.base_class = self
+    end
+
+    module ClassMethods
+      def from_database(attrs)
+        self.new(attrs).tap { |r| r.new_record = false}
+      end
+    end
+
+    attr_accessor :new_record, :attributes
+
+    def initialize(attrs = {})
+      @new_record = true
+      @attributes = {}
+
+      attrs.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+  end
+end

data/lib/dynamo_record/fields.rb

@@ -0,0 +1,31 @@
+module DynamoRecord
+  module Fields
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :attributes
+
+      self.attributes = {}
+
+      field :id # default primary key
+    end
+
+    module ClassMethods
+      def field(name, type = :string, opts = {})
+        named = name.to_s
+        self.attributes = attributes.merge(name: {type: type, options: opts})
+
+        define_method("#{named}=") { |value| write_attribute(named, value) }
+        define_method("#{name}") { read_attribute(named) }
+      end
+    end
+
+    def write_attribute(name, value)
+      attributes[name.to_sym] = value
+    end
+
+    def read_attribute(name)
+      attributes[name.to_sym]
+    end
+  end
+end

data/lib/dynamo_record/finders.rb

@@ -0,0 +1,17 @@
+module DynamoRecord
+  module Finders
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def find(id)
+        response = client.get_item(
+                      table_name: table_name,
+                      key: {
+                        id: id
+                      }
+                  )
+        response.item ? from_database(response.item) : new
+      end
+    end
+  end
+end

data/lib/dynamo_record/persistence.rb

@@ -0,0 +1,85 @@
+module DynamoRecord
+  module Persistence
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def table_name
+        @table_name ||= DynamoRecord::Config.namespace ? "#{DynamoRecord::Config.namespace}_#{base_class.name.downcase.pluralize}" : base_class.name.downcase.pluralize
+      end
+
+      def client
+        @client ||= Aws::DynamoDB::Client.new(
+                      access_key_id: DynamoRecord::Config.access_key_id,
+                      secret_access_key: DynamoRecord::Config.secret_access_key,
+                      region: DynamoRecord::Config.region
+                    )
+      end
+
+      def default_options
+        { table_name: self.table_name }
+      end
+
+      def create_table(opts = {})
+        table_name = opts[:table_name] || self.table_name
+        read_capacity = opts[:read_capacity] || DynamoRecord::Config.read_capacity_units
+        write_capacity = opts[:write_capacity] || DynamoRecord::Config.write_capacity_units
+
+        # Default id
+        attribute_definitions = [{attribute_name: "id", attribute_type: "S"}]
+
+        # Global indexes
+        indexes = []
+        attributes.each do |key, value|
+          indexes << key if value[:options][:index]
+        end
+
+        global_secondary_indexes = []
+        indexes.each do |index|
+          index_definition = {}
+          index_definition[:index_name] = "#{index}-index"
+          index_definition[:key_schema] = [{ attribute_name: index, key_type: 'HASH' }]
+          index_definition[:projection] = { projection_type: 'ALL'}
+          index_definition[:provisioned_throughput] = { read_capacity_units: read_capacity, write_capacity_units: write_capacity }
+          global_secondary_indexes << index_definition
+          attribute_definitions << {attribute_name: index.to_s, 
+                                    attribute_type: attributes[index][:type] == :string ? 'S' : 'N'} # only String and Number are supported. Not Binary
+        end
+
+        options = {
+          attribute_definitions: attribute_definitions,
+          table_name: table_name,
+          key_schema: [
+            {
+              attribute_name: "id",
+              key_type: "HASH",
+            },
+          ],
+          provisioned_throughput: {
+            read_capacity_units: read_capacity,
+            write_capacity_units: write_capacity,
+          }
+        }
+
+        options.merge!(global_secondary_indexes: global_secondary_indexes) unless global_secondary_indexes.empty?
+
+        response = self.client.create_table(options)
+      end
+    end
+
+    def save
+      options = self.class.default_options
+      if id.nil?
+        self.id = SecureRandom.uuid
+      elsif @new_record # New item. Don't overwrite if id exists
+        options.merge!(condition_expression: 'id <> :s', expression_attribute_values: { ':s' => self.id })
+      end
+
+      options.merge!(item: attributes)
+      response = self.class.client.put_item(options)
+      @new_record = false
+      true
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
+      false
+    end
+  end
+end

data/lib/dynamo_record/query.rb

@@ -0,0 +1,29 @@
+module DynamoRecord
+  module Query
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def all(opts = {})
+        options = self.default_options
+        options.merge!(opts.slice(:limit))
+
+        response = self.client.scan(options)
+        DynamoRecord::Collection.new(response, self)
+      end
+
+      def where(condition = {})
+        attribute = condition.first.first.to_s
+        value = condition.first.second
+        key_conditions = {}
+        key_conditions[attribute] = { attribute_value_list: [value], 
+                                           comparison_operator: 'EQ' } 
+        index_name = "#{attribute}-index"
+        options = self.default_options
+        options.merge!(key_conditions: key_conditions, index_name: index_name)
+
+        response = self.client.query(options)
+        DynamoRecord::Collection.new(response, self)
+      end
+    end
+  end
+end

data/lib/dynamo_record/version.rb

@@ -0,0 +1,3 @@
+module DynamoRecord
+  VERSION = "0.0.1"
+end

data/lib/dynamo_record.rb

@@ -0,0 +1,25 @@
+require 'securerandom'
+require 'active_support/concern'
+require 'active_support/core_ext'
+
+require 'aws-sdk'
+
+require 'dynamo_record/version'
+require 'dynamo_record/config'
+require 'dynamo_record/collection'
+require 'dynamo_record/fields'
+require 'dynamo_record/persistence'
+require 'dynamo_record/finders'
+require 'dynamo_record/query'
+require 'dynamo_record/document'
+
+module DynamoRecord
+  extend self
+
+  def configure
+    block_given? ? yield(DynamoRecord::Config) : DynamoRecord::Config
+  end
+  alias :config :configure
+
+end
+

data/spec/app/models/address.rb

@@ -0,0 +1,5 @@
+class Address
+  include DynamoRecord::Document
+
+  field :city, :string, index: true
+end

data/spec/app/models/person.rb

@@ -0,0 +1,5 @@
+class Person
+  include DynamoRecord::Document
+
+  field :name, :string
+end

data/spec/dynamo_record/collection_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe DynamoRecord::Collection do
+
+  let(:pager) { spy('pager', :items => items, :'next_page?' => false, :'last_page?' => true) }
+  let(:items) {
+    [
+      { id: 'id1', name: 'Person 1' },
+      { id: 'id2', name: 'Person 2' }
+    ]
+  }
+
+  it 'initializes properly' do
+    collection = DynamoRecord::Collection.new(pager, Person)
+    expect(collection.count).to eq(2)
+    expect(collection.map(&:name)).to eq(['Person 1','Person 2'])
+    expect(collection.next_page?).to be_falsy
+    expect(collection.last_page?).to be_truthy
+  end
+
+end