contentful-management 1.10.1 → 2.0.0

data/lib/contentful/management/entry.rb

@@ -1,13 +1,13 @@
 require_relative 'resource'
-require_relative 'resource_requester'
-require_relative 'client_entry_methods_factory'
-require_relative 'entry_snapshot_methods_factory'
-require_relative 'resource/entry_fields'
 require_relative 'resource/fields'
-require_relative 'resource/field_aware'
-require_relative 'resource/all_published'
 require_relative 'resource/archiver'
 require_relative 'resource/publisher'
+require_relative 'resource_requester'
+require_relative 'resource/field_aware'
+require_relative 'resource/entry_fields'
+require_relative 'resource/environment_aware'
+require_relative 'client_entry_methods_factory'
+require_relative 'entry_snapshot_methods_factory'
 
 module Contentful
   module Management
@@ -15,13 +15,14 @@ module Contentful
     # @see _ https://www.contentful.com/developers/documentation/content-management-api/#resources-entries
     class Entry
       include Contentful::Management::Resource
-      include Contentful::Management::Resource::SystemProperties
-      include Contentful::Management::Resource::Refresher
       extend Contentful::Management::Resource::EntryFields
-      extend Contentful::Management::Resource::AllPublished
+      include Contentful::Management::Resource::SystemProperties
+
       include Contentful::Management::Resource::Fields
       include Contentful::Management::Resource::Archiver
       include Contentful::Management::Resource::Publisher
+      include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::EnvironmentAware
 
       attr_accessor :content_type
 
@@ -153,6 +154,7 @@ module Contentful
           new_instance = Contentful::Management::Entry.create(
             client,
             content_type.space.id,
+            environment_id,
             content_type: content_type,
             fields: instance_variable_get(:@fields)
           )
@@ -248,7 +250,7 @@ module Contentful
                             sys[:contentType]['sys']['id']
                           end
         space_id = space.is_a?(::Contentful::Management::Resource) ? space.id : space['sys']['id']
-        @content_type ||= ::Contentful::Management::ContentType.find(client, space_id, content_type_id)
+        @content_type ||= ::Contentful::Management::ContentType.find(client, space_id, environment_id, content_type_id)
       end
     end
   end

data/lib/contentful/management/entry_association_methods_factory.rb

@@ -12,11 +12,11 @@ module Contentful
       end
 
       def all(_params = {})
-        associated_class.all(entry.client, entry.sys[:space].id, entry.id)
+        associated_class.all(entry.client, entry.sys[:space].id, entry.environment_id, entry.id)
       end
 
       def find(id)
-        associated_class.find(entry.client, entry.sys[:space].id, entry.id, id)
+        associated_class.find(entry.client, entry.sys[:space].id, entry.environment_id, entry.id, id)
       end
 
       def associated_class

data/lib/contentful/management/environment.rb

@@ -0,0 +1,138 @@
+require_relative 'environment_asset_methods_factory'
+require_relative 'environment_entry_methods_factory'
+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'
+
+module Contentful
+  module Management
+    # Resource class for Environment.
+    # @see _ https://www.contentful.com/developers/documentation/content-management-api/#resources-environments
+    class Environment
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::SystemProperties
+
+      property :name, :string
+
+      # @private
+      def self.build_endpoint(endpoint_options)
+        space_id = endpoint_options.fetch(:space_id)
+        environment_id = endpoint_options.fetch(:resource_id, endpoint_options.fetch(:environment_id, nil))
+
+        endpoint = "spaces/#{space_id}/environments"
+        endpoint = "#{endpoint}/#{environment_id}" if environment_id
+        endpoint
+      end
+
+      # Creates an environment.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [Hash] attributes
+      # @see _ README for full attribute list for each resource.
+      #
+      # @return [Contentful::Management::Environment]
+      def self.create(client, space_id, attributes = {})
+        super(client, space_id, nil, attributes)
+      end
+
+      # Finds an environment by ID.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] environment_id
+      #
+      # @return [Contentful::Management::Environment]
+      def self.find(client, space_id, environment_id)
+        super(client, space_id, nil, environment_id)
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        return {} if attributes.nil? || attributes.empty?
+
+        {
+          'name' => attributes.fetch(:name, attributes.fetch('name', nil))
+        }
+      end
+
+      # Allows manipulation of entries in context of the current environment
+      # Allows listing all entries for the current environment, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentEntryMethodsFactory]
+      def entries
+        EnvironmentEntryMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of assets in context of the current environment
+      # Allows listing all assets for the current environment, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentAssetMethodsFactory]
+      def assets
+        EnvironmentAssetMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of content types in context of the current environment
+      # Allows listing all content types for the current environment, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentContentTypeMethodsFactory]
+      def content_types
+        EnvironmentContentTypeMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of locales in context of the current environment
+      # Allows listing all locales for the current environment, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentLocaleMethodsFactory]
+      def locales
+        EnvironmentLocaleMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of UI extensions in context of the current environment
+      # Allows listing all UI extensions for the current environment, creating new and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentUIExtensionMethodsFactory]
+      def ui_extensions
+        EnvironmentUIExtensionMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of editor interfaces in context of the current environment
+      # Allows listing of editor interfaces for the current environment.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::EnvironmentEditorInterfaceMethodsFactory]
+      def editor_interfaces
+        EnvironmentEditorInterfaceMethodsFactory.new(self)
+      end
+
+      # Gets the environment ID
+      def environment_id
+        id
+      end
+
+      # Retrieves Default Locale for current Environment 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
+    end
+  end
+end

data/lib/contentful/management/environment_asset_methods_factory.rb

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

data/lib/contentful/management/environment_association_methods_factory.rb

@@ -0,0 +1,42 @@
+require_relative 'resource_requester'
+
+module Contentful
+  module Management
+    # Wrapper for Environment Association Methods
+    # @private
+    module EnvironmentAssociationMethodsFactory
+      attr_reader :environment
+
+      def initialize(environment)
+        @environment = environment
+      end
+
+      def all(_params = {})
+        associated_class.all(environment.client, environment.sys[:space].id, environment.id)
+      end
+
+      def find(id)
+        associated_class.all(environment.client, environment.sys[:space].id, environment.id, id)
+      end
+
+      def create(attributes = {})
+        associated_class.create(environment.client, environment.sys[:space].id, environment.id, attributes)
+      end
+
+      def new
+        object = associated_class.new
+        object.sys[:space] = environment.space
+        object.sys[:environment] = environment
+        object.client = environment.client
+        object
+      end
+
+      def associated_class
+        class_name = /\A(.+)Environment(.+)MethodsFactory\z/.match(self.class.name).captures.join
+        class_name.split('::').reduce(Object) do |mod, actual_class_name|
+          mod.const_get(actual_class_name)
+        end
+      end
+    end
+  end
+end

data/lib/contentful/management/environment_content_type_methods_factory.rb

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

data/lib/contentful/management/environment_editor_interface_methods_factory.rb

@@ -0,0 +1,15 @@
+require_relative 'environment_association_methods_factory'
+
+module Contentful
+  module Management
+    # Wrapper for Editor Interface API for usage from within Environment
+    # @private
+    class EnvironmentEditorInterfaceMethodsFactory
+      include Contentful::Management::EnvironmentAssociationMethodsFactory
+
+      def default(content_type_id)
+        associated_class.default(environment.client, environment.space.id, environment.id, content_type_id)
+      end
+    end
+  end
+end

data/lib/contentful/management/environment_entry_methods_factory.rb

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

data/lib/contentful/management/environment_locale_methods_factory.rb

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

data/lib/contentful/management/environment_ui_extension_methods_factory.rb

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

data/lib/contentful/management/field.rb

@@ -7,15 +7,15 @@ module Contentful
       include Contentful::Management::Resource
 
       property :id, :string
+      property :items, Field
       property :name, :string
       property :type, :string
+      property :omitted, :boolean
       property :linkType, :string
-      property :items, Field
       property :required, :boolean
+      property :disabled, :boolean
       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/file.rb

@@ -6,10 +6,10 @@ module Contentful
     class File
       include Contentful::Management::Resource
 
-      property :fileName, :string
-      property :contentType, :string
       property :details
       property :url, :string
+      property :fileName, :string
+      property :contentType, :string
     end
   end
 end

data/lib/contentful/management/link.rb

@@ -9,13 +9,27 @@ module Contentful
       include Contentful::Management::Resource::SystemProperties
 
       # Queries contentful for the Resource the Link is referring to
-      # @param [Hash] query
-      def resolve(query = {})
-        id_and_query = [(id unless link_type == 'Space')].compact + [query]
-        client.public_send(
-          Contentful::Management::Support.snakify(link_type).to_sym,
-          *id_and_query
-        )
+      # @param [String] space_id
+      # @param [String] environment_id
+      def resolve(space_id = nil, environment_id = nil)
+        return client.spaces.find(id) if link_type == 'Space'
+
+        method = Contentful::Management::Support.snakify(link_type).to_sym
+
+        if space_id && environment_id.nil?
+          return client.public_send(
+            method,
+            space_id
+          ).find(id)
+        elsif space_id && environment_id
+          return client.public_send(
+            method,
+            space_id,
+            environment_id
+          ).find(id)
+        end
+
+        client.public_send(method).find(id)
       end
     end
   end

data/lib/contentful/management/locale.rb

@@ -1,4 +1,5 @@
 require_relative 'resource'
+require_relative 'resource/environment_aware'
 
 module Contentful
   module Management
@@ -7,15 +8,16 @@ module Contentful
       include Contentful::Management::Resource
       include Contentful::Management::Resource::SystemProperties
       include Contentful::Management::Resource::Refresher
+      include Contentful::Management::Resource::EnvironmentAware
 
       property :code, :string
       property :name, :string
-      property :contentManagementApi, :boolean
-      property :contentDeliveryApi, :boolean
       property :publish, :boolean
       property :default, :boolean
       property :optional, :boolean
       property :fallbackCode, :string
+      property :contentDeliveryApi, :boolean
+      property :contentManagementApi, :boolean
 
       # @private
       def self.create_attributes(_client, attributes)

data/lib/contentful/management/organization.rb

@@ -6,8 +6,8 @@ module Contentful
     # @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
+      include Contentful::Management::Resource::SystemProperties
 
       property :name
 

data/lib/contentful/management/personal_access_token.rb

@@ -6,13 +6,13 @@ module Contentful
     # @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
+      include Contentful::Management::Resource::SystemProperties
 
       property :name, :string
-      property :revokedAt, :date
       property :scopes, :array
       property :token, :string
+      property :revokedAt, :date
 
       # @private
       def self.build_endpoint(endpoint_options)