contentstack 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671d9ee269ba5d1ab29949d9c76c55c74fa6b27567c5810ef72992cbcac698d5
-  data.tar.gz: 40e49c3028c79f1a9b54556a739d29aa745c9c280523b5bb166b3297f39db965
+  metadata.gz: 9a123ae65668a6bf29833ecc4afcb2a2928e1732714972f6435a454b73aaf4ad
+  data.tar.gz: 62e2227a92867dc87c0924a9739f8992ec48f315b36bd6dddd4c67695dec4312
 SHA512:
-  metadata.gz: 455dce0b18e04b9bb7e129466c01f083497c0f80a9dcb99a6ed80c8c3f22c16bd65a2a46f3bf2191f65f7020a549b5a80292cf5cc945860f75438c4ff1ed0229
-  data.tar.gz: 5ac68f4344f8aff3de2964f452cf34591caef69a3ed29af9c58d0a32d0acaff74a278927a7cc602cf24aec379c6df9e3edbbb3b836e9d35aee28a2d610d9ff16
+  metadata.gz: 46d3100475b3e04a49b01982ac0ffe39bc75669da2127256275ad4b9264f265e298391ea7da6f24c00a91e58307daf519a34baf71b4d21a54b6a6d365a4d1792
+  data.tar.gz: d666b92d9b25fe675187cebac7f04f4fc426cc731636022ba6350293fbe61f9e5ef258ceae7df363abfc78dc6fbc37b1f0c294e79debaaba7b1a8dbb90b90f0c

data/.gitignore

@@ -7,5 +7,6 @@ coverage
 \.yardoc
 .DS_Store
 .bundle/
-*/rspec_results.html
+**/rspec_results.html
 vendor/
+coverage/

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 ## CHANGELOG
 ------------------------------------------------
+## Version 0.5.0
+### Date: 14th-Oct-2021
+ ### New Features
+ - Live Preview feature support added
+
+------------------------------------------------
+## Version 0.4.3
+### Date: 17th-Sept-2021
+ ### Dependency update
+ - Issue for Monkey patching resolved. Implemented Refine to extend class within module scope.
+
+------------------------------------------------
+## Version 0.4.2
+### Date: 2nd-Sept-2021
+ ### Dependency update
+ - Added URI open on open uri deprecation 
+
+------------------------------------------------
+## Version 0.4.1
+### Date: 2nd-Jun-2021
+ ### Dependency update
+ - Updated gemspec dependency
+
+------------------------------------------------
+## Version 0.4.0
+### Date: 16th-Apr-2021
+ ### New Features
+ - Embedded feature Support added
+
+------------------------------------------------
 
 ## Version 0.3.0
 ### Date: 17th-Mar-2021

data/CODEOWNERS

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

data/Gemfile.lock

@@ -1,37 +1,39 @@
 PATH
   remote: .
   specs:
-    contentstack (0.2.0)
-      activesupport (> 3.2.5)
-      contentstack_utils (~> 1.0.0)
+    contentstack (0.5.0)
+      activesupport (>= 3.2, < 6.2)
+      contentstack_utils (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (6.1.4.1)
       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)
-    contentstack_utils (1.0.0)
-      activesupport (~> 6.1.0)
-      nokogiri (~> 1.11.0)
+    concurrent-ruby (1.1.9)
+    contentstack_utils (1.1.0)
+      activesupport (>= 3.2, < 6.2)
+      nokogiri (~> 1.11, >= 1.11.0)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.5)
+    docile (1.4.0)
     hashdiff (1.0.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
-    nokogiri (1.11.2-arm64-darwin)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -51,7 +53,7 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    simplecov_json_formatter (0.1.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     webmock (3.11.3)
@@ -59,10 +61,10 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.26)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
-  universal-darwin-19
+  ruby
 
 DEPENDENCIES
   contentstack!

data/contentstack.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', "~> 3.2"
-  s.add_dependency "contentstack_utils", "~> 1.0.0"
+  s.add_dependency 'activesupport', '>= 3.2', '< 6.2'
+  s.add_dependency "contentstack_utils", '~> 1.0', '>= 1.0.1'
   
   s.add_development_dependency 'rspec', '~> 3.10.0'
   s.add_development_dependency 'webmock', '~> 3.11.0'

data/lib/contentstack/api.rb

@@ -3,16 +3,24 @@ require 'net/http'
 require 'active_support'
 require 'active_support/json'
 require 'open-uri'
-
+require 'util'
 module Contentstack
   class API
-    def self.init_api(api_key, delivery_token, environment,host)
+    using Utility
+    def self.init_api(api_key, delivery_token, environment, host, branch, live_preview)
       @host = host
       @api_version = '/v3'
       @environment = environment
       @api_key = api_key
       @access_token = delivery_token
+      @branch = branch
       @headers = {environment: @environment}
+      @live_preview = live_preview
+    end
+
+    def self.live_preview_query(query= {})
+      @live_preview[:content_type_uid] = query[:content_type_uid]
+      @live_preview[:live_preview] = query[:live_preview]
     end
 
     def self.fetch_content_types(uid="")
@@ -25,13 +33,23 @@ module Contentstack
     end
 
     def self.fetch_entries(content_type, query)
-      path = "/content_types/#{content_type}/entries"
-      send_request(path, query)
+      if  @live_preview[:enable] && @live_preview[:content_type_uid] == content_type
+        path = "/content_types/#{content_type}/entries"
+        send_preview_request(path, query)  
+      else
+        path = "/content_types/#{content_type}/entries"
+        send_request(path, query)
+      end
     end
 
     def self.fetch_entry(content_type, entry_uid, query)
-      path = "/content_types/#{content_type}/entries/#{entry_uid}"
-      send_request(path, query)
+      if  @live_preview[:enable] && @live_preview[:content_type_uid] == content_type
+        path = "/content_types/#{content_type}/entries/#{entry_uid}"
+        send_preview_request(path, query)  
+      else
+        path = "/content_types/#{content_type}/entries/#{entry_uid}"
+        send_request(path, query)
+      end
     end
 
     def self.get_assets(asset_uid=nil)
@@ -53,12 +71,35 @@ 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}",
-      "api_key" =>  @api_key,
-      "access_token"=>  @access_token,
-      "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
-      "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
+      params = {
+        "api_key" =>  @api_key,
+        "access_token"=>  @access_token,
+        "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
+        "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}"
+      }
+      if !@branch.nil? && !@branch.empty?
+        params["branch"] = @branch
+      end
+      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}",params).read)
+    end
+
+    def self.send_preview_request(path, q=nil)
+      q ||= {}
+
+      q.merge!({live_preview: (!@live_preview.key?(:live_preview) ? 'init' : @live_preview[:live_preview]),})
+
+      query = "?" + q.to_query
+      preview_host = @live_preview[:host]
+      params = {
+        "api_key" =>  @api_key,
+        "authorization" => @live_preview[:management_token],
+        "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
+        "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}"
+      }
+      if !@branch.nil? && !@branch.empty?
+        params["branch"] = @branch
+      end
+      ActiveSupport::JSON.decode(open("#{preview_host}#{@api_version}#{path}#{query}",params).read)
     end
   end
 end

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,14 +2,18 @@ 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={})
       @region = options[:region].nil? ? Contentstack::Region::US : options[:region]
       @host = options[:host].nil? ? get_default_region_hosts(@region) : options[:host]
