contentstack_utils 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 759c06ba41beb4747785a6d55ac266954fd55a22a118c4cc82e9589b2f44c137
-  data.tar.gz: 1d12fcfce0cc480300d3f07786757e0ec37d6a0b31b36352fcc53b4a5b466ede
+  metadata.gz: 45608729d00c39aa34058014c55b5704af78a59d1296b3c2edfe28469d85787d
+  data.tar.gz: 5fefcde66ac69b48c7185dd9625dcf71b7b4fbd9921578ba6cf728f28d5ca938
 SHA512:
-  metadata.gz: 47522ef3975f83f27fa6a8d3a7b0414637e3aac7b96ea7aa605fa82294b5b28eeae874980bbe2c95e4e5f7aac237eafe82b85a21ecfdb006a205e77186bae205
-  data.tar.gz: 501bf8584aa0ca41b10b8f55aa3565a1363e46fc7f082f58db3574dd04efeb1f29152b857d2bfc701953597c0409195428a31dd755a38d10b013a901a4b9e8ee
+  metadata.gz: 10901b878dd07194d11ff7c712c47c4ccd3dfe5d549f988d69bb30298d917f18bd1f8f93638f0b527fb60d5bc236d37f992224570b9ac70ae8a97aaaf32350c4
+  data.tar.gz: 6488de4c8ed0da29acc7fc1c2396dc6f645608a6cca60dc60973719baa5fc0cdb50ca8efc1395de8c1aa58edead695c4f4cbeca8c35cf8538b39a365439a297c

data/.gitignore

@@ -1,4 +1,4 @@
-contentstack-*
+contentstack_utils-*
 build_doc.sh
 test
 doc
@@ -7,4 +7,5 @@ coverage
 \.yardoc
 .DS_Store
 .bundle/
-*/rspec_results.html
+**/rspec_results.html
+.dccache

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [1.1.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.1.0) (2021-08-10)
+  - GQL Json rte to Html content support added
+
+## [1.0.2](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.2) (2021-07-16)
+  - JSON RTE support added
 ## [1.0.1](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.1) (2021-06-02)
   - Gemspec Dependency update
 

data/CODEOWNERS

@@ -0,0 +1 @@
+* @contentstack/security-admin @contentstack/sdk-admin

data/Gemfile.lock

@@ -1,36 +1,36 @@
 PATH
   remote: .
   specs:
-    contentstack_utils (1.0.1)
+    contentstack_utils (1.1.0)
       activesupport (>= 3.2, < 6.2)
-      nokogiri (~> 1.11.0)
+      nokogiri (~> 1.11, >= 1.11.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
     docile (1.4.0)
     hashdiff (1.0.1)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.5.3)
-    minitest (5.14.4)
-    nokogiri (1.11.6)
-      mini_portile2 (~> 2.5.0)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    public_suffix (4.0.6)
-    racc (1.5.2)
+    public_suffix (4.0.7)
+    racc (1.6.0)
     rake (13.0.3)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -59,7 +59,7 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.26)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2021 Contentstack. All Rights Reserved
+Copyright (c) 2012-2022 Contentstack. All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -86,3 +86,12 @@ require  'contentstack'
 	Contentstack.render_content(@entry.rte_field_uid, ContentstackUtils::Model::Option.new(@entry))  
 end
 ```
+### GQL Json RTE to HTML
+To parse JSON RTE content from GQL response to HTML content use `ContentstackUtils::GQL.json_to_html` function as below:
+
+```ruby
+require  'contentstack_utils'  
+
+	result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+
+```

data/SECURITY.md

@@ -0,0 +1,27 @@
+## Security
+
+Contentstack takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations.
+
+If you believe you have found a security vulnerability in any Contentstack-owned repository, please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Send email to [security@contentstack.com](mailto:security@contentstack.com).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+[https://www.contentstack.com/trust/](https://www.contentstack.com/trust/)

data/lib/contentstack_utils/model/metadata.rb

@@ -3,29 +3,46 @@ module ContentstackUtils
     module Model
         class Metadata 
             def initialize( element )
-                @itemType = element.attribute('type')
-                @styleType = element.attribute('sys-style-type')
-                @itemUid ||= element.attribute('data-sys-entry-uid') || element.attribute('data-sys-asset-uid')
-                @contentTypeUid = element.attribute('data-sys-content-type-uid')
-                @text = element.text
-                @element = element
-                @attributes = element.attributes
+                if element.instance_of? Nokogiri::XML::Element
+                    @itemType = element.attribute('type') ? element.attribute('type').value : nil
+                    @styleType = element.attribute('sys-style-type') ? element.attribute('sys-style-type').value : nil
+                    @itemUid ||= (element.attribute('data-sys-entry-uid') ? element.attribute('data-sys-entry-uid').value : nil) || (element.attribute('data-sys-asset-uid') ? element.attribute('data-sys-asset-uid').value : nil)
+                    @contentTypeUid = element.attribute('data-sys-content-type-uid') ? element.attribute('data-sys-content-type-uid').value : nil
+                    @text = element.text
+                    @element = element
+                    @attributes = element
+                else
+                    @itemType = element["attrs"]['type']
+                    @styleType = element["attrs"]['display-type']
+                    @itemUid ||= element["attrs"]['entry-uid'] || element["attrs"]['asset-uid']
+                    @contentTypeUid = element["attrs"]['content-type-uid']
+                    if element["children"] && element["children"].length() > 0 
+                        child = element["children"]
+                        for item in child do
+                            if item["type"] == nil && item["text"] 
+                                @text = item["text"] 
+                            end
+                        end
+                    end   
+                    @element = element
+                    @attributes = element["attrs"]
+                end
             end
 
             def item_type 
-                @itemType ? @itemType.value : nil
+                @itemType ? @itemType : nil
             end
 
             def style_type 
-                @styleType ? @styleType.value : nil
+                @styleType ? @styleType : nil
             end
 
             def item_uid 
-                @itemUid ? @itemUid.value : nil
+                @itemUid ? @itemUid : nil
             end
 
             def content_type_uid 
-                @contentTypeUid ? @contentTypeUid.value : nil
+                @contentTypeUid ? @contentTypeUid : nil
             end
 
             def text 
@@ -39,6 +56,14 @@ module ContentstackUtils
             def attributes 
                 @attributes
             end
+
+            def get_attribute_value(string)
+                if @attributes.instance_of? Nokogiri::XML::Element
+                    @attributes.attribute(string) ? @attributes.attribute(string).value : nil
+                else
+                    @attributes[string]
+                end 
+            end
         end
     end
 end

data/lib/contentstack_utils/model/options.rb

@@ -5,7 +5,7 @@ module ContentstackUtils
     module Model
         class Options < Interface::Rendarable
 
-            def initialize(entry)
+            def initialize(entry = nil)
                 @entry = entry
             end
 
@@ -17,15 +17,94 @@ module ContentstackUtils
                 renderString = ''
                 case metadata.style_type
                 when 'block'
-                    renderString = "<div><p>#{embeddedObject['title'] || embeddedObject['uid']}</p><p>Content type: <span>#{embeddedObject['_content_type_uid']}</span></p></div>"
+                    renderString = "<div><p>#{embeddedObject['title'] || embeddedObject['uid']}</p><p>Content type: <span>#{embeddedObject['_content_type_uid'] || embeddedObject['system']['content_type_uid']}</span></p></div>"
                 when 'inline'
                     renderString = "<span>#{embeddedObject["title"] || embeddedObject["uid"]}</span>";
                 when 'link'
-                    renderString = "<a href='#{(metadata.attributes["href"] ? metadata.attributes["href"].value : nil) || embeddedObject["url"] || embeddedObject["title"] || embeddedObject["uid"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["title"] || embeddedObject["uid"]))}</a>";
+                    metadata.get_attribute_value("href")
+                    renderString = "<a href='#{metadata.get_attribute_value("href") || embeddedObject["url"] || embeddedObject["title"] || embeddedObject["uid"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["title"] || embeddedObject["uid"]))}</a>";
                 when 'display'
-                    renderString = "<img src='#{(metadata.attributes["href"] ? metadata.attributes["href"].value : nil)|| embeddedObject["url"]}' alt='#{(metadata.attributes["alt"] ? metadata.attributes["alt"].value : (embeddedObject["title"] || embeddedObject["filename"] || embeddedObject["uid"]))}' />";
+                    renderString = "<img src='#{metadata.get_attribute_value("src")|| embeddedObject["url"]}' alt='#{(metadata.attributes["alt"] ? metadata.attributes["alt"].value : (embeddedObject["title"] || embeddedObject["filename"] || embeddedObject["uid"]))}' />";
                 when 'download'
-                    renderString = "<a href='#{(metadata.attributes["href"] ? metadata.attributes["href"].value : nil) || embeddedObject["url"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["filename"] || embeddedObject["title"] || embeddedObject["uid"]))}</a>";
+                    renderString = "<a href='#{metadata.get_attribute_value("href") || embeddedObject["url"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["filename"] || embeddedObject["title"] || embeddedObject["uid"]))}</a>";
+                end
+                renderString
+            end
+
+            def render_mark(mark_type, text)
+                renderString = text
+                case mark_type
+                when 'bold'
+                    renderString = "<strong>#{text}</strong>"
+                when 'italic'
+                    renderString = "<em>#{text}</em>"
+                when 'underline'
+                    renderString = "<u>#{text}</u>"
+                when 'strikethrough'
+                    renderString = "<strike>#{text}</strike>"
+                when 'inlineCode'
+                    renderString = "<span>#{text}</span>"
+                when 'subscript'
+                    renderString = "<sub>#{text}</sub>"
+                when 'superscript'
+                    renderString = "<sup>#{text}</sup>"
+                end
+                renderString
+            end
+
+            def render_node(node_type, node, inner_html)
+                renderString = ""
+                case node_type
+                when 'doc'
+                    renderString = ""
+                when 'p'
+                    renderString = "<p>#{inner_html}</p>"
+                when 'a'
+                    renderString = "<a href='#{node["attrs"]["href"] || node["attrs"]["url"] || ""}'>#{inner_html}</a>"
+                when 'img'
+                    renderString = "<img src='#{node["attrs"]["src"] || node["attrs"]["url"]  || ""}' />#{inner_html}"
+                when 'embed'
+                    renderString = "<iframe src='#{node["attrs"]["src"] || node["attrs"]["url"]  || ""}'></iframe>"
+                when 'h1'
+                    renderString = "<h1>#{inner_html}</h1>"
+                when 'h2'
+                    renderString = "<h2>#{inner_html}</h2>"
+                when 'h3'
+                    renderString = "<h3>#{inner_html}</h3>"
+                when 'h4'
+                    renderString = "<h4>#{inner_html}</h4>"
+                when 'h5'
+                    renderString = "<h5>#{inner_html}</h5>"
+                when 'h6'
+                    renderString = "<h6>#{inner_html}</h6>"
+                when 'ol'
+                    renderString = "<ol>#{inner_html}</ol>"
+                when 'ul'
+                    renderString = "<ul>#{inner_html}</ul>"
+                when 'li'
+                    renderString = "<li>#{inner_html}</li>"
+                when 'hr'
+                    renderString = "<hr />"
+                when 'table'
+                    renderString = "<table>#{inner_html}</table>"
+                when 'thead'
+                    renderString = "<thead>#{inner_html}</thead>"
+                when 'tbody'
+                    renderString = "<tbody>#{inner_html}</tbody>"
+                when 'tfoot'
+                    renderString = "<tfoot>#{inner_html}</tfoot>"
+                when 'tr'
+                    renderString = "<tr>#{inner_html}</tr>"
+                when 'th'
+                    renderString = "<th>#{inner_html}</th>"
+                when 'td'
+                    renderString = "<td>#{inner_html}</td>"
+                when 'blockquote'
+                    renderString = "<blockquote>#{inner_html}</blockquote>"
+                when 'code'
+                    renderString = "<code>#{inner_html}</code>"
+                when 'reference'
+                    renderString = ""
                 end
                 renderString
             end

data/lib/contentstack_utils/utils.rb

@@ -16,6 +16,82 @@ module ContentstackUtils
         end
     end
 
+    def self.json_to_html(content, options)
+        reference = -> (metadata){
+            result = ""
+            if options.entry != nil
+                object = findObject(metadata, options.entry)
+                if object!= nil && object.length() > 0 
+                    result = options.render_option(object[0], metadata)
+                end
+            end
+            result
+         }
+        if (content.instance_of? Array)
+            result = []
+            content.each do |n|
+                result.push(json_doc_to_html(n, options, reference) )
+            end
+            result
+        elsif content.instance_of? Hash
+            json_doc_to_html(content, options, reference)
+        end
+    end
+
+    def self.json_doc_to_html(node, options, callback)
+        result = ""
+        if node["children"] && node["children"].length() > 0
+            result = node_children_to_html(node["children"], options, callback)
+        end
+        result
+    end
+
+    private_class_method def self.node_children_to_html(nodes, options, callback) 
+        nodes.map {|node| node_to_html(node, options, callback)}.join("")
+    end
+
+    private_class_method def self.node_to_html(node, options, callback)
+        html_result = ""
+        if node["type"] == nil && node["text"] 
+            html_result = text_to_htms(node, options)            
+        elsif node["type"]
+            if node["type"] == "reference"
+                metadata = Model::Metadata.new(node)
+                html_result = callback.call(metadata)
+            else
+                inner_html = json_doc_to_html(node, options, callback)
+                html_result =  options.render_node(node["type"], node, inner_html)
+            end 
+        end
+        html_result
+    end
+
+    private_class_method def self.text_to_htms(node, options)
+        text = node["text"]
+        if node["superscript"]
+            text = options.render_mark("superscript", text)
+        end
+        if node["subscript"]
+            text = options.render_mark("subscript", text)
+        end
+        if node["inlineCode"]
+            text = options.render_mark("inlineCode", text)
+        end
+        if node["strikethrough"]
+            text = options.render_mark("strikethrough", text)
+        end
+        if node["underline"]
+            text = options.render_mark("underline", text)
+        end
+        if node["italic"]
+            text = options.render_mark("italic", text)
+        end
+        if node["bold"]
+            text = options.render_mark("bold", text)
+        end
+        text
+    end
+
     private_class_method def self.render_string(string, options) 
         xml_doc = Nokogiri::HTML(appendFrame(string))
         result = xml_doc.xpath('//documentfragmentcontainer').inner_html
@@ -51,4 +127,37 @@ module ContentstackUtils
         end
         return nil
     end
+
+    module GQL
+        include ContentstackUtils
+        def self.json_to_html(content, options)
+            embeddedItems = []
+            if content.has_key? 'embedded_itemsConnection'
+                embeddedItems = content['embedded_itemsConnection']['edges'] || []
+            end            
+            reference = -> (metadata){
+                result = ""
+                if embeddedItems != nil
+                    object = embeddedItems.select { |embedObject| embedObject['node']["system"]["uid"] == metadata.item_uid }
+                    if object != nil && object.length() > 0 
+                        result = options.render_option(object[0]["node"], metadata)
+                    end
+                end
+                result
+            }         
+           
+            if content.has_key? 'json'
+                json = content['json']
+                if (json.instance_of? Array)
+                    result = []
+                    json.each do |n|
+                        result.push(ContentstackUtils.json_doc_to_html(n, options, reference))
+                    end
+                    result
+                elsif json.instance_of? Hash
+                    ContentstackUtils.json_doc_to_html(json, options, reference)
+                end
+            end
+        end
+    end
 end

data/lib/contentstack_utils/version.rb

@@ -1,3 +1,3 @@
 module ContentstackUtils
-    VERSION = "1.0.1"
+    VERSION = "1.1.1"
 end

data/spec/lib/model/metadata_spec.rb

@@ -51,5 +51,45 @@ RSpec.describe ContentstackUtils::Model::Metadata do
                 expect(metadata.text).to eq 'TEST'
             end
         end
+
+        it 'Asset Json To metadata' do 
+            doc = getJson(AssetReferenceJson)
+            metadata = ContentstackUtils::Model::Metadata.new(doc["children"][0])
+            expect(metadata.item_type).to eq "asset"
+            expect(metadata.style_type).to eq "display"
+            expect(metadata.item_uid).to eq "asset_uid_1"
+            expect(metadata.content_type_uid).to eq 'sys_assets'
+            expect(metadata.text).to eq ''
+        end
+
+        it 'Entry Block Json To metadata' do 
+            doc = getJson(EntryReferenceBlockJson)
+            metadata = ContentstackUtils::Model::Metadata.new(doc["children"][0])
+            expect(metadata.item_type).to eq "entry"
+            expect(metadata.style_type).to eq "block"
+            expect(metadata.item_uid).to eq "entry_uid_1"
+            expect(metadata.content_type_uid).to eq 'content_block'
+            expect(metadata.text).to eq ''
+        end
+
+        it 'Entry Link Json To metadata' do 
+            doc = getJson(EntryReferenceLinkJson)
+            metadata = ContentstackUtils::Model::Metadata.new(doc["children"][0])
+            expect(metadata.item_type).to eq "entry"
+            expect(metadata.style_type).to eq "link"
+            expect(metadata.item_uid).to eq "entry_uid_2"
+            expect(metadata.content_type_uid).to eq 'embeddedrte'
+            expect(metadata.text).to eq "/copy-of-entry-final-02"
+        end
+
+        it 'Entry Inline Json To metadata' do 
+            doc = getJson(EntryReferenceInlineJson)
+            metadata = ContentstackUtils::Model::Metadata.new(doc["children"][0])
+            expect(metadata.item_type).to eq "entry"
+            expect(metadata.style_type).to eq "inline"
+            expect(metadata.item_uid).to eq "entry_uid_3"
+            expect(metadata.content_type_uid).to eq 'embeddedrte'
+            expect(metadata.text).to eq ''
+        end
     end
 end