contentful-management 1.8.1 → 1.9.0

data/lib/contentful/management/space_membership.rb

@@ -0,0 +1,43 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for Space Membership.
+    class SpaceMembership
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :admin, :boolean
+      property :roles, :array
+      property :user, Link
+
+      # Returns the list of roles for this membership.
+      def roles
+        (properties[:roles] || []).map { |r| r.is_a?(Link) ? r : Link.new(r, nil, client) }
+      end
+
+      # @private
+      def self.clean_roles(roles)
+        roles.map { |r| r.is_a?(Link) ? r.raw_object : r }
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        {
+          'admin' => attributes['admin'] || attributes.fetch(:admin),
+          'roles' => clean_roles(attributes['roles'] || attributes.fetch(:roles)),
+          'email' => attributes['email'] || attributes.fetch(:email)
+        }
+      end
+
+      # @private
+      def query_attributes(attributes)
+        {
+          'admin' => attributes['admin'] || attributes[:admin],
+          'roles' => self.class.clean_roles(attributes['roles'] || attributes[:roles])
+        }.reject { |_k, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/contentful/management/space_space_membership_methods_factory.rb

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

data/lib/contentful/management/space_ui_extension_methods_factory.rb

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

data/lib/contentful/management/ui_extension.rb

@@ -0,0 +1,106 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for UIExtension.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/ui-extensions
+    class UIExtension
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :extension, :hash
+
+      # @private
+      def self.endpoint
+        'extensions'
+      end
+
+      # @private
+      def self.create_attributes(_client, attributes)
+        extension = attributes['extension'] || attributes[:extension]
+
+        fail 'Invalid UI Extension attributes' unless valid_extension(extension)
+
+        { 'extension' => extension }
+      end
+
+      # @private
+      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')
+        return false if extension.key?('sidebar') && ![false, true].include?(extension['sidebar'])
+        true
+      end
+
+      # If an extension is a new object gets created in the Contentful, otherwise the existing extension gets updated.
+      # @see _ https://github.com/contentful/contentful-management.rb for details.
+      #
+      # @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, extension: extension)
+          refresh_data(new_instance)
+        end
+      end
+
+      # Returns extension name
+      # @return [String] name
+      def name
+        extension['name']
+      end
+
+      # Sets extension name
+      # @param [String] value
+      def name=(value)
+        extension['name'] = value
+      end
+
+      # Returns extension field types
+      # @return [Array<String>] field types
+      def field_types
+        extension['fieldTypes']
+      end
+
+      # Sets extension field types
+      # @param [Array<String>] values
+      def field_types=(values)
+        extension['fieldTypes'] = values
+      end
+
+      # Returns extension source URL or data
+      # @return [String] source URL or data
+      def source
+        extension['src'] || extension['srcdoc']
+      end
+
+      # Sets extension source
+      # @param [String] value URL or data
+      def source=(value)
+        if value.start_with?('http')
+          extension['src'] = value
+          extension.delete('srcdoc')
+        else
+          extension['srcdoc'] = value
+          extension.delete('src')
+        end
+      end
+
+      # Returns if extension is on sidebar
+      # @return [Boolean] sidebar
+      def sidebar
+        extension['sidebar']
+      end
+
+      # Sets if extension is on sidebar
+      # @param [Boolean] value
+      def sidebar=(value)
+        extension['sidebar'] = value
+      end
+    end
+  end
+end

data/lib/contentful/management/user.rb

@@ -0,0 +1,28 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for User.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/users
+    class User
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :firstName, :string
+      property :lastName, :string
+      property :avatarUrl, :string
+      property :email, :string
+      property :activated, :boolean
+      property :signInCount, :integer
+      property :confirmed, :boolean
+
+      # @private
+      def self.build_endpoint(endpoint_options)
+        endpoint = '/users'
+        endpoint = "#{endpoint}/#{endpoint_options[:resource_id]}" if endpoint_options[:resource_id]
+        endpoint
+      end
+    end
+  end
+end

data/lib/contentful/management/version.rb

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

data/lib/contentful/management/webhook.rb

@@ -1,4 +1,6 @@
 require_relative 'resource'
+require_relative 'webhook_webhook_call_methods_factory'
+require_relative 'webhook_webhook_health_methods_factory'
 
 module Contentful
   module Management
@@ -25,6 +27,24 @@ module Contentful
         attributes.select { |key, _value| [:httpBasicUsername, :httpBasicPassword, :url, :name, :headers, :topics].include? key }
       end
 
+      # Allows manipulation of webhook call details in context of the current webhook
+      # Allows listing all webhook call details for the webhook and finding one by ID.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::WebhookWebhookCallMethodsFactory]
+      def webhook_calls
+        WebhookWebhookCallMethodsFactory.new(self)
+      end
+
+      # Allows manipulation of webhook health details in context of the current webhook
+      # Allows listing webhook health details for the webhook.
+      # @see _ README for details.
+      #
+      # @return [Contentful::Management::WebhookWebhookHealthMethodsFactory]
+      def webhook_health
+        WebhookWebhookHealthMethodsFactory.new(self)
+      end
+
       protected
 
       def query_attributes(attributes)

data/lib/contentful/management/webhook_call.rb

@@ -0,0 +1,77 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for WebhookCall.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls
+    class WebhookCall
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :statusCode, :integer
+      property :errors, :array
+      property :eventType, :string
+      property :url, :array
+      property :requestAt, :date
+      property :responseAt, :date
+      property :response, :hash
+      property :request, :hash
+
+      # Gets all webhook call details for a webhook.
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] webhook_id
+      #
+      # @return [Contentful::Management::Array<Contentful::Management::WebhookCall>]
+      def self.all(client, space_id, webhook_id)
+        ClientWebhookCallMethodsFactory.new(client).all(space_id, webhook_id)
+      end
+
+      # Gets a webhook's call details by ID
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] webhook_id
+      # @param [String] call_id
+      #
+      # @return [Contentful::Management::WebhookCall]
+      def self.find(client, space_id, webhook_id, call_id)
+        ClientWebhookCallMethodsFactory.new(client).find(space_id, webhook_id, call_id)
+      end
+
+      # Not supported
+      def self.create(*)
+        fail 'Not supported'
+      end
+
+      # @private
+      def self.endpoint
+        'webhooks'
+      end
+
+      # @private
+      def self.build_endpoint(endpoint_options)
+        space_id = endpoint_options.fetch(:space_id)
+        webhook_id = endpoint_options.fetch(:webhook_id)
+        call_id = endpoint_options.fetch(:call_id, nil)
+
+        endpoint = "spaces/#{space_id}/webhooks/#{webhook_id}/calls"
+        endpoint = "#{endpoint}/#{call_id}" unless call_id.nil?
+
+        endpoint
+      end
+
+      # Not supported
+      def destroy
+        fail 'Not supported'
+      end
+
+      # Not supported
+      def update(*)
+        fail 'Not supported'
+      end
+    end
+  end
+end

data/lib/contentful/management/webhook_health.rb

@@ -0,0 +1,79 @@
+require_relative 'resource'
+
+module Contentful
+  module Management
+    # Resource class for WebhookHealth.
+    # @see _ https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-health
+    class WebhookHealth
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      property :calls, :hash
+
+      # Gets a webhook's health details by ID
+      #
+      # @param [Contentful::Management::Client] client
+      # @param [String] space_id
+      # @param [String] webhook_id
+      #
+      # @return [Contentful::Management::WebhookHealth]
+      def self.find(client, space_id, webhook_id)
+        ClientWebhookHealthMethodsFactory.new(client).find(space_id, webhook_id)
+      end
+
+      # Not supported
+      def self.create(*)
+        fail 'Not supported'
+      end
+
+      # Not supported
+      def self.all(*)
+        fail 'Not supported'
+      end
+
+      # @private
+      def self.endpoint
+        'webhooks'
+      end
+
+      # @private
+      def self.build_endpoint(endpoint_options)
+        space_id = endpoint_options.fetch(:space_id)
+        webhook_id = endpoint_options.fetch(:webhook_id)
+
+        "spaces/#{space_id}/webhooks/#{webhook_id}/health"
+      end
+
+      # Not supported
+      def destroy
+        fail 'Not supported'
+      end
+
+      # Not supported
+      def update(*)
+        fail 'Not supported'
+      end
+
+      # Returns the total calls made by the webhook.
+      def total
+        calls['total']
+      end
+
+      # Returns the amount of healthy calls made by the webhook.
+      def healthy
+        calls['healthy']
+      end
+
+      # Returns wether or not there was an error on the webhook calls on the last 30 days.
+      def errors?
+        total != healthy
+      end
+
+      # Returns whether or not all the webhook calls on the last 30 days were successful.
+      def healthy?
+        total == healthy
+      end
+    end
+  end
+end

data/lib/contentful/management/webhook_webhook_call_methods_factory.rb

@@ -0,0 +1,30 @@
+require_relative 'resource_requester'
+
+module Contentful
+  module Management
+    # Wrapper for webhook call detail manipulation for a specific webhook.
+    # @private
+    class WebhookWebhookCallMethodsFactory
+      attr_reader :webhook
+
+      # @private
+      def initialize(webhook)
+        @webhook = webhook
+      end
+
+      # Gets all webhook call details for a specific webhook.
+      #
+      # @return [Contentful::Management::Array<Contentful::Management::WebhookCall>]
+      def all(_params = {})
+        WebhookCall.all(webhook.client, webhook.space.id, webhook.id)
+      end
+
+      # Gets a webhook call detail for a specific webhook by ID.
+      #
+      # @return [Contentful::Management::WebhookCall]
+      def find(call_id)
+        WebhookCall.find(webhook.client, webhook.space.id, webhook.id, call_id)
+      end
+    end
+  end
+end