rooftop-rails 0.0.6.4 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c763b6f784a114983b3477ba471e1ae4192c4d7
-  data.tar.gz: 052fd96a5732b5af07af3f7d85c7a8a385f6c21e
+  metadata.gz: 999a8685afdfab12db176b020b83f959868fce71
+  data.tar.gz: 525946c0293c90ef21824651362949ed3747597b
 SHA512:
-  metadata.gz: de633ef360fa5634eaf35a14b834074d76167cb8e34329e50fb4dfcb9b34bb742e51c5e6f734f5a6f9d78612e6e79b53fb73bb9e4966dcef3b7df50ff01e81ee
-  data.tar.gz: 6822909f77f6c4973fd1838a79cab5cf8f353ef0f2a2152e021accfd3db7a31af8a9689f1eee22c2971f6c864eaad97e2800a9e4248345747e034d48357ed1bf
+  metadata.gz: 12d8a8a7b2485ba1e1adaa73c4d0a66a41f57b2035b0c779fc5ac0b8b446a99f17fa649c55b8a2ed13f082929bd3e332fc626e6510b1bfc17a05020fd1499cf1
+  data.tar.gz: 17369a9d432389976470c3c5ea77273bee5ea4624e96835b930c854480786655c074b69e6198f01316a91c6bb0e9e4fd0af4204a4d26aaffdbbc94b22098c867

data/app/controllers/concerns/rooftop/rails/preview.rb

@@ -0,0 +1,24 @@
+module Rooftop
+  module Rails
+    # A controller mixin with utility methods for handling previews. This presupposes you're using the mounted Rooftop::Rails::PreviewController to receive POST requests for previews from Rooftop.
+    module Preview
+
+      def self.included(base)
+        base.send(:before_action, -> {
+          if preview?
+            Rooftop.include_drafts = true
+          else
+            Rooftop.include_drafts = false
+          end
+
+        })
+      end
+
+      def preview?
+        params[:preview].present? && session[:preview].present? && params[:preview] == session[:preview]["secret"]
+      end
+    end
+  end
+end
+
+

data/app/controllers/rooftop/rails/preview_controller.rb

@@ -0,0 +1,38 @@
+class Rooftop::Rails::PreviewController < ActionController::Base
+  skip_before_filter :verify_authenticity_token, :only => [:create]
+
+  #this is where we receive a message from Rooftop via a POST
+  def create
+    raise Rooftop::Content::PreviewKeyMissingError, "You need to POST a preview key" unless params[:preview_key].present?
+    session.delete(:preview)
+    # Rooftop will POST data to this endpoint
+    Rooftop.include_drafts = true
+
+    request.format = :json
+    session[:preview] = {
+      secret: Digest::SHA256.hexdigest(params[:preview_key]),
+      key: params[:preview_key]
+    }
+    item = Rooftop::Rails::PostTypeResolver.new(params[:post_type]).resolve.find(params[:id])
+    slug = item.respond_to?(:nested_path) ? item.nested_path : item.slug
+    if item.preview_key_matches?(params[:preview_key])
+      redirect_path = Rooftop::Rails::RouteResolver.new(params[:post_type].to_sym, slug).resolve(preview: session[:preview][:secret])
+      if redirect_path.nil?
+        raise ActionController::RoutingError, "Couldn't find a route to preview this post type"
+      else
+        redirect_to redirect_path
+      end
+    else
+      raise Rooftop::Content::PreviewKeyMismatchError, "The preview key received doesn't match the key in Rooftop"
+    end
+  end
+
+  private
+
+  def preview_params
+    params.permit!
+  end
+
+
+
+end

data/app/models/concerns/rooftop/rails/object_cache.rb

@@ -11,6 +11,12 @@ module Rooftop
         "#{self.class.cache_key_base}/#{self.id}"
       end
 
+      def expire_cache!
+        self.class.send(:expire_cache_for, self)
+      end
+
+      alias_method :expire!, :expire_cache!
+
       module ClassMethods
 
         # Base of the cache key for this class.

data/app/models/concerns/rooftop/rails/preview_model.rb

@@ -0,0 +1,16 @@
+module Rooftop
+  module Rails
+    module PreviewModel
+      include ActiveSupport::Concern
+
+      # Call the preview() method defined in Rooftop, but expire the cache afterwards
+      def preview
+        # super here is defined in Rooftop::Preview#preview()
+        preview = super
+        # expire is defined in Rooftop::Rails::ObjectCache#expire!
+        preview.expire!
+        return preview
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -6,4 +6,6 @@ Rooftop::Rails::Engine.routes.draw do
       end
     end
   end
+
+  resources :preview, only: [:create], defaults: { format: :json }
 end

data/lib/rooftop/rails.rb

@@ -23,12 +23,7 @@ module Rooftop
                     :authenticate_webhooks,
                     :webhooks_username,
                     :webhooks_password,
-                    :preview_username,
-                    :preview_password,
-                    :preview_domain,
-                    :enable_preview_domain,
                     :perform_http_response_caching,
-                    :perform_object_caching,
                     :cache_store,
                     :cache_logger,
                     :logger,
@@ -37,10 +32,22 @@ module Rooftop
                     :resource_route_map,
                     :post_type_mapping
 
+      def perform_object_caching=(perform_caching)
+        if perform_caching.is_a?(Proc)
+          @perform_object_caching = perform_caching
+        else
+          @perform_object_caching = ->{perform_caching}
+        end
+      end
+
+      def perform_object_caching
+        @perform_object_caching.call
+      end
+
       def initialize
         @authenticate_webhooks = true
         @perform_http_response_caching = ::Rails.configuration.action_controller.perform_caching
-        @perform_object_caching = ::Rails.configuration.action_controller.perform_caching
+        @perform_object_caching = ->{::Rails.configuration.action_controller.perform_caching}
         @cache_store = ::Rails.cache
         @cache_logger = ::Rails.logger
         @ssl_options = {}

data/lib/rooftop/rails/engine.rb

@@ -50,6 +50,13 @@ module Rooftop
         end
       end
 
+      initializer "add_preview_to_rooftop_models" do
+        ::Rails.application.eager_load!
+        Rooftop::Base.included_classes.each do |klass|
+          klass.send(:include, Rooftop::Rails::PreviewModel)
+        end
+      end
+
       initializer "clear_caches_on_webhook_notification" do
         ActiveSupport::Notifications.subscribe(/rooftop.*/) do |name, start, finish, id, payload|
           Rooftop::Rails::CacheExpirer.expire(payload)

data/lib/rooftop/rails/version.rb

@@ -1,5 +1,5 @@
 module Rooftop
   module Rails
-    VERSION = "0.0.6.4"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooftop-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6.4
+  version: 0.1.3
 platform: ruby
 authors:
 - Error Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.1.0
 description: This gem provides utility methods and a mountable engine for Rails applications
   using the Rooftop gem
 email:
@@ -76,11 +76,14 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - app/controllers/concerns/rooftop/rails/nested_resource.rb
+- app/controllers/concerns/rooftop/rails/preview.rb
+- app/controllers/rooftop/rails/preview_controller.rb
 - app/controllers/rooftop/rails/webhooks_controller.rb
 - app/helpers/rooftop/rails/content_helper.rb
 - app/helpers/rooftop/rails/menu_helper.rb
 - app/models/concerns/rooftop/rails/nested_model.rb
 - app/models/concerns/rooftop/rails/object_cache.rb
+- app/models/concerns/rooftop/rails/preview_model.rb
 - config/routes.rb
 - lib/generators/rooftop/rooftop_generator.rb
 - lib/generators/rooftop/templates/initializer.rb.erb
@@ -90,7 +93,6 @@ files:
 - lib/rooftop/rails/engine.rb
 - lib/rooftop/rails/errors.rb
 - lib/rooftop/rails/post_type_resolver.rb
-- lib/rooftop/rails/preview.rb
 - lib/rooftop/rails/route_resolver.rb
 - lib/rooftop/rails/version.rb
 - test/controllers/rooftop_rails/webhooks_controller_test.rb

data/lib/rooftop/rails/preview.rb

@@ -1,53 +0,0 @@
-module Rooftop::Rails
-  module Preview
-    extend ActiveSupport::Concern
-
-    included do
-      before_action :check_preview_domain
-      after_action :remove_preview_cache
-      helper_method :preview?
-    end
-    # Check whether the subdomain being presented is the preview domain.
-    # If so, set Rooftop to add the preview header
-    def check_preview_domain
-      # If enable_preview_domain is not enabled, explicitly set use_preview_api false and return
-      unless Rooftop::Rails.configuration.enable_preview_domain
-        Rooftop.preview = false
-        return
-      end
-
-      #check subdomain matches the configured one - we assume it's first sub.domain.in.the.array
-      if request.subdomains.first == Rooftop::Rails.configuration.preview_domain
-        authenticated = authenticate_with_http_basic  do |u,p|
-          u == Rooftop::Rails.configuration.preview_username
-          p == Rooftop::Rails.configuration.preview_password
-        end
-        # If user is authenticated, we're good to switch to the preview api
-        if authenticated
-          Rooftop.preview = true
-        else
-          #otherwise ask for user / pass
-          request_http_basic_authentication
-        end
-      else
-        #if the subdomain doesn't match the configured one, explicitly set to false
-        Rooftop.preview = false
-        return
-      end
-
-    end
-
-    # If we're in preview mode, we need to remove the preview view caches which were created.
-    # this is a bit of a hack but it's probably not feasible to turn off caching in preview mode.
-    def remove_preview_cache
-      # in preview mode, we alias_method_chain the cache_key method on Rooftop::Base to append 'preview/'
-      # to the front of the key.
-      return unless request.subdomain == Rooftop::Rails.configuration.preview_domain
-      expire_fragment(%r{.*/preview/.*})
-    end
-
-    def preview?
-      Rooftop.preview == true
-    end
-  end
-end