contentstack_utils 0.1.0.pre.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df97218ab0794ad8c4adff69d4146df7e736eecb5b302c2f2bf8892e45c53262
+  data.tar.gz: 1112de7f8c3df79c172b623f1981e8de31d54c4ac3407e07aad5a5058f72ba1f
+SHA512:
+  metadata.gz: 03d0dd9b13849d6f605855ec2e0bbdf551c0b02489bb38d8432747002639482db8188d065c53f9468367b7c9dba4654130927fdd1bf721d12576292853b4f868
+  data.tar.gz: 4e232dc32139bb1500fdfb6755710ba180d5492d1cda14ee3937af2b3a607c48fb3ba08fe5cf6bf742d8945bced1d7c8c01127d049d5f7760a146cef1abf30e5

data/.gitignore

@@ -0,0 +1,10 @@
+contentstack-*
+build_doc.sh
+test
+doc
+spec-integration
+coverage
+\.yardoc
+.DS_Store
+.bundle/
+*/rspec_results.html

data/.ruby-version

@@ -0,0 +1 @@
+2.6

data/.yardopts

@@ -0,0 +1,3 @@
+README.md
+lib/contentstack_utils/*
+lib/contentstack_utils.rb

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## [1.0.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.0) (2021-04-02)
+  - Initial release for Contentstack Utils SDK

data/Gemfile

@@ -0,0 +1,4 @@
+# Gemfile
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    contentstack_utils (1.0.0)
+      activesupport
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.7)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.4)
+    hashdiff (1.0.1)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.2)
+    nokogiri (1.11.0)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rake (13.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    simplecov (0.21.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webmock (3.11.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  contentstack_utils!
+  rake
+  rspec
+  simplecov
+  webmock
+  yard
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# 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
+```

data/Rakefile

@@ -0,0 +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
+
+task default: :spec

data/contentstack_utils.gemspec

@@ -0,0 +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', '~> 6.1.0'
+  s.add_dependency 'nokogiri', '~> 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.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require 'contentstack_utils/version'
+require 'contentstack_utils/utils'

data/lib/contentstack_utils/interface/renderable.rb

@@ -0,0 +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
+end

data/lib/contentstack_utils/model/metadata.rb

@@ -0,0 +1,44 @@
+
+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
+            end
+
+            def item_type 
+                @itemType ? @itemType.value : nil
+            end
+
+            def style_type 
+                @styleType ? @styleType.value : nil
+            end
+
+            def item_uid 
+                @itemUid ? @itemUid.value : nil
+            end
+
+            def content_type_uid 
+                @contentTypeUid ? @contentTypeUid.value : nil
+            end
+
+            def text 
+                @text
+            end
+
+            def element 
+                @element
+            end
+            
+            def attributes 
+                @attributes
+            end
+        end
+    end
+end

data/lib/contentstack_utils/model/options.rb

@@ -0,0 +1,34 @@
+require_relative '../interface/renderable.rb'
+require_relative './metadata.rb'
+
+module ContentstackUtils
+    module Model
+        class Options < Interface::Rendarable
+
+            def initialize(entry)
+                @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']}</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>";
+                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"]))}' />";
+                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>";
+                end
+                renderString
+            end
+        end
+    end
+end

data/lib/contentstack_utils/support/helper.rb

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

data/lib/contentstack_utils/utils.rb

@@ -0,0 +1,54 @@
+require_relative './model/options.rb'
+require_relative './model/metadata.rb'
+require_relative './support/helper.rb'
+require 'nokogiri'
+
+module ContentstackUtils
+    def self.render_content(content, options)
+        if (content.instance_of? Array)
+            result = []
+            content.each do |n|
+                result.push(render_string(n, options))
+            end
+            result
+        elsif content.instance_of? String
+            render_string(content, options)
+        end
+    end
+
+    private_class_method def self.render_string(string, options) 
+        xml_doc = Nokogiri::HTML(appendFrame(string))
+        result = xml_doc.xpath('//documentfragmentcontainer').inner_html
+        findEmbeddedObject(xml_doc).each do |metadata|
+            object = findObject(metadata, options.entry)
+            replaceString = ''
+            if object!= nil && object.length() > 0 
+                replaceString = options.render_option(object[0], metadata)
+            end
+            result = result.sub(metadata.element.to_html, replaceString)
+        end
+        result
+    end
+
+    private_class_method def self.findEmbeddedObject(doc)
+        metadataArray = []
+        doc.xpath('//*[contains(@class, "embedded-asset") or contains(@class, "embedded-entry")]').each do |n|
+            metadataArray.push(Model::Metadata.new(n))
+        end
+        metadataArray
+    end
+
+    private_class_method def self.findObject(metadata, entry) 
+        if entry.has_key? '_embedded_items'
+            embedItems = entry['_embedded_items']
+            keys = embedItems.keys
+            keys.each do |key|
+                object = embedItems[key].select { |embedObject| embedObject['uid'] == metadata.item_uid }
+                if object != nil && object.length() > 0 
+                    return object 
+                end
+            end
+        end
+        return nil
+    end
+end