rooftop-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b80eb9aa0ca54ecdd1b5e48e97317d57879ecf1f
-  data.tar.gz: 0b3cc153eec7c9b28f2b6348d8f3a042a1e601e9
+  metadata.gz: 0ce7b53b614dba3b91d76917209fdd360b3074ee
+  data.tar.gz: 9b3034dca31a3d7011d635b46639e519ebb90a51
 SHA512:
-  metadata.gz: 72ee68d6c0a743a63ad16e622cfa9340bb1f3be2c56830fd46ed2648ac91be5d4577c3b17a832d26772e19a3b353d5ee6dab764aa8843f6443b1203bb9f7b2c4
-  data.tar.gz: 2be3d3a56377202414c237d640497a0c546c1111eda3c9068aaa4584cb0b1f90d7806b0683c7a59a092ddb513b1be5dab8dd5fb5f322432fb9dc1494584e3dc9
+  metadata.gz: 7420b709d0dd54f2e485a87240a50e319806df71870d730d022d71529bf4a09407d1674fee1a29c2eb68b8cdea539d9e24c6451848533096f8d68d9985624f8e
+  data.tar.gz: dc72a561f64cb5e2ab552771ca5bfe61cba476117d9a39be140090cf44fb29db9b2eac4794d5750c71f12e431e7644f33037f28769a4e09f5d22fcaa4416a8e4

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

@@ -0,0 +1,65 @@
+module Rooftop
+  module Rails
+    # A controller mixin which can load a resource from a nested path. Useful mostly for pages.
+    # The mixin defines some dynamic instance methods on the controller, and a class method to define the name of the model you want to load.
+    module NestedResource
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        attr_reader :resource_name, :resource_class
+        # A class method defined on the controller which gives you an easy way to find a resource from a deeply-nested path, and optionally check that the path provided is correct.
+        # 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:
+        #     class PagesController
+        #       include Rooftop::Rails::NestedResource
+        #       nested_rooftop_resource :page
+        #       before_action :find_and_validate_page, except: :index
+        #     end
+        #
+        # Note that the methods on the controller are dynamically named according to the resource name - i.e. find_and_validate_page in this case.
+        # You need to set up your routes so that a single param called `nested_path` is passed to this controller for any methods you're calling `find_and_validate_page` on, for example:
+        # match "/*nested_path", via: [:get], to: "pages#show"
+        # This is a greedy route so you probably want it at the bottom.
+        def nested_rooftop_resource(resource)
+          @resource_name = resource
+          @resource_class = resource.to_s.classify.constantize
+          @resource_class.send(:include, Rooftop::Rails::NestedModel)
+
+          # Set up the dynamically-named find_[resource name]
+          define_method "find_#{@resource_name}" do
+            respond_to do |format|
+              format.html do
+                resource = self.class.resource_class.send(:find_by_nested_path, params[:nested_path])
+                instance_variable_set("@#{self.class.resource_name}",resource)
+              end
+              format.all do
+                raise ActionController::RoutingError, "Not found: #{request.original_fullpath}"
+              end
+            end
+
+          end
+          # Set up the dynamically-named validate_[resource name]
+          define_method "validate_#{@resource_name}" do
+            resource = instance_variable_get("@#{self.class.resource_name}")
+            if resource.nested_path != params[:nested_path]
+              raise Rooftop::Rails::AncestorMismatch, "The #{self.class.resource_name} you requested has a different path"
+            end
+          end
+          # Set up the dynamically-named find_and_validate_[resource name]
+          # (this is a utility method to call the two above)
+          define_method "find_and_validate_#{@resource_name}" do
+            send(:"find_#{self.class.resource_name}")
+            send(:"validate_#{self.class.resource_name}")
+          end
+        end
+      end
+
+
+
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Rooftop
+  module Rails
+    # A mixin helper to make it easier to deal with content coming out of Rooftop.
+    # For example, rendering relative links in the context of your application.
+    module ContentHelper
+
+      # Parse content and replace links from Rooftop with links to your resources.
+      # We introspect your routes using Rooftop::Rails::RouteResolver, which also gives you scope for
+      # manually overriding something, by setting Rooftop::Rails.configuration.resource_route_mapping.
+      # See the readme for more info.
+
+      # @param content [String] the content you want to parse, e.g. an html field from Rooftop.
+      # @return [String] the HTML, parsed to point to your URL structure.
+      def parse_links(content)
+        _fragment = Nokogiri::HTML.fragment(content, 'UTF-8')
+        _fragment.css("a[data-rooftop-link-type]").each do |a|
+          # build up the slug path for the resource we're linking to
+          if a['data-rooftop-link-ancestor-slugs'] #we have a nested resource, we need to build up the slug path
+            path = a['data-rooftop-link-ancestor-slugs'].split(",").push(a['data-rooftop-link-slug'])
+            resource_id = path.join("/")
+          else
+            resource_id = a['data-rooftop-link-slug']
+          end
+
+          a['href'] = Rooftop::Rails::RouteResolver.new(a['data-rooftop-link-type'], resource_id).resolve
+        end
+        _fragment.to_html
+      end
+
+      def parse_content(content)
+        parse_links(content).html_safe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Rooftop
+  module Rails
+
+    # This module adds methods for finding by a nested path of slugs, and generating a
+    # nested path of slugs
+    module NestedModel
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Get a model from a nested path. Assumes `slug` is the field you'll be finding by.
+        # Accepts options for the path delimiter and whether you want to unescape url strings
+
+        # @param path [String] the path - the last of which will be the thing we find
+        # @param opts [Hash] options - path delimiter and unescape
+        # @return object [Object] an instance of the class this is mixed into
+        def find_by_nested_path(path, opts = {})
+          options = {delimiter: '/', unescape: false}
+          options.merge!(opts)
+          path = CGI::unescape(path) if options[:unescape]
+          delimiter = options[:delimiter]
+          slug = "#{options[:prefix]}#{path}".gsub(/^\//, '').split(delimiter).last
+          entity = where(slug: slug).first
+          if entity.nil?
+            raise Rooftop::RecordNotFoundError, "Couldn't find #{self} with slug #{slug}"
+          else
+            return entity
+          end
+        end
+      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 "/"
+      # @return [String] the path as a string
+      def nested_path(opts = {})
+        options = {delimiter: "/", prefix: ""}
+        options.merge!(opts)
+        delimiter = options[:delimiter]
+        prefix = options[:prefix].empty? ? "" : "#{options[:prefix]}#{delimiter}"
+        path = ([slug] + ancestors.collect(&:slug)).reverse.join(delimiter).gsub(prefix,"")
+        return path
+      end
+    end
+  end
+end
+
+
+

data/lib/rooftop/rails.rb

@@ -1,8 +1,6 @@
 require 'rooftop'
-
-require "rooftop/rails/engine"
-require "rooftop/rails/development_constraint"
-require "rooftop/rails/preview"
+require 'require_all'
+require_rel '.'
 
 module Rooftop
   module Rails
@@ -25,15 +23,24 @@ module Rooftop
                     :authenticate_webhooks,
                     :webhooks_username,
                     :webhooks_password,
-                    :perform_caching,
                     :preview_username,
                     :preview_password,
                     :preview_domain,
-                    :enable_preview_domain
+                    :enable_preview_domain,
+                    :perform_caching,
+                    :cache_store,
+                    :cache_logger,
+                    :ssl_options,
+                    :proxy,
+                    :resource_route_map
 
       def initialize
         @authenticate_webhooks = true
         @perform_caching = ::Rails.configuration.action_controller.perform_caching
+        @cache_store = ::Rails.cache
+        @cache_logger = ::Rails.logger
+        @ssl_options = {}
+        @resource_route_map = {}
       end
     end
   end

data/lib/rooftop/rails/engine.rb

@@ -17,7 +17,12 @@ module Rooftop
           config.extra_headers = Rooftop::Rails.configuration.extra_headers
           config.advanced_options = Rooftop::Rails.configuration.advanced_options
           config.api_path = Rooftop::Rails.configuration.api_path
-          config.url = Rooftop::Rails.configuration.url || "http://#{config.site_name}.rooftopcms.io"
+          config.url = Rooftop::Rails.configuration.url || "https://#{config.site_name}.rooftopcms.io"
+          config.perform_caching = Rooftop::Rails.configuration.perform_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
+          config.proxy = Rooftop::Rails.configuration.proxy
         end
       end
 
@@ -26,6 +31,12 @@ module Rooftop
           include Rooftop::Rails::Preview
         end
       end
+
+      initializer "add_helpers" do
+        ActiveSupport.on_load(:action_view) do
+          include Rooftop::Rails::ContentHelper
+        end
+      end
     end
   end
 end

data/lib/rooftop/rails/errors.rb

@@ -0,0 +1,5 @@
+module Rooftop
+  module Rails
+    class AncestorMismatch < StandardError; end
+  end
+end

data/lib/rooftop/rails/route_resolver.rb

@@ -0,0 +1,34 @@
+module Rooftop
+  module Rails
+    # A class to generate a proper rails route for Rooftop resources.
+    #
+    # You can configure a custom route in Rooftop::Rails::Configuration.resource_route_map. If you don't,
+    # this class will introspect the Rails routes to try and guess. Otherwise it'll return nothing.
+    class RouteResolver
+      # Create the route resolver, with a type (post, page, whatever) and an optional ID
+      attr_accessor :type, :id
+      def initialize(type, id=nil)
+        @type = type.to_sym
+        @id = id
+      end
+
+      def resolve
+        route_config = Rooftop::Rails.configuration.resource_route_map
+        resource_key = @id.nil? ? @type.to_s.pluralize.to_sym : @type
+        if route_config[resource_key]
+          return route_config[resource_key].try(:call,@id)
+        else
+          begin
+            route_info = ::Rails.application.routes.named_routes[resource_key].defaults
+            route_info.reverse_merge!(id: @id) unless @id.nil?
+            ::Rails.application.routes.url_helpers.url_for(route_info.merge(only_path: true))
+          rescue
+            nil
+          end
+        end
+      end
+
+
+    end
+  end
+end

data/lib/rooftop/rails/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rooftop-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Error Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -24,20 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rooftop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 description: This gem provides utility methods and a mountable engine for Rails applications
   using the Rooftop gem
 email:
@@ -47,13 +75,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
+- app/controllers/concerns/rooftop/rails/nested_resource.rb
 - app/controllers/rooftop_rails/webhooks_controller.rb
-- app/helpers/rooftop_rails/webhooks_helper.rb
+- app/helpers/rooftop/rails/content_helper.rb
+- app/helpers/rooftop/webhooks_helper.rb
+- app/models/concerns/rooftop/rails/nested_model.rb
 - config/routes.rb
 - lib/rooftop/rails.rb
 - lib/rooftop/rails/development_constraint.rb
 - lib/rooftop/rails/engine.rb
+- lib/rooftop/rails/errors.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
 - test/dummy/README.rdoc