wcc-contentful 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbf4090e5eb907ab57ae130ef528a05b48bedff6
-  data.tar.gz: 717ac008fd501476b14f7e638b12dbc3afa7f9a3
+  metadata.gz: 58ee6d756754247484bf90a993340caf891a7471
+  data.tar.gz: 947b949744aacf47612a91237e70807e91c53664
 SHA512:
-  metadata.gz: b5218be16ee83549e3dd3e876ce8be5d4ffee0ad0d33534eeaa2ef9679a4e2d973a78b242b192fac90d83836af35875a174896a578922f4ead213989dc9f68d8
-  data.tar.gz: a9673fbfa992ff680a49887a2aa4563adde136255476d1f160b9769ff5cb398ef304d7f86c851c0700d55c840a1f566e77d287b73eaee8ca4286b50f6a6dd163
+  metadata.gz: b89c3971ea984941b7f6dcba32cf1b9942417236a8074224304716379bccc9e8a7e10cfb646cece2d4989b514ee8ada7e55bc65f03668d8686482418d2699dc9
+  data.tar.gz: 47ebcda216d33570a8a99018131c84411bbc42c3dead50c47632bc3b2e1d516d3af18447b31e2c17dc003e7805423e4bef891545c3302fd6fa1792504cf4d6bd

data/CHANGELOG.md

@@ -23,4 +23,23 @@
 * Application models can be registered to be instantiated for a given content type
 * New 'lazy sync' delivery method acts as a cache that is kept up to date by the sync API
 * 'eager sync' is now hooked up to a webhook which can be mounted to receive publish events
-* Major changes to configuration methods
+* Major changes to configuration methods
+
+# v0.2.2
+
+* Add preview_client for doing contentful calls to their preview api
+* 'find_by' can now receive a preview param set to a boolean value 
+* Can configure your preview_api by passing a preview_token to configure block
+* The Redirect model provides a 'href' method that will give you the url it points to
+
+# v0.3.0
+
+* Now neccesary to require the engine in a Gemfile when using in Rails:
+
+  `gem 'wcc-contentful', require: 'wcc/contentful/rails'`
+  
+* The gem can be configured to point to a non-master environment with the following configuration parameter:
+
+  `config.environment = 'my_environment'`
+  
+* When a model is not found in contentful, `Model.find_by` returns `nil` rather than raising an error.

data/README.md

@@ -5,7 +5,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'wcc-contentful'
+gem 'wcc-contentful', require: 'wcc/contentful/rails'
 ```
 
 And then execute:
@@ -21,6 +21,7 @@ Or install it yourself as:
 ```ruby
 WCC::Contentful.configure do |config|
   config.access_token = <CONTENTFUL_ACCESS_TOKEN>
+  config.preview_token = <CONTENTFUL_PREVIEW_TOKEN>
   config.space = <CONTENTFUL_SPACE_ID>
   config.default_locale = "en-US"
 end
@@ -29,9 +30,11 @@ end
 ## Usage
 
 ```ruby
-redirect_object = WCC::Contentful::Redirect.find_by_slug('new')
+redirect_object = WCC::Contentful::Model::Redirect.find_by({slug: 'published-redirect'}, preview: false)
+redirect_object.href
 
-redirect_object.location
+preview_redirect_object = WCC::Contentful::Model::Redirect.find_by({slug: 'draft-redirect'}, preview: true)
+preview_redirect_object.href
 ```
 
 ## Development

data/lib/generators/wcc/USAGE

@@ -3,14 +3,14 @@ Description:
     to your contentful space.
 
 Example:
-    rails generate wcc:menu
+    rails generate wcc:model MODEL
 
     This will install:
       https://www.github.com/watermarkchurch/migration-cli
 
     This will create:
-      db/migrate/[date]_generated_add_menus.ts -
-        this migration is run by the migration CLI to create menus in your
+      db/migrate/[date]_generated_add_[MODEL].ts -
+        this migration is run by the migration CLI to create MODEL in your
         contentful space
       bin/release -
         Adds a release command to your rails app which runs migrations.

