wcc-contentful 0.3.0.pre.rc3 → 1.0.0.pre.rc1

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.rc3
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
 - Watermark Dev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: erb_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.26
 - !ruby/object:Gem::Dependency
   name: httplog
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +108,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-instrumentation-matcher
+  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: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -109,117 +193,145 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: wisper-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: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: guard-shell
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
-  name: contentful
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
-  name: contentful-management
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: graphql
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -283,33 +395,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: dry-validation
+  name: wcc-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
-  name: wcc-base
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 2.0.0
 description: Contentful API wrapper library exposing an ActiveRecord-like interface
 email:
 - dev@watermark.org
@@ -318,11 +430,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- Gemfile
+- Guardfile
 - README.md
 - app/controllers/wcc/contentful/application_controller.rb
 - app/controllers/wcc/contentful/webhook_controller.rb
-- app/jobs/wcc/contentful/delayed_sync_job.rb
 - app/jobs/wcc/contentful/webhook_enable_job.rb
 - bin/console
 - bin/rails
@@ -330,42 +441,67 @@ files:
 - bin/setup
 - config/initializers/mime_types.rb
 - config/routes.rb
+- doc/wcc-contentful.png
+- lib/tasks/download_schema.rake
 - lib/wcc/contentful.rb
-- lib/wcc/contentful/client_ext.rb
+- lib/wcc/contentful/active_record_shim.rb
 - lib/wcc/contentful/configuration.rb
 - lib/wcc/contentful/content_type_indexer.rb
+- lib/wcc/contentful/downloads_schema.rb
 - lib/wcc/contentful/engine.rb
+- lib/wcc/contentful/event.rb
+- lib/wcc/contentful/events.rb
 - lib/wcc/contentful/exceptions.rb
-- lib/wcc/contentful/graphql.rb
-- lib/wcc/contentful/graphql/builder.rb
-- lib/wcc/contentful/graphql/types.rb
 - lib/wcc/contentful/helpers.rb
 - lib/wcc/contentful/indexed_representation.rb
+- lib/wcc/contentful/instrumentation.rb
+- lib/wcc/contentful/link.rb
+- lib/wcc/contentful/link_visitor.rb
+- lib/wcc/contentful/middleware.rb
+- lib/wcc/contentful/middleware/store.rb
+- lib/wcc/contentful/middleware/store/caching_middleware.rb
 - lib/wcc/contentful/model.rb
 - lib/wcc/contentful/model_builder.rb
 - lib/wcc/contentful/model_methods.rb
 - lib/wcc/contentful/model_singleton_methods.rb
 - lib/wcc/contentful/rails.rb
+- lib/wcc/contentful/rake.rb
+- lib/wcc/contentful/rspec.rb
 - lib/wcc/contentful/services.rb
 - lib/wcc/contentful/simple_client.rb
-- lib/wcc/contentful/simple_client/http_adapter.rb
 - lib/wcc/contentful/simple_client/management.rb
 - lib/wcc/contentful/simple_client/response.rb
 - lib/wcc/contentful/simple_client/typhoeus_adapter.rb
 - lib/wcc/contentful/store.rb
+- lib/wcc/contentful/store/README.md
 - lib/wcc/contentful/store/base.rb
 - lib/wcc/contentful/store/cdn_adapter.rb
-- lib/wcc/contentful/store/lazy_cache_store.rb
+- lib/wcc/contentful/store/factory.rb
+- lib/wcc/contentful/store/instrumentation.rb
+- lib/wcc/contentful/store/interface.rb
 - lib/wcc/contentful/store/memory_store.rb
 - lib/wcc/contentful/store/postgres_store.rb
+- lib/wcc/contentful/store/postgres_store/schema_1.sql
+- lib/wcc/contentful/store/postgres_store/schema_2.sql
+- lib/wcc/contentful/store/query.rb
+- lib/wcc/contentful/store/query/interface.rb
+- lib/wcc/contentful/store/rspec_examples.rb
+- lib/wcc/contentful/store/rspec_examples/basic_store.rb
+- lib/wcc/contentful/store/rspec_examples/include_param.rb
+- lib/wcc/contentful/store/rspec_examples/nested_queries.rb
+- lib/wcc/contentful/sync_engine.rb
 - lib/wcc/contentful/sys.rb
+- lib/wcc/contentful/test.rb
+- lib/wcc/contentful/test/attributes.rb
+- lib/wcc/contentful/test/double.rb
+- lib/wcc/contentful/test/factory.rb
 - lib/wcc/contentful/version.rb
 - wcc-contentful.gemspec
 homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -380,30 +516,33 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
-summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://badge.fury.io/rb/wcc-contentful)
-  [![CircleCI](https://circleci.com/gh/watermarkchurch/wcc-contentful.svg?style=svg)](https://circleci.com/gh/watermarkchurch/wcc-contentful)  Full
-  documentation: https://www.rubydoc.info/github/watermarkchurch/wcc-contentful  #
-  WCC::Contentful  ## Installation  Add this line to your application''s Gemfile:  ```ruby
-  gem ''wcc-contentful'', require: ''wcc/contentful/rails'' ```  And then execute:  $
-  bundle  Or install it yourself as:  $ gem install wcc-contentful  ## Configure  ```ruby
-  WCC::Contentful.configure do |config| config.access_token = <CONTENTFUL_ACCESS_TOKEN>
-  config.space = <CONTENTFUL_SPACE_ID> end  WCC::Contentful.init! ```  ## Usage  ###
-  WCC::Contentful::Model API  The WCC::Contentful::Model API exposes Contentful data
-  as a set of dynamically generated Ruby objects.  These objects are based on the
-  content types in your Contentful space.  All these objects are generated by WCC::Contentful.init!  The
-  following examples show how to use this API to find entries of the `page` content
-  type:  ```ruby # Find objects by id WCC::Contentful::Model::Page.find(''1E2ucWSdacxxf233sfa3'')
-  # => #<WCC::Contentful::Model::Page:0x0000000005c71a78 @created_at=2018-04-16 18:41:17
-  UTC...>  # Find objects by field WCC::Contentful::Model::Page.find_by(slug: ''/some-slug'')
-  # => #<WCC::Contentful::Model::Page:0x0000000005c71a78 @created_at=2018-04-16 18:41:17
-  UTC...>  # Use operators to filter by a field # must use full notation for sys attributes
-  (except ID) WCC::Contentful::Model::Page.find_all(''sys.created_at'' => { lte: Date.today
-  }) # => [#<WCC::Contentful::Model::Page:0x0000000005c71a78 @created_at=2018-04-16
-  18:41:17 UTC...>, ... ]  # Nest queries to mimick joins WCC::Contentful::Model::Page.find_by(subpages:
+summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://rubygems.org/gems/wcc-contentful)
+  [![Build Status](https://travis-ci.org/watermarkchurch/wcc-contentful.svg?branch=master)](https://travis-ci.org/watermarkchurch/wcc-contentful)
+  [![Coverage Status](https://coveralls.io/repos/github/watermarkchurch/wcc-contentful/badge.svg?branch=master)](https://coveralls.io/github/watermarkchurch/wcc-contentful?branch=master)  Full
+  documentation: https://www.rubydoc.info/gems/wcc-contentful  # WCC::Contentful  ##
+  Installation  Add this line to your application''s Gemfile:  ```ruby gem ''wcc-contentful'',
+  require: ''wcc/contentful/rails'' ```  If you''re not using rails, exclude the `require:`
+  parameter.  ```ruby gem ''wcc-contentful'' ```  And then execute: ``` $ bundle ```
+  Or install it yourself as: ``` $ gem install wcc-contentful ```  ## Configure  Put
+  this in an initializer: ```ruby # config/initializers/wcc_contentful.rb WCC::Contentful.configure
+  do |config| config.access_token = <CONTENTFUL_ACCESS_TOKEN> config.space = <CONTENTFUL_SPACE_ID>
+  end  WCC::Contentful.init! ```  All configuration options can be found [in the rubydoc](https://www.rubydoc.info/gems/wcc-contentful/WCC/Contentful/Configuration)
+  under {WCC::Contentful::Configuration}  ## Usage  ### WCC::Contentful::Model API  The
+  WCC::Contentful::Model API exposes Contentful data as a set of dynamically generated
+  Ruby objects.  These objects are based on the content types in your Contentful space.  All
+  these objects are generated by `WCC::Contentful.init!`  The following examples show
+  how to use this API to find entries of the `page` content type:  ```ruby # Find
+  objects by id WCC::Contentful::Model::Page.find(''1E2ucWSdacxxf233sfa3'') # => #<WCC::Contentful::Model::Page:0x0000000005c71a78
+  @created_at=2018-04-16 18:41:17 UTC...>  # Find objects by field WCC::Contentful::Model::Page.find_by(slug:
+  ''/some-slug'') # => #<WCC::Contentful::Model::Page:0x0000000005c71a78 @created_at=2018-04-16
+  18:41:17 UTC...>  # Use operators to filter by a field # must use full notation
+  for sys attributes (except ID) WCC::Contentful::Model::Page.find_all(''sys.created_at''
+  => { lte: Date.today }) # => [#<WCC::Contentful::Model::Page:0x0000000005c71a78
+  @created_at=2018-04-16 18:41:17 UTC...>, ... ]  # Nest queries to mimick joins WCC::Contentful::Model::Page.find_by(subpages:
   { slug: ''/some-slug'' }) # => #<WCC::Contentful::Model::Page:0x0000000005c71a78
   @created_at=2018-04-16 18:41:17 UTC...>  # Pass the preview flag to use the preview
   client (must have set preview_token config param) preview_redirect = WCC::Contentful::Model::Redirect.find_by({
@@ -436,32 +575,72 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   #   {"sys"=> ...} #  "6Fwukxxkxa6qQCC04WCaqg"=> #   {"sys"=> ...} #   ...} ```  The
   client handles Paging automatically within the lazy iterator returned by #items.
   This lazy iterator does not respect the `limit` param - that param is only passed
-  through to the API to set the page size.  Entries included via the `include` parameter
-  are made available on the #includes field.  This is a hash of `<entry ID> => <raw
-  entry>` and makes it easy to grab links.  This hash is added to lazily as you enumerate
-  the pages.  See the {WCC::Contentful::SimpleClient} documentation for more details.  ###
-  Accessing the APIs within application code  The Model API is best exposed by defining
-  your own model classes in the `app/models` directory which inherit from the WCC::Contentful
-  models.  ```ruby # app/models/page.rb class Page < WCC::Contentful::Model::Page  #
-  You can add additional methods here end  # app/controllers/pages_controller.rb class
-  PagesController < ApplicationController def show @page = Page.find_by(slug: params[:slug])
-  raise Exceptions::PageNotFoundError, params[:slug] unless @page end end ```  The
-  {WCC::Contentful::Services} singleton gives access to the other configured services.
-  You can also include the {WCC::Contentful::ServiceAccessors} concern to define these
-  services as attributes in a class.  ```ruby class MyJob < ApplicationJob include
-  WCC::Contentful::ServiceAccessors  def perform Page.find(...)  store.find(...)  client.entries(...)
-  end end ```  ## Development  After checking out the repo, run `bin/setup` to install
-  dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console`
-  for an interactive prompt that will allow you to experiment.  To install this gem
-  onto your local machine, run `bundle exec rake install`. To release a new version,
-  update the version number in `version.rb`, and then run `bundle exec rake release`,
-  which will create a git tag for the version, push git commits and tags, and push
-  the `.gem` file to [rubygems.org](https://rubygems.org).  ## Contributing  Bug reports
-  and pull requests are welcome on GitHub at https://github.com/watermarkchurch/wcc-contentful.
-  This project is intended to be a safe, welcoming space for collaboration, and contributors
-  are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org)
-  code of conduct.  ## License  The gem is available as open source under the terms
-  of the [MIT License](http://opensource.org/licenses/MIT).  ## Code of Conduct  Everyone
+  through to the API to set the page size.  If you truly want a limited subset of
+  response items, use [`response.items.take(n)`](https://ruby-doc.org/core-2.5.3/Enumerable.html#method-i-take)  Entries
+  included via the `include` parameter are made available on the #includes field.  This
+  is a hash of `<entry ID> => <raw entry>` and makes it easy to grab links.  This
+  hash is added to lazily as you enumerate the pages.  See the {WCC::Contentful::SimpleClient}
+  documentation for more details.  ### Accessing the APIs within application code  The
+  Model API is best exposed by defining your own model classes in the `app/models`
+  directory which inherit from the WCC::Contentful models.  ```ruby # app/models/page.rb
+  class Page < WCC::Contentful::Model::Page  # You can add additional methods here
+  end  # app/controllers/pages_controller.rb class PagesController < ApplicationController
+  def show @page = Page.find_by(slug: params[:slug]) raise Exceptions::PageNotFoundError,
+  params[:slug] unless @page end end ```  The {WCC::Contentful::Services} singleton
+  gives access to the other configured services. You can also include the {WCC::Contentful::ServiceAccessors}
+  concern to define these services as attributes in a class.  ```ruby class MyJob
+  < ApplicationJob include WCC::Contentful::ServiceAccessors  def perform Page.find(...)  store.find(...)  client.entries(...)
+  end end ```  ## Architecture  ![wcc-contentful diagram](./doc/wcc-contentful.png)  ##
+  Test Helpers  To use the test helpers, include the following in your rails_helper.rb:  ```ruby
+  require ''wcc/contentful/rspec'' ```  This adds the following helpers to all your
+  specs:  ```ruby ## # Builds a in-memory instance of the Contentful model for the
+  given content_type. # All attributes that are known to be required fields on the
+  content type # will return a default value based on the field type. instance = contentful_create(''my-content-type'',
+  my_field: ''some-value'') # => #<WCC::Contentful::Model::MyContentType:0x0000000005c71a78
+  @created_at=2018-04-16 18:41:17 UTC...>  instance.my_field # => "some-value"  instance.other_required_field
+  # => "default-value"  instance.other_optional_field # => nil  instance.not_a_field
+  # NoMethodError: undefined method `not_a_field'' for #<MyContentType:0x00007fbac81ee490>  ##
+  # Builds a rspec double of the Contentful model for the given content_type. # All
+  attributes that are known to be required fields on the content type # will return
+  a default value based on the field type. dbl = contentful_double(''my-content-type'',
+  my_field: ''other-value'') # => #<Double (anonymous)>  dbl.my_field # => "other-value"  dbl.other_optional_field
+  # => nil  dbl.not_a_field # => #<Double (anonymous)> received unexpected message
+  :not_a_field with (no args)  ## # Builds out a fake Contentful entry for the given
+  content type, and then # stubs the Model API to return that content type for `.find`
+  and `.find_by` # query methods. stubbed = contentful_stub(''my-content-type'', id:
+  ''1234'', my_field: ''test'')  WCC::Contentful::Model.find(''1234'') == stubbed
+  # => true  MyContentType.find(''1234'') == stubbed # => true  MyContentType.find_by(my_field:
+  ''test'') == stubbed # => true ```  ## Advanced Configuration Example  Here''s an
+  example containing all the configuration options, and a sample setup for automatic
+  deployment to Heroku.  This is intended to make you aware of what is possible, and
+  not as a general recommendation of what your setup should look like.  ```ruby #
+  config/initializers/wcc_contentful.rb WCC::Contentful.configure do |config| config.access_token
+  = ENV[''CONTENTFUL_ACCESS_TOKEN''] config.space = ENV[''CONTENTFUL_SPACE_ID''] config.environment
+  = ENV[''CONTENTFUL_ENVIRONMENT''] config.preview_token = ENV[''CONTENTFUL_PREVIEW_ACCESS_TOKEN'']  #
+  You may or may not want to provide this to your production server... config.management_token
+  = ENV[''CONTENTFUL_MANAGEMENT_TOKEN''] unless Rails.env.production?  config.app_url
+  = "https://#{ENV[''HOSTNAME'']}" config.webhook_username = ''my-app-webhook'' config.webhook_password
+  = Rails.application.secrets.webhook_password config.webhook_jobs << MyOnWebhookJob  config.store
+  = :lazy_sync, Rails.cache if Rails.env.production? # config.store = MyCustomStore.new  #
+  Use a custom Faraday connection config.connection = Faraday.new do |builder| f.request
+  :retry f.request MyFaradayRequestAdapter.new ... end # OR implement some adapter
+  like this to use another HTTP client config.connection = MyNetHttpAdapter.new  config.update_schema_file
+  = :never end  WCC::Contentful.init! ```  For Heroku:  ```yaml # Procfile web: bundle
+  exec rails s worker: bundle exec sidekiq release: bin/release ```  ```sh # bin/release
+  #!/bin/sh  set -e  echo "Migrating database..." bin/rake db:migrate  echo "Migrating
+  contentful..." migrations_to_be_run=$( ... ) # somehow figure this out node_modules/.bin/contentful-migration
+  \ -s $CONTENTFUL_SPACE_ID -a $CONTENTFUL_MANAGEMENT_TOKEN \ -y -p "$migrations_to_be_run"  echo
+  "Updating schema file..." rake wcc_contentful:download_schema ```  All configuration
+  options can be found [in the rubydoc](https://www.rubydoc.info/gems/wcc-contentful/WCC/Contentful/Configuration)
+  under {WCC::Contentful::Configuration}   ## 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 and pull requests are welcome
+  on GitHub at https://github.com/watermarkchurch/wcc-contentful. This project is
+  intended to be a safe, welcoming space for collaboration, and contributors are expected
+  to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+  conduct.  ## License  The gem is available as open source under the terms of the
+  [MIT License](http://opensource.org/licenses/MIT).  ## Code of Conduct  Everyone
   interacting in the WCC::Contentful project''s codebases, issue trackers, chat rooms
   and mailing lists is expected to follow the [code of conduct](https://github.com/watermarkchurch/wcc-contentful/blob/master/CODE_OF_CONDUCT.md).'
 test_files: []