-      API.init_api(api_key, delivery_token, environment,  @host)
+      @live_preview = !options.key?(:live_preview) ? {} : options[:live_preview]
+      @branch = options[:branch].nil? ? "" : options[:branch]
+      API.init_api(api_key, delivery_token, environment,  @host, @branch, @live_preview)
     end
     
     def content_types
@@ -28,6 +32,9 @@ module Contentstack
       Asset.new(uid)
     end
 
+    def live_preview_query(query={})
+      API.live_preview_query(query)
+    end
     
     # Syncs your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates
     # 
@@ -41,9 +48,9 @@ module Contentstack
     # 
     #   Stack.sync({'init': true, 'type': 'entry_published'})   // Use the type parameter to get a specific type of content.Supports 'asset_published', 'entry_published', 'asset_unpublished', 'entry_unpublished', 'asset_deleted', 'entry_deleted', 'content_type_deleted'.
     # 
-    #   Stack.sync({'pagination_token': '<btlsomething>'})    // For fetching the next batch of entries using pagination token
+    #   Stack.sync({'pagination_token': '<pagination>'})    // For fetching the next batch of entries using pagination token
     # 
-    #   Stack.sync({'sync_token': '<btlsomething>'})    // For performing subsequent sync after initial sync
+    #   Stack.sync({'sync_token': '<sync>'})    // For performing subsequent sync after initial sync
     #
     # @param params [Hash] params is an object that supports ‘locale’, ‘start_date’, ‘content_type_uid’, and ‘type’ queries.
     def sync(params)

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 the branch for publish content.
+    #
+    # Example
+    #
+    #    @entry = @stack.content_type('product').entry(entry_uid)
+    #    @entry.include_branch
+    #
+    # @return [Contentstack::Entry]
+    def include_branch(flag=true)
+      @query[:include_branch] = flag
+      self
+    end
+
     # Include Embedded Objects (Entries and Assets) along with entry/entries details.
     #
     # Example

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
 
@@ -287,7 +289,7 @@ module Contentstack
     end
 
     # This method provides only the entries matching the specified value.
-    #
+    # @deprecated since version 0.5.0
     # @param [String] text value used to match or compare
     #
     # Example
@@ -516,6 +518,19 @@ module Contentstack
       self
     end
 
+    # Include the branch for publish content.
+    #
+    # Example
+    #
+    #    @query = @stack.content_type('product').query
+    #    @query.include_branch
+    #
+    # @return [Contentstack::Entry]
+    def include_branch(flag=true)
+      @query[:include_branch] = flag
+      self
+    end
+
     # Include Embedded Objects (Entries and Assets) along with entry/entries details.
     #
     # Example

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/contentstack.rb

@@ -4,8 +4,6 @@ require "contentstack/version"
 require "contentstack/client"
 require "contentstack/region"
 require "contentstack_utils"
-require "util"
-
 
 # == 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.
@@ -17,6 +15,8 @@ require "util"
 #   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"region": Contentstack::Region::EU })
 # == Initialize the Stack for custom host
 #   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"host": "https://custom-cdn.contentstack.com" })
+# == Initialize the Stack for EU region
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"branch":"branch_name" })
 # == Usage
 # ==== Get single entry
 #   @stack.content_type('blog').entry('<entry_uid_here>').fetch
@@ -26,4 +26,7 @@ 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