contentful_rails 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f0f7d55ee8546d4eed5140bb1768923d8bc6861b
-  data.tar.gz: c0616573406f91822b3d3ee04d5138625498497a
+SHA256:
+  metadata.gz: b9421a944765ac63cc458ab0b6f0a88dd50d13bd459898ca04a067ac7a328edf
+  data.tar.gz: 78e17715de578357a0217eb209771ab2e4234e0a92556f550033d7718fe40419
 SHA512:
-  metadata.gz: bae8ca92a8774946ed40da840af9815059925c9c0f386d0fe23cddb514d6b4ca3906822c07b003826a213b60bc41e7e27881062bba4efd963bed45319ea2629b
-  data.tar.gz: a934378c344537923460d5f96ee2328fe57ec49d316136eb4c6eaf5763fbed085574cccb121107bd929b1b1327b3550ecf7db5759ddf7d8035c9d0fdc52af1e1
+  metadata.gz: 460f1d80d06888d332e3206dfe076493a7796d618bdfd33a4b82a95ea65286aae57b818d31ca3e36cdb9d91a657c7a4e618b8eaf7b244a9a8580f8a13a2e3a51
+  data.tar.gz: b51109a95f65e45e795baf3e62762a5fa2c70ee4c6ba67a237953108e0bb12d4e5a60e6059c6ccbee0b367ddefb1e4959f66e266fca348b127a99bb5e3ec1493

data/README.md

@@ -7,12 +7,12 @@ This is a work in progress. It relies on the contentful_model gem (http://github
 
 ## What is Contentful?
 
-[Contentful](https://www.contentful.com) is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.
+[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
 
 # Configuration
 ContentfulRails accepts a block for configuration. Best done in a Rails initializer.
 
-```
+```ruby
 ContentfulRails.configure do |config|
   config.authenticate_webhooks = true # false here would allow the webhooks to process without basic auth
   config.webhooks_username = "a basic auth username"
@@ -21,6 +21,7 @@ ContentfulRails.configure do |config|
   config.preview_access_token = "your preview access token"
   config.management_token = "your management access token"
   config.space = "your space ID"
+  config.environment = "your environment ID"
   config.contentful_options = "hash of options"
 end
 ```
@@ -39,7 +40,7 @@ By default, ContentfulRails will try to define your `entry_mapping` configuratio
   as [described here](https://github.com/contentful/contentful.rb#custom-resource-classes).
 
 
-```
+```ruby
 ContentfulRails.configure do |config|
   ...
   config.eager_load_entry_mapping = false
@@ -59,7 +60,7 @@ The issue with 'Russian Doll' caching in Rails is that it requires a hit on the
 
 This is obviously expensive when the object is called over an API. So this gem wraps caches `updated_at` locally, and checks that first on subsequent calls.
 
-```
+```ruby
 Foo.updated_at #returns a timestamp from cache, or from the API if no cache exists
 ```
 
@@ -73,7 +74,7 @@ To make use of this in your app:
 ## routes.rb
 Mount the ContentfulRails engine at your preferred url:
 
-```
+```ruby
 mount ContentfulRails::Engine => '/contentful' #feel free to choose a different endpoint name
 ```
 
@@ -92,7 +93,7 @@ To take advantage of this, there's a custom Redcarpet renderer which allows you
 
 In your application_controller.rb:
 
-```
+```ruby
 helper ContentfulRails::MarkdownHelper
 ```
 
@@ -101,8 +102,8 @@ This allows you to call `parse_markdown(@your_markdown)` and get HTML. *Note* th
 ## Manipulating images
 To manipulate images which are referenced in your markdown, you can pass the following into the `parse_markdown()` call.
 
-```
-parse_markdown(@your_markdown, image_options: {width: 1024, height: 1024})
+```ruby
+parse_markdown(@your_markdown, image_options: { width: 1024, height: 1024 })
 ```
 
 The `image_options` parameter takes the following options (some are mutually exclusive. Read the [instructions here](https://www.contentful.com/blog/2014/08/14/do-more-with-images-on-contentful-platform/)):
@@ -119,25 +120,41 @@ Sometimes you might want to apply some specific class, markup or similar to an h
 
 Just subclass the `ContentfulRails::MarkdownRenderer` class, and call any methods you need.
 
-```
+```ruby
 class MyRenderer < ContentfulRails::MarkdownRenderer
-      # If you want to pass options into your renderer, you need to overload initialize()
-      def initialize(opts)
-        @options = opts
-        super
-      end
-
-      # If you want to do something special with links:
-      def link(link,title,content)
-        # Add a class name to all links, for example
-        class_name = "my-link-class-name"
-        content_tag(:a, content, href: link, title: title, class: class_name)
-      end
+  # If you want to pass options into your renderer, you need to overload initialize()
+  def initialize(opts)
+    @options = opts
+    super
+  end
+
+  # If you want to do something special with links:
+  def link(link,title,content)
+    # Add a class name to all links, for example
+    class_name = "my-link-class-name"
+    content_tag(:a, content, href: link, title: title, class: class_name)
+  end
 end
 ```
 
 You can overload any methods exposed in RedCarpet.
 
+# Preview API
+ContenfulRails can be set up to use the [Contenful Preview API](https://www.contentful.com/developers/docs/references/content-preview-api/), and has the option of protecting that content behind basic authentication.
+To enable the preview api, add the below settings to your configuration.
+
+```
+ContentfulRails.configure do |config|
+  config.enable_preview_domain = true # use the preview domain
+  config.preview_access_token = "your preview access token"
+  config.preview_username = "a basic auth username"
+  config.preview_password = "a basic auth password"
+end
+```
+
+If you site is already protected with another form of authentication, then leave `preview_username` and `preview_password` unset.
+This will skip the authentication step when displaying preview content.
+
 # To Do
 Some things would be nice to do:
 

data/app/controllers/contentful_rails/webhooks_controller.rb

@@ -1,49 +1,51 @@
-class ContentfulRails::WebhooksController < ActionController::Base
-  protect_from_forgery with: :exception
-
-  if ContentfulRails.configuration.authenticate_webhooks
-    http_basic_authenticate_with  name: ContentfulRails.configuration.webhooks_username,
-                                  password: ContentfulRails.configuration.webhooks_password
-  end
-
-  params = [:verify_authenticity_token, {:only => [:create], raise: false}]
-  if Rails::VERSION::MAJOR > 4 
-    skip_before_action *params
-  else
-    skip_before_filter *params
-  end
-
-  #this is where we receive a webhook, via a POST
-  def create
-    # The only things we need to handle in here (for now at least) are entries.
-    # If there's been an update or a deletion, we just remove the cached timestamp.
-    # The updated_at method which is included in ContentfulModel::Base in this gem
-    # will check the cache first before making the call to the API.
-
-    # We can then just use normal Rails russian doll caching without expensive API calls.
-    request.format = :json
-    update_type = request.headers['HTTP_X_CONTENTFUL_TOPIC']
-
-    # All we do here is publish an ActiveSupport::Notification, which is subscribed to
-    # elsewhere. In this gem are subscription options for timestamp or object caching,
-    # implement your own and subscribe in an initializer.
-    ActiveSupport::Notifications.instrument("Contentful.#{update_type}", params)
-
-    #must return an ok
-    render nothing: true
+module ContentfulRails
+  # Controller for debugging and receiving Contentful Webhooks
+  # Webhooks are forwarded via the ActiveSupport::Notification system
+  class WebhooksController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    if ContentfulRails.configuration.authenticate_webhooks
+      http_basic_authenticate_with  name: ContentfulRails.configuration.webhooks_username,
+                                    password: ContentfulRails.configuration.webhooks_password
+    end
+
+    params = [:verify_authenticity_token, { only: [:create], raise: false }]
+    if Rails::VERSION::MAJOR > 4
+      skip_before_action(*params)
+    else
+      skip_before_filter(*params)
+    end
+
+    # this is where we receive a webhook, via a POST
+    def create
+      # The only things we need to handle in here (for now at least) are entries.
+      # If there's been an update or a deletion, we just remove the cached timestamp.
+      # The updated_at method which is included in ContentfulModel::Base in this gem
+      # will check the cache first before making the call to the API.
+
+      # We can then just use normal Rails russian doll caching without expensive API calls.
+      request.format = :json
+      update_type = request.headers['HTTP_X_CONTENTFUL_TOPIC']
+
+      # All we do here is publish an ActiveSupport::Notification, which is subscribed to
+      # elsewhere. In this gem are subscription options for timestamp or object caching,
+      # implement your own and subscribe in an initializer.
+      ActiveSupport::Notifications.instrument("Contentful.#{update_type}", params)
+
+      # must return an empty response
+      render body: nil
+    end
+
+    # Debug route
+    def debug
+      render plain: 'Debug method works ok'
+    end
+
+    private
+
+    def webhook_params
+      params.permit!
+      params.require(:sys).permit(:id, contentType: [sys: [:id]])
+    end
   end
-
-  def debug
-    render text: "Debug method works ok"
-  end
-
-  private
-
-  def webhook_params
-    params.permit!
-    params.require(:sys).permit(:id, contentType: [sys: [:id]])
-  end
-
-
-
 end

data/app/helpers/contentful_rails/markdown_helper.rb

@@ -1,12 +1,15 @@
 module ContentfulRails
+  # Custom Redcarpet wrapper with opinionated defaults.
   module MarkdownHelper
-    # Return HTML which is passed through the Redcloth markdown processor, using a custom renderer
+    # Return HTML which is passed through the Redcarpet markdown processor, using a custom renderer
     # so that we can manipulate images using contentful's URL-based API.
     # NOTE that this is super-permissive out of the box. Set options to suit when you call the method.
+    #
     # @param renderer_options [Hash] of options from https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch
     # @param markdown_options [Hash] of options from https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use
+    # @param image_options [Hash] of options to pass to the Image API. https://github.com/contentful/contentful_rails#manipulating-images
     def parse_markdown(markdown_string, renderer_options: {}, markdown_options: {}, image_options: {})
-      markdown_string ||= ""
+      markdown_string ||= ''
       markdown_opts = {
         no_intr_emphasis: true,
         tables: true,
@@ -43,4 +46,4 @@ module ContentfulRails
       markdown.render(markdown_string).html_safe
     end
   end
-end
+end

data/config/routes.rb

@@ -1,11 +1,9 @@
 ContentfulRails::Engine.routes.draw do
-
   resources :webhooks, only: [:create], defaults: { format: :json } do
     collection do
       scope constraints: ContentfulRails::DevelopmentConstraint do
-        get "/debug", to: "webhooks#debug"
+        get '/debug', to: 'webhooks#debug'
       end
     end
   end
-
 end

data/lib/contentful_rails.rb

@@ -1,14 +1,16 @@
 require 'redcarpet'
 require 'contentful_model'
 
-require "contentful_rails/engine"
-require "contentful_rails/development_constraint"
+require 'contentful_rails/engine'
+require 'contentful_rails/development_constraint'
 require 'contentful_rails/caching/timestamps'
-require "contentful_rails/markdown_renderer"
-require "contentful_rails/nested_resource"
-require "contentful_rails/sluggable"
-require "contentful_rails/preview"
+require 'contentful_rails/markdown_renderer'
+require 'contentful_rails/nested_resource'
+require 'contentful_rails/sluggable'
+require 'contentful_rails/preview'
 
+# A collection of useful things to help make it easier to integrate Contentful into your Rails app.
+# It includes view helpers, a Webhook handler, caching, and a Rails Engine to hook it all together.
 module ContentfulRails
   class << self
     attr_accessor :configuration
@@ -19,6 +21,19 @@ module ContentfulRails
     yield(configuration)
   end
 
+  def self.include_migrations_to_active_record
+    return unless active_record_available?
+
+    ActiveRecord::Migration.send(:include, ContentfulModel::Migrations::Migration)
+  end
+
+  def self.active_record_available?
+    Module.const_get('ActiveRecord::Migration')
+  rescue NameError
+    false
+  end
+
+  # Configuration accessors
   class Configuration
     attr_accessor :authenticate_webhooks,
                   :webhooks_username,
@@ -28,6 +43,7 @@ module ContentfulRails
                   :access_token,
                   :preview_access_token,
                   :management_token,
+                  :environment,
                   :space,
                   :default_locale,
                   :contentful_options,
@@ -39,7 +55,9 @@ module ContentfulRails
 
     def initialize
       @authenticate = true
-      @slug_delimiter = "-"
+      @slug_delimiter = '-'
+      @environment = 'master'
+      @default_locale = 'en-US'
       @perform_caching = Rails.configuration.action_controller.perform_caching
       @eager_load_entry_mapping = true
       @contentful_options = {}
@@ -47,4 +65,4 @@ module ContentfulRails
   end
 end
 
-ActiveRecord::Migration.send(:include, ContentfulModel::Migrations::Migration)
+ContentfulRails.include_migrations_to_active_record

data/lib/contentful_rails/caching/timestamps.rb

@@ -1,13 +1,16 @@
 module ContentfulRails
+  # Module for caching extensions
   module Caching
     # A module to prepend into ContentfulModel::Base which will allow the model instance
     # to check the cache for its timestamp before making an expensive API call.
     # Also includes a module method to remove an existing timestamp.
     module Timestamps
+      # @private
       def self.prepended(base)
         base.extend ClassMethods
       end
 
+      # Class methods for Timestamps
       module ClassMethods
         # Clear an existing timestamp from the cache; called by the subscriber to the Entry notifications
         # from the WebhooksController.
@@ -17,19 +20,21 @@ module ContentfulRails
           Rails.cache.delete(cache_key)
         end
 
+        # Get the cache key for the timestamp
         def timestamp_cache_key(item_id)
-          "contentful_timestamp/#{self.content_type_id}/#{item_id}"
+          "contentful_timestamp/#{content_type_id}/#{item_id}"
         end
       end
 
+      # Get the cache key for the timestamp for the current object
       def timestamp_cache_key
         self.class.timestamp_cache_key(id)
       end
 
-
+      # Fetches updated_at from cache if set, otherwise calls contentful object
       def updated_at
         if ContentfulRails.configuration.perform_caching && !ContentfulModel.use_preview_api
-          Rails.cache.fetch(self.timestamp_cache_key) do
+          Rails.cache.fetch(timestamp_cache_key) do
             super
           end
         else
@@ -37,6 +42,7 @@ module ContentfulRails
         end
       end
 
+      # Get the cache key
       def cache_key
         if ContentfulModel.use_preview_api
           "preview/#{super}"
@@ -47,4 +53,3 @@ module ContentfulRails
     end
   end
 end
-

data/lib/contentful_rails/development_constraint.rb

@@ -1,5 +1,9 @@
-class ContentfulRails::DevelopmentConstraint
-  def self.matches?(request)
-    Rails.env =~ %r{development} && (request.remote_ip =~ %r{127.0.0} || request.remote_ip =~ %r{^::1$})
+module ContentfulRails
+  # Constraint for ensuring development origin
+  class DevelopmentConstraint
+    # Returns if current request is coming from development environment or localhost
+    def self.matches?(request)
+      Rails.env =~ %r{development} && (request.remote_ip =~ %r{127.0.0} || request.remote_ip =~ %r{^::1$})
+    end
   end
-end
+end

data/lib/contentful_rails/engine.rb

@@ -1,6 +1,12 @@
 module ContentfulRails
+  # Rails Engine that initializes the Contentful wrappers
+  # This engine handles:
+  #   * ContentfulModel configuration (settings and eager entry mapping loading)
+  #   * Webhook Event handling (Entry publish/unpublish only)
+  #   * Caching timestamp prepending on entry objects
+  #   * Contentful MIME-type handling
+  #   * Preview API caching behaviour and local authentication for accessing the Preview API
   class Engine < ::Rails::Engine
-
     isolate_namespace ContentfulRails
 
     config.generators do |g|
@@ -8,28 +14,27 @@ module ContentfulRails
     end
 
     config.before_initialize do
-      if ContentfulRails.configuration.nil?
-        ContentfulRails.configure {}
-      end
+      ContentfulRails.configure {} if ContentfulRails.configuration.nil?
     end
 
-    initializer "configure_contentful", before: :add_entry_mappings do
+    initializer 'configure_contentful', before: :add_entry_mappings do
       ContentfulModel.configure do |config|
         config.access_token = ContentfulRails.configuration.access_token
         config.preview_access_token = ContentfulRails.configuration.preview_access_token
         config.management_token = ContentfulRails.configuration.management_token
+        config.environment = ContentfulRails.configuration.environment
         config.default_locale = ContentfulRails.configuration.default_locale
         config.space = ContentfulRails.configuration.space
         config.options = ContentfulRails.configuration.contentful_options
       end
     end
 
-    #Iterate through all models which inherit from ContentfulModel::Base
-    #and add an entry mapping for them, so calls to the Contentful API return
-    #the appropriate classes
-    #If eager_load_entry_mapping is false, engine assumes entry mapping is set manually by
-    #ContentfulRails.contentful_options[:entry_mapping] (passed through to Contentful.entry_mapping config)
-    initializer "add_entry_mappings", after: :configure_contentful  do
+    # Iterate through all models which inherit from ContentfulModel::Base
+    # and add an entry mapping for them, so calls to the Contentful API return
+    # the appropriate classes
+    # If eager_load_entry_mapping is false, engine assumes entry mapping is set manually by
+    # ContentfulRails.contentful_options[:entry_mapping] (passed through to Contentful.entry_mapping config)
+    initializer 'add_entry_mappings', after: :configure_contentful do
       if defined?(ContentfulModel) && ContentfulRails.configuration.eager_load_entry_mapping
         Rails.application.eager_load!
         ContentfulModel::Base.descendents.each do |klass|
@@ -38,38 +43,42 @@ module ContentfulRails
       end
     end
 
-    initializer "subscribe_to_webhook_events", after: :add_entry_mappings do
-      ActiveSupport::Notifications.subscribe(/Contentful.*Entry\.publish/) do |name, start, finish, id, payload|
+    initializer 'subscribe_to_webhook_events', after: :add_entry_mappings do
+      ActiveSupport::Notifications.subscribe(/Contentful.*Entry\.publish/) do |_name, _start, _finish, _id, payload|
         content_type_id = payload[:sys][:contentType][:sys][:id]
         klass = ContentfulModel.configuration.entry_mapping[content_type_id]
-        # klass will be nil if the content model has been created in contentful but the model in rails hasn't been added
-        unless klass.nil?
-          klass.send(:clear_cache_for, payload[:sys][:id])
-        end
 
+        # klass will be nil if the content model has been created in contentful but the model in rails hasn't been added
+        klass.send(:clear_cache_for, payload[:sys][:id]) unless klass.nil?
       end
 
-      ActiveSupport::Notifications.subscribe(/Contentful.*Entry\.unpublish/) do |name, start, finish, id, payload|
-        ActionController::Base.new.expire_fragment(%r{.*#{payload[:sys][:id]}.*})
+      ActiveSupport::Notifications.subscribe(/Contentful.*Entry\.unpublish/) do |_name, _start, _finish, _id, payload|
+        ActionController::Base.new.expire_fragment(%r{/.*#{payload[:sys][:id]}.*/})
       end
     end
 
-    initializer "prepend_timestamps_module", after: :subscribe_to_webhook_events do
+    initializer 'prepend_timestamps_module', after: :subscribe_to_webhook_events do
       if defined?(::ContentfulModel)
         ContentfulModel::Base.send(:prepend, ContentfulRails::Caching::Timestamps)
       end
     end
 
-    initializer "add_contentful_mime_type" do
-      content_type = "application/vnd.contentful.management.v1+json"
-      Mime::Type.register content_type, :contentful_json, [content_type]
+    # Module for defining Contentful vnd mime-type
+    module ContentfulJSON
+      # Contentful mime-type
+      MIMETYPE = 'application/vnd.contentful.management.v1+json'.freeze
+    end
+
+    initializer 'add_contentful_mime_type' do
+      Mime::Type.register(ContentfulJSON::MIMETYPE, :contentful_json)
       default_parsers = Rails::VERSION::MAJOR > 4 ? ActionDispatch::Http::Parameters::DEFAULT_PARSERS : ActionDispatch::ParamsParser::DEFAULT_PARSERS
-      default_parsers[Mime::Type.lookup(content_type)] = lambda do |body|
+      default_parsers[Mime::Type.lookup(ContentfulJSON::MIMETYPE)] = lambda do |body|
         JSON.parse(body)
       end
+      ActionDispatch::Request.parameter_parsers = ActionDispatch::Request::DEFAULT_PARSERS if ActionDispatch::Request.respond_to?(:parameter_parsers=)
     end
 
-    initializer "add_preview_support" do
+    initializer 'add_preview_support' do
       ActiveSupport.on_load(:action_controller) do
         include ContentfulRails::Preview
       end

data/lib/contentful_rails/markdown_renderer.rb

@@ -1,31 +1,38 @@
 require 'redcarpet'
-# A custom renderer for Redcarpet, which adds options for manipulating images through the URL of the image,
-# and building links based on the content of the link.
-#
-# You can subclass this in your application, to add or manipulate specific markup to elements in the markdown.
-class ContentfulRails::MarkdownRenderer < Redcarpet::Render::HTML
-  include ActionView::Helpers::TagHelper
-  include ActionView::Context
-  def initialize(opts)
-    @options = opts
-    @image_parameters = {
-      w: @options[:image_options][:width], #width in px
-      h: @options[:image_options][:height], #height in px
-      fit: @options[:image_options][:fit], #crop, scale, pad, thumb
-      f: @options[:image_options][:focus], #top, right, bottom, left, top_right, top_left, bottom_right, bottom_left, face
-      fm: @options[:image_options][:format], #jpg, png
-      bg: @options[:image_options][:background_colour], #no idea what the options are, but 'transparent' works for pngs
-      r: @options[:image_options][:corner_radius], #corner radius in px
-      q: @options[:image_options][:quality]
-    }.delete_if {|k,v| v.nil?}
-    super
-  end
 
-  def image(link, title, alt_text)
-    # add the querystring to the image
-    link += "?#{@image_parameters.to_query}"
-    # return a content tag
-    content_tag(:img, nil, src: link.to_s, alt: alt_text, title: title)
-  end
+module ContentfulRails
+  # A custom renderer for Redcarpet, which adds options for manipulating images through the URL of the image,
+  # and building links based on the content of the link.
+  #
+  # You can subclass this in your application, to add or manipulate specific markup to elements in the markdown.
+  class MarkdownRenderer < Redcarpet::Render::HTML
+    include ::ActionView::Helpers::TagHelper
+    include ::ActionView::Context
 
-end
+    def initialize(opts)
+      @options = opts
+      @image_parameters = {
+        w: @options[:image_options][:width], # width in px
+        h: @options[:image_options][:height], # height in px
+        fit: @options[:image_options][:fit], # crop, scale, pad, thumb
+        f: @options[:image_options][:focus], # top, right, bottom, left, top_right, top_left, bottom_right, bottom_left, face
+        fm: @options[:image_options][:format], # jpg, png, webp
+        bg: @options[:image_options][:background_colour], # no idea what the options are, but 'transparent' works for pngs
+        r: @options[:image_options][:corner_radius], # corner radius in px
+        q: @options[:image_options][:quality]
+      }.delete_if { |_, v| v.nil? }
+      super
+    end
+
+    # Image tag wrapper for forwarding Image API options
+    def image(link, title, alt_text)
+      # add the querystring to the image
+      if @image_parameters.present?
+        prefix = link.include?('?') ? '&' : '?'
+        link += "#{prefix}#{@image_parameters.to_query}"
+      end
+      # return a content tag
+      content_tag(:img, nil, src: link.to_s, alt: alt_text, title: title)
+    end
+  end
+end

data/lib/contentful_rails/nested_resource.rb

@@ -1,78 +1,81 @@
 module ContentfulRails
+  # Module for obtaining object references from paths
   module NestedResource
-
     def self.included(base)
       base.extend ClassMethods
     end
 
+    # Class methods for NestedResource
     module ClassMethods
       # Get a deeply-nested object from a string which represents the heirarchy.
       # The obvious use for this is to find an object from a URL
       # e.g. /grandparent/parent/child
-      # @param [Symbol] the field to search by - for example, :slug
-      # @param [String] the path as a forward-slash separated string
+      #
+      # @param field [Symbol] the field to search by - for example, :slug
+      # @param path [String] the path as a forward-slash separated string
       def get_nested_from_path_by(field, path, opts = {})
-        options = {delimiter: '/', unescape: false, prefix: ""}
+        options = { delimiter: '/', unescape: false, prefix: '' }
         options.merge!(opts)
 
         path = CGI::unescape(path) if options[:unescape]
         delimiter = options[:delimiter]
-        prefix = options[:prefix].empty? ? "" : "#{delimiter}#{options[:prefix]}#{delimiter}"
+        prefix = options[:prefix].empty? ? '' : "#{delimiter}#{options[:prefix]}#{delimiter}"
 
-        root, *children = "#{prefix}#{path}".gsub(/^\//, '').split(delimiter)
+        root, *children = "#{prefix}#{path}".gsub(%r{/^\//}, '').split(delimiter)
 
         if field.to_sym == :id
-          #we need to call find() to get by ID
+          # we need to call find() to get by ID
           root_entity = find(root)
         else
           begin
             root_entity = search(field => root).first
           rescue Contentful::BadRequest
-            #we have something which needs find_by called on it
+            # we have something which needs find_by called on it
             root_entity = find_by(field => root).first
           end
         end
 
         if root_entity && root_entity.has_children?
-          return root_entity.get_child_entity_from_path_by(field, children)
+          root_entity.get_child_entity_from_path_by(field, children)
         elsif root_entity
-          return root_entity
-        else
-          return nil
+          root_entity
         end
       end
     end
 
     # Given a field and an array of child fields, we need to recurse through them to get the last one
-    # @param [Symbol] the field we need to search for
-    # @param [Array] an array of field values to match against
+    #
+    # @param field [Symbol] the field we need to search for
+    # @param children [Array] an array of field values to match against
     # @return an entity matching this class, which is the last in the tree
     def get_child_entity_from_path_by(field, children)
       # the next child in the path
       child_value = children.shift
+
       # get the child entity
-      child = self.send(:children).find {|child| child.send(field) == child_value}
-      if child && children.size > 0
-        # we have some recursion to do - we're not at the end of the array
-        # so call this method again with a smaller set of children
-        child.get_child_entity_from_path_by(field, children)
-      else
-        return child #this is the final thing in the array - return it
-      end
+      child = send(:children).find { |c| c.send(field) == child_value }
+
+      # we have some recursion to do - we're not at the end of the array
+      # so call this method again with a smaller set of children
+      return child.get_child_entity_from_path_by(field, children) if child && !children.empty?
+
+      child # this is the final thing in the array - return it
     end
 
     # Given a field (and optional delimiter), return a path to the current object.
     # e.g. you'd end up with /path/to/page (where this object is 'page')
-    # @param [Symbol] the field to use to create the path
-    # @param [String] the delimiter to use. Defaults to "/"
+    #
+    # @param field [Symbol] the field to use to create the path
+    # @param opts [Hash] the delimiter to use. Defaults to "/"
     # @return [String] the path as a string
     def nested_path_by(field, opts = {})
-      options = {delimiter: "/", prefix: ""}
+      options = { delimiter: '/', prefix: '' }
       options.merge!(opts)
       delimiter = options[:delimiter]
-      prefix = options[:prefix].empty? ? "" : "#{options[:prefix]}#{delimiter}"
-      path = ([self] + ancestors).reverse.collect {|a| a.send(field)}.join(delimiter).gsub(prefix,"")
-      return delimiter + path
+      prefix = options[:prefix].empty? ? '' : "#{options[:prefix]}#{delimiter}"
+      path = ([self] + ancestors).reverse.collect { |a| a.send(field) }.join(delimiter).gsub(prefix, '')
+
+      delimiter + path
     end
   end
 end

data/lib/contentful_rails/preview.rb

@@ -1,14 +1,14 @@
 module ContentfulRails
+  # Module to secure preview sessions and bust cache on preview entries
   module Preview
     extend ActiveSupport::Concern
 
     included do
       before_action :check_preview_domain
       after_action :remove_preview_cache
-      if respond_to?(:helper_method)
-        helper_method :preview?
-      end
+      helper_method :preview? if respond_to?(:helper_method)
     end
+
     # Check whether the subdomain being presented is the preview domain.
     # If so, set ContentfulModel to use the preview API, and request a username / password
     def check_preview_domain
@@ -18,25 +18,29 @@ module ContentfulRails
         return
       end
 
-      #check subdomain matches the configured one - we assume it's first sub.domain.in.the.array
+      # check subdomain matches the configured one - we assume it's first sub.domain.in.the.array
       if request.subdomains.first == ContentfulRails.configuration.preview_domain
-        authenticated = authenticate_with_http_basic  do |u,p|
-          u == ContentfulRails.configuration.preview_username
-          p == ContentfulRails.configuration.preview_password
+        if ContentfulRails.configuration.preview_username.nil? && ContentfulRails.configuration.preview_password.nil?
+          ContentfulModel.use_preview_api = true
+          return
+        end
+
+        authenticated = authenticate_with_http_basic do |u, p|
+          u == ContentfulRails.configuration.preview_username &&
+            p == ContentfulRails.configuration.preview_password
         end
         # If user is authenticated, we're good to switch to the preview api
         if authenticated
           ContentfulModel.use_preview_api = true
         else
-          #otherwise ask for user / pass
-            request_http_basic_authentication
+          # otherwise ask for user / pass
+          request_http_basic_authentication
         end
       else
-        #if the subdomain doesn't match the configured one, explicitly set to false
+        # if the subdomain doesn't match the configured one, explicitly set to false
         ContentfulModel.use_preview_api = false
         return
       end
-
     end
 
     # If we're in preview mode, we need to remove the preview view caches which were created.
@@ -49,7 +53,7 @@ module ContentfulRails
     end
 
     def preview?
-      ContentfulModel.use_preview_api == true
+      ContentfulModel.use_preview_api
     end
   end
-end
+end

data/lib/contentful_rails/sluggable.rb

@@ -1,18 +1,17 @@
 module ContentfulRails
+  # A quick mixin to slugify a field other than 'slug'
+  # NOTE that if you include sluggable (and define a slug field) in a class which responds to
+  # slug() than you'll get a stack level too deep error.
   module Sluggable
     extend ActiveSupport::Concern
-    # A quick mixin to slugify a field other than 'slug'
-    # NOTE that if you include sluggable (and define a slug field) in a class which responds to
-    # slug() than you'll get a stack level too deep error.
 
     class_methods do
       attr_accessor :slug_field
     end
 
+    # Returns the slugified version of the :slug_field
     def slug
-      if self.class.slug_field.present?
-        self.send(self.class.slug_field).parameterize(ContentfulRails.configuration.slug_delimiter)
-      end
+      send(self.class.slug_field).parameterize(ContentfulRails.configuration.slug_delimiter) if self.class.slug_field.present?
     end
   end
-end
+end

data/lib/contentful_rails/version.rb

@@ -1,3 +1,4 @@
 module ContentfulRails
-  VERSION = "0.4.1"
+  # Version number
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: contentful_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
+- Contentful GmbH (David Litvak Bruno)
 - Error Creative Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +53,216 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: pry
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-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-rubocop
+  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-yard
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
 description: A gem to help with hooking Contentful into your Rails application
 email:
+- david.litvak@contentful.com
 - hosting@errorstudio.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - app/controllers/contentful_rails/webhooks_controller.rb
@@ -94,8 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A gem to help with hooking Contentful into your Rails application

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2014 Error Creative Studio
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.