contentful-management 1.8.1 → 1.9.0

data/lib/contentful/management/client_space_membership_methods_factory.rb

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

data/lib/contentful/management/client_ui_extension_methods_factory.rb

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

data/lib/contentful/management/client_user_methods_factory.rb

@@ -0,0 +1,27 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Users API for usage from within Client
+    # @private
+    class ClientUserMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def new(*)
+        fail 'Not supported'
+      end
+
+      def find(user_id)
+        super(nil, user_id)
+      end
+
+      def me
+        find('me')
+      end
+
+      def all(*)
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/client_webhook_call_methods_factory.rb

@@ -0,0 +1,30 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Webhook Call API for usage from within Client
+    # @private
+    class ClientWebhookCallMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      def all(space_id, webhook_id, _params = {})
+        @resource_requester.find(
+          space_id: space_id,
+          webhook_id: webhook_id
+        )
+      end
+
+      def find(space_id, webhook_id, call_id)
+        @resource_requester.find(
+          space_id: space_id,
+          webhook_id: webhook_id,
+          call_id: call_id
+        )
+      end
+
+      def new(*)
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/client_webhook_health_methods_factory.rb

@@ -0,0 +1,27 @@
+require_relative 'client_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Webhook Health API for usage from within Client
+    # @private
+    class ClientWebhookHealthMethodsFactory
+      include Contentful::Management::ClientAssociationMethodsFactory
+
+      # Not supported
+      def all(*)
+        fail 'Not supported'
+      end
+
+      def find(space_id, webhook_id)
+        @resource_requester.find(
+          space_id: space_id,
+          webhook_id: webhook_id
+        )
+      end
+
+      def new(*)
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/content_type.rb

@@ -3,6 +3,7 @@ require_relative 'field'
 require_relative 'validation'
 require_relative 'content_type_entry_methods_factory'
 require_relative 'content_type_editor_interface_methods_factory'
+require_relative 'content_type_snapshot_methods_factory'
 require_relative 'support'
 require_relative 'resource/all_published'
 require_relative 'resource/publisher'
@@ -153,6 +154,15 @@ module Contentful
         Contentful::Management::ContentTypeEditorInterfaceMethodsFactory.new(self)
       end
 
+      # Allows manipulation of snapshots in context of the current content type
+      # Allows listing all snapshots belonging to this entry and finding one by id.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::ContentTypeSnapshotMethodsFactory]
+      def snapshots
+        ContentTypeSnapshotMethodsFactory.new(self)
+      end
+
       # @private
       def self.fields_to_nested_properties_hash(fields)
         fields.map do |field|

data/lib/contentful/management/content_type_snapshot_methods_factory.rb

@@ -0,0 +1,35 @@
+require_relative 'resource_requester'
+
+module Contentful
+  module Management
+    # Wrapper for Entry manipulation for a specific Content Type
+    # @private
+    class ContentTypeSnapshotMethodsFactory
+      attr_reader :content_type
+
+      # @private
+      def initialize(content_type)
+        @content_type = content_type
+      end
+
+      # Gets all snapshot for a specific content type.
+      #
+      # @see _ For complete option list: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/content-type-snapshots-collection
+      #
+      # @return [Contentful::Management::Array<Contentful::Management::Snapshot>]
+      def all(params = {})
+        Snapshot.all(content_type.client, content_type.space.id, content_type.id, 'content_types', params)
+      end
+
+      # Gets a snapshot by ID for a specific content type.
+      #
+      # @param [String] snapshot_id
+      # @see _ For complete option list: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/content-type-snapshots-collection
+      #
+      # @return [Contentful::Management::Array<Contentful::Management::Snapshot>]
+      def find(snapshot_id)
+        Snapshot.find(content_type.client, content_type.space.id, content_type.id, snapshot_id, 'content_types')
+      end
+    end
+  end
+end

data/lib/contentful/management/editor_interface.rb

@@ -45,7 +45,7 @@ module Contentful
         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"
+        "spaces/#{space_id}/content_types/#{content_type_id}/editor_interface"
       end
 
       # Updates an Editor Interface

data/lib/contentful/management/organization.rb

@@ -0,0 +1,20 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for Organization.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/organizations
+    class Organization
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :name
+
+      # @private
+      def self.build_endpoint(_endpoint_options)
+        '/organizations'
+      end
+    end
+  end
+end

data/lib/contentful/management/personal_access_token.rb

@@ -0,0 +1,45 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for PersonalAccessToken.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens
+    class PersonalAccessToken
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :name, :string
+      property :revokedAt, :date
+      property :scopes, :array
+      property :token, :string
+
+      # @private
+      def self.build_endpoint(endpoint_options)
+        endpoint = 'users/me/access_tokens'
+        endpoint = "#{endpoint}/#{endpoint_options[:resource_id]}" if endpoint_options[:resource_id]
+        endpoint = "#{endpoint}#{endpoint_options[:suffix]}" if endpoint_options[:suffix]
+        endpoint
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        attributes
+      end
+
+      # Not supported
+      def destroy
+        fail 'Not supported'
+      end
+
+      # Revokes the personal access token.
+      def revoke
+        ResourceRequester.new(client, self.class).update(
+          self,
+          resource_id: id,
+          suffix: '/revoked'
+        )
+      end
+    end
+  end
+end

data/lib/contentful/management/request.rb

@@ -17,7 +17,6 @@ module Contentful
 
         case query
         when Hash
-          @client.zero_length = query.empty?
           @query = normalize_query(query) if query && !query.empty?
         else
           @query = query

data/lib/contentful/management/resource.rb

@@ -152,6 +152,8 @@ module Contentful
           COERCIONS[what] ? COERCIONS[what][value] : value
         when Class
           what.new(value, client)
+        when Proc
+          what[value]
         else
           value
         end
@@ -166,8 +168,8 @@ module Contentful
 
         # @private
         def build_endpoint(endpoint_options)
-          return "/#{endpoint_options[:space_id]}/public/#{endpoint}" if endpoint_options.key?(:public)
-          base = "/#{endpoint_options[:space_id]}/#{endpoint}"
+          return "spaces/#{endpoint_options[:space_id]}/public/#{endpoint}" if endpoint_options.key?(:public)
+          base = "spaces/#{endpoint_options[:space_id]}/#{endpoint}"
           return "#{base}/#{endpoint_options[:resource_id]}#{endpoint_options[:suffix]}" if endpoint_options.key?(:resource_id)
           base
         end

data/lib/contentful/management/resource_builder.rb

@@ -5,12 +5,19 @@ require_relative 'dynamic_entry'
 require_relative 'array'
 require_relative 'link'
 require_relative 'space'
+require_relative 'space_membership'
+require_relative 'organization'
+require_relative 'user'
 require_relative 'content_type'
 require_relative 'asset'
 require_relative 'webhook'
+require_relative 'webhook_call'
+require_relative 'webhook_health'
 require_relative 'api_key'
+require_relative 'personal_access_token'
 require_relative 'locale'
 require_relative 'role'
+require_relative 'ui_extension'
 require_relative 'editor_interface'
 require_relative 'snapshot'
 require_relative 'upload'
@@ -24,15 +31,23 @@ module Contentful
       # @see _ README for more information on Resource Mapping
       DEFAULT_RESOURCE_MAPPING = {
         'Space' => Contentful::Management::Space,
+        'SpaceMembership' => Contentful::Management::SpaceMembership,
+        'Organization' => Contentful::Management::Organization,
+        'User' => Contentful::Management::User,
         'ContentType' => Contentful::Management::ContentType,
         'Entry' => :find_entry_class,
         'Asset' => Contentful::Management::Asset,
         'Array' => :array_or_sync_page,
         'Link' => Contentful::Management::Link,
         'WebhookDefinition' => Contentful::Management::Webhook,
+        'WebhookCallOverview' => Contentful::Management::WebhookCall,
+        'WebhookCallDetails' => Contentful::Management::WebhookCall,
+        'Webhook' => Contentful::Management::WebhookHealth,
         'ApiKey' => Contentful::Management::ApiKey,
+        'PersonalAccessToken' => Contentful::Management::PersonalAccessToken,
         'Locale' => Contentful::Management::Locale,
         'Role' => Contentful::Management::Role,
+        'Extension' => Contentful::Management::UIExtension,
         'EditorInterface' => Contentful::Management::EditorInterface,
         'Snapshot' => Contentful::Management::Snapshot,
         'Upload' => Contentful::Management::Upload

data/lib/contentful/management/snapshot.rb

@@ -10,34 +10,48 @@ module Contentful
       include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
 
-      property :snapshot, DynamicEntry
+      # @private
+      def self.property_coercions
+        {
+          snapshot: lambda do |h|
+            case h.fetch('sys', {})['type']
+            when 'Entry'
+              DynamicEntry.new(h)
+            when 'ContentType'
+              ContentType.new(h)
+            end
+          end
+        }
+      end
+
+      property :snapshot
 
-      # Gets all Snapshots for an Entry
+      # Gets all snapshots for a resource
       #
       # @param [Contentful::Management::Client] client
       # @param [String] space_id
-      # @param [String] entry_id
+      # @param [String] resource_id
+      # @param [String] resource_type
       #
       # @return [Contentful::Management::Array<Contentful::Management::Snapshot>]
-      def self.all(client, space_id, entry_id)
-        ClientSnapshotMethodsFactory.new(client).all(space_id, entry_id)
+      def self.all(client, space_id, resource_id, resource_type = 'entries', params = {})
+        ClientSnapshotMethodsFactory.new(client, resource_type).all(space_id, resource_id, params)
       end
 
-      # Gets a Snapshot by ID
+      # Gets a snapshot by ID
       #
       # @param [Contentful::Management::Client] client
       # @param [String] space_id
-      # @param [String] entry_id
+      # @param [String] resource_id
       # @param [String] snapshot_id
+      # @param [String] resource_type
       #
       # @return [Contentful::Management::Snapshot]
-      def self.find(client, space_id, entry_id, snapshot_id)
-        ClientSnapshotMethodsFactory.new(client).find(space_id, entry_id, snapshot_id)
+      def self.find(client, space_id, resource_id, snapshot_id, resource_type = 'entries')
+        ClientSnapshotMethodsFactory.new(client, resource_type).find(space_id, resource_id, snapshot_id)
       end
 
-      # Creates a Snapshot
-      #
-      # Not Supported
+      # Not supported
       def self.create(*)
         fail 'Not supported'
       end
@@ -49,26 +63,23 @@ module Contentful
 
       # @private
       def self.build_endpoint(endpoint_options)
+        resource_type = endpoint_options.fetch(:resource_type, 'entries')
         space_id = endpoint_options.fetch(:space_id)
-        entry_id = endpoint_options.fetch(:entry_id)
+        resource_id = endpoint_options.fetch(:resource_id)
         snapshot_id = endpoint_options.fetch(:snapshot_id, nil)
 
-        endpoint = "/#{space_id}/entries/#{entry_id}/snapshots"
+        endpoint = "spaces/#{space_id}/#{resource_type}/#{resource_id}/snapshots"
         endpoint = "#{endpoint}/#{snapshot_id}" unless snapshot_id.nil?
 
         endpoint
       end
 
-      # Deletes a Snapshot
-      #
-      # Not Supported
+      # Not supported
       def destroy
         fail 'Not supported'
       end
 
-      # Updates a Snapshot
-      #
-      # Not Supported
+      # Not supported
       def update(*)
         fail 'Not supported'
       end

data/lib/contentful/management/space.rb

@@ -1,4 +1,6 @@
 require_relative 'resource'
+require_relative 'space_membership'
+require_relative 'space_space_membership_methods_factory'
 require_relative 'locale'
 require_relative 'space_locale_methods_factory'
 require_relative 'content_type'
@@ -11,6 +13,8 @@ require_relative 'webhook'
 require_relative 'space_webhook_methods_factory'
 require_relative 'role'
 require_relative 'space_role_methods_factory'
+require_relative 'ui_extension'
+require_relative 'space_ui_extension_methods_factory'
 require_relative 'editor_interface'
 require_relative 'space_editor_interface_methods_factory'
 require_relative 'api_key'
@@ -33,8 +37,8 @@ module Contentful
 
       # @private
       def self.build_endpoint(endpoint_options)
-        return "/#{endpoint_options[:space_id]}" if endpoint_options.key?(:space_id)
-        ''
+        return "spaces/#{endpoint_options[:space_id]}" if endpoint_options.key?(:space_id)
+        'spaces'
       end
 
       # Gets all Spaces
@@ -123,7 +127,7 @@ module Contentful
       end
 
       # Allows manipulation of content types in context of the current space
-      # Allows listing all content types of space, creating new and finding one by id.
+      # Allows listing all content types of space, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceContentTypeMethodsFactory]
@@ -132,7 +136,7 @@ module Contentful
       end
 
       # Allows manipulation of api keys in context of the current space
-      # Allows listing all api keys of space, creating new and finding one by id.
+      # Allows listing all api keys of space, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceApiKeyMethodsFactory]
@@ -141,7 +145,7 @@ module Contentful
       end
 
       # Allows manipulation of locales in context of the current space
-      # Allows listing all locales of space, creating new and finding one by id.
+      # Allows listing all locales of space, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceLocaleMethodsFactory]
@@ -149,8 +153,17 @@ module Contentful
         SpaceLocaleMethodsFactory.new(self)
       end
 
+      # Allows manipulation of space memberships in context of the current space
+      # Allows listing all space memberships of space, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceSpaceMembershipMethodsFactory]
+      def space_memberships
+        SpaceSpaceMembershipMethodsFactory.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.
+      # Allows listing all roles of space, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceRoleMethodsFactory]
@@ -158,8 +171,17 @@ module Contentful
         SpaceRoleMethodsFactory.new(self)
       end
 
+      # Allows manipulation of UI extension in context of the current space
+      # Allows listing all UI extension of space, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::SpaceUIExtensionMethodsFactory]
+      def ui_extensions
+        SpaceUIExtensionMethodsFactory.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.
+      # Allows listing all editor interfaces of space, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceEditorInterfaceMethodsFactory]
@@ -168,7 +190,7 @@ module Contentful
       end
 
       # Allows manipulation of assets in context of the current space
-      # Allows listing all assets of space, creating new and finding one by id.
+      # Allows listing all assets of space, creating new and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceAssetMethodsFactory]
@@ -177,7 +199,7 @@ module Contentful
       end
 
       # Allows manipulation of entries in context of the current space
-      # Allows listing all entries for space and finding one by id.
+      # Allows listing all entries for space and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceEntryMethodsFactory]
@@ -186,7 +208,7 @@ module Contentful
       end
 
       # Allows manipulation of webhooks in context of the current space
-      # Allows listing all webhooks for space and finding one by id.
+      # Allows listing all webhooks for space and finding one by ID.
       # @see _ README for details.
       #
       # @return [Contentful::Management::SpaceWebhookMethodsFactory]