contentstack 0.6.3.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f14695f1861ed1b07a85cfe6d23e722c2a6a33903728e2e06e4807838d730ff
-  data.tar.gz: a86c8a4d86482aa468c1ac1e8358621e9088338f5e011d70e49b2558175a769b
+  metadata.gz: 151e081a79919a89260f63ea374d5c4ab54428d07468efbcf0ba4c5316d4ca4f
+  data.tar.gz: 82cd520466c27d4e1bc23d07695fedfeefef9931385eb8607f283ce37b065143
 SHA512:
-  metadata.gz: bfef2767aa76ecc46237715014e9911b35d86e29213b44cb5a5a380a78bb36b356ac35cb1cc8150b0b0518e109b3656aa89a0a30a99f04246deae05070758f80
-  data.tar.gz: 8f2ea750a2ba6aa291e53f578b3f7a41ae4018e7930215899bc3cbc5b6315d6c737df16430c943805143f5663b4d3acebf6fd4979e8dcfa54c3f7921061d8784
+  metadata.gz: 2d3b5c78d18430d184ef95694570b6af0c8574ef697f7861733797c05ef9ae5fa969d79b7e14533c4730fb10d9eab491484ca634941c3c67606927c7a9b764a1
+  data.tar.gz: 72d63d5c25715a236e007f46b5e0fe92663d33eaf994ab5bfb8669c43c77aa7f48b972f1b535e30c5acaeba20aa1e6b2134149dc5c7edae9dba546e2a985534a

data/.github/workflows/check-branch.yml

@@ -0,0 +1,20 @@
+name: 'Check Branch'
+
+on:
+  pull_request:
+
+jobs:
+  check_branch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment PR
+        if: github.base_ref == 'master' && github.head_ref != 'next'
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          message: |
+            We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the next branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch.
+      - name: Check branch
+        if: github.base_ref == 'master' && github.head_ref != 'next'
+        run: |
+          echo "ERROR: We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the next branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch."
+          exit 1

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

@@ -1,68 +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
+# 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/jira.yml

@@ -1,28 +1,28 @@
-name: Create JIRA ISSUE
-on:
-  pull_request:
-    types: [opened]
-jobs:
-  security:
-    if: ${{ github.actor == 'dependabot[bot]' || github.actor == 'snyk-bot' || contains(github.event.pull_request.head.ref, 'snyk-fix-')  || contains(github.event.pull_request.head.ref, 'snyk-upgrade-')}}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Login into JIRA
-        uses: atlassian/gajira-login@master
-        env:
-          JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
-          JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
-          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
-      - name: Create a JIRA Issue
-        id: create
-        uses: atlassian/gajira-create@master
-        with:
-          project: ${{ secrets.JIRA_PROJECT }}
-          issuetype: ${{ secrets.JIRA_ISSUE_TYPE }}
-          summary: |
-            ${{ github.event.pull_request.title }}
-          description: |
-            PR: ${{ github.event.pull_request.html_url }}
-
-          fields: "${{ secrets.JIRA_FIELDS }}"
+name: Create JIRA ISSUE
+on:
+  pull_request:
+    types: [opened]
+jobs:
+  security:
+    if: ${{ github.actor == 'dependabot[bot]' || github.actor == 'snyk-bot' || contains(github.event.pull_request.head.ref, 'snyk-fix-')  || contains(github.event.pull_request.head.ref, 'snyk-upgrade-')}}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Login into JIRA
+        uses: atlassian/gajira-login@master
+        env:
+          JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
+          JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
+          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+      - name: Create a JIRA Issue
+        id: create
+        uses: atlassian/gajira-create@master
+        with:
+          project: ${{ secrets.JIRA_PROJECT }}
+          issuetype: ${{ secrets.JIRA_ISSUE_TYPE }}
+          summary: |
+            ${{ github.event.pull_request.title }}
+          description: |
+            PR: ${{ github.event.pull_request.html_url }}
+
+          fields: "${{ secrets.JIRA_FIELDS }}"

data/.github/workflows/release-gem.yml

@@ -1,31 +1,31 @@
-name: Ruby Gem
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
+name: Ruby Gem
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
         GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

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

@@ -1,11 +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
+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

@@ -1,15 +1,15 @@
-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/ruby@master
-        env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-        with:
-          args: --fail-on=all
+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/ruby@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+        with:
+          args: --fail-on=all

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

@@ -1,11 +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
+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

@@ -1,12 +1,12 @@
-contentstack-*
-build_doc.sh
-test
-doc
-spec-integration
-coverage
-\.yardoc
-.DS_Store
-.bundle/
-**/rspec_results.html
-vendor/
+contentstack-*
+build_doc.sh
+test
+doc
+spec-integration
+coverage
+\.yardoc
+.DS_Store
+.bundle/
+**/rspec_results.html
+vendor/
 .dccache

data/.yardopts

@@ -1,6 +1,6 @@
-README.rdoc
-lib/contentstack/*
-lib/contentstack.rb
---exclude lib/contentstack/util.rb
---exclude lib/contentstack/api.rb
---exclude lib/contentstack/version.rb
+README.rdoc
+lib/contentstack/*
+lib/contentstack.rb
+--exclude lib/contentstack/util.rb
+--exclude lib/contentstack/api.rb
+--exclude lib/contentstack/version.rb

data/CHANGELOG.md

@@ -1,115 +1,130 @@
-## CHANGELOG
-
-## Version 0.6.3
-### Date: 16th-Mar-2023
- ### Package Update
- - Dependency gem max version issue resolved.
-
-------------------------------------------------
-## Version 0.6.2
-### Date: 27th-Feb-2023
- ### Package Update
- - Dependency gem update.
-
-------------------------------------------------
-## Version 0.6.1
-### Date: 9th-Sept-2022
- ### Bug
- - Live Preview feature for entry with reference update.
-
-------------------------------------------------
-## Version 0.6.0
-### Date: 17th-Aug-2022
- ### New Features
- - Proxy and Retry functionality support added.
-
-------------------------------------------------
-## Version 0.5.1
-### Date: 21st-Apr-2022
- ### Package Update
- - API request with URI.OPEN issue resolved.
-
-------------------------------------------------
-## Version 0.5.0
-### Date: 8th-Dec-2021
- ### New Feature
- - 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
- ### New Features
- - Sync API module support added
-
- ------------------------------------------------
-## Version 0.2.0
-
- ### New Features
-  - Entry 
-    - locale - function for passing locale is added
-    - only - function for getting only specified field
-    - except - function for getting field except specified field
-    - include_reference - function for including reference in entry
-    - include_schema - function for including schema along with entry added
-    - include_content_type - function for including content type details along with entry added
-    - include_owner - function for getting owner of entry
-    - include_fallback - function for getting published fallback locale content, if specified locale content is not published
-
-  - Query 
-    - include_fallback - function for getting published fallback locale content, if specified locale content is not published
-
-
-------------------------------------------------
-
-## Version 0.1.0
-
- ### Bug
-  - Stack Tokens Moved to Headers
-
-------------------------------------------------
-
-## Version 0.0.4
-
- ### Enhancement
-  - Region support added
-
-------------------------------------------------
-
-## Version 0.0.3
-
- ### Enhancement
-  - Query - function for passing locale is added.
-
-------------------------------------------------
-
-## Version 0.0.1
-
- - Initial release 
-
+## CHANGELOG
+
+## Version 0.6.4
+### Date: 17th-Apr-2023
+ ### Enhancement
+ - Include metadata support for Asset, Entry and Query,
+ - Region support for Azure-EU added
+
+------------------------------------------------
+
+## Version 0.6.3.1
+### Date: 17th-Mar-2023
+ ### Package Update
+ - Activesupport gem version limit removed (for supporting ruby v3.0 and above) .
+
+------------------------------------------------
+
+## Version 0.6.3
+### Date: 16th-Mar-2023
+ ### Package Update
+ - Dependency gem max version issue resolved.
+
+------------------------------------------------
+## Version 0.6.2
+### Date: 27th-Feb-2023
+ ### Package Update
+ - Dependency gem update.
+
+------------------------------------------------
+## Version 0.6.1
+### Date: 9th-Sept-2022
+ ### Bug
+ - Live Preview feature for entry with reference update.
+
+------------------------------------------------
+## Version 0.6.0
+### Date: 17th-Aug-2022
+ ### New Features
+ - Proxy and Retry functionality support added.
+
+------------------------------------------------
+## Version 0.5.1
+### Date: 21st-Apr-2022
+ ### Package Update
+ - API request with URI.OPEN issue resolved.
+
+------------------------------------------------
+## Version 0.5.0
+### Date: 8th-Dec-2021
+ ### New Feature
+ - 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
+ ### New Features
+ - Sync API module support added
+
+ ------------------------------------------------
+## Version 0.2.0
+
+ ### New Features
+  - Entry 
+    - locale - function for passing locale is added
+    - only - function for getting only specified field
+    - except - function for getting field except specified field
+    - include_reference - function for including reference in entry
+    - include_schema - function for including schema along with entry added
+    - include_content_type - function for including content type details along with entry added
+    - include_owner - function for getting owner of entry
+    - include_fallback - function for getting published fallback locale content, if specified locale content is not published
+
+  - Query 
+    - include_fallback - function for getting published fallback locale content, if specified locale content is not published
+
+
+------------------------------------------------
+
+## Version 0.1.0
+
+ ### Bug
+  - Stack Tokens Moved to Headers
+
+------------------------------------------------
+
+## Version 0.0.4
+
+ ### Enhancement
+  - Region support added
+
+------------------------------------------------
+
+## Version 0.0.3
+
+ ### Enhancement
+  - Query - function for passing locale is added.
+
+------------------------------------------------
+
+## Version 0.0.1
+
+ - Initial release 
+
 ------------------------------------------------

data/CODEOWNERS

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