contentful-management 3.11.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11d5eba1080e56f80928b6e0b5eef8425b72c976fa814c78eef67b80eeb92c0
-  data.tar.gz: f7991340fd7452cd04503d8c036b36800629809e532a85dae6575efde55fafa9
+  metadata.gz: d3d63b88cb40993d64e55a0f9a50989a3e99963891555c7e68da940808147c7d
+  data.tar.gz: 7e246681551ffdfce7d5382cf614d95b5e0c556c577aab035ca82ba3eae56510
 SHA512:
-  metadata.gz: 6030d1c3af5683ccbd8596c4643c9ed32ff2776c4c409b1bf7c53000e9fed7a841695a458471a40752ba4b7abaa76f3162c3a7e9759cf2673d1f0f399682da01
-  data.tar.gz: 37c6ebbebb2502d64ea3e70f98036e5d81bff2503da5c6b7c41bfe92e37812b178e9fbb8d758ed80a0d6f76c022744f5038b0fbb5d870c3584bfe84a3e3c208b
+  metadata.gz: 4b3951f8ea5f59c913ff237226bba6570905312267b36088bd011fbf07e8befe2b4edf4d8e5561a1c35db5b094bc303488b8581b092e89e5a9ba6ade2df70173
+  data.tar.gz: 2fafc92979fbee9f7d28d9467f778b02b8478861055b7a55259c1b10b3ebcedc5fc6b41b74d6addc5006a9fe16a90fff388588e873651c42426d6ebd727b4b31

data/.github/workflows/codeql.yml

@@ -0,0 +1,32 @@
+---
+name: "CodeQL Scan for GitHub Actions Workflows"
+
+on:
+  push:
+    branches: [master]
+    paths: [".github/workflows/**"]
+  pull_request:
+    branches: [master]
+    paths: [".github/workflows/**"]
+
+jobs:
+  analyze:
+    name: Analyze GitHub Actions workflows
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: actions
+
+      - name: Run CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: actions

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ### Unreleased
 
+## 3.12.0
+* Add support for Taxonomy endpoints
+
 ## 3.11.0
 * Add support for general editor interfaces endpoint
 

data/README.md

@@ -1,7 +1,7 @@
 # Contentful::Management
 [![Gem Version](https://badge.fury.io/rb/contentful-management.svg)](http://badge.fury.io/rb/contentful-management) [![CircleCI](https://circleci.com/gh/contentful/contentful-management.rb/tree/master.svg?style=svg)](https://app.circleci.com/pipelines/github/contentful/contentful-management.rb?branch=master)
 
-Ruby client for the Contentful Content Management API.
+Ruby client for the Contentful Content Management API (CMA).
 
 [Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
 
@@ -711,6 +711,34 @@ Tagging an asset:
 asset.update(_metadata: {"tags": [{ "sys": { "type": "Link", "linkType": "Tag", "id": "fooTag" } }]})
 ```
 
+### Concepts
+
+Adding concepts to an entry:
+
+```ruby
+entry.update(_metadata: {"concepts": [{ "sys": { "type": "Link", "linkType": "TaxonomyConcept", "id": "concept_id" } }]})
+```
+
+Adding concepts to an asset:
+
+```ruby
+asset.update(_metadata: {"concepts": [{ "sys": { "type": "Link", "linkType": "TaxonomyConcept", "id": "concept_id" } }]})
+```
+
+Adding concepts to a content type:
+
+```ruby
+content_type.update(_metadata: {"concepts": [{ "sys": { "type": "Link", "linkType": "TaxonomyConcept", "id": "concept_id" } }]})
+```
+
+Removing concepts from an entry, asset, or content type:
+
+```ruby
+entry.update(_metadata: {"concepts": [], "tags": []})
+asset.update(_metadata: {"concepts": [], "tags": []})
+content_type.update(_metadata: {"concepts": []})
+```
+
 ### Roles
 
 Retrieving all roles from the space:
@@ -972,6 +1000,104 @@ Retrieving one user by ID from the space:
 user = blog_space.users.find('user_id')
 ```
 
+### Taxonomy
+
+Retrieving all concepts from an organization:
+
+```ruby
+concepts = client.taxonomy_concepts('organization_id').all
+```
+
+Retrieving one concept by ID from an organization:
+
+```ruby
+concept = client.taxonomy_concepts('organization_id').find('concept_id')
+```
+
+Creating a concept:
+
+```ruby
+client.taxonomy_concepts('organization_id').create(prefLabel: { 'en-US' => 'Bicycles' })
+```
+
+Creating a concept with a user-defined ID:
+
+```ruby
+client.taxonomy_concepts('organization_id').create(id: 'my-custom-id', prefLabel: { 'en-US' => 'Bicycles' })
+```
+
+Updating a concept:
+
+```ruby
+concept.update([
+  { op: 'add', path: '/prefLabel/en-US', value: 'New Label' }
+])
+```
+
+Destroying a concept:
+
+```ruby
+concept.destroy
+```
+
+Fetching the ancestors of a concept:
+
+```ruby
+concept.ancestors
+```
+
+Fetching the descendants of a concept:
+
+```ruby
+concept.descendants
+```
+
+Fetching the total number of concepts:
+
+```ruby
+client.taxonomy_concepts('organization_id').total
+```
+
+### Concept Schemes
+
+Retrieving all concept schemes from an organization:
+
+```ruby
+concept_schemes = client.taxonomy_concept_schemes('organization_id').all
+```
+
+Retrieving one concept scheme by ID from an organization:
+
+```ruby
+concept_scheme = client.taxonomy_concept_schemes('organization_id').find('concept_scheme_id')
+```
+
+Updating a concept scheme:
+
+```ruby
+concept_scheme.update([
+  { op: 'add', path: '/prefLabel/en-US', value: 'New Scheme Name' }
+])
+```
+
+Destroying a concept scheme:
+
+```ruby
+concept_scheme.destroy
+```
+
+Creating a concept scheme:
+
+```ruby
+client.taxonomy_concept_schemes('organization_id').create(prefLabel: { 'en-US' => 'New Scheme' })
+```
+
+Fetching the total number of concept schemes:
+
+```ruby
+client.taxonomy_concept_schemes('organization_id').total
+```
+
 ### UI Extensions
 
 Retrieving all UI extensions from the environment:

data/lib/contentful/management/client.rb

@@ -35,6 +35,8 @@ require 'contentful/management/client_editor_interface_methods_factory'
 require 'contentful/management/client_space_periodic_usage_methods_factory'
 require 'contentful/management/client_personal_access_tokens_methods_factory'
 require 'contentful/management/client_organization_periodic_usage_methods_factory'
+require 'contentful/management/client_taxonomy_concept_methods_factory'
+require 'contentful/management/client_taxonomy_concept_scheme_methods_factory'
 
 module Contentful
   module Management
@@ -152,6 +154,24 @@ module Contentful
         ClientSpacePeriodicUsageMethodsFactory.new(self, organization_id)
       end
 
+      # Allows manipulation of taxonomy concepts in context of the current client
+      # Allows listing all taxonomy concepts for client, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientTaxonomyConceptMethodsFactory]
+      def taxonomy_concepts(organization_id)
+        ClientTaxonomyConceptMethodsFactory.new(self, organization_id)
+      end
+
+      # Allows manipulation of taxonomy concept schemes in context of the current client
+      # Allows listing all taxonomy concept schemes for client, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientTaxonomyConceptSchemeMethodsFactory]
+      def taxonomy_concept_schemes(organization_id)
+        ClientTaxonomyConceptSchemeMethodsFactory.new(self, organization_id)
+      end
+
       # Allows viewing of users in context of the current client
       # Allows listing all users for client.
       # @see _ README for details.
@@ -474,6 +494,13 @@ module Contentful
         end
       end
 
+      # @private
+      def patch(request)
+        execute_request(request) do |url|
+          http_send(:patch, url, { json: request.query }, request_headers(request), proxy_parameters)
+        end
+      end
+
       # Proxy Helper
       #
       # @param [Symbol] type

data/lib/contentful/management/client_taxonomy_concept_methods_factory.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Taxonomy Concept API for usage from within Client
+    # @private
+    class ClientTaxonomyConceptMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def initialize(client, organization_id)
+        super(client)
+        @organization_id = organization_id
+      end
+
+      def find(resource_id)
+        associated_class.find(client, @organization_id, resource_id)
+      end
+
+      def all(query = {})
+        associated_class.all(client, @organization_id, query)
+      end
+
+      def create(attributes)
+        associated_class.create(client, @organization_id, attributes)
+      end
+
+      def total
+        associated_class.total(client, @organization_id)
+      end
+    end
+  end
+end

data/lib/contentful/management/client_taxonomy_concept_scheme_methods_factory.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Taxonomy Concept Scheme API for usage from within Client
+    # @private
+    class ClientTaxonomyConceptSchemeMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def initialize(client, organization_id)
+        super(client)
+        @organization_id = organization_id
+      end
+
+      def find(resource_id)
+        associated_class.find(client, @organization_id, resource_id)
+      end
+
+      def all(query = {})
+        associated_class.all(client, @organization_id, query)
+      end
+
+      def create(attributes)
+        associated_class.create(client, @organization_id, attributes)
+      end
+
+      def total
+        associated_class.total(client, @organization_id)
+      end
+    end
+  end
+end

data/lib/contentful/management/content_type.rb

@@ -7,6 +7,7 @@ require_relative 'validation'
 require_relative 'resource/publisher'
 require_relative 'resource/all_published'
 require_relative 'resource/environment_aware'
+require_relative 'resource/metadata'
 require_relative 'content_type_entry_methods_factory'
 require_relative 'content_type_snapshot_methods_factory'
 require_relative 'content_type_editor_interface_methods_factory'
@@ -37,6 +38,7 @@ module Contentful
       extend Contentful::Management::Resource::AllPublished
       include Contentful::Management::Resource::EnvironmentAware
       include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Metadata
 
       property :name, :string
       property :description, :string
@@ -170,6 +172,7 @@ module Contentful
         parameters[:name] = attributes[:name] || name
         parameters[:description] = attributes[:description] || description
         parameters[:fields] = self.class.fields_to_nested_properties_hash(attributes[:fields] || fields)
+        parameters[:metadata] = attributes.delete(:_metadata) if attributes.key?(:_metadata)
 
         parameters.delete_if { |_, v| v.nil? }
       end

data/lib/contentful/management/resource/metadata.rb

@@ -30,8 +30,11 @@ module Contentful
           return unless object.key?('metadata')
 
           object['metadata'].each do |key, value|
-            @_metadata[key.to_sym] = if key == 'tags'
+            @_metadata[key.to_sym] = case key
+                                     when 'tags'
                                        coerce_tags(value)
+                                     when 'concepts'
+                                       coerce_concepts(value)
                                      else
                                        value
                                      end
@@ -41,6 +44,10 @@ module Contentful
         def coerce_tags(tags)
           tags.map { |tag| Contentful::Management::Link.new(tag) }
         end
+
+        def coerce_concepts(concepts)
+          concepts.map { |concept| Contentful::Management::Link.new(concept) }
+        end
       end
     end
   end

data/lib/contentful/management/resource_builder.rb

@@ -28,6 +28,8 @@ require_relative 'editor_interface'
 require_relative 'space_periodic_usage'
 require_relative 'personal_access_token'
 require_relative 'organization_periodic_usage'
+require_relative 'taxonomy_concept'
+require_relative 'taxonomy_concept_scheme'
 
 module Contentful
   module Management
@@ -62,7 +64,9 @@ module Contentful
         'EditorInterface' => Contentful::Management::EditorInterface,
         'Snapshot' => Contentful::Management::Snapshot,
         'Upload' => Contentful::Management::Upload,
-        'Tag' => Contentful::Management::Tag
+        'Tag' => Contentful::Management::Tag,
+        'TaxonomyConcept' => Contentful::Management::TaxonomyConcept,
+        'TaxonomyConceptScheme' => Contentful::Management::TaxonomyConceptScheme
       }.freeze
 
       # Default Entry Mapping

data/lib/contentful/management/resource_requester.rb

@@ -54,6 +54,17 @@ module Contentful
       end
       alias unpublish unarchive
 
+      def patch(endpoint_options = {}, attributes = {}, headers = {})
+        request = Request.new(
+          client,
+          resource_class.build_endpoint(endpoint_options),
+          attributes,
+          nil,
+          headers
+        )
+        ResourceBuilder.new(client.patch(request), client).run
+      end
+
       private
 
       def resource_class?(object)

data/lib/contentful/management/taxonomy_concept.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+require_relative 'resource/system_properties'
+require_relative 'resource/refresher'
+
+module Contentful
+  module Management
+    # Resource class for TaxonomyConcept.
+    # https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept
+    class TaxonomyConcept
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :uri, :string
+      property :prefLabel, :hash
+      property :altLabels, :hash
+      property :hiddenLabels, :hash
+      property :notations, :array
+      property :note, :hash
+      property :changeNote, :hash
+      property :definition, :hash
+      property :editorialNote, :hash
+      property :example, :hash
+      property :historyNote, :hash
+      property :scopeNote, :hash
+      property :broader, :array
+      property :related, :array
+      property :conceptSchemes, :array
+
+      # Finds a Taxonomy Concept by ID.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] organization_id
+      # @param [String] concept_id
+      #
+      # @return [Contentful::Management::TaxonomyConcept]
+      def self.find(client, organization_id, concept_id)
+        requester = ResourceRequester.new(client, self)
+        requester.find(
+          id: concept_id,
+          organization_id: organization_id
+        )
+      end
+
+      def self.all(client, organization_id, query = {})
+        requester = ResourceRequester.new(client, self)
+        requester.all({ organization_id: organization_id }, query)
+      end
+
+      def self.total(client, organization_id)
+        response = client.get(
+          Request.new(
+            client,
+            build_endpoint(total: true, organization_id: organization_id)
+          )
+        )
+        response.object['total']
+      end
+
+      def self.create(client, organization_id, attributes)
+        requester = ResourceRequester.new(client, self)
+        requester.create(
+          {
+            organization_id: organization_id,
+            id: attributes[:id]
+          }.compact,
+          attributes
+        )
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        attributes
+      end
+
+      def update(patch_operations)
+        requester = ResourceRequester.new(client, self.class)
+        requester.patch(
+          {
+            organization_id: sys[:organization].id,
+            id: id
+          },
+          patch_operations,
+          {
+            'Content-Type' => 'application/json-patch+json',
+            'X-Contentful-Version' => sys[:version].to_s
+          }
+        )
+      end
+
+      def destroy
+        requester = ResourceRequester.new(client, self.class)
+        requester.destroy(
+          {
+            organization_id: sys[:organization].id,
+            id: id
+          },
+          {},
+          { 'X-contentful-version' => sys[:version].to_s }
+        )
+      end
+
+      def ancestors(query = {})
+        requester = ResourceRequester.new(client, self.class)
+        endpoint_options = {
+          organization_id: sys[:organization].id,
+          id: id,
+          ancestors: true
+        }
+        requester.all(endpoint_options, query)
+      end
+
+      def descendants(query = {})
+        requester = ResourceRequester.new(client, self.class)
+        endpoint_options = {
+          organization_id: sys[:organization].id,
+          id: id,
+          descendants: true
+        }
+        requester.all(endpoint_options, query)
+      end
+
+      # @private
+      def self.build_endpoint(endpoint_options = {})
+        organization_id = endpoint_options[:organization_id]
+        base_url = "organizations/#{organization_id}/taxonomy/concepts"
+
+        return "#{base_url}/total" if endpoint_options[:total]
+
+        if endpoint_options.key?(:id)
+          concept_url = "#{base_url}/#{endpoint_options[:id]}"
+          return "#{concept_url}/ancestors" if endpoint_options[:ancestors]
+          return "#{concept_url}/descendants" if endpoint_options[:descendants]
+
+          concept_url
+        else
+          base_url
+        end
+      end
+    end
+  end
+end

data/lib/contentful/management/taxonomy_concept_scheme.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+require_relative 'resource/system_properties'
+require_relative 'resource/refresher'
+
+module Contentful
+  module Management
+    # Resource class for TaxonomyConceptScheme.
+    # https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme
+    class TaxonomyConceptScheme
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :uri, :string
+      property :prefLabel, :hash
+      property :definition, :hash
+      property :topConcepts, :array
+      property :concepts, :array
+      property :totalConcepts, :integer
+
+      # Finds a Taxonomy Concept Scheme by ID.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] organization_id
+      # @param [String] concept_scheme_id
+      #
+      # @return [Contentful::Management::TaxonomyConceptScheme]
+      def self.find(client, organization_id, concept_scheme_id)
+        requester = ResourceRequester.new(client, self)
+        requester.find(
+          id: concept_scheme_id,
+          organization_id: organization_id
+        )
+      end
+
+      def self.all(client, organization_id, query = {})
+        requester = ResourceRequester.new(client, self)
+        requester.all({ organization_id: organization_id }, query)
+      end
+
+      def self.total(client, organization_id)
+        response = client.get(
+          Request.new(
+            client,
+            build_endpoint(total: true, organization_id: organization_id)
+          )
+        )
+        response.object['total']
+      end
+
+      def self.create(client, organization_id, attributes)
+        requester = ResourceRequester.new(client, self)
+        requester.create(
+          { organization_id: organization_id },
+          attributes
+        )
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        attributes
+      end
+
+      def update(patch_operations)
+        requester = ResourceRequester.new(client, self.class)
+        requester.patch(
+          {
+            organization_id: sys[:organization].id,
+            id: id
+          },
+          patch_operations,
+          {
+            'Content-Type' => 'application/json-patch+json',
+            'X-Contentful-Version' => sys[:version].to_s
+          }
+        )
+      end
+
+      def destroy
+        requester = ResourceRequester.new(client, self.class)
+        requester.destroy(
+          {
+            organization_id: sys[:organization].id,
+            id: id
+          },
+          {},
+          { 'X-Contentful-Version' => sys[:version].to_s }
+        )
+      end
+
+      # @private
+      def self.build_endpoint(endpoint_options = {})
+        organization_id = endpoint_options[:organization_id]
+        base_url = "organizations/#{organization_id}/taxonomy/concept-schemes"
+
+        return "#{base_url}/total" if endpoint_options[:total]
+
+        if endpoint_options.key?(:id)
+          "#{base_url}/#{endpoint_options[:id]}"
+        else
+          base_url
+        end
+      end
+    end
+  end
+end

data/lib/contentful/management/version.rb

@@ -5,6 +5,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '3.11.0'
+    VERSION = '3.12.0'
   end
 end