wcc-contentful 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5599a00c953fc7b5692bc3f3c5b235d621c2d65bb1965e30a5ef89db3006a1c8
-  data.tar.gz: 40731523f1a793e1c85159977e0f3235588fadf82fa2d5b4733f586f33a812fe
+  metadata.gz: d67d393afd50ea2c1ab321eea762d18111df439d4058f4cdf2281d43418b9b86
+  data.tar.gz: 64b7149e4a25410576287ea71692bccb23878e7c9b12b3b013cdaf08f4d1c79c
 SHA512:
-  metadata.gz: 22ee7a27c1000436dbf3ba622ef1ce412ca62d67bd67e2db0a0cc707a6e85f8e1a62a719729bba7385d8020295ae460779e0e0cc4be7bcac35bea90b855c7baf
-  data.tar.gz: cee9e57b7f192501d5cfe46338a34a8db64be596e7ab64872495eab6ad33408439d024a8ad9a60f9754487b460eae9cb31ea26c908c40fd828d87289443e9170
+  metadata.gz: 8458a30bd45a736ce11777e43c1376c887515f2870db10511cffd4361675506fa723fc400e280b68f19c0fb74d340c452c3a055ecf06032424337c2f14425dd7
+  data.tar.gz: 27b2af13bfad415a2f385fb1d641178ea5496e1e9080ae21071807cc3a3c662422675f6943422b9e7824b87f0eca1a8e4c4c64743a898e732637ecebf23345ab

data/README.md

@@ -74,10 +74,14 @@ We have successfully created caching layers using Memcached, Postgres, and an in
 
 ### Better Rails Integration
 
-When we initially got started with the Contentful ruby models, we encountered one problem that was more frustrating than all others: If a field exists in the content model, but the particular entry we're working with does not have that field populated, then accessing that field raised a `NoMethodError`.  This caused us to litter our code with `if defined?(entry.my_field)` which is bad practice.  (Note: this has since been fixed in contentful.rb v2).
+When we initially got started with the Contentful ruby models, we encountered one problem that was more frustrating than all others: If a field exists in the content model, but the particular entry we're working with does not have that field populated, then accessing that field raised a `NoMethodError`.  This caused us to litter our code with `if defined?(entry.my_field)` which is bad practice.  
 
 We decided it was better to not rely on `method_missing?` (what contentful.rb does), and instead to use `define_method` in an initializer to generate the methods for our models.  This has the advantage that calling `.instance_methods` on a model class includes all the fields present in the content model.
 
+Note: it appears that [contentful_rb has added an opt-in configuration to return `nil`](https://github.com/contentful/contentful_model#returning-nil-for-fields-which-arent-defined).
+instead of raising `NoMethodError. We think this should be the default setting,
+rather than being opt-in.
+
 We also took advantage of Rails' naming conventions to automatically infer the content type name based on the class name.  Thus in our code, we have `app/models/page.rb` which defines `class Page << WCC::Contentful::Model::Page`, and is automatically linked to the `page` content type ID.  (Note: this is overridable on a per-model basis)
 
 All our models are automatically generated at startup which improves response times at the expense of initialization time.  In addition, our content model registry allows easy definition of custom models in your `app/models` directory to override fields.  This plays nice with other gems like algoliasearch-rails, which allows you to declaratively manage your Algolia indexes.  Another example from our flagship watermark.org:

data/lib/wcc/contentful/engine.rb

@@ -2,36 +2,38 @@
 
 module WCC::Contentful
   class Engine < ::Rails::Engine
-    initializer 'enable webhook' do
-      config = WCC::Contentful.configuration
+    initializer 'enable webhook' do |app|
+      app.config.to_prepare do
+        config = WCC::Contentful.configuration
 
-      jobs = []
-      jobs << WCC::Contentful::SyncEngine::Job if WCC::Contentful::Services.instance.sync_engine&.should_sync?
-      jobs.push(*WCC::Contentful.configuration.webhook_jobs)
+        jobs = []
+        jobs << WCC::Contentful::SyncEngine::Job if WCC::Contentful::Services.instance.sync_engine&.should_sync?
+        jobs.push(*WCC::Contentful.configuration.webhook_jobs)
 
-      jobs.each do |job|
-        WCC::Contentful::WebhookController.subscribe(
-          ->(event) do
-            begin
-              if job.respond_to?(:perform_later)
-                job.perform_later(event.to_h)
-              else
-                Rails.logger.error "Misconfigured webhook job: #{job} does not respond to " \
-                                   ':perform_later'
+        jobs.each do |job|
+          WCC::Contentful::WebhookController.subscribe(
+            ->(event) do
+              begin
+                if job.respond_to?(:perform_later)
+                  job.perform_later(event.to_h)
+                else
+                  Rails.logger.error "Misconfigured webhook job: #{job} does not respond to " \
+                                     ':perform_later'
+                end
+              rescue StandardError => e
+                warn "Error in job #{job}: #{e}"
+                Rails.logger.error "Error in job #{job}: #{e}"
               end
-            rescue StandardError => e
-              warn "Error in job #{job}: #{e}"
-              Rails.logger.error "Error in job #{job}: #{e}"
-            end
-          end,
-          with: :call
-        )
-      end
+            end,
+            with: :call
+          )
+        end
 
-      next unless config&.management_token.present?
-      next unless config.app_url.present?
+        next unless config&.management_token.present?
+        next unless config.app_url.present?
 
-      WebhookEnableJob.set(wait: 10.seconds).perform_later if Rails.env.production?
+        WebhookEnableJob.set(wait: 10.seconds).perform_later if Rails.env.production?
+      end
     end
 
     config.generators do |g|

data/lib/wcc/contentful/test/double.rb

@@ -48,8 +48,8 @@ module WCC::Contentful::Test::Double
         },
         id: SecureRandom.urlsafe_base64,
         type: 'Asset',
-        createdAt: Time.now.to_s(:iso8601),
-        updatedAt: Time.now.to_s(:iso8601),
+        createdAt: Time.now.to_formatted_s(:iso8601),
+        updatedAt: Time.now.to_formatted_s(:iso8601),
         environment: {
           sys: {
             id: 'master',

data/lib/wcc/contentful/test/factory.rb

@@ -62,8 +62,8 @@ module WCC::Contentful::Test::Factory
       },
       id: id || SecureRandom.urlsafe_base64,
       type: 'Entry',
-      createdAt: Time.now.to_s(:iso8601),
-      updatedAt: Time.now.to_s(:iso8601),
+      createdAt: Time.now.to_formatted_s(:iso8601),
+      updatedAt: Time.now.to_formatted_s(:iso8601),
       environment: {
         sys: {
           id: 'master',

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '1.5.1'
+    VERSION = '1.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Watermark Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -499,7 +499,7 @@ homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.5/wcc-contentful
+  documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.6/wcc-contentful
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -516,7 +516,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://rubygems.org/gems/wcc-contentful)
@@ -576,14 +576,16 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   models, we encountered one problem that was more frustrating than all others: If
   a field exists in the content model, but the particular entry we''re working with
   does not have that field populated, then accessing that field raised a `NoMethodError`.  This
-  caused us to litter our code with `if defined?(entry.my_field)` which is bad practice.  (Note:
-  this has since been fixed in contentful.rb v2).  We decided it was better to not
-  rely on `method_missing?` (what contentful.rb does), and instead to use `define_method`
-  in an initializer to generate the methods for our models.  This has the advantage
-  that calling `.instance_methods` on a model class includes all the fields present
-  in the content model.  We also took advantage of Rails'' naming conventions to automatically
-  infer the content type name based on the class name.  Thus in our code, we have
-  `app/models/page.rb` which defines `class Page << WCC::Contentful::Model::Page`,
+  caused us to litter our code with `if defined?(entry.my_field)` which is bad practice.    We
+  decided it was better to not rely on `method_missing?` (what contentful.rb does),
+  and instead to use `define_method` in an initializer to generate the methods for
+  our models.  This has the advantage that calling `.instance_methods` on a model
+  class includes all the fields present in the content model.  Note: it appears that
+  [contentful_rb has added an opt-in configuration to return `nil`](https://github.com/contentful/contentful_model#returning-nil-for-fields-which-arent-defined).
+  instead of raising `NoMethodError. We think this should be the default setting,
+  rather than being opt-in.  We also took advantage of Rails'' naming conventions
+  to automatically infer the content type name based on the class name.  Thus in our
+  code, we have `app/models/page.rb` which defines `class Page << WCC::Contentful::Model::Page`,
   and is automatically linked to the `page` content type ID.  (Note: this is overridable
   on a per-model basis)  All our models are automatically generated at startup which
   improves response times at the expense of initialization time.  In addition, our