synced 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7216624feb81567456dd5c0d2468da9d36232efe
+  data.tar.gz: b2ac5bb712039e8ddedb5713960a5a68785545a4
+SHA512:
+  metadata.gz: bec0c589e63b7ff64d901a3d3e9172a032c7b1ba8bd9466122011d0dc9d127510294daa0d8597a95fbe60214c99c8feef96cfe9d598b63beb511cf7a6884832b
+  data.tar.gz: 955521df6291cc240e6ddd38e6643a0ebf79685fadd4a6285d585bdcee1b2445080635200e585b9cfd6daed47b2a295950a75120e53e2a0e116c8ae9a26573c5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 BookingSync
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Synced
+
+Synced is a Rails Engine that helps you keep local models synchronized with their BookingSync representation.
+
+Note: This synchronization is in one way only, from BookingSync to your application. If you want to do a 2 way synchronization, you will need to implement it yourself using [BookingSync-API](https://github.com/BookingSync/bookingsync-api)
+
+## Requirements
+
+This engine requires BookingSync API `>= 0.0.17`, Rails `>= 4.0.0` and Ruby `>= 2.0.0`.
+
+## Documentation
+
+[API documentation is available at rdoc.info](http://rdoc.info/github/BookingSync/synced/master/frames).
+
+## Installation
+
+Synced works with BookingSync API 0.0.17 onwards, Rails 4.0 onwards and Ruby 2.0 onwards. To get started, add it to your Gemfile with:
+
+```ruby
+gem 'synced'
+```
+
+Then run the installer to copy the migrations,
+
+```console
+rake synced:install:migrations
+```
+
+Then, generate a migration to add Synced fields for the model you want to synchronize:
+
+Example:
+```console
+rails g migration AddSyncedFieldsToRentals synced_id:integer:index synced_data:text \
+  synced_updated_at:datetime
+```
+
+and migrate:
+
+```console
+rake db:migrate
+```
+
+And include `Synced::HasSyncedData` in the model you want to keep in sync:
+
+Example:
+```ruby
+class Rental < ActiveRecord::Base
+  include Synced::HasSyncedData
+end
+```

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'thor'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Synced'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+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/models/synced/synchronization.rb

@@ -0,0 +1,4 @@
+module Synced
+  class Synchronization < ActiveRecord::Base
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/20140621143737_create_synced_synchronizations.rb

@@ -0,0 +1,10 @@
+class CreateSyncedSynchronizations < ActiveRecord::Migration
+  def change
+    create_table :synced_synchronizations do |t|
+      t.string :model
+      t.datetime :synchronized_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/synced.rb

@@ -0,0 +1,4 @@
+require "synced/engine"
+
+module Synced
+end

data/lib/synced/engine.rb

@@ -0,0 +1,13 @@
+module Synced
+  class Engine < ::Rails::Engine
+    isolate_namespace Synced
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.to_prepare do
+      require "synced/engine/lib/has_synced_data"
+    end
+  end
+end

data/lib/synced/engine/lib/has_synced_data.rb

@@ -0,0 +1,37 @@
+require 'hashie'
+
+module Synced
+  # Provide a serialized `bs_data` attribute for models. This is a friendlier
+  # alternative to `serialize` with respect to dirty attributes.
+  module HasSyncedData
+    class SyncedData < Hashie::Mash; end
+
+    # Serialize and set remote data from `object`.
+    def synced_data=(object)
+      write_attribute :synced_data, dump(object)
+    ensure
+      @synced_data = nil
+    end
+
+    # Return remote data as a cached instance.
+    def synced_data
+      @synced_data ||= SyncedData.new loaded_synced_data
+    end
+
+    private
+
+    def loaded_synced_data
+      load read_attribute(:synced_data)
+    rescue
+      {}
+    end
+
+    def dump(object)
+      JSON.dump object
+    end
+
+    def load(source)
+      JSON.load source
+    end
+  end
+end

data/lib/synced/version.rb

@@ -0,0 +1,3 @@
+module Synced
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: synced
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sebastien Grosjean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bookingsync-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 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: guard-rspec
+  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: Keep your BookingSync Application synced with BookingSync.
+email:
+- dev@bookingsync.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/synced/synchronization.rb
+- config/routes.rb
+- db/migrate/20140621143737_create_synced_synchronizations.rb
+- lib/synced.rb
+- lib/synced/engine.rb
+- lib/synced/engine/lib/has_synced_data.rb
+- lib/synced/version.rb
+homepage: https://github.com/BookingSync/synced
+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: Keep your BookingSync Application synced with BookingSync.
+test_files: []