data/lib/generators/wcc/{menu_generator.rb → model_generator.rb}

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
 module Wcc
-  class MenuGenerator < Rails::Generators::Base
+  class ModelGenerator < Rails::Generators::Base
     source_root File.expand_path('templates', __dir__)
+    argument :model, type: :string
 
-    def create_menus_migration
-      now = Time.now.strftime('%Y%m%d%H%M')
-      copy_file 'menu/generated_add_menus.ts',
-        "db/migrate/#{now}01_generated_add_menus.ts"
+    VALID_MODELS = %w[menu page].freeze
+
+    def initialize(*)
+      super
+
+      return if VALID_MODELS.include?(singular)
+
+      raise ArgumentError, "Model must be #{VALID_MODELS.to_sentence}"
     end
 
     def ensure_migration_tools_installed
@@ -17,7 +22,7 @@ module Wcc
         deps = package['dependencies']
 
         unless deps.try(:[], 'contentful-migration-cli').present?
-          run 'npm install --save watermarkchurch/migration-cli ts-node typescript'
+          run 'npm install --save watermarkchurch/migration-cli ts-node typescript contentful-export'
         end
       end
     end
@@ -59,9 +64,27 @@ module Wcc
       copy_file 'wcc_contentful.rb', 'config/initializers/wcc_contentful.rb'
     end
 
+    def create_model_migration
+      copy_file "#{singular}/generated_add_#{plural}.ts",
+        "db/migrate/#{timestamp}01_generated_add_#{plural}.ts"
+    end
+
     def drop_model_overrides_in_app_models
-      copy_file 'menu/menu.rb', 'app/models/menu.rb'
-      copy_file 'menu/menu_button.rb', 'app/models/menu_button.rb'
+      directory "#{singular}/models", 'app/models'
+    end
+
+    private
+
+    def singular
+      model.downcase.singularize
+    end
+
+    def plural
+      model.downcase.pluralize
+    end
+
+    def timestamp
+      Time.now.strftime('%Y%m%d%H%M')
     end
   end
 end

data/lib/generators/wcc/templates/contentful_shell_wrapper

