rom-dynamo 0.1.4 → 0.14.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzVjNmE0OWM2ODc1N2ZkNDM4ZDAzYjliNWYzODE0MDZmZWUxYzFkOA==
-  data.tar.gz: !binary |-
-    ZTBlOWU4ZGY1NGZiYjM1MmI3MDg1NjMxYmE0NWE5NjViODUxY2JlNw==
+SHA256:
+  metadata.gz: bb3d1008f7f0331e2ea2d49690cf9b95388c96143ca86718204e0fc53f3e8c4e
+  data.tar.gz: f45c64b787dab54ea6c821e196c3d3ab4a1aa181065a5338e5892156e606885c
 SHA512:
-  metadata.gz: !binary |-
-    MDBkZmMwNzcyM2VlODE1NzQ1Y2ExOTgzNDUwMjhkNDA3ZmYzMGM4YzYxYWFl
-    ODg1ZDlkYWEwNGEzODg2Mzk2YjFjMjI0MjUyYTAyODRiNTg3YjQyYjIxNWQ0
-    ZGQ1ZjNmNTVhZDkxOWE4ZTk1NGNkMjFmNTE1MmFkYmUzMDliYTM=
-  data.tar.gz: !binary |-
-    ZGY0ZGRmOThiZDBhYzRiMzA2NjdjMDhhZWM4MzRiMGNhYWEwMzhmYzRiMjhk
-    NDdlZWNhMzE2NjMyOTFkMTY4NWUyMDk4ZmU3YmUxM2I5MWI3NDdjNGU4Mzdk
-    MTIxNjllNjc1ZTU3NjEyODBhZDc5YjljOGFkNzI1NjNlYTk5YzU=
+  metadata.gz: e595872d1620052b010b0b42905ae517d6a2461e1cc9b2a30e78ec661d6f89afa8e3bb4e9f2681b11a44b0372c8e9e6489c02864e768f3091fb539a41f5c0719
+  data.tar.gz: 81ec89f72f4e0b0b5a0be77b828c5db7bb730e6e4b118fca5a52d657d809396bcb63d494d592ebfaabf7d9d0b5ce618e8f323817059f6b537e4826ad1a0382c8

data/.rspec

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

data/Gemfile

@@ -5,5 +5,6 @@ gemspec
 
 # For development/testing
 gem 'dotenv'
-gem 'rom', :github => 'rom-rb/rom'
-gem 'virtus'
+gem 'rom'
+gem 'virtus'
+gem 'rspec'

data/Rakefile

@@ -1,2 +1,7 @@
+#!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/rom/dynamo/commands.rb

@@ -5,21 +5,43 @@ module Rom
     module Commands
       # DynamoDB create command
       class Create < ROM::Commands::Create
-        def execute(tuple)
-          attributes = input[tuple]
-          validator.call(attributes)
-          relation.insert(attributes.to_h)
-          []
+        def execute(tuples)
+          Array([tuples]).flatten.map do |tuple|
+            attributes = input[tuple]
+            dataset.insert(attributes.to_h)
+          end
+        end
+
+        def dataset
+          relation.dataset
+        end
+      end
+
+      # DynamoDB update command
+      class Update < ROM::Commands::Update
+        def execute(params)
+          attributes = input[params]
+          relation.map do |tuple|
+            dataset.update(tuple, attributes.to_h)
+          end
+        end
+
+        def dataset
+          relation.dataset
         end
       end
 
       # DynamoDB delete command
       class Delete < ROM::Commands::Delete
         def execute
-          target.to_a.tap do |tuples|
-            tuples.each { |t| relation.delete(t) }
+          relation.to_a.tap do |tuples|
+            tuples.each { |t| dataset.delete(t) }
           end
         end
+
+        def dataset
+          relation.dataset
+        end
       end
     end
   end

data/lib/rom/dynamo/relation.rb

@@ -2,84 +2,108 @@ 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
+      forward :restrict, :batch_restrict, :index_restrict
+      forward :limit, :reversed
+      adapter :dynamo
     end
 
     class Dataset
-      include Equalizer.new(:name, :connection)
-      attr_reader :name, :connection
+      include Enumerable
+      include Dry::Equalizer(:name, :connection)
+      extend Dry::Initializer[undefined: false]
+      EmptyQuery = { key_conditions: {}.freeze }.freeze
+
+      option :connection
+      option :name, proc(&:to_s)
+      option :table_keys, optional: true, reader: false
+      option :query, default: proc { EmptyQuery }, reader: false
       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)
