contentful-management 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386e22c5309df503436b066804e279c4aa8912c6dc84ef02be9c90ce7d617cc5
-  data.tar.gz: e8d54a6fbf5e5a229abf9391743e3d06264d15088e6033d4522bef5b1ab14622
+  metadata.gz: 683b48fdab7cafe30ccbc6ba4359db731ce08a97f59b83cae82397a3982f03bf
+  data.tar.gz: bf94afa87c07baa3daca8e6b70dad36000fadffcd41334e625ddadfe4f25197f
 SHA512:
-  metadata.gz: 3f3f99d5e04748431abf899b58d4a6e729e3814a3af740676a98cbe0b721fc9c27df0f9c192443014613d7ee36f98172550919bbe5f51a8e5c6d053ecb2c5c43
-  data.tar.gz: 2582509fd98611a065920e9333b6b755dd05aa1389a213caedb3617a66a898f9d94ac45805a16aa6a39064d2186ad0d2912624f9c1d6289bdecc559b81b80646
+  metadata.gz: bbebbb891e59e74e85919ea4e8e992ace7c467b652a098d8668cf5b587744789ac8fc4de1dff1026a1a010ad0d85aa33c99bfbfb01fd0a437e2c8e287841fb56
+  data.tar.gz: 6e0af2ee33543eab79af415edaa8939a6ab747d858d8717d16a621aaf45a898e50dca21cb0fdf2282c2b691b599d3935a4d87f2781c5c57da85baaed05157025

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master
 
+## 2.5.0
+
+As `RichText` moves from `alpha` to `beta`, we're treating this as a feature release.
+
+### Added
+* Added `#save` method to resources, generalizing how to create/update them.
+
+### Changed
+* Renamed `StructuredText` to `RichText`.
+
 ## 2.4.0
 ### Added
 * Added support for StructuredText field type.

data/lib/contentful/management/asset.rb

@@ -64,19 +64,6 @@ module Contentful
         self
       end
 
-      # If an asset is a new object gets created in the Contentful, otherwise the existing asset gets updated.
-      # @see _ https://github.com/contentful/contentful-management.rb for details.
-      #
-      # @return [Contentful::Management::Asset]
-      def save
-        if id
-          update(title: title, description: description, file: file)
-        else
-          new_instance = self.class.create(client, sys[:space].id, fields: instance_variable_get(:@fields))
-          refresh_data(new_instance)
-        end
-      end
-
       # Returns currently supported locale or default locale.
       # @return [String] current_locale
       def locale

data/lib/contentful/management/content_type.rb

@@ -26,7 +26,7 @@ module Contentful
         ARRAY = 'Array'.freeze,
         OBJECT = 'Object'.freeze,
         LOCATION = 'Location'.freeze,
-        STRUCTURED_TEXT = 'StructuredText'.freeze
+        STRUCTURED_TEXT = 'RichText'.freeze
       ].freeze
 
       include Contentful::Management::Resource
@@ -74,19 +74,6 @@ module Contentful
         end
       end
 
-      # If a content type is a new object gets created in the Contentful, otherwise the existing entry gets updated.
-      # @see _ README for details.
-      #
-      # @return [Contentful::Management::ContentType]
-      def save
-        if id
-          update(@properties)
-        else
-          new_instance = self.class.create(client, space.id, environment_id, @properties)
-          refresh_data(new_instance)
-        end
-      end
-
       # This method merges existing fields with new one, when adding, creating or updating new fields.
       # @private
       def merged_fields(new_field)

data/lib/contentful/management/content_type_entry_methods_factory.rb

@@ -45,6 +45,7 @@ module Contentful
           DynamicEntry.create(content_type, content_type.client)
         )
         dynamic_entry = dynamic_entry_class.new
+        dynamic_entry.space = content_type.space
         dynamic_entry.content_type = content_type
         dynamic_entry
       end

data/lib/contentful/management/editor_interface.rb

@@ -66,19 +66,11 @@ module Contentful
             content_type_id: content_type.id,
             editor_id: id
           },
-          { 'controls' => attributes.fetch(:controls) },
+          { 'controls' => attributes[:controls] || controls },
           version: sys[:version]
         )
       end
 
-      # Saves the current editor interface.
-      # @see _ README for details.
-      #
-      # @return [Contentful::Management::EditorInterface]
-      def save
-        update(controls: controls) if id
-      end
-
       # Destroys an EditorInterface.
       #
       # Not Supported

data/lib/contentful/management/entry.rb

@@ -61,8 +61,8 @@ module Contentful
       end
 
       # @private
-      def self.create_headers(_client, attributes)
-        content_type = attributes[:content_type]
+      def self.create_headers(_client, attributes, instance = nil)
+        content_type = instance.nil? ? attributes[:content_type] : (instance.content_type || instance.sys[:contentType])
         content_type_id = content_type.respond_to?(:id) ? content_type.id : content_type[:id]
 
         { content_type_id: content_type_id }
@@ -130,25 +130,6 @@ module Contentful
         self.locale = attributes[:locale] || client.default_locale
       end
 
-      # If an entry is a new object gets created in the Contentful, otherwise the existing entry gets updated.
-      # @see _ README for details.
-      #
-      # @return [Contentful::Management::Entry]
-      def save
-        if id
-          update({})
-        else
-          new_instance = Contentful::Management::Entry.create(
-            client,
-            content_type.space.id,
-            environment_id,
-            content_type: content_type,
-            fields: instance_variable_get(:@fields)
-          )
-          refresh_data(new_instance)
-        end
-      end
-
       # Returns the currently supported local.
       #
       # @return [String] current_locale

data/lib/contentful/management/resource.rb

@@ -62,18 +62,24 @@ module Contentful
       #
       # @return [Contentful::Management::Resource]
       def update(attributes)
+        headers = self.class.create_headers(client, attributes, self)
+        headers = headers.merge(update_headers)
+
         ResourceRequester.new(client, self.class).update(
           self,
-          {
-            space_id: space.id,
-            environment_id: environment_id,
-            resource_id: id
-          },
+          update_url_attributes,
           query_attributes(attributes),
-          version: sys[:version]
+          headers
         )
       end
 
+      # Creates or updates a resource.
+      #
+      # @return [Contentful::Management::Resource]
+      def save
+        update({})
+      end
+
       # Destroys a resource.
       #
       # @return [true, Contentful::Management::Error] success
@@ -130,6 +136,18 @@ module Contentful
 
       protected
 
+      def update_headers
+        { version: sys[:version] }
+      end
+
+      def update_url_attributes
+        {
+          space_id: space.id,
+          environment_id: environment_id,
+          resource_id: id
+        }
+      end
+
       def query_attributes(attributes)
         attributes
       end
@@ -249,7 +267,7 @@ module Contentful
         end
 
         # @private
-        def create_headers(_client, _attributes)
+        def create_headers(_client, _attributes, _instance = nil)
           {}
         end
 

data/lib/contentful/management/resource_requester.rb

@@ -35,7 +35,7 @@ module Contentful
       end
 
       def update(object, endpoint_options = {}, attributes = {}, headers = {})
-        object.refresh_data(put(endpoint_options, attributes, headers))
+        object.refresh_data(put(endpoint_options, attributes, headers, object))
       end
 
       def destroy(endpoint_options = {})
@@ -69,7 +69,8 @@ module Contentful
         ResourceBuilder.new(request.get, client).run
       end
 
-      def put(endpoint_options = {}, attributes = {}, headers = {})
+      def put(endpoint_options = {}, attributes = {}, headers = {}, object = nil)
+        is_update = !object.nil? && object.id
         request = Request.new(
           client,
           resource_class.build_endpoint(endpoint_options),
@@ -77,7 +78,7 @@ module Contentful
           nil,
           headers
         )
-        ResourceBuilder.new(request.put, client).run
+        ResourceBuilder.new(is_update ? request.put : request.post, client).run
       end
 
       def delete(endpoint_options = {}, attributes = {}, headers = {})

data/lib/contentful/management/ui_extension.rb

@@ -22,13 +22,13 @@ module Contentful
       def self.create_attributes(_client, attributes)
         extension = attributes['extension'] || attributes[:extension]
 
-        fail 'Invalid UI Extension attributes' unless valid_extension(extension)
+        fail 'Invalid UI Extension attributes' unless valid_extension?(extension)
 
         { 'extension' => extension }
       end
 
       # @private
-      def self.valid_extension(extension)
+      def self.valid_extension?(extension)
         return false unless extension.key?('name')
         return false unless extension.key?('fieldTypes') && extension['fieldTypes'].is_a?(::Array)
         return false unless extension.key?('src') || extension.key?('srcdoc')
@@ -41,13 +41,8 @@ module Contentful
       #
       # @return [Contentful::Management::UIExtension]
       def save
-        self.class.valid_extension(extension)
-        if id
-          update(extension: extension)
-        else
-          new_instance = self.class.create(client, sys[:space].id, environment_id, extension: extension)
-          refresh_data(new_instance)
-        end
+        fail 'Invalid UI extension attributes' unless self.class.valid_extension?(extension)
+        update(extension: extension)
       end
 
       # Returns extension name

data/lib/contentful/management/version.rb

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

data/spec/fixtures/vcr_cassettes/content_type/{create_with_StructuredText_field.yml → create_with_RichText_field.yml}

@@ -5,9 +5,9 @@ http_interactions:
     uri: https://api.contentful.com/spaces/ctgv7kwgsghk/environments/master/content_types
     body:
       encoding: UTF-8
-      string: '{"name":"StructuredText","description":"Content type with StructuredText
-        field","fields":[{"id":"my_StructuredText_field","name":"My StructuredText
-        Field","type":"StructuredText"}]}'
+      string: '{"name":"RichText","description":"Content type with RichText
+        field","fields":[{"id":"my_RichText_field","name":"My RichText
+        Field","type":"RichText"}]}'
     headers:
       X-Contentful-User-Agent:
       - sdk contentful-management.rb/2.3.0; platform ruby/2.5.1; os macOS/16;
@@ -119,13 +119,13 @@ http_interactions:
             "version": 1
           },
           "displayField": null,
-          "name": "StructuredText",
-          "description": "Content type with StructuredText field",
+          "name": "RichText",
+          "description": "Content type with RichText field",
           "fields": [
             {
-              "id": "my_StructuredText_field",
-              "name": "My StructuredText Field",
-              "type": "StructuredText",
+              "id": "my_RichText_field",
+              "name": "My RichText Field",
+              "type": "RichText",
               "localized": false,
               "required": false,
               "validations": [],

data/spec/lib/contentful/management/content_type_spec.rb

@@ -188,7 +188,7 @@ module Contentful
           end
         end
 
-        Contentful::Management::ContentType::FIELD_TYPES.reject { |f| f == 'StructuredText' }.each do |field_type|
+        Contentful::Management::ContentType::FIELD_TYPES.reject { |f| f == 'RichText' }.each do |field_type|
           it "creates within a space with #{ field_type } field" do
             vcr("content_type/create_with_#{ field_type }_field") do
               field = Contentful::Management::Field.new
@@ -213,22 +213,22 @@ module Contentful
           end
         end
 
-        it "creates within a space with StructuredText field" do
-          vcr("content_type/create_with_StructuredText_field") do
+        it "creates within a space with RichText field" do
+          vcr("content_type/create_with_RichText_field") do
             subject = client.content_types('ctgv7kwgsghk', 'master')
 
             field = Contentful::Management::Field.new
-            field.id = "my_StructuredText_field"
-            field.name = "My StructuredText Field"
-            field.type = 'StructuredText'
+            field.id = "my_RichText_field"
+            field.name = "My RichText Field"
+            field.type = 'RichText'
             content_type = subject.create(
-              name: "StructuredText",
-              description: "Content type with StructuredText field",
+              name: "RichText",
+              description: "Content type with RichText field",
               fields: [field]
             )
             expect(content_type).to be_kind_of Contentful::Management::ContentType
-            expect(content_type.name).to eq "StructuredText"
-            expect(content_type.description).to eq "Content type with StructuredText field"
+            expect(content_type.name).to eq "RichText"
+            expect(content_type.description).to eq "Content type with RichText field"
             expect(content_type.fields.size).to eq 1
             result_field = content_type.fields.first
             expect(result_field.id).to eq field.id

data/spec/lib/contentful/management/ui_extension_spec.rb

@@ -14,11 +14,11 @@ module Contentful
       subject { client.ui_extensions(space_id, 'master') }
 
       describe 'class methods' do
-        describe '::valid_extension' do
+        describe '::valid_extension?' do
           it 'false when name is missing' do
             extension = {}
 
-            expect(described_class.valid_extension(extension)).to be_falsey
+            expect(described_class.valid_extension?(extension)).to be_falsey
           end
 
           it 'false when fieldTypes is missing' do
@@ -26,7 +26,7 @@ module Contentful
               'name' => 'foobar'
             }
 
-            expect(described_class.valid_extension(extension)).to be_falsey
+            expect(described_class.valid_extension?(extension)).to be_falsey
           end
 
           it 'false when fieldTypes is present but not an array' do
@@ -35,7 +35,7 @@ module Contentful
               'fieldTypes' => 'baz'
             }
 
-            expect(described_class.valid_extension(extension)).to be_falsey
+            expect(described_class.valid_extension?(extension)).to be_falsey
           end
 
           it 'false when both src and srcdoc missing' do
@@ -44,7 +44,7 @@ module Contentful
               'fieldTypes' => ['Symbol']
             }
 
-            expect(described_class.valid_extension(extension)).to be_falsey
+            expect(described_class.valid_extension?(extension)).to be_falsey
           end
 
           it 'true when all of the above are passed' do
@@ -54,7 +54,7 @@ module Contentful
               'src' => 'foo'
             }
 
-            expect(described_class.valid_extension(extension)).to be_truthy
+            expect(described_class.valid_extension?(extension)).to be_truthy
 
             extension = {
               'name' => 'foobar',
@@ -62,7 +62,7 @@ module Contentful
               'srcdoc' => 'foo'
             }
 
-            expect(described_class.valid_extension(extension)).to be_truthy
+            expect(described_class.valid_extension?(extension)).to be_truthy
           end
 
           it 'false if sidebar is present but not boolean' do
@@ -73,7 +73,7 @@ module Contentful
               'sidebar' => true
             }
 
-            expect(described_class.valid_extension(extension)).to be_truthy
+            expect(described_class.valid_extension?(extension)).to be_truthy
 
             extension = {
               'name' => 'foobar',
@@ -82,7 +82,7 @@ module Contentful
               'sidebar' => false
             }
 
-            expect(described_class.valid_extension(extension)).to be_truthy
+            expect(described_class.valid_extension?(extension)).to be_truthy
 
             extension = {
               'name' => 'foobar',
@@ -91,7 +91,7 @@ module Contentful
               'sidebar' => 'foobar'
             }
 
-            expect(described_class.valid_extension(extension)).to be_falsey
+            expect(described_class.valid_extension?(extension)).to be_falsey
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful-management
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Piotr Protas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -466,7 +466,7 @@ files:
 - spec/fixtures/vcr_cassettes/content_type/create_with_Location_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Number_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Object_field.yml
-- spec/fixtures/vcr_cassettes/content_type/create_with_StructuredText_field.yml
+- spec/fixtures/vcr_cassettes/content_type/create_with_RichText_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Symbol_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Text_field.yml
 - spec/fixtures/vcr_cassettes/content_type/deactivate.yml
@@ -853,7 +853,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/content_type/create_with_Location_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Number_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Object_field.yml
-- spec/fixtures/vcr_cassettes/content_type/create_with_StructuredText_field.yml
+- spec/fixtures/vcr_cassettes/content_type/create_with_RichText_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Symbol_field.yml
 - spec/fixtures/vcr_cassettes/content_type/create_with_Text_field.yml
 - spec/fixtures/vcr_cassettes/content_type/deactivate.yml