synced 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ea40c30211956a680d7ef2a3030fbf97cfe45c2
-  data.tar.gz: 3cbc1b4d38f7aabc32e54eac1ddf73667de1f13c
+  metadata.gz: 9d07dc9160fbcc981a1b08e986c8b732768b3912
+  data.tar.gz: 6ad287a51fd7465e84120d34c230d0359ef7afe1
 SHA512:
-  metadata.gz: 8dbad6127fda57a74cb2d4c8fd443fbd8b4d6e7da07a2bb8203d07175f64bc4d146b43da406cfe28175d5a345542373beb5edcb3b5539e9e1a338be6bdb476a9
-  data.tar.gz: b9a5699877146d56c1ac2ae2a2da4e94a29308c36bd09a89bf51b1178628ffb5ef3359806394a53c5cc7b19b6d3b9b2938ad78b73a15c95cb1b0f313737551ac
+  metadata.gz: 0381da8af658da381a11eb0fcc3b2f764a0e90e20c6fb5df03e6fc33d3755c1f39bdd4451c94461779ecb66140e6e60940e71781714ed1cf3431a038344a6c3b
+  data.tar.gz: 8c30d25d30aebb37edd4f1eb3b331795bce23efbcdda85331468f9c01b220b08ae3c97bac7e25fd9e157329e9816d8c4a1327cf8df2eb66533b7139d39245980

data/README.md

@@ -275,12 +275,13 @@ and copy the body from here:
 class CreateSyncedTimestamps < ActiveRecord::Migration
   def change
     create_table :synced_timestamps do |t|
-      t.belongs_to :parent_scope, polymorphic: true
+      t.string :parent_scope_type
+      t.integer :parent_scope_id
       t.string :model_class, null: false
       t.datetime :synced_at, null: false
     end
 
