contentstack 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9752caee17d0a0685f86068d868e188beb0221e75c7580e97fe5957ee60af9
-  data.tar.gz: 608036425d1fd793a8c4b0789628237a89c12ab29a981ffa6aeedd8fce31140d
+  metadata.gz: 8d05c5b008fe472ff0f8440f69c7226645ef13db5b6d6d75b1de0d4d2cf9dcec
+  data.tar.gz: 015ec71ca2e816f17f6f274e992b5273a04a5303e0eb1a67a1b6449743b8847f
 SHA512:
-  metadata.gz: 777e224fb7794aa8cb5e810ebb04447a55168d5c7cd0f6d3134c6e78fd57ef88f99c6ff7b020ce1fb1baab51aebe4ea3d2e151182e43649e552a52e81c582621
-  data.tar.gz: 47c32273f2510b09d0e46f656ebe7cdd91ee88c9caf32dd8baeb76fa712d829392d308a651d34edd465ee871b092a2eff03c15a49af4133dcc33fc2978035d13
+  metadata.gz: 380dee7e9afb6047034eff28239631bdeb6aacb964e1665aeee80dc9116c769c477f1f0c33a36dc0c701ec987df207e3fd1e747ba7edd37fc9a87de69590323e
+  data.tar.gz: 9d686de63a036bb5a5c159540148d8d3c305fca02967aaf4dd9ab1d5aeb1e038199ed1575a8f57a2ab15bf14e62d3bcc999dfe07f7587084e1e507d827746b54

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,68 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: '*'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/sast-scan.yml

@@ -0,0 +1,11 @@
+name: SAST Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Horusec Scan
+        run: docker run -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/src horuszup/horusec-cli:latest horusec start -p /src -P $(pwd)

data/.github/workflows/sca-scan.yml

@@ -0,0 +1,13 @@
+name: Source Composition Analysis Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Run Snyk to check for vulnerabilities
+        uses: snyk/actions/node@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

data/.github/workflows/secrets-scan.yml

@@ -0,0 +1,11 @@
+name: Secrets Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Gittyleaks
+        uses: gupy-io/gittyleaks-action@v0.1

data/.gitignore

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

data/.talismanrc

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

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    contentstack (0.4.1)
+    contentstack (0.6.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.6.1)
       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.12.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.16.2)
+    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)
@@ -54,14 +54,14 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     webmock (3.11.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.26)
-    zeitwerk (2.4.2)
+    zeitwerk (2.6.0)
 
 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

@@ -7,13 +7,25 @@ require 'util'
 module Contentstack
   class API
     using Utility
-    def self.init_api(api_key, delivery_token, environment,host)
+    def self.init_api(api_key, delivery_token, environment, host, branch, live_preview, proxy, retry_options)
       @host = host
       @api_version = '/v3'
       @environment = environment
       @api_key = api_key
       @access_token = delivery_token
+      @branch = branch
       @headers = {environment: @environment}
+      @live_preview = live_preview
+      @proxy_details = proxy
+      @timeout = retry_options["timeout"]
+      @retryDelay = retry_options["retryDelay"]
+      @retryLimit = retry_options["retryLimit"]
+      @errorRetry = retry_options["errorRetry"]
+    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="")
@@ -22,31 +34,56 @@ module Contentstack
       else
         path = "/content_types"
       end
-      send_request(path, {})
+      fetch_retry(path, {})
     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"
+        fetch_retry(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}"
+        fetch_retry(path, query)
+      end
     end
 
     def self.get_assets(asset_uid=nil)
       path = "/assets"
       path += "/#{asset_uid}" if !asset_uid.nil?
-      send_request(path)
+      fetch_retry(path)
     end
 
     def self.get_sync_items(query)
       path = "/stacks/sync"
-      send_request(path, query)
+      fetch_retry(path, query)
     end
 
     private
+    def self.fetch_retry(path, query=nil, count=0)
+      response = send_request(path, query)
+      if @errorRetry.include?(response["status_code"].to_i)
+        if count < @retryLimit
+          retryDelay_in_seconds = @retryDelay / 1000 #converting retry_delay from milliseconds into seconds
+          sleep(retryDelay_in_seconds.to_i) #sleep method requires time in seconds as parameter
+          response = fetch_retry(path, query, (count + 1))
+        else
+         raise Contentstack::Error.new(response) #Retry Limit exceeded
+        end  
+      else
+        response
+      end
+    end
+
     def self.send_request(path, q=nil)
       q ||= {}
 
@@ -54,12 +91,98 @@ 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}",
+        "read_timeout" => @timeout
+      }
+      if !@branch.nil? && !@branch.empty?
+        params["branch"] = @branch
+      end
+
+      begin
+        if @proxy_details.empty?
+          ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", params).read)
+        elsif @proxy_details.present? && @proxy_details[:url].present? && @proxy_details[:port].present? && @proxy_details[:username].present? && @proxy_details[:password].present?
+          proxy_uri = URI.parse("http://#{@proxy_details[:url]}:#{@proxy_details[:port]}/")
+          proxy_username = @proxy_details[:username]
+          proxy_password = @proxy_details[:password]
+         
+          if !@branch.nil? && !@branch.empty?
+            ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout, "branch" => @branch).read)
+          else
+            ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
+          end
+        elsif @proxy_details.present? && @proxy_details[:url].present? && @proxy_details[:port].present? && @proxy_details[:username].empty? && @proxy_details[:password].empty?
+          proxy_uri = URI.parse("http://#{@proxy_details[:url]}:#{@proxy_details[:port]}/")
+  
+          if !@branch.nil? && !@branch.empty?
+            ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout, "branch" => @branch).read)
+          else
+            ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "access_token"=>  @access_token, "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
+          end
+        end      
+        rescue OpenURI::HTTPError => error
+        response = error.io
+        #response.status
+        # => ["503", "Service Unavailable"] 
+        error_response = JSON.parse(response.string)
+        error_status = {"status_code" => response.status[0], "status_message" => response.status[1]}
+        error = error_response.merge(error_status)
+        raise Contentstack::Error.new(error.to_s)
+      end
+    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}",
+        "read_timeout" => @timeout
+      }
+      if !@branch.nil? && !@branch.empty?
+        params["branch"] = @branch
+      end
+      begin
+        if @proxy_details.empty?
+          ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}",params).read)
+        elsif @proxy_details.present? && @proxy_details[:url].present? && @proxy_details[:port].present? && @proxy_details[:username].present? && @proxy_details[:password].present?
+          proxy_uri = URI.parse("http://#{@proxy_details[:url]}:#{@proxy_details[:port]}/")
+          proxy_username = @proxy_details[:username]
+          proxy_password = @proxy_details[:password]
+  
+          if !@branch.nil? && !@branch.empty?
+            ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout, "branch" => @branch).read)
+          else
+            ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", :proxy_http_basic_authentication => [proxy_uri, proxy_username, proxy_password], "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
+          end
+        elsif @proxy_details.present? && @proxy_details[:url].present? && @proxy_details[:port].present? && @proxy_details[:username].empty? && @proxy_details[:password].empty?
+          proxy_uri = URI.parse("http://#{@proxy_details[:url]}:#{@proxy_details[:port]}/")
+          
+          if !@branch.nil? && !@branch.empty?
+            ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout, "branch" => @branch).read)
+          else
+            ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}", "proxy" => proxy_uri, "api_key" =>  @api_key, "authorization" => @live_preview[:management_token], "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}", "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}", "read_timeout" => @timeout).read)
+          end
+        end
+      rescue OpenURI::HTTPError => error
+        response = error.io
+        #response.status
+        # => ["503", "Service Unavailable"] 
+        error_response = JSON.parse(response.string)
+        error_status = {"status_code" => response.status[0], "status_message" => response.status[1]}
+        error = error_response.merge(error_status)
+        raise Contentstack::Error.new(error.to_s)
+      end
     end
   end
 end

data/lib/contentstack/client.rb

@@ -3,15 +3,37 @@ require 'contentstack/content_type'
 require 'contentstack/asset_collection'
 require 'contentstack/sync_result'
 require 'util'
+require 'contentstack/error'
 module Contentstack
   class Client
     using Utility
     attr_reader :region, :host
     # Initialize "Contentstack" Client instance
     def initialize(api_key, delivery_token, environment, options={})
+      raise Contentstack::Error.new("Api Key is not valid") if api_key.class != String
+      raise Contentstack::Error.new("Api Key Field Should not be Empty") if api_key.empty?
+      raise Contentstack::Error.new("Delivery Token is not valid") if delivery_token.class != String
+      raise Contentstack::Error.new("Delivery Token Field Should not be Empty") if delivery_token.empty?
+      raise Contentstack::Error.new("Envirnoment Field is not valid") if environment.class != String
+      raise Contentstack::Error.new("Envirnoment Field Should not be Empty") if environment.empty?
       @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]
+      @proxy_details = options[:proxy].nil? ? "" : options[:proxy]
+      @timeout = options[:timeout].nil? ? 3000 : options[:timeout]
+      @retryDelay = options[:retryDelay].nil? ? 3000 : options[:retryDelay]
+      @retryLimit = options[:retryLimit].nil? ? 5 : options[:retryLimit]
+      @errorRetry = options[:errorRetry].nil? ? [408, 429] : options[:errorRetry]
+      retry_options = {
+        "timeout" =>  @timeout.to_s,
+        "retryDelay"=>  @retryDelay,
+        "retryLimit"=> @retryLimit,
+        "errorRetry" => @errorRetry
+      }
+      raise Contentstack::Error.new("Proxy URL Should not be Empty") if @proxy_details.present? && @proxy_details[:url].empty?
+      raise Contentstack::Error.new("Proxy Port Should not be Empty") if @proxy_details.present? && @proxy_details[:port].empty?
+      API.init_api(api_key, delivery_token, environment,  @host, @branch, @live_preview, @proxy_details, retry_options)
     end
     
     def content_types
@@ -30,6 +52,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
     # 
@@ -43,9 +68,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/entry.rb

@@ -154,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/query.rb

@@ -249,10 +249,14 @@ module Contentstack
     # @param [String] field_uid UID of the field for which query should be executed
     # @param [String] values The possible values for the key's object
     #
-    # Example
+    # Example 1 - Array Equals Operator Within Group
     #    @query = @stack.content_type('category').query
     #    @query.contained_in("title", ["Electronics", "Apparel"])
     #
+    # Example 2 - Array Equals Operator Within Modular Blocks
+    #    @query = @stack.content_type('category').query
+    #    @query.contained_in("additional_info.deals.deal_name", ["Christmas Deal", "Summer Deal"])
+    #
     # @return [Contentstack::Query]
     def contained_in(field_uid, values)
       add_query_hash({:"#{field_uid}" => {"$in" => values}})
@@ -264,10 +268,14 @@ module Contentstack
     # @param [String] field_uid UID of the field for which query should be executed
     # @param [String] values The possible values for the key's object
     #
-    # Example
+    # Example 1 - Array Not-equals Operator Within Group
     #    @query = @stack.content_type('category').query
     #    @query.not_contained_in("title", ["Electronics", "Apparel"])
     #
+    # Example 2 - Array Not-equals Operator Within Modular Blocks
+    #    @query = @stack.content_type('category').query
+    #    @query.not_contained_in("additional_info.deals.deal_name", ["Christmas Deal", "Summer Deal"])
+    #
     # @return [Contentstack::Query]
     def not_contained_in(field_uid, values)
       add_query_hash({:"#{field_uid}" => {"$nin" => values}})
@@ -289,7 +297,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
@@ -377,6 +385,7 @@ module Contentstack
     # @param [String] code The locale code of the entry
     #
     # Example
+    #    Change language method
     #    @query = @stack.content_type('category').query
     #    @query.locale('en-us')
     #
@@ -518,6 +527,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.3"
+  VERSION = "0.6.0"
 end

data/lib/contentstack.rb

@@ -15,6 +15,8 @@ require "contentstack_utils"
 #   @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/spec/asset_spec.rb

@@ -5,43 +5,43 @@ describe Contentstack::Asset do
   let(:client) { create_client }
 
   it "has attribute called `uid`" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.uid).not_to be nil
   end
 
   it "should match uid" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.uid).to eq @uid
   end
 
   it "has attribute called `url`" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.url).not_to be nil
   end
 
   it "has attribute called `tags`" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.tags).not_to be nil
   end
 
   it "has attribute called `file_size`" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.file_size).not_to be nil
   end
 
   it "has attribute called `filename`" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.filename).not_to be nil
   end
 
   it "has attribute called `content_type`" do
-    @uid = "blt3ca1a3470787ba63"
+    @uid = "image_1"
     @asset = client.asset(@uid).fetch
     expect(@asset.content_type).not_to be nil
   end