synced 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9d07dc9160fbcc981a1b08e986c8b732768b3912
-  data.tar.gz: 6ad287a51fd7465e84120d34c230d0359ef7afe1
+SHA256:
+  metadata.gz: c2c2e645519782a9d9dd2d17e75c568d9da22740fd72ae1df00378c274db862c
+  data.tar.gz: bddae30333bfe7676cf0efccce14d22296988f5a5bcaff40ee5e99bd2fa15054
 SHA512:
-  metadata.gz: 0381da8af658da381a11eb0fcc3b2f764a0e90e20c6fb5df03e6fc33d3755c1f39bdd4451c94461779ecb66140e6e60940e71781714ed1cf3431a038344a6c3b
-  data.tar.gz: 8c30d25d30aebb37edd4f1eb3b331795bce23efbcdda85331468f9c01b220b08ae3c97bac7e25fd9e157329e9816d8c4a1327cf8df2eb66533b7139d39245980
+  metadata.gz: 9b7640f5888e65432bb20672b372dae02c2b92a81d48ada3799145526ccc5838f36652843822c872e308f99ec347723b8cbf462adc99db489e0c0bb567219c41
+  data.tar.gz: ed40aead1f87fa5f0eb4fa78fe1eead2c936deae3676caa516a31c60c822992d7d0bb3529e58abdd5c160a470af69128846380cb5c4e477443f3ec0f2f98389e

data/README.md

@@ -1,5 +1,5 @@
-[![Code Climate](https://codeclimate.com/github/BookingSync/synced.png)](https://codeclimate.com/github/BookingSync/synced)
-[![Build Status](https://travis-ci.org/BookingSync/synced.png?branch=master)](https://travis-ci.org/BookingSync/synced)
+©[![Code Climate](https://codeclimate.com/github/BookingSync/synced.png)](https://codeclimate.com/github/BookingSync/synced)
+[![Build Status](https://github.com/BookingSync/synced/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/BookingSync/synced/actions/workflows/ci.yml)
 
 # Synced
 
@@ -13,7 +13,7 @@ added/changed/deleted objects since last synchronization.
 
 ## Requirements
 
-This engine requires Rails `>= 4.0.0` and Ruby `>= 2.0.0`.
+This engine requires Rails `>= 6.0.0` and Ruby `>= 2.7.0`.
 
 ## Installation
 
@@ -500,6 +500,9 @@ Or as a param in `synchronize` method:
 Photo.synchronize(transaction_per_page: true)
 ```
 
+## Model Aliasing
+By default `synced` gem will look for an endpoint in BookingSync with the same name as it was defined in. If you want to name your class differently or place it in a namespace, provide endpoint of resource that you want to access with the `endpoint` option. Like so: `synced endpoint: :bookings`.
+
 ## Synced configuration options
 
 Option name          | Default value    | Description                                                                       | synced | synchronize |
@@ -518,6 +521,7 @@ Option name          | Default value    | Description
 `: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 |
+`:endpoint` | `table name of the class it was defined in` | endpoint for synchronizeable resource on BookingSync | YES    | NO |
 
 ## Documentation
 

data/lib/synced/model.rb

@@ -50,13 +50,13 @@ module Synced
       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)
+        :timestamp_strategy, :handle_processed_objects_proc, :tolerance, :endpoint)
       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_tolerance
+        :synced_tolerance, :synced_endpoint
       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) }
@@ -78,6 +78,7 @@ module Synced
       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
+      self.synced_endpoint              = options.fetch(:endpoint) { self.to_s.tableize }
       include Synced::DelegateAttributes
       include Synced::HasSyncedData
     end
@@ -126,7 +127,6 @@ module Synced
       options[:transaction_per_page] = synced_transaction_per_page unless options.has_key?(:transaction_per_page)
       options.merge!({
         scope:                 scope,
-        strategy:              strategy,
         id_key:                synced_id_key,
         synced_data_key:       synced_data_key,
         data_key:              synced_data_key,
@@ -138,9 +138,10 @@ module Synced
         initial_sync_since:    synced_initial_sync_since,
         timestamp_strategy:    synced_timestamp_strategy,
         handle_processed_objects_proc:  synced_handle_processed_objects_proc,
-        tolerance:             synced_tolerance
+        tolerance:             synced_tolerance,
+        synced_endpoint:       synced_endpoint
       })
-      Synced::Synchronizer.new(self, options).perform
+      Synced::Synchronizer.new(self, strategy: strategy, **options).perform
     end
 
     # Reset last sync timestamp for given scope, this forces synced to sync
@@ -150,12 +151,12 @@ module Synced
     def reset_synced(scope: scope_from_relation)
       options = {
         scope:                 scope,
-        strategy:              synced_strategy,
         only_updated:          synced_only_updated,
         initial_sync_since:    synced_initial_sync_since,
-        timestamp_strategy:    synced_timestamp_strategy
+        timestamp_strategy:    synced_timestamp_strategy,
+        synced_endpoint:       synced_endpoint
       }
-      Synced::Synchronizer.new(self, options).reset_synced
+      Synced::Synchronizer.new(self,  strategy: synced_strategy, **options).reset_synced
     end
 
     private
@@ -172,4 +173,3 @@ module Synced
     end
   end
 end
-

data/lib/synced/strategies/full.rb

@@ -49,6 +49,7 @@ module Synced
       #   of fetched records
       def initialize(model_class, options = {})
         @model_class           = model_class
+        @synced_endpoint       = options[:synced_endpoint]
         @scope                 = options[:scope]
         @id_key                = options[:id_key]
         @data_key              = options[:data_key]
@@ -198,18 +199,18 @@ module Synced
       def fetch_and_save_remote_objects(processor)
         instrument("fetch_remote_objects.synced", model: @model_class) do
           if @transaction_per_page
-            api.paginate(resource_name, api_request_options) do |batch|
+            api.paginate(@synced_endpoint, api_request_options) do |batch|
               relation_scope.transaction do
                 processor.call(batch)
               end
             end
           elsif @auto_paginate
             relation_scope.transaction do
-              processor.call(api.paginate(resource_name, api_request_options))
+              processor.call(api.paginate(@synced_endpoint, api_request_options))
             end
           else
             relation_scope.transaction do
-              api.paginate(resource_name, api_request_options) do |batch|
+              api.paginate(@synced_endpoint, api_request_options) do |batch|
                 processor.call(batch)
               end
             end

data/lib/synced/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: synced
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sebastien Grosjean
 - Mariusz Pietrzyk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bookingsync-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +222,7 @@ homepage: https://github.com/BookingSync/synced
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -237,9 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Keep your BookingSync Application synced with BookingSync.
 test_files: []