-    add_index :synced_timestamps, [:parent_scope_id, :parent_scope_type, :model_class, :synced_at], name: 'synced_timestamps_max_index', order: { synced_at: 'DESC' }
+    add_index :synced_timestamps, [:parent_scope_id, :parent_scope_type, :model_class, :synced_at], name: "synced_timestamps_max_index", order: { synced_at: "DESC" }
   end
 end
 ```
@@ -289,6 +290,27 @@ end
 This strategy is added to fix the problems with massive updates on `synced_all_at`. Proper cleanup of timestamp records
 is needed once in a while with `Synced::Timestamp.cleanup` (cleans records older than 1 week).
 
+### Syncing with offset
+
+Sometimes (mostly for pricing related endpoints like LOS Records or Rates) sync request
+is made during transaction. That can make your local database out of sync, usually due to
+older records not being removed. For such cases there is `tolerance` option which will
+reduce `updated_since` value by specified amount of seconds. That way, if your last request has
+been made during transaction, everything will heal itself during next sync.
+
+For example:
+
+```ruby
+class Rental < ActiveRecord::Base
+  synced tolerance: 60
+end
+```
+
+Will always reduce `updated_since` param by 60 seconds.
+Setting this value too high can cause re-fetching same changes multiple times, which
+may exhaust rate limit of your application much faster and increase overall sync time.
+
+
 ### 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
@@ -495,6 +517,7 @@ Option name          | Default value    | Description
 `:auto_paginate`     | `true`           | [Whether data should be fetched in batches or as one response](#fetching-methods)                 | YES    | YES |
 `:transaction_per_page` | `false`       | [Whether transaction should be per page of fetched objects or for all the pages - note that setting this value to `true` will mean always fetching data in batches, even when specifying `auto_paginate` as true](#persisting-fetched-objects)                 | YES    | YES |
 `:handle_processed_objects_proc` | `nil` | [Custom proc taking persisted remote objects, called after persisting batch of data](#persisted-objects)   | YES    | NO |
+`:tolerance`         | 0                | [How many seconds updated_since param should be reduced during request](#syncing-with-offset) | YES | NO |
 
 ## Documentation
 

data/lib/synced/model.rb

@@ -43,16 +43,20 @@ module Synced
     # @option options [Proc] handle_processed_objects_proc: Proc taking one argument (persisted remote objects).
     #   Called after persisting remote objects (once in case of auto_paginate, after each batch
     #   when paginating with block).
+    # @option options [Integer] tolerance: amount of seconds subtracted from last_request timestamp.
+    #   Used to ensure records are up to date in case request has been made in the middle of transaction.
+    #   Defaults to 0.
     def synced(strategy: :updated_since, **options)
-      options.assert_valid_keys(:associations, :data_key, :fields,
-        :globalized_attributes, :id_key, :include, :initial_sync_since,
-        :local_attributes, :mapper, :only_updated, :remove, :auto_paginate, :transaction_per_page,
-        :delegate_attributes, :query_params, :timestamp_strategy, :handle_processed_objects_proc)
+      options.assert_valid_keys(:associations, :data_key, :fields, :globalized_attributes,
+        :id_key, :include, :initial_sync_since, :local_attributes, :mapper, :only_updated,
+        :remove, :auto_paginate, :transaction_per_page, :delegate_attributes, :query_params,
+        :timestamp_strategy, :handle_processed_objects_proc, :tolerance)
       class_attribute :synced_id_key, :synced_data_key,
         :synced_local_attributes, :synced_associations, :synced_only_updated,
         :synced_mapper, :synced_remove, :synced_include, :synced_fields, :synced_auto_paginate, :synced_transaction_per_page,
         :synced_globalized_attributes, :synced_initial_sync_since, :synced_delegate_attributes,
-        :synced_query_params, :synced_timestamp_strategy, :synced_strategy, :synced_handle_processed_objects_proc
+        :synced_query_params, :synced_timestamp_strategy, :synced_strategy, :synced_handle_processed_objects_proc,
+        :synced_tolerance
       self.synced_strategy              = strategy
       self.synced_id_key                = options.fetch(:id_key, :synced_id)
       self.synced_data_key              = options.fetch(:data_key) { synced_column_presence(:synced_data) }
@@ -73,6 +77,7 @@ module Synced
       self.synced_auto_paginate         = options.fetch(:auto_paginate, true)
       self.synced_transaction_per_page  = options.fetch(:transaction_per_page, false)
       self.synced_handle_processed_objects_proc  = options.fetch(:handle_processed_objects_proc, nil)
+      self.synced_tolerance             = options.fetch(:tolerance, 0).to_i.abs
       include Synced::DelegateAttributes
       include Synced::HasSyncedData
     end
@@ -132,7 +137,8 @@ module Synced
         globalized_attributes: synced_globalized_attributes,
         initial_sync_since:    synced_initial_sync_since,
         timestamp_strategy:    synced_timestamp_strategy,
-        handle_processed_objects_proc:  synced_handle_processed_objects_proc
+        handle_processed_objects_proc:  synced_handle_processed_objects_proc,
+        tolerance:             synced_tolerance
       })
       Synced::Synchronizer.new(self, options).perform
     end

data/lib/synced/strategies/updated_since.rb

@@ -11,6 +11,7 @@ module Synced
       def initialize(model_class, options = {})
         super
         @initial_sync_since = options[:initial_sync_since]
+        @tolerance = options[:tolerance]
         timestampt_strategy_class = options[:timestamp_strategy] || Synced::Strategies::SyncedAllAtTimestampStrategy
         @timestamp_strategy = timestampt_strategy_class.new(relation_scope: relation_scope, scope: @scope, model_class: model_class)
       end
@@ -44,10 +45,15 @@ module Synced
 
       def updated_since
         instrument("updated_since.synced") do
-          [@timestamp_strategy.last_synced_at, initial_sync_since].compact.max
+          [last_synced_at_with_offset, initial_sync_since].compact.max
         end
       end
 
+      def last_synced_at_with_offset
+        return if @timestamp_strategy.last_synced_at.blank?
+        @timestamp_strategy.last_synced_at - @tolerance
+      end
+
       def deleted_remote_objects_ids
         meta && meta[:deleted_ids] or raise CannotDeleteDueToNoDeletedIdsError.new(@model_class)
       end

data/lib/synced/version.rb

@@ -1,3 +1,3 @@
 module Synced
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synced
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Sebastien Grosjean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails