Project

aquasync_model

0.0
No commit activity in last 3 years
No release in over 3 years
aquasync_modelaqaquamarine/aquasync_modelHomepageDocumentationSource CodeBug TrackerWiki
A mixin to help development of Aquasync.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
20,020
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.2.2
Total releases
6
First release
2014-08-01
Latest release
2014-08-05
 Issues
Open Issues
0
Closed Issues
3
Total Issues
3
Issue Closure Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-07-31
Reverse Dependencies
1

 Dependencies

Development

database_cleaner
~> 1.3
factory_girl
~> 4.4
guard-rspec
~> 4.3
rspec
~> 3.0

Runtime

activerecord
~> 4.0
activesupport
~> 4.0
mongoid
~> 4.0
simple_uuid
~> 0.4
 Project Readme

aquasync_model

Gem Version

A module to mixin Aquasync Model requirements.

Example

require 'aquasync_model'

class Book
  include Aquasync::Base

  field :name
end

Then it automatically mixin fields, callbacks, validators to satisfy Aquasync Model requirement.

Specs

#before_save
  ust are set when saved
  gid should be lowercase
validation
  does not allow nil for :gid
  does not allow nil for :deviceToken
  does not allow nil for :localTimestamp
  allows lowercase UUID values for :gid
  does not allow not-UUID value for :gid
  allows lowercase UUID values for :deviceToken
  does not allow not-UUID value for :deviceToken
#to_h
  does not include _id
  does not include ust

Fields

# should be UNIX timestamp
# @example 1406697904
field :ust, type: Integer
# should be UNIX timestamp
# @example 1406697904
field :localTimestamp, type: Integer
# should be UUIDv1
# @example 550e8400-e29b-41d4-a716-446655440000
field :gid, type: String
# should be UUIDv1
# @example 550e8400-e29b-41d4-a716-446655440000
field :deviceToken, type: String
# for paranoid deletion
# @example false
field :isDeleted, type: Boolean

Callbacks

before_validation do
  downcase_gid
  downcase_device_token
  set_ust
end

Validations

validates_presence_of :gid
validates_format_of :gid, with: /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
validates_presence_of :ust
validates_presence_of :deviceToken
validates_format_of :deviceToken, with: /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
validates_presence_of :localTimestamp

Aquasync DeltasAggregator methods

def aq_deltas(ust)
    where(:ust.gt => ust)
end

def aq_commit_deltas(deltas)
    deltas.each {|delta| commit_delta(delta) }
end

Aquasync DeltaPack methods

def to_h
  serializable_hash.delete_if {|key| key == "_id" or key == "ust"}
end