wcc-contentful 0.4.0.pre.rc → 1.0.0.pre.rc1

data/lib/wcc/contentful/sync_engine.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'wcc/contentful/event'
+require 'wisper'
+
+begin
+  gem 'activejob'
+  require 'active_job'
+rescue Gem::LoadError # rubocop:disable Lint/HandleExceptions
+  # suppress
+end
+
+module WCC::Contentful
+  # The SyncEngine is used to keep the currently configured store up to date
+  # using the Sync API.  It is available on the WCC::Contentful::Services instance,
+  # and the application is responsible to periodically call #next in order to hit
+  # the sync API and update the store.
+  #
+  # If you have mounted the WCC::Contentful::Engine, AND the configured store is
+  # one that can be synced (i.e. it responds to `:index`), then
+  # the WCC::Contentful::WebhookController will call #next automatically anytime
+  # a webhook is received.  Otherwise you should hook up to the Webhook events
+  # and call the sync engine via your initializer:
+  #     WCC::Contentful::Events.subscribe(proc do |event|
+  #       WCC::Contentful::Services.instance.sync_engine.next(up_to: event.dig('sys', 'id'))
+  #     end, with: :call)
+  class SyncEngine
+    include ::Wisper::Publisher
+
+    def state
+      (@state&.dup || token_wrapper_factory(nil)).freeze
+    end
+
+    attr_reader :store
+    attr_reader :client
+
+    def should_sync?
+      store&.index?
+    end
+
+    def initialize(state: nil, store: nil, client: nil, key: nil)
+      @state_key = key || "sync:#{object_id}"
+      @client = client || WCC::Contentful::Services.instance.client
+      @mutex = Mutex.new
+
+      if store
+        unless %i[index index? find].all? { |m| store.respond_to?(m) }
+          raise ArgumentError, ':store param must implement the Store interface'
+        end
+
+        @store = store
+        @state = read_state if should_sync?
+      end
+      if state
+        @state = token_wrapper_factory(state)
+        raise ArgumentError, ':state param must be a String or Hash' unless @state.is_a? Hash
+        unless @state.dig('sys', 'type') == 'token'
+          raise ArgumentError, ':state param must be of sys.type = "token"'
+        end
+      end
+      raise ArgumentError, 'either :state or :store must be provided' unless @state || @store
+    end
+
+    # Gets the next increment of data from the Sync API.
+    # If the configured store responds to `:index`, that will be called with each
+    # item in the Sync response to update the store.
+    # If a block is passed, that block will be evaluated with each item in the
+    # response.
+    # @param [String] up_to_id An ID to look for in the response.  The method returns
+    #   true if the ID was found or no up_to_id was given, false if the ID did not come back.
+    # @return [Array] A `[Boolean, Integer]` tuple where the first value is whether the ID was found,
+    #   and the second value is the number of items returned.
+    def next(up_to_id: nil)
+      id_found = up_to_id.nil?
+      all_events = []
+
+      @mutex.synchronize do
+        @state ||= read_state || token_wrapper_factory(nil)
+        next_sync_token = @state['token']
+
+        sync_resp = client.sync(sync_token: next_sync_token)
+        sync_resp.items.each do |item|
+          id = item.dig('sys', 'id')
+          id_found ||= id == up_to_id
+
+          store.index(item) if store&.index?
+          event = WCC::Contentful::Event.from_raw(item, source: self)
+          yield(event) if block_given?
+          emit_event(event)
+          all_events << event
+        end
+
+        @state['token'] = sync_resp.next_sync_token
+        write_state
+      end
+
+      emit_sync_complete(all_events)
+
+      [id_found, all_events.length]
+    end
+
+    def emit_event(event)
+      type = event.dig('sys', 'type')
+      raise ArgumentError, "Unknown event type #{event}" unless type.present?
+
+      broadcast(type, event)
+    end
+
+    def emit_sync_complete(events)
+      event = WCC::Contentful::Event::SyncComplete.new(events, source: self)
+      broadcast('SyncComplete', event)
+    end
+
+    private
+
+    def read_state
+      return unless found = store&.find(@state_key)
+
+      # backwards compat - migrate existing state
+      token_wrapper_factory(found)
+    end
+
+    def write_state
+      store.index(@state) if store&.index?
+    end
+
+    def token_wrapper_factory(state)
+      state = { 'token' => state } unless state.is_a? Hash
+
+      state.merge!('sys' => { 'id' => @state_key, 'type' => 'token' }) unless state['sys']
+      state
+    end
+
+    # Define the job only if rails is loaded
+    if defined?(ActiveJob)
+      # This job uses the Contentful Sync API to update the configured store with
+      # the latest data from Contentful.
+      class Job < ActiveJob::Base
+        include WCC::Contentful::ServiceAccessors
+
+        self.queue_adapter = :async
+        queue_as :default
+
+        def perform(event = nil)
+          return unless sync_engine&.should_sync?
+
+          up_to_id = nil
+          up_to_id = event[:up_to_id] || event.dig('sys', 'id') if event
+          sync!(up_to_id: up_to_id)
+        end
+
+        # Calls the Contentful Sync API and updates the configured store with the returned
+        # data.
+        #
+        # @param [String] up_to_id
+        #  An ID that we know has changed and should come back from the sync.
+        #  If we don't find this ID in the sync data, then drop a job to try
+        #  the sync again after a few minutes.
+        #
+        def sync!(up_to_id: nil)
+          id_found, count = sync_engine.next(up_to_id: up_to_id)
+
+          next_sync_token = sync_engine.state['token']
+
+          logger.info "Synced #{count} entries.  Next sync token:\n  #{next_sync_token}"
+          logger.info "Should enqueue again? [#{!id_found}]"
+          # Passing nil to only enqueue the job 1 more time
+          sync_later!(up_to_id: nil) unless id_found
+          next_sync_token
+        end
+
+        # Drops an ActiveJob job to invoke WCC::Contentful.sync! after a given amount
+        # of time.
+        def sync_later!(up_to_id: nil, wait: 10.minutes)
+          self.class.set(wait: wait)
+            .perform_later(up_to_id: up_to_id)
+        end
+      end
+    end
+  end
+end

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

@@ -5,10 +5,22 @@ module WCC::Contentful::Test::Attributes
     String: 'test',
     Int: 0,
     Float: 0.0,
-    DateTime: Time.at(0),
+    DateTime: Time.at(0).to_s,
     Boolean: false,
-    Json: -> { OpenStruct.new },
-    Coordinates: -> { OpenStruct.new }
+    Json: ->(_f) { {} },
+    Coordinates: ->(_f) { {} },
+    Asset: ->(f) {
+             WCC::Contentful::Link.new(
+               "fake-#{f.name}-#{SecureRandom.urlsafe_base64[1..6]}",
+               :Asset
+             ).raw
+           },
+    Link: ->(f) {
+            WCC::Contentful::Link.new(
+              "fake-#{f.name}-#{SecureRandom.urlsafe_base64[1..6]}",
+              :Link
+            ).raw
+          }
   }.freeze
 
   class << self
@@ -35,8 +47,8 @@ module WCC::Contentful::Test::Attributes
       return [] if field.array
       return unless field.required
 
-      val = DEFAULTS[field]
-      return val.call if val.respond_to?(:call)
+      val = DEFAULTS[field.type]
+      return val.call(field) if val.respond_to?(:call)
 
       val
     end

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

@@ -7,62 +7,38 @@ module WCC::Contentful::Test::Factory
   # 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.
-  def contentful_create(content_type, **attrs)
+  def contentful_create(content_type, context = nil, **attrs)
     const = WCC::Contentful::Model.resolve_constant(content_type.to_s)
     attrs = attrs.transform_keys { |a| a.to_s.camelize(:lower) }
 
     id = attrs.delete('id')
+    sys = attrs.delete('sys')
+    raw = attrs.delete('raw') || default_raw(const, id)
     bad_attrs = attrs.reject { |a| const.content_type_definition.fields.key?(a) }
     raise ArgumentError, "Attribute(s) do not exist on #{const}: #{bad_attrs.keys}" if bad_attrs.any?
 
-    default_instance(const, id).tap do |instance|
-      attrs.each do |k, v|
-        field = const.content_type_definition.fields[k]
+    raw['sys'].merge!(sys) if sys
 
-        raw = v
-        if %i[Asset Link].include?(field.type)
-          raw = to_raw(v, field.type)
+    attrs.each do |k, v|
+      field = const.content_type_definition.fields[k]
 
-          unless field.array ? v.any? { |i| i.is_a?(String) } : v.is_a?(String)
-            instance.instance_variable_set("@#{field.name}_resolved", v)
-          end
-        end
+      raw_value = v
+      raw_value = to_raw(v, field.type) if %i[Asset Link].include?(field.type)
+      raw['fields'][field.name][raw.dig('sys', 'locale')] = raw_value
+    end
 
-        instance.raw['fields'][field.name][instance.sys.locale] = raw
-        instance.instance_variable_set("@#{field.name}", raw)
-      end
+    instance = const.new(raw, context)
 
-      def instance.to_s
-        "#<#{self.class.name} id=\"#{id}\">"
-      end
-    end
-  end
+    attrs.each do |k, v|
+      field = const.content_type_definition.fields[k]
+      next unless %i[Asset Link].include?(field.type)
 
-  class Link
-    attr_reader :id
-    attr_reader :link_type
-    attr_reader :raw
-
-    LINK_TYPES = {
-      Asset: 'Asset',
-      Link: 'Entry'
-    }.freeze
-
-    def initialize(model, link_type = nil)
-      @id = model.try(:id) || model
-      @link_type = link_type
-      @link_type ||= model.is_a?(WCC::Contentful::Model::Asset) ? :Asset : :Link
-      @raw =
-        {
-          'sys' => {
-            'type' => 'Link',
-            'linkType' => LINK_TYPES[@link_type],
-            'id' => @id
-          }
-        }
+      unless field.array ? v.any? { |i| i.is_a?(String) } : v.is_a?(String)
+        instance.instance_variable_set("@#{field.name}_resolved", v)
+      end
     end
 
-    alias_method :to_h, :raw
+    instance
   end
 
   private
@@ -72,10 +48,10 @@ module WCC::Contentful::Test::Factory
   end
 
   def default_raw(model, id = nil)
-    { sys: sys(model, id), fields: fields(model) }.as_json
+    { sys: contentful_sys(model, id), fields: contentful_fields(model) }.as_json
   end
 
-  def sys(model, id = nil)
+  def contentful_sys(model, id = nil)
     {
       space: {
         sys: {
@@ -107,7 +83,7 @@ module WCC::Contentful::Test::Factory
     }
   end
 
-  def fields(model)
+  def contentful_fields(model)
     WCC::Contentful::Test::Attributes.defaults(model).each_with_object({}) do |(k, v), h|
       h[k] = { 'en-US' => v }
     end
@@ -117,7 +93,7 @@ module WCC::Contentful::Test::Factory
     if val.is_a? Array
       val.map { |i| to_raw(i, field_type) }
     elsif val.is_a? String
-      Link.new(val, field_type).raw
+      WCC::Contentful::Link.new(val, field_type).raw
     elsif val
       val.raw
     end

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '0.4.0-rc'
+    VERSION = '1.0.0-rc1'
   end
 end

data/wcc-contentful.gemspec

@@ -24,39 +24,42 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'byebug', '~> 11.0.1'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'dotenv', '~> 2.2'
+  spec.add_development_dependency 'erb_lint', '~> 0.0.26'
   spec.add_development_dependency 'httplog', '~> 1.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'rspec-instrumentation-matcher'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
+  spec.add_development_dependency 'rubocop', '0.68'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
-  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'vcr', '~> 5.0'
   spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'wisper-rspec'
 
   # Makes testing easy via `bundle exec guard`
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'guard-rubocop', '~> 1.3.0'
+  spec.add_development_dependency 'guard-shell', '~> 0.7.1'
 
   # for generators
   spec.add_development_dependency 'generator_spec', '~> 0.9.4'
-  spec.add_development_dependency 'rails', '~> 5.1'
-  spec.add_development_dependency 'rspec-rails', '~> 3.7'
-  spec.add_development_dependency 'sqlite3'
+  # spec.add_development_dependency 'rails', '~> 5.0'
+  # spec.add_development_dependency 'rspec-rails', '~> 3.7'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 
   # optional dependencies
   spec.add_development_dependency 'connection_pool', '~> 2.2'
-  spec.add_development_dependency 'contentful', '2.6.0'
-  spec.add_development_dependency 'contentful-management', '2.0.2'
-  spec.add_development_dependency 'graphql', '~> 1.7'
+  spec.add_development_dependency 'faraday', '~> 0.9'
   spec.add_development_dependency 'http', '> 1.0', '< 3.0'
   spec.add_development_dependency 'pg', '~> 1.0'
   spec.add_development_dependency 'typhoeus', '~> 1.3'
 
   spec.add_dependency 'activesupport', '>= 5'
-  spec.add_dependency 'dry-validation', '~> 0.11.1'
   spec.add_dependency 'wcc-base', '~> 0.3.1'
+  spec.add_dependency 'wisper', '~> 2.0.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre.rc
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
 - Watermark Dev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-22 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
@@ -38,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
@@ -58,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
@@ -80,34 +108,48 @@ 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.3.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.68'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.68'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +170,14 @@ dependencies:
     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
@@ -150,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  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
@@ -193,61 +249,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: guard-shell
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 0.9.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -277,47 +319,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: contentful
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-- !ruby/object:Gem::Dependency
-  name: contentful-management
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.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
@@ -381,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
@@ -416,12 +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
@@ -429,35 +441,55 @@ 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
@@ -469,7 +501,7 @@ homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -484,31 +516,33 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-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)
+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/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:
+  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({
@@ -541,51 +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 ```  ## 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
+  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 #<Menu:0x00007fbac81ee490>  ##
+  # 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.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 ```   ## 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
+  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: []