contentstack_utils 1.1.0 → 1.1.2

data/Rakefile

@@ -1,33 +1,33 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
- t.files   = ['lib/contentstack_utils/*.rb', 'lib/contentstack_utils.rb']   # optional
-end
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |t|
-    t.pattern = Dir.glob('spec/**/*_spec.rb')
-    t.rspec_opts = '--format documentation'
-end
-
-require "rdoc/task"
-task ghpages: :rdoc do
-  %x[git checkout gh-pages]
-  require "fileutils"
-  FileUtils.rm_rf "/tmp/html"
-  FileUtils.mv "html", "/tmp"
-  FileUtils.rm_rf "*"
-  FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
-end
-
-RDoc::Task.new do |doc|
-  doc.main   = "README.rdoc"
-  doc.title  = "Rake -- Ruby Make"
-  doc.rdoc_files = FileList.new %w[lib LICENSE doc/**/*.rdoc *.rdoc]
-  doc.rdoc_dir = "html"
-end
-
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+ t.files   = ['lib/contentstack_utils/*.rb', 'lib/contentstack_utils.rb']   # optional
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = Dir.glob('spec/**/*_spec.rb')
+    t.rspec_opts = '--format documentation'
+end
+
+require "rdoc/task"
+task ghpages: :rdoc do
+  %x[git checkout gh-pages]
+  require "fileutils"
+  FileUtils.rm_rf "/tmp/html"
+  FileUtils.mv "html", "/tmp"
+  FileUtils.rm_rf "*"
+  FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
+end
+
+RDoc::Task.new do |doc|
+  doc.main   = "README.rdoc"
+  doc.title  = "Rake -- Ruby Make"
+  doc.rdoc_files = FileList.new %w[lib LICENSE doc/**/*.rdoc *.rdoc]
+  doc.rdoc_dir = "html"
+end
+
 task default: :spec

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/contentstack_utils.gemspec

@@ -1,32 +1,32 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'contentstack_utils/version'
-Gem::Specification.new do |s|
-  s.name = %q{contentstack_utils}
-  s.version = ContentstackUtils::VERSION.dup
-  s.date = Time.now
-  s.authors = [%q{Contentstack}]
-  s.email = ["support@contentstack.com"]
-
-  s.required_ruby_version = '>= 2.0'
-
-  s.license = "MIT"
-  s.homepage = "https://github.com/contentstack/contentstack-utils-ruby"
-
-  s.summary = %q{Contentstack Ruby Utils for }
-  s.description = %q{Contentstack Ruby client for the Content Delivery API}
-
-  s.files = `git ls-files`.split("\n")
-  s.test_files    = s.files.grep(%r{^spec/})
-  s.require_paths = ["lib"]
-
-  s.add_dependency 'activesupport', '>= 3.2', '< 6.2'
-  s.add_dependency 'nokogiri', '~> 1.11', '>= 1.11.0'
-
-  s.add_development_dependency 'rake', '~> 13.0.3'
-  s.add_development_dependency 'rspec', '~> 3.10.0'
-  s.add_development_dependency 'webmock', '~> 3.11.0'
-  s.add_development_dependency 'simplecov', '~> 0.21.1'
-  s.add_development_dependency 'yard', '~> 0.9.26'
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'contentstack_utils/version'
+Gem::Specification.new do |s|
+  s.name = %q{contentstack_utils}
+  s.version = ContentstackUtils::VERSION.dup
+  s.date = Time.now
+  s.authors = [%q{Contentstack}]
+  s.email = ["support@contentstack.com"]
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.license = "MIT"
+  s.homepage = "https://github.com/contentstack/contentstack-utils-ruby"
+
+  s.summary = %q{Contentstack Ruby Utils for }
+  s.description = %q{Contentstack Ruby client for the Content Delivery API}
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(%r{^spec/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport', '>= 3.2', '< 7.0.4'
+  s.add_dependency 'nokogiri', '~> 1.11', '>= 1.11.0'
+
+  s.add_development_dependency 'rake', '~> 13.0.3'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+  s.add_development_dependency 'webmock', '~> 3.11.0'
+  s.add_development_dependency 'simplecov', '~> 0.21.1'
+  s.add_development_dependency 'yard', '~> 0.9.26'
 end

data/lib/contentstack_utils/interface/renderable.rb

@@ -1,9 +1,9 @@
-module ContentstackUtils
-    module Interface
-        class Rendarable
-            def render_option(embeddedObject, metadata)
-                raise NotImplementedError, "Implement this method in a child class"
-            end
-        end
-    end
+module ContentstackUtils
+    module Interface
+        class Rendarable
+            def render_option(embeddedObject, metadata)
+                raise NotImplementedError, "Implement this method in a child class"
+            end
+        end
+    end
 end

data/lib/contentstack_utils/model/metadata.rb

@@ -1,69 +1,69 @@
-
-module ContentstackUtils
-    module Model
-        class Metadata 
-            def initialize( element )
-                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 : nil
-            end
-
-            def style_type 
-                @styleType ? @styleType : nil
-            end
-
-            def item_uid 
-                @itemUid ? @itemUid : nil
-            end
-
-            def content_type_uid 
-                @contentTypeUid ? @contentTypeUid : nil
-            end
-
-            def text 
-                @text
-            end
-
-            def element 
-                @element
-            end
-            
-            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
+
+module ContentstackUtils
+    module Model
+        class Metadata 
+            def initialize( element )
+                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 : nil
+            end
+
+            def style_type 
+                @styleType ? @styleType : nil
+            end
+
+            def item_uid 
+                @itemUid ? @itemUid : nil
+            end
+
+            def content_type_uid 
+                @contentTypeUid ? @contentTypeUid : nil
+            end
+
+            def text 
+                @text
+            end
+
+            def element 
+                @element
+            end
+            
+            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

@@ -1,113 +1,115 @@
-require_relative '../interface/renderable.rb'
-require_relative './metadata.rb'
-
-module ContentstackUtils
-    module Model
-        class Options < Interface::Rendarable
-
-            def initialize(entry = nil)
-                @entry = entry
-            end
-
-            def entry 
-                @entry
-            end
-
-            def render_option(embeddedObject, metadata)
-                renderString = ''
-                case metadata.style_type
-                when 'block'
-                    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'
-                    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.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.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"] || ""}'>#{inner_html}</a>"
-                when 'img'
-                    renderString = "<img src='#{node["attrs"]["src"] || ""}' />#{inner_html}"
-                when 'embed'
-                    renderString = "<iframe src='#{node["attrs"]["src"] || ""}'></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
-        end
-    end
-end
+require_relative '../interface/renderable.rb'
+require_relative './metadata.rb'
+
+module ContentstackUtils
+    module Model
+        class Options < Interface::Rendarable
+
+            def initialize(entry = nil)
+                @entry = entry
+            end
+
+            def entry 
+                @entry
+            end
+
+            def render_option(embeddedObject, metadata)
+                renderString = ''
+                case metadata.style_type
+                when 'block'
+                    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'
+                    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.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.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 = ""
+                when 'span'
+                    renderString = "<span>#{inner_html}</span>"
+                end
+                renderString
+            end
+        end
+    end
+end

data/lib/contentstack_utils/support/helper.rb

@@ -1,3 +1,3 @@
-def appendFrame(string)
-   "<documentfragmentcontainer>#{string}</documentfragmentcontainer>"
+def appendFrame(string)
+   "<documentfragmentcontainer>#{string}</documentfragmentcontainer>"
 end