dynamodb-api 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9be0f31417b188293408482f8661646b207c587e62f19b252cba0beecb9f7a7
-  data.tar.gz: e449872d243d29819b761edf6503f5931cd838436eabb2584bd7ea238125573f
+  metadata.gz: dbaea71109e5f59f3371de8c33d10a26e23855e6666c6e71d4c3fe46cd6f9818
+  data.tar.gz: 58b5b94c50002c02605e46eb75aeec66a2f8f38339f34d074fa23d16cf13f80d
 SHA512:
-  metadata.gz: 43976f0890badbe08057345c9576d6cb48cd623ac97b1363bab6cc9dfaa245cded0cba11dc694a6d4213e0b08ab30ac8436f86b249553859220cb03224068ffa
-  data.tar.gz: 66be89216803aeb7644a12a5107894cc1531eb14c9ca70bae8dc304fdeffd985d1ba4ac83d8ff07eaa381138e51e4b90c8aa22f056c4e62e55ec21fce12a43fc
+  metadata.gz: 5ba6e2154406a24eec7aa3a806b5901c6216c2cfa3f74ea00ded9c0849b8e272933d8f4bd92d2b20417e284815273046a1eb575cab7765e7eb6523493ea204c8
+  data.tar.gz: a31a6a368d48914534eb50d9055a6d6b6fa1ee3ae3edb95039f189caf047b635612f798ad012b32afa6c48c26d4e21025b57eeb193c683ad43bbd1a84de2717d

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2018-12-23
+### Added
+- [#34](https://github.com/walkersumida/dynamodb-api/pull/34) `scan` method
+
 ## [0.6.2] - 2018-12-13
 ### Added
 - [#32](https://github.com/walkersumida/dynamodb-api/pull/32) `remove_attributes` method

data/README.md

@@ -57,6 +57,23 @@ cars table.
 |3 |3 |Model S |0.20120601e8 |0 |
 |4 |1 |S2000 |0.19980101e8 |1 |
 
+### Scan
+
+Scan returns items in random order.
+
+```ruby
+scan = Dynamodb::Api.scan
+scan.from('cars')
+items = scan.all.items
+```
+
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|1 |1 |Accord |0.19760508e8 |0 |
+|2 |2 |CROWN |0.19550101e8 |0 |
+|3 |3 |Model S |0.20120601e8 |0 |
+|4 |1 |S2000 |0.19980101e8 |1 |
+
 ### Query
 https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instance_method
 

data/lib/dynamodb/api.rb

@@ -5,7 +5,9 @@ require 'active_support/core_ext'
 require 'dynamodb/api/version'
 require 'dynamodb/api/config'
 require 'dynamodb/api/adapter'
+require 'dynamodb/api/base'
 require 'dynamodb/api/query'
+require 'dynamodb/api/scan'
 require 'dynamodb/api/relation'
 require 'dynamodb/api/relation/query_methods'
 require 'dynamodb/api/relation/from_clause'
@@ -40,6 +42,10 @@ module Dynamodb
       Delete::Tables.delete_tables
     end
 
+    def scan
+      Scan.new
+    end
+
     def query
       Query.new
     end

data/lib/dynamodb/api/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'dynamodb/api/relation'
+
+module Dynamodb
+  module Api
+    class Base # :nodoc:
+      include Relation
+
+      def all
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      private
+
+      def build_query
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def base_params
+        raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def order_direct(clause)
+        clause&.direct ? clause.direct : OrderClause.new.direct
+      end
+
+      def select_name(clause)
+        clause&.name ? clause.name : SelectClause.new.name
+      end
+
+      def build_filter_clause
+        return {} if filter_clause&.expression.blank?
+        {
+          filter_expression: filter_clause.expression,
+          expression_attribute_values: filter_clause.values,
+        }
+      end
+
+      def build_expression_attribute_names(params)
+        if filter_clause&.reserved_words.present?
+          expression_attribute.add(filter_clause.reserved_words)
+        end
+        if expression_attribute.names.present?
+          params[:expression_attribute_names] = expression_attribute.names
+        end
+      end
+    end
+  end
+end

data/lib/dynamodb/api/query.rb

@@ -4,9 +4,7 @@ require 'dynamodb/api/relation'
 
 module Dynamodb
   module Api
-    class Query # :nodoc:
-      include Relation
-
+    class Query < Base # :nodoc:
       def all
         Adapter.client.query(build_query)
       end
@@ -29,31 +27,6 @@ module Dynamodb
           key_conditions: where_clause.key_conditions,
         }
       end
-
-      def order_direct(clause)
-        clause&.direct ? clause.direct : OrderClause.new.direct
-      end
-
-      def select_name(clause)
-        clause&.name ? clause.name : SelectClause.new.name
-      end
-
-      def build_filter_clause
-        return {} if filter_clause&.expression.blank?
-        {
-          filter_expression: filter_clause.expression,
-          expression_attribute_values: filter_clause.values,
-        }
-      end
-
-      def build_expression_attribute_names(params)
-        if filter_clause&.reserved_words.present?
-          expression_attribute.add(filter_clause.reserved_words)
-        end
-        if expression_attribute.names.present?
-          params[:expression_attribute_names] = expression_attribute.names
-        end
-      end
     end
   end
 end

data/lib/dynamodb/api/scan.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'dynamodb/api/relation'
+
+module Dynamodb
+  module Api
+    class Scan < Base # :nodoc:
+      def all
+        Adapter.client.scan(build_query)
+      end
+
+      private
+
+      def build_query
+        build_params = base_params.merge(build_filter_clause)
+        build_params[:index_name] = index_clause.name if index_clause&.name
+        build_params[:key_conditions] = where_clause.key_conditions if where_clause&.key_conditions
+        build_params[:select] = select_name(select_clause)
+        build_expression_attribute_names(build_params)
+        build_params[:limit] = limit_clause.number if limit_clause&.number
+        build_params
+      end
+
+      def base_params
+        {
+          table_name: from_clause.name,
+        }
+      end
+    end
+  end
+end

data/lib/dynamodb/api/version.rb

@@ -1,5 +1,5 @@
 module Dynamodb
   module Api
-    VERSION = '0.6.2'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-api
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - WalkerSumida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-15 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -150,6 +150,7 @@ files:
 - gemfiles/aws_sdk_3.gemfile
 - lib/dynamodb/api.rb
 - lib/dynamodb/api/adapter.rb
+- lib/dynamodb/api/base.rb
 - lib/dynamodb/api/config.rb
 - lib/dynamodb/api/config/options.rb
 - lib/dynamodb/api/delete/item.rb
@@ -167,6 +168,7 @@ files:
 - lib/dynamodb/api/relation/query_methods.rb
 - lib/dynamodb/api/relation/select_clause.rb
 - lib/dynamodb/api/relation/where_clause.rb
+- lib/dynamodb/api/scan.rb
 - lib/dynamodb/api/update/attributes.rb
 - lib/dynamodb/api/update/base.rb
 - lib/dynamodb/api/update/item.rb