consyncful 0.6.2 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427a251dcb99af926beb09b1bd9c606319df5107c65954f152d007d5d3efc10c
-  data.tar.gz: d6774652c16586f99ed13a9683c5fa800fdd5e1535bb6c117d280f941d82a37f
+  metadata.gz: d2f62207463a8f75a74abef31265619b16425ef9b8cfa9cecc8935ab8fd74937
+  data.tar.gz: 5eca96bb788eb38855afa49cafaf5091eabbb5343f09828266f4f7e95cba3d29
 SHA512:
-  metadata.gz: d7d2852b4f286dc1b19557f1e59411c3d4a4f354f1e4466ff14596a425fb7cb1f1cb858ab0fb61229004884442adb6aef44661be150bb10f10f18782cc79bc52
-  data.tar.gz: 8011d57e5ac51fe2a2c287e57d9adcd747de95858074734135ebe4b0e05ffd6b1c16bd2dca1840886978ce5ae0925d7d1a28d15e5c1bc0c2c53a606760c8899c
+  metadata.gz: 2c9188b10e74d92bf2078e3227ecf7f189a749e088a5a64990f7f66fe0256eccc9628b07cb287ef78307f15287c2a7f57992688170b574e802fbc5f03b916508
+  data.tar.gz: a63b5e7ddca0cab2dc969b8a83b48ca66c4957b7641ddf7caa6be22e45733cb9bebb405187bb867280bd5149b2c2b2bd2e7399694df80fba39e1874979887dbd

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  ci_checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.7.5
+          - 3.0.3
+          - 3.1.1
+        mongodb:
+          - 4.2
+          - 4.4
+          - 5.0
+
+    name: Ruby ${{ matrix.ruby }} sample
+
+    steps:
+      - name: Checkout this repo
+        uses: actions/checkout@v2
+
+      - name: Install Ruby and Bundler
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.7.0
+        with:
+          mongodb-version: ${{ matrix.mongodb }}
+
+      - name: Run rubocop
+        run: |
+          bundle exec rubocop
+      - name: Run tests
+        run: |
+          bundle exec rspec

data/.rubocop.yml

@@ -1 +1,5 @@
 inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable

data/.rubocop_todo.yml

@@ -1,48 +1,50 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-01 10:54:42 +1300 using RuboCop version 0.79.0.
+# on 2022-05-03 22:33:33 UTC using RuboCop version 1.28.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
+# Offense count: 3
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'lib/consyncful/item_mapper.rb'
+    - 'spec/consyncful/base_spec.rb'
+    - 'spec/consyncful/persisted_item_spec.rb'
 
 # Offense count: 1
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 19
 
-# Offense count: 10
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Offense count: 12
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 175
+  Max: 220
 
 # Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle.
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/consyncful/railtie.rb'
     - 'spec/consyncful/base_spec.rb'
 
-# Offense count: 3
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/consyncful.rb'
-    - 'lib/consyncful/railtie.rb'
 
-# Offense count: 56
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 9
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
   Max: 226

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consyncful (0.6.2)
+    consyncful (0.7.2)
       contentful (>= 2.11.1, < 3.0.0)
       hooks (>= 0.4.1)
       mongoid (>= 7.0.2, < 8.0.0)
@@ -10,27 +10,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3.1)
-      activesupport (= 6.1.3.1)
-    activesupport (6.1.3.1)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    bson (4.12.0)
-    concurrent-ruby (1.1.8)
-    contentful (2.16.0)
+    ast (2.4.2)
+    bson (4.15.0)
+    concurrent-ruby (1.1.10)
+    contentful (2.16.3)
       http (> 0.8, < 5.0)
       multi_json (~> 1)
     database_cleaner (1.8.3)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.15.0)
+    ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -41,27 +40,29 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.4)
-    mongo (2.14.0)
+    minitest (5.16.2)
+    mongo (2.17.1)
       bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.2.2)
-      activemodel (>= 5.1, < 6.2)
+    mongoid (7.4.0)
+      activemodel (>= 5.1, < 7.1, != 7.0.0)
       mongo (>= 2.10.5, < 3.0.0)
+      ruby2_keywords (~> 0.0.5)
     multi_json (1.15.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (13.0.1)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -75,22 +76,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.28.2)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     uber (0.0.15)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.4.2)
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -101,7 +110,9 @@ DEPENDENCIES
   database_cleaner
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (= 0.79.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
-   2.1.4
+   2.3.7

data/README.md

@@ -1,4 +1,4 @@
-# Consyncful [![Build Status](https://travis-ci.org/boost/consyncful.svg?branch=master)](https://travis-ci.org/boost/consyncful)
+# Consyncful
 
 Contentful -> local database synchronisation for Rails
 
@@ -165,6 +165,39 @@ end
 
 If fields have multiple locales then the default locale will be mapped to the field name. Additional locales will have a suffix (lower snake case) on the field name. e.g title (default), title_mi_nz (New Zealand Maori mi-NZ)
 
+### Preserving Contentful timestamps
+
+If you need to access the timestamps from Contentful, you can enable it by setting `preserve_contentful_timestamps` to `true`.
+
+```rb
+Consyncful.configure do |config|
+  # Consyncful models will have two extra fields that contains the value of timestamps in Contentful.
+  # contentful_created_at
+  # contentful_updated_at
+  config.preserve_contentful_timestamps = true # defaults to false
+end
+```
+
+### Sync specific contents using [Contentful Tag](https://www.contentful.com/help/tags/).
+You can configure Consyncful to sync or ignore specific contents using Contentful Tag.
+
+```rb
+Consyncful.configure do |config|
+  # Any contents tagged with 'myTag' will be stored in the database. 
+  # Other contents without 'myTag' would be ignored.
+  config.content_tags = ['myTag'] # defaults to []
+end
+```
+
+Also, you can ignore contents with specific Tags.
+
+```rb
+Consyncful.configure do |config|
+  # Any contents tagged with 'ignoreTag' won't be stored in the database.
+  config.ignore_content_tags = ['ignoreTag'] # defaults to []
+end
+```
+
 ### Configuring what Mongo database Consyncful uses
 
 You can also configure what Mongoid client Consyncful uses and the name of the collection the entries are stored under. This is useful if you want to have your consyncful data hosted in a different mongo database than your application-specific mongo database.

data/consyncful.gemspec

@@ -5,14 +5,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'consyncful/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'consyncful'
-  spec.version       = Consyncful::VERSION
-  spec.authors       = ['Andy Anastasiadis-Gray', 'Montgomery Anderson', 'Greg Rogan']
-  spec.email         = ['andy@boost.co.nz', 'montgomery@boost.co.nz', 'greg@boost.co.nz']
+  spec.name                  = 'consyncful'
+  spec.version               = Consyncful::VERSION
+  spec.required_ruby_version = '>= 2.7'
+  spec.authors               = ['Andy Anastasiadis-Gray']
+  spec.email                 = ['andy@boost.co.nz']
 
-  spec.summary       = 'Contentful to local database synchronisation for Rails'
-  spec.homepage      = 'https://github.com/boost/consyncful'
-  spec.license       = 'MIT'
+  spec.summary  = 'Contentful to local database synchronisation for Rails'
+  spec.homepage = 'https://github.com/boost/consyncful'
+  spec.license  = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -23,7 +24,7 @@ Gem::Specification.new do |spec|
   #     "public gem pushes."
   # end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = 'exe'
@@ -34,10 +35,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.79.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
 
   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 'rainbow'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/consyncful/item_mapper.rb

@@ -13,6 +13,13 @@ module Consyncful
       @item.is_a?(Contentful::DeletedEntry) || @item.is_a?(Contentful::DeletedAsset)
     end
 
+    def excluded_by_tag?
+      return (Consyncful.configuration.content_tags & item_tag_ids).empty?      if Consyncful.configuration.content_tags.any?
+      return (Consyncful.configuration.ignore_content_tags & item_tag_ids).any? if Consyncful.configuration.ignore_content_tags.any?
+
+      false
+    end
+
     def type
       case @item.type
       when 'Entry' then @item.content_type.id
@@ -29,18 +36,27 @@ module Consyncful
 
       fields.merge!(localized_fields(default_locale))
       fields.merge!(localized_asset_fields(default_locale)) if type == 'asset'
+      fields.merge!(contentful_timestamps) if Consyncful.configuration.preserve_contentful_timestamps
 
       fields
     end
 
     private
 
+    def item_tag_ids
+      return [] if @item.nil?
+
+      @item._metadata[:tags].map(&:id)
+    end
+
     def generic_fields
-      { created_at: @item.created_at,
+      {
+        created_at: @item.created_at,
         updated_at: @item.updated_at,
         revision: @item.revision,
         contentful_type: type,
-        synced_at: Time.current }
+        synced_at: Time.current
+      }
     end
 
     def localized_fields(default_locale)
@@ -94,11 +110,18 @@ module Consyncful
       if single_reference?(value)
         [ActiveSupport::Inflector.foreign_key(field).to_sym, value.id]
       elsif many_reference?(value)
-        ids_field_name = field.to_s.singularize + '_ids' # fk field name
+        ids_field_name = "#{field.to_s.singularize}_ids" # fk field name
         [ids_field_name.to_sym, value.map(&:id)]
       else
         [field, value]
       end
     end
+
+    def contentful_timestamps
+      {
+        contentful_created_at: @item.created_at,
+        contentful_updated_at: @item.updated_at
+      }
+    end
   end
 end

data/lib/consyncful/persisted_item.rb

@@ -15,7 +15,8 @@ module Consyncful
 
     def persist
       puts Rainbow("syncing: #{@item.id}").yellow
-      if @item.deletion?
+
+      if @item.deletion? || @item.excluded_by_tag?
         delete_model(@item.id, @stats)
       else
         create_or_update_model(@item, @sync_id, @stats)

data/lib/consyncful/sync.rb

@@ -102,10 +102,11 @@ module Consyncful
       ids
     end
 
-    def sync_item(item, stats)
-      puts Rainbow("syncing: #{item.id}").yellow
-      PersistedItem.new(item, id, stats).persist
-      item.id
+    def sync_item(item_mapper, stats)
+      puts Rainbow("syncing: #{item_mapper.id}").yellow
+      PersistedItem.new(item_mapper, id, stats).persist
+
+      item_mapper.id
     end
   end
 end

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.6.2'
+  VERSION = '0.7.2'
 end

data/lib/consyncful.rb

@@ -13,8 +13,13 @@ require 'consyncful/railtie' if defined?(Rails)
 module Consyncful
   # Handles Rails configurations for Consynful
   class Configuration
-    attr_accessor :contentful_client_options, :locale,
-                  :mongo_client, :mongo_collection
+    attr_accessor :contentful_client_options,
+                  :locale,
+                  :mongo_client,
+                  :mongo_collection,
+                  :content_tags,
+                  :ignore_content_tags,
+                  :preserve_contentful_timestamps
 
     def initialize
       @contentful_client_options = {
@@ -23,6 +28,9 @@ module Consyncful
       @locale = 'en-NZ'
       @mongo_client = :default
       @mongo_collection = 'contentful_models'
+      @content_tags = []
+      @ignore_content_tags = []
+      @preserve_contentful_timestamps = false
     end
   end
 

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consyncful
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.2
 platform: ruby
 authors:
 - Andy Anastasiadis-Gray
-- Montgomery Anderson
-- Greg Rogan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,16 +70,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: contentful
   requirement: !ruby/object:Gem::Requirement
@@ -153,18 +179,16 @@ dependencies:
 description:
 email:
 - andy@boost.co.nz
-- montgomery@boost.co.nz
-- greg@boost.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -187,7 +211,8 @@ files:
 homepage: https://github.com/boost/consyncful
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -196,14 +221,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Contentful to local database synchronisation for Rails

data/.travis.yml

@@ -1,14 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-  - 2.6.5
-before_install: gem install bundler -v 2.1.4
-services:
-  - mongodb
-
-script:
-  - bundle exec rake spec
-  - bundle exec rubocop -P