@@ -176,13 +176,15 @@ migrate() {
 
   require_environment
 
+  [[ ! -z "$CONTENTFUL_ENVIRONMENT" ]] && ENV="--environment-id $CONTENTFUL_ENVIRONMENT"
+
   execv node_modules/.bin/ts-node node_modules/.bin/contentful-migration \
-    -s $CONTENTFUL_SPACE_ID -a $CONTENTFUL_MANAGEMENT_TOKEN \
+    -s $CONTENTFUL_SPACE_ID $ENV -a $CONTENTFUL_MANAGEMENT_TOKEN \
     $YES -p $ARG
 
   mkdir -p db
   execv node_modules/.bin/contentful-export --export-dir db --content-file contentful-schema.json \
-    --space-id $CONTENTFUL_SPACE_ID --management-token $CONTENTFUL_MANAGEMENT_TOKEN \
+    --space-id $CONTENTFUL_SPACE_ID $ENV --management-token $CONTENTFUL_MANAGEMENT_TOKEN \
     --query-entries 'content_type=migrationHistory' \
     --query-assets 'sys.id=false'
 

data/lib/generators/wcc/templates/menu/generated_add_menus.ts

@@ -61,6 +61,11 @@ export = function (migration: Migration) {
     .name('Icon')
     .type('Link')
     .linkType('Asset')
+    .validations([
+      {
+        linkMimetypeGroup: ['image']
+      }
+    ])
   
   menuButton.createField('externalLink')
     .name('External Link')

data/lib/generators/wcc/templates/page/generated_add_pages.ts

@@ -0,0 +1,50 @@
+import Migration from 'contentful-migration-cli'
+
+export = function (migration: Migration) {
+  const page = migration.createContentType('page')
+    .name('Page')
+    .description('A page describes a collection of sections that correspond' +
+     'to a URL slug')
+    .displayField('title')
+
+  page.createField('title')
+    .name('Title')
+    .type('Symbol')
+    .required(true)
+
+  page.createField('slug')
+    .name('Slug')
+    .type('Symbol')
+    .required(true)
+    .validations([
+      {
+        unique: true
+      },
+      {
+        regexp: { pattern: "(\\/|\\/([\w#!:.?+=&%@!\\-\\/]))?$" },
+        message: "The slug must look like the path part of a URL and begin with a forward slash, example: '/my-page-slug'"
+      }
+    ])
+
+  page.createField('sections')
+    .name('Sections')
+    .type('Array')
+    .items({
+      type: 'Link',
+      linkType: 'Entry'
+    })
+
+  page.createField('subpages')
+    .name('Subpages')
+    .type('Array')
+    .items({
+      type: 'Link',
+      linkType: 'Entry',
+      validations: [
+        {
+          linkContentType: [ 'page' ]
+        }
+      ]
+    })
+
+}

data/lib/generators/wcc/templates/page/models/page.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# This model represents the 'page' content type in Contentful.  Any linked
+# entries of the 'page' content type will be resolved as instances of this class.
+# It exposes #find, #find_by, and #find_all methods to query Contentful.
+class Page < WCC::Contentful::Model::Page
+  # Add custom validations to ensure that app-specific properties exist:
+  # validate_field :foo, :String, :required
+  # validate_field :bar_links, :Array, link_to: %w[bar baz]
+
+  # Override functionality or add utilities
+  #
+  # # Example: override equality
+  # def ===(other)
+  #   ...
+  # end
+  #
+  # # Example: override "title" attribute to always be titlecase.
+  # #          `@title` is populated by the gem in the initializer.
+  # def title
+  #   @title_titlecased ||= @title.titlecase
+  # end
+end

data/lib/wcc/contentful.rb

@@ -35,8 +35,12 @@ module WCC::Contentful
   ##
   # Gets a {CDN Client}[rdoc-ref:WCC::Contentful::SimpleClient::Cdn] which provides
   # methods for getting and paging raw JSON data from the Contentful CDN.
-  def self.client
-    configuration&.client
+  def self.client(preview: false)
+    if preview
+      configuration&.preview_client
+    else
+      configuration&.client
+    end
   end
 
   ##
@@ -59,6 +63,10 @@ module WCC::Contentful
     WCC::Contentful::Model.store
   end
 
+  def self.preview_store
+    WCC::Contentful::Model.preview_store
+  end
+
   ##
   # Configures the WCC::Contentful gem to talk to a Contentful space.
   # This must be called first in your initializer, before #init! or accessing the
@@ -68,8 +76,7 @@ module WCC::Contentful
     @next_sync_token = nil
     yield(configuration)
 
-    raise ArgumentError, 'Please provide "space"' unless configuration.space.present?
-    raise ArgumentError, 'Please provide "access_token"' unless configuration.access_token.present?
+    configuration.validate!
 
     configuration.configure_contentful
 
@@ -90,6 +97,7 @@ module WCC::Contentful
     raise ArgumentError, 'Please first call WCC:Contentful.configure' if configuration.nil?
     @mutex ||= Mutex.new
 
+    use_preview_client = false
     # we want as much as possible the raw JSON from the API
     content_types_resp =
       if configuration.management_client
@@ -97,6 +105,9 @@ module WCC::Contentful
       else
         configuration.client.content_types(limit: 1000)
       end
+
+    (use_preview_client = true) unless configuration.preview_client.nil?
+
     @content_types = content_types_resp.items
 
     indexer =
@@ -105,8 +116,15 @@ module WCC::Contentful
       end
     @types = indexer.types
 
-    store = configuration.store
-    WCC::Contentful::Model.store = store
+    if use_preview_client
+      store = configuration.store(preview: false)
+      WCC::Contentful::Model.store = store
+      preview_store = configuration.store(preview: use_preview_client)
+      WCC::Contentful::Model.preview_store = preview_store
+    else
+      store = configuration.store(preview: use_preview_client)
+      WCC::Contentful::Model.store = store
+    end
 
     if store.respond_to?(:index)
       @next_sync_token = store.find("sync:#{configuration.space}:token")
@@ -120,11 +138,6 @@ module WCC::Contentful
       file = File.dirname(__FILE__) + "/contentful/model/#{t.name.underscore}.rb"
       require file if File.exist?(file)
     end
-
-    return unless defined?(Rails)
-
-    # load up the engine so it gets automatically mounted
-    require 'wcc/contentful/engine'
   end
 
   ##

data/lib/wcc/contentful/configuration.rb

@@ -5,8 +5,10 @@ class WCC::Contentful::Configuration
     access_token
     management_token
     space
+    environment
     default_locale
     content_delivery
+    preview_token
     http_adapter
     sync_cache_store
     webhook_username
@@ -59,12 +61,20 @@ class WCC::Contentful::Configuration
 
   ##
   # Initializes the configured Sync Store.
-  def store
-    @store ||= WCC::Contentful::Store::Factory.new(
-      self,
-      @content_delivery,
-      @content_delivery_params
-    ).build_sync_store
+  def store(preview: false)
+    if preview
+      @preview_store ||= WCC::Contentful::Store::Factory.new(
+        self,
+        :direct,
+        [{ preview: preview }]
+      ).build_sync_store
+    else
+      @store ||= WCC::Contentful::Store::Factory.new(
+        self,
+        @content_delivery,
+        @content_delivery_params
+      ).build_sync_store
+    end
   end
 
   ##
@@ -84,6 +94,7 @@ class WCC::Contentful::Configuration
   def initialize
     @access_token = ''
     @management_token = ''
+    @preview_token = ''
     @space = ''
     @default_locale = nil
     @content_delivery = :direct
@@ -94,6 +105,7 @@ class WCC::Contentful::Configuration
   # methods for getting and paging raw JSON data from the Contentful CDN.
   attr_reader :client
   attr_reader :management_client
+  attr_reader :preview_client
 
   ##
   # Called by WCC::Contentful.init! to configure the
@@ -105,6 +117,7 @@ class WCC::Contentful::Configuration
   def configure_contentful
     @client = nil
     @management_client = nil
+    @preview_client = nil
 
     if defined?(::ContentfulModel)
       ContentfulModel.configure do |config|
@@ -121,14 +134,35 @@ class WCC::Contentful::Configuration
       access_token: access_token,
       space: space,
       default_locale: default_locale,
-      adapter: http_adapter
+      adapter: http_adapter,
+      environment: environment
     )
+
+    if preview_token.present?
+      @preview_client = WCC::Contentful::SimpleClient::Preview.new(
+        preview_token: preview_token,
+        space: space,
+        default_locale: default_locale,
+        adapter: http_adapter
+      )
+    end
+
     return unless management_token.present?
     @management_client = WCC::Contentful::SimpleClient::Management.new(
       management_token: management_token,
       space: space,
       default_locale: default_locale,
-      adapter: http_adapter
+      adapter: http_adapter,
+      environment: environment
     )
   end
+
+  def validate!
+    raise ArgumentError, 'Please provide "space"' unless space.present?
+    raise ArgumentError, 'Please provide "access_token"' unless access_token.present?
+
+    return if environment.nil? || %i[direct custom].include?(content_delivery)
+    raise ArgumentError, 'The Contentful Sync API currently does not work with environments.  ' \
+      'You can use the ":direct" content_delivery method, or provide a custom store implementation.'
+  end
 end

data/lib/wcc/contentful/engine.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'wcc/rails'
-
 module WCC::Contentful
   class Engine < ::Rails::Engine
     isolate_namespace WCC::Contentful

data/lib/wcc/contentful/helpers.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 module WCC::Contentful::Helpers
@@ -16,7 +15,7 @@ module WCC::Contentful::Helpers
   end
 
   def constant_from_content_type(content_type)
-    content_type.camelize.gsub(/[^_a-zA-Z0-9]/, '_')
+    content_type.gsub(/[^_a-zA-Z0-9]/, '_').camelize
   end
 
   def shared_prefix(string_array)

data/lib/wcc/contentful/model.rb

@@ -17,6 +17,7 @@ class WCC::Contentful::Model
     # See the {sync_store}[rdoc-ref:WCC::Contentful::Configuration.sync_store] parameter
     # on the WCC::Contentful::Configuration class.
     attr_accessor :store
+    attr_accessor :preview_store
 
     def const_missing(name)
       raise WCC::Contentful::ContentTypeNotFoundError,

data/lib/wcc/contentful/model/page.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::Model::Page < WCC::Contentful::Model
+  validate_field :title, :String
+  validate_field :slug, :String
+  validate_field :subpages, :Array, link_to: %w[page]
+  validate_field :sections, :Array, link_to: /^section/
+end

data/lib/wcc/contentful/model/redirect.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::Model::Redirect < WCC::Contentful::Model
+  def href
+    if !url.nil?
+      url
+    elsif valid_page_reference?(pageReference)
+      "/#{pageReference.url}"
+    end
+  end
+
+  def valid_page_reference?(page_ref)
+    if !page_ref.nil? && !defined?(page_ref.url).nil?
+      true
+    else
+      false
+    end
+  end
+end

data/lib/wcc/contentful/model_builder.rb

@@ -57,7 +57,13 @@ module WCC::Contentful
             bad_fields = filter.keys.reject { |k| fields.include?(k) }
             raise ArgumentError, "These fields do not exist: #{bad_fields}" unless bad_fields.empty?
 
-            result = WCC::Contentful::Model.store.find_by(content_type: content_type, filter: filter)
+            result =
+              if defined?(context[:preview]) && context[:preview] == true
+                WCC::Contentful::Model.preview_store.find_by(content_type: content_type, filter: filter)
+              else
+                WCC::Contentful::Model.store.find_by(content_type: content_type, filter: filter)
+              end
+
             new(result, context) if result
           end
 
@@ -89,7 +95,7 @@ module WCC::Contentful
               if raw_value.present?
                 case f.type
                 when :DateTime
-                  raw_value = Time.zone.parse(raw_value)
+                  raw_value = Time.parse(raw_value).localtime
                 when :Int
                   raw_value = Integer(raw_value)
                 when :Float

data/lib/wcc/contentful/rails.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'wcc/rails'
+require 'wcc/contentful'
+require 'wcc/contentful/engine'

data/lib/wcc/contentful/simple_client.rb

@@ -23,6 +23,9 @@ module WCC::Contentful
       @options = options
       @query_defaults = {}
       @query_defaults[:locale] = @options[:default_locale] if @options[:default_locale]
+
+      return unless env = options[:environment]
+      @api_url = URI.join(@api_url, 'environments/', env + '/')
     end
 
     def get(path, query = {})
@@ -99,6 +102,10 @@ module WCC::Contentful
         )
       end
 
+      def client_type
+        'cdn'
+      end
+
       ##
       # Gets an entry by ID
       def entry(key, query = {})
@@ -155,22 +162,38 @@ module WCC::Contentful
     end
 
     class Management < SimpleClient
-      def initialize(management_token:, **options)
+      def initialize(space:, management_token:, **options)
         super(
           api_url: options[:api_url] || 'https://api.contentful.com',
-          space: options[:space] || '/',
+          space: space,
           access_token: management_token,
           **options
         )
       end
 
-      def content_types(space: nil, **query)
-        space ||= @space
-        raise ArgumentError, 'please provide a space ID' if space.nil?
+      def client_type
+        'management'
+      end
 
-        resp = get("/spaces/#{space}/content_types", query)
+      def content_types(**query)
+        resp = get('content_types', query)
         resp.assert_ok!
       end
     end
+
+    class Preview < Cdn
+      def initialize(space:, preview_token:, **options)
+        super(
+          api_url: options[:api_url] || 'https://preview.contentful.com/',
+          space: space,
+          access_token: preview_token,
+          **options
+        )
+      end
+
+      def client_type
+        'preview'
+      end
+    end
   end
 end

data/lib/wcc/contentful/store.rb

@@ -56,8 +56,12 @@ module WCC::Contentful::Store
         )
       end
 
-      def build_direct(config, *_options)
-        CDNAdapter.new(config.client)
+      def build_direct(config, *options)
+        if options.find { |array| array[:preview] == true }
+          CDNAdapter.new(config.preview_client)
+        else
+          CDNAdapter.new(config.client)
+        end
       end
 
       def validate_eager_sync(_config, store = nil, *_options)

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/wcc-contentful.gemspec

@@ -46,8 +46,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 
   # optional dependencies
-  spec.add_development_dependency 'contentful', '>= 0.12.0'
-  spec.add_development_dependency 'contentful-management', '>= 1.10.0'
+  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 'http', '> 1.0', '< 3.0'
   spec.add_development_dependency 'pg', '~> 1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -238,30 +238,30 @@ dependencies:
   name: contentful
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: contentful-management
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -396,13 +396,15 @@ files:
 - config/initializers/mime_types.rb
 - config/routes.rb
 - lib/generators/wcc/USAGE
-- lib/generators/wcc/menu_generator.rb
+- lib/generators/wcc/model_generator.rb
 - lib/generators/wcc/templates/.keep
 - lib/generators/wcc/templates/Procfile
 - lib/generators/wcc/templates/contentful_shell_wrapper
 - lib/generators/wcc/templates/menu/generated_add_menus.ts
