consyncful 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c882690a75c66e0d0045caf2c574e04c6eb1c86160f767db1d5d1ef309cffc22
-  data.tar.gz: 8223e7a016e55b6ee64b80bb0979eaa4f646d84dbcfb157fdd3fffe2ff30822e
+  metadata.gz: 39ad7cde060eb4740f59d3d630116456e4ca766a288e69589da90d16d501688b
+  data.tar.gz: e1498ad860cae54c4a7779979d0ec501dec1df99d3e1f1b8942c710c2a014520
 SHA512:
-  metadata.gz: 1883a3eba634425d4579d734046e2f44e2bd1798ee4c0ff7e0b4d911df3afb40760aa29bfb78cf1ba770fcf7f1b84a76833e1925a31c50c1e3c108462731f5dc
-  data.tar.gz: da8df93ab4487b5ffb8d626781338a623a988d568b3d0445b357e44adeb5021c8bcbe3c7a14daec9e0c0f37cd5626ee172986d420f7ea28b5ef4d872deb07722
+  metadata.gz: 447015c1e208ef8f8d70b4e6d5f0c006fbbc762bc88b90be3bc73ab39c10eb94e6ce0babd86cee7fc509e3664edc14ebb796c443536f58018a1a2358120c913f
+  data.tar.gz: 8f4a2561961ebe86546b3c3b9760107c3b90ddab8958a872940323f889928a89219315c6e41ced013a33374b352b66b3c0d275539c442549e77f6206ea3bb3a5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consyncful (0.7.1)
+    consyncful (0.7.3)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
@@ -10,15 +10,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3)
-      activesupport (= 7.0.3)
-    activesupport (7.0.3)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
       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)
@@ -45,12 +45,12 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.10.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.16.3)
+    mongo (2.18.1)
+      bson (>= 4.14.1, < 5.0.0)
+    mongoid (7.5.1)
       activemodel (>= 5.1, < 7.1, != 7.0.0)
       mongo (>= 2.10.5, < 3.0.0)
       ruby2_keywords (~> 0.0.5)
@@ -58,7 +58,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.7)
+    public_suffix (5.0.0)
     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.5)
       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/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/tasks/consyncful.rake

@@ -10,6 +10,11 @@ namespace :consyncful do
   end
 
   task :sync, [:seconds] => %i[environment update_model_names] do |_task, args|
+    Signal.trap('TERM') do
+      puts Rainbow("Graceful shutdown PID=#{Process.pid}").red
+      exit 0
+    end
+
     seconds = args[:seconds].to_i
     seconds = 15 if seconds.zero?
     loop do

data/lib/consyncful/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consyncful
-  VERSION = '0.7.1'
+  VERSION = '0.7.3'
 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.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler