ud_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bd624f7a50e53ab1cfaa2ddce8be9f50f7342b5
+  data.tar.gz: aa73de3d74848846325ab80eeba6d6f39cd9b810
+SHA512:
+  metadata.gz: 3a68af143ba1bf28704e3269ac26aa3017d3f087c457437d366331d3d53703f34c40e58f447d3c47e4f657825561101ff3709cdd8eca02f8a23121277a3b346d
+  data.tar.gz: f5c5d56349b628b3f0e6553f617c9450106b957476ff2c461db0515013377da0d9f2add2f0ada9b9c04ac173c06f47c77618b03cee826b3945b09fd4878f5dab

data/.gitignore

@@ -0,0 +1,12 @@
+*.log
+*.sqlite3
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.2.2
+  - 2.1.0
+  - 2.0.0
+before_install:
+  - gem install bundler -v 1.10.6
+  - ./bin/setup

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ud-sync-rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,124 @@
+# ud_sync_rails [![Build Status](https://travis-ci.org/ud-sync/ud-sync-rails.svg?branch=master)](https://travis-ci.org/ud-sync/ud-sync-rails)
+
+ud-sync is a set of tools to allow client applications to work offline. This gem
+will help you on the server.
+
+This gem will plug into your Rails models and save every DB operation.
+With that information, it will expose `GET /ud_sync/operations` so that your
+mobile devices can come from offline and know what data was deleted in other
+devices, synchronizing automatically.
+
+We're aiming at building the client counterparts. Check the
+[ud-sync](https://github.com/ud-sync) organization for other languages
+(e.g [ud-sync-swift](Swift)).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ud_sync'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+**Step 1: add the route**
+
+```ruby
+Rails.application.routes.draw do
+  mount UdSync::Engine => "/ud_sync"
+
+  # ...
+end
+```
+
+**Step 2: configure your models**
+
+```ruby
+class Post < ActiveRecord::Base
+  ud_sync
+
+  # ...
+end
+```
+
+Whenever you save or delete a post, this will save the operation automatically.
+
+**Step 3: consume /ud_sync/operations**
+
+When you access `GET /ud_sync/operations`, you will get a response such as the
+following.
+
+```json
+{
+  "operations" => [{
+    "id" => 1,
+    "name" => "save",
+    "record_id" => "record-1",
+    "entity" => "User",
+    "date" => "2025-10-23T10:32:41Z"
+  }, {
+    "id" => 2,
+    "name" => "delete",
+    "record_id" => "record-2",
+    "entity" => "Post",
+    "date" => "2025-10-23T11:23:23Z"
+  }]
+}
+```
+
+`name` stands for the name of the operation, which could be `save` or `delete`.
+`record_id` is the id of the record that was processed. `entity` is the resource
+name and `date` when it happened.
+
+For example, when DeviceA running your offline ready mobile app deletes Post
+with id `record-2`, this operation will be recorded. When DeviceB comes online,
+it will request the operations endpoint and check that the Post was deleted
+online. It will then delete it locally so that it's synchronized with DeviceA.
+
+**Step 4: define current_user in your application controller**
+
+If your `ApplicationController` has `current_user` defined, `GET /operations`
+will only return Operations which `owner_id` equals `current_user.id`
+
+### Customizing ud-sync-rails
+
+You can customize it by changing `ud_sync` call:
+
+```ruby
+class Post < ActiveRecord::Base
+  belongs_to :user
+
+  ud_sync entity: 'Article', id: :uuid, owner: :user
+  # ...
+end
+```
+
+`entity` is the name of the resource. If not specified, the name of the model
+class will be used. `id` is the attribute you want to use as id - for example,
+when you use uuids, you might not want to expose your internal ids. `owner`
+is the association that represents the user that has the current resource. With
+that, you can return only the operations belonging to the current user.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake` to run the tests.
+
+### Testing
+
+When adding a new attribute via migration, do the following to clean up the
+cache:
+
+```
+bin/setup
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ud-sync-rails.
+

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+#
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+# This refreshes migration paths and no duplications occur
+ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/ud_sync/operations_controller.rb

@@ -0,0 +1,19 @@
+module UdSync
+  class OperationsController < ActionController::Base
+    def index
+      operations = UdSync::Operation.all
+
+      render json: {
+        operations: operations.map do |operation|
+          {
+            id:        operation.id,
+            name:      operation.name,
+            record_id: operation.record_id,
+            entity:    operation.entity_name,
+            date:      operation.created_at.iso8601,
+          }
+        end
+      }
+    end
+  end
+end

data/app/models/ud_sync/operation.rb

@@ -0,0 +1,5 @@
+module UdSync
+  class Operation < ActiveRecord::Base
+    self.table_name = :ud_sync_operations
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ud/sync/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/reset

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+rm spec/dummy/db/*.sqlite3
+rm spec/dummy/db/schema.rb
+./bin/setup

data/bin/setup

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+rake db:create db:migrate
+rake db:schema:dump

data/config/routes.rb

@@ -0,0 +1,3 @@
+UdSync::Engine.routes.draw do
+  resources :operations, only: [:index]
+end

data/db/migrate/20160130183000_create_ud_sync_tables.rb

@@ -0,0 +1,13 @@
+class CreateUdSyncTables < ActiveRecord::Migration
+  def change
+    create_table :ud_sync_operations do |t|
+      t.string :name,         null: false
+      t.string :record_id
+      t.string :external_id,  null: false
+      t.string :owner_id
+      t.string :entity_name,  null: false
+      t.timestamps
+    end
+  end
+end
+

data/lib/ud_sync/engine.rb

@@ -0,0 +1,13 @@
+module UdSync
+  class Engine < ::Rails::Engine
+    isolate_namespace UdSync
+
+    initializer 'account.append_migrations' do |app|
+      unless app.root.to_s == root.to_s
+        config.paths["db/migrate"].expanded.each do |path|
+          app.config.paths["db/migrate"].push(path)
+        end
+      end
+    end
+  end
+end

data/lib/ud_sync/rails/model_extension.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  class Base
+    class << self
+      def ud_sync(entity: nil, id: :id, owner: nil)
+        @@ud_sync_options ||= {}
+
+        class_name = self.name
+        @@ud_sync_options[class_name] = {
+          entity: entity,
+          id: id,
+          owner: owner
+        }
+
+        self.after_save :save_operation
+        self.after_destroy :save_operation
+      end
+    end
+
+    def save_operation
+      UdSync::Sentinel.new(self, @@ud_sync_options[self.class.name]).save_operation
+    end
+  end
+end

data/lib/ud_sync/sentinel.rb

@@ -0,0 +1,53 @@
+module UdSync
+  class Sentinel
+
+    def initialize(model, options)
+      @model = model
+      @options = options
+    end
+
+    def save_operation
+      operation = if model.destroyed?
+                    :delete
+                  else
+                    :save
+                  end
+
+      UdSync::Operation.create(
+        name:        operation,
+        record_id:   model.id,
+        external_id: external_id,
+        owner_id:    owner_id,
+        entity_name: operation_name
+      )
+    end
+
+    private
+
+    attr_accessor :model, :options
+
+    def external_id
+      attribute = options[:id]
+      model.public_send(attribute)
+    end
+
+    def owner_id
+      if options[:owner].present?
+        attribute = "#{options[:owner]}".to_sym
+
+        if model.respond_to?(attribute) && model.public_send(attribute).present?
+          association = model.public_send(attribute)
+          if association.respond_to?(:id)
+            association.id.to_s
+          else
+            raise OwnerAssociationHasNoIdError, "The owner association has no id column"
+          end
+        end
+      end
+    end
+
+    def operation_name
+      options[:entity] || model.class.name
+    end
+  end
+end

data/lib/ud_sync/version.rb

@@ -0,0 +1,3 @@
+module UdSync
+  VERSION = "0.1.0"
+end

data/lib/ud_sync.rb

@@ -0,0 +1,9 @@
+require "ud_sync/version"
+
+require "ud_sync/engine"
+require "ud_sync/sentinel"
+require "ud_sync/rails/model_extension"
+
+module UdSync
+  class OwnerAssociationHasNoIdError < StandardError; end
+end

data/ud_sync.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ud_sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ud_sync"
+  spec.version       = UdSync::VERSION
+  spec.authors       = ["Alexandre de Oliveira"]
+  spec.email         = ["chavedomundo@gmail.com"]
+
+  spec.summary       = ""
+  spec.description   = ""
+  spec.homepage      = "https://github.com/kurko/ud-sync-rails"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_dependency "rails", ">=4.2"
+  spec.add_dependency "railties", ">=4.2"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: ud_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre de Oliveira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: ''
+email:
+- chavedomundo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/ud_sync/operations_controller.rb
+- app/models/ud_sync/operation.rb
+- bin/console
+- bin/reset
+- bin/setup
+- config/routes.rb
+- db/migrate/20160130183000_create_ud_sync_tables.rb
+- lib/ud_sync.rb
+- lib/ud_sync/engine.rb
+- lib/ud_sync/rails/model_extension.rb
+- lib/ud_sync/sentinel.rb
+- lib/ud_sync/version.rb
+- ud_sync.gemspec
+homepage: https://github.com/kurko/ud-sync-rails
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []