contentstack 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a87ffedb4feafb037dccf082f50e3e2df92db4f68bbb2278c69fc6209ebd0f97
-  data.tar.gz: b89fca962f1c9fe6c2839f41fe3ce761eed92f2329229dc41b3cb79383e40b7a
+  metadata.gz: 38cb9c00678c71f0e4d00449b051bdbfa8e743141c95989d27caf58802665a28
+  data.tar.gz: f916dfd420ea954d7d01208ab97df9e7e2d8a97777449bef101a39d41d4f720d
 SHA512:
-  metadata.gz: d4af764bf1af5cd485a49bdb6ff127bd0a9a079f562c82a7ee27c79776324dd9b7c297291d1af71aadab8c19c7b0d989aede075689b7998b5d8ff858d65e8ce4
-  data.tar.gz: 128181df6d6b5e93ec1ea4bee2ce3c6c9afad74fb2519cf52f0d9b41a7a57519935ae7e7ebb00db45dbbb56c98471b443105ea5e560f63e49f544f53e06befb0
+  metadata.gz: a7491b3bf5648675b9fd069bdf8dfff2c70e51d75594f1f2629b54632ca616be27cdebc6487dac9eb9f8fc242a440cd783167b94b0707f1a1879a925cde22301
+  data.tar.gz: f32ceecfa27bf63e217bcf27a6f11b62c054e2bef6a74c61a6659ff1508cdd4b8f5d14fb95b2df6814254e09e8898e18269a852bfc3eff925e53de6da4d293fa

data/.gitignore

@@ -9,3 +9,4 @@ coverage
 .bundle/
 **/rspec_results.html
 vendor/
+.dccache

data/.talismanrc

@@ -0,0 +1 @@
+threshold: medium

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 ## CHANGELOG
+------------------------------------------------
+## 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

data/CODEOWNERS

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

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    contentstack (0.4.1)
+    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.4)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -16,8 +16,8 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.9)
-    contentstack_utils (1.0.2)
+    concurrent-ruby (1.1.10)
+    contentstack_utils (1.1.0)
       activesupport (>= 3.2, < 6.2)
       nokogiri (~> 1.11, >= 1.11.0)
     crack (0.4.5)
@@ -25,15 +25,15 @@ GEM
     diff-lcs (1.4.4)
     docile (1.4.0)
     hashdiff (1.0.1)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.5.3)
-    minitest (5.14.4)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
       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)
@@ -61,7 +61,7 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.26)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2021 Contentstack. All Rights Reserved
+Copyright (c) 2012-2022 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

data/README.md

@@ -116,7 +116,7 @@ In a single instance, the [Get Multiple Entries](https://www.contentstack.com/do
 
 We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on. 
 
-For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, https://images.contentstack.io/v3/assets/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/download?crop=300,400. There are several more parameters that you can use for your images. 
+For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, https://images.contentstack.io/v3/download?crop=300,400. There are several more parameters that you can use for your images. 
 
 [Read Image Delivery API documentation](https://www.contentstack.com/docs/apis/image-delivery-api/). 
 

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/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(URI.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(URI.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(URI.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.2"
+  VERSION = "0.5.1"
 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

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