dynamodb-api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1176f23f9b8202950b14fb9f093a89a0e8a71408b07d1eee64e1cfa2f4771f68
-  data.tar.gz: '018fe530f3c0df9d3f025154569dd1958b476e1d84051b01091c4dd7f5337c9b'
+  metadata.gz: 34f7a13fc8d01e4e3fd6126b892e5bd71484bb19ef77a838a5a02307be3e4530
+  data.tar.gz: f1beedbb696099688379ebc381144b601273d0614ddff89fa5466450f4fe56d1
 SHA512:
-  metadata.gz: c4da7e234eeff907f7382187281794ae788c57312b3e5d35c2ee9f7b4c2c686153d7111fa8b3633012c5dc6248c7cd41abb5e93ebf094e9d23dfd71a7cd5f270
-  data.tar.gz: 2a3e960e5d73b46d989ae006f18ecf8c4d5837b1e52d478f0b64c55ea608a04a5e7e3ccb9857e3839525629c9a6b906dc070f9ddcbb307638c5a64a421cd8aa3
+  metadata.gz: 589539eca0a48f767afeefecb2eed852f8095c8082bca32d973aa3608327eeb95b6a31c58c1d438a2ff96bac044096960d604799123bd63fc2eec5d6609f3b42
+  data.tar.gz: c157d7759fd9d9328f305bebb5ab7800f8d55b083e2686dac1ea07863507dff4e9402ee6bd2936ad17b64d11f94203881f211b4c1dbbdef8327af81094c15fbd

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] - 2018-11-03
+### Added
+- [#25](https://github.com/walkersumida/dynamodb-api/pull/25) `update` method
+- [#24](https://github.com/walkersumida/dynamodb-api/pull/24) `delete` method
+- [#23](https://github.com/walkersumida/dynamodb-api/pull/23) `query` method
+
 ## [0.5.0] - 2018-09-30
 ### Added
 - [#21](https://github.com/walkersumida/dynamodb-api/pull/21) Automatically add Expression Attribute Names

data/README.md

@@ -50,12 +50,12 @@ e.g.
 
 cars table.
 
-| maker_id(Partition key) | model | release_date(Sort key) | status |
-|:---|:---|:---|:---|
-|1 |Accord |0.19760508e8 |0 |
-|2 |CROWN |0.19550101e8 |0 |
-|3 |Model S |0.20120601e8 |0 |
-|1 |S2000 |0.19980101e8 |1 |
+| 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
@@ -63,63 +63,63 @@ https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instan
 #### Partition(Hash) key
 
 ```ruby
-query = Dynamodb::Api::Query.new
+query = Dynamodb::Api.query
 query.from('cars').index('index_maker_id_release_date').
   where(['maker_id', '=', 1])
 items = query.all.items
 ```
 
-| maker_id(Partition key) | model | release_date(Sort key) | status |
-|:---|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |1 |
-|1 |Accord |0.19760508e8 |0 |
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|4 |1 |S2000 |0.19980101e8 |1 |
+|1 |1 |Accord |0.19760508e8 |0 |
 
 #### Partition key and Sort(Range) key
 
 ```ruby
-query = Dynamodb::Api::Query.new
+query = Dynamodb::Api.query
 query.from('cars').index('index_maker_id_release_date').
   where([['maker_id', '=', 1], ['release_date', '>=', 19_980_101]])
 items = query.all.items
 ```
 
-| maker_id(Partition key) | model | release_date(Sort key) | status |
-|:---|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |1 |
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|4 |1 |S2000 |0.19980101e8 |1 |
 
 #### Sorting
 
 ```ruby
-query = Dynamodb::Api::Query.new
+query = Dynamodb::Api.query
 query.from('cars').index('index_maker_id_release_date').
   where(['maker_id', '=', 1]).
   order('asc') # default: 'desc'
 items = query.all.items
 ```
 
-| maker_id(Partition key) | model | release_date(Sort key) | status |
-|:---|:---|:---|:---|
-|1 |Accord |0.19760508e8 |0 |
-|1 |S2000 |0.19980101e8 |1 |
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|1 |1 |Accord |0.19760508e8 |0 |
+|4 |1 |S2000 |0.19980101e8 |1 |
 
 #### Filter
 
 ```ruby
-query = Dynamodb::Api::Query.new
+query = Dynamodb::Api.query
 query.from('cars').index('index_maker_id_release_date').
   where(['maker_id', '=', 1]).
   filter('model = :model', ':model': 'S2000')
 items = query.all.items
 ```
 
-| maker_id(Partition key) | model | release_date(Sort key) | status |
-|:---|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |1 |
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|4 |1 |S2000 |0.19980101e8 |1 |
 
 #### Limit
 
 ```ruby
-query = Dynamodb::Api::Query.new
+query = Dynamodb::Api.query
 query.from('cars').index('index_maker_id_release_date').
   where(['maker_id', '=', 1]).
   order('asc'). # default: 'desc'
@@ -127,9 +127,9 @@ query.from('cars').index('index_maker_id_release_date').
 items = query.all.items
 ```
 
-| maker_id(Partition key) | model | release_date(Sort key) | status |
-|:---|:---|:---|:---|
-|1 |Accord |0.19760508e8 |0 |
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|1 |1 |Accord |0.19760508e8 |0 |
 
 #### Expression Attribute Names
 
@@ -138,22 +138,59 @@ In `dynamodb-api` , you can omit the special processing by putting `#` at the be
 Refer to the list of reserved words from [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html).
 
 ```ruby
-query = Dynamodb::Api::Query.new
+query = Dynamodb::Api.query
 query.from('cars').index('index_maker_id_release_date').
   where(['maker_id', '=', 1]).
   filter('#status = :status', ':status': 1)
 items = query.all.items
 ```
 
-| maker_id | model | release_date | status |
-|:---|:---|:---|:---|
-|1 |S2000 |0.19980101e8 |1 |
+| id | maker_id(Partition key) | model | release_date(Sort key) | status |
+|:---|:---|:---|:---|:---|
+|4 |1 |S2000 |0.19980101e8 |1 |
 
 If you don't add `#` to a reserved word, the following error will occur:
 
     Aws::DynamoDB::Errors::ValidationException:
       Invalid FilterExpression: Attribute name is a reserved keyword; reserved keyword: [reserved word]
 
+### Insert
+
+```ruby
+item = { id: '5', maker_id: 1, maker: 'Honda', model: 'NSX', release_date: 19900914 }
+Dynamodb::Api.insert('cars', item)
+```
+
+### Update
+
+```ruby
+key = { id: '5' }
+value = { new_col: 'new' }
+Dynamodb::Api.update('cars', key, value)
+```
+
+### Delete
+
+```ruby
+key = { id: '5' }
+Dynamodb::Api.delete('cars', key)
+```
+
+### Other API operations
+
+`client` returns the `<Aws::DynamoDB::Client>` .
+So, you can use all [API operations](https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html).
+
+```ruby
+client = Dynamodb::Api::Adapter.client # <Aws::DynamoDB::Client>
+
+# e.g.
+client.create_backup(
+  table_name: 'TableName', # required
+  backup_name: 'BackupName', # required
+)
+```
+
 ## Development
 
 - Run `docker-compose up` to run the dynamodb_local.

data/bin/console

@@ -11,4 +11,17 @@ require "dynamodb/api"
 # Pry.start
 
 require "irb"
+
+ENV['ACCESS_KEY'] ||= 'abcd'
+ENV['SECRET_KEY'] ||= '1234'
+
+Aws.config.update(
+  region: 'ap-northeast-1',
+  credentials: Aws::Credentials.new(ENV['ACCESS_KEY'], ENV['SECRET_KEY'])
+)
+
+Dynamodb::Api.config do |config|
+  config.endpoint = 'http://0.0.0.0:8000'
+end
+
 IRB.start(__FILE__)

data/lib/dynamodb/api.rb

@@ -18,7 +18,9 @@ require 'dynamodb/api/relation/expression_attribute_names'
 require 'dynamodb/api/relation/limit_clause'
 require 'dynamodb/api/put/item'
 require 'dynamodb/api/delete/tables'
+require 'dynamodb/api/delete/item'
 require 'dynamodb/api/map/operator'
+require 'dynamodb/api/update/item'
 
 module Dynamodb
   module Api # :nodoc:
@@ -36,9 +38,21 @@ module Dynamodb
       Delete::Tables.delete_tables
     end
 
+    def query
+      Query.new
+    end
+
     def insert(table_name, value)
       # TODO: BatchWriteItem
       Put::Item.put_item(value, table_name)
     end
+
+    def update(table_name, key, value)
+      Update::Item.new.update_item(key, value, table_name)
+    end
+
+    def delete(table_name, key)
+      Delete::Item.delete_item(key, table_name)
+    end
   end
 end

data/lib/dynamodb/api/delete/item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dynamodb
+  module Api
+    module Delete
+      class Item # :nodoc:
+        def self.delete_item(key, table_name)
+          client = Adapter.client
+          client.delete_item(key: key, table_name: table_name)
+        end
+      end
+    end
+  end
+end

data/lib/dynamodb/api/update/item.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Dynamodb
+  module Api
+    module Update
+      class Item # :nodoc:
+        def update_item(key, cols, table_name)
+          @key = key
+          @cols = cols
+          @table_name = table_name
+
+          client = Adapter.client
+          client.update_item(build_update_clause)
+        end
+
+        private
+
+        def build_update_expression
+          str = @cols.each_with_object([]) do |(k, _v), ary|
+            ary << "##{k} = :#{k}"
+          end.join(', ')
+          "SET #{str}"
+        end
+
+        def build_expression_attribute_names
+          @cols.each_with_object({}) do |(k, _v), h|
+            h["##{k}"] = k
+          end
+        end
+
+        def build_expression_attribute_values
+          @cols.each_with_object({}) do |(k, v), h|
+            h[":#{k}"] = v
+          end
+        end
+
+        def build_update_clause
+          {
+            key: @key, table_name: @table_name,
+            update_expression: build_update_expression,
+            expression_attribute_names: build_expression_attribute_names,
+            expression_attribute_values: build_expression_attribute_values,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dynamodb/api/version.rb

@@ -1,5 +1,5 @@
 module Dynamodb
   module Api
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - WalkerSumida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2018-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -152,6 +152,7 @@ files:
 - lib/dynamodb/api/adapter.rb
 - lib/dynamodb/api/config.rb
 - lib/dynamodb/api/config/options.rb
+- lib/dynamodb/api/delete/item.rb
 - lib/dynamodb/api/delete/tables.rb
 - lib/dynamodb/api/map/operator.rb
 - lib/dynamodb/api/put/item.rb
@@ -166,6 +167,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/update/item.rb
 - lib/dynamodb/api/version.rb
 homepage: https://github.com/walkersumida/dynamodb-api
 licenses: