contentful-management 3.2.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caefa93b06c479fb9b2d87a27e7d360b7c7cbd87fd4d849f083486df39bb43de
-  data.tar.gz: '029cebff0c301345930e183480a6e24d54e4a778ad5b8afda88cd15a3abef9d2'
+  metadata.gz: 60951b91e0b816f76ce81387b1be4d70673f7365b384161d3882fadbc04d947e
+  data.tar.gz: ffbde8522e8ffb96dd247f2c14508e48b505ca00f6e4c71047f905472cc30eb0
 SHA512:
-  metadata.gz: 838ee33007dd1b5caa7777e08aaafc1fc0f4a5869772dcf7e7eaab781e41e45454f8a91d78799e283d028ad4ad290f4d989c450d293171fcc41b1b8b28f38fc4
-  data.tar.gz: 6986a8b83df08cbb573634c5c35697c8ecfee5e27bc4e759ab90335ce88dacbf14ba5303eed081cc00aaedffc30546ca7751de122ab17239b84a7d404d49678a
+  metadata.gz: dbda6173a0e1cb13a62f4f9aa8274969a011bca71866aab1be0983f367dfabb6041b2cc132c9fbb5b4d22d235e9d07647c6ec28a6ebe84cfd2ddffb3f1c09271
+  data.tar.gz: fac67fa15e95c1dbdcf44c9ebe0934d7be17d54825dc24f16b12cea7a1b746f90ba31b301b4023040a815b97574b89eb3ad09c0f476f36eb3170dfeb02166cf7

data/.circleci/config.yml

@@ -0,0 +1,23 @@
+version: 2.1
+
+jobs:
+  test_and_lint:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    steps:
+      - checkout
+      - run: gem install bundler
+      - run: bundle install
+      - run: bundle exec rake rspec_rubocop
+
+workflows:
+  version: 2
+  workflow:
+    jobs:
+      - test_and_lint:
+          matrix:
+            parameters:
+              ruby-version: ["2.6", "2.7", "3.0"]

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master
 
+## 3.5.0
+* Added support for Entry References API
+
+## 3.4.0
+* Changed CI/CD vendor
+* Added support for Tags API
+
+## 3.3.0
+* Added getter/setter for EditorInterface#sidebar
+
 ## 3.2.0
 * Added support for parameters on Users API. [#227](https://github.com/contentful/contentful-management.rb/pull/227)
 

data/README.md

@@ -1,5 +1,5 @@
 # Contentful::Management
-[![Gem Version](https://badge.fury.io/rb/contentful-management.svg)](http://badge.fury.io/rb/contentful-management) [![Build Status](https://travis-ci.org/contentful/contentful-management.rb.svg)](https://travis-ci.org/contentful/contentful-management.rb)
+[![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.
 
@@ -640,6 +640,50 @@ Destroying a locale:
 blog_post_locale.destroy
 ```
 
+### Tags
+
+Retrieving all tags from the environment:
+
+```ruby
+tags = environment.tags.all
+```
+
+Retrieving one tag by ID from the environment:
+
+```ruby
+tag = environment.tags.find(tag_id)
+```
+
+Creating a tag:
+
+```ruby
+environment.tags.create(name: 'tag name', id: 'tagID')
+```
+
+Updating a tag:
+
+```ruby
+tag.update(name: 'new name')
+```
+
+Destroying a tag:
+
+```ruby
+tag.destroy
+```
+
+Tagging an entry:
+
+```ruby
+entry.update(_metadata: {"tags": [{ "sys": { "type": "Link", "linkType": "Tag", "id": "fooTag" } }]})
+```
+
+Tagging an asset:
+
+```ruby
+asset.update(_metadata: {"tags": [{ "sys": { "type": "Link", "linkType": "Tag", "id": "fooTag" } }]})
+```
+
 ### Roles
 
 Retrieving all roles from the space:

data/lib/contentful/management/asset.rb

@@ -40,7 +40,7 @@ module Contentful
         fields[:description] = { locale => attributes[:description] } if attributes[:description]
         fields[:file] = { locale => attributes[:file].properties } if attributes[:file]
 
-        { fields: fields }
+        { fields: fields, metadata: attributes[:_metadata] }
       end
 
       # @private
@@ -122,7 +122,7 @@ module Contentful
         self.description = attributes[:description] || description
         self.file = attributes[:file] || file
 
-        { fields: fields_for_query }
+        { fields: fields_for_query, metadata: attributes[:_metadata] }
       end
     end
   end

data/lib/contentful/management/client.rb

@@ -10,6 +10,7 @@ require 'contentful/management/version'
 require 'contentful/management/response'
 require 'contentful/management/resource_builder'
 
+require 'contentful/management/client_tag_methods_factory'
 require 'contentful/management/client_role_methods_factory'
 require 'contentful/management/client_user_methods_factory'
 require 'contentful/management/client_space_methods_factory'
@@ -194,6 +195,15 @@ module Contentful
         ClientAssetMethodsFactory.new(self, space_id, environment_id)
       end
 
+      # Allows manipulation of tags in context of the current client
+      # Allows listing all tags for client, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientTagMethodsFactory]
+      def tags(space_id, environment_id)
+        ClientTagMethodsFactory.new(self, space_id, environment_id)
+      end
+
       # Allows manipulation of content types in context of the current client
       # Allows listing all content types for client, creating new and finding one by ID.
       # @see _ README for details.

data/lib/contentful/management/client_tag_methods_factory.rb

@@ -0,0 +1,11 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Tag API for usage from within Client
+    # @private
+    class ClientTagMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+    end
+  end
+end

data/lib/contentful/management/editor_interface.rb

@@ -11,6 +11,7 @@ module Contentful
       include Contentful::Management::Resource::EnvironmentAware
 
       property :controls, :array
+      property :sidebar, :array
 
       # Gets the Default Editor Interface
       #
@@ -39,7 +40,10 @@ module Contentful
 
       # @private
       def self.create_attributes(_client, attributes)
-        { 'controls' => attributes.fetch(:controls) }
+        {
+          'controls' => attributes.fetch(:controls),
+          'sidebar' => attributes.fetch(:sidebar)
+        }
       end
 
       # @private
@@ -54,7 +58,7 @@ module Contentful
       # Updates an Editor Interface
       #
       # @param [Hash] attributes
-      # @option attributes [Array<Hash>] :controls
+      # @option attributes [Array<Hash>] :controls, :sidebar
       #
       # @return [Contentful::Management::EditorInterface]
       def update(attributes)
@@ -66,7 +70,10 @@ module Contentful
             content_type_id: content_type.id,
             editor_id: id
           },
-          { 'controls' => attributes[:controls] || controls },
+          {
+            'controls' => attributes[:controls] || controls,
+            'sidebar' => attributes[:sidebar] || sidebar
+          },
           version: sys[:version]
         )
       end
@@ -86,7 +93,8 @@ module Contentful
 
       def query_attributes(attributes)
         {
-          controls: controls
+          controls: controls,
+          sidebar: sidebar
         }.merge(
           attributes.each_with_object({}) { |(k, v), result| result[k.to_sym] = v }
         )

data/lib/contentful/management/entry.rb

@@ -58,8 +58,7 @@ module Contentful
                             end
 
         client.register_dynamic_entry(content_type.id, DynamicEntry.create(content_type, client))
-
-        { fields: fields_for_create }
+        { fields: fields_for_create, metadata: attributes[:_metadata] }
       end
 
       # @private
@@ -180,10 +179,24 @@ module Contentful
         EntrySnapshotMethodsFactory.new(self)
       end
 
+      def references(query = {}, headers = {})
+        ResourceRequester.new(client, self.class).all(
+          {
+            space_id: space.id,
+            environment_id: environment_id,
+            resource_id: id,
+            suffix: '/references'
+          },
+          query,
+          headers
+        )
+      end
+
       protected
 
       def query_attributes(attributes)
-        { fields: Contentful::Management::Support.deep_hash_merge(fields_for_query, fields_from_attributes(attributes)) }
+        { metadata: attributes.delete(:_metadata),
+          fields: Contentful::Management::Support.deep_hash_merge(fields_for_query, fields_from_attributes(attributes)) }
       end
 
       private

data/lib/contentful/management/environment.rb

@@ -4,6 +4,7 @@ require_relative 'environment_locale_methods_factory'
 require_relative 'environment_content_type_methods_factory'
 require_relative 'environment_ui_extension_methods_factory'
 require_relative 'environment_editor_interface_methods_factory'
+require_relative 'environment_tag_methods_factory'
 
 module Contentful
   module Management
@@ -121,6 +122,15 @@ module Contentful
         EnvironmentEditorInterfaceMethodsFactory.new(self)
       end
 
+      # Allows manipulation of tags in context of the current environment
+      # Allows listing all tags for the current environment, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentTagMethodsFactory]
+      def tags
+        EnvironmentTagMethodsFactory.new(self)
+      end
+
       # Gets the environment ID
       def environment_id
         id

data/lib/contentful/management/environment_tag_methods_factory.rb

@@ -0,0 +1,11 @@
+require_relative 'environment_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Tag API for usage from within Environment
+    # @private
+    class EnvironmentTagMethodsFactory
+      include Contentful::Management::EnvironmentAssociationMethodsFactory
+    end
+  end
+end

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

@@ -24,6 +24,7 @@ module Contentful
             @properties = resource.instance_variable_get(:@properties)
             @fields = resource.instance_variable_get(:@fields)
             @sys = resource.instance_variable_get(:@sys).merge(locale: locale)
+            @_metadata = resource.instance_variable_get(:@_metadata)
             self
           end
         end

data/lib/contentful/management/resource_requester.rb

@@ -38,8 +38,8 @@ module Contentful
         object.refresh_data(put(endpoint_options, attributes, headers, object))
       end
 
-      def destroy(endpoint_options = {})
-        delete(endpoint_options)
+      def destroy(endpoint_options = {}, attributes = {}, headers = {})
+        delete(endpoint_options, attributes, headers)
       end
 
       def archive(object, endpoint_options = {}, headers = {})

data/lib/contentful/management/tag.rb

@@ -1,4 +1,5 @@
 require_relative 'resource'
+require_relative 'resource/environment_aware'
 
 module Contentful
   module Management
@@ -6,9 +7,35 @@ module Contentful
     # https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-tags
     class Tag
       include Contentful::Management::Resource
+      include Contentful::Management::Resource::Refresher
       include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::EnvironmentAware
 
       property :name
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        return {} if attributes.nil? || attributes.empty?
+
+        {
+          'name' => attributes.fetch(:name),
+          'sys' => {
+            'visibility' => attributes.fetch(:visibility, 'private'),
+            'id' => attributes.fetch(:id),
+            'type' => 'Tag'
+          }
+        }
+      end
+
+      def destroy
+        ResourceRequester.new(client, self.class).destroy(
+          { space_id: space.id,
+            environment_id: environment_id,
+            resource_id: id },
+          {},
+          version: sys[:version]
+        )
+      end
     end
   end
 end

data/lib/contentful/management/version.rb

@@ -3,6 +3,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '3.2.0'.freeze
+    VERSION = '3.5.0'.freeze
   end
 end