contentstack_utils 1.1.3.2 → 1.2.0

data/README.md

@@ -1,97 +1,97 @@
-# Contentstack Utils Ruby
-
-Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. Read More.
-
-This guide will help you get started with Contentstack Ruby Utils SDK to build apps powered by Contentstack.
-
-## Prerequisites
-
--   Ruby version 2.0 or later
-    
-## SDK Installation and Setup
-
-To set up Ruby Utils SDK, install it via gem:
-```sh
-gem install contentstack_utils
-```
-
-> Note: If you are using Contentstack Ruby SDK, then “contentstack/utils” is already imported into your project.
-
-## Usage
-
-Let’s learn how you can use Utils SDK to render embedded items.
-
-### Create Render Option:
-
-To render embedded items on the front-end, use the render_option function, and define the UI elements you want to show in the front-end of your website, as shown in the example code below:
-```ruby
-class  CustomLOption < ContentstackUtils::Model::Option  
-	def render_option(embeddedObject, metadata)  
-		case metadata.style_type  
-			when  'block'  
-				if metadataArray.content_type_uid === 'product'  
-					return  "<div>  
-						<h2 >#{embeddedObject["title"]}</h2>  
-						<img src=#{embeddedObject["product_image"]["url"]} alt=#{embeddedObject["product_image"]["title"]}/>  
-						<p>#{embeddedObject["price"]}</p>  
-						</div>"  
-				end  
-			when  'inline'  
-				return  "<span><b>#{embeddedObject["title"]}</b> - #{embeddedObject["description"]}</span>"  
-			when link  
-				return  "<a href='#{metadata.attributes["href"].value}'>#{metadata.text}</a>"  
-			when  'display'  
-				return  "<img src='#{metadata.attributes["src"].value}' alt='#{metadata.alt}' />"  
-			when download  
-				return  "<a href='#{metadata.attributes["href"].value}'>#{metadata.text}</a>"  
-		end  
-		super(embeddedObject, metadata)  
-	end  
-end
-```
-## Basic Queries
-
-Contentstack Utils SDK lets you interact with the Content Delivery APIs and retrieve embedded items from the RTE field of an entry.
-
-### Fetch Embedded Item(s) from a Single Entry:
-
-To get an embedded item of a single entry, you need to provide the stack API key, environment name, delivery token, content type’s UID, and entry’s UID. Then, use the include_embedded_items function  as shown below:
-```ruby
-require  'contentstack'  
-
-@stack = Contentstack::Client.new('<API_KEY>', '<ENVIRONMENT_SPECIFIC_DELIVERY_TOKEN>', '<ENVIRONMENT>')  
-@entry = @stack.content_type('<CONTENT_TYPE>').entry('<ENTRY_UID>')  
-.include_embedded_items  
-.fetch  
-
-@rendered_rich_text = Contentstack.render_content(@entry.rte_field_uid, ContentstackUtils::Model::Option.new(@entry))
-```
-
-If you want to render embedded items using the CustomOption function, you can refer to the code below:
-```ruby
-@rendered_rich_text = Contentstack.render_content(@entry.rte_field_uid, CustomLOption.new(@entry))
-```
-### Fetch Embedded Item(s) from Multiple Entries
-
-To get embedded items from multiple entries, you need to provide the stack API key, environment name, delivery token, and content type’s UID.
-```ruby
-require  'contentstack'  
-@stack = Contentstack::Client.new('<API_KEY>', '<ENVIRONMENT_SPECIFIC_DELIVERY_TOKEN>', '<ENVIRONMENT>')  
-@query = @stack.content_type('<CONTENT_TYPE>').query  
-@entries = @query.where('title', 'welcome')  
-.include_embedded_items  
-.fetch
- 
-@entries.each do |entry|  
-	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())
-
+# Contentstack Utils Ruby
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. Read More.
+
+This guide will help you get started with Contentstack Ruby Utils SDK to build apps powered by Contentstack.
+
+## Prerequisites
+
+-   Ruby version 2.0 or later
+    
+## SDK Installation and Setup
+
+To set up Ruby Utils SDK, install it via gem:
+```sh
+gem install contentstack_utils
+```
+
+> Note: If you are using Contentstack Ruby SDK, then “contentstack/utils” is already imported into your project.
+
+## Usage
+
+Let’s learn how you can use Utils SDK to render embedded items.
+
+### Create Render Option:
+
+To render embedded items on the front-end, use the render_option function, and define the UI elements you want to show in the front-end of your website, as shown in the example code below:
+```ruby
+class  CustomLOption < ContentstackUtils::Model::Option  
+	def render_option(embeddedObject, metadata)  
+		case metadata.style_type  
+			when  'block'  
+				if metadataArray.content_type_uid === 'product'  
+					return  "<div>  
+						<h2 >#{embeddedObject["title"]}</h2>  
+						<img src=#{embeddedObject["product_image"]["url"]} alt=#{embeddedObject["product_image"]["title"]}/>  
+						<p>#{embeddedObject["price"]}</p>  
+						</div>"  
+				end  
+			when  'inline'  
+				return  "<span><b>#{embeddedObject["title"]}</b> - #{embeddedObject["description"]}</span>"  
+			when link  
+				return  "<a href='#{metadata.attributes["href"].value}'>#{metadata.text}</a>"  
+			when  'display'  
+				return  "<img src='#{metadata.attributes["src"].value}' alt='#{metadata.alt}' />"  
+			when download  
+				return  "<a href='#{metadata.attributes["href"].value}'>#{metadata.text}</a>"  
+		end  
+		super(embeddedObject, metadata)  
+	end  
+end
+```
+## Basic Queries
+
+Contentstack Utils SDK lets you interact with the Content Delivery APIs and retrieve embedded items from the RTE field of an entry.
+
+### Fetch Embedded Item(s) from a Single Entry:
+
+To get an embedded item of a single entry, you need to provide the stack API key, environment name, delivery token, content type’s UID, and entry’s UID. Then, use the include_embedded_items function  as shown below:
+```ruby
+require  'contentstack'  
+
+@stack = Contentstack::Client.new('<API_KEY>', '<ENVIRONMENT_SPECIFIC_DELIVERY_TOKEN>', '<ENVIRONMENT>')  
+@entry = @stack.content_type('<CONTENT_TYPE>').entry('<ENTRY_UID>')  
+.include_embedded_items  
+.fetch  
+
+@rendered_rich_text = Contentstack.render_content(@entry.rte_field_uid, ContentstackUtils::Model::Option.new(@entry))
+```
+
+If you want to render embedded items using the CustomOption function, you can refer to the code below:
+```ruby
+@rendered_rich_text = Contentstack.render_content(@entry.rte_field_uid, CustomLOption.new(@entry))
+```
+### Fetch Embedded Item(s) from Multiple Entries
+
+To get embedded items from multiple entries, you need to provide the stack API key, environment name, delivery token, and content type’s UID.
+```ruby
+require  'contentstack'  
+@stack = Contentstack::Client.new('<API_KEY>', '<ENVIRONMENT_SPECIFIC_DELIVERY_TOKEN>', '<ENVIRONMENT>')  
+@query = @stack.content_type('<CONTENT_TYPE>').query  
+@entries = @query.where('title', 'welcome')  
+.include_embedded_items  
+.fetch
+ 
+@entries.each do |entry|  
+	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/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

@@ -1,27 +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/)
+## 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'
-  s.add_dependency 'nokogiri', '~> 1.11'
-
-  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'
+  s.add_dependency 'nokogiri', '~> 1.11'
+
+  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