rooftop-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ce7b53b614dba3b91d76917209fdd360b3074ee
-  data.tar.gz: 9b3034dca31a3d7011d635b46639e519ebb90a51
+  metadata.gz: 44f03f4480ef66da90df9283ee01437c7e24fb1f
+  data.tar.gz: 5d5bcfd4bbe1fc4d4d73ca638226bd35c04da30e
 SHA512:
-  metadata.gz: 7420b709d0dd54f2e485a87240a50e319806df71870d730d022d71529bf4a09407d1674fee1a29c2eb68b8cdea539d9e24c6451848533096f8d68d9985624f8e
-  data.tar.gz: dc72a561f64cb5e2ab552771ca5bfe61cba476117d9a39be140090cf44fb29db9b2eac4794d5750c71f12e431e7644f33037f28769a4e09f5d22fcaa4416a8e4
+  metadata.gz: 45f27bfd588ba45324abae25ee6d798faaf78a74f91237009ee838d9a2275ff37fbb4f123476d09adbe3c1e8cb7a920d407da8572d27183866995b0c15e12afc
+  data.tar.gz: a1263337fc73348789ed7f3ea001532ca0556ba706a22326f87f46f5bd03d62ff23f6daa0e90e9df312fc416a7bd5797de9474f5a6cbe0a9376882d8fda86b61

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

@@ -13,7 +13,7 @@ module Rooftop
         # By adding a call to `nested_rooftop_resource` in your controller class, the following happens:
         # - The resource model you identify has Rooftop::Rails::NestedModel mixed into it
         # - Methods for finding a model object and validating that the path is correct are added
-        # For example:
+        # @example
         #     class PagesController
         #       include Rooftop::Rails::NestedResource
         #       nested_rooftop_resource :page

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

@@ -0,0 +1,38 @@
+class Rooftop::Rails::WebhooksController < ActionController::Base
+  # if Rooftop::Rails.configuration.authenticate_webhooks
+  #   http_basic_authenticate_with  name: Rooftop::Rails.configuration.webhooks_username,
+  #                                 password: Rooftop::Rails.configuration.webhooks_password
+  # end
+
+  skip_before_filter :verify_authenticity_token, :only => [:create]
+
+  #this is where we receive a webhook, via a POST
+  def create
+    # Rooftop will POST data to this endpoint, and we can decide what to do with it.
+    # The data included in the POST is as follows:
+
+    request.format = :json
+    update_type = params[:status]
+
+    # 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("rooftop.#{update_type}", params)
+
+    #must return an ok
+    render nothing: true
+  end
+
+  def debug
+    render text: "Debug method works ok"
+  end
+
+  private
+
+  def webhook_params
+    params.permit!
+  end
+
+
+
+end

data/app/helpers/rooftop/rails/menu_helper.rb

@@ -0,0 +1,30 @@
+module Rooftop
+  module Rails
+    module MenuHelper
+
+      # Given a Rooftop::Menus::Item, return a path for it, or nil if we can't.
+      def path_for_menu_item(item)
+        begin
+          # for links elsewhere, return the url as-is
+          if item.object_type == "custom"
+            return item.url
+          end
+
+          # otherwise we need to determine if we have a nested resource
+          if item.object_ancestor_slugs.present?
+            # we have a nested tree of slugs
+            resource_id = item.object_ancestor_slugs.split(",").push(item.object_slug).join("/")
+          else
+            resource_id = item.object_slug
+          end
+
+          return Rooftop::Rails::RouteResolver.new(item.object_type, resource_id).resolve
+        rescue
+          nil
+        end
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+module Rooftop
+  module Rails
+    # This mixin adds object caching when you call find(). It overloads the find() method to cache the result, and read that instead if possible.
+    module ObjectCache
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Utility method to get the cache key for the instance.
+      def cache_key
+        "#{self.class.cache_key_base}/#{self.id}"
+      end
+
+      module ClassMethods
+
+        # Base of the cache key for this class.
+        def cache_key_base
+          "rooftop/#{self.to_s.underscore}"
+        end
+
+        # Redeclare the find() method, with caching. Only pass uncached keys to the super method.
+        def find(*ids)
+          if Rooftop::Rails.configuration.perform_object_caching
+            ids.uniq!
+            uncached_ids = ids.reject {|i| ::Rails.cache.read("#{cache_key_base}/#{i}").present?}
+            [super(*uncached_ids)].flatten.reject(&:blank?).collect do |object|
+              ::Rails.logger.debug("Caching #{cache_key_base}/#{object.id}")
+              ::Rails.cache.write(object.cache_key,object)
+            end
+            all_objects = ids.collect do |id|
+              ::Rails.cache.read("#{cache_key_base}/#{id}")
+            end
+
+            all_objects.length == 1 ? all_objects.first : all_objects
+          else
+            super
+          end
+        end
+
+        def where(args)
+          #Sort the arguments, and any keys which are arrays
+          args = Hash[args.sort.each {|k,v| v.sort! if v.is_a?(Array)}]
+          # Generate a hash for keying the cache of the results
+          args_hash = Digest::MD5.hexdigest(args.to_s)
+          cache_key = "#{cache_key_base}/collection_query/#{args_hash}"
+          # first see if we have a collection which matches the args
+          cached_collection = ::Rails.cache.read(cache_key)
+          # if it's present, then we can return it directly.
+          if cached_collection.present?
+            return cached_collection
+          else
+            # If not, then we need to call super() to get it from the API
+            collection = super(args)
+            # and write it into the cache
+            ::Rails.cache.write(cache_key,collection)
+            # We also iterate over the collection and cache each object, and cache the argument hash against each object
+            collection.each do |object|
+              # This is a bit funky and circular. We store an array of hashes for queries to which this object belongs.
+              # If the object cache needs to be removed, we can iterate through those hashes and clear the collection caches too.
+              collection_query_hash_key = "#{object.cache_key}/collection_hashes"
+              collection_hashes = ::Rails.cache.read(collection_query_hash_key) || []
+              collection_hashes << args_hash
+              ::Rails.cache.write(collection_query_hash_key, collection_hashes)
+              # this is the object cache - i.e. it'll respond with a cache lookup for Page.find(14) or whatever
+              ::Rails.cache.write(object.cache_key,object)
+            end
+            collection
+          end
+        end
+
+        # A method to expire the relevant caches for a collection of objects or ids
+        # @param args [Array] of either objects which respond to `.id`, or ids themselves
+        def expire_cache_for(*args)
+          args = args.collect {|a| a.respond_to?(:id) ? a.id : a}
+          # the caches we need to clear are:
+          # - the object cache
+          # - any collection caches which included this object
+          args.each do |id|
+            object_cache_key = "#{cache_key_base}/#{id}"
+            collection_keys = (::Rails.cache.read("#{object_cache_key}/collection_hashes") || []).collect do |hash|
+              "#{cache_key_base}/collection_query/#{hash}"
+            end
+            collection_keys << "#{object_cache_key}/collection_hashes"
+            [collection_keys + [object_cache_key]].flatten.each do |key|
+              ::Rails.cache.delete(key)
+            end
+
+          end
+
+
+        end
+
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,4 +1,4 @@
-Rails.application.routes.draw do
+Rooftop::Rails::Engine.routes.draw do
   resources :webhooks, only: [:create], defaults: { format: :json } do
     collection do
       scope constraints: Rooftop::Rails::DevelopmentConstraint do

data/lib/rooftop/rails.rb

@@ -27,7 +27,8 @@ module Rooftop
                     :preview_password,
                     :preview_domain,
                     :enable_preview_domain,
-                    :perform_caching,
+                    :perform_http_response_caching,
+                    :perform_object_caching,
                     :cache_store,
                     :cache_logger,
                     :ssl_options,
@@ -36,7 +37,8 @@ module Rooftop
 
       def initialize
         @authenticate_webhooks = true
-        @perform_caching = ::Rails.configuration.action_controller.perform_caching
+        @perform_http_response_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

@@ -18,7 +18,7 @@ module Rooftop
           config.advanced_options = Rooftop::Rails.configuration.advanced_options
           config.api_path = Rooftop::Rails.configuration.api_path
           config.url = Rooftop::Rails.configuration.url || "https://#{config.site_name}.rooftopcms.io"
-          config.perform_caching = Rooftop::Rails.configuration.perform_caching
+          config.perform_caching = Rooftop::Rails.configuration.perform_http_response_caching
           config.cache_store = Rooftop::Rails.configuration.cache_store
           config.cache_logger = Rooftop::Rails.configuration.cache_logger
           config.ssl_options = Rooftop::Rails.configuration.ssl_options
@@ -35,6 +35,26 @@ module Rooftop
       initializer "add_helpers" do
         ActiveSupport.on_load(:action_view) do
           include Rooftop::Rails::ContentHelper
+          include Rooftop::Rails::MenuHelper
+        end
+      end
+
+      initializer "add_caching_to_rooftop_models" do
+        ::Rails.application.eager_load!
+        Rooftop::Base.included_classes.each do |klass|
+          klass.send(:include, Rooftop::Rails::ObjectCache)
+        end
+      end
+
+      initializer "clear_caches_on_webhook_notification" do
+        ActiveSupport::Notifications.subscribe(/rooftop.*/) do |name, start, finish, id, payload|
+          content_type = payload[:type]
+          if Rooftop.configuration.post_type_mapping[content_type].present?
+            klass = Rooftop.configuration.post_type_mapping[content_type]
+          else
+            klass = content_type.classify.constantize
+          end
+          klass.send(:expire_cache_for, payload[:id])
         end
       end
     end

data/lib/rooftop/rails/version.rb

@@ -1,5 +1,5 @@
 module Rooftop
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooftop-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Error Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-28 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.5
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 description: This gem provides utility methods and a mountable engine for Rails applications
   using the Rooftop gem
 email:
@@ -76,10 +76,11 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - app/controllers/concerns/rooftop/rails/nested_resource.rb
-- app/controllers/rooftop_rails/webhooks_controller.rb
+- app/controllers/rooftop/rails/webhooks_controller.rb
 - app/helpers/rooftop/rails/content_helper.rb
-- app/helpers/rooftop/webhooks_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
 - config/routes.rb
 - lib/rooftop/rails.rb
 - lib/rooftop/rails/development_constraint.rb

data/app/controllers/rooftop_rails/webhooks_controller.rb

@@ -1,5 +0,0 @@
-class Rooftop::Rails::WebhooksController < ::ApplicationController
-  def create
-    return render text: "CREATE"
-  end
-end

data/app/helpers/rooftop/webhooks_helper.rb

@@ -1,2 +0,0 @@
-module Rooftop::Rails::WebhooksHelper
-end