sinicum 0.5.0

data/lib/sinicum/jcr/node_initializer.rb

@@ -0,0 +1,16 @@
+module Sinicum
+  module Jcr
+    # Responsible for Initializing a node based on the nodes' JSON data with the
+    # correct class.
+    class NodeInitializer
+      def self.initialize_node_from_json(json)
+        node = nil
+        TypeTranslator.list.each do |translator|
+          node = translator.initialize_node(json)
+          break if node
+        end
+        node
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/node_queries.rb

@@ -0,0 +1,101 @@
+require 'multi_json'
+
+module Sinicum
+  module Jcr
+    module NodeQueries
+      PATH_DELIMITER = '/'
+      UUID_PREFIX = "_uuid"
+      BINARY_PREFIX = "_binary"
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        include Sinicum::Logger
+        include ApiClient
+        include QuerySanitizer
+
+        def find_by_path(workspace, path)
+          url = construct_url(workspace, nil, path)
+          return_first_item(url)
+        end
+
+        def find_by_uuid(workspace, uuid)
+          url = construct_url(workspace, UUID_PREFIX, uuid)
+          return_first_item(url)
+        end
+
+        def query(workspace, language, query, parameters = nil, options = {})
+          url = "/#{workspace}/_query"
+          sanitized = sanitize_query(language, query, parameters)
+          api_hash = { "query" => sanitized, "language" => language.to_s }
+          api_hash["limit"] = options[:limit] if options[:limit]
+          api_hash["offset"] = options[:offset] if options[:offset]
+          response = api_get(url, api_hash)
+          from_rest_response(response)
+        end
+
+        def stream_attribute(workspace, path, property_name, output)
+          connection = ApiQueries.http_client.get_async(
+            ApiQueries.jcr_configuration.base_url + construct_url(workspace, BINARY_PREFIX, path),
+            "property" => property_name)
+          response = connection.pop
+          while result = response.content.read(256)
+            output.write(result)
+          end
+        end
+
+        private
+
+        def return_first_item(url)
+          response = api_get(url)
+          nodes = from_rest_response(response)
+          result = nodes
+          result = nodes.first if nodes && nodes.is_a?(Array)
+          result
+        end
+
+        def from_rest_response(result)
+          if result.status == 200
+            instances = create_instances(result.body)
+            return instances
+          elsif result.status == 404
+            return
+          elsif result.status == 500
+            message = "Error fetching content"
+            begin
+              if result.headers["Content-Type"] =~ /application\/json/
+                message << ": #{MultiJson.load(result.body)["message"]}"
+              end
+            rescue
+              # nothing
+            end
+            fail message
+          end
+          the_status = result ? result.status : "undefined"
+          fail "Error fetching JCR content object. Server status: #{the_status}"
+        end
+
+        def create_instances(body)
+          instances = []
+          json = MultiJson.load(body)
+          if json.is_a?(Array)
+            json.each do |node|
+              instance = NodeInitializer.initialize_node_from_json(node)
+              instances << instance if instance
+            end
+          else
+            instance = NodeInitializer.initialize_node_from_json(json)
+            instances << instance if instance
+          end
+          instances
+        end
+
+        def construct_url(workspace, action, path)
+          fail "JCR access is not configured" unless ApiQueries.jcr_configuration
+          action = PATH_DELIMITER + action if action && action[0] && action[0] != PATH_DELIMITER
+          path = PATH_DELIMITER + path if path && path[0] && path[0] != PATH_DELIMITER
+          "/#{workspace}#{action}#{path}"
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/query_sanitizer.rb

@@ -0,0 +1,24 @@
+module Sinicum
+  module Jcr
+    module QuerySanitizer
+      private
+
+      def sanitize_query(language, query, parameters = nil)
+        return query unless parameters && parameters.size > 0
+
+        base_query = query.to_s.dup
+        parameters.each_key do |key|
+          original_value = parameters[key]
+          san_value = escape_for_query(original_value)
+          key_pattern = ":#{key}"
+          base_query.gsub!(key_pattern, san_value)
+        end
+        base_query
+      end
+
+      def escape_for_query(unsafe_string)
+        unsafe_string.gsub('\'', '\'\'')
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/type_translator.rb

@@ -0,0 +1,38 @@
+module Sinicum
+  module Jcr
+    # Public: Manages TypeTranslators in a Rails Middleware inspired way.
+    #
+    # A TypeTranslator is a class that translates the information on a node
+    # given by the node's JSON representation in a class that will be
+    # initialized with the node's data.
+    # Please note, that DefaultTranslator should always be the last translator in
+    # the array.
+    class TypeTranslator
+      DEFAULT_TRANSLATORS = [
+        Sinicum::Jcr::TypeTranslators::DataTranslator,
+        Sinicum::Jcr::TypeTranslators::DamTranslator,
+        Sinicum::Jcr::TypeTranslators::ComponentTranslator,
+        Sinicum::Jcr::TypeTranslators::DefaultTranslator]
+
+      def self.use(clazz)
+        translators.insert(0, clazz)
+      end
+
+      def self.list
+        translators
+      end
+
+      def self.clear
+        @translators = []
+      end
+
+      def self.reset
+        @translators = DEFAULT_TRANSLATORS.dup
+      end
+
+      def self.translators
+        @translators ||= DEFAULT_TRANSLATORS.dup
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/type_translators/component_translator.rb

@@ -0,0 +1,28 @@
+module Sinicum
+  module Jcr
+    module TypeTranslators
+      # Public: Identifies a node as a `mgnl:page` or `mgnl:component` and finds
+      # the class based on the node's template information.
+      class ComponentTranslator
+        include TranslatorBase
+
+        PAGE_TYPE = "mgnl:page"
+        COMPONENT_TYPE = "mgnl:component"
+
+        def self.initialize_node(json)
+          if valid_json?(json) &&
+              (jcr_primary_type(json) == PAGE_TYPE || jcr_primary_type(json) == COMPONENT_TYPE)
+            instance_from_template_name(json)
+          end
+        end
+
+        def self.instance_from_template_name(json)
+          class_name = split_template_parts(json).join("/").classify
+          class_name.constantize.new(json_response: json)
+        rescue NameError
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/type_translators/dam_translator.rb

@@ -0,0 +1,33 @@
+module Sinicum
+  module Jcr
+    module TypeTranslators
+      # Public: Identifies files stored in Magnolia's DAM workspace as Dam::Document
+      # or Dam::Image types.
+      class DamTranslator
+        include TranslatorBase
+
+        DOCUMENT_NODE = "jcr:content"
+        IMAGE_TYPE_PREFIX = "image/"
+        MIME_TYPE = "jcr:mimeType"
+
+        WORKSPACE = "dam"
+        NODE_TYPE = "mgnl:asset"
+
+        def self.initialize_node(json)
+          if jcr_primary_type(json) && workspace(json) == WORKSPACE &&
+              jcr_primary_type(json) == NODE_TYPE
+            if json[NODES][DOCUMENT_NODE]
+              if json[NODES][DOCUMENT_NODE][PROPERTIES] &&
+                  json[NODES][DOCUMENT_NODE][PROPERTIES][MIME_TYPE] &&
+                  json[NODES][DOCUMENT_NODE][PROPERTIES][MIME_TYPE].index(IMAGE_TYPE_PREFIX) == 0
+                ::Sinicum::Jcr::Dam::Image.new(json_response: json)
+              else
+                ::Sinicum::Jcr::Dam::Document.new(json_response: json)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/type_translators/data_translator.rb

@@ -0,0 +1,31 @@
+module Sinicum
+  module Jcr
+    module TypeTranslators
+      # Public: Identifies nodes in the data module and assigns the matching
+      # classes to them.
+      class DataTranslator
+        include TranslatorBase
+        DEFAULT_TYPES = ["mgnl:content", "mgnl:contentNode"]
+
+        WORKSPACE = "data"
+
+        def self.initialize_node(json)
+          if workspace(json) == WORKSPACE && jcr_primary_type(json) && no_default_type?(json)
+            instance_from_primary_type(json)
+          end
+        end
+
+        def self.no_default_type?(json)
+          !DEFAULT_TYPES.include?(jcr_primary_type(json))
+        end
+
+        def self.instance_from_primary_type(json)
+          clazz = jcr_primary_type(json).classify
+          clazz.constantize.new(json_response: json)
+        rescue NameError
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/type_translators/default_translator.rb

@@ -0,0 +1,13 @@
+module Sinicum
+  module Jcr
+    module TypeTranslators
+      # Public: Identifies all nodes as belonging to the `Node` class. Should be
+      # used as the last TypeTranslator in a chain.
+      class DefaultTranslator
+        def self.initialize_node(json)
+          ::Sinicum::Jcr::Node.new(json_response: json)
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/jcr/type_translators/translator_base.rb

@@ -0,0 +1,40 @@
+module Sinicum
+  module Jcr
+    module TypeTranslators
+      module TranslatorBase
+        extend ActiveSupport::Concern
+
+        META_NODE = "meta"
+        NODES = "nodes"
+        PROPERTIES = "properties"
+        PRIMARY_TYPE = "jcr:primaryType"
+        MGNL_TEMPLATE = "mgnl:template"
+        WORKSPACE = "workspace"
+
+        protected
+
+        module ClassMethods
+          def split_template_parts(json)
+            mgnl_template(json).gsub('-', '_').split(":")
+          end
+
+          def jcr_primary_type(json)
+            json[META_NODE][PRIMARY_TYPE] if json[META_NODE]
+          end
+
+          def workspace(json)
+            json[META_NODE][WORKSPACE]
+          end
+
+          def mgnl_template(json)
+            json[META_NODE][MGNL_TEMPLATE] if json[META_NODE] && json[META_NODE][MGNL_TEMPLATE]
+          end
+
+          def valid_json?(json)
+            jcr_primary_type(json) && mgnl_template(json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/logger.rb

@@ -0,0 +1,28 @@
+module Sinicum
+  module Logger
+    require 'logger'
+    @@logger = ::Logger.new(STDOUT)
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def logger
+      if defined?(Rails) && Rails.logger
+        return Rails.logger
+      else
+        return @@logger
+      end
+    end
+
+    module ClassMethods
+      def logger
+        if defined?(Rails) && Rails.logger
+          return Rails.logger
+        else
+          return @@logger
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/navigation/default_navigation_element.rb

@@ -0,0 +1,30 @@
+module Sinicum
+  module Navigation
+    # Public: Standard implementation for the navigation.
+    #
+    # Expects the pages in the repository to provide the following attributes:
+    #
+    # nav_title    - The title of the page that should be used specifically
+    #                for the navigation.
+    # title        - The normal title of the page. Used for the navigation as
+    #                well if `nav_title` is not present.
+    # nav_hidden   - Checkbox-based attribute that indicates if the page
+    #                should not show up in the navigation.
+    class DefaultNavigationElement
+      include NavigationElement
+      DEFAULT_PROPERTIES = %w(title nav_title nav_hidden)
+
+      def title
+        @properties["nav_title"].presence || @properties["title"]
+      end
+
+      def self.navigation_properties
+        DEFAULT_PROPERTIES
+      end
+
+      def self.filter_node(json_element)
+        !!(json_element["properties"] && json_element["properties"]["nav_hidden"] == true)
+      end
+    end
+  end
+end

data/lib/sinicum/navigation/navigation_element.rb

@@ -0,0 +1,39 @@
+module Sinicum
+  module Navigation
+    module NavigationElement
+      extend ActiveSupport::Concern
+
+      attr_reader :uuid, :path, :depth, :properties, :children
+
+      def initialize(uuid, path, depth, properties, children)
+        @uuid = uuid
+        @path = path
+        @depth = depth
+        @properties = properties
+        @children = children
+      end
+
+      def title
+      end
+
+      def has_children?
+        warn "[DEPRECATION] `has_children?` is deprecated.  Please use `children?` instead."
+        @children && @children.size > 0
+      end
+
+      def children?
+        @children && @children.size > 0
+      end
+
+      def children
+        NavigationElementList.new(@children)
+      end
+
+      module ClassMethods
+        def navigation_properties
+          []
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/navigation/navigation_element_list.rb

@@ -0,0 +1,33 @@
+module Sinicum
+  module Navigation
+    # Public: Wrapper around the navigation element array that exposes a
+    # NavigationStatus in the #each iteration.
+    class NavigationElementList
+      include Enumerable
+
+      def initialize(navigation_elements)
+        @navigation_elements = navigation_elements
+      end
+
+      def each(&block)
+        count = 0
+        @navigation_elements.each do |el|
+          block.call(el, NavigationStatus.new(@navigation_elements.size, count))
+          count += 1
+        end
+      end
+
+      def size
+        @navigation_elements.size
+      end
+
+      def first
+        @navigation_elements.first
+      end
+
+      def last
+        @navigation_elements.last
+      end
+    end
+  end
+end