dynamodb-api 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4061c168a73225d611dccc1a6e22aefcc7db228c0ea943f9a043f1a55113dad0
-  data.tar.gz: c01601e30d038fdd7454ba554c517470cb229fab94576de46986e0fe5ff92dba
+  metadata.gz: 3497adfb9b42e61ab127deb44c26834aff181ebe8a12e2842a49f4548f87b844
+  data.tar.gz: 9bdbb77d400193f402ae5e02502d2cd02ef39eee12f0455325b1f0bd1673c930
 SHA512:
-  metadata.gz: b393488340105ee19749dc58c6f15c6e90fbb83c42b16f7f115be3ef6dd8422f2b688b852d76ae933e05c64762f0ad595b9b1b39b77e80c67529659ef40f0b55
-  data.tar.gz: 18f26f3209871a606ec1193c85d8f8a8b30b3875858b7090fbb5488aa6f15dae96ceead389bd52807dccb768895e8f4965a3debad010150c8297319417952713
+  metadata.gz: ab22702e4ee21d4471a499a743bd99f15e9a2e231adbce737db77feb1c405e18ceed4ab833f602b135051a7fede6f5b1bd85ca7caba736bc5b88cb031e827999
+  data.tar.gz: 070f875b3e41688a0840ec506a3f12b04127e59d0dec90d2102e50abad14cdd742a6fccc7b274813065b9226330dc13f176d02c7144d586a57603c9df2c9d4a6

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.3
+require:
+  - rubocop-airbnb
+
+inherit_from:
+  - .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,2 @@
+Airbnb/OptArgParameters:
+  Enabled: false

data/.travis.yml

@@ -1,11 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
+  - 2.3
+  - 2.4
+  - 2.5
 before_install: gem install bundler -v 1.16.2
 
 before_script:
   - docker-compose up -d
 
+script: bundle exec rubocop --fail-level=C
+
 after_script:
   - docker-compose down

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamodb-api (0.4.1)
+    dynamodb-api (0.4.2)
       activesupport (>= 4)
       aws-sdk (~> 2)
 
@@ -13,6 +13,7 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    ast (2.4.0)
     aws-sdk (2.11.93)
       aws-sdk-resources (= 2.11.93)
     aws-sdk-core (2.11.93)
@@ -27,15 +28,21 @@ GEM
     diff-lcs (1.3)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
     jmespath (1.4.0)
     method_source (0.9.0)
     minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -50,9 +57,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-airbnb (1.5.0)
