contentstack 0.3.0 → 0.4.3

data/lib/contentstack/api.rb

@@ -3,9 +3,10 @@ require 'net/http'
 require 'active_support'
 require 'active_support/json'
 require 'open-uri'
-
+require 'util'
 module Contentstack
   class API
+    using Utility
     def self.init_api(api_key, delivery_token, environment,host)
       @host = host
       @api_version = '/v3'
@@ -54,7 +55,7 @@ module Contentstack
       query = "?" + q.to_query
       # puts "Request URL:- #{@host}#{@api_version}#{path}#{query} \n\n"
       
-      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}",
+      ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}",
       "api_key" =>  @api_key,
       "access_token"=>  @access_token,
       "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",

data/lib/contentstack/asset.rb

@@ -1,7 +1,9 @@
+require 'util'
 module Contentstack
 
   # Asset class to fetch file details on Conentstack server.
   class Asset
+    using Utility
     attr_reader :uid, :content_type, :filename, :file_size, :tags, :url
 
     # @!attribute [r] uid

data/lib/contentstack/asset_collection.rb

@@ -1,8 +1,10 @@
 require 'contentstack/asset'
+require 'util'
 
 module Contentstack
   # Asset class to fetch details of files on Conentstack server.
   class AssetCollection
+    using Utility
     attr_reader :assets
 
     def initialize(assets_array=nil)

data/lib/contentstack/client.rb

@@ -2,8 +2,10 @@ require 'contentstack/api'
 require 'contentstack/content_type'
 require 'contentstack/asset_collection'
 require 'contentstack/sync_result'
+require 'util'
 module Contentstack
   class Client
+    using Utility
     attr_reader :region, :host
     # Initialize "Contentstack" Client instance
     def initialize(api_key, delivery_token, environment, options={})

data/lib/contentstack/content_type.rb

@@ -1,7 +1,9 @@
 require 'contentstack/query'
+require 'util'
 
 module Contentstack
   class ContentType
+    using Utility
     [:title, :uid, :created_at, :updated_at, :attributes].each do |method_name|
       if [:created_at, :updated_at].include?(method_name)
         define_method method_name do

data/lib/contentstack/entry.rb

@@ -1,7 +1,9 @@
 require 'active_support/core_ext'
+require 'util'
 
 module Contentstack
   class Entry
+    using Utility
     attr_reader :fields, :content_type, :uid, :owner, :query, :schema, :content_type
     def initialize(attrs, content_type_uid=nil)
       setup(attrs, content_type_uid)
@@ -152,6 +154,19 @@ module Contentstack
       self
     end
 
+    # Include Embedded Objects (Entries and Assets) along with entry/entries details.
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_embedded_items
+    #
+    # @return [Contentstack::Query]
+    def include_embedded_items()
+      @query[:include_embedded_items] = ['BASE']
+      self
+    end
+
     #
     # @return [Contentstack::Query]
     def include(field_uids)

data/lib/contentstack/entry_collection.rb

@@ -1,7 +1,9 @@
 require 'contentstack/entry'
+require 'util'
 
 module Contentstack
   class EntryCollection
+    using Utility
     attr_reader :entries, :count, :content_type, :schema
 
     def initialize(json, content_type_uid=nil)

data/lib/contentstack/query.rb

@@ -1,8 +1,10 @@
 require 'contentstack/entry_collection'
+require 'util'
 
 module Contentstack
   # A class that defines a query that is used to query for Entry instance.
   class Query
+    using Utility
     # @!attribute [r] query
     #   Attribute which has all the information about the query which will be executed against Contentstack API
 
@@ -516,6 +518,19 @@ module Contentstack
       self
     end
 
+    # Include Embedded Objects (Entries and Assets) along with entry/entries details.
+    #
+    # Example
+    #
+    #    @query = @stack.content_type('product').query
+    #    @query.include_embedded_items
+    #
+    # @return [Contentstack::Query]
+    def include_embedded_items()
+      @query[:include_embedded_items] = ['BASE']
+      self
+    end
+
     # Include objects in 'Draft' mode in response
     #
     # Example

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.3.0"
+  VERSION = "0.4.3"
 end

data/lib/contentstack.rb

@@ -3,8 +3,7 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "contentstack/version"
 require "contentstack/client"
 require "contentstack/region"
-require "util"
-
+require "contentstack_utils"
 
 # == Contentstack - Ruby SDK
 # Contentstack is a content management system that facilitates the process of publication by separating the content from site-related programming and design.
@@ -22,4 +21,10 @@ require "util"
 # ==== Query entries
 #   @stack.content_type('blog').query.regex('title', '.*hello.*').fetch
 module Contentstack
+    def self.render_content(content, options)
+        ContentstackUtils.render_content(content, options)
+    end
+    def self.json_to_html(content, options)
+        ContentstackUtils.json_to_html(content, options)
+    end
 end

data/lib/util.rb