+        block.nil? ? to_enum : begin
+          result = start_query(consistent_read: true)
+          result.each_page { |p| p[:items].each(&block) }
+        end
       end
 
       def restrict(query = nil)
         return self if query.nil?
-        conds = query_to_conditions(query)
-        conds = @conditions.merge(conds)
-        dup_as(Dataset, conditions: conds)
+        dup_with_query(Dataset, query)
+      end
+
+      def batch_restrict(keys)
+        dup_as(BatchGetDataset, keys: keys.map do |k|
+          Hash[table_keys.zip(k.is_a?(Array) ? k : [k])]
+        end)
       end
 
       def index_restrict(index, query)
-        conds = query_to_conditions(query)
-        conds = @conditions.merge(conds)
-        dup_as(GlobalIndexDataset, index: index, conditions: conds)
+        dup_with_query(GlobalIndexDataset, query, index_name: index.to_s)
+      end
+
+      ############# PAGINATION #############
+
+      def limit(limit)
+        dup_with_query(self.class, nil, limit: limit.to_i)
+      end
+
+      def reversed
+        dup_with_query(self.class, nil, scan_index_forward: false)
       end
 
       ############# WRITE #############
       def insert(hash)
-        connection.put_item({
-          table_name: name,
-          item: hash
-        })
+        opts = { table_name: name, item: stringify_keys(hash) }
+        connection.put_item(opts).attributes
       end
 
       def delete(hash)
+        hash = stringify_keys(hash)
         connection.delete_item({
           table_name: name,
           key: hash_to_key(hash),
           expected: to_expected(hash),
-        })
+        }).attributes
+      end
+
+      def update(keys, hash)
+        connection.update_item({
+          table_name: name, key: hash_to_key(stringify_keys(keys)),
+          attribute_updates: hash.each_with_object({}) do |(k, v), out|
+            out[k] = { value: dump_value(v), action: 'PUT' } if !keys[k]
+          end
+        }).attributes
       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)
+      def batch_get_each_item(keys, &block)
+        !keys.empty? && ddb.batch_get_item({
+          request_items: { name => { keys: keys } },
+        }).each_page do |page|
+          out = page[:responses][name]
+          out.each(&block)
         end
       end
 
-      def query_to_conditions(query)
-        Hash[query.map do |key, value|
-          [key, {
-            attribute_value_list: [value],
-            comparison_operator:  "EQ"
-          }]
-        end]
+      def dup_with_query(klass, key_hash, opts = {})
+        opts = @query.merge(opts)
+
+        if key_hash && !key_hash.empty?
+          conditions = @query[:key_conditions]
+          opts[:key_conditions] = conditions.merge(Hash[
+            key_hash.map do |key, value|
+              [key, {
+                attribute_value_list: [value],
+                comparison_operator:  "EQ"
+              }]
+            end
+          ]).freeze
+        end
+
+        dup_as(klass, query: opts.freeze)
       end
 
       def to_expected(hash)
@@ -96,45 +120,63 @@ module Rom
 
       def table_keys
         @table_keys ||= begin
-          resp = ddb.describe_table(table_name: name)
-          keys = resp.first[:table][:key_schema]
-          keys.map(&:attribute_name)
+          r = ddb.describe_table(table_name: name)
+          r[:table][:key_schema].map(&:attribute_name)
         end
       end
 
+      def start_query(opts = {}, &block)
+        opts = @query.merge(table_name: name).merge!(opts)
+        puts "Querying DDB: #{opts.inspect}"
+        ddb.query(opts)
+      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
+        attrs = Dataset.dry_initializer.attributes(self)
+        klass.new(attrs.merge(opts))
+      end
+
+      # String modifiers
+      def stringify_keys(hash)
+        hash.each_with_object({}) { |(k, v), out| out[k.to_s] = v }
+      end
+
+      def dump_value(v)
+        return v.new_offset(0).iso8601(6) if v.is_a?(DateTime)
+        v.is_a?(Time) ? v.utc.iso8601(6) : v
       end
     end
 
-    # Dataset queried via a Global Index
-    class GlobalIndexDataset < Dataset
-      attr_accessor :index
+    # Batch get using an array of key queries
+    # [{ key => val }, { key => val }, ...]
+    class BatchGetDataset < Dataset
+      option :keys
 
+      # Query for records
       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?
+        batch_get_each_item(@keys, &block)
+      end
+    end
 
-        # 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)
+    # Dataset queried via a Global Secondary Index
+    # Paginate through keys from Global Index and
+    # call BatchGetItem for keys from each page
+    class GlobalIndexDataset < Dataset
+      def each(&block)
+        if @query[:limit]
+          each_item(start_query, &block)
+        else
+          result = start_query(limit: 100)
+          result.each_page { |p| each_item(p, &block) }
         end
       end
 
+      private def each_item(result, &block)
+        keys = result[:items].map { |h| hash_to_key(h) }
+        batch_get_each_item(keys, &block)
+      end
     end
+
   end
 end

data/lib/rom/dynamo/repository.rb

@@ -1,12 +1,19 @@
-require 'uri'
-require 'rom/repository'
+require 'addressable/uri'
+require 'rom/gateway'
 
 module Rom
   module Dynamo
-    class Repository < ROM::Repository
+    class Gateway < ROM::Gateway
+      attr_reader :ddb, :options
+
       def initialize(uri)
-        uri = URI.parse(uri)
-        @connection = Aws::DynamoDB::Client.new(region: uri.host)
+        uri = Addressable::URI.parse(uri)
+        opts =  { region: uri.host }
+        opts.merge!(uri.query_values) if uri.query
+        opts.keys.each { |k| opts[k.to_sym] = opts.delete(k) }
+
+        @options = opts
+        @ddb = Aws::DynamoDB::Client.new(@options)
         @prefix = uri.path.gsub('/', '')
         @datasets = {}
       end
@@ -17,17 +24,22 @@ module Rom
 
       def dataset(name)
         name = "#{@prefix}#{name}"
-        @datasets[name] ||= Dataset.new(name, @connection)
+        @datasets[name] ||= _has?(name) && Dataset.new(connection: @ddb, name: name)
       end
 
       def dataset?(name)
-        name = "#{@prefix}#{name}"
-        list = connection.list_tables
-        list[:table_names].include?(name)
+        !!self[name]
       end
 
       def [](name)
-        @datasets[name]
+        @datasets["#{@prefix}#{name}"]
+      end
+
+    private
+      def _has?(name)
+        @ddb.describe_table(table_name: name)
+      rescue Aws::DynamoDB::Errors::ResourceNotFoundException
+        return false
       end
     end
   end

data/lib/rom/dynamo/version.rb

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

data/lib/rom/dynamo.rb

@@ -1,8 +1,13 @@
 require 'rom'
-require 'aws-sdk-core'
+require 'date'
+require 'aws-sdk-dynamodb'
 require "rom/dynamo/version"
 require 'rom/dynamo/relation'
 require 'rom/dynamo/commands'
 require 'rom/dynamo/repository'
 
+# jRuby HACK: https://github.com/jruby/jruby/issues/3645#issuecomment-181660161
+module Aws; const_set(:DynamoDB, Aws::DynamoDB) end
+
+# Register adapter with ROM-rb
 ROM.register_adapter(:dynamo, Rom::Dynamo)

data/lib/rom-dynamo.rb

@@ -1 +1,2 @@
 require 'rom/dynamo'
+ROM::Dynamo = Rom::Dynamo

data/rom-dynamo.gemspec

@@ -24,10 +24,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Runtime
-  spec.add_runtime_dependency "rom", "~> 0.5"
-  spec.add_runtime_dependency "aws-sdk-core"
+  spec.add_runtime_dependency "addressable", "~> 2.3"
+  spec.add_runtime_dependency "rom", ">= 1.0", "< 6.0"
+  spec.add_runtime_dependency "aws-sdk-dynamodb", "~> 1.0"
 
   # Development
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activesupport", ">= 4.0", "< 7.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

metadata

@@ -1,71 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: rom-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.14.0
 platform: ruby
 authors:
 - Michael Rykov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-core
+  name: aws-sdk-dynamodb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: DynamoDB adapter for Ruby Object Mapper
 email:
 - mrykov@gmail.com
@@ -73,9 +113,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -99,17 +139,17 @@ 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
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: DynamoDB adapter for Ruby Object Mapper