-- lib/generators/wcc/templates/menu/menu.rb
-- lib/generators/wcc/templates/menu/menu_button.rb
+- lib/generators/wcc/templates/menu/models/menu.rb
+- lib/generators/wcc/templates/menu/models/menu_button.rb
+- lib/generators/wcc/templates/page/generated_add_pages.ts
+- lib/generators/wcc/templates/page/models/page.rb
 - lib/generators/wcc/templates/release
 - lib/generators/wcc/templates/wcc_contentful.rb
 - lib/wcc/contentful.rb
@@ -419,9 +421,12 @@ files:
 - lib/wcc/contentful/model.rb
 - lib/wcc/contentful/model/menu.rb
 - lib/wcc/contentful/model/menu_button.rb
+- lib/wcc/contentful/model/page.rb
+- lib/wcc/contentful/model/redirect.rb
 - lib/wcc/contentful/model_builder.rb
 - lib/wcc/contentful/model_validators.rb
 - lib/wcc/contentful/model_validators/dsl.rb
+- lib/wcc/contentful/rails.rb
 - lib/wcc/contentful/simple_client.rb
 - lib/wcc/contentful/simple_client/http_adapter.rb
 - lib/wcc/contentful/simple_client/response.rb
@@ -454,20 +459,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: '# WCC::Contentful  ## Installation  Add this line to your application''s
-  Gemfile:  ```ruby gem ''wcc-contentful'' ```  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>
-  config.default_locale = "en-US" end ```  ## Usage  ```ruby redirect_object = WCC::Contentful::Redirect.find_by_slug(''new'')  redirect_object.location
-  ```  ## 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).  ##
+  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.preview_token = <CONTENTFUL_PREVIEW_TOKEN> config.space = <CONTENTFUL_SPACE_ID>
+  config.default_locale = "en-US" end ```  ## Usage  ```ruby redirect_object = WCC::Contentful::Model::Redirect.find_by({slug:
+  ''published-redirect''}, preview: false) redirect_object.href  preview_redirect_object
+  = WCC::Contentful::Model::Redirect.find_by({slug: ''draft-redirect''}, preview:
+  true) preview_redirect_object.href ```  ## 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/[USERNAME]/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)