synced 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b1d111a0f8399a92dc2e05d16a7f5d2ec1b483f
-  data.tar.gz: 5e294cabc9c1f81592269017b74b6463b554b91e
+  metadata.gz: e53235ec845a40357c1ae3610807ca571cec8807
+  data.tar.gz: 9e1b1289380aafc9a0a08b8f940a773b4308ade2
 SHA512:
-  metadata.gz: b93a1b2a3485ccc1280356f17a6f76bada7a6a39314f4f5b0c44e10779418d638b957ca5f8a49136b7e3dc0484f9805af522134cc85c68934d170f76289338d3
-  data.tar.gz: f52a4a789d434ae88fcc9f3e60f5f6f3350e139995ed39e90d120befb113ce2b7218ea03a468701ad99d3bb46133819b12e0456e4d973c109675fcc45957b9d5
+  metadata.gz: 30fb365ace28a5d26c29601a42d0f308c6a43fdafb0d872968bd797aea799da796a250a8eca45f02c2e43033f5ff8598a5162cb7361119e59777a372e58dcc34
+  data.tar.gz: 004235ba0a34d878c544665ba580bdf0fd643eac9d84e71421f783aaef5901095359923975608a5588ee7362867470faf615a496e513300a059c0faca57735d0

data/README.md

@@ -168,6 +168,39 @@ class Rental < ActiveRecord::Base
 end
 ```
 
+### Globalized attributes
+
+Some of the API endpoints return strings in multiple languages.
+When your app is also multilingual you might want take advantage of it
+and import translations straight to model translations.
+
+In order to import translations use `:globalized_attributes` attribute. It
+assumes that your app is using Globalize 3 or newer and `:headline` is already
+a translated attribute.
+
+```ruby
+class Rental < ActiveRecord::Base
+  synced globalized_attributes: :headline
+  translates :headline
+end
+```
+
+Now headline will be saved for all translations provided by the API.
+If given translation will be removed on the API side, it will set to nil
+locally.
+
+If you want to map remote field to a different local attribute,
+specify mapping as a Hash instead of an Array.
+
+```ruby
+class Rental < ActiveRecord::Base
+  synced globalized_attributes: {headline: :description}
+  translates :headline
+end
+```
+
+This will map remote `:description` to local `:headline` attribute.
+
 ## Partial updates (using updated since parameter)
 
 Partial updates mean that first synchronization will copy all of the remote
@@ -182,6 +215,24 @@ NOTE: In order it to work, given endpoint needs to support updated_since
 parameter. Check [API documentation](http://docs.api.bookingsync.com/reference/)
 for given endpoint.
 
+### Forcing local objects to be re-synced with the API
+
+When you add a new column or change something in the synced attributes and you
+are using partial updates, old local objects will not be re-synced with API
+automatically. You need to reset `synced_all_at` column in order to force
+re-syncing objects again on the next synchronization. In order to do that use
+`reset_synced` method.
+
+```ruby
+Rental.reset_synced
+```
+
+You can use this method on a relation as well.
+
+```ruby
+account.rentals.reset_synced
+```
+
 ## Disabling saving whole synced_data
 
 If you don't need whole remote object to be stored in local object skip

data/lib/synced/model.rb

@@ -16,7 +16,7 @@ module Synced
     #   remote objects
     # @option options [Symbol] data_key: attribute name under which remote
     #   object's data is stored.
-    # @option options [Array] local_attributes: Array of attributes in the remote
+    # @option options [Array|Hash] local_attributes: Array of attributes in the remote
     #   object which will be mapped to local object attributes.
     # @option options [Boolean|Symbol] remove: If it's true all local objects
     #   within current scope which are not present in the remote array will be
@@ -27,27 +27,32 @@ module Synced
     #   if it's missing, all will be destroyed with destroy_all.
     #   You can also force method to remove local objects by passing it
     #   to remove: :mark_as_missing.
+    # @option options [Array|Hash] globalized_attributes: A list of attributes
+    #   which will be mapped with their translations.
     def synced(options = {})
       options.symbolize_keys!
-      options.assert_valid_keys(:associations, :data_key, :fields, :id_key,
-        :include, :local_attributes, :mapper, :only_updated, :remove,
-        :synced_all_at_key)
+      options.assert_valid_keys(:associations, :data_key, :fields,
+        :globalized_attributes, :id_key, :include, :local_attributes, :mapper,
+        :only_updated, :remove, :synced_all_at_key)
       class_attribute :synced_id_key, :synced_all_at_key, :synced_data_key,
         :synced_local_attributes, :synced_associations, :synced_only_updated,
-        :synced_mapper, :synced_remove, :synced_include, :synced_fields
-      self.synced_id_key           = options.fetch(:id_key, :synced_id)
-      self.synced_all_at_key       = options.fetch(:synced_all_at_key,
+        :synced_mapper, :synced_remove, :synced_include, :synced_fields,
+        :synced_globalized_attributes
+      self.synced_id_key                = options.fetch(:id_key, :synced_id)
+      self.synced_all_at_key            = options.fetch(:synced_all_at_key,
         synced_column_presence(:synced_all_at))
-      self.synced_data_key         = options.fetch(:data_key,
+      self.synced_data_key              = options.fetch(:data_key,
         synced_column_presence(:synced_data))
-      self.synced_local_attributes = options.fetch(:local_attributes, [])
-      self.synced_associations     = options.fetch(:associations, [])
-      self.synced_only_updated     = options.fetch(:only_updated,
+      self.synced_local_attributes      = options.fetch(:local_attributes, [])
+      self.synced_associations          = options.fetch(:associations, [])
+      self.synced_only_updated          = options.fetch(:only_updated,
         column_names.include?(synced_all_at_key.to_s))
-      self.synced_mapper           = options.fetch(:mapper, nil)
-      self.synced_remove           = options.fetch(:remove, false)
-      self.synced_include          = options.fetch(:include, [])
-      self.synced_fields           = options.fetch(:fields, [])
+      self.synced_mapper                = options.fetch(:mapper, nil)
+      self.synced_remove                = options.fetch(:remove, false)
+      self.synced_include               = options.fetch(:include, [])
+      self.synced_fields                = options.fetch(:fields, [])
+      self.synced_globalized_attributes = options.fetch(:globalized_attributes,
+        [])
       include Synced::HasSyncedData
     end
 
@@ -88,14 +93,15 @@ module Synced
       options[:include] = Array(synced_include) unless options.has_key?(:include)
       options[:fields]  = Array(synced_fields) unless options.has_key?(:fields)
       options.merge!({
-        id_key:            synced_id_key,
-        synced_data_key:   synced_data_key,
-        synced_all_at_key: synced_all_at_key,
-        data_key:          synced_data_key,
-        local_attributes:  synced_local_attributes,
-        associations:      synced_associations,
-        only_updated:      synced_only_updated,
-        mapper:            synced_mapper
+        id_key:                synced_id_key,
+        synced_data_key:       synced_data_key,
+        synced_all_at_key:     synced_all_at_key,
+        data_key:              synced_data_key,
+        local_attributes:      synced_local_attributes,
+        associations:          synced_associations,
+        only_updated:          synced_only_updated,
+        mapper:                synced_mapper,
+        globalized_attributes: synced_globalized_attributes
       })
       Synced::Synchronizer.new(self, options).perform
     end

data/lib/synced/synchronizer.rb

@@ -37,24 +37,27 @@ module Synced
     #   remote objects
     # @option options [Module] mapper: Module class which will be used for
     #   mapping remote objects attributes into local object attributes
+    # @option options [Array|Hash] globalized_attributes: A list of attributes
+    #   which will be mapped with their translations.
     def initialize(model_class, options = {})
-      @model_class       = model_class
-      @scope             = options[:scope]
-      @id_key            = options[:id_key]
-      @synced_all_at_key = options[:synced_all_at_key]
-      @data_key          = options[:data_key]
-      @remove            = options[:remove]
-      @only_updated      = options[:only_updated]
-      @include           = options[:include]
-      @local_attributes  = options[:local_attributes]
-      @api               = options[:api]
-      @mapper            = options[:mapper].respond_to?(:call) ?
-                             options[:mapper].call : options[:mapper]
-      @fields            = options[:fields]
-      @remove            = options[:remove]
-      @associations      = Array(options[:associations])
-      @remote_objects    = Array(options[:remote]) unless options[:remote].nil?
-      @request_performed = false
+      @model_class           = model_class
+      @scope                 = options[:scope]
+      @id_key                = options[:id_key]
+      @synced_all_at_key     = options[:synced_all_at_key]
+      @data_key              = options[:data_key]
+      @remove                = options[:remove]
+      @only_updated          = options[:only_updated]
+      @include               = options[:include]
+      @local_attributes      = attributes_as_hash(options[:local_attributes])
+      @api                   = options[:api]
+      @mapper                = options[:mapper].respond_to?(:call) ?
+                               options[:mapper].call : options[:mapper]
+      @fields                = options[:fields]
+      @remove                = options[:remove]
+      @associations          = Array(options[:associations])
+      @remote_objects        = Array(options[:remote]) unless options[:remote].nil?
+      @request_performed     = false
+      @globalized_attributes = attributes_as_hash(options[:globalized_attributes])
     end
 
     def perform
@@ -69,6 +72,10 @@ module Synced
               local_object = local_object_by_remote_id(remote.id) || relation_scope.new
               local_object.attributes = default_attributes_mapping(remote)
               local_object.attributes = local_attributes_mapping(remote)
+              if @globalized_attributes.present?
+                local_object.attributes = globalized_attributes_mapping(remote,
+                  local_object.translations.translated_locales)
+              end
               local_object.save! if local_object.changed?
               local_object.tap do |local_object|
                 @associations.each do |association|
@@ -92,15 +99,9 @@ module Synced
     private
 
     def local_attributes_mapping(remote)
-      if @local_attributes.is_a?(Hash)
-        Hash[
-          @local_attributes.map do |k, v|
-            [k, v.respond_to?(:call) ? v.call(remote) : remote.send(v)]
-          end
-        ]
-      else
-        Hash[Array(@local_attributes).map { |k| [k, remote.send(k)] }]
-      end
+      Hash[@local_attributes.map do |k, v|
+        [k, v.respond_to?(:call) ? v.call(remote) : remote.send(v)]
+      end]
     end
 
     def default_attributes_mapping(remote)
@@ -110,6 +111,16 @@ module Synced
       end
     end
 
+    def globalized_attributes_mapping(remote, used_locales)
+      empty = Hash[used_locales.map { |locale| [locale.to_s, nil] }]
+      {}.tap do |attributes|
+        @globalized_attributes.each do |local_attr, remote_attr|
+          translations = empty.merge(remote.send(remote_attr) || {})
+          attributes["#{local_attr}_translations"] = translations
+        end
+      end
+    end
+
     # Returns relation within which local objects are created/edited and removed
     # If no scope is provided, the relation_scope will be class on which
     # .synchronize method is called.
@@ -213,6 +224,11 @@ module Synced
       Synced.instrumenter.instrument(*args, &block)
     end
 
+    def attributes_as_hash(attributes)
+      return attributes if attributes.is_a?(Hash)
+      Hash[Array(attributes).map { |name| [name, name] }]
+    end
+
     class MissingAPIClient < StandardError
       def initialize(scope, model_class)
         @scope = scope

data/lib/synced/version.rb

@@ -1,3 +1,3 @@
 module Synced
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synced
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Sebastien Grosjean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -137,6 +137,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: globalize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
 description: Keep your BookingSync Application synced with BookingSync.
 email:
 - dev@bookingsync.com