+      rubocop (= 0.57.2)
+      rubocop-rspec (= 1.27.0)
+    rubocop-rspec (1.27.0)
+      rubocop (>= 0.56.0)
+    ruby-progressbar (1.10.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -64,6 +86,7 @@ DEPENDENCIES
   pry-byebug
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop-airbnb
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -1,10 +1,7 @@
 # Dynamodb::Api
 
 [![Build Status](https://travis-ci.org/walkersumida/dynamodb-api.svg?branch=master)](https://travis-ci.org/walkersumida/dynamodb-api)
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dynamodb/api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/dynamodb-api.svg)](https://badge.fury.io/rb/dynamodb-api)
 
 ## Installation
 
@@ -24,9 +21,11 @@ Or install it yourself as:
 
 ## Configuration
 
+### Rails
+
 `config/initializers/dynamodb_api.rb`
 
-```
+```ruby
 Dynamodb::Api.config do |config|
   config.access_key_id = ''
   config.secret_access_key = ''
@@ -36,6 +35,102 @@ Dynamodb::Api.config do |config|
 end
 ```
 
+### Other
+
+```ruby
+Dynamodb::Api.config.access_key_id = ''
+Dynamodb::Api.config.secret_access_key = ''
+Dynamodb::Api.config.region = ''
+Dynamodb::Api.config.table_name_prefix = ''
+Dynamodb::Api.config.index_name_prefix = ''
+```
+
+## How to use
+e.g.
+
+cars table.
+
+| maker_id(Partition key) | model | release_date(Sort key) |
+|:---|:---|:---|
+|1 |Accord |0.19760508e8 |
+|2 |CROWN |0.19550101e8 |
+|3 |Model S |0.20120601e8 |
+|1 |S2000 |0.19980101e8 |
+
+### Query
+https://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#query-instance_method
+
+#### Partition(Hash) key
+
+```ruby
+query = Dynamodb::Api::Query.new
+query.from('cars').index('index_maker_id_release_date').
+  where(['maker_id', '=', 1])
+items = query.all.items
+```
+
+| maker_id | model | release_date |
+|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |
+|1 |Accord |0.19760508e8 |
+
+#### Partition key and Sort(Range) key
+
+```ruby
+query = Dynamodb::Api::Query.new
+query.from('cars').index('index_maker_id_release_date').
+  where([['maker_id', '=', 1], ['release_date', '>=', 19_980_101]])
+items = query.all.items
+```
+
+| maker_id | model | release_date |
+|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |
+
+#### Sorting
+
+```ruby
+query = Dynamodb::Api::Query.new
+query.from('cars').index('index_maker_id_release_date').
+  where(['maker_id', '=', 1]).
+  order('asc') # default: 'desc'
+items = query.all.items
+```
+
+| maker_id | model | release_date |
+|:---|:---|:---|
+|1 |Accord |0.19760508e8 |
+|1 |S2000 |0.19980101e8 |
+
+#### Filter
+
+```ruby
+query = Dynamodb::Api::Query.new
+query.from('cars').index('index_maker_id_release_date').
+  where(['maker_id', '=', 1]).
+  filter('model = :model', ':model': 'S2000')
+items = query.all.items
+```
+
+| maker_id | model | release_date |
+|:---|:---|:---|
+|1 |S2000 |0.19980101e8 |
+
+#### Limit
+
+```ruby
+query = Dynamodb::Api::Query.new
+query.from('cars').index('index_maker_id_release_date').
+  where(['maker_id', '=', 1]).
+  order('asc'). # default: 'desc'
+  limit(1)
+items = query.all.items
+```
+
+| maker_id | model | release_date |
+|:---|:---|:---|
+|1 |Accord |0.19760508e8 |
+
 ## Development
 
 - Run `docker-compose up` to run the dynamodb_local.

data/dynamodb-api.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['WalkerSumida']
   spec.email         = ['walkersumida@gmail.com']
 
-  spec.summary       = %q{aws dynamodb api}
-  spec.description   = %q{aws dynamodb api}
+  spec.summary       = %q(aws dynamodb api)
+  spec.description   = %q(aws dynamodb api)
   spec.homepage      = 'https://github.com/walkersumida/dynamodb-api'
   spec.license       = 'MIT'
 
@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop-airbnb'
 end

data/lib/dynamodb/api.rb

@@ -14,8 +14,10 @@ require 'dynamodb/api/relation/where_clause'
 require 'dynamodb/api/relation/filter_clause'
 require 'dynamodb/api/relation/global_secondary_index'
 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/map/operator'
 
 module Dynamodb
   module Api # :nodoc:

data/lib/dynamodb/api/adapter.rb

@@ -8,7 +8,7 @@ module Dynamodb
       end
 
       def self.connect_config
-        config_keys = %w[endpoint access_key_id secret_access_key region]
+        config_keys = %w(endpoint access_key_id secret_access_key region)
         @connect_hash = {}
 
         config_keys.each do |config_key|

data/lib/dynamodb/api/map/operator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Dynamodb
+  module Api
+    module Map
+      class Operator # :nodoc:
+        def self.key(k)
+          k = k.gsub(' ', '')
+          case k
+          when '='
+            'EQ'
+          when '!='
+            'NE'
+          when '<='
+            'LE'
+          when '<'
+            'LT'
+          when '>='
+            'GE'
+          when '>'
+            'GT'
+          else
+            k
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dynamodb/api/query.rb

@@ -17,13 +17,14 @@ module Dynamodb
         build_params = {
           table_name: from_clause.name,
           index_name: index_clause.name,
-          key_conditions: where_clause.key_conditions
+          key_conditions: where_clause.key_conditions,
         }.merge(build_filter_clause)
         build_params[:scan_index_forward] = order_direct(order_clause)
         build_params[:select] = select_name(select_clause)
         if expression_attribute&.names
           build_params[:expression_attribute_names] = expression_attribute.names
         end
+        build_params[:limit] = limit_clause.number if limit_clause&.number
         build_params
       end
 
@@ -39,7 +40,7 @@ module Dynamodb
         return {} unless filter_clause&.expression
         {
           filter_expression: filter_clause.expression,
-          expression_attribute_values: filter_clause.values
+          expression_attribute_values: filter_clause.values,
         }
       end
     end

data/lib/dynamodb/api/relation.rb

@@ -13,6 +13,7 @@ module Dynamodb
       attr_accessor :where_clause
       attr_accessor :filter_clause
       attr_accessor :expression_attribute
+      attr_accessor :limit_clause
     end
   end
 end

data/lib/dynamodb/api/relation/expression_attribute_names.rb

@@ -4,7 +4,7 @@ module Dynamodb
   module Api
     module Relation
       class ExpressionAttributeNames
-        attr_reader  :names
+        attr_reader :names
 
         def initialize(names)
           @names = names
@@ -13,4 +13,3 @@ module Dynamodb
     end
   end
 end
-

data/lib/dynamodb/api/relation/global_secondary_index.rb

@@ -4,7 +4,7 @@ module Dynamodb
   module Api
     module Relation
       class GlobalSecondaryIndex
-        attr_reader  :name
+        attr_reader :name
 
         def initialize(name)
           if Dynamodb::Api::Config.index_name_prefix?

data/lib/dynamodb/api/relation/limit_clause.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dynamodb
+  module Api
+    module Relation
+      class LimitClause # :nodoc:
+        attr_reader :number
+
+        def initialize(number)
+          @number = number
+        end
+      end
+    end
+  end
+end

data/lib/dynamodb/api/relation/query_methods.rb

@@ -2,40 +2,47 @@
 
 module Dynamodb
   module Api
-    module QueryMethods # :nodoc:
-      def from(value)
-        self.from_clause = Relation::FromClause.new(value)
-        self
-      end
+    module Relation
+      module QueryMethods # :nodoc:
+        def from(value)
+          self.from_clause = Relation::FromClause.new(value)
+          self
+        end
 
-      def index(value)
-        self.index_clause = Relation::GlobalSecondaryIndex.new(value)
-        self
-      end
+        def index(value)
+          self.index_clause = Relation::GlobalSecondaryIndex.new(value)
+          self
+        end
 
-      def select(value = nil)
-        self.select_clause = Relation::SelectClause.new(value)
-        self
-      end
+        def select(value = nil)
+          self.select_clause = Relation::SelectClause.new(value)
+          self
+        end
 
-      def order(value = nil)
-        self.order_clause = Relation::OrderClause.new(value)
-        self
-      end
+        def order(value = nil)
+          self.order_clause = Relation::OrderClause.new(value)
+          self
+        end
 
-      def where(key_conditions)
-        self.where_clause = Relation::WhereClause.new(key_conditions)
-        self
-      end
+        def where(key_conditions)
+          self.where_clause = Relation::WhereClause.new(key_conditions)
+          self
+        end
 
-      def filter(expression, values)
-        self.filter_clause = Relation::FilterClause.new(expression, values)
-        self
-      end
+        def filter(expression, values)
+          self.filter_clause = Relation::FilterClause.new(expression, values)
+          self
+        end
+
+        def ex_attr(names)
+          self.expression_attribute = Relation::ExpressionAttributeNames.new(names)
+          self
+        end
 
-      def ex_attr(names)
-        self.expression_attribute = Relation::ExpressionAttributeNames.new(names)
-        self
+        def limit(value)
+          self.limit_clause = Relation::LimitClause.new(value)
+          self
+        end
       end
     end
   end

data/lib/dynamodb/api/relation/where_clause.rb

@@ -7,8 +7,8 @@ module Dynamodb
         attr_reader :key_conditions
 
         KEY = 0
-        VALUE = 1
-        OPERATOR = 2
+        VALUE = 2
+        OPERATOR = 1
 
         def initialize(key_conditions)
           @key_conditions = build(key_conditions)
@@ -21,7 +21,7 @@ module Dynamodb
           conditions.each_with_object({}) do |c, h|
             h[c[KEY]] = {
               attribute_value_list: format_value(c[VALUE]),
-              comparison_operator: c[OPERATOR]
+              comparison_operator: Map::Operator.key(c[OPERATOR]),
             }
           end
         end

data/lib/dynamodb/api/version.rb

@@ -1,5 +1,5 @@
 module Dynamodb
   module Api
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - WalkerSumida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-airbnb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: aws dynamodb api
 email:
 - walkersumida@gmail.com
@@ -104,6 +118,8 @@ files:
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -120,6 +136,7 @@ files:
 - lib/dynamodb/api/config.rb
 - lib/dynamodb/api/config/options.rb
 - lib/dynamodb/api/delete/tables.rb
+- lib/dynamodb/api/map/operator.rb
 - lib/dynamodb/api/put/item.rb
 - lib/dynamodb/api/query.rb
 - lib/dynamodb/api/relation.rb
@@ -127,6 +144,7 @@ files:
 - lib/dynamodb/api/relation/filter_clause.rb
 - lib/dynamodb/api/relation/from_clause.rb
 - lib/dynamodb/api/relation/global_secondary_index.rb
+- lib/dynamodb/api/relation/limit_clause.rb
 - lib/dynamodb/api/relation/order_clause.rb
 - lib/dynamodb/api/relation/query_methods.rb
 - lib/dynamodb/api/relation/select_clause.rb