rom-dynamo 0.1.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzVjNmE0OWM2ODc1N2ZkNDM4ZDAzYjliNWYzODE0MDZmZWUxYzFkOA==
+  data.tar.gz: !binary |-
+    ZTBlOWU4ZGY1NGZiYjM1MmI3MDg1NjMxYmE0NWE5NjViODUxY2JlNw==
+SHA512:
+  metadata.gz: !binary |-
+    MDBkZmMwNzcyM2VlODE1NzQ1Y2ExOTgzNDUwMjhkNDA3ZmYzMGM4YzYxYWFl
+    ODg1ZDlkYWEwNGEzODg2Mzk2YjFjMjI0MjUyYTAyODRiNTg3YjQyYjIxNWQ0
+    ZGQ1ZjNmNTVhZDkxOWE4ZTk1NGNkMjFmNTE1MmFkYmUzMDliYTM=
+  data.tar.gz: !binary |-
+    ZGY0ZGRmOThiZDBhYzRiMzA2NjdjMDhhZWM4MzRiMGNhYWEwMzhmYzRiMjhk
+    NDdlZWNhMzE2NjMyOTFkMTY4NWUyMDk4ZmU3YmUxM2I5MWI3NDdjNGU4Mzdk
+    MTIxNjllNjc1ZTU3NjEyODBhZDc5YjljOGFkNzI1NjNlYTk5YzU=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# From rom-dynamo.gemspec
+gemspec
+
+# For development/testing
+gem 'dotenv'
+gem 'rom', :github => 'rom-rb/rom'
+gem 'virtus'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Rykov
+
+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,72 @@
+[gem]: https://rubygems.org/gems/rom-dynamo
+[aws]: https://github.com/aws/aws-sdk-core-ruby
+
+# Rom::Dynamo
+
+[![Gem Version](https://badge.fury.io/rb/rom-dynamo.svg)][gem]
+
+AWS DynamoDB support for [Ruby Object Mapper](https://github.com/rom-rb/rom).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom-dynamo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-dynamo
+
+## Usage
+
+ROM-Dynamo uses [aws-sdk-core][aws] library, so you will need to initialize that first:
+
+    Aws.config.merge!({
+      credentials:   Aws::Credentials.new(AWS_ACCESS, AWS_SECRET),
+      region:        'us-east-1'
+    })
+
+To connect, use the following URL to specify the AWS region and table name prefix.  In this case, accessing `photos` will map to the table `table-name-prefix-photos`:
+
+    dynamo://region/table-name-prefix-/
+
+So a sample setup will be:
+
+    rom = ROM.setup(:dynamo, 'dynamo://us-east-1/development_app_/') do
+      relation(:photos) do
+        # This will call GetItem API directly
+        def by_id(id)
+          restrict(id: id)
+        end
+
+        # This will first query a Global Secondary Index
+        def all_for_user(id)
+          index_restrict('user-to-id', user_id: id)
+        end
+      end
+
+      commands(:photos) do
+        define(:create) { result(:one) }
+        define(:delete) { result(:one) }
+      end
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/rykov/rom-dynamo/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,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rom/dynamo"
+
+# 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

data/bin/setup

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

data/lib/rom-dynamo.rb

@@ -0,0 +1 @@
+require 'rom/dynamo'

data/lib/rom/dynamo.rb

@@ -0,0 +1,8 @@
+require 'rom'
+require 'aws-sdk-core'
+require "rom/dynamo/version"
+require 'rom/dynamo/relation'
+require 'rom/dynamo/commands'
+require 'rom/dynamo/repository'
+
+ROM.register_adapter(:dynamo, Rom::Dynamo)

data/lib/rom/dynamo/commands.rb

@@ -0,0 +1,26 @@
+require 'rom/commands'
+
+module Rom
+  module Dynamo
+    module Commands
+      # DynamoDB create command
+      class Create < ROM::Commands::Create
+        def execute(tuple)
+          attributes = input[tuple]
+          validator.call(attributes)
+          relation.insert(attributes.to_h)
+          []
+        end
+      end
+
+      # DynamoDB delete command
+      class Delete < ROM::Commands::Delete
+        def execute
+          target.to_a.tap do |tuples|
+            tuples.each { |t| relation.delete(t) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/dynamo/relation.rb

@@ -0,0 +1,140 @@
+module Rom
+  module Dynamo
+    class Relation < ROM::Relation
+      include Enumerable
+      forward :restrict, :index_restrict
+
+      def insert(*args)
+        dataset.insert(*args)
+        self
+      end
+
+      def delete(*args)
+        dataset.delete(*args)
+        self
+      end
+    end
+
+    class Dataset
+      include Equalizer.new(:name, :connection)
+      attr_reader :name, :connection
+      alias_method :ddb, :connection
+
+      def initialize(name, ddb, conditions = nil)
+        @name, @connection = name, ddb
+        @conditions = conditions || {}
+      end
+
+      ############# READ #############
+      def each(&block)
+        each_item({
+          consistent_read: true,
+          key_conditions: @conditions
+        }, &block)
+      end
+
+      def restrict(query = nil)
+        return self if query.nil?
+        conds = query_to_conditions(query)
+        conds = @conditions.merge(conds)
+        dup_as(Dataset, conditions: conds)
+      end
+
+      def index_restrict(index, query)
+        conds = query_to_conditions(query)
+        conds = @conditions.merge(conds)
+        dup_as(GlobalIndexDataset, index: index, conditions: conds)
+      end
+
+      ############# WRITE #############
+      def insert(hash)
+        connection.put_item({
+          table_name: name,
+          item: hash
+        })
+      end
+
+      def delete(hash)
+        connection.delete_item({
+          table_name: name,
+          key: hash_to_key(hash),
+          expected: to_expected(hash),
+        })
+      end
+
+      ############# HELPERS #############
+    private
+      def each_item(options, &block)
+        puts "Querying #{name} ...\nWith: #{options.inspect}"
+        connection.query(options.merge({
+          table_name: name
+        })).each_page do |page|
+          page[:items].each(&block)
+        end
+      end
+
+      def query_to_conditions(query)
+        Hash[query.map do |key, value|
+          [key, {
+            attribute_value_list: [value],
+            comparison_operator:  "EQ"
+          }]
+        end]
+      end
+
+      def to_expected(hash)
+        hash && Hash[hash.map do |k, v|
+          [k, { value: v }]
+        end]
+      end
+
+      def hash_to_key(hash)
+        table_keys.each_with_object({}) do |k, out|
+          out[k] = hash[k] if hash.has_key?(k)
+        end
+      end
+
+      def table_keys
+        @table_keys ||= begin
+          resp = ddb.describe_table(table_name: name)
+          keys = resp.first[:table][:key_schema]
+          keys.map(&:attribute_name)
+        end
+      end
+
+      def dup_as(klass, opts = {})
+        table_keys # To populate keys once at top-level Dataset
+        vars = [:@name, :@connection, :@conditions, :@table_keys]
+        klass.allocate.tap do |out|
+          vars.each { |k| out.instance_variable_set(k, instance_variable_get(k)) }
+          opts.each { |k, v| out.instance_variable_set("@#{k}", v) }
+        end
+      end
+    end
+
+    # Dataset queried via a Global Index
+    class GlobalIndexDataset < Dataset
+      attr_accessor :index
+
+      def each(&block)
+        # Pull record IDs from Global Index
+        keys = []; each_item({
+          key_conditions: @conditions,
+          index_name: @index
+        }) { |hash| keys << hash_to_key(hash) }
+
+        # Bail if we have nothing
+        return if keys.empty?
+
+        # Query for the actual records
+        ddb.batch_get_item({
+          request_items: { name => { keys: keys } },
+        }).each_page do |page|
+          out = page[:responses][name]
+          out.each(&block)
+        end
+      end
+
+    end
+  end
+end

data/lib/rom/dynamo/repository.rb

@@ -0,0 +1,34 @@
+require 'uri'
+require 'rom/repository'
+
+module Rom
+  module Dynamo
+    class Repository < ROM::Repository
+      def initialize(uri)
+        uri = URI.parse(uri)
+        @connection = Aws::DynamoDB::Client.new(region: uri.host)
+        @prefix = uri.path.gsub('/', '')
+        @datasets = {}
+      end
+
+      def use_logger(logger)
+        @logger = logger
+      end
+
+      def dataset(name)
+        name = "#{@prefix}#{name}"
+        @datasets[name] ||= Dataset.new(name, @connection)
+      end
+
+      def dataset?(name)
+        name = "#{@prefix}#{name}"
+        list = connection.list_tables
+        list[:table_names].include?(name)
+      end
+
+      def [](name)
+        @datasets[name]
+      end
+    end
+  end
+end

data/lib/rom/dynamo/version.rb

@@ -0,0 +1,5 @@
+module Rom
+  module Dynamo
+    VERSION = "0.1.4"
+  end
+end

data/rom-dynamo.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom/dynamo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rom-dynamo"
+  spec.version       = Rom::Dynamo::VERSION
+  spec.authors       = ["Michael Rykov"]
+  spec.email         = ["mrykov@gmail.com"]
+
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "https://push.fury.io"
+  #end
+
+  spec.summary       = %q{DynamoDB adapter for Ruby Object Mapper}
+  spec.description   = %q{DynamoDB adapter for Ruby Object Mapper}
+  spec.homepage      = "https://github.com/rykov/rom-dynamo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime
+  spec.add_runtime_dependency "rom", "~> 0.5"
+  spec.add_runtime_dependency "aws-sdk-core"
+
+  # Development
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rom-dynamo
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Michael Rykov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  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
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: DynamoDB adapter for Ruby Object Mapper
+email:
+- mrykov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rom-dynamo.rb
+- lib/rom/dynamo.rb
+- lib/rom/dynamo/commands.rb
+- lib/rom/dynamo/relation.rb
+- lib/rom/dynamo/repository.rb
+- lib/rom/dynamo/version.rb
+- rom-dynamo.gemspec
+homepage: https://github.com/rykov/rom-dynamo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: DynamoDB adapter for Ruby Object Mapper
+test_files: []