dinamo 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5a87623eec736f4ade9d8159b6266f582f6f1c6
-  data.tar.gz: 13601000c2defa1cd05be25af741688989988bc4
+  metadata.gz: d9cd6b373ec5452b1dd8376a579372d5b006f926
+  data.tar.gz: d4a31a837890869dde716495d151307c2b5e8fdc
 SHA512:
-  metadata.gz: 531d04b7abe01ae2ae4242a7d39e21213a90c012ed91231c189a6a8defd601d43d311564736c621b67a24cb04ae89317137165842a4b433114d341eeac9cef3b
-  data.tar.gz: d79cfc37a67d1e1a7e43caff2cb3393d67998bff8cb71d14c27ed6f55d117374f0a147d2678713f556f8c8a6413a855698d1d06ba51dd6b4934e9cfbe64e4e8e
+  metadata.gz: 6d4af004b40517092c57f65ff2515245433e197e72020739880a2a344f137bfd16f248094a3931e599aaae548113f50af3867b21f1b2586f665912db559c231d
+  data.tar.gz: 5c5596eaa98c31d66c08215c4a8bfe7e1eab5aa1999c1ada8cdefc26022978e61a2c7dc5b05613db578adefe6efc81d616a9b82c1547136a0be893606f952adf

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.2.5
+  - 2.3.1
 before_install: gem install bundler -v 1.10.6
 install:
   - mkdir /tmp/dynamodb
-  - wget -O - http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest | tar xz --directory /tmp/dynamodb
+  - wget -O - https://s3-ap-northeast-1.amazonaws.com/dynamodb-local-tokyo/dynamodb_local_latest.tar.gz | tar xz --directory /tmp/dynamodb
 before_script:
   - java -Djava.library.path=/tmp/dynamodb/DynamoDBLocal_lib -jar /tmp/dynamodb/DynamoDBLocal.jar -sharedDb -inMemory &
   - sleep 2

data/README.md

@@ -1,6 +1,10 @@
 # Dinamo
 
-Dinamo is an simple ORM for Amazon DynamoDB for Ruby applications.
+[![build status](https://img.shields.io/travis/namusyaka/dinamo.svg?style=flat-square)](http://travis-ci.org/namusyaka/dinamo)
+[![gem](https://img.shields.io/gem/v/dinamo.svg?style=flat-square)](https://rubygems.org/gems/dinamo)
+[![license](https://img.shields.io/github/license/namusyaka/dinamo.svg?style=flat-square)](https://github.com/namusyaka/dinamo/blob/master/LICENSE.txt)
+
+Dinamo is an ORM for [Dynamo DB](https://aws.amazon.com/dynamodb/), it has followed the behavior of the ORM which is often seen in the Ruby culture.
 
 ## Installation
 
@@ -18,27 +22,68 @@ Or install it yourself as:
 
     $ gem install dinamo
 
-## Usage
+## Overview
 
-### Sample
+Dinamo makes it easy to create DynamoDB record from any ruby object. Also, dinamo supports for [data types of Dynamo DB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html) such as scaler types, document types and set types. This means things that you can declare their types on your model.
 
-Your class must inherit `Dinamo::Model` in every Dinamo model.
+Of course, you can use validations, casting and model change tracking smoothly.
+Next section will describe their things with example code.
+
+## Usage
+
+### Model definition
 
 ```ruby
 class User < Dinamo::Model
-  hash_key :id, type: :number
-  range_key :kind, type: :string
-  field :name, type: :string
+  hash_key :name, type: :string
+  field    :age,  type: :number
+end
+```
+
+### Building/Saving
+
+```ruby
+user = User.new(name: 'numb', age: 24)
+user.persisted? #=> false
+user.save
+user.persisted? #=> true
+```
+
+Or you can use `create`.
+
+```ruby
+user = User.create(name: 'numb', age: 24)
+user.persisted? #=> true
+```
+
+### Dirty (model change tracking)
+
+```ruby
+user = User.new(name: 'numb', age: 24)
+user.changed? #=> false
+user.age = 25
+user.changed? #=> true
+user.save
+user.changed? #=> false
+```
+
+### Validation
+
+```ruby
+class NameLengthValidator < Dinamo::Model::Validation::Validator
+  def validate(record)
+    unless options[:length].include?(record.name.length)
+      record.errors.add(:name, I18n.t("models.user.error.length"))
+    end
+  end
 end
 
-user = User.new
-user.id   = 1
-user.kind = "developer"
-user.name = "namusyaka"
+class User < Dinamo::Model
+  hash_key :id
+  field :name, type: :string
 
-user.valid? #=> true
-user.errors #=> {}
-user.save #=> true
+  validates_with NameLengthValidator, length: 1..30
+end
 ```
 
 ## Contributing

data/dinamo.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", "~> 5.0.0"
-  spec.add_dependency "aws-sdk",       "~> 2.1.26"
+  spec.add_dependency "aws-sdk-core", "~> 3"
+  spec.add_dependency "aws-sdk-dynamodb", "~> 1.2"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/dinamo/adapter.rb

@@ -1,5 +1,5 @@
 require 'dinamo/exceptions'
-require 'aws-sdk'
+require 'aws-sdk-dynamodb'
 
 module Dinamo
   class Adapter

data/lib/dinamo/version.rb

@@ -1,3 +1,3 @@
 module Dinamo
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dinamo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - namusyaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.26
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.26
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,4 +179,3 @@ signing_key:
 specification_version: 4
 summary: DynamoDB ORM for Ruby
 test_files: []
-has_rdoc: