contentstack 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38cb9c00678c71f0e4d00449b051bdbfa8e743141c95989d27caf58802665a28
-  data.tar.gz: f916dfd420ea954d7d01208ab97df9e7e2d8a97777449bef101a39d41d4f720d
+  metadata.gz: 8d05c5b008fe472ff0f8440f69c7226645ef13db5b6d6d75b1de0d4d2cf9dcec
+  data.tar.gz: 015ec71ca2e816f17f6f274e992b5273a04a5303e0eb1a67a1b6449743b8847f
 SHA512:
-  metadata.gz: a7491b3bf5648675b9fd069bdf8dfff2c70e51d75594f1f2629b54632ca616be27cdebc6487dac9eb9f8fc242a440cd783167b94b0707f1a1879a925cde22301
-  data.tar.gz: f32ceecfa27bf63e217bcf27a6f11b62c054e2bef6a74c61a6659ff1508cdd4b8f5d14fb95b2df6814254e09e8898e18269a852bfc3eff925e53de6da4d293fa
+  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/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    contentstack (0.5.0)
+    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.5)
+    activesupport (6.1.6.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -25,10 +25,10 @@ GEM
     diff-lcs (1.4.4)
     docile (1.4.0)
     hashdiff (1.0.1)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     mini_portile2 (2.8.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     nokogiri (1.13.4)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
@@ -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.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby

data/lib/contentstack/api.rb

@@ -7,7 +7,7 @@ require 'util'
 module Contentstack
   class API
     using Utility
-    def self.init_api(api_key, delivery_token, environment, host, branch, live_preview)
+    def self.init_api(api_key, delivery_token, environment, host, branch, live_preview, proxy, retry_options)
       @host = host
       @api_version = '/v3'
       @environment = environment
@@ -16,6 +16,11 @@ module Contentstack
       @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= {})
@@ -29,7 +34,7 @@ module Contentstack
       else
         path = "/content_types"
       end
-      send_request(path, {})
+      fetch_retry(path, {})
     end
 
     def self.fetch_entries(content_type, query)
@@ -38,7 +43,7 @@ module Contentstack
         send_preview_request(path, query)  
       else
         path = "/content_types/#{content_type}/entries"
-        send_request(path, query)
+        fetch_retry(path, query)
       end
     end
 
@@ -48,22 +53,37 @@ module Contentstack
         send_preview_request(path, query)  
       else
         path = "/content_types/#{content_type}/entries/#{entry_uid}"
-        send_request(path, query)
+        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 ||= {}
 
@@ -75,12 +95,44 @@ module Contentstack
         "api_key" =>  @api_key,
         "access_token"=>  @access_token,
         "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
-        "x-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
-      ActiveSupport::JSON.decode(URI.open("#{@host}#{@api_version}#{path}#{query}", params).read)
+
+      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)
@@ -94,12 +146,43 @@ module Contentstack
         "api_key" =>  @api_key,
         "authorization" => @live_preview[:management_token],
         "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
-        "x-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
-      ActiveSupport::JSON.decode(URI.open("#{preview_host}#{@api_version}#{path}#{query}",params).read)
+      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,17 +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]
       @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)
+      @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

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}})
@@ -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')
     #

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentstack
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Contentstack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,6 +113,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/sast-scan.yml"
+- ".github/workflows/sca-scan.yml"
+- ".github/workflows/secrets-scan.yml"
 - ".gitignore"
 - ".talismanrc"
 - ".yardopts"
@@ -178,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Contentstack Ruby client for the Content Delivery API