wcc-contentful 1.2.0 → 1.3.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Watermark Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -136,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.68'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.68'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -466,7 +452,9 @@ files:
 - lib/wcc/contentful/rspec.rb
 - lib/wcc/contentful/services.rb
 - lib/wcc/contentful/simple_client.rb
+- lib/wcc/contentful/simple_client/cdn.rb
 - lib/wcc/contentful/simple_client/management.rb
+- lib/wcc/contentful/simple_client/preview.rb
 - lib/wcc/contentful/simple_client/response.rb
 - lib/wcc/contentful/simple_client/typhoeus_adapter.rb
 - lib/wcc/contentful/store.rb
@@ -503,7 +491,8 @@ homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.2/wcc-contentful
+  documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.3/wcc-contentful
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -512,7 +501,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -777,14 +766,19 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   step.  However the gem is also capable of connecting to multiple spaces within the
   same ruby process!  You just have to create and initialize a namespace.  The {WCC::Contentful::ModelAPI}
   concern makes this straightforward.  Start by creating your Namespace and including
-  the concern: ```ruby # app/models/my_second_space.rb class MySecondSpace include
-  WCC::Contentful::ModelAPI end  # app/models/other_page.rb class OtherPage < MySecondSpace::Page
-  end ```  Then configure it in an initializer: ```ruby # config/initializers/my_second_space.rb
+  the concern: ```ruby # lib/my_second_space.rb  # Note: This class must be in the
+  "lib" folder in :zeitwerk mode, otherwise Rails 6+ will unload all your constants
+  # that were created in the initializer.  Your models which subclass this namespace
+  may reside in the app/models directory. class MySecondSpace include WCC::Contentful::ModelAPI
+  end  # app/models/other_page.rb class OtherPage < MySecondSpace::Page end ```  Then
+  configure it in an initializer: ```ruby # config/initializers/my_second_space.rb
   MySecondSpace.configure do |config| # Make sure to point to a different schema file
   from your first space! config.schema_file = Rails.root.join(''db/second-contentful-schema.json'')  config.access_token
   = ENV[''SECOND_CONTENTFUL_ACCESS_TOKEN''] config.preview_token = ENV[''SECOND_CONTENTFUL_PREVIEW_ACCESS_TOKEN'']
   config.space = ENV[''SECOND_CONTENTFUL_SPACE_ID''] config.environment = ENV[''CONTENTFUL_ENVIRONMENT'']
-  end ```  Finally, use it: ```ruby OtherPage.find(''1234'') # GET https://cdn.contentful.com/spaces/other-space/environments/other-env/entries/1234
+  end  # Ensure that models are reloaded in Rails development mode Rails.application.config.to_prepare
+  do MySecondSpace.reload! end ```  Finally, use it: ```ruby OtherPage.find(''1234'')
+  # GET https://cdn.contentful.com/spaces/other-space/environments/other-env/entries/1234
   # => #<OtherPage:0x0000000005c71a78 @created_at=2018-04-16 18:41:17 UTC...>  Page.find(''1234'')
   # GET https://cdn.contentful.com/spaces/first-space/environments/first-env/entries/1234
   # => #<Page:0x0000000001271b70 @created_at=2018-04-15 12:02:14 UTC...> ```  The
@@ -794,14 +788,27 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   preview_client = MySecondSpace.services.preview_client # => #<WCC::Contentful::SimpleClient::Preview:0x00007f888ccafa00
   sync_engine = MySecondSpace.services.sync_engine # => #<WCC::Contentful::SyncEngine:0x00007f88960b6b40
   ``` Note that the above services are not accessible on {WCC::Contentful::Services.instance}
-  or via the {WCC::Contentful::ServiceAccessors}.  ### Using a sync store with a second
-  space  If you use something other than the CDNAdapter with your second space, you
-  will need to find a way to trigger `MySecondSpace.services.sync_engine.next` to
-  keep it up-to-date.  The {WCC::Contentful::Engine} will only manage the global SyncEngine
-  configured by the global {WCC::Contentful.configure}.  The easiest way to do this
-  is to set up your own Rails route to respond to Contentful webhooks and then configure
-  the second Contentful space to send webhooks to this route. You could also do this
-  by triggering it periodically in a background job using Sidekiq and [sidekiq-scheduler](https://github.com/Moove-it/sidekiq-scheduler).  ##
+  or via the {WCC::Contentful::ServiceAccessors}.  #### Important Note when using
+  Zeitwerk with Rails 6+ When using Rails >= 6 with `config.autoloader = :zeitwerk`,
+  Rails will remove any models defined in `app/models` after initialization and then
+  load them again when they are referenced.  If you `include WCC::Contentful::ModelAPI`
+  in a class defined inside the `app` directory, this will have the effect of deleting
+  all configuration that was set in the initializer as well as the constants generated
+  from your schema. This will result in one of two errors:  * `NameError (uninitialized
+  constant MySecondSpace::MyContentType)`   if you try to reference a subclass such
+  as `MyContentType < MySecondSpace::MyContentType` * `ArgumentError (Not yet configured!)`
+  if you try to `MySecondSpace.find(''xxxx'')` to load an Entry or Asset  The solution
+  is to have your secondary namespace in a folder which is not in the `autoload_paths`.
+  We suggest using `lib`, which will work so long as you have not added the `lib`
+  folder to the `autoload_paths` as some uninformed StackOverflow answers suggest
+  you do.  ### Using a sync store with a second space  If you use something other
+  than the CDNAdapter with your second space, you will need to find a way to trigger
+  `MySecondSpace.services.sync_engine.next` to keep it up-to-date.  The {WCC::Contentful::Engine}
+  will only manage the global SyncEngine configured by the global {WCC::Contentful.configure}.  The
+  easiest way to do this is to set up your own Rails route to respond to Contentful
+  webhooks and then configure the second Contentful space to send webhooks to this
+  route. You could also do this by triggering it periodically in a background job
+  using Sidekiq and [sidekiq-scheduler](https://github.com/Moove-it/sidekiq-scheduler).  ##
   Development  After checking out the repo, run `bin/setup` to install dependencies.
   Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for
   an interactive prompt that will allow you to experiment.  ## Contributing  Bug reports