consyncful 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f62207463a8f75a74abef31265619b16425ef9b8cfa9cecc8935ab8fd74937
-  data.tar.gz: 5eca96bb788eb38855afa49cafaf5091eabbb5343f09828266f4f7e95cba3d29
+  metadata.gz: 7098621f9a1f36a61f658c4897016b0b578e30003a2e0efd84aca0c5c7385088
+  data.tar.gz: 6017ae2bb5a5565555d6fb264815d650bca697bd781b855f1b4df622ecc2c61f
 SHA512:
-  metadata.gz: 2c9188b10e74d92bf2078e3227ecf7f189a749e088a5a64990f7f66fe0256eccc9628b07cb287ef78307f15287c2a7f57992688170b574e802fbc5f03b916508
-  data.tar.gz: a63b5e7ddca0cab2dc969b8a83b48ca66c4957b7641ddf7caa6be22e45733cb9bebb405187bb867280bd5149b2c2b2bd2e7399694df80fba39e1874979887dbd
+  metadata.gz: 1938e0faa4a541d1f8c2070c81ecf5cd67ac2bc677cccd85eeb39c5d90d633ac9a2c3468f9880335f7a1090e32bcc5dbe56eef8ca1dc8c8742151798106f4a32
+  data.tar.gz: bfa6e4d41df6a91434411ef58a2eacd6a790eec522f3b392754d3fc2bf496ec79e436b3c0d95d527a61e74c9900a51cdae6b29fd8ed415fd8fb523cd8134d390

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    consyncful (0.7.2)
+    consyncful (0.8.0)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
-      mongoid (>= 7.0.2, < 8.0.0)
+      mongoid (>= 7.0.2, < 9.0.0)
       rainbow
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3)
-      activesupport (= 7.0.3)
-    activesupport (7.0.3)
+    activemodel (7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     bson (4.15.0)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     contentful (2.16.3)
       http (> 0.8, < 5.0)
       multi_json (~> 1)
@@ -47,18 +47,18 @@ GEM
       ffi-compiler (>= 1.0, < 2.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.2)
-    mongo (2.17.1)
-      bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.4.0)
+    minitest (5.17.0)
+    mongo (2.18.2)
+      bson (>= 4.14.1, < 5.0.0)
+    mongoid (8.0.3)
       activemodel (>= 5.1, < 7.1, != 7.0.0)
-      mongo (>= 2.10.5, < 3.0.0)
+      mongo (>= 2.18.0, < 3.0.0)
       ruby2_keywords (~> 0.0.5)
     multi_json (1.15.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.7)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.1)
     regexp_parser (2.3.1)
@@ -93,7 +93,7 @@ GEM
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uber (0.0.15)
     unf (0.1.4)

data/README.md

@@ -42,7 +42,7 @@ If you don't already use Mongoid, generate a mongoid.yml by running:
 
 Add an initializer:
 
-Consyncful uses [contentful.rb](https://github.com/contentful/contentful.rb); client options are as documented there.
+Consyncful uses [contentful.rb](https://github.com/contentful/contentful.rb); client options are as documented there. Sync options are documented in the [Content Delivery Sync API docs](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization).
 ```rb
 Consyncful.configure do |config|
   config.locale = 'en-NZ'
@@ -53,6 +53,11 @@ Consyncful.configure do |config|
     environment: 'master',        # optional
     logger: Logger.new(STDOUT)    # optional for debugging
   }
+
+  # optional to override the Sync API defaults
+  config.contentful_sync_options = { 
+    limit: 50
+  }
 end
 ```
 

data/consyncful.gemspec

@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'contentful', ['>=2.11.1', '<3.0.0']
   spec.add_dependency 'hooks', '>=0.4.1'
-  spec.add_dependency 'mongoid', ['>=7.0.2', '<8.0.0']
+  spec.add_dependency 'mongoid', ['>=7.0.2', '<9.0.0']
   spec.add_dependency 'rainbow'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/consyncful/sync.rb

@@ -83,13 +83,17 @@ module Consyncful
     end
 
     def start_sync
-      if next_url.present?
-        puts Rainbow("Starting update, last update: #{last_run_at} (#{(Time.current - last_run_at).round(3)}s ago)").blue
-        Consyncful.client.sync(next_url)
-      else
-        puts Rainbow('Starting full refresh').blue
-        Consyncful.client.sync(initial: true)
-      end
+      next_url.present? ? start_update : start_new_sync
+    end
+
+    def start_update
+      puts Rainbow("Starting update, last update: #{last_run_at} (#{(Time.current - last_run_at).round(3)}s ago)").blue
+      Consyncful.client.sync(next_url)
+    end
+
+    def start_new_sync
+      puts Rainbow('Starting full refresh').blue
+      Consyncful.client.sync(Consyncful.configuration.initial_sync_options)
     end
 
     def sync_items(sync, stats)

data/lib/consyncful/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consyncful
-  VERSION = '0.7.2'
+  VERSION = '0.8.0'
 end

data/lib/consyncful.rb

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 
 require 'consyncful/version'
-
 require 'mongoid'
 require 'contentful'
-
 require 'consyncful/base'
 require 'consyncful/sync'
-
 require 'consyncful/railtie' if defined?(Rails)
 
 module Consyncful
   # Handles Rails configurations for Consynful
   class Configuration
     attr_accessor :contentful_client_options,
+                  :contentful_sync_options,
                   :locale,
                   :mongo_client,
                   :mongo_collection,
@@ -22,9 +20,8 @@ module Consyncful
                   :preserve_contentful_timestamps
 
     def initialize
-      @contentful_client_options = {
-        api_url: 'cdn.contentful.com'
-      }
+      @contentful_client_options = {}
+      @contentful_sync_options = {}
       @locale = 'en-NZ'
       @mongo_client = :default
       @mongo_collection = 'contentful_models'
@@ -32,6 +29,17 @@ module Consyncful
       @ignore_content_tags = []
       @preserve_contentful_timestamps = false
     end
+
+    def initial_sync_options
+      options = { initial: true }
+      options = options.reverse_merge(@contentful_sync_options)
+      options.reverse_merge(DEFAULT_SYNC_OPTIONS)
+    end
+
+    def client_options
+      options = @contentful_client_options
+      options.reverse_merge!(DEFAULT_CLIENT_OPTIONS)
+    end
   end
 
   DEFAULT_CLIENT_OPTIONS = {
@@ -39,6 +47,12 @@ module Consyncful
     api_url: 'cdn.contentful.com'
   }.freeze
 
+  # see https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization
+  DEFAULT_SYNC_OPTIONS = {
+    limit: 100,
+    type: 'all'
+  }.freeze
+
   class << self
     def configuration
       @configuration ||= Configuration.new
@@ -49,11 +63,7 @@ module Consyncful
     end
 
     def client
-      @client ||= begin
-        options = Consyncful.configuration.contentful_client_options
-        options.reverse_merge!(DEFAULT_CLIENT_OPTIONS)
-        Contentful::Client.new(options)
-      end
+      @client ||= Contentful::Client.new(Consyncful.configuration.client_options)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-24 00:00:00.000000000 Z
+date: 2023-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,7 +151,7 @@ dependencies:
         version: 7.0.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 9.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -161,7 +161,7 @@ dependencies:
         version: 7.0.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 9.0.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement