contentful-management 1.0.1 → 1.1.0

data/lib/contentful/management/client.rb

@@ -11,6 +11,8 @@ require 'contentful/management/client_asset_methods_factory'
 require 'contentful/management/client_content_type_methods_factory'
 require 'contentful/management/client_entry_methods_factory'
 require 'contentful/management/client_locale_methods_factory'
+require 'contentful/management/client_role_methods_factory'
+require 'contentful/management/client_editor_interface_methods_factory'
 require 'contentful/management/client_webhook_methods_factory'
 
 require_relative 'request'
@@ -122,6 +124,24 @@ module Contentful
         ClientLocaleMethodsFactory.new(self)
       end
 
+      # Allows manipulation of roles in context of the current client
+      # Allows listing all roles for client, creating new and finding one by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientRoleMethodsFactory]
+      def roles
+        ClientRoleMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of editor interfaces in context of the current client
+      # Allows listing all editor interfaces for client, creating new and finding one by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ClientEditorInterfaceMethodsFactory]
+      def editor_interfaces
+        ClientEditorInterfaceMethodsFactory.new(self)
+      end
+
       # Allows manipulation of webhooks in context of the current client
       # Allows listing all webhooks for client, creating new and finding one by id.
       # @see _ README for details.

data/lib/contentful/management/client_association_all_published_method_factory.rb

@@ -8,9 +8,13 @@ module Contentful
       # @param [String] space_id
       # @param [Hash] params
       # @see _ For complete option list: http://docs.contentfulcda.apiary.io/#reference/search-parameters
+      # @deprecated This call will be soon removed from the API except for Content Types
       #
       # @return [Contentful::Management::Array<Contentful::Management::Resource>]
       def all_published(space_id, params = {})
+        warn('This call will soon be removed from the API except for Content Types') unless params.key?(:suppress_warning)
+        params.delete(:suppress_warning) if params.key?(:suppress_warning)
+
         @resource_requester.all(
           { space_id: space_id, public: true },
           params

data/lib/contentful/management/client_content_type_methods_factory.rb

@@ -8,6 +8,10 @@ module Contentful
     class ClientContentTypeMethodsFactory
       include Contentful::Management::ClientAssociationMethodsFactory
       include Contentful::Management::ClientAssociationAllPublishedMethodsFactory
+
+      def all_published(space_id, params = {})
+        super(space_id, { suppress_warning: true }.merge(params))
+      end
     end
   end
 end

data/lib/contentful/management/client_editor_interface_methods_factory.rb

@@ -0,0 +1,35 @@
+require_relative 'client_association_methods_factory'
+require_relative 'editor_interface'
+
+module Contentful
+  module Management
+    # Wrapper for EditorInterface API for usage from within Client
+    # @private
+    class ClientEditorInterfaceMethodsFactory
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+        @resource_requester = ResourceRequester.new(client, associated_class)
+      end
+
+      # Gets the Default Editor Interface
+      #
+      # @param [String] space_id
+      # @param [String] content_type_id
+      # @param [Hash] params
+      # @see _ For complete option list: http://docs.contentfulcda.apiary.io/#reference/search-parameters
+      #
+      # @return [Contentful::Management::EditorInterface]
+      def default(space_id, content_type_id)
+        @resource_requester.all(space_id: space_id, content_type_id: content_type_id, editor_id: 'default')
+      end
+
+      private
+
+      def associated_class
+        EditorInterface
+      end
+    end
+  end
+end

data/lib/contentful/management/client_role_methods_factory.rb

@@ -0,0 +1,15 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Role API for usage from within Client
+    # @private
+    class ClientRoleMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def new(*)
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/client_webhook_methods_factory.rb

@@ -2,7 +2,7 @@ require_relative 'client_association_methods_factory'
 
 module Contentful
   module Management
-    # Wrapper for ApiKey API for usage from within Client
+    # Wrapper for Webhook API for usage from within Client
     # @private
     class ClientWebhookMethodsFactory
       include Contentful::Management::ClientAssociationMethodsFactory

data/lib/contentful/management/content_type.rb

@@ -2,6 +2,7 @@ require_relative 'resource'
 require_relative 'field'
 require_relative 'validation'
 require_relative 'content_type_entry_methods_factory'
+require_relative 'content_type_editor_interface_methods_factory'
 require_relative 'support'
 require_relative 'resource/all_published'
 require_relative 'resource/publisher'
@@ -141,6 +142,17 @@ module Contentful
         Contentful::Management::ContentTypeEntryMethodsFactory.new(self)
       end
 
+      # Use this method only in the context of content type.
+      # Allows you to create an editor interface.
+      # @see _ README for details.
+      #
+      # @private
+      #
+      # @return [Contentful::Management::ContentTypeEditorInterfaceMethodsFactory]
+      def editor_interface
+        Contentful::Management::ContentTypeEditorInterfaceMethodsFactory.new(self)
+      end
+
       # @private
       def self.fields_to_nested_properties_hash(fields)
         fields.map do |field|

data/lib/contentful/management/content_type_editor_interface_methods_factory.rb

@@ -0,0 +1,22 @@
+require_relative 'client_editor_interface_methods_factory'
+require_relative 'editor_interface'
+
+module Contentful
+  module Management
+    # Wrapper for Editor Interface API for a specific Content Type
+    # @private
+    class ContentTypeEditorInterfaceMethodsFactory
+      attr_reader :content_type, :editor_interfaces_client
+
+      # @private
+      def initialize(content_type)
+        @content_type = content_type
+        @editor_interfaces_client = ClientEditorInterfaceMethodsFactory.new(content_type.client)
+      end
+
+      def default
+        editor_interfaces_client.default(content_type.space.id, content_type.id)
+      end
+    end
+  end
+end

data/lib/contentful/management/editor_interface.rb

@@ -0,0 +1,85 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for Editor Interface.
+    class EditorInterface
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :controls, :array
+
+      # Gets the Default Editor Interface
+      #
+      # @param [String] space_id
+      # @param [String] content_type_id
+      # @param [Hash] params
+      # @see _ For complete option list: http://docs.contentfulcda.apiary.io/#reference/search-parameters
+      #
+      # @return [Contentful::Management::EditorInterface]
+      def self.default(client, space_id, content_type_id)
+        ClientEditorInterfaceMethodsFactory.new(client).default(space_id, content_type_id)
+      end
+
+      # Finds an EditorInterface.
+      #
+      # Not Supported
+      def self.find(*)
+        fail 'Not supported'
+      end
+
+      # Creates an EditorInterface.
+      #
+      # Not Supported
+      def self.create(*)
+        fail 'Not supported'
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        { 'controls' => attributes.fetch(:controls) }
+      end
+
+      # @private
+      def self.build_endpoint(endpoint_options)
+        space_id = endpoint_options.fetch(:space_id)
+        content_type_id = endpoint_options.fetch(:content_type_id)
+
+        "/#{space_id}/content_types/#{content_type_id}/editor_interface"
+      end
+
+      # Updates an Editor Interface
+      #
+      # @param [Hash] attributes
+      # @option attributes [Array<Hash>] :controls
+      #
+      # @return [Contentful::Management::EditorInterface]
+      def update(attributes)
+        ResourceRequester.new(client, self.class).update(
+          self,
+          { space_id: space.id, content_type_id: content_type.id, editor_id: id },
+          { 'controls' => attributes.fetch(:controls) },
+          version: sys[:version]
+        )
+      end
+
+      # Destroys an EditorInterface.
+      #
+      # Not Supported
+      def destroy
+        fail 'Not supported'
+      end
+
+      protected
+
+      def refresh_find
+        self.class.default(client, space.id, content_type.id)
+      end
+
+      def query_attributes(attributes)
+        attributes.each_with_object({}) { |(k, v), result| result[k.to_sym] = v }
+      end
+    end
+  end
+end

data/lib/contentful/management/field.rb

@@ -15,6 +15,7 @@ module Contentful
       property :localized, :boolean
       property :validations, Validation
       property :disabled, :boolean
+      property :omitted, :boolean
 
       # Takes a field object of content type
       # Merges existing properties, items and validations of field with new one

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

@@ -13,6 +13,7 @@ module Contentful
         # @option parameters [String] :content_type
         # @option parameters [Integer] :limit
         # @option parameters [Integer] :skip
+        # @deprecated This call will be soon removed from the API except for Content Types
         #
         # @return [Contentful::Management::Array<Contentful::Management::Resource>]
         def all_published(client, space_id, parameters = {})

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

@@ -6,9 +6,13 @@ module Contentful
         # Reload an object
         # Updates the current version of the object to the version on the system
         def reload
-          self_class = self.class
-          resource = self.is_a?(Space) ? self_class.find(client, id) : self_class.find(client, space.id, id)
-          refresh_data(resource) if resource.is_a? self_class
+          resource = refresh_find
+          refresh_data(resource) if resource.is_a? self.class
+        end
+
+        # @private
+        def refresh_find
+          self.class.find(client, space.id, id)
         end
 
         # @private

data/lib/contentful/management/resource_builder.rb

@@ -10,6 +10,8 @@ require_relative 'asset'
 require_relative 'webhook'
 require_relative 'api_key'
 require_relative 'locale'
+require_relative 'role'
+require_relative 'editor_interface'
 
 module Contentful
   module Management
@@ -27,7 +29,9 @@ module Contentful
         'Link' => Contentful::Management::Link,
         'WebhookDefinition' => Contentful::Management::Webhook,
         'ApiKey' => Contentful::Management::ApiKey,
-        'Locale' => Contentful::Management::Locale
+        'Locale' => Contentful::Management::Locale,
+        'Role' => Contentful::Management::Role,
+        'EditorInterface' => Contentful::Management::EditorInterface
       }
       # Default Entry Mapping
       # @see _ README for more information on Entry Mapping

data/lib/contentful/management/role.rb

@@ -0,0 +1,33 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for Role.
+    class Role
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :name, :string
+      property :description, :string
+      property :permissions, :hash
+      property :policies, :array
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        {
+          'name' => attributes.fetch(:name),
+          'description' => attributes.fetch(:description),
+          'permissions' => attributes.fetch(:permissions),
+          'policies' => attributes.fetch(:policies)
+        }
+      end
+
+      protected
+
+      def query_attributes(attributes)
+        attributes.each_with_object({}) { |(k, v), result| result[k.to_sym] = v }
+      end
+    end
+  end
+end

data/lib/contentful/management/space.rb

@@ -9,6 +9,10 @@ require_relative 'entry'
 require_relative 'space_entry_methods_factory'
 require_relative 'webhook'
 require_relative 'space_webhook_methods_factory'
+require_relative 'role'
+require_relative 'space_role_methods_factory'
+require_relative 'editor_interface'
+require_relative 'space_editor_interface_methods_factory'
 require_relative 'api_key'
 require_relative 'space_api_key_methods_factory'
 
@@ -145,6 +149,24 @@ module Contentful
         SpaceLocaleMethodsFactory.new(self)
       end
 
+      # Allows manipulation of roles in context of the current space
+      # Allows listing all roles of space, creating new and finding one by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceRoleMethodsFactory]
+      def roles
+        SpaceRoleMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of editor interfaces in context of the current space
+      # Allows listing all editor interfaces of space, creating new and finding one by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceEditorInterfaceMethodsFactory]
+      def editor_interfaces
+        SpaceEditorInterfaceMethodsFactory.new(self)
+      end
+
       # Allows manipulation of assets in context of the current space
       # Allows listing all assets of space, creating new and finding one by id.
       # @see _ README for details.
@@ -188,6 +210,12 @@ module Contentful
         return locale.code unless locale.nil?
         @default_locale
       end
+
+      protected
+
+      def refresh_find
+        self.class.find(client, id)
+      end
     end
   end
 end

data/lib/contentful/management/space_association_all_published_method_factory.rb

@@ -2,6 +2,7 @@ module Contentful
   module Management
     # Wrapper for /public API for usage from within Space Wrapper Classes
     # @private
+    # @deprecated This call will be soon removed from the API except for Content Types
     module SpaceAssociationAllPublishedMethodsFactory
       def all_published(params = {})
         associated_class.all_published(space.client, space.id, params)

data/lib/contentful/management/space_editor_interface_methods_factory.rb

@@ -0,0 +1,21 @@
+require_relative 'client_editor_interface_methods_factory'
+require_relative 'editor_interface'
+
+module Contentful
+  module Management
+    # Wrapper for EditorInterface API for usage from within Space
+    # @private
+    class SpaceEditorInterfaceMethodsFactory
+      attr_reader :space, :editor_interfaces_client
+
+      def initialize(space)
+        @space = space
+        @editor_interfaces_client = ClientEditorInterfaceMethodsFactory.new(space.client)
+      end
+
+      def default(content_type_id)
+        editor_interfaces_client.default(space.id, content_type_id)
+      end
+    end
+  end
+end

data/lib/contentful/management/space_role_methods_factory.rb

@@ -0,0 +1,15 @@
+require_relative 'space_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Role API for usage from within Space
+    # @private
+    class SpaceRoleMethodsFactory
+      include Contentful::Management::SpaceAssociationMethodsFactory
+
+      def new
+        fail 'Not supported'
+      end
+    end
+  end
+end