aquasync_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e928cee82bd6380e8aa1873b29508880f12ae3da
+  data.tar.gz: 1ba61cbaa2c95c8e2b2d2256ea748f3c45edcd7a
+SHA512:
+  metadata.gz: 531a97065839dfe68b9bcba55227b2c82c162f2512db6fc53b2076dc5b3bf2a601a35504957e4cc55a9b750c3feab8c867a3b0ccfa8ec67810357e1520eb7205
+  data.tar.gz: 1efbd90fadb51cff0a3195aab16dd6ca369205ec4ea99c2c86a7cc448d1ae34c465111819304ab7654dcc720575d18590c2c1f76323f6b02f156b6c94e3210e1

data/lib/models/base.rb

@@ -0,0 +1,41 @@
+require 'mongoid'
+require 'active_support/concern'
+require_relative 'concerns/aquasync_callbacks'
+require_relative 'concerns/aquasync_aggregated_methods'
+require_relative 'concerns/aquasync_delta_pack_methods'
+require_relative '../validators/aquasync_validator'
+
+module Aquasync
+  # Is a concern to mixin AquasyncModel requirements.
+  # @see https://github.com/AQAquamarine/aquasync-protocol/blob/master/aquasync-model.md
+  # @author kaiinui
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      include Mongoid::Document
+
+      # 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
+
+      validates_with Aquasync::Validator
+
+      include Aquasync::Callbacks
+      include Aquasync::AggregatedMethods
+      include Aquasync::DeltaPackMethods
+    end
+  end
+end

data/lib/models/concerns/aquasync_aggregated_methods.rb

@@ -0,0 +1,47 @@
+require 'active_support/concern'
+
+module Aquasync
+  # Has a responsibility to implement Aquasync::DeltasAggregator requirement.
+  # @author kaiinui
+  # @see DeltasAggregator
+  module AggregatedMethods
+    extend ActiveSupport::Concern
+
+    included do
+      # @param [Hash]
+      def resolve_conflict(delta)
+        self.update_attributes(delta) if delta["localTimestamp"] > self.localTimestamp
+      end
+    end
+
+    module ClassMethods
+      # DeltasAggregator requirement
+      # @return [Array<Aquasync::Base>]
+      def aq_deltas(ust)
+        where(:ust.gt => ust)
+      end
+
+      # DeltasAggregator requirement
+      # @return [NilClass]
+      def aq_commit_deltas(deltas)
+        deltas.each {|delta| commit_delta(delta) }
+      end
+
+      # commits a delta.
+      # @param [Hash]
+      def commit_delta(delta)
+        record = find_by(gid: delta["gid"])
+        if record
+          record.resolve_conflict(delta)
+        else
+          create_record_from_delta(delta)
+        end
+      end
+
+      # @param [Hash]
+      def create_record_from_delta(delta)
+        create(delta)
+      end
+    end
+  end
+end

data/lib/models/concerns/aquasync_callbacks.rb

@@ -0,0 +1,34 @@
+require 'active_support/concern'
+require 'active_support/core_ext'
+
+module Aquasync
+  # Has a responsibility to implement format methods to obey AquasyncModel.
+  # @see https://github.com/AQAquamarine/aquasync-protocol/blob/master/aquasync-model.md
+  # @author kaiinui
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      before_validation do
+        downcase_gid
+        downcase_device_token
+        set_ust
+      end
+
+      # gid should be lowercase (https://github.com/AQAquamarine/aquasync-protocol/blob/master/aquasync-model.md#aquasync-model)
+      def downcase_gid
+        self.gid.try(:downcase!)
+      end
+
+      # deviceToken should be lowercase (https://github.com/AQAquamarine/aquasync-protocol/blob/master/aquasync-model.md#aquasync-model)
+      def downcase_device_token
+        self.deviceToken.try(:downcase!)
+      end
+
+      # sets UST current UNIX timestamp
+      def set_ust
+        self.ust = Time.now.to_i
+      end
+    end
+  end
+end

data/lib/models/concerns/aquasync_delta_pack_methods.rb

@@ -0,0 +1,26 @@
+require 'active_support/concern'
+
+module Aquasync
+  # Has a responsibility to implement DeltaPackBuilder requirement.
+  # @author kaiinui
+  # @see DeltaPackBuilder
+  module DeltaPackMethods
+    extend ActiveSupport::Concern
+
+    included do
+      # returns its class name. Hoge for "Hoge".
+      # *DeltaPackBuilder Requirement
+      # @return [Symbol]
+      def _name
+        self.class.name
+      end
+
+      # returns serialized hash whose _id is excluded.
+      # *DeltaPackBuilder Requirement
+      # @return [Hash]
+      def to_h
+        serializable_hash.delete_if {|key| key == "_id" or key == "ust"}
+      end
+    end
+  end
+end

data/lib/validators/aquasync_validator.rb

@@ -0,0 +1,19 @@
+require 'active_model/validator'
+
+module Aquasync
+  # Has a responsibility to implement AquasyncModel validations.
+  # @see https://github.com/AQAquamarine/aquasync-protocol/blob/master/aquasync-model.md
+  # @author kaiinui
+  # @example usage
+  #   validates_with Aquasync::Validator
+  class Validator < ActiveModel::Validator
+    def validate(record)
+      record.validates_presence_of :gid
+      record.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}/
+      record.validates_presence_of :ust
+      record.validates_presence_of :deviceToken
+      record.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}/
+      record.validates_presence_of :localTimestamp
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: aquasync_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kaiinui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simple_uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A mixin to help development of Aquasync.
+email: me@kaiinui.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/models/base.rb
+- lib/models/concerns/aquasync_aggregated_methods.rb
+- lib/models/concerns/aquasync_callbacks.rb
+- lib/models/concerns/aquasync_delta_pack_methods.rb
+- lib/validators/aquasync_validator.rb
+homepage: https://github.com/AQAquamarine/aquasync_model
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A mixin model which implements Aquasync Model specification.
+test_files: []
+has_rdoc: