contentful-management 1.10.1 → 2.0.0

data/lib/contentful/management/resource.rb

@@ -1,6 +1,6 @@
-require_relative 'resource/system_properties'
-require_relative 'resource/refresher'
 require 'date'
+require_relative 'resource/refresher'
+require_relative 'resource/system_properties'
 
 module Contentful
   module Management
@@ -65,7 +65,11 @@ module Contentful
       def update(attributes)
         ResourceRequester.new(client, self.class).update(
           self,
-          { space_id: space.id, resource_id: id },
+          {
+            space_id: space.id,
+            environment_id: environment_id,
+            resource_id: id
+          },
           query_attributes(attributes),
           version: sys[:version]
         )
@@ -75,7 +79,11 @@ module Contentful
       #
       # @return [true, Contentful::Management::Error] success
       def destroy
-        ResourceRequester.new(client, self.class).destroy(space_id: space.id, resource_id: id)
+        ResourceRequester.new(client, self.class).destroy(
+          space_id: space.id,
+          environment_id: environment_id,
+          resource_id: id
+        )
       end
 
       # @private
@@ -116,6 +124,11 @@ module Contentful
         true
       end
 
+      # Returns the Environment ID
+      def environment_id
+        nil
+      end
+
       protected
 
       def query_attributes(attributes)
@@ -168,9 +181,16 @@ module Contentful
 
         # @private
         def build_endpoint(endpoint_options)
-          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)
+          if endpoint_options.key?(:public)
+            base = "spaces/#{endpoint_options[:space_id]}"
+            base = "#{base}/environments/#{endpoint_options[:environment_id]}" if endpoint_options[:environment_id]
+            return "#{base}/public/#{endpoint}"
+          end
+
+          base = "spaces/#{endpoint_options[:space_id]}"
+          base = "#{base}/environments/#{endpoint_options[:environment_id]}" if endpoint_options[:environment_id]
+          base = "#{base}/#{endpoint}"
+          return "#{base}/#{endpoint_options[:resource_id]}#{endpoint_options[:suffix]}" if endpoint_options[:resource_id]
           base
         end
 
@@ -182,8 +202,8 @@ module Contentful
         # @see _ For complete option list: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters
         #
         # @return [Contentful::Management::Array<Contentful::Management::Resource>]
-        def all(client, space_id, parameters = {})
-          ResourceRequester.new(client, self).all({ space_id: space_id }, parameters)
+        def all(client, space_id, environment_id = nil, parameters = {})
+          ResourceRequester.new(client, self).all({ space_id: space_id, environment_id: environment_id }, parameters)
         end
 
         # Gets a specific resource.
@@ -193,20 +213,21 @@ module Contentful
         # @param [String] resource_id
         #
         # @return [Contentful::Management::Resource]
-        def find(client, space_id, resource_id)
-          ResourceRequester.new(client, self).find(space_id: space_id, resource_id: resource_id)
+        def find(client, space_id, environment_id = nil, resource_id = nil)
+          ResourceRequester.new(client, self).find(space_id: space_id, environment_id: environment_id, resource_id: resource_id)
         end
 
         # Creates a resource.
         #
         # @param [Contentful::Management::Client] client
         # @param [String] space_id
+        # @param [String] environment_id
         # @param [Hash] attributes
         # @see _ README for full attribute list for each resource.
         #
         # @return [Contentful::Management::Resource]
-        def create(client, space_id, attributes)
-          endpoint_options = { space_id: space_id }
+        def create(client, space_id, environment_id = nil, attributes = {})
+          endpoint_options = { space_id: space_id, environment_id: environment_id }
           endpoint_options[:resource_id] = attributes[:id] if attributes.respond_to?(:key) && attributes.key?(:id)
           ResourceRequester.new(client, self).create(
             endpoint_options,

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

@@ -16,8 +16,8 @@ module Contentful
         # @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 = {})
-          client_association_class.new(client).all_published(space_id, parameters)
+        def all_published(client, space_id, environment_id, parameters = {})
+          client_association_class.new(client, space_id, environment_id).all_published(parameters)
         end
       end
     end

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

@@ -9,7 +9,12 @@ module Contentful
         def archive
           ResourceRequester.new(client, self.class).archive(
             self,
-            { space_id: space.id, resource_id: id, suffix: '/archived' },
+            {
+              space_id: space.id,
+              environment_id: environment_id,
+              resource_id: id,
+              suffix: '/archived'
+            },
             version: sys[:version]
           )
         end
@@ -20,7 +25,12 @@ module Contentful
         def unarchive
           ResourceRequester.new(client, self.class).unarchive(
             self,
-            { space_id: space.id, resource_id: id, suffix: '/archived' },
+            {
+              space_id: space.id,
+              environment_id: environment_id,
+              resource_id: id,
+              suffix: '/archived'
+            },
             version: sys[:version]
           )
         end

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

@@ -0,0 +1,13 @@
+module Contentful
+  module Management
+    module Resource
+      # Mixin for environment aware resources
+      module EnvironmentAware
+        # Gets the environment ID for the resource.
+        def environment_id
+          sys.fetch(:environment, {}).fetch(:id, 'master')
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,12 @@ module Contentful
         def publish
           ResourceRequester.new(client, self.class).publish(
             self,
-            { space_id: space.id, resource_id: id, suffix: '/published' },
+            {
+              space_id: space.id,
+              environment_id: environment_id,
+              resource_id: id,
+              suffix: '/published'
+            },
             version: sys[:version]
           )
         end
@@ -20,7 +25,12 @@ module Contentful
         def unpublish
           ResourceRequester.new(client, self.class).unpublish(
             self,
-            { space_id: space.id, resource_id: id, suffix: '/published' },
+            {
+              space_id: space.id,
+              environment_id: environment_id,
+              resource_id: id,
+              suffix: '/published'
+            },
             version: sys[:version]
           )
         end

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

@@ -12,7 +12,7 @@ module Contentful
 
         # @private
         def refresh_find
-          self.class.find(client, space.id, id)
+          self.class.find(client, space.id, environment_id, id)
         end
 
         # @private

data/lib/contentful/management/resource_builder.rb

@@ -1,26 +1,27 @@
+require_relative 'link'
+require_relative 'user'
+require_relative 'role'
 require_relative 'error'
-require_relative 'resource'
 require_relative 'entry'
-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 'locale'
+require_relative 'upload'
 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 'resource'
+require_relative 'snapshot'
+require_relative 'environment'
+require_relative 'organization'
+require_relative 'content_type'
+require_relative 'webhook_call'
 require_relative 'ui_extension'
+require_relative 'dynamic_entry'
+require_relative 'webhook_health'
+require_relative 'space_membership'
 require_relative 'editor_interface'
-require_relative 'snapshot'
-require_relative 'upload'
+require_relative 'personal_access_token'
 
 module Contentful
   module Management
@@ -34,6 +35,7 @@ module Contentful
         'SpaceMembership' => Contentful::Management::SpaceMembership,
         'Organization' => Contentful::Management::Organization,
         'User' => Contentful::Management::User,
+        'Environment' => Contentful::Management::Environment,
         'ContentType' => Contentful::Management::ContentType,
         'Entry' => :find_entry_class,
         'Asset' => Contentful::Management::Asset,

data/lib/contentful/management/response.rb

@@ -1,5 +1,5 @@
-require_relative 'error'
 require 'multi_json'
+require_relative 'error'
 
 module Contentful
   module Management

data/lib/contentful/management/role.rb

@@ -5,13 +5,13 @@ module Contentful
     # Resource class for Role.
     class Role
       include Contentful::Management::Resource
-      include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::SystemProperties
 
       property :name, :string
+      property :policies, :array
       property :description, :string
       property :permissions, :hash
-      property :policies, :array
 
       # @private
       def self.create_attributes(_client, attributes)
@@ -23,11 +23,38 @@ module Contentful
         }
       end
 
+      # Creates a role.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [Hash] attributes
+      #
+      # @return [Contentful::Management::Role]
+      def self.create(client, space_id, attributes = {})
+        super(client, space_id, nil, attributes)
+      end
+
+      # Finds a role by ID.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] role_id
+      #
+      # @return [Contentful::Management::Role]
+      def self.find(client, space_id, role_id)
+        super(client, space_id, nil, role_id)
+      end
+
       protected
 
       def query_attributes(attributes)
         attributes.each_with_object({}) { |(k, v), result| result[k.to_sym] = v }
       end
+
+      # @private
+      def refresh_find
+        self.class.find(client, space.id, id)
+      end
     end
   end
 end

data/lib/contentful/management/snapshot.rb

@@ -1,4 +1,5 @@
 require_relative 'resource'
+require_relative 'resource/environment_aware'
 require_relative 'client_snapshot_methods_factory'
 
 module Contentful
@@ -7,8 +8,9 @@ module Contentful
     # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots
     class Snapshot
       include Contentful::Management::Resource
-      include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::EnvironmentAware
 
       # @private
       def self.property_coercions
@@ -30,25 +32,28 @@ module Contentful
       #
       # @param [Contentful::Management::Client] client
       # @param [String] space_id
+      # @param [String] environment_id
       # @param [String] resource_id
       # @param [String] resource_type
       #
       # @return [Contentful::Management::Array<Contentful::Management::Snapshot>]
-      def self.all(client, space_id, resource_id, resource_type = 'entries', params = {})
-        ClientSnapshotMethodsFactory.new(client, resource_type).all(space_id, resource_id, params)
+      # rubocop:disable Metrics/ParameterLists
+      def self.all(client, space_id, environment_id, resource_id, resource_type = 'entries', params = {})
+        ClientSnapshotMethodsFactory.new(client, space_id, environment_id, resource_type).all(resource_id, params)
       end
 
       # Gets a snapshot by ID
       #
       # @param [Contentful::Management::Client] client
       # @param [String] space_id
+      # @param [String] environment_id
       # @param [String] resource_id
       # @param [String] snapshot_id
       # @param [String] resource_type
       #
       # @return [Contentful::Management::Snapshot]
-      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)
+      def self.find(client, space_id, environment_id, resource_id, snapshot_id, resource_type = 'entries')
+        ClientSnapshotMethodsFactory.new(client, space_id, environment_id, resource_type).find(resource_id, snapshot_id)
       end
 
       # Not supported
@@ -65,11 +70,12 @@ module Contentful
       def self.build_endpoint(endpoint_options)
         resource_type = endpoint_options.fetch(:resource_type, 'entries')
         space_id = endpoint_options.fetch(:space_id)
+        environment_id = endpoint_options.fetch(:environment_id)
         resource_id = endpoint_options.fetch(:resource_id)
         snapshot_id = endpoint_options.fetch(:snapshot_id, nil)
 
-        endpoint = "spaces/#{space_id}/#{resource_type}/#{resource_id}/snapshots"
-        endpoint = "#{endpoint}/#{snapshot_id}" unless snapshot_id.nil?
+        endpoint = "spaces/#{space_id}/environments/#{environment_id}/#{resource_type}/#{resource_id}/snapshots"
+        endpoint = "#{endpoint}/#{snapshot_id}" if snapshot_id
 
         endpoint
       end

data/lib/contentful/management/space.rb

@@ -1,24 +1,15 @@
-require_relative 'resource'
-require_relative 'space_membership'
-require_relative 'space_space_membership_methods_factory'
+require_relative 'role'
 require_relative 'locale'
-require_relative 'space_locale_methods_factory'
-require_relative 'content_type'
-require_relative 'space_content_type_methods_factory'
-require_relative 'asset'
-require_relative 'space_asset_methods_factory'
-require_relative 'entry'
-require_relative 'space_entry_methods_factory'
+require_relative 'api_key'
 require_relative 'webhook'
-require_relative 'space_webhook_methods_factory'
-require_relative 'role'
+require_relative 'resource'
+require_relative 'environment'
+require_relative 'space_membership'
 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'
+require_relative 'space_webhook_methods_factory'
 require_relative 'space_api_key_methods_factory'
+require_relative 'space_environment_methods_factory'
+require_relative 'space_space_membership_methods_factory'
 
 module Contentful
   module Management
@@ -26,14 +17,11 @@ module Contentful
     # @see _ https://www.contentful.com/developers/documentation/content-management-api/#resources-spaces
     class Space
       include Contentful::Management::Resource
-      include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::SystemProperties
 
       property :name, :string
       property :organization, :string
-      property :locales, Locale
-
-      attr_accessor :found_locale
 
       # @private
       def self.build_endpoint(endpoint_options)
@@ -71,11 +59,6 @@ module Contentful
         { organization_id: attributes[:organization_id] }
       end
 
-      # @private
-      def after_create(attributes)
-        self.found_locale = attributes[:default_locale] || client.default_locale
-      end
-
       # Create a space.
       #
       # @param [Contentful::Management::Client] client
@@ -126,13 +109,13 @@ module Contentful
         ResourceRequester.new(client, self.class).destroy(space_id: id)
       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 manipulation of environments in context of the current space
+      # Allows listing all environments of space, creating new and finding one by ID.
       # @see _ README for details.
       #
-      # @return [Contentful::Management::SpaceContentTypeMethodsFactory]
-      def content_types
-        SpaceContentTypeMethodsFactory.new(self)
+      # @return [Contentful::Management::SpaceEnvironmentMethodsFactory]
+      def environments
+        SpaceEnvironmentMethodsFactory.new(self)
       end
 
       # Allows manipulation of api keys in context of the current space
@@ -144,15 +127,6 @@ module Contentful
         SpaceApiKeyMethodsFactory.new(self)
       end
 
-      # Allows manipulation of locales in context of the current space
-      # Allows listing all locales of space, creating new and finding one by ID.
-      # @see _ README for details.
-      #
-      # @return [Contentful::Management::SpaceLocaleMethodsFactory]
-      def locales
-        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.
@@ -171,42 +145,6 @@ 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.
-      # @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.
-      #
-      # @return [Contentful::Management::SpaceAssetMethodsFactory]
-      def assets
-        SpaceAssetMethodsFactory.new(self)
-      end
-
-      # Allows manipulation of entries in context of the current space
-      # Allows listing all entries for space and finding one by ID.
-      # @see _ README for details.
-      #
-      # @return [Contentful::Management::SpaceEntryMethodsFactory]
-      def entries
-        SpaceEntryMethodsFactory.new(self)
-      end
-
       # Allows manipulation of webhooks in context of the current space
       # Allows listing all webhooks for space and finding one by ID.
       # @see _ README for details.
@@ -216,23 +154,6 @@ module Contentful
         SpaceWebhookMethodsFactory.new(self)
       end
 
-      # Retrieves Default Locale for current Space and leaves it cached
-      #
-      # @return [String]
-      def default_locale
-        self.found_locale ||= find_locale
-      end
-
-      # Finds Default Locale Code for current Space
-      # This request makes an API call to the Locale endpoint
-      #
-      # @return [String]
-      def find_locale
-        locale = locales.all.detect(&:default)
-        return locale.code unless locale.nil?
-        @default_locale
-      end
-
       protected
 
       def refresh_find