@@ -1,107 +1,111 @@
-class Hash
-  def to_query(namespace = nil)
-    collect do |key, value|
-      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
-    end.sort * '&'
-  end
-
-  def symbolize_keys
-    new_hash = {}
-    self.each do |key,value|
-      if [Hash, Array].include?(value.class)
-        new_hash[key.to_sym] = value.symbolize_keys
-      else
-        new_hash[key.to_sym] = value
+module Contentstack
+  module Utility
+    refine Hash do
+      def to_query(namespace = nil)
+        collect do |key, value|
+          value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+        end.sort * '&'
+      end
+    
+      def symbolize_keys
+        new_hash = {}
+        self.each do |key,value|
+          if [Hash, Array].include?(value.class)
+            new_hash[key.to_sym] = value.symbolize_keys
+          else
+            new_hash[key.to_sym] = value
+          end
+        end
+        new_hash
+      end
+    end
+    
+    refine Array do
+      def to_query(key)
+        prefix = "#{key}[]"
+        collect { |value| value.to_query(prefix) }.join '&'
+      end
+    
+      def symbolize_keys
+        collect do |entry|
+          if entry.class == Hash
+            entry.symbolize_keys
+          else
+            entry
+          end
+        end
+      end
+    end
+    
+    refine String do
+      def to_query(key)
+        require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+        "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+      end
+      
+      def to_param
+        to_s
+      end
+    end
+    
+    refine Symbol do
+      def to_query(key)
+        to_s.to_query(key)
+      end
+    
+      def to_param
+        to_s
+      end
+    end
+    
+    refine NilClass do
+      def to_query(key)
+        to_s.to_query(key)
+      end
+    
+      def to_param
+        to_s
+      end
+    end
+    
+    refine TrueClass do
+      def to_query(key)
+        to_s.to_query(key)
+      end
+    
+      def to_query(val)
+        "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
       end
     end
-    new_hash
-  end
-end
-
-class Array
-  def to_query(key)
-    prefix = "#{key}[]"
-    collect { |value| value.to_query(prefix) }.join '&'
-  end
-
-  def symbolize_keys
-    collect do |entry|
-      if entry.class == Hash
-        entry.symbolize_keys
-      else
-        entry
+    
+    refine FalseClass do
+      def to_query(key)
+        to_s.to_query(key)
+      end
+    
+      def to_query(val)
+        "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
       end
     end
-  end
-end
-
-class String
-  def to_query(key)
-    require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
-    "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
-  end
-  
-  def to_param
-    to_s
-  end
-end
-
-class Symbol
-  def to_query(key)
-    to_s.to_query(key)
-  end
-
-  def to_param
-    to_s
-  end
-end
-
-class NilClass
-  def to_query(key)
-    to_s.to_query(key)
-  end
-
-  def to_param
-    to_s
-  end
-end
-
-class TrueClass
-  def to_query(key)
-    to_s.to_query(key)
-  end
-
-  def to_query(val)
-    "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
-  end
-end
-
-class FalseClass
-  def to_query(key)
-    to_s.to_query(key)
-  end
-
-  def to_query(val)
-    "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
-  end
-end
-
-class Integer
-  def to_query(key)
-    to_s.to_query(key)
-  end
-
-  def to_query(val)
-    "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
-  end
-end
-
-class Numeric
-  def to_query(key)
-    to_s.to_query(key)
-  end
-
-  def to_query(val)
-    "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
-  end
+    
+    refine Integer do
+      def to_query(key)
+        to_s.to_query(key)
+      end
+    
+      def to_query(val)
+        "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
+      end
+    end
+    
+    refine Numeric do
+      def to_query(key)
+        to_s.to_query(key)
+      end
+    
+      def to_query(val)
+        "#{CGI.escape(val.to_param)}=#{CGI.escape(to_s)}"
+      end
+    end  
+  end  
 end

data/spec/contentstack_spec.rb

@@ -29,4 +29,11 @@ describe Contentstack do
     expect(custom_host_client.host).to eq 'https://custom-cdn.contentstack.com'  
   end
 
+  it "JSON to HTML" do
+    expect(Contentstack::json_to_html({}, ContentstackUtils::Model::Options.new())).to eq ''  
+  end
+
+  it "JSON to HTML" do
+    expect(Contentstack::render_content('', ContentstackUtils::Model::Options.new())).to eq ''  
+  end
 end

data/spec/entry_spec.rb

@@ -4,7 +4,6 @@ require_relative '../lib/contentstack.rb'
 describe Contentstack::Entry do
   let(:client) { create_client }
   let(:uid) { "blt05056a2f5e0ebf76" }
-
   let(:category) {client.content_type("category").entry(uid)}
   let(:product) {client.content_type("product").entry(uid)}
 
@@ -86,4 +85,10 @@ describe Contentstack::Entry do
     puts data.get("categories.title")
     expect(data.fields[:categories][0][:title]).not_to be nil
   end
+
+  it "should get data using `include_embedded_items` method" do
+    data = product.include_embedded_items().fetch
+    puts data.get("categories.title")
+    expect(data.fields[:categories][0][:title]).not_to be nil
+  end
 end

data/spec/spec_helper.rb

@@ -160,4 +160,11 @@ RSpec.configure do |config|
   def create_client(delivery_token = ENV['DELIVERY_TOKEN'], api_key = ENV['API_KEY'], environment = ENV['ENVIRONMENT'], options = {})
     Contentstack::Client.new(api_key, delivery_token, environment, options)
   end
+
+  def render(content, entry)
+    Contentstack::render_content(content, ContentstackUtils::Model::Options.new(entry))
+  end
+  def json_to_html(content, entry)
+    Contentstack::json_to_html(content, ContentstackUtils::Model::Options.new(entry))
+  end
 end

metadata

@@ -1,71 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: contentstack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Contentstack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: contentstack_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
 description: Contentstack Ruby client for the Content Delivery API
 email:
 - support@contentstack.com
@@ -76,6 +116,7 @@ files:
 - ".gitignore"
 - ".yardopts"
 - CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock